fix xml ambiqueties.
[spider.git] / perl / DXProtout.pm
index 0be2f0ea9d0672feb00ccbb67f261a9d13969bed..522352e48d97cc35b61020e33b10c2cdd1aa092e 100644 (file)
@@ -15,9 +15,20 @@ package DXProt;
 
 use DXUtil;
 use DXM;
+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);
+
+$sentencelth = 180;
+
 #
 # All the PCxx generation routines
 #
@@ -25,74 +36,96 @@ use strict;
 # create a talk string ($from, $to, $via, $text)
 sub pc10
 {
-  my ($from, $to, $via, $text) = @_;
-  my $user2 = $via ? $to : ' ';
-  my $user1 = $via ? $via : $to;
-  $text = unpad($text);
-  $text = ' ' if !$text;
-  return "PC10^$from^$user1^$text^*^$user2^$main::mycall^~";  
+       my ($from, $to, $via, $text, $origin) = @_;
+       my ($user1, $user2);
+       if ($via && $via ne $to) {
+               $user1 = $via;
+               $user2 = $to;
+       } else {
+               $user2 = ' ';
+               $user1 = $to;
+       }
+       $origin ||= $main::mycall;
+       $text = unpad($text);
+       $text = ' ' unless $text && length $text > 0;
+       $text =~ s/\^/%5E/g;
+       return "PC10^$from^$user1^$text^*^$user2^$origin^~";  
 }
 
 # create a dx message (call, freq, dxcall, text) 
 sub pc11
 {
-  my ($mycall, $freq, $dxcall, $text) = @_;
-  my $hops = get_hops(11);
-  my $t = time;
-  $text = ' ' if !$text;
-  return sprintf "PC11^%.1f^$dxcall^%s^%s^$text^$mycall^$hops^~", $freq, cldate($t), ztime($t);
+       my ($mycall, $freq, $dxcall, $text) = @_;
+       my $hops = get_hops(11);
+       my $t = time;
+       $text = ' ' if !$text;
+       $text =~ s/\^/%5E/g;
+       return sprintf "PC11^%.1f^$dxcall^%s^%s^$text^$mycall^$main::mycall^$hops^~", $freq, cldate($t), ztime($t);
 }
 
 # create an announce message
 sub pc12
 {
-  my ($call, $text, $tonode, $sysop, $wx) = @_;
-  my $hops = get_hops(12);
-  $sysop = ' ' if !$sysop;
-  $text = ' ' if !$text;
-  $wx = '0' if !$wx;
-  $tonode = '*' if !$tonode;
-  return "PC12^$call^$tonode^$text^$sysop^$main::mycall^$wx^$hops^~";
+       my ($call, $text, $tonode, $sysop, $wx, $origin) = @_;
+       my $hops = get_hops(12);
+       $text ||= ' ';
+       $text =~ s/\^/%5E/g;
+       $tonode ||= '*';
+       $sysop ||= ' ';
+       $wx ||= '0';
+       $origin ||= $main::mycall;
+       return "PC12^$call^$tonode^$text^$sysop^$origin^$wx^$hops^~";
 }
 
 #
 # add one or more users (I am expecting references that have 'call', 
