make sure touser is passed on
[spider.git] / perl / Aranea.pm
index 1d0a912fe6dcea060b2f17d9d06b3e7ba594a106..7765af34fead427e39b4e7a12b2c95324994147d 100644 (file)
@@ -24,22 +24,30 @@ use Route::Node;
 use Script;
 use Verify;
 use DXDupe;
+use Thingy;
+use Thingy::Rt;
+use Thingy::Hello;
+use Thingy::Bye;
+use RouteDB;
+use DXProt;
+use DXCommandmode;
 
 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(@ISA $ntpflag $dupeage);
+main::mkver($VERSION = q$Revision$);
+
+use vars qw(@ISA $ntpflag $dupeage $cf_interval $hello_interval);
 
 @ISA = qw(DXChannel);
 
 $ntpflag = 0;                                  # should be set in startup if NTP in use
 $dupeage = 12*60*60;                   # duplicates stored half a day 
+$cf_interval = 30*60;                  # interval between config broadcasts
+$hello_interval = 3*60*60;             # interval between hello broadcasts for me and local users
 
 my $seqno = 0;
 my $dayno = 0;
+my $daystart = 0;
 
 sub init
 {
@@ -53,7 +61,6 @@ sub new
        # add this node to the table, the values get filled in later
        my $pkg = shift;
        my $call = shift;
-       $main::routeroot->add($call, '5000', Route::here(1)) if $call ne $main::mycall;
        $self->{'sort'} = 'W';
        return $self;
 }
@@ -67,7 +74,7 @@ sub start
        # log it
        my $host = $self->{conn}->{peerhost} || "unknown";
        Log('Aranea', "$call connected from $host");
-       
+
        # remember type of connection
        $self->{consort} = $line;
        $self->{outbound} = $sort eq 'O';
@@ -109,16 +116,22 @@ sub start
        $self->{metric} ||= 100;
        $self->{lastping} = $main::systime;
        
-       $self->state('init');
+       $self->state('normal');
        $self->{pc50_t} = $main::systime;
 
        # send info to all logged in thingies
        $self->tell_login('loginn');
 
+       # broadcast our configuration to the world
+       unless ($self->{outbound}) {
+               my $thing = Thingy::Rt->new_cf;
+               $thing->broadcast;
+               $main::me->lastcf($main::systime);
+       }
+       
        # run a script send the output to the debug file
        my $script = new Script(lc $call) || new Script('node_default');
        $script->run($self) if $script;
-       $self->send("Hello?");
 }
 
 #
@@ -127,19 +140,124 @@ sub start
 sub normal
 {
        my ($self, $line) = @_;
-
-       
+       my $thing = input($line);
+       $thing->queue($self) if $thing;
 }
 
 #
-# periodic processing
+# periodic processing (every second)
 #
 
