put dx.pl into an explicit handle sub
[spider.git] / perl / DXProtout.pm
index 1533c2b45887ed2cdb1bac8208db926599e42f29..088d82e59f369df71d21c2288e7a49584b22a588 100644 (file)
@@ -6,12 +6,12 @@
 #
 # Copyright (c) 1998 Dirk Koopman G1TLH
 #
-# $Id$
-# 
+#
+#
 
 package DXProt;
 
-@ISA = qw(DXProt DXChannel);
+@ISA = qw(DXChannel);
 
 use DXUtil;
 use DXM;
@@ -19,15 +19,10 @@ use DXDebug;
 
 use strict;
 
-use vars qw($VERSION $BRANCH);
-$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
-$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
-$main::build += $VERSION;
-$main::branch += $BRANCH;
-
-use vars qw($sentencelth);
+use vars qw($sentencelth $pc19_version $pc9x_nodupe_first_slot);
 
 $sentencelth = 180;
+$pc9x_nodupe_first_slot = 1;
 
 #
 # All the PCxx generation routines
@@ -38,7 +33,7 @@ sub pc10
 {
        my ($from, $to, $via, $text, $origin) = @_;
        my ($user1, $user2);
-       if ($via && $via ne $to) {
+       if ($via && $via ne $to && $via ne '*') {
                $user1 = $via;
                $user2 = $to;
        } else {
@@ -49,10 +44,10 @@ sub pc10
        $text = unpad($text);
        $text = ' ' unless $text && length $text > 0;
        $text =~ s/\^/%5E/g;
-       return "PC10^$from^$user1^$text^*^$user2^$origin^~";  
+       return "PC10^$from^$user1^$text^*^$user2^$origin^~";
 }
 
-# create a dx message (call, freq, dxcall, text) 
+# create a dx message (call, freq, dxcall, text) see also pc61
 sub pc11
 {
        my ($mycall, $freq, $dxcall, $text) = @_;
@@ -63,6 +58,17 @@ sub pc11
        return sprintf "PC11^%.1f^$dxcall^%s^%s^$text^$mycall^$main::mycall^$hops^~", $freq, cldate($t), ztime($t);
 }
 
+# create a dx message (call, freq, dxcall, text, $ipaddr) see also pc11
+sub pc61
+{
+       my ($mycall, $freq, $dxcall, $text, $ipaddr) = @_;
+       my $hops = get_hops(61) || get_hops(11);
+       my $t = time;
+       $text = ' ' if !$text;
+       $text =~ s/\^/%5E/g;
+       return sprintf "PC61^%.1f^$dxcall^%s^%s^$text^$mycall^$main::mycall^$ipaddr^$hops^~", $freq, cldate($t), ztime($t);
+}
+
 # create an announce message
 sub pc12
 {
@@ -78,8 +84,8 @@ sub pc12
 }
 
 #
-# add one or more users (I am expecting references that have 'call', 
-# 'conf' & 'here' method) 
+# add one or more users (I am expecting references that have 'call',
+# 'conf' & 'here' method)
 #
 # this will create a list of PC16 with up pc16_max_users in each
 # called $self->pc16(..)
@@ -115,7 +121,7 @@ sub pc17
                my $hops = get_hops(17);
                my $ncall = $node->call;
                my $ucall = $ref->call;
-               push @out, "PC17^$ucall^$ncall^$hops^"; 
+               push @out, "PC17^$ucall^$ncall^$hops^";
        }
        return @out;
 }
@@ -123,14 +129,13 @@ sub pc17
 # Request init string
 sub pc18
 {
-       my $flags = " pc92";
-       $flags .= " xml" if DXXml::available(); 
-       return "PC18^DXSpider Version: $main::version Build: $main::build$flags^$DXProt::myprot_version^";
+       my $flags = shift;
+       return "PC18^DXSpider Version: $main::version Build: $main::build Git: $main::gitversion$flags^$DXProt::myprot_version^";
 }
 
 #
