perl/DXMsg.pm

   1 #!/usr/bin/perl
   2 #
   3 # This module impliments the message handling for a dx cluster
   4 #
   5 # Copyright (c) 1998 Dirk Koopman G1TLH
   6 #
   7 # $Id$
   8 #
   9 #
  10 # Notes for implementors:-
  11 #
  12 # PC28 field 11 is the RR required flag
  13 # PC28 field 12 is a VIA routing (ie it is a node call)
  14 #
  15
  16 package DXMsg;
  17
  18 use DXUtil;
  19 use DXChannel;
  20 use DXUser;
  21 use DXM;
  22 use DXProtVars;
  23 use DXProtout;
  24 use DXDebug;
  25 use DXLog;
  26 use IO::File;
  27 use Fcntl;
  28
  29 use strict;
  30
  31 use vars qw($VERSION $BRANCH);
  32 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
  33 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
  34 $main::build += $VERSION;
  35 $main::branch += $BRANCH;
  36
  37 use vars qw(%work @msg $msgdir %valid %busy $maxage $last_clean
  38                         @badmsg @swop $swopfn $badmsgfn $forwardfn @forward $timeout $waittime
  39                     $queueinterval $lastq $importfn $minchunk $maxchunk $bulltopriv);
  40
  41 %work = ();                                             # outstanding jobs
  42 @msg = ();                                              # messages we have
  43 %busy = ();                                             # station interlocks
  44 $msgdir = "$main::root/msg";    # directory contain the msgs
  45 $maxage = 30 * 86400;                   # the maximum age that a message shall live for if not marked
  46 $last_clean = 0;                                # last time we did a clean
  47 @forward = ();                  # msg forward table
  48 @badmsg = ();                                   # bad message table
  49 @swop = ();                                             # swop table
  50 $timeout = 30*60;               # forwarding timeout
  51 $waittime = 30*60;              # time an aborted outgoing message waits before trying again
  52 $queueinterval = 1*60;          # run the queue every 1 minute
  53 $lastq = 0;
  54
  55 $minchunk = 4800;               # minimum chunk size for a split message
  56 $maxchunk = 6000;               # maximum chunk size
  57 $bulltopriv = 1;                                # convert msgs with callsigns to private if they are bulls
  58
  59
  60 $badmsgfn = "$msgdir/badmsg.pl";    # list of TO address we wont store
  61 $forwardfn = "$msgdir/forward.pl";  # the forwarding table
  62 $swopfn = "$msgdir/swop.pl";        # the swopping table
  63 $importfn = "$msgdir/import";       # import directory
  64
  65
  66 %valid = (
  67                   fromnode => '5,From Node',
  68                   tonode => '5,To Node',
  69                   to => '0,To',
  70                   from => '0,From',
  71                   t => '0,Msg Time,cldatetime',
  72                   private => '5,Private',
  73                   subject => '0,Subject',
  74                   linesreq => '0,Lines per Gob',
  75                   rrreq => '5,Read Confirm',
  76                   origin => '0,Origin',
  77                   lines => '5,Data',
  78                   stream => '9,Stream No',
  79                   count => '5,Gob Linecnt',
  80                   file => '5,File?,yesno',
  81                   gotit => '5,Got it Nodes,parray',
  82                   lines => '5,Lines,parray',
  83                   'read' => '5,Times read',
  84                   size => '0,Size',
  85                   msgno => '0,Msgno',
  86                   keep => '0,Keep this?,yesno',
  87                   lastt => '5,Last processed,cldatetime',
  88                   waitt => '5,Wait until,cldatetime',
  89                  );
  90
  91 # allocate a new object
  92 # called fromnode, tonode, from, to, datetime, private?, subject, nolinesper
  93 sub alloc
  94 {
  95         my $pkg = shift;
  96         my $self = bless {}, $pkg;
  97         $self->{msgno} = shift;
  98         my $to = shift;
  99         #  $to =~ s/-\d+$//o;
 100         $self->{to} = ($to eq $main::mycall) ? $main::myalias : $to;
 101         my $from = shift;
 102         $from =~ s/-\d+$//o;
 103         $self->{from} = uc $from;
 104         $self->{t} = shift;
 105         $self->{private} = shift;
 106         $self->{subject} = shift;
 107         $self->{origin} = shift;
 108         $self->{'read'} = shift;
 109         $self->{rrreq} = shift;
 110         $self->{gotit} = [];
 111 #       $self->{lastt} = $main::systime;
 112         $self->{lines} = [];
 113         $self->{private} = 1 if $bulltopriv && DXUser->get_current($self->{to});
 114
 115         return $self;
 116 }
 117
 118 sub workclean
 119 {
 120         my $ref = shift;
 121         delete $ref->{lines};
 122         delete $ref->{linesreq};
 123         delete $ref->{tonode};
 124         delete $ref->{fromnode};
 125         delete $ref->{stream};
 126         delete $ref->{file};
 127         delete $ref->{count};
 128         delete $ref->{lastt} if exists $ref->{lastt};
 129         delete $ref->{waitt} if exists $ref->{waitt};
 130 }
 131
 132 sub process
 133 {
 134         my ($self, $line) = @_;
 135
 136         # this is periodic processing
 137         if (!$self || !$line) {
 138
 139                 if ($main::systime >= $lastq + $queueinterval) {
 140
 141                         # queue some message if the interval timer has gone off
 142                         queue_msg(0);
 143
 144                         # import any messages in the import directory
 145                         import_msgs();
 146
 147                         $lastq = $main::systime;
 148                 }
 149
 150                 # clean the message queue
 151                 clean_old() if $main::systime - $last_clean > 3600 ;
 152                 return;
 153         }
 154
 155         my @f = split /\^/, $line;
 156         my ($pcno) = $f[0] =~ /^PC(\d\d)/; # just get the number
 157
 158  SWITCH: {
 159                 if ($pcno == 28) {              # incoming message
 160
 161                         # sort out various extant protocol errors that occur
 162                         my ($fromnode, $origin);
 163                         if ($self->is_arcluster && $f[13] eq $self->call) {
 164                                 $fromnode = $f[13];
 165                                 $origin = $f[2];
 166                         } else {
 167                                 $fromnode = $f[2];
 168                             $origin = $f[13];
 169                         }
 170                         $origin = $self->call unless $origin && $origin gt ' ';
 171
 172                         # first look for any messages in the busy queue
 173                         # and cancel them this should both resolve timed out incoming messages
 174                         # and crossing of message between nodes, incoming messages have priority
 175
 176                         if (exists $busy{$fromnode}) {
 177                                 my $ref = $busy{$fromnode};
 178                                 my $tonode = $ref->{tonode};
 179                                 dbg("Busy, stopping msgno: $ref->{msgno} $fromnode->$tonode") if isdbg('msg');
 180                                 $ref->stop_msg($self->call);
 181                         }
 182
 183                         my $t = cltounix($f[5], $f[6]);
 184                         my $stream = next_transno($fromnode);
 185                         my $ref = DXMsg->alloc($stream, uc $f[3], $f[4], $t, $f[7], $f[8], $origin, '0', $f[11]);
 186
 187                         # fill in various forwarding state variables
 188                         $ref->{fromnode} = $fromnode;
 189                         $ref->{tonode} = $f[1];
 190                         $ref->{rrreq} = $f[11];
 191                         $ref->{linesreq} = $f[10];
 192                         $ref->{stream} = $stream;
 193                         $ref->{count} = 0;      # no of lines between PC31s
 194                         dbg("new message from $f[4] to $f[3] '$f[8]' stream $fromnode/$stream\n") if isdbg('msg');
 195                         Log('msg', "Incoming message $f[4] to $f[3] '$f[8]'" );
 196                         $work{"$fromnode$stream"} = $ref; # store in work
 197                         $busy{$fromnode} = $ref; # set interlock
 198                         $self->send(DXProt::pc30($fromnode, $f[1], $stream)); # send ack
 199                         $ref->{lastt} = $main::systime;
 200
 201                         # look to see whether this is a non private message sent to a known callsign
 202                         my $uref = DXUser->get_current($ref->{to});
 203                         if (is_callsign($ref->{to}) && !$ref->{private} && $uref && $uref->homenode) {
 204                                 $ref->{private} = 1;
 205                                 dbg("set bull to $ref->{to} to private") if isdbg('msg');
 206                         }
 207                         last SWITCH;
 208                 }
 209
 210                 if ($pcno == 29) {              # incoming text
 211                         my $ref = $work{"$f[2]$f[3]"};
 212                         if ($ref) {
 213                                 $f[4] =~ s/\%5E/^/g;
 214                                 push @{$ref->{lines}}, $f[4];
 215                                 $ref->{count}++;
 216                                 if ($ref->{count} >= $ref->{linesreq}) {
 217                                         $self->send(DXProt::pc31($f[2], $f[1], $f[3]));
 218                                         dbg("stream $f[3]: $ref->{count} lines received\n") if isdbg('msg');
 219                                         $ref->{count} = 0;
 220                                 }
 221                                 $ref->{lastt} = $main::systime;
 222                         } else {
 223                                 dbg("PC29 from unknown stream $f[3] from $f[2]") if isdbg('msg');
 224                                 $self->send(DXProt::pc42($f[2], $f[1], $f[3])); # unknown stream
 225                         }
 226                         last SWITCH;
 227                 }
 228
 229                 if ($pcno == 30) {              # this is a incoming subject ack
 230                         my $ref = $work{$f[2]}; # note no stream at this stage
 231                         if ($ref) {
 232                                 delete $work{$f[2]};
 233                                 $ref->{stream} = $f[3];
 234                                 $ref->{count} = 0;
 235                                 $ref->{linesreq} = 5;
 236                                 $work{"$f[2]$f[3]"} = $ref;     # new ref
 237                                 dbg("incoming subject ack stream $f[3]\n") if isdbg('msg');
 238                                 $busy{$f[2]} = $ref; # interlock
 239                                 push @{$ref->{lines}}, ($ref->read_msg_body);
 240                                 $ref->send_tranche($self);
 241                                 $ref->{lastt} = $main::systime;
 242                         } else {
 243                                 dbg("PC30 from unknown stream $f[3] from $f[2]") if isdbg('msg');
 244                                 $self->send(DXProt::pc42($f[2], $f[1], $f[3])); # unknown stream
 245                         }
 246                         last SWITCH;
 247                 }
 248
 249                 if ($pcno == 31) {              # acknowledge a tranche of lines
 250                         my $ref = $work{"$f[2]$f[3]"};
 251                         if ($ref) {
 252                                 dbg("tranche ack stream $f[3]\n") if isdbg('msg');
 253                                 $ref->send_tranche($self);
 254                                 $ref->{lastt} = $main::systime;
 255                         } else {
 256                                 dbg("PC31 from unknown stream $f[3] from $f[2]") if isdbg('msg');
 257                                 $self->send(DXProt::pc42($f[2], $f[1], $f[3])); # unknown stream
 258                         }
 259                         last SWITCH;
 260                 }
 261
 262                 if ($pcno == 32) {              # incoming EOM
 263                         dbg("stream $f[3]: EOM received\n") if isdbg('msg');
 264                         my $ref = $work{"$f[2]$f[3]"};
 265                         if ($ref) {
 266                                 $self->send(DXProt::pc33($f[2], $f[1], $f[3])); # acknowledge it
 267
 268                                 # get the next msg no - note that this has NOTHING to do with the stream number in PC protocol
 269                                 # store the file or message
 270                                 # remove extraneous rubbish from the hash
 271                                 # remove it from the work in progress vector
 272                                 # stuff it on the msg queue
 273                                 if ($ref->{lines}) {
 274                                         if ($ref->{file}) {
 275                                                 $ref->store($ref->{lines});
 276                                         } else {
 277
 278                                                 # does an identical message already exist?
 279                                                 my $m;
 280                                                 for $m (@msg) {
 281                                                         if ($ref->{subject} eq $m->{subject} && $ref->{t} == $m->{t} && $ref->{from} eq $m->{from} && $ref->{to} eq $m->{to}) {
 282                                                                 $ref->stop_msg($self->call);
 283                                                                 my $msgno = $m->{msgno};
 284                                                                 dbg("duplicate message from $ref->{from} -> $ref->{to} to $msgno") if isdbg('msg');
 285                                                                 Log('msg', "duplicate message from $ref->{from} -> $ref->{to} to $msgno");
 286                                                                 return;
 287                                                         }
 288                                                 }
 289
 290                                                 # swop addresses
 291                                                 $ref->swop_it($self->call);
 292
 293                                                 # look for 'bad' to addresses
 294                                                 if ($ref->dump_it($self->call)) {
 295                                                         $ref->stop_msg($self->call);
 296                                                         dbg("'Bad' message $ref->{to}") if isdbg('msg');
 297                                                         Log('msg', "'Bad' message $ref->{to}");
 298                                                         return;
 299                                                 }
 300
 301                                                 $ref->{msgno} = next_transno("Msgno");
 302                                                 push @{$ref->{gotit}}, $f[2]; # mark this up as being received
 303                                                 $ref->store($ref->{lines});
 304                                                 add_dir($ref);
 305                                                 my $dxchan = DXChannel->get($ref->{to});
 306                                                 $dxchan->send($dxchan->msg('m9')) if $dxchan && $dxchan->is_user;
 307                                                 Log('msg', "Message $ref->{msgno} from $ref->{from} received from $f[2] for $ref->{to}");
 308                                         }
 309                                 }
 310                                 $ref->stop_msg($self->call);
 311                         } else {
 312                                 dbg("PC32 from unknown stream $f[3] from $f[2]") if isdbg('msg');
 313                                 $self->send(DXProt::pc42($f[2], $f[1], $f[3])); # unknown stream
 314                         }
 315                         # queue_msg(0);
 316                         last SWITCH;
 317                 }
 318
 319                 if ($pcno == 33) {              # acknowledge the end of message
 320                         my $ref = $work{"$f[2]$f[3]"};
 321                         if ($ref) {
 322                                 if ($ref->{private}) { # remove it if it private and gone off site#
 323                                         Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $f[2] and deleted");
 324                                         $ref->del_msg;
 325                                 } else {
 326                                         Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $f[2]");
 327                                         push @{$ref->{gotit}}, $f[2]; # mark this up as being received
 328                                         $ref->store($ref->{lines});     # re- store the file
 329                                 }
 330                                 $ref->stop_msg($self->call);
 331                         } else {
 332                                 dbg("PC33 from unknown stream $f[3] from $f[2]") if isdbg('msg');
 333                                 $self->send(DXProt::pc42($f[2], $f[1], $f[3])); # unknown stream
 334                         }
 335
 336                         # send next one if present
 337                         queue_msg(0);
 338                         last SWITCH;
 339                 }
 340
 341                 if ($pcno == 40) {              # this is a file request
 342                         $f[3] =~ s/\\/\//og; # change the slashes
 343                         $f[3] =~ s/\.//og;      # remove dots
 344                         $f[3] =~ s/^\///o;   # remove the leading /
 345                         $f[3] = lc $f[3];       # to lower case;
 346                         dbg("incoming file $f[3]\n") if isdbg('msg');
 347                         $f[3] = 'packclus/' . $f[3] unless $f[3] =~ /^packclus\//o;
 348
 349                         # create any directories
 350                         my @part = split /\//, $f[3];
 351                         my $part;
 352                         my $fn = "$main::root";
 353                         pop @part;                      # remove last part
 354                         foreach $part (@part) {
 355                                 $fn .= "/$part";
 356                                 next if -e $fn;
 357                                 last SWITCH if !mkdir $fn, 0777;
 358                                 dbg("created directory $fn\n") if isdbg('msg');
 359                         }
 360                         my $stream = next_transno($f[2]);
 361                         my $ref = DXMsg->alloc($stream, "$main::root/$f[3]", $self->call, time, !$f[4], $f[3], ' ', '0', '0');
 362
 363                         # forwarding variables
 364                         $ref->{fromnode} = $f[1];
 365                         $ref->{tonode} = $f[2];
 366                         $ref->{linesreq} = $f[5];
 367                         $ref->{stream} = $stream;
 368                         $ref->{count} = 0;      # no of lines between PC31s
 369                         $ref->{file} = 1;
 370                         $ref->{lastt} = $main::systime;
 371                         $work{"$f[2]$stream"} = $ref; # store in work
 372                         $self->send(DXProt::pc30($f[2], $f[1], $stream)); # send ack
 373
 374                         last SWITCH;
 375                 }
 376
 377                 if ($pcno == 42) {              # abort transfer
 378                         dbg("stream $f[3]: abort received\n") if isdbg('msg');
 379                         my $ref = $work{"$f[2]$f[3]"};
 380                         if ($ref) {
 381                                 $ref->stop_msg($self->call);
 382                                 $ref = undef;
 383                         }
 384                         last SWITCH;
 385                 }
 386
 387                 if ($pcno == 49) {      # global delete on subject
 388                         for (@msg) {
 389                                 if ($_->{from} eq $f[1] && $_->{subject} eq $f[2]) {
 390                                         $_->del_msg();
 391                                         Log('msg', "Message $_->{msgno} from $_->{from} ($_->{subject}) fully deleted");
 392                                         DXProt::broadcast_ak1a($line, $self);
 393                                 }
 394                         }
 395                 }
 396         }
 397 }
 398
 399
 400 # store a message away on disc or whatever
 401 #
 402 # NOTE the second arg is a REFERENCE not a list
 403 sub store
 404 {
 405         my $ref = shift;
 406         my $lines = shift;
 407
 408         if ($ref->{file}) {                     # a file
 409                 dbg("To be stored in $ref->{to}\n") if isdbg('msg');
 410
 411                 my $fh = new IO::File "$ref->{to}", "w";
 412                 if (defined $fh) {
 413                         my $line;
 414                         foreach $line (@{$lines}) {
 415                                 print $fh "$line\n";
 416                         }
 417                         $fh->close;
 418                         dbg("file $ref->{to} stored\n") if isdbg('msg');
 419                         Log('msg', "file $ref->{to} from $ref->{from} stored" );
 420                 } else {
 421                         confess "can't open file $ref->{to} $!";
 422                 }
 423         } else {                                        # a normal message
 424
 425                 # attempt to open the message file
 426                 my $fn = filename($ref->{msgno});
 427
 428                 dbg("To be stored in $fn\n") if isdbg('msg');
 429
 430                 # now save the file, overwriting what's there, YES I KNOW OK! (I will change it if it's a problem)
 431                 my $fh = new IO::File "$fn", "w";
 432                 if (defined $fh) {
 433                         my $rr = $ref->{rrreq} ? '1' : '0';
 434                         my $priv = $ref->{private} ? '1': '0';
 435                         print $fh "=== $ref->{msgno}^$ref->{to}^$ref->{from}^$ref->{t}^$priv^$ref->{subject}^$ref->{origin}^$ref->{'read'}^$rr\n";
 436                         print $fh "=== ", join('^', @{$ref->{gotit}}), "\n";
 437                         my $line;
 438                         $ref->{size} = 0;
 439                         foreach $line (@{$lines}) {
 440                                 $ref->{size} += (length $line) + 1;
 441                                 print $fh "$line\n";
 442                         }
 443                         $fh->close;
 444                         dbg("msg $ref->{msgno} stored\n") if isdbg('msg');
 445                         Log('msg', "msg $ref->{msgno} from $ref->{from} to $ref->{to} stored" );
 446                 } else {
 447                         confess "can't open msg file $fn $!";
 448                 }
 449         }
 450 }
 451
 452 # delete a message
 453 sub del_msg
 454 {
 455         my $self = shift;
 456
 457         # remove it from the active message list
 458         dbg("\@msg = " . scalar @msg . " before delete") if isdbg('msg');
 459         @msg = grep { $_ != $self } @msg;
 460
 461         # remove the file
 462         unlink filename($self->{msgno});
 463         dbg("deleting $self->{msgno}\n") if isdbg('msg');
 464         dbg("\@msg = " . scalar @msg . " after delete") if isdbg('msg');
 465 }
 466
 467 # clean out old messages from the message queue
 468 sub clean_old
 469 {
 470         my $ref;
 471
 472         # mark old messages for deletion
 473         dbg("\@msg = " . scalar @msg . " before delete") if isdbg('msg');
 474         foreach $ref (@msg) {
 475                 if (ref($ref) && !$ref->{keep} && $ref->{t} < $main::systime - $maxage) {
 476                         $ref->{deleteme} = 1;
 477                         unlink filename($ref->{msgno});
 478                         dbg("deleting old $ref->{msgno}\n") if isdbg('msg');
 479                 }
 480         }
 481
 482         # remove them all from the active message list
 483         @msg = grep { !$_->{deleteme} } @msg;
 484         dbg("\@msg = " . scalar @msg . " after delete") if isdbg('msg');
 485         $last_clean = $main::systime;
 486 }
 487
 488 # read in a message header
 489 sub read_msg_header
 490 {
 491         my $fn = shift;
 492         my $file;
 493         my $line;
 494         my $ref;
 495         my @f;
 496         my $size;
 497
 498         $file = new IO::File "$fn";
 499         if (!$file) {
 500             dbg("Error reading $fn $!");
 501             Log('err', "Error reading $fn $!");
 502                 return undef;
 503         }
 504         $size = -s $fn;
 505         $line = <$file>;                        # first line
 506         if ($size == 0 || !$line) {
 507             dbg("Empty $fn $!");
 508             Log('err', "Empty $fn $!");
 509                 return undef;
 510         }
 511         chomp $line;
 512         $size -= length $line;
 513         if (! $line =~ /^===/o) {
 514                 dbg("corrupt first line in $fn ($line)");
 515                 Log('err', "corrupt first line in $fn ($line)");
 516                 return undef;
 517         }
 518         $line =~ s/^=== //o;
 519         @f = split /\^/, $line;
 520         $ref = DXMsg->alloc(@f);
 521
 522         $line = <$file>;                        # second line
 523         chomp $line;
 524         $size -= length $line;
 525         if (! $line =~ /^===/o) {
 526             dbg("corrupt second line in $fn ($line)");
 527             Log('err', "corrupt second line in $fn ($line)");
 528                 return undef;
 529         }
 530         $line =~ s/^=== //o;
 531         $ref->{gotit} = [];
 532         @f = split /\^/, $line;
 533         push @{$ref->{gotit}}, @f;
 534         $ref->{size} = $size;
 535
 536         close($file);
 537
 538         return $ref;
 539 }
 540
 541 # read in a message header
 542 sub read_msg_body
 543 {
 544         my $self = shift;
 545         my $msgno = $self->{msgno};
 546         my $file;
 547         my $line;
 548         my $fn = filename($msgno);
 549         my @out;
 550
 551         $file = new IO::File;
 552         if (!open($file, $fn)) {
 553                 dbg("Error reading $fn $!");
 554                 Log('err' ,"Error reading $fn $!");
 555                 return undef;
 556         }
 557         @out = map {chomp; $_} <$file>;
 558         close($file);
 559
 560         shift @out if $out[0] =~ /^=== /;
 561         shift @out if $out[0] =~ /^=== /;
 562         return @out;
 563 }
 564
 565 # send a tranche of lines to the other end
 566 sub send_tranche
 567 {
 568         my ($self, $dxchan) = @_;
 569         my @out;
 570         my $to = $self->{tonode};
 571         my $from = $self->{fromnode};
 572         my $stream = $self->{stream};
 573         my $lines = $self->{lines};
 574         my ($c, $i);
 575
 576         for ($i = 0, $c = $self->{count}; $i < $self->{linesreq} && $c < @$lines; $i++, $c++) {
 577                 push @out, DXProt::pc29($to, $from, $stream, $lines->[$c]);
 578     }
 579     $self->{count} = $c;
 580
 581     push @out, DXProt::pc32($to, $from, $stream) if $i < $self->{linesreq};
 582         $dxchan->send(@out);
 583 }
 584
 585
 586 # find a message to send out and start the ball rolling
 587 sub queue_msg
 588 {
 589         my $sort = shift;
 590         my $call = shift;
 591         my $ref;
 592         my $clref;
 593
 594         # bat down the message list looking for one that needs to go off site and whose
 595         # nearest node is not busy.
 596
 597         dbg("queue msg ($sort)\n") if isdbg('msg');
 598         my @nodelist = DXChannel::get_all_nodes;
 599         foreach $ref (@msg) {
 600
 601                 # ignore 'delayed' messages until their waiting time has expired
 602                 if (exists $ref->{waitt}) {
 603                         next if $ref->{waitt} > $main::systime;
 604                         delete $ref->{waitt};
 605                 }
 606
 607                 # any time outs?
 608                 if (exists $ref->{lastt} && $main::systime >= $ref->{lastt} + $timeout) {
 609                         my $node = $ref->{tonode};
 610                         dbg("Timeout, stopping msgno: $ref->{msgno} -> $node") if isdbg('msg');
 611                         Log('msg', "Timeout, stopping msgno: $ref->{msgno} -> $node");
 612                         $ref->stop_msg($node);
 613
 614                         # delay any outgoing messages that fail
 615                         $ref->{waitt} = $main::systime + $waittime + rand(120) if $node ne $main::mycall;
 616                         delete $ref->{lastt};
 617                         next;
 618                 }
 619
 620                 # firstly, is it private and unread? if so can I find the recipient
 621                 # in my cluster node list offsite?
 622
 623                 # deal with routed private messages
 624                 my $dxchan;
 625                 if ($ref->{private}) {
 626                         next if $ref->{'read'};           # if it is read, it is stuck here
 627                         $clref = Route::get($ref->{to});
 628 #                       unless ($clref) {             # otherwise look for a homenode
 629 #                               my $uref = DXUser->get_current($ref->{to});
 630 #                               my $hnode =  $uref->homenode if $uref;
 631 #                               $clref = Route::Node::get($hnode) if $hnode;
 632 #                       }
 633                         if ($clref) {
 634                                 $dxchan = $clref->dxchan;
 635                                 if ($dxchan) {
 636                                         if ($dxchan->is_node) {
 637                                                 next if $clref->call eq $main::mycall;  # i.e. it lives here
 638                                                 $ref->start_msg($dxchan) if !get_busy($dxchan->call)  && $dxchan->state eq 'normal';
 639                                         }
 640                                 } else {
 641                                         dbg("Route: No dxchan for $ref->{to} " . ref($clref) ) if isdbg('msg');
 642                                 }
 643                         }
 644                 }
 645
 646                 # otherwise we are dealing with a bulletin or forwarded private message
 647                 # compare the gotit list with
 648                 # the nodelist up above, if there are sites that haven't got it yet
 649                 # then start sending it - what happens when we get loops is anyone's
 650                 # guess, use (to, from, time, subject) tuple?
 651                 foreach $dxchan (@nodelist) {
 652                         my $call = $dxchan->call;
 653                         next unless $call;
 654                         next if $call eq $main::mycall;
 655                         next if ref $ref->{gotit} && grep $_ eq $call, @{$ref->{gotit}};
 656                         next unless $ref->forward_it($call);           # check the forwarding file
 657
 658                         # if we are here we have a node that doesn't have this message
 659                         $ref->start_msg($dxchan) if !get_busy($call)  && $dxchan->state eq 'normal';
 660                         last;
 661                 }
 662
 663                 # if all the available nodes are busy then stop
 664                 last if @nodelist == scalar grep { get_busy($_->call) } @nodelist;
 665         }
 666 }
 667
 668 # is there a message for me?
 669 sub for_me
 670 {
 671         my $call = uc shift;
 672         my $ref;
 673
 674         foreach $ref (@msg) {
 675                 # is it for me, private and unread?
 676                 if ($ref->{to} eq $call && $ref->{private}) {
 677                         return 1 if !$ref->{'read'};
 678                 }
 679         }
 680         return 0;
 681 }
 682
 683 # start the message off on its travels with a PC28
 684 sub start_msg
 685 {
 686         my ($self, $dxchan) = @_;
 687
 688         dbg("start msg $self->{msgno}\n") if isdbg('msg');
 689         $self->{linesreq} = 10;
 690         $self->{count} = 0;
 691         $self->{tonode} = $dxchan->call;
 692         $self->{fromnode} = $main::mycall;
 693         $busy{$self->{tonode}} = $self;
 694         $work{$self->{tonode}} = $self;
 695         $self->{lastt} = $main::systime;
 696         my ($fromnode, $origin);
 697         if ($dxchan->is_arcluster) {
 698                 $fromnode = $self->{origin};
 699                 $origin = $self->{fromnode};
 700         } else {
 701                 $fromnode = $self->{fromnode};
 702                 $origin = $self->{origin};
 703         }
 704         $dxchan->send(DXProt::pc28($self->{tonode}, $fromnode, $self->{to}, $self->{from}, $self->{t}, $self->{private}, $self->{subject}, $origin, $self->{rrreq}));
 705 }
 706
 707 # get the ref of a busy node
 708 sub get_busy
 709 {
 710         my $call = shift;
 711         return $busy{$call};
 712 }
 713
 714 # get the busy queue
 715 sub get_all_busy
 716 {
 717         return values %busy;
 718 }
 719
 720 # get the forwarding queue
 721 sub get_fwq
 722 {
 723         return values %work;
 724 }
 725
 726 # stop a message from continuing, clean it out, unlock interlocks etc
 727 sub stop_msg
 728 {
 729         my $self = shift;
 730         my $node = shift;
 731         my $stream = $self->{stream} if exists $self->{stream};
 732
 733
 734         dbg("stop msg $self->{msgno} -> node $node\n") if isdbg('msg');
 735         delete $work{$node};
 736         delete $work{"$node$stream"} if $stream;
 737         $self->workclean;
 738         delete $busy{$node};
 739 }
 740
 741 # get a new transaction number from the file specified
 742 sub next_transno
 743 {
 744         my $name = shift;
 745         $name =~ s/\W//og;                      # remove non-word characters
 746         my $fn = "$msgdir/$name";
 747         my $msgno;
 748
 749         my $fh = new IO::File;
 750         if (sysopen($fh, $fn, O_RDWR|O_CREAT, 0666)) {
 751                 $fh->autoflush(1);
 752                 $msgno = $fh->getline || '0';
 753                 chomp $msgno;
 754                 $msgno++;
 755                 seek $fh, 0, 0;
 756                 $fh->print("$msgno\n");
 757                 dbg("msgno $msgno allocated for $name\n") if isdbg('msg');
 758                 $fh->close;
 759         } else {
 760                 confess "can't open $fn $!";
 761         }
 762         return $msgno;
 763 }
 764
 765 # initialise the message 'system', read in all the message headers
 766 sub init
 767 {
 768         my $dir = new IO::File;
 769         my @dir;
 770         my $ref;
 771
 772         # load various control files
 773         dbg("load badmsg: " . (load_badmsg() or "Ok"));
 774         dbg("load forward: " . (load_forward() or "Ok"));
 775         dbg("load swop: " . (load_swop() or "Ok"));
 776
 777         # read in the directory
 778         opendir($dir, $msgdir) or confess "can't open $msgdir $!";
 779         @dir = readdir($dir);
 780         closedir($dir);
 781
 782         @msg = ();
 783         for (sort @dir) {
 784                 next unless /^m\d\d\d\d\d\d$/;
 785
 786                 $ref = read_msg_header("$msgdir/$_");
 787                 unless ($ref) {
 788                         dbg("Deleting $_");
 789                         Log('err', "Deleting $_");
 790                         unlink "$msgdir/$_";
 791                         next;
 792                 }
 793
 794                 # delete any messages to 'badmsg.pl' places
 795                 if ($ref->dump_it('')) {
 796                         dbg("'Bad' TO address $ref->{to}") if isdbg('msg');
 797                         Log('msg', "'Bad' TO address $ref->{to}");
 798                         $ref->del_msg;
 799                         next;
 800                 }
 801
 802                 # add the message to the available queue
 803                 add_dir($ref);
 804         }
 805 }
 806
 807 # add the message to the directory listing
 808 sub add_dir
 809 {
 810         my $ref = shift;
 811         confess "tried to add a non-ref to the msg directory" if !ref $ref;
 812         push @msg, $ref;
 813 }
 814
 815 # return all the current messages
 816 sub get_all
 817 {
 818         return @msg;
 819 }
 820
 821 # get a particular message
 822 sub get
 823 {
 824         my $msgno = shift;
 825         for (@msg) {
 826                 return $_ if $_->{msgno} == $msgno;
 827                 last if $_->{msgno} > $msgno;
 828         }
 829         return undef;
 830 }
 831
 832 # return the official filename for a message no
 833 sub filename
 834 {
 835         return sprintf "$msgdir/m%06d", shift;
 836 }
 837
 838 #
 839 # return a list of valid elements
 840 #
 841
 842 sub fields
 843 {
 844         return keys(%valid);
 845 }
 846
 847 #
 848 # return a prompt for a field
 849 #
 850
 851 sub field_prompt
 852 {
 853         my ($self, $ele) = @_;
 854         return $valid{$ele};
 855 }
 856
 857 #
 858 # send a message state machine
 859 sub do_send_stuff
 860 {
 861         my $self = shift;
 862         my $line = shift;
 863         my @out;
 864
 865         if ($self->state eq 'send1') {
 866                 #  $DB::single = 1;
 867                 confess "local var gone missing" if !ref $self->{loc};
 868                 my $loc = $self->{loc};
 869                 $loc->{subject} = $line;
 870                 $loc->{lines} = [];
 871                 $self->state('sendbody');
 872                 #push @out, $self->msg('sendbody');
 873                 push @out, $self->msg('m8');
 874         } elsif ($self->state eq 'sendbody') {
 875                 confess "local var gone missing" if !ref $self->{loc};
 876                 my $loc = $self->{loc};
 877                 if ($line eq "\032" || $line eq '%1A' || uc $line eq "/EX") {
 878                         my $to;
 879
 880                         foreach $to (@{$loc->{to}}) {
 881                                 my $ref;
 882                                 my $systime = $main::systime;
 883                                 my $mycall = $main::mycall;
 884                                 $ref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
 885                                                                         uc $to,
 886                                                                         exists $loc->{from} ? $loc->{from} : $self->call,
 887                                                                         $systime,
 888                                                                         $loc->{private},
 889                                                                         $loc->{subject},
 890                                                                         exists $loc->{origin} ? $loc->{origin} : $mycall,
 891                                                                         '0',
 892                                                                         $loc->{rrreq});
 893                                 $ref->swop_it($self->call);
 894                                 $ref->store($loc->{lines});
 895                                 $ref->add_dir();
 896                                 push @out, $self->msg('m11', $ref->{msgno}, $to);
 897                                 #push @out, "msgno $ref->{msgno} sent to $to";
 898                                 my $dxchan = DXChannel->get(uc $to);
 899                                 if ($dxchan) {
 900                                         if ($dxchan->is_user()) {
 901                                                 $dxchan->send($dxchan->msg('m9'));
 902                                         }
 903                                 }
 904                         }
 905
 906                         delete $loc->{lines};
 907                         delete $loc->{to};
 908                         delete $self->{loc};
 909                         $self->func(undef);
 910
 911                         $self->state('prompt');
 912                 } elsif ($line eq "\031" || uc $line eq "/ABORT" || uc $line eq "/QUIT") {
 913                         #push @out, $self->msg('sendabort');
 914                         push @out, $self->msg('m10');
 915                         delete $loc->{lines};
 916                         delete $loc->{to};
 917                         delete $self->{loc};
 918                         $self->func(undef);
 919                         $self->state('prompt');
 920                 } else {
 921
 922                         # i.e. it ain't and end or abort, therefore store the line
 923                         push @{$loc->{lines}}, length($line) > 0 ? $line : " ";
 924                 }
 925         }
 926         return (1, @out);
 927 }
 928
 929 # return the standard directory line for this ref
 930 sub dir
 931 {
 932         my $ref = shift;
 933         return sprintf "%6d%s%s%5d %8.8s %8.8s %-6.6s %5.5s %-30.30s",
 934                 $ref->msgno, $ref->read ? '-' : ' ', $ref->private ? 'p' : ' ', $ref->size,
 935                         $ref->to, $ref->from, cldate($ref->t), ztime($ref->t), $ref->subject;
 936 }
 937
 938 # load the forward table
 939 sub load_forward
 940 {
 941         my @out;
 942         my $s = readfilestr($forwardfn);
 943         if ($s) {
 944                 eval $s;
 945                 push @out, $@ if $@;
 946         }
 947         return @out;
 948 }
 949
 950 # load the bad message table
 951 sub load_badmsg
 952 {
 953         my @out;
 954         my $s = readfilestr($badmsgfn);
 955         if ($s) {
 956                 eval $s;
 957                 push @out, $@ if $@;
 958         }
 959         return @out;
 960 }
 961
 962 # load the swop message table
 963 sub load_swop
 964 {
 965         my @out;
 966         my $s = readfilestr($swopfn);
 967         if ($s) {
 968                 eval $s;
 969                 push @out, $@ if $@;
 970         }
 971         return @out;
 972 }
 973
 974 #
 975 # forward that message or not according to the forwarding table
 976 # returns 1 for forward, 0 - to ignore
 977 #
 978
 979 sub forward_it
 980 {
 981         my $ref = shift;
 982         my $call = shift;
 983         my $i;
 984
 985         for ($i = 0; $i < @forward; $i += 5) {
 986                 my ($sort, $field, $pattern, $action, $bbs) = @forward[$i..($i+4)];
 987                 my $tested;
 988
 989                 # are we interested?
 990                 next if $ref->{private} && $sort ne 'P';
 991                 next if !$ref->{private} && $sort ne 'B';
 992
 993                 # select field
 994                 $tested = $ref->{to} if $field eq 'T';
 995                 $tested = $ref->{from} if $field eq 'F';
 996                 $tested = $ref->{origin} if $field eq 'O';
 997                 $tested = $ref->{subject} if $field eq 'S';
 998
 999                 if (!$pattern || $tested =~ m{$pattern}i) {
1000                         return 0 if $action eq 'I';
1001                         return 1 if !$bbs || grep $_ eq $call, @{$bbs};
1002                 }
1003         }
1004         return 0;
1005 }
1006
1007 sub dump_it
1008 {
1009         my $ref = shift;
1010         my $call = shift;
1011         my $i;
1012
1013         for ($i = 0; $i < @badmsg; $i += 3) {
1014                 my ($sort, $field, $pattern) = @badmsg[$i..($i+2)];
1015                 my $tested;
1016
1017                 # are we interested?
1018                 next if $ref->{private} && $sort ne 'P';
1019                 next if !$ref->{private} && $sort ne 'B';
1020
1021                 # select field
1022                 $tested = $ref->{to} if $field eq 'T';
1023                 $tested = $ref->{from} if $field eq 'F';
1024                 $tested = $ref->{origin} if $field eq 'O';
1025                 $tested = $ref->{subject} if $field eq 'S';
1026                 $tested = $call if $field eq 'I';
1027
1028                 if (!$pattern || $tested =~ m{$pattern}i) {
1029                         return 1;
1030                 }
1031         }
1032         return 0;
1033 }
1034
1035 sub swop_it
1036 {
1037         my $ref = shift;
1038         my $call = shift;
1039         my $i;
1040         my $count = 0;
1041
1042         for ($i = 0; $i < @swop; $i += 5) {
1043                 my ($sort, $field, $pattern, $tfield, $topattern) = @swop[$i..($i+4)];
1044                 my $tested;
1045                 my $swop;
1046                 my $old;
1047
1048                 # are we interested?
1049                 next if $ref->{private} && $sort ne 'P';
1050                 next if !$ref->{private} && $sort ne 'B';
1051
1052                 # select field
1053                 $tested = $ref->{to} if $field eq 'T';
1054                 $tested = $ref->{from} if $field eq 'F';
1055                 $tested = $ref->{origin} if $field eq 'O';
1056                 $tested = $ref->{subject} if $field eq 'S';
1057
1058                 # select swop field
1059                 $old = $swop = $ref->{to} if $tfield eq 'T';
1060                 $old = $swop = $ref->{from} if $tfield eq 'F';
1061                 $old = $swop = $ref->{origin} if $tfield eq 'O';
1062                 $old = $swop = $ref->{subject} if $tfield eq 'S';
1063
1064                 if ($tested =~ m{$pattern}i) {
1065                         if ($tested eq $swop) {
1066                                 $swop =~ s{$pattern}{$topattern}i;
1067                         } else {
1068                                 $swop = $topattern;
1069                         }
1070                         Log('msg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1071                         Log('dbg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1072                         $ref->{to} = $swop if $tfield eq 'T';
1073                         $ref->{from} = $swop if $tfield eq 'F';
1074                         $ref->{origin} = $swop if $tfield eq 'O';
1075                         $ref->{subject} = $swop if $tfield eq 'S';
1076                         ++$count;
1077                 }
1078         }
1079         return $count;
1080 }
1081
1082 # import any msgs in the import directory
1083 # the messages are in BBS format (but may have cluster extentions
1084 # so SB UK < GB7TLH is legal
1085 sub import_msgs
1086 {
1087         # are there any to do in this directory?
1088         return unless -d $importfn;
1089         unless (opendir(DIR, $importfn)) {
1090                 dbg("can\'t open $importfn $!") if isdbg('msg');
1091                 Log('msg', "can\'t open $importfn $!");
1092                 return;
1093         }
1094
1095         my @names = readdir(DIR);
1096         closedir(DIR);
1097         my $name;
1098         foreach $name (@names) {
1099                 next if $name =~ /^\./;
1100                 my $splitit = $name =~ /^split/;
1101                 my $fn = "$importfn/$name";
1102                 next unless -f $fn;
1103                 unless (open(MSG, $fn)) {
1104                         dbg("can\'t open import file $fn $!") if isdbg('msg');
1105                         Log('msg', "can\'t open import file $fn $!");
1106                         unlink($fn);
1107                         next;
1108                 }
1109                 my @msg = map { chomp; $_ } <MSG>;
1110                 close(MSG);
1111                 unlink($fn);
1112                 my @out = import_one($DXProt::me, \@msg, $splitit);
1113                 Log('msg', @out);
1114         }
1115 }
1116
1117 # import one message as a list in bbs (as extended) mode
1118 # takes a reference to an array containing the whole message
1119 sub import_one
1120 {
1121         my $dxchan = shift;
1122         my $ref = shift;
1123         my $splitit = shift;
1124         my $private = '1';
1125         my $rr = '0';
1126         my $notincalls = 1;
1127         my $from = $dxchan->call;
1128         my $origin = $main::mycall;
1129         my @to;
1130         my @out;
1131
1132         # first line;
1133         my $line = shift @$ref;
1134         my @f = split /\s+/, $line;
1135         unless (@f && $f[0] =~ /^(:?S|SP|SB|SEND)$/ ) {
1136                 my $m = "invalid first line in import '$line'";
1137                 dbg($m) if isdbg('msg');
1138                 return (1, $m);
1139         }
1140         while (@f) {
1141                 my $f = uc shift @f;
1142                 next if $f eq 'SEND';
1143
1144                 # private / noprivate / rr
1145                 if ($notincalls && ($f eq 'B' || $f eq 'SB' || $f =~ /^NOP/oi)) {
1146                         $private = '0';
1147                 } elsif ($notincalls && ($f eq 'P' || $f eq 'SP' || $f =~ /^PRI/oi)) {
1148                         ;
1149                 } elsif ($notincalls && ($f eq 'RR')) {
1150                         $rr = '1';
1151                 } elsif ($f eq '@' && @f) {       # this is bbs syntax, for origin
1152                         $origin = uc shift @f;
1153                 } elsif ($f eq '<' && @f) {     # this is bbs syntax  for from call
1154                         $from = uc shift @f;
1155                 } elsif ($f =~ /^\$/) {     # this is bbs syntax  for a bid
1156                         next;
1157                 } elsif ($f =~ /^<\S+/) {     # this is bbs syntax  for from call
1158                         ($from) = $f =~ /^<(\S+)$/;
1159                 } elsif ($f =~ /^\@\S+/) {     # this is bbs syntax for origin
1160                         ($origin) = $f =~ /^\@(\S+)$/;
1161                 } else {
1162
1163                         # callsign ?
1164                         $notincalls = 0;
1165
1166                         # is this callsign a distro?
1167                         my $fn = "$msgdir/distro/$f.pl";
1168                         if (-e $fn) {
1169                                 my $fh = new IO::File $fn;
1170                                 if ($fh) {
1171                                         local $/ = undef;
1172                                         my $s = <$fh>;
1173                                         $fh->close;
1174                                         my @call;
1175                                         @call = eval $s;
1176                                         return (1, "Error in Distro $f.pl:", $@) if $@;
1177                                         if (@call > 0) {
1178                                                 push @f, @call;
1179                                                 next;
1180                                         }
1181                                 }
1182                         }
1183
1184                         if (grep $_ eq $f, @DXMsg::badmsg) {
1185                                 push @out, $dxchan->msg('m3', $f);
1186                         } else {
1187                                 push @to, $f;
1188                         }
1189                 }
1190         }
1191
1192         # subject is the next line
1193         my $subject = shift @$ref;
1194
1195         # strip off trailing lines
1196         pop @$ref while (@$ref && $$ref[-1] =~ /^\s*$/);
1197
1198         # strip off /EX or /ABORT
1199         return ("aborted") if @$ref && $$ref[-1] =~ m{^/ABORT$}i;
1200         pop @$ref if (@$ref && $$ref[-1] =~ m{^/EX$}i);
1201
1202         # sort out any splitting that needs to be done
1203         my @chunk;
1204         if ($splitit) {
1205                 my $lth = 0;
1206                 my $lines = [];
1207                 for (@$ref) {
1208                         if ($lth >= $maxchunk || ($lth > $minchunk && /^\s*$/)) {
1209                                 push @chunk, $lines;
1210                                 $lines = [];
1211                                 $lth = 0;
1212                         }
1213                         push @$lines, $_;
1214                         $lth += length;
1215                 }
1216                 push @chunk, $lines if @$lines;
1217         } else {
1218                 push @chunk, $ref;
1219         }
1220
1221     # write all the messages away
1222         my $i;
1223         for ( $i = 0;  $i < @chunk; $i++) {
1224                 my $chunk = $chunk[$i];
1225                 my $ch_subject;
1226                 if (@chunk > 1) {
1227                         my $num = " [" . ($i+1) . "/" . scalar @chunk . "]";
1228                         $ch_subject = substr($subject, 0, 27 - length $num) .  $num;
1229                 } else {
1230                         $ch_subject = $subject;
1231                 }
1232                 my $to;
1233                 foreach $to (@to) {
1234                         my $systime = $main::systime;
1235                         my $mycall = $main::mycall;
1236                         my $mref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
1237                                                                         $to,
1238                                                                         $from,
1239                                                                         $systime,
1240                                                                         $private,
1241                                                                         $ch_subject,
1242                                                                         $origin,
1243                                                                         '0',
1244                                                                         $rr);
1245                         $mref->swop_it($main::mycall);
1246                         $mref->store($chunk);
1247                         $mref->add_dir();
1248                         push @out, $dxchan->msg('m11', $mref->{msgno}, $to);
1249                         #push @out, "msgno $ref->{msgno} sent to $to";
1250                         my $todxchan = DXChannel->get(uc $to);
1251                         if ($todxchan) {
1252                                 if ($todxchan->is_user()) {
1253                                         $todxchan->send($todxchan->msg('m9'));
1254                                 }
1255                         }
1256                 }
1257         }
1258         return @out;
1259 }
1260
1261 no strict;
1262 sub AUTOLOAD
1263 {
1264         my $self = shift;
1265         my $name = $AUTOLOAD;
1266         return if $name =~ /::DESTROY$/;
1267         $name =~ s/.*:://o;
1268
1269         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
1270         # this clever line of code creates a subroutine which takes over from autoload
1271         # from OO Perl - Conway
1272         *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
1273         @_ ? $self->{$name} = shift : $self->{$name} ;
1274 }
1275
1276 1;
1277
1278 __END__