made the censoring of PC10,11,12 optional with $censorpc = 0
[spider.git] / perl / DXProt.pm
index 7a324625f4e9342304b1545cf2718c83ea5efa89..60e0391f2e34e7e3bb73a061e40b7d0b274a9ea6 100644 (file)
@@ -29,12 +29,13 @@ use AnnTalk;
 use Geomag;
 use WCY;
 use Time::HiRes qw(gettimeofday tv_interval);
+use BadWords;
 
 use strict;
 use vars qw($me $pc11_max_age $pc23_max_age
                        $last_hour %pings %rcmds
-                       %nodehops @baddx $baddxfn 
-                       $allowzero $decode_dk0wcy $send_opernam);
+                       %nodehops @baddx $baddxfn $censorpc
+                       $allowzero $decode_dk0wcy $send_opernam @checklist);
 
 $me = undef;                                   # the channel id for this cluster
 $pc11_max_age = 1*3600;                        # the maximum age for an incoming 'real-time' pc11
@@ -45,10 +46,127 @@ $last_hour = time;                         # last time I did an hourly periodic update
 %rcmds = ();                    # outstanding rcmd requests outbound
 %nodehops = ();                 # node specific hop control
 @baddx = ();                    # list of illegal spotted callsigns
-
+$censorpc = 0;                                 # Do a BadWords::check on text fields and reject things
 
 $baddxfn = "$main::data/baddx.pl";
 
