perl/DXProt.pm

   1 #!/usr/bin/perl
   2 #
   3 # This module impliments the protocal mode for a dx cluster
   4 #
   5 # Copyright (c) 1998 Dirk Koopman G1TLH
   6 #
   7 # $Id$
   8 #
   9
  10 package DXProt;
  11
  12 @ISA = qw(DXChannel);
  13
  14 use DXUtil;
  15 use DXChannel;
  16 use DXUser;
  17 use DXM;
  18 use DXCluster;
  19 use DXProtVars;
  20 use DXCommandmode;
  21 use DXLog;
  22 use Spot;
  23 use DXProtout;
  24 use Carp;
  25
  26 use strict;
  27 use vars qw($me $pc11_max_age $pc11_dup_age %dup $last_hour %pings %rcmds);
  28
  29 $me = undef;                                    # the channel id for this cluster
  30 $pc11_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc11
  31 $pc11_dup_age = 24*3600;                # the maximum time to keep the dup list for
  32 %dup = ();                                              # the pc11 and 26 dup hash
  33 $last_hour = time;                              # last time I did an hourly periodic update
  34 %pings = ();                    # outstanding ping requests outbound
  35 %rcmds = ();                    # outstanding rcmd requests outbound
  36
  37 sub init
  38 {
  39         my $user = DXUser->get($main::mycall);
  40         $me = DXProt->new($main::mycall, undef, $user);
  41         $me->{here} = 1;
  42         #  $me->{sort} = 'M';    # M for me
  43 }
  44
  45 #
  46 # obtain a new connection this is derived from dxchannel
  47 #
  48
  49 sub new
  50 {
  51         my $self = DXChannel::alloc(@_);
  52         $self->{sort} = 'A';            # in absence of how to find out what sort of an object I am
  53         return $self;
  54 }
  55
  56 # this is how a pc connection starts (for an incoming connection)
  57 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
  58 # all the crap that comes between).
  59 sub start
  60 {
  61         my ($self, $line, $sort) = @_;
  62         my $call = $self->{call};
  63         my $user = $self->{user};
  64
  65         # remember type of connection
  66         $self->{consort} = $line;
  67         $self->{outbound} = $sort eq 'O';
  68         $self->{priv} = $user->priv;
  69         $self->{lang} = $user->lang;
  70         $self->{consort} = $line;       # save the connection type
  71         $self->{here} = 1;
  72
  73         # set unbuffered
  74         $self->send_now('B',"0");
  75
  76         # send initialisation string
  77         if (!$self->{outbound}) {
  78                 $self->send(pc38()) if DXNode->get_all();
  79                 $self->send(pc18());
  80         }
  81         $self->state('init');
  82         $self->pc50_t(time);
  83         Log('DXProt', "$call connected");
  84 }
  85
  86 #
  87 # This is the normal pcxx despatcher
  88 #
  89 sub normal
  90 {
  91         my ($self, $line) = @_;
  92         my @field = split /[\^\~]/, $line;
  93
  94         # ignore any lines that don't start with PC
  95         return if !$field[0] =~ /^PC/;
  96
  97         # process PC frames
  98         my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
  99         return if $pcno < 10 || $pcno > 51;
 100
 101  SWITCH: {
 102                 if ($pcno == 10) {              # incoming talk
 103
 104                         # is it for me or one of mine?
 105                         my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
 106                         if ($call eq $main::mycall || grep $_ eq $call, get_all_user_calls()) {
 107
 108                                 # yes, it is
 109                                 my $text = unpad($field[3]);
 110                                 Log('talk', $call, $field[1], $field[6], $text);
 111                                 $call = $main::myalias if $call eq $main::mycall;
 112                                 my $ref = DXChannel->get($call);
 113                                 $ref->send("$call de $field[1]: $text") if $ref;
 114                         } else {
 115                                 route($field[2], $line); # relay it on its way
 116                         }
 117                         return;
 118                 }
 119
 120                 if ($pcno == 11 || $pcno == 26) { # dx spot
 121
 122                         # if this is a 'nodx' node then ignore it
 123                         last SWITCH if grep $field[7] =~ /^$_/,  @DXProt::nodx_node;
 124
 125                         # convert the date to a unix date
 126                         my $d = cltounix($field[3], $field[4]);
 127                         return if !$d || ($pcno == 11 && $d < $main::systime - $pc11_max_age); # bang out (and don't pass on) if date is invalid or the spot is too old
 128
 129                         # strip off the leading & trailing spaces from the comment
 130                         my $text = unpad($field[5]);
 131
 132                         # store it away
 133                         my $spotter = $field[6];
 134                         $spotter =~ s/-\d+$//o; # strip off the ssid from the spotter
 135
 136                         # do some de-duping
 137                         my $dupkey = "$field[1]$field[2]$d$text$field[6]";
 138                         return if $dup{$dupkey};
 139                         $dup{$dupkey} = $d;
 140
 141                         my $spot = Spot::add($field[1], $field[2], $d, $text, $spotter);
 142
 143                         # send orf to the users
 144                         if ($spot && $pcno == 11) {
 145                                 my $buf = Spot::formatb($field[1], $field[2], $d, $text, $spotter);
 146                                 broadcast_users("$buf\a\a");
 147                         }
 148
 149                         last SWITCH;
 150                 }
 151
 152                 if ($pcno == 12) {              # announces
 153
 154                         if ($field[2] eq '*' || $field[2] eq $main::mycall) {
 155
 156                                 # strip leading and trailing stuff
 157                                 my $text = unpad($field[3]);
 158                                 my $target;
 159                                 my $to = 'To ';
 160                                 my @list;
 161
 162                                 if ($field[4] eq '*') { # sysops
 163                                         $target = "Sysops";
 164                                         @list = map { $_->priv >= 5 ? $_ : () } get_all_users();
 165                                 } elsif ($field[4] gt ' ') { # speciality list handling
 166                                         my ($name) = split /\./, $field[4];
 167                                         $target = "$name"; # put the rest in later (if bothered)
 168                                 }
 169
 170                                 if ($field[6] eq '1') {
 171                                         $target = "WX";
 172                                         $to = '';
 173                                 }
 174                                 $target = "All" if !$target;
 175
 176                                 if (@list > 0) {
 177                                         broadcast_list("$to$target de $field[1]: $text", @list);
 178                                 } else {
 179                                         broadcast_users("$target de $field[1]: $text");
 180                                 }
 181                                 Log('ann', $target, $field[1], $text);
 182
 183                                 return if $field[2] eq $main::mycall; # it's routed to me
 184                         } else {
 185                                 route($field[2], $line);
 186                                 return;                 # only on a routed one
 187                         }
 188
 189                         last SWITCH;
 190                 }
 191
 192                 if ($pcno == 13) {
 193                         last SWITCH;
 194                 }
 195                 if ($pcno == 14) {
 196                         last SWITCH;
 197                 }
 198                 if ($pcno == 15) {
 199                         last SWITCH;
 200                 }
 201
 202                 if ($pcno == 16) {              # add a user
 203                         my $node = DXCluster->get_exact($field[1]);
 204                         last SWITCH if !$node; # ignore if havn't seen a PC19 for this one yet
 205                         my $i;
 206
 207                         for ($i = 2; $i < $#field; $i++) {
 208                                 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (-) (\d)/o;
 209                                 next if length $call < 3;
 210                                 next if !$confmode;
 211                                 $call = uc $call;
 212                                 next if DXCluster->get_exact($call); # we already have this (loop?)
 213
 214                                 $confmode = $confmode eq '*';
 215                                 DXNodeuser->new($self, $node, $call, $confmode, $here);
 216
 217                                 # add this station to the user database, if required
 218                                 $call =~ s/-\d+$//o;        # remove ssid for users
 219                                 my $user = DXUser->get_current($call);
 220                                 $user = DXUser->new($call) if !$user;
 221                                 $user->node($node->call);
 222                                 $user->homenode($node->call) if !$user->homenode;
 223                                 $user->put;
 224                         }
 225
 226                         # queue up any messages (look for privates only)
 227                         DXMsg::queue_msg(1) if $self->state eq 'normal';
 228                         last SWITCH;
 229                 }
 230
 231                 if ($pcno == 17) {              # remove a user
 232
 233                         my $ref = DXCluster->get_exact($field[1]);
 234                         $ref->del() if $ref;
 235                         last SWITCH;
 236                 }
 237
 238                 if ($pcno == 18) {              # link request
 239                         $self->send_local_config();
 240                         $self->send(pc20());
 241                         $self->state('init');
 242                         last SWITCH;
 243                 }
 244
 245                 if ($pcno == 19) {              # incoming cluster list
 246                         my $i;
 247                         for ($i = 1; $i < $#field-1; $i += 4) {
 248                                 my $here = $field[$i];
 249                                 my $call = uc $field[$i+1];
 250                                 my $confmode = $field[$i+2] eq '*';
 251                                 my $ver = $field[$i+3];
 252
 253                                 # now check the call over
 254                                 next if DXCluster->get_exact($call); # we already have this
 255
 256                                 # check for sane parameters
 257                                 next if $ver < 5000; # only works with version 5 software
 258                                 next if length $call < 3; # min 3 letter callsigns
 259                                 DXNode->new($self, $call, $confmode, $here, $ver);
 260
 261                                 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
 262                                 my $mref = DXMsg::get_busy($call);
 263                                 $mref->stop_msg($self) if $mref;
 264
 265                                 # add this station to the user database, if required (don't remove SSID from nodes)
 266                                 my $user = DXUser->get_current($call);
 267                                 if (!$user) {
 268                                         $user = DXUser->new($call);
 269                                         $user->sort('A');
 270                                         $user->node($call);
 271                                         $user->homenode($call);
 272                                         $user->put;
 273                                 }
 274                         }
 275
 276                         # queue up any messages
 277                         DXMsg::queue_msg() if $self->state eq 'normal';
 278                         last SWITCH;
 279                 }
 280
 281                 if ($pcno == 20) {              # send local configuration
 282                         $self->send_local_config();
 283                         $self->send(pc22());
 284                         $self->state('normal');
 285
 286                         # queue mail
 287                         DXMsg::queue_msg();
 288                         return;
 289                 }
 290
 291                 if ($pcno == 21) {              # delete a cluster from the list
 292                         my $call = uc $field[1];
 293                         if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
 294                                 my $ref = DXCluster->get_exact($call);
 295                                 $ref->del() if $ref;
 296                         }
 297                         last SWITCH;
 298                 }
 299
 300                 if ($pcno == 22) {
 301                         $self->state('normal');
 302
 303                         # queue mail
 304                         DXMsg::queue_msg();
 305                         return;
 306                 }
 307
 308                 if ($pcno == 23 || $pcno == 27) { # WWV info
 309                         Geomag::update(@field[1..$#field]);
 310                         last SWITCH;
 311                 }
 312
 313                 if ($pcno == 24) {              # set here status
 314                         my $call = uc $field[1];
 315                         my $ref = DXCluster->get_exact($call);
 316                         $ref->here($field[2]) if $ref;
 317                         last SWITCH;
 318                 }
 319
 320                 if ($pcno == 25) {
 321                         last SWITCH;
 322                 }
 323
 324                 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42) { # mail/file handling
 325                         DXMsg::process($self, $line);
 326                         return;
 327                 }
 328
 329                 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
 330                         if ($field[1] eq $main::mycall) {
 331                                 my $ref = DXUser->get_current($field[2]);
 332                                 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
 333                                 if ($ref->{priv}) {     # you have to have SOME privilege, the commands have further filtering
 334                                         $self->{remotecmd} = 1; # for the benefit of any command that needs to know
 335                                         my @in = (DXCommandmode::run_cmd($self, $field[3]));
 336                                         for (@in) {
 337                                                 s/\s*$//og;
 338                                                 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
 339                                                 Log('rcmd', 'out', $field[2], $_);
 340                                         }
 341                                         delete $self->{remotecmd};
 342                                 }
 343                         } else {
 344                                 route($field[1], $line);
 345                         }
 346                         return;
 347                 }
 348
 349                 if ($pcno == 35) {              # remote command replies
 350                         if ($field[1] eq $main::mycall) {
 351                                 my $s = $rcmds{$field[2]};
 352                                 if ($s) {
 353                                         my $dxchan = DXChannel->get($s->{call});
 354                                         $dxchan->send($field[3]) if $dxchan;
 355                                         delete $rcmds{$field[2]} if !$dxchan;
 356                                 }
 357                         } else {
 358                                 route($field[1], $line);
 359                         }
 360                         return;
 361                 }
 362
 363                 if ($pcno == 37) {
 364                         last SWITCH;
 365                 }
 366
 367                 if ($pcno == 38) {              # node connected list from neighbour
 368                         return;
 369                 }
 370
 371                 if ($pcno == 39) {              # incoming disconnect
 372                         $self->disconnect();
 373                         return;
 374                 }
 375
 376                 if ($pcno == 41) {              # user info
 377                         # add this station to the user database, if required
 378                         my $user = DXUser->get_current($field[1]);
 379                         if (!$user) {
 380                                 # then try without an SSID
 381                                 $field[1] =~ s/-\d+$//o;
 382                                 $user = DXUser->get_current($field[1]);
 383                         }
 384                         $user = DXUser->new($field[1]) if !$user;
 385
 386                         if ($field[2] == 1) {
 387                                 $user->name($field[3]);
 388                         } elsif ($field[2] == 2) {
 389                                 $user->qth($field[3]);
 390                         } elsif ($field[2] == 3) {
 391                                 my ($latd, $latm, $latl, $longd, $longm, $longl) = split /\s+/, $field[3];
 392                                 $longd += ($longm/60);
 393                                 $longd = 0-$longd if (uc $longl) eq 'W';
 394                                 $user->long($longd);
 395                                 $latd += ($latm/60);
 396                                 $latd = 0-$latd if (uc $latl) eq 'S';
 397                                 $user->lat($latd);
 398                         } elsif ($field[2] == 4) {
 399                                 $user->homenode($field[3]);
 400                         }
 401                         $user->put;
 402                         last SWITCH;
 403                 }
 404                 if ($pcno == 43) {
 405                         last SWITCH;
 406                 }
 407                 if ($pcno == 44) {
 408                         last SWITCH;
 409                 }
 410                 if ($pcno == 45) {
 411                         last SWITCH;
 412                 }
 413                 if ($pcno == 46) {
 414                         last SWITCH;
 415                 }
 416                 if ($pcno == 47) {
 417                         last SWITCH;
 418                 }
 419                 if ($pcno == 48) {
 420                         last SWITCH;
 421                 }
 422                 if ($pcno == 49) {
 423                         last SWITCH;
 424                 }
 425
 426                 if ($pcno == 50) {              # keep alive/user list
 427                         my $ref = DXCluster->get_exact($field[1]);
 428                         $ref->update_users($field[2]) if $ref;
 429                         last SWITCH;
 430                 }
 431
 432                 if ($pcno == 51) {              # incoming ping requests/answers
 433
 434                         # is it for us?
 435                         if ($field[1] eq $main::mycall) {
 436                                 my $flag = $field[3];
 437                                 if ($flag == 1) {
 438                                         $self->send(pc51($field[2], $field[1], '0'));
 439                                 } else {
 440                                         # it's a reply, look in the ping list for this one
 441                                         my $ref = $pings{$field[2]};
 442                                         if ($ref) {
 443                                                 my $r = shift @$ref;
 444                                                 my $dxchan = DXChannel->get($r->{call});
 445                                                 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
 446                                         }
 447                                 }
 448
 449                         } else {
 450                                 # route down an appropriate thingy
 451                                 route($field[1], $line);
 452                         }
 453                         return;
 454                 }
 455         }
 456
 457          # if get here then rebroadcast the thing with its Hop count decremented (if
 458          # there is one). If it has a hop count and it decrements to zero then don't
 459          # rebroadcast it.
 460          #
 461          # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
 462          #        REBROADCAST!!!!
 463          #
 464
 465          my $hops;
 466         if (($hops) = $line =~ /H(\d+)\^\~?$/o) {
 467                 my $newhops = $hops - 1;
 468                 if ($newhops > 0) {
 469                         $line =~ s/\^H$hops(\^\~?)$/\^H$newhops$1/;     # change the hop count
 470                         broadcast_ak1a($line, $self); # send it to everyone but me
 471                 }
 472         }
 473 }
 474
 475 #
 476 # This is called from inside the main cluster processing loop and is used
 477 # for despatching commands that are doing some long processing job
 478 #
 479 sub process
 480 {
 481         my $t = time;
 482         my @chan = DXChannel->get_all();
 483         my $chan;
 484
 485         foreach $chan (@chan) {
 486                 next if !$chan->is_ak1a();
 487
 488                 # send a pc50 out on this channel
 489                 if ($t >= $chan->pc50_t + $DXProt::pc50_interval) {
 490                         $chan->send(pc50());
 491                         $chan->pc50_t($t);
 492                 }
 493         }
 494
 495         my $key;
 496         my $val;
 497         my $cutoff;
 498         if ($main::systime - 3600 > $last_hour) {
 499                 $cutoff  = $main::systime - $pc11_dup_age;
 500                 while (($key, $val) = each %dup) {
 501                         delete $dup{$key} if $val < $cutoff;
 502                 }
 503                 $last_hour = $main::systime;
 504         }
 505 }
 506
 507 #
 508 # finish up a pc context
 509 #
 510 sub finish
 511 {
 512         my $self = shift;
 513         my $call = $self->call;
 514         my $ref = DXCluster->get_exact($call);
 515
 516         # unbusy and stop and outgoing mail
 517         my $mref = DXMsg::get_busy($call);
 518         $mref->stop_msg($self) if $mref;
 519
 520         # broadcast to all other nodes that all the nodes connected to via me are gone
 521         my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
 522         my $node;
 523
 524         foreach $node (@gonenodes) {
 525                 next if $node->call eq $call;
 526                 broadcast_ak1a(pc21($node->call, 'Gone'), $self); # done like this 'cos DXNodes don't have a pc21 method
 527                 $node->del();
 528         }
 529
 530         # remove outstanding pings
 531         delete $pings{$call};
 532
 533         # now broadcast to all other ak1a nodes that I have gone
 534         broadcast_ak1a(pc21($call, 'Gone.'), $self);
 535         Log('DXProt', $call . " Disconnected");
 536         $ref->del() if $ref;
 537 }
 538
 539 #
 540 # some active measures
 541 #
 542
 543 sub send_local_config
 544 {
 545         my $self = shift;
 546         my $n;
 547
 548         # send our nodes
 549         my @nodes = DXNode::get_all();
 550
 551         # create a list of all the nodes that are not connected to this connection
 552         @nodes = grep { $_->dxchan != $self } @nodes;
 553         $self->send($me->pc19(@nodes));
 554
 555         # get all the users connected on the above nodes and send them out
 556         foreach $n (@nodes) {
 557                 my @users = values %{$n->list};
 558                 $self->send(DXProt::pc16($n, @users));
 559         }
 560 }
 561
 562 #
 563 # route a message down an appropriate interface for a callsign
 564 #
 565 # is called route(to, pcline);
 566 #
 567 sub route
 568 {
 569         my ($call, $line) = @_;
 570         my $cl = DXCluster->get_exact($call);
 571         if ($cl) {
 572                 my $hops;
 573                 my $dxchan = $cl->{dxchan};
 574                 if (($hops) = $line =~ /H(\d+)\^\~?$/o) {
 575                         my $newhops = $hops - 1;
 576                         if ($newhops > 0) {
 577                                 $line =~ s/\^H$hops(\^\~?)$/\^H$newhops$1/;     # change the hop count
 578                                 $dxchan->send($line) if $dxchan;
 579                         }
 580                 } else {
 581                         $dxchan->send($line) if $dxchan; # for them wot don't have Hops
 582                 }
 583         }
 584 }
 585
 586 # broadcast a message to all clusters [except those mentioned after buffer]
 587 sub broadcast_ak1a
 588 {
 589         my $s = shift;                          # the line to be rebroadcast
 590         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 591         my @chan = get_all_ak1a();
 592         my $chan;
 593
 594         foreach $chan (@chan) {
 595                 next if grep $chan == $_, @except;
 596                 $chan->send($s);                # send it if it isn't the except list
 597         }
 598 }
 599
 600 # broadcast to all users
 601 sub broadcast_users
 602 {
 603         my $s = shift;                          # the line to be rebroadcast
 604         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 605         my @chan = get_all_users();
 606         my $chan;
 607
 608         foreach $chan (@chan) {
 609                 next if grep $chan == $_, @except;
 610                 $s =~ s/\a//og if !$chan->{beep};
 611                 $chan->send($s);                # send it if it isn't the except list
 612         }
 613 }
 614
 615 # broadcast to a list of users
 616 sub broadcast_list
 617 {
 618         my $s = shift;
 619         my $chan;
 620
 621         foreach $chan (@_) {
 622                 $chan->send($s);                # send it
 623         }
 624 }
 625
 626 #
 627 # gimme all the ak1a nodes
 628 #
 629 sub get_all_ak1a
 630 {
 631         my @list = DXChannel->get_all();
 632         my $ref;
 633         my @out;
 634         foreach $ref (@list) {
 635                 push @out, $ref if $ref->is_ak1a;
 636         }
 637         return @out;
 638 }
 639
 640 # return a list of all users
 641 sub get_all_users
 642 {
 643         my @list = DXChannel->get_all();
 644         my $ref;
 645         my @out;
 646         foreach $ref (@list) {
 647                 push @out, $ref if $ref->is_user;
 648         }
 649         return @out;
 650 }
 651
 652 # return a list of all user callsigns
 653 sub get_all_user_calls
 654 {
 655         my @list = DXChannel->get_all();
 656         my $ref;
 657         my @out;
 658         foreach $ref (@list) {
 659                 push @out, $ref->call if $ref->is_user;
 660         }
 661         return @out;
 662 }
 663
 664 #
 665 # obtain the hops from the list for this callsign and pc no
 666 #
 667
 668 sub get_hops
 669 {
 670         my ($pcno) = @_;
 671         my $hops = $DXProt::hopcount{$pcno};
 672         $hops = $DXProt::def_hopcount if !$hops;
 673         return "H$hops";
 674 }
 675
 676 # remove leading and trailing spaces from an input string
 677 sub unpad
 678 {
 679         my $s = shift;
 680         $s =~ s/^\s+|\s+$//;
 681         return $s;
 682 }
 683
 684 # add a ping request to the ping queues
 685 sub addping
 686 {
 687         my ($from, $to) = @_;
 688         my $ref = $pings{$to};
 689         $ref = $pings{$to} = [] if !$ref;
 690         my $r = {};
 691         $r->{call} = $from;
 692         $r->{t} = $main::systime;
 693         route($to, pc51($to, $main::mycall, 1));
 694         push @$ref, $r;
 695 }
 696
 697 # add a rcmd request to the rcmd queues
 698 sub addrcmd
 699 {
 700         my ($from, $to, $cmd) = @_;
 701         my $r = {};
 702         $r->{call} = $from;
 703         $r->{t} = $main::systime;
 704         $r->{cmd} = $cmd;
 705         route($to, pc34($main::mycall, $to, $cmd));
 706         $rcmds{$to} = $r;
 707 }
 708 1;
 709 __END__