added SipSak probe for SIP ping testing

2 files changed, 114 insertions, 0 deletions

diff --git a/CHANGES b/CHANGES
index 64bc8d7..2d08719 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,6 @@
+* new probe for SIP Ping test based on sipsak tool 
+  -- tobi sponsored by ANI Networks
+
 * bandaid fix for timeout issue in CiscoRTTMonEchoICMP probe ...
   since the probe needs a longer timeout, the basefork parent needs to wait
   longer too ... a local timeout configurable with higher default should fix
diff --git a/lib/Smokeping/probes/SipSak.pm b/lib/Smokeping/probes/SipSak.pm
new file mode 100644
index 0000000..b608427
--- /dev/null
+++ b/lib/Smokeping/probes/SipSak.pm
@@ -0,0 +1,111 @@
+package Smokeping::probes::SipSak;
+
+=head1 301 Moved Permanently
+
+This is a Smokeping probe module. Please use the command 
+
+C<smokeping -man Smokeping::probes::SipSak>
+
+to view the documentation or the command
+
+C<smokeping -makepod Smokeping::probes::SipSak>
+
+to generate the POD document.
+
+=cut
+
+use strict;
+use base qw(Smokeping::probes::basefork);
+use Carp;
+
+sub pod_hash {
+    return {
+        name => <<DOC,
+Smokeping::probes::SipSak - tests sip server
+DOC
+        overview => <<DOC,
+This probe sends OPTIONS messages to a sip server testing the latency.
+DOC
+        description => <<DOC,
+The probe uses the L<sipsak|http://sipsak.org/> tool to measure sip server latency by sending an OPTIONS message.
+
+The sipsak command supports a large number of additional parameters to fine-tune its operation. Use the
+params variable to configure them.
+DOC
+        authors => <<'DOC',
+Tobias Oetiker <tobi@oetiker.ch> sponsored by ANI Networks
+DOC
+    }
+}
+
+sub ProbeDesc ($) {
+        my $self = shift;  
+    return sprintf("SIP OPTIONS messages");
+}
+
+sub new {
+        my $proto = shift;
+        my $class = ref($proto) || $proto;
+        my $self = $class->SUPER::new(@_);
+        return $self;
+}
+
+sub pingone {
+    my $self = shift;
+    my $target = shift;
+    my $host = $target->{addr};
+    my $vars = $target->{vars};
+    my @times;
+    my $elapsed;
+    my $pingcount = $self->pings($target);
+    $host = $vars->{user}.'@'.$host if $vars->{user};
+    $host = $host . ':' . $vars->{port} if $vars->{port};    
+    my @extra_opts = ();
+    @extra_opts = split /\s/, $vars->{params} if $vars->{params};
+    open (my $sak,'-|',$self->{properties}{binary},'-vv','-A',$pingcount,'-s','sip:'.$host,@extra_opts)
+        or die("ERROR: $target->{binary}: $!\n");
+    while(<$sak>){    
+	chomp;
+        if (/^(?:\s+and|\*\*\sreply\sreceived\safter)\s(\d+(?:\.\d+))\sms\s/){	
+            push @times,$1/1000;
+        }
+    }
+    close $sak;
+    return sort { $a <=> $b } @times;
+}
+
+sub probevars {
+    my $class = shift;
+    my $h = $class->SUPER::probevars;
+    return $class->_makevars($h, {
+        binary => {
+            _doc => "The location of your echoping binary.",
+            _default => '/usr/bin/sipsak',
+            _sub => sub {
+                my $val = shift;
+                -x $val or return "ERROR: binary '$val' is not executable";
+                return undef;
+            },
+        },
+    });    
+}
+        
+sub targetvars {
+    my $class = shift;
+    return $class->_makevars($class->SUPER::targetvars, {
+        user => {
+            _doc => "User to use for sip connection.",
+            _example => 'nobody',
+        },
+        port => {
+            _doc => "usa non-default port for the sip connection.",
+            _example => 5061,
+        },
+        params => {
+            _doc => "additional sipsak options. The options will get split on space.",
+            _example => '--numeric --password=mysecret'
+        },        
+    });
+}
+
+1;