+@checklist = 
+(
+ [ qw(c c m bp bc c) ],                        # pc10
+ [ qw(f m d t m c c h) ],              # pc11
+ [ qw(c bc m bp bm p h) ],             # pc12
+ [ qw(c h) ],                                  # 
+ [ qw(c h) ],                                  # 
+ [ qw(c m h) ],                                        # 
+ undef ,                                               # pc16 has to be validated manually
+ [ qw(c c h) ],                                        # pc17
+ [ qw(m n) ],                                  # pc18
+ undef ,                                               # pc19 has to be validated manually
+ undef ,                                               # pc20 no validation
+ [ qw(c m h) ],                                        # pc21
+ undef ,                                               # pc22 no validation
+ [ qw(d n n n n m c c h) ],            # pc23
+ [ qw(c p h) ],                                        # pc24
+ [ qw(c c n n) ],                              # pc25
+ [ qw(f m d t m c c bc) ],             # pc26
+ [ qw(d n n n n m c c bc) ],   # pc27
+ [ qw(c c c c d t p m bp n p bp bc) ], # pc28
+ [ qw(c c n m) ],                              # pc29
+ [ qw(c c n) ],                                        # pc30
+ [ qw(c c n) ],                                        # pc31
+ [ qw(c c n) ],                                        # pc32
+ [ qw(c c n) ],                                        # pc33
+ [ qw(c c m) ],                                        # pc34
+ [ qw(c c m) ],                                        # pc35
+ [ qw(c c m) ],                                        # pc36
+ [ qw(c c n m) ],                              # pc37
+ undef,                                                        # pc38 not interested
+ [ qw(c m) ],                                  # pc39
+ [ qw(c c m p n) ],                            # pc40
+ [ qw(c n m h) ],                              # pc41
+ [ qw(c c n) ],                                        # pc42
+ undef,                                                        # pc43 don't handle it
+ [ qw(c c n m m c) ],                  # pc44
+ [ qw(c c n m) ],                              # pc45
+ [ qw(c c n) ],                                        # pc46
+ undef,                                                        # pc47
+ undef,                                                        # pc48
+ [ qw(c m h) ],                                        # pc49
+ [ qw(c n h) ],                                        # pc50
+ [ qw(c c n) ],                                        # pc51
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,                                                        # pc60
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,                                                        # pc70
+ undef,
+ undef,
+ [ qw(d n n n n n n m m m c c h) ],    # pc73
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,
+ undef,                                                        # pc80
+ undef,
+ undef,
+ undef,
+ [ qw(c c c m) ],                              # pc84
+ [ qw(c c c m) ],                              # pc85
+);
+
+# use the entry in the check list to check the field list presented
+# return OK if line NOT in check list (for now)
+sub check
+{
+       my $n = shift;
+       $n -= 10;
+       return 0 if $n < 0 || $n > @checklist; 
+       my $ref = $checklist[$n];
+       return 0 unless ref $ref;
+       
+       my $i;
+       shift;    # not interested in the first field
+       for ($i = 0; $i < @$ref; $i++) {
+               my ($blank, $act) = $$ref[$i] =~ /^(b?)(\w)$/;
+               return 0 unless $act;
+               next if $blank && $_[$i] =~ /^[ \*]$/;
+               if ($act eq 'c') {
+                       return $i+1 unless is_callsign($_[$i]);
+               } elsif ($act eq 'm') {
+                       return $i+1 unless is_pctext($_[$i]);
+               } elsif ($act eq 'p') {
+                       return $i+1 unless is_pcflag($_[$i]);
+               } elsif ($act eq 'f') {
+                       return $i+1 unless is_freq($_[$i]);
+               } elsif ($act eq 'n') {
+                       return $i+1 unless $_[$i] =~ /^[\d ]+$/;
+               } elsif ($act eq 'h') {
+                       return $i+1 unless $_[$i] =~ /^H\d\d?$/;
+               } elsif ($act eq 'd') {
+                       return $i+1 unless $_[$i] =~ /^\s*\d+-\w\w\w-[12][90]\d\d$/;
+               } elsif ($act eq 't') {
+                       return $i+1 unless $_[$i] =~ /^[012]\d[012345]\dZ$/;
+               }
+       }
+       return 0;
+}
+
 sub init
 {
        my $user = DXUser->get($main::mycall);
@@ -58,16 +176,16 @@ sub init
        $me->{state} = "indifferent";
        do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
        confess $@ if $@;
-       #  $me->{sort} = 'M';    # M for me
+       $me->{sort} = 'S';    # S for spider
 
        # now prime the spot and wwv  duplicates file with data
-    my @today = Julian::unixtoj(time);
-       for (Spot::readfile(@today), Spot::readfile(Julian::sub(@today, 1))) {
-               Spot::dup(@{$_}[0..3]);
-       }
-       for (Geomag::readfile(time)) {
-               Geomag::dup(@{$_}[1..5]);
-       }
+#    my @today = Julian::unixtoj(time);
+#      for (Spot::readfile(@today), Spot::readfile(Julian::sub(@today, 1))) {
+#              Spot::dup(@{$_}[0..3]);
+#      }
+#      for (Geomag::readfile(time)) {
+#              Geomag::dup(@{$_}[1..5]);
+#      }
 
        # load the baddx file
        do "$baddxfn" if -e "$baddxfn";
@@ -96,7 +214,7 @@ sub start
        # remember type of connection
        $self->{consort} = $line;
        $self->{outbound} = $sort eq 'O';
-       $self->{priv} = $user->priv;
+       $self->{priv} = $user->priv || 1;     # other clusters can always be 'normal' users
        $self->{lang} = $user->lang || 'en';
        $self->{isolate} = $user->{isolate};
        $self->{consort} = $line;       # save the connection type
@@ -122,7 +240,7 @@ sub start
 
        # send initialisation string
        unless ($self->{outbound}) {
-               $self->send(pc38()) if DXNode->get_all();
+#              $self->send(pc38()) if DXNode->get_all();
                $self->send(pc18());
                $self->{lastping} = $main::systime;
        } else {
@@ -146,6 +264,8 @@ sub normal
 {
        my ($self, $line) = @_;
        my @field = split /\^/, $line;
+       return unless @field;
+       
        pop @field if $field[-1] eq '~';
        
 #      print join(',', @field), "\n";
@@ -158,9 +278,10 @@ sub normal
        return unless $pcno;
        return if $pcno < 10 || $pcno > 99;
 
-       # dump bad protocol messages unless it is a PC29
-       if ($line =~ /\%[0-9A-F][0-9A-F]/o && $pcno != 29) {
-               dbg('chan', "CORRUPT protocol message - dumped");
+       # check for and dump bad protocol messages
+       my $n = check($pcno, @field);
+       if ($n) {
+               dbg('chan', "bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")");
                return;
        }
 
@@ -174,17 +295,28 @@ sub normal
        
  SWITCH: {
                if ($pcno == 10) {              # incoming talk
-                       
+
+                       # will we allow it at all?
+                       if ($censorpc) {
+                               my @bad;
+                               if (@bad = BadWords::check($field[3])) {
+                                       dbg('chan', "Bad words: @bad, dropped" );
+                                       return;
+                               }
+                       }
+
                        # is it for me or one of mine?
-                       my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
-                       if ($call eq $main::mycall || grep $_ eq $call, DXChannel::get_all_user_calls()) {
-                               
-                               # yes, it is
-                               my $text = unpad($field[3]);
-                               Log('talk', $call, $field[1], $field[6], $text);
-                               $call = $main::myalias if $call eq $main::mycall;
-                               my $ref = DXChannel->get($call);
-                               $ref->send("$call de $field[1]: $text") if $ref && $ref->{talk};
+                       my ($to, $via, $call, $dxchan);
+                       if ($field[5] gt ' ') {
+                               $call = $via = $field[2];
+                               $to = $field[5];
+                       } else {
+                               $call = $to = $field[2];
+                       }
+                       $dxchan = DXChannel->get($call);
+                       if ($dxchan && $dxchan->is_user) {
+                               $field[3] =~ s/\%5E/^/g;
+                               $dxchan->talk($field[1], $to, $via, $field[3]);
                        } else {
                                $self->route($field[2], $line); # relay it on its way
                        }
@@ -220,12 +352,6 @@ sub normal
                                dbg('chan', "Bad DX spot, ignored");
                                return;
                        }
-
-                       # are any of the crucial fields invalid?
-            if ($field[2] =~ /(?:^\s*$|[a-z])/ || $field[6] =~ /(?:^\s*$|[a-z])/ || $field[7] =~ /(?:^\s*$|[a-z])/) {
-                               dbg('chan', "Spot contains lower case callsigns or blanks, rejected");
-                               return;
-                       }
                        
                        # do some de-duping
                        $field[5] =~ s/^\s+//;      # take any leading blanks off
@@ -233,6 +359,13 @@ sub normal
                                dbg('chan', "Duplicate Spot ignored\n");
                                return;
                        }
+                       if ($censorpc) {
+                               my @bad;
+                               if (@bad = BadWords::check($field[5])) {
+                                       dbg('chan', "Bad words: @bad, dropped" );
+                                       return;
+                               }
+                       }
                        
                        my @spot = Spot::add($field[1], $field[2], $d, $field[5], $field[6], $field[7]);
 
@@ -306,9 +439,17 @@ sub normal
                        # announce duplicate checking
                        $field[3] =~ s/^\s+//;  # remove leading blanks
                        if (AnnTalk::dup($field[1], $field[2], $field[3])) {
-                               dbg('chan', "Duplicate Announce ignored\n");
+                               dbg('chan', "Duplicate Announce ignored");
                                return;
                        }
+
+                       if ($censorpc) {
+                               my @bad;
+                               if (@bad = BadWords::check($field[3])) {
+                                       dbg('chan', "Bad words: @bad, dropped" );
+                                       return;
+                               }
+                       }
                        
                        if ($field[2] eq '*' || $field[2] eq $main::mycall) {
                                
@@ -499,12 +640,16 @@ sub normal
                        if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
                                my $node = DXCluster->get_exact($call);
                                if ($node) {
+                                       if ($call eq $self->{call}) {
+                                               dbg('chan', "LOOP: Trying to disconnect myself with PC21");
+                                               return;
+                                       } 
                                        if ($node->dxchan != $self) {
                                                dbg('chan', "LOOP: $call come in on wrong channel");
                                                return;
                                        }
                                        my $dxchan;
-                                       if (($dxchan = DXChannel->get($call)) && $dxchan != $self) {
+                                       if ($dxchan = DXChannel->get($call)) {
                                                dbg('chan', "LOOP: $call connected locally");
                                                return;
                                        }
@@ -609,7 +754,7 @@ sub normal
                        if ($pcno == 49 || $field[1] eq $main::mycall) {
                                DXMsg::process($self, $line);
                        } else {
-                               $self->route($field[1], $line);
+                               $self->route($field[1], $line) unless $self->is_clx;
                        }
                        return;
                }
@@ -619,7 +764,7 @@ sub normal
                                my $ref = DXUser->get_current($field[2]);
                                my $cref = DXCluster->get($field[2]);
                                Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
-                               unless ($field[3] =~ /rcmd/i || !$cref || !$ref || $cref->mynode->call ne $ref->homenode) {    # not allowed to relay RCMDS!
+                               unless (!$cref || !$ref || $cref->mynode->call ne $ref->homenode) {    # not allowed to relay RCMDS!
                                        if ($ref->{priv}) {     # you have to have SOME privilege, the commands have further filtering
                                                $self->{remotecmd} = 1; # for the benefit of any command that needs to know
                                                my $oldpriv = $self->{priv};
@@ -656,6 +801,10 @@ sub normal
                                        my $dxchan = DXChannel->get($s->{call});
                                        $dxchan->send($field[3]) if $dxchan;
                                        delete $rcmds{$field[2]} if !$dxchan;
+                               } else {
+                                       # send unsolicited ones to the sysop
+                                       my $dxchan = DXChannel->get($main::myalias);
+                                       $dxchan->send($field[3]) if $dxchan;
                                }
                        } else {
                                my $ref = DXUser->get_current($field[1]);
@@ -697,9 +846,7 @@ sub normal
                                my ($lat, $long) = DXBearing::stoll($field[3]);
                                $user->lat($lat);
                                $user->long($long);
-                               my $qra = $user->qra || DXBearing::lltoqra($lat, $long);
-                               $qra = DXBearing::lltoqra($lat, $long) unless $qra && DXBearing::is_qra($qra);
-                               $user->qra($qra) if $qra ne $user->qra;
+                               $user->qra(DXBearing::lltoqra($lat, $long)) unless $user->qra && DXBearing::is_qra($user->qra);
                        } elsif ($field[2] == 4) {
                                $user->homenode($field[3]);
                        }
@@ -768,6 +915,13 @@ sub normal
                        return;
                }
 
+               if ($pcno == 75) {              # dunno but route it
+                       if ($field[1] ne $main::mycall) {
+                               $self->route($field[1], $line);
+                       }
+                       return;
+               }
+
                if ($pcno == 73) {  # WCY broadcasts
                        
                        # do some de-duping
@@ -842,6 +996,10 @@ sub normal
                                                $dxchan = DXChannel->get($s->{call});
                                                $dxchan->send($field[4]) if $dxchan;
                                                delete $rcmds{$field[2]} if !$dxchan;
+                                       } else {
+                                               # send unsolicited ones to the sysop
+                                               my $dxchan = DXChannel->get($main::myalias);
+                                               $dxchan->send($field[4]) if $dxchan;
                                        }
                                }
                        } else {
@@ -905,9 +1063,9 @@ sub process
        my $val;
        my $cutoff;
        if ($main::systime - 3600 > $last_hour) {
-               Spot::process;
-               Geomag::process;
-               AnnTalk::process;
+#              Spot::process;
+#              Geomag::process;
+#              AnnTalk::process;
                $last_hour = $main::systime;
        }
 }
@@ -990,7 +1148,8 @@ sub send_dx_spot
                } elsif ($dxchan->is_user && $dxchan->{dx}) {
                        my $buf = Spot::formatb($dxchan->{user}->wantgrid, $_[0], $_[1], $_[2], $_[3], $_[4]);
                        $buf .= "\a\a" if $dxchan->{beep};
-                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
+                       $buf =~ s/\%5E/^/g;
+                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
                                $dxchan->send($buf);
                        } else {
                                $dxchan->delay($buf);
@@ -1034,7 +1193,7 @@ sub send_wwv_spot
                } elsif ($dxchan->is_user && $dxchan->{wwv}) {
                        my $buf = "WWV de $_[6] <$_[1]>:   SFI=$_[2], A=$_[3], K=$_[4], $_[5]";
                        $buf .= "\a\a" if $dxchan->{beep};
-                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
+                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
                                $dxchan->send($buf);
                        } else {
                                $dxchan->delay($buf);
@@ -1077,7 +1236,7 @@ sub send_wcy_spot
                } elsif ($dxchan->is_user && $dxchan->{wcy}) {
                        my $buf = "WCY de $_[10] <$_[1]> : K=$_[4] expK=$_[5] A=$_[3] R=$_[6] SFI=$_[2] SA=$_[7] GMF=$_[8] Au=$_[9]";
                        $buf .= "\a\a" if $dxchan->{beep};
-                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
+                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
                                $dxchan->send($buf);
                        } else {
                                $dxchan->delay($buf);
@@ -1137,11 +1296,15 @@ sub send_announce
                                $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
                                
                        }
-               } elsif ($dxchan->is_user && $dxchan->{ann}) {
+               } elsif ($dxchan->is_user) {
+                       unless ($dxchan->{ann}) {
+                               next if $_[0] ne $main::myalias && $_[0] ne $main::mycall;
+                       }
                        next if $target eq 'SYSOP' && $dxchan->{priv} < 5;
                        my $buf = "$to$target de $_[0]: $text";
+                       $buf =~ s/\%5E/^/g;
                        $buf .= "\a\a" if $dxchan->{beep};
-                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
+                       if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
                                $dxchan->send($buf);
                        } else {
                                $dxchan->delay($buf);
@@ -1222,7 +1385,7 @@ sub broadcast_ak1a
 {
        my $s = shift;                          # the line to be rebroadcast
        my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
-       my @dxchan = DXChannel::get_all_ak1a();
+       my @dxchan = DXChannel::get_all_nodes();
        my $dxchan;
        
        # send it if it isn't the except list and isn't isolated and still has a hop count
@@ -1239,7 +1402,7 @@ sub broadcast_all_ak1a
 {
        my $s = shift;                          # the line to be rebroadcast
        my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
-       my @dxchan = DXChannel::get_all_ak1a();
+       my @dxchan = DXChannel::get_all_nodes();
        my $dxchan;
        
        # send it if it isn't the except list and isn't isolated and still has a hop count
@@ -1292,7 +1455,7 @@ sub broadcast_list
 
                $s =~ s/\a//og unless $dxchan->{beep};
 
-               if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
+               if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
                        $dxchan->send($s);      
                } else {
                        $dxchan->delay($s);
@@ -1402,5 +1565,18 @@ sub disconnect
 
        $self->SUPER::disconnect;
 }
+
+
+# 
+# send a talk message to this thingy
+#
+sub talk
+{
+       my ($self, $from, $to, $via, $line) = @_;
+       
+       $line =~ s/\^/\\5E/g;                   # remove any ^ characters
+       $self->send(DXProt::pc10($from, $to, $via, $line));
+       Log('talk', $self->call, $from, $via?$via:$main::mycall, $line);
+}
 1;
 __END__