+my $lastmin = time;
+
 sub process
 {
 
        # calc day number
-       $dayno = (gmtime($main::systime))[3];
+       my $d = (gmtime($main::systime))[3];
+       if ($d != $dayno) {
+               $dayno = $d;
+               $daystart = $main::systime - ($main::systime % 86400);
+       }
+       if ($main::systime >= $lastmin + 60) {
+               per_minute();
+               $lastmin = $main::systime;
+       }
+}
+
+sub per_minute
+{
+       # send hello and cf packages periodically
+       foreach my $dxchan (DXChannel::get_all()) {
+               next if $dxchan->is_aranea;
+               if ($main::systime >= $dxchan->lasthello + $hello_interval) {
+                       my $thing = Thingy::Hello->new(h => $dxchan->here);
+                       $thing->{user} = $dxchan->{call} unless $dxchan == $main::me;
+                       if (my $v = $dxchan->{version}) {
+                               if ($dxchan->is_spider) {
+                                       $thing->{sw} = 'DXSp';
+                               }
+                               $thing->{v} = $v;
+                       }
+                       $thing->{b} = $dxchan->{build} if $dxchan->{build};
+                       $thing->broadcast($dxchan);
+                       $dxchan->lasthello($main::systime);
+               }
+               if ($dxchan->is_node) {
+                       if ($main::systime >= $dxchan->lastcf + $cf_interval) {
+                               my $call = $dxchan->call;
+                               if ($dxchan == $main::me) {
+
+                                       # i am special but, currently, still a node
+                                       my $thing = Thingy::Rt->new_cf;
+                                       $thing->broadcast;
+                                       $dxchan->lastcf($main::systime);
+                               } else {
+
+                                       # i am a pc protocol node connected directly
+                                       my $thing = Thingy::Rt->new();
+                                       $thing->{user} = $call unless $dxchan == $main::me;
+                                       if (my $nref = Route::Node::get($call)) {
+                                               $thing->copy_pc16_data($nref);
+                                               $thing->broadcast($dxchan);
+                                               $dxchan->lastcf($main::systime);
+                                       } else {
+                                               dbg("Aranea::per_minute: Route::Node for $call disappeared");
+                                               $dxchan->disconnect;
+                                       }
+                               }
+                       }
+               }
+       }
+}
+
+sub disconnect
+{
+       my $self = shift;
+       my $call = $self->call;
+
+       return if $self->{disconnecting}++;
+
+       my $thing = Thingy::Bye->new(origin=>$main::mycall, user=>$call);
+       $thing->broadcast($self);
+
+       # get rid of any PC16/17/19
+       DXProt::eph_del_regex("^PC1[679]*$call");
+
+       # do routing stuff, remove me from routing table
+       my $node = Route::Node::get($call);
+       my @rout;
+       if ($node) {
+               @rout = $node->del($main::routeroot);
+               
+               # and all my ephemera as well
+               for (@rout) {
+                       my $c = $_->call;
+                       DXProt::eph_del_regex("^PC1[679].*$c");
+               }
+       }
+
+       RouteDB::delete_interface($call);
+       
+       # unbusy and stop and outgoing mail
+       my $mref = DXMsg::get_busy($call);
+       $mref->stop_msg($call) if $mref;
+       
+       # broadcast to all other nodes that all the nodes connected to via me are gone
+       DXProt::route_pc21($self, $main::mycall, undef, @rout) if @rout;
+
+       # remove outstanding pings
+       Thingy::Ping::forget($call);
+       
+       # I was the last node visited
+    $self->user->node($main::mycall);
+
+       # send info to all logged in thingies
+       $self->tell_login('logoutn');
+
+       Log('Aranea', $call . " Disconnected");
+
+       $self->SUPER::disconnect;
 }
 
 # 
@@ -147,86 +265,271 @@ sub process
 # because it has to be used before a channel is fully initialised).
 #
 
+sub formathead
+{
+       my $mycall = shift;
+       my $dts = shift;
+       my $hop = shift;
+       my $user = shift;
+       my $group = shift;
+       my $touser = shift;
+       
+       my $s = "$mycall,$dts,$hop";
+       $s .= ",$user" if $user;
+       if ($group) {
+               $s .= "," unless $user;
+               $s .= ",$group" if $group;
+               $s .= ",$touser" if $touser;
+       } 
+       return $s;
+}
+
 sub genheader
 {
        my $mycall = shift;
        my $to = shift;
        my $from = shift;
+       my $touser = shift;
        
        my $date = ((($dayno << 1) | $ntpflag) << 18) |  ($main::systime % 86400);
-       my $r = "$mycall,$to," . sprintf('%06X%04X,0', $date, $seqno);
-       $r .= ",$from" if $from;
+       my $r = formathead($mycall, sprintf('%6X%04X', $date, $seqno), 0, $from, $to, $touser);
        $seqno++;
        $seqno = 0 if $seqno > 0x0ffff;
        return $r;
 }
 
