route the right thing in the user portion of PC16
[spider.git] / perl / DXProt.pm
index 9a4f367339a7699459028bcec4bb813a2e36afb7..ab989c8f3ccf404cec3397006c3b4727919ca8d3 100644 (file)
@@ -44,6 +44,7 @@ $main::branch += $BRANCH;
 
 use vars qw($pc11_max_age $pc23_max_age $last_pc50 $eph_restime $eph_info_restime $eph_pc34_restime
                        $last_hour $last10 %eph  %pings %rcmds $ann_to_talk
+                       $pingint $obscount %pc19list
                        %nodehops $baddx $badspotter $badnode $censorpc $rspfcheck
                        $allowzero $decode_dk0wcy $send_opernam @checklist);
 
@@ -54,6 +55,8 @@ $last_hour = time;                            # last time I did an hourly periodic update
 %pings = ();                    # outstanding ping requests outbound
 %rcmds = ();                    # outstanding rcmd requests outbound
 %nodehops = ();                 # node specific hop control
+%pc19list = ();                                        # list of outstanding PC19s that haven't had PC16s on them
+
 $censorpc = 1;                                 # Do a BadWords::check on text fields and reject things
                                                                # loads of 'bad things'
 $baddx = new DXHash "baddx";
@@ -65,6 +68,8 @@ $rspfcheck = 1;
 $eph_restime = 180;
 $eph_info_restime = 60*60;
 $eph_pc34_restime = 30;