-# 'confmode' & 'here' method) 
+# 'conf' & 'here' method) 
 #
 # this will create a list of PC16 with up pc16_max_users in each
 # called $self->pc16(..)
 #
 sub pc16
 {
-  my $self = shift;
-  my @out;
+       my $node = shift;
+       my $ncall = $node->call;
+       my @out;
 
-  foreach (@_) {
-    my $str = "PC16^$self->{call}";
-    my $i;
-    
-    for ($i = 0; @_ > 0  && $i < $DXProt::pc16_max_users; $i++) {
-      my $ref = shift;
-         $str .= sprintf "^%s %s %d", $ref->call, $ref->confmode ? '*' : '-', $ref->here;
+       my $s = "";
+       for (@_) {
+               next unless $_;
+               my $ref = $_;
+               my $str = sprintf "^%s %s %d", $ref->call, $ref->conf ? '*' : '-', $ref->here;
+               if (length($s) + length($str) > $sentencelth) {
+                       push @out, "PC16^$ncall" . $s . sprintf "^%s^", get_hops(16);
+                       $s = "";
+               }
+               $s .= $str;
        }
-    $str .= sprintf "^%s^", get_hops(16);
-       push @out, $str;
-  }
-  return (@out);
+       push @out, "PC16^$ncall" . $s . sprintf "^%s^", get_hops(16);
+       return @out;
 }
 
 # remove a local user
 sub pc17
 {
-  my ($self, $ref) = @_;
-  my $hops = get_hops(17);
-  return "PC17^$self->{call}^$ref->{call}^$hops^";
+       my @out;
+       while (@_) {
+               my $node = shift;
+               my $ref = shift;
+               my $hops = get_hops(17);
+               my $ncall = $node->call;
+               my $ucall = $ref->call;
+               push @out, "PC17^$ucall^$ncall^$hops^"; 
+       }
+       return @out;
 }
 
 # Request init string
 sub pc18
 {
-  return "PC18^wot a load of twaddle^$DXProt::myprot_version^~";
+       my $flags = "";
+       $flags .= " xml" if DXXml::available(); 
+       return "PC18^DXSpider Version: $main::version Build: $main::build$flags^$DXProt::myprot_version^";
 }
 
 #
@@ -100,140 +133,254 @@ sub pc18
 # 
 sub pc19
 {
-  my $self = shift;
-  my @out;
-
-  while (@_) {
-    my $str = "PC19";
-    my $i;
-    
-    for ($i = 0; @_ && $i < $DXProt::pc19_max_nodes; $i++) {
-      my $ref = shift;
-         my $here = $ref->{here} ? '1' : '0';
-         my $confmode = $ref->{confmode} ? '1' : '0';
-      $str .= "^$here^$ref->{call}^$confmode^$ref->{pcversion}";
+       my @out;
+       my @in;
+
+       my $s = "";
+       for (@_) {
+               next unless $_;
+               my $ref = $_;
+               my $call = $ref->call;
+               my $here = $ref->here;
+               my $conf = $ref->conf;
+               my $version = $ref->version;
+               my $str = "^$here^$call^$conf^$version";
+               if (length($s) + length($str) > $sentencelth) {
+                       push @out, "PC19" . $s . sprintf "^%s^", get_hops(19);
+                       $s = "";
+               }
+               $s .= $str;
        }
-    $str .= sprintf "^%s^", get_hops(19);
-       push @out, $str;
-  }
-  return @out;
+       push @out, "PC19" . $s . sprintf "^%s^", get_hops(19);
+       return @out;
 }
 
 # end of Rinit phase
 sub pc20
 {
-  return 'PC20^';
+       return 'PC20^';
 }
 
 # delete a node
 sub pc21
 {
-  my ($call, $reason) = @_;
-  my $hops = get_hops(21);
-  $reason = "Gone." if !$reason;
-  return "PC21^$call^$reason^$hops^";
+       my @out;
+       while (@_) {
+               my $node = shift;
+               my $hops = get_hops(21);
+               my $call = $node->call;
+               push @out, "PC21^$call^Gone^$hops^";
+       }
+       return @out;
 }
 
 # end of init phase
 sub pc22
 {
-  return 'PC22^';
+       return 'PC22^';
 }
 
 # here status
 sub pc24
 {
-  my $self = shift;
-  my $call = $self->call;
-  my $flag = $self->here ? '1' : '0';
-  my $hops = get_hops(24);
+       my $self = shift;
+       my $call = $self->call;
+       my $flag = $self->here ? '1' : '0';
+       my $hops = shift || get_hops(24);
   
-  return "PC24^$call^$flag^$hops^";
+       return "PC24^$call^$flag^$hops^";
+}
+
+
+# create a merged dx message (freq, dxcall, t, text, spotter, orig-node) 
+sub pc26
+{
+       my ($freq, $dxcall, $t, $text, $spotter, $orignode) = @_;
+       $text = ' ' unless $text;
+       $orignode = $main::mycall unless $orignode;
+       return sprintf "PC26^%.1f^$dxcall^%s^%s^$text^$spotter^$orignode^ ^~", $freq, cldate($t), ztime($t);
+}
+
+# create a merged WWV spot (logger, t, sfi, a, k, forecast, orig-node)
+sub pc27
+{
+       my ($logger, $t, $sfi, $a, $k, $forecast, $orignode) = @_;
+       return sprintf "PC27^%s^%-2.2s^$sfi^$a^$k^$forecast^$logger^$orignode^ ^~", cldate($t), ztime($t);
 }
 
 # message start (fromnode, tonode, to, from, t, private, subject, origin)
 sub pc28
 {
-  my ($fromnode, $tonode, $to, $from, $t, $private, $subject, $origin) = @_;
-  my $date = cldate($t);
-  my $time = ztime($t);
-  $private = $private ? '1' : '0';
-  return "PC28^$fromnode^$tonode^$to^from^$date^$time^$private^$subject^ ^5^0^ ^$origin^~";
+       my ($tonode, $fromnode, $to, $from, $t, $private, $subject, $origin, $rr) = @_;
+       my $date = cldate($t);
+       my $time = ztime($t);
+       $private = $private ? '1' : '0';
+       $rr = $rr ? '1' : '0';
+       $subject ||= ' ';
+       return "PC28^$tonode^$fromnode^$to^$from^$date^$time^$private^$subject^ ^5^$rr^ ^$origin^~";
 }
 
 # message text (from and to node same way round as pc29)
 sub pc29 
 {
-  my ($fromnode, $tonode, $stream, $text) = @_;
-  $text =~ s/\^//og;        # remove ^
-  return "PC29^$fromnode^$tonode^$stream^text^~";
+       my ($fromnode, $tonode, $stream, $text) = @_;
+       $text = ' ' unless defined $text && length $text > 0;
+       $text =~ s/\^/%5E/og;                   # remove ^
+       return "PC29^$fromnode^$tonode^$stream^$text^~";
 }
 
 # subject acknowledge (will have to and from node reversed to pc28)
 sub pc30
 {
-  my ($fromnode, $tonode, $stream) = @_;
-  return "PC30^$fromnode^$tonode^$stream^";
+       my ($fromnode, $tonode, $stream) = @_;
+       return "PC30^$fromnode^$tonode^$stream^";
 }
 
 # acknowledge this tranche of lines (to and from nodes reversed to pc29 and pc28
 sub pc31
 {
-  my ($fromnode, $tonode, $stream) = @_;
-  return "PC31^$fromnode^$tonode^$stream^";
+       my ($fromnode, $tonode, $stream) = @_;
+       return "PC31^$fromnode^$tonode^$stream^";
 }
 
 #  end of message from the sending end (pc28 node order)
 sub pc32
 {
-  my ($fromnode, $tonode, $stream) = @_;
-  return "PC32^$fromnode^$tonode^$stream^";
+       my ($fromnode, $tonode, $stream) = @_;
+       return "PC32^$fromnode^$tonode^$stream^";
 }
 
 # acknowledge end of message from receiving end (opposite pc28 node order)
 sub pc33
 {
-  my ($fromnode, $tonode, $stream) = @_;
-  return "PC33^$fromnode^$tonode^$stream^";
+       my ($fromnode, $tonode, $stream) = @_;
+       return "PC33^$fromnode^$tonode^$stream^";
 }
 
+# remote cmd send
+sub pc34
+{
+       my($fromnode, $tonode, $msg) = @_;
+       return "PC34^$tonode^$fromnode^$msg^~";
+}
+
+# remote cmd reply
+sub pc35
+{
+       my($fromnode, $tonode, $msg) = @_;
+       return "PC35^$tonode^$fromnode^$msg^~";
+}
 
 # send all the DX clusters I reckon are connected
 sub pc38
 {
-  my @list = DXNode->get_all();
-  my $list;
-  my @nodes;
-  
-  foreach $list (@list) {
-    push @nodes, $list->call;
-  }
-  return "PC38^" . join(',', @nodes) . "^~";
+       return join '^', "PC38", map {$_->call} Route::Node::get_all();
 }
 
 # tell the local node to discconnect
 sub pc39
 {
-  my ($ref, $reason) = @_;
-  my $call = $ref->call;
-  my $hops = get_hops(21);
-  $reason = "Gone." if !$reason;
-  return "PC39^$call^$reason^";
+       my ($call, $reason) = @_;
+       my $hops = get_hops(39);
+       $reason = "Gone." if !$reason;
+       return "PC39^$call^$reason^$hops^";
+}
+
+# cue up bulletin or file for transfer
+sub pc40
+{
+       my ($to, $from, $fn, $bull) = @_;
+       $bull = $bull ? '1' : '0';
+       return "PC40^$to^$from^$fn^$bull^5^";
+}
+
+# user info
+sub pc41
+{
+       my $call = shift;
+       $call = shift if ref $call;
+       
+       my $sort = shift || '0';
+       my $info = shift || ' ';
+       my $hops = shift || get_hops(41);
+       return "PC41^$call^$sort^$info^$hops^~";
+}
+
+# abort message
+sub pc42
+{
+       my ($fromnode, $tonode, $stream) = @_;
+       return "PC42^$fromnode^$tonode^$stream^";
+}
+
+# remote db request
+sub pc44
+{
+       my ($fromnode, $tonode, $stream, $db, $req, $call) = @_;
+       $db = uc $db;
+       return "PC44^$tonode^$fromnode^$stream^$db^$req^$call^";
+}
+
+# remote db data
+sub pc45
+{
+       my ($fromnode, $tonode, $stream, $data) = @_;
+       return "PC45^$tonode^$fromnode^$stream^$data^";
+}
+
+# remote db data complete
+sub pc46
+{
+       my ($fromnode, $tonode, $stream) = @_;
+       return "PC46^$tonode^$fromnode^$stream^";
+}
+
+# bull delete
+sub pc49
+{
+       my ($from, $subject) = @_;
+       my $hops = get_hops(49);
+       return "PC49^$from^$subject^$hops^~";
 }
 
 # periodic update of users, plus keep link alive device (always H99)
 sub pc50
 {
-  my $me = DXCluster->get($main::mycall);
-  my $n = $me->users ? $me->users : '0';
-  return "PC50^$main::mycall^$n^H99^";
+       my $self = shift;
+       my $call = $self->call;
+       my $n = shift || '0';
+       my $hops = shift || 'H99';
+       return "PC50^$call^$n^$hops^";
 }
 
 # generate pings
 sub pc51
 {
-  my ($self, $to, $from, $val) = @_;
-  return "PC51^$to^$from^$val^";
+       my ($to, $from, $val) = @_;
+       return "PC51^$to^$from^$val^";
 }
+
+# clx remote cmd send
+sub pc84
+{
+       my($fromnode, $tonode, $call, $msg) = @_;
+       return "PC84^$tonode^$fromnode^$call^$msg^~";
+}
+
+# clx remote cmd reply
+sub pc85
+{
+       my($fromnode, $tonode, $call, $msg) = @_;
+       return "PC85^$tonode^$fromnode^$call^$msg^~";
+}
+
+# spider route broadcast
+sub pc90
+{
+}
+
 1;
 __END__
+
+
+