+#
+# decode the date time sequence group
+#
+
+sub decode_dts
+{
+       my $dts = shift;
+       my ($dt, $seqno) = map {hex} unpack "A6 A4", $dts;
+       my $secs = $dt & 0x3FFFF;
+       $dt >>= 18;
+       my $day = $dt >> 1;
+       my $ntp = $dt & 1;
+       my $t;
+       if ($dayno == $day) {
+               $t = $daystart + $secs;
+       } elsif ($dayno < $day) {
+               $t = $daystart + (($day-$dayno) * 86400) + $secs;
+       } else {
+               $t = $daystart + (($dayno-$day) * 86400) + $secs;
+       }
+       return ($t, $seqno, $ntp);
+}
+
 # subroutines to encode and decode values in lists 
 sub tencode
 {
        my $s = shift;
-       $s =~ s/([\%=|,\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
+       $s =~ s/([\%=|,\'\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
+#      $s = "'$s'" if $s =~ / /;
        return $s;
 }
 
 sub tdecode
 {
        my $s = shift;
+       $s =~ s/^'(.*)'$/$1/;
        $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
-       return $s;
+       return length $s ? $s : '';
 }
 
 sub genmsg
 {
        my $thing = shift;
-       my $name = shift;
+       my $list = ref $_[0] ? shift : \@_;
+       my ($name) = uc ref $thing;
+       $name =~ /::(\w+)$/;
+       $name = $1;
+       my $group = $thing->{group};
        my $head = genheader($thing->{origin}, 
-                                                ($thing->{group} || $thing->{touser} || $thing->{tonode}),
-                                                ($thing->{user} || $thing->{fromuser} || $thing->{fromnode})
+                                                $group,
+                                                ($thing->{user} || $thing->{fromuser} || $thing->{fromnode}),
+                                                $thing->{touser}
                                                );
-       my $data = "$name,";
-       while (@_) {
-               my $k = lc shift;
-               my $v = tencode(shift);
-               $data .= "$k=$v,";
+        
+       my $data = uc $name . ',';
+       while (@$list) {
+               my $k = lc shift @$list;
+               my $v = $thing->{$k};
+               $data .= "$k=" . tencode($v) . ',' if defined $v;
        }
        chop $data;
        return "$head|$data";
 }
 
+
+sub decode_input
+{
+       my $self = shift;
+       my $line = shift;
+       return ('I', $self->{call}, $line);
+}
+
 sub input
 {
        my $line = shift;
        my ($head, $data) = split /\|/, $line, 2;
        return unless $head && $data;
-       my ($origin, $group, $dts, $hop, $user) = split /,/, $head;
-       return if DXDupe::add("Ara,$origin,$dts", $dupeage);
-       $hop++;
+
+       my ($origin, $dts, $hop, $user, $group, $tocall) = split /,/, $head;
+       return if DXDupe::check("Ara,$origin,$dts", $dupeage);
+       my $err;
+       $err .= "incomplete header," unless $origin && $dts && defined $hop;
        my ($cmd, $rdata) = split /,/, $data, 2;
-       my $class = 'Thingy::' . ucfirst $cmd;
+
+       # validate it further
+       $err .= "missing cmd or data," unless $cmd && $data;
+       $err .= "invalid command ($cmd)," unless $cmd =~ /^[A-Z][A-Z0-9]*$/;
+
+       $err .= "from me," if $origin eq $main::mycall;
+       $err .= "invalid group ($group)," if $group && $group !~ /^[-A-Z0-9]{2,}$/;
+       $err .= "invalid tocall ($tocall)," if $tocall && !is_callsign($tocall);
+       $err .= "invalid fromcall ($user)," if $user && !is_callsign($user);
+
+       my $class = 'Thingy::' . ucfirst(lc $cmd);
        my $thing;
+       my ($t, $seqno, $ntp) = decode_dts($dts) unless $err;
+       dbg("dts: $dts = $ntp $t($main::systime) $seqno") if isdbg('dts');
+       $err .= "invalid date/seq," unless $t;
        
-       # create the appropriate Thingy
-       if (defined *$class) {
+       if ($err) {
+               chop $err;
+               dbg("Aranea input: $err");
+       } elsif ($class->can('new')) {
+               # create the appropriate Thingy
                $thing = $class->new();
 
                # reconstitute the header but wth hop increased by one
-               $head = join(',', $origin, $group, $dts, $hop);
-               $head .= ",$user" if $user;
+               $head = formathead($origin, $dts, ++$hop, $user, $group, $tocall);
                $thing->{Aranea} = "$head|$data";
 
                # store useful data
                $thing->{origin} = $origin;
-               $thing->{group} = $group;
-               $thing->{time} = decode_dts($dts);
+               $thing->{time} = $t;
+               $thing->{group} = $group if $group;
+               $thing->{touser} = $tocall if $tocall;
                $thing->{user} = $user if $user;
                $thing->{hopsaway} = $hop; 
+
+               if ($rdata) {
+                       for (split(/,/, $rdata)) {
+                               if (/=/) {
+                                       my ($k,$v) = split /=/, $_, 2;
+                                       $thing->{$k} = tdecode($v);
+                               } else {
+                                       $thing->{$_} = 1;
+                               }
+                       }
+               }
                
-               while (my ($k,$v) = split /,/, $rdata) {
-                       $thing->{$k} = tdecode($v);
+               # post process the thing, this generally adds on semantic meaning
+               # does parameter checking etc. It also adds / prepares the thingy so
+               # this is compatible with older protocol and arranges data so
+               # that the filtering can still work.
+               if ($thing->can('from_Aranea')) {
+
+                       # if a thing is ok then return that thing, otherwise return
+                       # nothing
+                       $thing = $thing->from_Aranea;
                }
        }
        return $thing;
 }
 
+# this is the DXChannel send
+# note that this does NOT send out stuff in same way as other DXChannels
+# it is just as it comes, no extra bits added (here)
+sub send                                               # this is always later and always data
+{
+       my $self = shift;
+       my $conn = $self->{conn};
+       return unless $conn;
+       my $call = $self->{call};
+
+       for (@_) {
+#              chomp;
+        my @lines = split /\n/;
+               for (@lines) {
+                       $conn->send_later($_);
+                       dbg("-> D $call $_") if isdbg('chan');
+               }
+       }
+       $self->{t} = $main::systime;
+}
+
+#
+# load of dummies for DXChannel broadcasts
+# these will go away in time?
+# These are all from PC protocol
+#
+
+sub dx_spot
+{
+       my $self = shift;
+       my $line = shift;
+       my $isolate = shift;
+       my ($filter, $hops);
+
+       if ($self->{spotsfilter}) {
+               ($filter, $hops) = $self->{spotsfilter}->it(@_);
+               return unless $filter;
+       }
+#      send_prot_line($self, $filter, $hops, $isolate, $line);
+}
+
+sub wwv
+{
+       my $self = shift;
+       my $line = shift;
+       my $isolate = shift;
+       my ($filter, $hops);
+       
+       if ($self->{wwvfilter}) {
+               ($filter, $hops) = $self->{wwvfilter}->it(@_);
+               return unless $filter;
+       }
+#      send_prot_line($self, $filter, $hops, $isolate, $line)
+}
+
+sub wcy
+{
+       my $self = shift;
+       my $line = shift;
+       my $isolate = shift;
+       my ($filter, $hops);
+
+       if ($self->{wcyfilter}) {
+               ($filter, $hops) = $self->{wcyfilter}->it(@_);
+               return unless $filter;
+       }
+#      send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
+}
+
+sub announce
+{
+       my $self = shift;
+       my $line = shift;
+       my $isolate = shift;
+       my $to = shift;
+       my $target = shift;
+       my $text = shift;
+       my ($filter, $hops);
+
+       if ($self->{annfilter}) {
+               ($filter, $hops) = $self->{annfilter}->it(@_);
+               return unless $filter;
+       }
+#      send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
+}
+
+sub chat
+{
+       goto &announce;
+}
+
 1;