3 # This module impliments the message handling for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
10 # Notes for implementors:-
12 # PC28 field 11 is the RR required flag
13 # PC28 field 12 is a VIA routing (ie it is a node call)
35 use vars qw($VERSION $BRANCH);
36 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
37 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
38 $main::build += $VERSION;
39 $main::branch += $BRANCH;
41 use vars qw(%work @msg $msgdir %valid %busy $maxage $last_clean $residencetime
42 @badmsg @swop $swopfn $badmsgfn $forwardfn @forward $timeout $waittime
43 $email_server $email_prog $email_from
44 $queueinterval $lastq $importfn $minchunk $maxchunk $bulltopriv);
46 %work = (); # outstanding jobs
47 @msg = (); # messages we have
48 %busy = (); # station interlocks
49 $msgdir = "$main::root/msg"; # directory contain the msgs
50 $maxage = 30 * 86400; # the maximum age that a message shall live for if not marked
51 $last_clean = 0; # last time we did a clean
52 @forward = (); # msg forward table
53 @badmsg = (); # bad message table
54 @swop = (); # swop table
55 $timeout = 30*60; # forwarding timeout
56 $waittime = 30*60; # time an aborted outgoing message waits before trying again
57 $queueinterval = 1*60; # run the queue every 1 minute
60 $minchunk = 4800; # minimum chunk size for a split message
61 $maxchunk = 6000; # maximum chunk size
62 $bulltopriv = 1; # convert msgs with callsigns to private if they are bulls
63 $residencetime = 2*86400; # keep deleted messages for this amount of time
64 $email_server = undef; # DNS address of smtp server if 'smtp'
65 $email_prog = undef; # program name + args for sending mail
66 $email_from = undef; # the from address the email will appear to be from
68 $badmsgfn = "$msgdir/badmsg.pl"; # list of TO address we wont store
69 $forwardfn = "$msgdir/forward.pl"; # the forwarding table
70 $swopfn = "$msgdir/swop.pl"; # the swopping table
71 $importfn = "$msgdir/import"; # import directory
75 fromnode => '5,From Node',
76 tonode => '5,To Node',
79 t => '0,Msg Time,cldatetime',
80 private => '5,Private,yesno',
81 subject => '0,Subject',
82 linesreq => '0,Lines per Gob',
83 rrreq => '5,Read Confirm,yesno',
86 stream => '9,Stream No',
87 count => '5,Gob Linecnt',
88 file => '5,File?,yesno',
89 gotit => '5,Got it Nodes,parray',
90 lines => '5,Lines,parray',
91 'read' => '5,Times read',
94 keep => '0,Keep this?,yesno',
95 lastt => '5,Last processed,cldatetime',
96 waitt => '5,Wait until,cldatetime',
97 delete => '5,Awaiting Delete,yesno',
98 deletetime => '5,Deletion Time,cldatetime',
101 # fix up the default sendmail if available
102 for (qw(/usr/sbin/sendmail /usr/lib/sendmail /usr/sbin/sendmail)) {
109 # allocate a new object
110 # called fromnode, tonode, from, to, datetime, private?, subject, nolinesper
114 my $self = bless {}, $pkg;
115 $self->{msgno} = shift;
118 $self->{to} = ($to eq $main::mycall) ? $main::myalias : $to;
120 $self->{from} = uc $from;
122 $self->{private} = shift;
123 $self->{subject} = shift;
124 $self->{origin} = shift;
125 $self->{'read'} = shift;
126 $self->{rrreq} = shift;
127 $self->{delete} = shift;
128 $self->{deletetime} = shift || ($self->{t} + $maxage);
129 $self->{keep} = shift;
131 # $self->{lastt} = $main::systime;
133 $self->{private} = 1 if $bulltopriv && DXUser->get_current($self->{to});
141 # this is periodic processing
142 if ($main::systime >= $lastq + $queueinterval) {
144 # queue some message if the interval timer has gone off
147 # import any messages in the import directory
150 $lastq = $main::systime;
153 # clean the message queue
154 if ($main::systime >= $last_clean+3600) {
156 $last_clean = $main::systime;
159 # actual remove all the 'deleted' messages in one hit.
160 # this has to be delayed until here otherwise it only does one at
161 # a time because @msg is rewritten everytime del_msg is called.
162 my @del = grep {!$_->{tonode} && $_->{delete} && !$_->{keep} && $_->{deletetime} < $main::systime} @msg;
173 my ($tonode, $fromnode) = @_[1..2];
175 # sort out various extant protocol errors that occur
177 $origin = $dxchan->call unless $origin && $origin gt ' ';
179 # first look for any messages in the busy queue
180 # and cancel them this should both resolve timed out incoming messages
181 # and crossing of message between nodes, incoming messages have priority
183 my $ref = get_busy($fromnode);
185 my $otonode = $ref->{tonode} || "unknown";
186 dbg("Busy, stopping msgno: $ref->{msgno} $fromnode->$otonode") if isdbg('msg');
187 $ref->stop_msg($fromnode);
190 my $t = cltounix($_[5], $_[6]);
191 my $stream = next_transno($fromnode);
192 $ref = DXMsg->alloc($stream, uc $_[3], $_[4], $t, $_[7], $_[8], $origin, '0', $_[11]);
194 # fill in various forwarding state variables
195 $ref->{fromnode} = $fromnode;
196 $ref->{tonode} = $tonode;
197 $ref->{rrreq} = $_[11];
198 $ref->{linesreq} = $_[10];
199 $ref->{stream} = $stream;
200 $ref->{count} = 0; # no of lines between PC31s
201 dbg("new message from $_[4] to $_[3] '$_[8]' stream $fromnode/$stream\n") if isdbg('msg');
202 Log('msg', "Incoming message $_[4] to $_[3] '$_[8]' origin: $origin" );
203 set_fwq($fromnode, $stream, $ref); # store in work
204 set_busy($fromnode, $ref); # set interlock
205 $dxchan->send(DXProt::pc30($fromnode, $tonode, $stream)); # send ack
206 $ref->{lastt} = $main::systime;
208 # look to see whether this is a non private message sent to a known callsign
209 my $uref = DXUser->get_current($ref->{to});
210 if (is_callsign($ref->{to}) && !$ref->{private} && $uref && $uref->homenode) {
212 dbg("set bull to $ref->{to} to private") if isdbg('msg');
213 Log('msg', "set bull to $ref->{to} to private");
221 my ($tonode, $fromnode, $stream) = @_[1..3];
223 my $ref = get_fwq($fromnode, $stream);
226 if (@{$ref->{lines}}) {
227 push @{$ref->{lines}}, $_[4];
229 # temporarily store any R: lines so that we end up with
230 # only the first and last ones stored.
231 if ($_[4] =~ m|^R:\d{6}/\d{4}|) {
232 push @{$ref->{tempr}}, $_[4];
234 if (exists $ref->{tempr}) {
235 push @{$ref->{lines}}, shift @{$ref->{tempr}};
236 push @{$ref->{lines}}, pop @{$ref->{tempr}} if @{$ref->{tempr}};
237 delete $ref->{tempr};
239 push @{$ref->{lines}}, $_[4];
243 if ($ref->{count} >= $ref->{linesreq}) {
244 $dxchan->send(DXProt::pc31($fromnode, $tonode, $stream));
245 dbg("stream $stream: $ref->{count} lines received\n") if isdbg('msg');
248 $ref->{lastt} = $main::systime;
250 dbg("PC29 from unknown stream $stream from $fromnode") if isdbg('msg');
251 $dxchan->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
255 # this is a incoming subject ack
259 my ($tonode, $fromnode, $stream) = @_[1..3];
261 my $ref = get_fwq($fromnode); # note no stream at this stage
264 $ref->{stream} = $stream;
266 $ref->{linesreq} = 5;
267 set_fwq($fromnode, $stream, $ref); # new ref
268 set_busy($fromnode, $ref); # interlock
269 dbg("incoming subject ack stream $stream\n") if isdbg('msg');
270 $ref->{lines} = [ $ref->read_msg_body ];
271 $ref->send_tranche($dxchan);
272 $ref->{lastt} = $main::systime;
274 dbg("PC30 from unknown stream $stream from $fromnode") if isdbg('msg');
275 $dxchan->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
279 # acknowledge a tranche of lines
283 my ($tonode, $fromnode, $stream) = @_[1..3];
285 my $ref = get_fwq($fromnode, $stream);
287 dbg("tranche ack stream $stream\n") if isdbg('msg');
288 $ref->send_tranche($dxchan);
289 $ref->{lastt} = $main::systime;
291 dbg("PC31 from unknown stream $stream from $fromnode") if isdbg('msg');
292 $dxchan->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
300 my ($tonode, $fromnode, $stream) = @_[1..3];
302 dbg("stream $stream: EOM received\n") if isdbg('msg');
303 my $ref = get_fwq($fromnode, $stream);
305 $dxchan->send(DXProt::pc33($fromnode, $tonode, $stream)); # acknowledge it
307 # get the next msg no - note that this has NOTHING to do with the stream number in PC protocol
308 # store the file or message
309 # remove extraneous rubbish from the hash
310 # remove it from the work in progress vector
311 # stuff it on the msg queue
314 $ref->store($ref->{lines});
318 if ($ref->{t}+$maxage < $main::systime ) {
319 $ref->stop_msg($fromnode);
320 dbg("old message from $ref->{from} -> $ref->{to} " . atime($ref->{t}) . " ignored") if isdbg('msg');
321 Log('msg', "old message from $ref->{from} -> $ref->{to} " . cldatetime($ref->{t}) . " ignored");
325 # does an identical message already exist?
328 if (substr($ref->{subject},0,28) eq substr($m->{subject},0,28) && $ref->{t} == $m->{t} && $ref->{from} eq $m->{from} && $ref->{to} eq $m->{to}) {
329 $ref->stop_msg($fromnode);
330 my $msgno = $m->{msgno};
331 dbg("duplicate message from $ref->{from} -> $ref->{to} to msg: $msgno") if isdbg('msg');
332 Log('msg', "duplicate message from $ref->{from} -> $ref->{to} to msg: $msgno");
338 $ref->swop_it($dxchan->call);
340 # look for 'bad' to addresses
341 if ($ref->dump_it($dxchan->call)) {
342 $ref->stop_msg($fromnode);
343 dbg("'Bad' message $ref->{to}") if isdbg('msg');
344 Log('msg', "'Bad' message $ref->{to}");
348 # check the message for bad words
351 @bad = BadWords::check($ref->{subject});
352 push @words, [$ref->{subject}, @bad] if @bad;
353 for (@{$ref->{lines}}) {
354 @bad = BadWords::check($_);
355 push @words, [$_, @bad] if @bad;
358 LogDbg('msg',"$ref->{from} swore: $ref->{to} origin: $ref->{origin} via " . $dxchan->call);
359 LogDbg('msg',"subject: $ref->{subject}");
362 my $line = shift @$r;
363 LogDbg('msg', "line: $line (using words: ". join(',', @$r).")");
365 $ref->stop_msg($fromnode);
369 $ref->{msgno} = next_transno("Msgno");
370 push @{$ref->{gotit}}, $fromnode; # mark this up as being received
371 $ref->store($ref->{lines});
374 Log('msg', "Message $ref->{msgno} from $ref->{from} received from $fromnode for $ref->{to}");
377 $ref->stop_msg($fromnode);
379 dbg("PC32 from unknown stream $stream from $fromnode") if isdbg('msg');
380 $dxchan->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
385 # acknowledge the end of message
389 my ($tonode, $fromnode, $stream) = @_[1..3];
391 my $ref = get_fwq($fromnode, $stream);
393 if ($ref->{private}) { # remove it if it private and gone off site#
394 Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $fromnode and deleted");
397 Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $fromnode");
398 push @{$ref->{gotit}}, $fromnode; # mark this up as being received
399 $ref->store($ref->{lines}); # re- store the file
401 $ref->stop_msg($fromnode);
403 dbg("PC33 from unknown stream $stream from $fromnode") if isdbg('msg');
404 $dxchan->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
407 # send next one if present
411 # this is a file request
415 my ($tonode, $fromnode) = @_[1..2];
417 $_[3] =~ s/\\/\//og; # change the slashes
418 $_[3] =~ s/\.//og; # remove dots
419 $_[3] =~ s/^\///o; # remove the leading /
420 $_[3] = lc $_[3]; # to lower case;
421 dbg("incoming file $_[3]\n") if isdbg('msg');
422 $_[3] = 'packclus/' . $_[3] unless $_[3] =~ /^packclus\//o;
424 # create any directories
425 my @part = split /\//, $_[3];
427 my $fn = "$main::root";
428 pop @part; # remove last part
429 foreach $part (@part) {
432 last SWITCH if !mkdir $fn, 0777;
433 dbg("created directory $fn\n") if isdbg('msg');
435 my $stream = next_transno($fromnode);
436 my $ref = DXMsg->alloc($stream, "$main::root/$_[3]", $dxchan->call, time, !$_[4], $_[3], ' ', '0', '0');
438 # forwarding variables
439 $ref->{fromnode} = $tonode;
440 $ref->{tonode} = $fromnode;
441 $ref->{linesreq} = $_[5];
442 $ref->{stream} = $stream;
443 $ref->{count} = 0; # no of lines between PC31s
445 $ref->{lastt} = $main::systime;
446 set_fwq($fromnode, $stream, $ref); # store in work
447 $dxchan->send(DXProt::pc30($fromnode, $tonode, $stream)); # send ack
454 my ($tonode, $fromnode, $stream) = @_[1..3];
456 dbg("stream $stream: abort received\n") if isdbg('msg');
457 my $ref = get_fwq($fromnode, $stream);
459 $ref->stop_msg($fromnode);
464 # global delete on subject
471 if ($_->{from} eq $_[1] && $_->{subject} eq $_[2]) {
473 Log('msg', "Message $_->{msgno} from $_->{from} ($_->{subject}) fully deleted");
474 DXChannel::broadcast_nodes($line, $dxchan);
485 my $uref = DXUser->get_current($to);
486 my $dxchan = DXChannel::get($to);
487 if (((*Net::SMTP && $email_server) || $email_prog) && $uref && $uref->wantemail) {
488 my $email = $uref->email;
490 my @rcpt = ref $email ? @{$email} : $email;
491 my $fromaddr = $email_from || $main::myemail;
492 my @headers = ("To: $ref->{to}",
494 "Subject: [DXSpider: $ref->{from}] $ref->{subject}",
495 "X-DXSpider-To: $ref->{to}",
496 "X-DXSpider-From: $ref->{from}\@$ref->{origin}",
497 "X-DXSpider-Gateway: $main::mycall"
499 my @data = ("Msgno: $ref->{msgno} To: $to From: $ref->{from}\@$ref->{origin} Gateway: $main::mycall",
505 if (*Net::SMTP && $email_server) {
506 $msg = Net::SMTP->new($email_server);
508 $msg->mail($fromaddr);
510 $msg->data(map {"$_\n"} @headers, '', @data);
513 } elsif ($email_prog) {
514 $msg = new IO::File "|$email_prog " . join(' ', @rcpt);
516 print $msg map {"$_\r\n"} @headers, '', @data, '.';
520 dbg("email forwarding error $!") if isdbg('msg') && !$msg && defined $!;
523 $dxchan->send($dxchan->msg('m9')) if $dxchan && $dxchan->is_user;
526 # store a message away on disc or whatever
528 # NOTE the second arg is a REFERENCE not a list
534 if ($ref->{file}) { # a file
535 dbg("To be stored in $ref->{to}\n") if isdbg('msg');
537 my $fh = new IO::File "$ref->{to}", "w";
540 foreach $line (@{$lines}) {
544 dbg("file $ref->{to} stored\n") if isdbg('msg');
545 Log('msg', "file $ref->{to} from $ref->{from} stored" );
547 confess "can't open file $ref->{to} $!";
549 } else { # a normal message
551 # attempt to open the message file
552 my $fn = filename($ref->{msgno});
554 dbg("To be stored in $fn\n") if isdbg('msg');
556 # now save the file, overwriting what's there, YES I KNOW OK! (I will change it if it's a problem)
557 my $fh = new IO::File "$fn", "w";
559 my $rr = $ref->{rrreq} ? '1' : '0';
560 my $priv = $ref->{private} ? '1': '0';
561 my $del = $ref->{delete} ? '1' : '0';
562 my $delt = $ref->{deletetime} || ($ref->{t} + $maxage);
563 my $keep = $ref->{keep} || '0';
564 print $fh "=== $ref->{msgno}^$ref->{to}^$ref->{from}^$ref->{t}^$priv^$ref->{subject}^$ref->{origin}^$ref->{'read'}^$rr^$del^$delt^$keep\n";
565 print $fh "=== ", join('^', @{$ref->{gotit}}), "\n";
568 foreach $line (@{$lines}) {
569 $line =~ s/[\x00-\x08\x0a-\x1f\x80-\x9f]/./g;
570 $ref->{size} += (length $line) + 1;
574 dbg("msg $ref->{msgno} stored\n") if isdbg('msg');
575 Log('msg', "msg $ref->{msgno} from $ref->{from} to $ref->{to} stored" );
577 confess "can't open msg file $fn $!";
589 $call = ' by ' . $dxchan->call if $dxchan;
591 if ($self->{tonode}) {
593 $self->{deletetime} = 0;
594 dbg("Msgno $self->{msgno} but marked as expunged$call") if isdbg('msg');
596 # remove it from the active message list
597 @msg = grep { $_ != $self } @msg;
599 Log('msg', "Msgno $self->{msgno} expunged$call");
600 dbg("Msgno $self->{msgno} expunged$call") if isdbg('msg');
603 unlink filename($self->{msgno});
612 return if $ref->{keep};
614 $t = $main::systime + $residencetime unless defined $t;
617 $ref->{deletetime} = $t;
618 $ref->store( [$ref->read_msg_body] );
626 $ref->{deletetime} = 0;
629 # clean out old messages from the message queue
634 # mark old messages for deletion
635 foreach $ref (@msg) {
636 if (ref($ref) && !$ref->{keep} && $ref->{deletetime} < $main::systime) {
638 # this is for IMMEDIATE destruction
640 $ref->{deletetime} = 0;
645 # read in a message header
655 $file = new IO::File "$fn";
657 dbg("Error reading $fn $!");
658 Log('err', "Error reading $fn $!");
662 $line = <$file>; # first line
663 if ($size == 0 || !$line) {
665 Log('err', "Empty $fn $!");
669 $size -= length $line;
670 if (! $line =~ /^===/o) {
671 dbg("corrupt first line in $fn ($line)");
672 Log('err', "corrupt first line in $fn ($line)");
676 @f = split /\^/, $line;
677 $ref = DXMsg->alloc(@f);
679 $line = <$file>; # second line
681 $size -= length $line;
682 if (! $line =~ /^===/o) {
683 dbg("corrupt second line in $fn ($line)");
684 Log('err', "corrupt second line in $fn ($line)");
689 @f = split /\^/, $line;
690 push @{$ref->{gotit}}, @f;
691 $ref->{size} = $size;
698 # read in a message header
702 my $msgno = $self->{msgno};
705 my $fn = filename($msgno);
708 $file = new IO::File;
709 if (!open($file, $fn)) {
710 dbg("Error reading $fn $!");
711 Log('err' ,"Error reading $fn $!");
714 @out = map {chomp; $_} <$file>;
717 shift @out if $out[0] =~ /^=== /;
718 shift @out if $out[0] =~ /^=== /;
722 # send a tranche of lines to the other end
725 my ($self, $dxchan) = @_;
727 my $to = $self->{tonode};
728 my $from = $self->{fromnode};
729 my $stream = $self->{stream};
730 my $lines = $self->{lines};
733 for ($i = 0, $c = $self->{count}; $i < $self->{linesreq} && $c < @$lines; $i++, $c++) {
734 push @out, DXProt::pc29($to, $from, $stream, $lines->[$c]);
738 push @out, DXProt::pc32($to, $from, $stream) if $i < $self->{linesreq};
743 # find a message to send out and start the ball rolling
750 # bat down the message list looking for one that needs to go off site and whose
751 # nearest node is not busy.
753 dbg("queue msg ($sort)\n") if isdbg('msg');
754 my @nodelist = DXChannel::get_all_nodes;
755 foreach $ref (@msg) {
757 # ignore 'delayed' messages until their waiting time has expired
758 if (exists $ref->{waitt}) {
759 next if $ref->{waitt} > $main::systime;
760 delete $ref->{waitt};
764 if (exists $ref->{lastt} && $main::systime >= $ref->{lastt} + $timeout) {
765 my $node = $ref->{tonode};
766 dbg("Timeout, stopping msgno: $ref->{msgno} -> $node") if isdbg('msg');
767 Log('msg', "Timeout, stopping msgno: $ref->{msgno} -> $node");
768 $ref->stop_msg($node);
770 # delay any outgoing messages that fail
771 $ref->{waitt} = $main::systime + $waittime + int rand(120) if $node ne $main::mycall;
772 delete $ref->{lastt};
776 # is it being sent anywhere currently?
777 next if $ref->{tonode}; # ignore it if it already being processed
779 # is it awaiting deletion?
780 next if $ref->{delete};
782 # firstly, is it private and unread? if so can I find the recipient
783 # in my cluster node list offsite?
785 # deal with routed private messages
787 if ($ref->{private}) {
788 next if $ref->{'read'}; # if it is read, it is stuck here
789 $clref = Route::get($ref->{to});
791 $dxchan = $clref->dxchan;
793 if ($dxchan->is_node) {
794 next if $clref->call eq $main::mycall; # i.e. it lives here
795 $ref->start_msg($dxchan) if !get_busy($dxchan->call) && $dxchan->state eq 'normal';
798 dbg("Route: No dxchan for $ref->{to} " . ref($clref) ) if isdbg('msg');
803 # otherwise we are dealing with a bulletin or forwarded private message
804 # compare the gotit list with
805 # the nodelist up above, if there are sites that haven't got it yet
806 # then start sending it - what happens when we get loops is anyone's
807 # guess, use (to, from, time, subject) tuple?
808 foreach $dxchan (@nodelist) {
809 my $call = $dxchan->call;
811 next if $call eq $main::mycall;
812 next if ref $ref->{gotit} && grep $_ eq $call, @{$ref->{gotit}};
813 next unless $ref->forward_it($call); # check the forwarding file
814 next if $ref->{tonode}; # ignore it if it already being processed
816 # if we are here we have a node that doesn't have this message
817 if (!get_busy($call) && $dxchan->state eq 'normal') {
818 $ref->start_msg($dxchan);
824 # if all the available nodes are busy then stop
825 last if @nodelist == scalar grep { get_busy($_->call) } @nodelist;
831 # is there a message for me?
838 foreach $ref (@msg) {
839 # is it for me, private and unread?
840 if ($ref->{to} eq $call && $ref->{private}) {
841 $count++ unless $ref->{'read'} || $ref->{delete};
847 # start the message off on its travels with a PC28
850 my ($self, $dxchan) = @_;
852 confess("trying to start started msg $self->{msgno} nodes: $self->{fromnode} -> $self->{tonode}") if $self->{tonode};
853 dbg("start msg $self->{msgno}\n") if isdbg('msg');
854 $self->{linesreq} = 10;
856 $self->{tonode} = $dxchan->call;
857 $self->{fromnode} = $main::mycall;
858 set_busy($self->{tonode}, $self);
859 set_fwq($self->{tonode}, undef, $self);
860 $self->{lastt} = $main::systime;
861 my ($fromnode, $origin);
862 $fromnode = $self->{fromnode};
863 $origin = $self->{origin};
864 $dxchan->send(DXProt::pc28($self->{tonode}, $fromnode, $self->{to}, $self->{from}, $self->{t}, $self->{private}, $self->{subject}, $origin, $self->{rrreq}));
867 # get the ref of a busy node
877 return $busy{$call} = shift;
883 return delete $busy{$call};
886 # get the whole busy queue
892 # get a forwarding queue entry
896 my $stream = shift || '0';
897 return $work{"$call,$stream"};
900 # delete a forwarding queue entry
904 my $stream = shift || '0';
905 return delete $work{"$call,$stream"};
912 my $stream = shift || '0';
913 return $work{"$call,$stream"} = shift;
916 # get the whole forwarding queue
922 # stop a message from continuing, clean it out, unlock interlocks etc
927 my $stream = $self->{stream};
930 dbg("stop msg $self->{msgno} -> node $node\n") if isdbg('msg');
931 del_fwq($node, $stream);
939 delete $ref->{lines};
940 delete $ref->{linesreq};
941 delete $ref->{tonode};
942 delete $ref->{fromnode};
943 delete $ref->{stream};
945 delete $ref->{count};
946 delete $ref->{tempr};
947 delete $ref->{lastt};
948 delete $ref->{waitt};
951 # get a new transaction number from the file specified
955 $name =~ s/\W//og; # remove non-word characters
956 my $fn = "$msgdir/$name";
959 my $fh = new IO::File;
960 if (sysopen($fh, $fn, O_RDWR|O_CREAT, 0666)) {
962 $msgno = $fh->getline || '0';
966 $fh->print("$msgno\n");
967 dbg("msgno $msgno allocated for $name\n") if isdbg('msg');
970 confess "can't open $fn $!";
975 # initialise the message 'system', read in all the message headers
978 my $dir = new IO::File;
982 # load various control files
983 dbg("load badmsg: " . (load_badmsg() or "Ok"));
984 dbg("load forward: " . (load_forward() or "Ok"));
985 dbg("load swop: " . (load_swop() or "Ok"));
987 # read in the directory
988 opendir($dir, $msgdir) or confess "can't open $msgdir $!";
989 @dir = readdir($dir);
994 next unless /^m\d\d\d\d\d\d$/;
996 $ref = read_msg_header("$msgdir/$_");
999 Log('err', "Deleting $_");
1000 unlink "$msgdir/$_";
1004 # delete any messages to 'badmsg.pl' places
1005 if ($ref->dump_it('')) {
1006 dbg("'Bad' TO address $ref->{to}") if isdbg('msg');
1007 Log('msg', "'Bad' TO address $ref->{to}");
1012 # add the message to the available queue
1017 # add the message to the directory listing
1021 confess "tried to add a non-ref to the msg directory" if !ref $ref;
1025 # return all the current messages
1031 # get a particular message
1036 return $_ if $_->{msgno} == $msgno;
1037 last if $_->{msgno} > $msgno;
1042 # return the official filename for a message no
1045 return sprintf "$msgdir/m%06d", shift;
1049 # return a list of valid elements
1054 return keys(%valid);
1058 # return a prompt for a field
1063 my ($self, $ele) = @_;
1064 return $valid{$ele};
1068 # send a message state machine
1075 if ($self->state eq 'send1') {
1077 confess "local var gone missing" if !ref $self->{loc};
1078 my $loc = $self->{loc};
1079 if (my @ans = BadWords::check($line)) {
1080 $self->{badcount} += @ans;
1081 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} in msg");
1084 $loc->{subject} = $line;
1086 $self->state('sendbody');
1087 #push @out, $self->msg('sendbody');
1088 push @out, $self->msg('m8');
1089 } elsif ($self->state eq 'sendbody') {
1090 confess "local var gone missing" if !ref $self->{loc};
1091 my $loc = $self->{loc};
1092 if ($line eq "\032" || $line eq '%1A' || uc $line eq "/EX") {
1094 unless ($loc->{reject}) {
1095 foreach $to (@{$loc->{to}}) {
1097 my $systime = $main::systime;
1098 my $mycall = $main::mycall;
1099 $ref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
1101 exists $loc->{from} ? $loc->{from} : $self->call,
1105 exists $loc->{origin} ? $loc->{origin} : $mycall,
1108 $ref->swop_it($self->call);
1109 $ref->store($loc->{lines});
1111 push @out, $self->msg('m11', $ref->{msgno}, $to);
1112 #push @out, "msgno $ref->{msgno} sent to $to";
1116 LogDbg('msg', $self->call . " swore to @{$loc->{to}} subject: '$loc->{subject}' in msg, REJECTED");
1119 delete $loc->{lines};
1121 delete $self->{loc};
1124 $self->state('prompt');
1125 } elsif ($line eq "\031" || uc $line eq "/ABORT" || uc $line eq "/QUIT") {
1126 #push @out, $self->msg('sendabort');
1127 push @out, $self->msg('m10');
1128 delete $loc->{lines};
1130 delete $self->{loc};
1132 $self->state('prompt');
1133 } elsif ($line =~ m|^/+\w+|) {
1134 # this is a command that you want display for your own reference
1135 # or if it has TWO slashes is a command
1137 my $store = $line =~ s|^/+||;
1138 my @in = $self->run_cmd($line);
1141 foreach my $l (@in) {
1142 if (my @ans = BadWords::check($l)) {
1143 $self->{badcount} += @ans;
1144 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} subject: '$loc->{subject}' in msg") unless $loc->{reject};
1145 Log('msg', "line: $l");
1148 push @{$loc->{lines}}, length($l) > 0 ? $l : " ";
1152 if (my @ans = BadWords::check($line)) {
1153 $self->{badcount} += @ans;
1154 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} subject: '$loc->{subject}' in msg") unless $loc->{reject};
1155 Log('msg', "line: $line");
1159 if ($loc->{lines} && @{$loc->{lines}}) {
1160 push @{$loc->{lines}}, length($line) > 0 ? $line : " ";
1162 # temporarily store any R: lines so that we end up with
1163 # only the first and last ones stored.
1164 if ($line =~ m|^R:\d{6}/\d{4}|) {
1165 push @{$loc->{tempr}}, $line;
1167 if (exists $loc->{tempr}) {
1168 push @{$loc->{lines}}, shift @{$loc->{tempr}};
1169 push @{$loc->{lines}}, pop @{$loc->{tempr}} if @{$loc->{tempr}};
1170 delete $loc->{tempr};
1172 push @{$loc->{lines}}, length($line) > 0 ? $line : " ";
1176 # i.e. it ain't and end or abort, therefore store the line
1182 # return the standard directory line for this ref
1186 my $flag = $ref->{private} && $ref->{read} ? '-' : ' ';
1189 } elsif ($ref->{delete}) {
1190 $flag = $ref->{deletetime} > $main::systime ? 'D' : 'E';
1192 return sprintf("%6d%s%s%5d %8.8s %8.8s %-6.6s %5.5s %-30.30s",
1193 $ref->{msgno}, $flag, $ref->{private} ? 'p' : ' ',
1194 $ref->{size}, $ref->{to}, $ref->{from}, cldate($ref->{t}),
1195 ztime($ref->{t}), $ref->{subject});
1198 # load the forward table
1202 my $s = readfilestr($forwardfn);
1205 push @out, $@ if $@;
1210 # load the bad message table
1214 my $s = readfilestr($badmsgfn);
1217 push @out, $@ if $@;
1222 # load the swop message table
1226 my $s = readfilestr($swopfn);
1229 push @out, $@ if $@;
1235 # forward that message or not according to the forwarding table
1236 # returns 1 for forward, 0 - to ignore
1245 for ($i = 0; $i < @forward; $i += 5) {
1246 my ($sort, $field, $pattern, $action, $bbs) = @forward[$i..($i+4)];
1249 # are we interested?
1250 next if $ref->{private} && $sort ne 'P';
1251 next if !$ref->{private} && $sort ne 'B';
1254 $tested = $ref->{to} if $field eq 'T';
1255 $tested = $ref->{from} if $field eq 'F';
1256 $tested = $ref->{origin} if $field eq 'O';
1257 $tested = $ref->{subject} if $field eq 'S';
1259 if (!$pattern || $tested =~ m{$pattern}i) {
1260 return 0 if $action eq 'I';
1261 return 1 if !$bbs || grep $_ eq $call, @{$bbs};
1268 # look down the forward table to see whether this is a valid bull
1269 # or not (ie it will forward somewhere even if it is only here)
1277 return 1 if $call =~ /^ALL/;
1278 return 1 if $call =~ /^DX/;
1282 for ($i = 0; $i < @forward; $i += 5) {
1283 my ($sort, $field, $pattern, $action, $bbs) = @forward[$i..($i+4)];
1284 if ($field eq 'T') {
1285 if (!$pattern || $call =~ m{$pattern}i) {
1299 for ($i = 0; $i < @badmsg; $i += 3) {
1300 my ($sort, $field, $pattern) = @badmsg[$i..($i+2)];
1303 # are we interested?
1304 next if $ref->{private} && $sort ne 'P';
1305 next if !$ref->{private} && $sort ne 'B';
1308 $tested = $ref->{to} if $field eq 'T';
1309 $tested = $ref->{from} if $field eq 'F';
1310 $tested = $ref->{origin} if $field eq 'O';
1311 $tested = $ref->{subject} if $field eq 'S';
1312 $tested = $call if $field eq 'I';
1314 if (!$pattern || $tested =~ m{$pattern}i) {
1328 for ($i = 0; $i < @swop; $i += 5) {
1329 my ($sort, $field, $pattern, $tfield, $topattern) = @swop[$i..($i+4)];
1334 # are we interested?
1335 next if $ref->{private} && $sort ne 'P';
1336 next if !$ref->{private} && $sort ne 'B';
1339 $tested = $ref->{to} if $field eq 'T';
1340 $tested = $ref->{from} if $field eq 'F';
1341 $tested = $ref->{origin} if $field eq 'O';
1342 $tested = $ref->{subject} if $field eq 'S';
1345 $old = $swop = $ref->{to} if $tfield eq 'T';
1346 $old = $swop = $ref->{from} if $tfield eq 'F';
1347 $old = $swop = $ref->{origin} if $tfield eq 'O';
1348 $old = $swop = $ref->{subject} if $tfield eq 'S';
1350 if ($tested =~ m{$pattern}i) {
1351 if ($tested eq $swop) {
1352 $swop =~ s{$pattern}{$topattern}i;
1356 Log('msg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1357 Log('dbg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1358 $ref->{to} = $swop if $tfield eq 'T';
1359 $ref->{from} = $swop if $tfield eq 'F';
1360 $ref->{origin} = $swop if $tfield eq 'O';
1361 $ref->{subject} = $swop if $tfield eq 'S';
1368 # import any msgs in the import directory
1369 # the messages are in BBS format (but may have cluster extentions
1370 # so SB UK < GB7TLH is legal
1373 # are there any to do in this directory?
1374 return unless -d $importfn;
1375 unless (opendir(DIR, $importfn)) {
1376 dbg("can\'t open $importfn $!") if isdbg('msg');
1377 Log('msg', "can\'t open $importfn $!");
1381 my @names = readdir(DIR);
1384 foreach $name (@names) {
1385 next if $name =~ /^\./;
1386 my $splitit = $name =~ /^split/;
1387 my $fn = "$importfn/$name";
1389 unless (open(MSG, $fn)) {
1390 dbg("can\'t open import file $fn $!") if isdbg('msg');
1391 Log('msg', "can\'t open import file $fn $!");
1395 my @msg = map { chomp; $_ } <MSG>;
1398 my @out = import_one($main::me, \@msg, $splitit);
1403 # import one message as a list in bbs (as extended) mode
1404 # takes a reference to an array containing the whole message
1409 my $splitit = shift;
1413 my $from = $dxchan->call;
1414 my $origin = $main::mycall;
1419 my $line = shift @$ref;
1420 my @f = split /([\s\@\$])/, $line;
1421 @f = map {s/\s+//g; length $_ ? $_ : ()} @f;
1423 unless (@f && $f[0] =~ /^(:?S|SP|SB|SEND)$/ ) {
1424 my $m = "invalid first line in import '$line'";
1425 dbg($m) if isdbg('msg');
1429 my $f = uc shift @f;
1430 next if $f eq 'SEND';
1432 # private / noprivate / rr
1433 if ($notincalls && ($f eq 'B' || $f eq 'SB' || $f =~ /^NOP/oi)) {
1435 } elsif ($notincalls && ($f eq 'P' || $f eq 'SP' || $f =~ /^PRI/oi)) {
1437 } elsif ($notincalls && ($f eq 'RR')) {
1439 } elsif (($f =~ /^[\@\.\#\$]$/ || $f eq '.#') && @f) { # this is bbs syntax, for AT
1441 } elsif ($f eq '<' && @f) { # this is bbs syntax for from call
1442 $from = uc shift @f;
1443 } elsif ($f =~ /^\$/) { # this is bbs syntax for a bid
1445 } elsif ($f =~ /^<(\S+)/) { # this is bbs syntax for from call
1447 } elsif ($f =~ /^\$\S+/) { # this is bbs syntax for bid
1454 # is this callsign a distro?
1455 my $fn = "$msgdir/distro/$f.pl";
1457 my $fh = new IO::File $fn;
1464 return (1, "Error in Distro $f.pl:", $@) if $@;
1472 if (grep $_ eq $f, @DXMsg::badmsg) {
1473 push @out, $dxchan->msg('m3', $f);
1480 # subject is the next line
1481 my $subject = shift @$ref;
1483 # strip off trailing lines
1484 pop @$ref while (@$ref && $$ref[-1] =~ /^\s*$/);
1486 # strip off /EX or /ABORT
1487 return ("aborted") if @$ref && $$ref[-1] =~ m{^/ABORT$}i;
1488 pop @$ref if (@$ref && $$ref[-1] =~ m{^/EX$}i);
1490 # sort out any splitting that needs to be done
1496 if ($lth >= $maxchunk || ($lth > $minchunk && /^\s*$/)) {
1497 push @chunk, $lines;
1504 push @chunk, $lines if @$lines;
1509 # does an identical message already exist?
1512 if (substr($subject,0,28) eq substr($m->{subject},0,28) && $from eq $m->{from} && grep $m->{to} eq $_, @to) {
1513 my $msgno = $m->{msgno};
1514 dbg("duplicate message from $from -> $m->{to} to msg: $msgno") if isdbg('msg');
1515 Log('msg', "duplicate message from $from -> $m->{to} to msg: $msgno");
1520 # write all the messages away
1522 for ( $i = 0; $i < @chunk; $i++) {
1523 my $chunk = $chunk[$i];
1526 my $num = " [" . ($i+1) . "/" . scalar @chunk . "]";
1527 $ch_subject = substr($subject, 0, 27 - length $num) . $num;
1529 $ch_subject = $subject;
1533 my $systime = $main::systime;
1534 my $mycall = $main::mycall;
1535 my $mref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
1544 $mref->swop_it($main::mycall);
1545 $mref->store($chunk);
1547 push @out, $dxchan->msg('m11', $mref->{msgno}, $to);
1548 #push @out, "msgno $ref->{msgno} sent to $to";
1559 my $name = $AUTOLOAD;
1560 return if $name =~ /::DESTROY$/;
1561 $name =~ s/^.*:://o;
1563 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
1564 # this clever line of code creates a subroutine which takes over from autoload
1565 # from OO Perl - Conway
1566 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};