+$pingint = 5*60;
+$obscount = 2;
 
 @checklist = 
 (
@@ -255,9 +260,9 @@ sub start
        
        # ping neighbour node stuff
        my $ping = $user->pingint;
-       $ping = 5*60 unless defined $ping;
+       $ping = $pingint unless defined $ping;
        $self->{pingint} = $ping;
-       $self->{nopings} = $user->nopings || 2;
+       $self->{nopings} = $user->nopings || $obscount;
        $self->{pingtime} = [ ];
        $self->{pingave} = 999;
        $self->{metric} ||= 100;
@@ -471,7 +476,7 @@ sub normal
                        # this goes after the input filtering, but before the add
                        # so that if it is input filtered, it isn't added to the dup
                        # list. This allows it to come in from a "legitimate" source
-                       if (Spot::dup($field[1], $field[2], $d, $field[5])) {
+                       if (Spot::dup($field[1], $field[2], $d, $field[5], $field[6])) {
                                dbg("PCPROT: Duplicate Spot ignored\n") if isdbg('chanerr');
                                return;
                        }
@@ -625,24 +630,82 @@ sub normal
                        my $ncall = $field[1];
                        my $newline = "PC16^";
                        
+                       # do I want users from this channel?
+                       unless ($self->user->wantpc16) {
+                               dbg("PCPROT: don't send users to $self->{call}") if isdbg('chanerr');
+                               return;
+                       }
+                       # is it me?
                        if ($ncall eq $main::mycall) {
                                dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
                                return;
                        }
                        my $parent = Route::Node::get($ncall); 
+
+                       # if there is a parent, proceed, otherwise if there is a latent PC19 in the PC19list, 
+                       # fix it up in the routing tables and issue it forth before the PC16
                        unless ($parent) {
-                               dbg("PCPROT: Node $ncall not in config") if isdbg('chanerr');
-                               return;
-                       }
-                       $dxchan = $parent->dxchan;
-                       if ($dxchan && $dxchan ne $self) {
-                               dbg("PCPROT: PC16 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
-                               return;
+                               my $nl = $pc19list{$ncall};
+
+                               if ($nl && @field > 3) {                     # 3 because of the hop count!
+
+                                       # this is a new (remembered) node, now attach it to me if it isn't in filtered
+                                       # and we haven't disallowed it
+                                       my $user = DXUser->get_current($ncall);
+                                       if (!$user) {
+                                               $user = DXUser->new($ncall);
+                                               $user->sort('A');
+                                               $user->priv(1);                   # I have relented and defaulted nodes
+                                               $user->lockout(1);
+                                               $user->homenode($ncall);
+                                               $user->node($ncall);
+                                       }
+
+                                       my $wantpc19 = $user->wantroutepc19;
+                                       if ($wantpc19 || !defined $wantpc19) {
+                                               my $new = Route->new($ncall);          # throw away
+                                               if ($self->in_filter_route($new)) {
+                                                       my @nrout;
+                                                       for (@$nl) {
+                                                               $parent = Route::Node::get($_->[0]);
+                                                               $dxchan = $parent->dxchan if $parent;
+                                                               if ($dxchan && $dxchan ne $self) {
+                                                                       dbg("PCPROT: PC16 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
+                                                                       $parent = undef;
+                                                               }
+                                                               if ($parent) {
+                                                                       my $r = $parent->add($ncall, $_->[1], $_->[2]);
+                                                                       push @nrout, $r unless @nrout;
+                                                               }
+                                                       }
+                                                       $user->wantroutepc19(1) unless defined $wantpc19;              # for now we work on the basis that pc16 = real route 
+                                                       $user->lastin($main::systime) unless DXChannel->get($ncall);
+                                                       $user->put;
+                                               
+                                                       # route the pc19 - this will cause 'stuttering PC19s' for a while
+                                                       $self->route_pc19(@nrout) if @nrout ;
+                                                       $parent = Route::Node::get($ncall);
+                                               } else {
+                                                       return;
+                                               }
+                                               delete $pc19list{$ncall};
+                                       }
+                               } else {
+                                       dbg("PCPROT: Node $ncall not in config") if isdbg('chanerr');
+                                       return;
+                               }
+                       } else {
+                               
+                               $dxchan = $parent->dxchan;
+                               if ($dxchan && $dxchan ne $self) {
+                                       dbg("PCPROT: PC16 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
+                                       return;
+                               }
+
+                               # input filter if required
+                               return unless $self->in_filter_route($parent);
                        }
 
-                       # input filter if required
-                       return unless $self->in_filter_route($parent);
-                       
                        my $i;
                        my @rout;
                        for ($i = 2; $i < $#field; $i++) {
@@ -666,14 +729,16 @@ sub normal
                                my $flags = Route::here($here)|Route::conf($conf);
                                
                                if ($r) {
+                                       my $au = $r->addparent($parent);                                        
                                        if ($r->flags != $flags) {
                                                $r->flags($flags);
-                                               push @rout, $r;
+                                               $au = $r;
                                        }
-                                       $r->addparent($parent);
+                                       push @rout, $r if $au;
                                } else {
                                        push @rout, $parent->add_user($call, $flags);
                                }
+               
                                
                                # add this station to the user database, if required
                                $call =~ s/-\d+$//o;        # remove ssid for users
@@ -699,6 +764,11 @@ sub normal
 
                        eph_del_regex("^PC16\\^$ncall.*$ucall");
                        
+                       # do I want users from this channel?
+                       unless ($self->user->wantpc16) {
+                               dbg("PCPROT: don't send users to $self->{call}") if isdbg('chanerr');
+                               return;
+                       }
                        if ($ncall eq $main::mycall) {
                                dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
                                return;
@@ -805,9 +875,21 @@ sub normal
                                        next;
                                }
 
-                               # update it if required
+                               # add this station to the user database, if required (don't remove SSID from nodes)
+                               my $user = DXUser->get_current($call);
+                               if (!$user) {
+                                       $user = DXUser->new($call);
+                                       $user->sort('A');
+                                       $user->priv(1);                   # I have relented and defaulted nodes
+                                       $user->lockout(1);
+                                       $user->homenode($call);
+                                       $user->node($call);
+                               }
+
                                my $r = Route::Node::get($call);
                                my $flags = Route::here($here)|Route::conf($conf);
+
+                               # modify the routing table if it is in it, otherwise store it in the pc19list for now
                                if ($r) {
                                        my $ar;
                                        if ($call ne $parent->call) {
@@ -824,17 +906,21 @@ sub normal
                                                push @rout, $r unless $ar;
                                        }
                                } else {
-                                       if ($call eq $self->{call}) {
-                                               dbg("DXPROT: my channel route for $call has disappeared");
-                                               next;
-                                       };
-                                       
-                                       my $new = Route->new($call);          # throw away
-                                   if ($self->in_filter_route($new)) {
-                                               my $r = $parent->add($call, $ver, $flags);
-                                               push @rout, $r;
+
+                                       # if he is directly connected or allowed then add him, otherwise store him up for later
+                                       if ($call eq $self->{call} || $user->wantroutepc19) {
+                                               my $new = Route->new($call);          # throw away
+                                               if ($self->in_filter_route($new)) {
+                                                       my $ar = $parent->add($call, $ver, $flags);
+                                                       $user->wantroutepc19(1) unless defined $user->wantroutepc19;
+                                                       push @rout, $ar if $ar;
+                                               } else {
+                                                       next;
+                                               }
                                        } else {
-                                               next;
+                                               $pc19list{$call} = [] unless exists $pc19list{$call};
+                                               my $nl = $pc19list{$call};
+                                               push @{$pc19list{$call}}, [$self->{call}, $ver, $flags] unless grep $_->[0] eq $self->{call}, @$nl;
                                        }
                                }
 
@@ -842,16 +928,6 @@ sub normal
                                my $mref = DXMsg::get_busy($call);
                                $mref->stop_msg($call) if $mref;
                                
-                               # add this station to the user database, if required (don't remove SSID from nodes)
-                               my $user = DXUser->get_current($call);
-                               if (!$user) {
-                                       $user = DXUser->new($call);
-                                       $user->sort('A');
-                                       $user->priv(1);                   # I have relented and defaulted nodes
-                                       $user->lockout(1);
-                                       $user->homenode($call);
-                                       $user->node($call);
-                               }
                                $user->lastin($main::systime) unless DXChannel->get($call);
                                $user->put;
                        }
@@ -872,7 +948,7 @@ sub normal
                if ($pcno == 21) {              # delete a cluster from the list
                        my $call = uc $field[1];
 
-                       eph_del_regex("^PC1[79].*$call");
+                       eph_del_regex("^PC1[679].*$call");
                        
                        # if I get a PC21 from the same callsign as self then treat it
                        # as a PC39: I have gone away
@@ -881,39 +957,42 @@ sub normal
                                return;
                        }
 
+                       # check to see if we are in the pc19list, if we are then don't bother with any of
+                       # this routing table manipulation, just remove it from the list and dump it
                        my @rout;
-                       my $parent = Route::Node::get($self->{call});
-                       unless ($parent) {
-                               dbg("DXPROT: my parent $self->{call} has disappeared");
-                               $self->disconnect;
-                               return;
-                       }
-                       if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
-                               my $node = Route::Node::get($call);
-                               if ($node) {
-
-                                       my $dxchan = DXChannel->get($call);
-                                       if ($dxchan && $dxchan != $self) {
-                                               dbg("PCPROT: PC21 from $self->{call} trying to alter locally connected $call, ignored!") if isdbg('chanerr');
-                                               return;
+                       if (my $nl = $pc19list{$call}) {
+                               $pc19list{$call} = [ grep {$_->[0] ne $self->{call}} @$nl ];
+                               delete $pc19list{$call} unless @{$pc19list{$call}};
+                       } else {
+                               
+                               my $parent = Route::Node::get($self->{call});
+                               unless ($parent) {
+                                       dbg("DXPROT: my parent $self->{call} has disappeared");
+                                       $self->disconnect;
+                                       return;
+                               }
+                               if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
+                                       my $node = Route::Node::get($call);
+                                       if ($node) {
+                                               
+                                               my $dxchan = DXChannel->get($call);
+                                               if ($dxchan && $dxchan != $self) {
+                                                       dbg("PCPROT: PC21 from $self->{call} trying to alter locally connected $call, ignored!") if isdbg('chanerr');
+                                                       return;
+                                               }
+                                               
+                                               # input filter it
+                                               return unless $self->in_filter_route($node);
+                                               
+                                               # routing objects
+                                               push @rout, $node->del($parent);
                                        }
-
-                                       # input filter it
-                                       return unless $self->in_filter_route($node);
-
-                                       # routing objects
-                                       push @rout, $node->del($parent);
+                               } else {
+                                       dbg("PCPROT: I WILL _NOT_ be disconnected!") if isdbg('chanerr');
+                                       return;
                                }
-                       } else {
-                               dbg("PCPROT: I WILL _NOT_ be disconnected!") if isdbg('chanerr');
-                               return;
                        }
 
-#                      if (eph_dup($line)) {
-#                              dbg("PCPROT: dup PC21 detected") if isdbg('chanerr');
-#                              return;
-#                      }
-
                        $self->route_pc21(@rout) if @rout;
                        return;
                }
@@ -1498,24 +1577,27 @@ sub send_announce
 
        # obtain country codes etc 
        my ($ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
+       my ($ann_state, $org_state) = ("", "");
        my @dxcc = Prefix::extract($_[0]);
        if (@dxcc > 0) {
                $ann_dxcc = $dxcc[1]->dxcc;
                $ann_itu = $dxcc[1]->itu;
                $ann_cq = $dxcc[1]->cq;                                         
+               $ann_state = $dxcc[1]->state;
        }
        @dxcc = Prefix::extract($_[4]);
        if (@dxcc > 0) {
                $org_dxcc = $dxcc[1]->dxcc;
                $org_itu = $dxcc[1]->itu;
                $org_cq = $dxcc[1]->cq;                                         
+               $org_state = $dxcc[1]->state;
        }
 
        if ($self->{inannfilter}) {
                my ($filter, $hops) = 
                        $self->{inannfilter}->it(@_, $self->{call}, 
                                                                         $ann_dxcc, $ann_itu, $ann_cq,
-                                                                        $org_dxcc, $org_itu, $org_cq);
+                                                                        $org_dxcc, $org_itu, $org_cq, $ann_state, $org_state);
                unless ($filter) {
                        dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
                        return;
@@ -1559,7 +1641,7 @@ sub announce
 sub send_local_config
 {
        my $self = shift;
-       my $n;
+       my $node;
        my @nodes;
        my @localnodes;
        my @remotenodes;
@@ -1578,19 +1660,20 @@ sub send_local_config
                my @intcalls = map { $_->nodes } @localnodes if @localnodes;
                my $ref = Route::Node::get($self->{call});
                my @rnodes = $ref->nodes;
-               for my $n (@intcalls) {
-                       push @remotenodes, Route::Node::get($n) unless grep $n eq $_, @rnodes;
+               for my $node (@intcalls) {
+                       push @remotenodes, Route::Node::get($node) unless grep $node eq $_, @rnodes;
                }
                unshift @localnodes, $main::routeroot;
        }
        
 
-       send_route($self, \&pc19, scalar(@localnodes)+scalar(@remotenodes), @localnodes, @remotenodes);
+       $self->send_route(\&pc19, scalar(@localnodes)+scalar(@remotenodes), @localnodes, @remotenodes);
        
        # get all the users connected on the above nodes and send them out
-       foreach $n (@localnodes, @remotenodes) {
-               if ($n) {
-                       send_route($self, \&pc16, 1, $n, map {my $r = Route::User::get($_); $r ? ($r) : ()} $n->users);
+       foreach $node (@localnodes, @remotenodes) {
+               if ($node) {
+                       my @rout = map {my $r = Route::User::get($_); $r ? ($r) : ()} $node->users;
+                       $self->send_route(\&pc16, 1, $node, @rout) if @rout && $self->user->wantsendpc16;
                } else {
                        dbg("sent a null value") if isdbg('chanerr');
                }
@@ -1687,7 +1770,7 @@ sub load_hops
        return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
        do "$main::data/hop_table.pl";
        return $@ if $@;
-       return 0;
+       return ();
 }
 
 
@@ -1811,17 +1894,35 @@ sub disconnect
                $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
        }
 
-       # get rid of any PC16 and 19s
-       eph_del_regex("^PC16\\^$call");
-       eph_del_regex("^PC19\\^.*$call");
+       # get rid of any PC16/17/19
+       eph_del_regex("^PC1[679]*$call");
 
-       # do routing stuff
+       # 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;
+                       eph_del_regex("^PC1[679].*$c");
+               }
        }
        
+       # remove them from the pc19list as well
+       while (my ($k,$v) = each %pc19list) {
+               my @l = grep {$_->[0] ne $call} @{$pc19list{$k}};
+               if (@l) {
+                       $pc19list{$k} = \@l;
+               } else {
+                       delete $pc19list{$k};
+               }
+               
+               # and the ephemera
+               eph_del_regex("^PC1[679].*$k");
+       }
+
        # unbusy and stop and outgoing mail
        my $mref = DXMsg::get_busy($call);
        $mref->stop_msg($call) if $mref;
@@ -1875,7 +1976,7 @@ sub send_route
                if (!$self->{isolate} && $self->{routefilter}) {
                        $filter = undef;
                        if ($r) {
-                               ($filter, $hops) = $self->{routefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
+                               ($filter, $hops) = $self->{routefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq, $self->{state}, $r->{state});
                                if ($filter) {
                                        push @rin, $r;
                                } else {
@@ -1915,7 +2016,8 @@ sub broadcast_route
                        next if $dxchan == $self;
                        next if $dxchan == $main::me;
                        next if $dxchan->user->wantnp;
-                       
+                       next if ($generate == \&pc16 || $generate==\&pc17) && !$dxchan->user->wantsendpc16;
                        $dxchan->send_route($generate, @_);
                }
        }
@@ -1924,12 +2026,14 @@ sub broadcast_route
 sub route_pc16
 {
        my $self = shift;
+       return unless $self->user->wantpc16;
        broadcast_route($self, \&pc16, 1, @_);
 }
 
 sub route_pc17
 {
        my $self = shift;
+       return unless $self->user->wantpc16;
        broadcast_route($self, \&pc17, 1, @_);
 }
 
@@ -1976,7 +2080,7 @@ sub in_filter_route
        my ($filter, $hops) = (1, 1);
        
        if ($self->{inroutefilter}) {
-               ($filter, $hops) = $self->{inroutefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
+               ($filter, $hops) = $self->{inroutefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq, $self->state, $r->state);
                dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
        }
        return $filter;