-# add one or more nodes 
-# 
+# add one or more nodes
+#
 sub pc19
 {
        my @out;
@@ -144,6 +149,8 @@ sub pc19
                my $here = $ref->here;
                my $conf = $ref->conf;
                my $version = $ref->version;
+               $version = $pc19_version unless $version =~ /^\d\d\d\d$/;
+
                my $str = "^$here^$call^$conf^$version";
                if (length($s) + length($str) > $sentencelth) {
                        push @out, "PC19" . $s . sprintf "^%s^", get_hops(19);
@@ -187,12 +194,12 @@ sub pc24
        my $call = $self->call;
        my $flag = $self->here ? '1' : '0';
        my $hops = shift || get_hops(24);
-  
+
        return "PC24^$call^$flag^$hops^";
 }
 
 
-# create a merged dx message (freq, dxcall, t, text, spotter, orig-node) 
+# create a merged dx message (freq, dxcall, t, text, spotter, orig-node)
 sub pc26
 {
        my ($freq, $dxcall, $t, $text, $spotter, $orignode) = @_;
@@ -221,7 +228,7 @@ sub pc28
 }
 
 # message text (from and to node same way round as pc29)
-sub pc29 
+sub pc29
 {
        my ($fromnode, $tonode, $stream, $text) = @_;
        $text = ' ' unless defined $text && length $text > 0;
@@ -299,7 +306,7 @@ sub pc41
 {
        my $call = shift;
        $call = shift if ref $call;
-       
+
        my $sort = shift || '0';
        my $info = shift || ' ';
        my $hops = shift || get_hops(41);
@@ -377,27 +384,34 @@ sub pc85
 # spider route broadcasts
 #
 
-my $_last_time;
-my $_last_occurs;
 
-sub _gen_time
+sub _gen_pc92
 {
-       if (!$_last_time || $_last_time != $main::systime) {
-               $_last_time = $main::systime;
-               $_last_occurs = 0;
-               return $_last_time;
-       } else {
-               $_last_occurs++;
-               return sprintf "$_last_time.%02d", $_last_occurs;
+       my $sort = shift;
+       my $ext = shift;
+       my $s = "PC92^$main::mycall^" . gen_pc9x_t() . "^$sort";
+       if ($pc9x_nodupe_first_slot && ($sort eq 'A' || $sort eq 'D') && $_[0]->call eq $main::mycall) {
+               shift;
+               $s .= '^';
+       }
+       for (@_) {
+               $s .= '^' . _encode_pc92_call($_, $ext);
+               $ext = 0 unless $sort eq 'A';                           # only the first slot has an ext.
        }
+       return $s . '^H99^';
 }
 
-sub _gen_pc92
+sub gen_pc92_with_time
 {
+       my $call = shift;
        my $sort = shift;
-#      my $ext = $sort eq 'C';
+       my $t = shift;
        my $ext = 1;
-       my $s = "PC92^$main::mycall^" . _gen_time . "^$sort";
+       my $s = "PC92^$call^$t^$sort";
+       if ($pc9x_nodupe_first_slot && ($sort eq 'A' || $sort eq 'D') && $_[0]->call eq $main::mycall) {
+               shift;
+               $s .= '^';
+       }
        for (@_) {
                $s .= "^" . _encode_pc92_call($_, $ext);
        }
@@ -407,19 +421,64 @@ sub _gen_pc92
 # add a local one
 sub pc92a
 {
-       return _gen_pc92('A', @_);
+       return _gen_pc92('A', 2, @_);
 }
 
 # delete a local one
 sub pc92d
 {
-       return _gen_pc92('D', @_);
+       return _gen_pc92('D', 0, @_);
 }
 
 # send a config
 sub pc92c
 {
-       return _gen_pc92('C', @_);
+       return _gen_pc92('C', 1, @_);
+}
+
+# send a keep alive
+sub pc92k
+{
+       my $nref = shift;
+       my $s = "PC92^$main::mycall^" . gen_pc9x_t() . "^K";
+       $s .= "^" . _encode_pc92_call($nref, 1) . ":$main::me->{build}";
+       $s .= "^" . scalar $nref->nodes;
+       $s .= "^" . scalar $nref->users;
+       return $s . '^H99^';
+}
+
+# send a 'find' message
+sub pc92f
+{
+       my $target = shift;
+       my $from = shift;
+       return "PC92^$main::mycall^" . gen_pc9x_t() . "^F^$from^$target^H99^"
+}
+
+# send a 'reply' message
+sub pc92r
+{
+       my $to = shift;
+       my $target = shift;
+       my $flag = shift;
+       my $ms = shift;
+       return "PC92^$main::mycall^" . gen_pc9x_t() . "^R^$to^$target^$flag^$ms^H99^"
+}
+
+sub pc93
+{
+       my $to = shift;                         # *, callsign, chat group name, sysop
+       my $from = shift;                       # from user callsign
+       my $via = shift || '*';                 # *, node call
+       my $line = shift;                       # the text
+       my $origin = shift;                     # this will be present on proxying from PC10
+
+       $line = unpad($line);
+       $line =~ s/\^/\\5E/g;           # remove any ^ characters
+       my $s = "PC93^$main::mycall^" . gen_pc9x_t() . "^$to^$from^$via^$line";
+       $s .= "^$origin" if $origin;
+       $s .= "^H99^";
+       return $s;
 }
 
 1;