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 my ($self, $line) = @_;
143 # this is periodic processing
144 if (!$self || !$line) {
146 if ($main::systime >= $lastq + $queueinterval) {
148 # queue some message if the interval timer has gone off
151 # import any messages in the import directory
154 $lastq = $main::systime;
157 # clean the message queue
158 clean_old() if $main::systime - $last_clean > 3600 ;
160 # actual remove all the 'deleted' messages in one hit.
161 # this has to be delayed until here otherwise it only does one at
162 # a time because @msg is rewritten everytime del_msg is called.
163 my @del = grep {!$_->{tonode} && $_->{delete} && !$_->{keep} && $_->{deletetime} < $main::systime} @msg;
168 $last_clean = $main::systime;
172 my @f = split /\^/, $line;
173 my ($pcno) = $f[0] =~ /^PC(\d\d)/; # just get the number
174 my ($tonode, $fromnode) = @f[1, 2];
175 my $stream = $f[3] if ($pcno >= 29 && $pcno <= 33) || $pcno == 42;
178 if ($pcno == 28) { # incoming message
180 # sort out various extant protocol errors that occur
182 $origin = $self->call unless $origin && $origin gt ' ';
184 # first look for any messages in the busy queue
185 # and cancel them this should both resolve timed out incoming messages
186 # and crossing of message between nodes, incoming messages have priority
188 my $ref = get_busy($fromnode);
190 my $otonode = $ref->{tonode} || "unknown";
191 dbg("Busy, stopping msgno: $ref->{msgno} $fromnode->$otonode") if isdbg('msg');
192 $ref->stop_msg($fromnode);
195 my $t = cltounix($f[5], $f[6]);
196 $stream = next_transno($fromnode);
197 $ref = DXMsg->alloc($stream, uc $f[3], $f[4], $t, $f[7], $f[8], $origin, '0', $f[11]);
199 # fill in various forwarding state variables
200 $ref->{fromnode} = $fromnode;
201 $ref->{tonode} = $tonode;
202 $ref->{rrreq} = $f[11];
203 $ref->{linesreq} = $f[10];
204 $ref->{stream} = $stream;
205 $ref->{count} = 0; # no of lines between PC31s
206 dbg("new message from $f[4] to $f[3] '$f[8]' stream $fromnode/$stream\n") if isdbg('msg');
207 Log('msg', "Incoming message $f[4] to $f[3] '$f[8]' origin: $origin" );
208 set_fwq($fromnode, $stream, $ref); # store in work
209 set_busy($fromnode, $ref); # set interlock
210 $self->send(DXProt::pc30($fromnode, $tonode, $stream)); # send ack
211 $ref->{lastt} = $main::systime;
213 # look to see whether this is a non private message sent to a known callsign
214 my $uref = DXUser->get_current($ref->{to});
215 if (is_callsign($ref->{to}) && !$ref->{private} && $uref && $uref->homenode) {
217 dbg("set bull to $ref->{to} to private") if isdbg('msg');
218 Log('msg', "set bull to $ref->{to} to private");
223 if ($pcno == 29) { # incoming text
224 my $ref = get_fwq($fromnode, $stream);
227 if (@{$ref->{lines}}) {
228 push @{$ref->{lines}}, $f[4];
230 # temporarily store any R: lines so that we end up with
231 # only the first and last ones stored.
232 if ($f[4] =~ m|^R:\d{6}/\d{4}|) {
233 push @{$ref->{tempr}}, $f[4];
235 if (exists $ref->{tempr}) {
236 push @{$ref->{lines}}, shift @{$ref->{tempr}};
237 push @{$ref->{lines}}, pop @{$ref->{tempr}} if @{$ref->{tempr}};
238 delete $ref->{tempr};
240 push @{$ref->{lines}}, $f[4];
244 if ($ref->{count} >= $ref->{linesreq}) {
245 $self->send(DXProt::pc31($fromnode, $tonode, $stream));
246 dbg("stream $stream: $ref->{count} lines received\n") if isdbg('msg');
249 $ref->{lastt} = $main::systime;
251 dbg("PC29 from unknown stream $stream from $fromnode") if isdbg('msg');
252 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
257 if ($pcno == 30) { # this is a incoming subject ack
258 my $ref = get_fwq($fromnode); # note no stream at this stage
261 $ref->{stream} = $stream;
263 $ref->{linesreq} = 5;
264 set_fwq($fromnode, $stream, $ref); # new ref
265 set_busy($fromnode, $ref); # interlock
266 dbg("incoming subject ack stream $stream\n") if isdbg('msg');
267 $ref->{lines} = [ $ref->read_msg_body ];
268 $ref->send_tranche($self);
269 $ref->{lastt} = $main::systime;
271 dbg("PC30 from unknown stream $stream from $fromnode") if isdbg('msg');
272 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
277 if ($pcno == 31) { # acknowledge a tranche of lines
278 my $ref = get_fwq($fromnode, $stream);
280 dbg("tranche ack stream $stream\n") if isdbg('msg');
281 $ref->send_tranche($self);
282 $ref->{lastt} = $main::systime;
284 dbg("PC31 from unknown stream $stream from $fromnode") if isdbg('msg');
285 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
290 if ($pcno == 32) { # incoming EOM
291 dbg("stream $stream: EOM received\n") if isdbg('msg');
292 my $ref = get_fwq($fromnode, $stream);
294 $self->send(DXProt::pc33($fromnode, $tonode, $stream)); # acknowledge it
296 # get the next msg no - note that this has NOTHING to do with the stream number in PC protocol
297 # store the file or message
298 # remove extraneous rubbish from the hash
299 # remove it from the work in progress vector
300 # stuff it on the msg queue
303 $ref->store($ref->{lines});
306 # does an identical message already exist?
309 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}) {
310 $ref->stop_msg($fromnode);
311 my $msgno = $m->{msgno};
312 dbg("duplicate message from $ref->{from} -> $ref->{to} to msg: $msgno") if isdbg('msg');
313 Log('msg', "duplicate message from $ref->{from} -> $ref->{to} to msg: $msgno");
319 $ref->swop_it($self->call);
321 # look for 'bad' to addresses
322 if ($ref->dump_it($self->call)) {
323 $ref->stop_msg($fromnode);
324 dbg("'Bad' message $ref->{to}") if isdbg('msg');
325 Log('msg', "'Bad' message $ref->{to}");
329 # check the message for bad words
331 for (@{$ref->{lines}}) {
332 push @words, BadWords::check($_);
334 push @words, BadWords::check($ref->{subject});
336 dbg("$ref->{from} swore: '@words' -> $ref->{to} '$ref->{subject}' origin: $ref->{origin} via " . $self->call) if isdbg('msg');
337 Log('msg',"$ref->{from} swore: '@words' -> $ref->{to} origin: $ref->{origin} via " . $self->call);
338 Log('msg',"subject: $ref->{subject}");
339 for (@{$ref->{lines}}) {
340 Log('msg', "line: $_");
342 $ref->stop_msg($fromnode);
346 $ref->{msgno} = next_transno("Msgno");
347 push @{$ref->{gotit}}, $fromnode; # mark this up as being received
348 $ref->store($ref->{lines});
351 Log('msg', "Message $ref->{msgno} from $ref->{from} received from $fromnode for $ref->{to}");
354 $ref->stop_msg($fromnode);
356 dbg("PC32 from unknown stream $stream from $fromnode") if isdbg('msg');
357 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
363 if ($pcno == 33) { # acknowledge the end of message
364 my $ref = get_fwq($fromnode, $stream);
366 if ($ref->{private}) { # remove it if it private and gone off site#
367 Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $fromnode and deleted");
370 Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $fromnode");
371 push @{$ref->{gotit}}, $fromnode; # mark this up as being received
372 $ref->store($ref->{lines}); # re- store the file
374 $ref->stop_msg($fromnode);
376 dbg("PC33 from unknown stream $stream from $fromnode") if isdbg('msg');
377 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
380 # send next one if present
385 if ($pcno == 40) { # this is a file request
386 $f[3] =~ s/\\/\//og; # change the slashes
387 $f[3] =~ s/\.//og; # remove dots
388 $f[3] =~ s/^\///o; # remove the leading /
389 $f[3] = lc $f[3]; # to lower case;
390 dbg("incoming file $f[3]\n") if isdbg('msg');
391 $f[3] = 'packclus/' . $f[3] unless $f[3] =~ /^packclus\//o;
393 # create any directories
394 my @part = split /\//, $f[3];
396 my $fn = "$main::root";
397 pop @part; # remove last part
398 foreach $part (@part) {
401 last SWITCH if !mkdir $fn, 0777;
402 dbg("created directory $fn\n") if isdbg('msg');
404 my $stream = next_transno($fromnode);
405 my $ref = DXMsg->alloc($stream, "$main::root/$f[3]", $self->call, time, !$f[4], $f[3], ' ', '0', '0');
407 # forwarding variables
408 $ref->{fromnode} = $tonode;
409 $ref->{tonode} = $fromnode;
410 $ref->{linesreq} = $f[5];
411 $ref->{stream} = $stream;
412 $ref->{count} = 0; # no of lines between PC31s
414 $ref->{lastt} = $main::systime;
415 set_fwq($fromnode, $stream, $ref); # store in work
416 $self->send(DXProt::pc30($fromnode, $tonode, $stream)); # send ack
421 if ($pcno == 42) { # abort transfer
422 dbg("stream $stream: abort received\n") if isdbg('msg');
423 my $ref = get_fwq($fromnode, $stream);
425 $ref->stop_msg($fromnode);
431 if ($pcno == 49) { # global delete on subject
433 if ($_->{from} eq $f[1] && $_->{subject} eq $f[2]) {
435 Log('msg', "Message $_->{msgno} from $_->{from} ($_->{subject}) fully deleted");
436 DXChannel::broadcast_nodes($line, $self);
448 my $uref = DXUser->get_current($to);
449 my $dxchan = DXChannel->get($to);
450 if (((*Net::SMTP && $email_server) || $email_prog) && $uref && $uref->wantemail) {
451 my $email = $uref->email;
453 my @rcpt = ref $email ? @{$email} : $email;
454 my $fromaddr = $email_from || $main::myemail;
455 my @headers = ("To: $ref->{to}",
457 "Subject: [DXSpider: $ref->{from}] $ref->{subject}",
458 "X-DXSpider-To: $ref->{to}",
459 "X-DXSpider-From: $ref->{from}\@$ref->{origin}",
460 "X-DXSpider-Gateway: $main::mycall"
462 my @data = ("Msgno: $ref->{msgno} To: $to From: $ref->{from}\@$ref->{origin} Gateway: $main::mycall",
468 if (*Net::SMTP && $email_server) {
469 $msg = Net::SMTP->new($email_server);
471 $msg->mail($fromaddr);
473 $msg->data(map {"$_\n"} @headers, '', @data);
476 } elsif ($email_prog) {
477 $msg = new IO::File "|$email_prog " . join(' ', @rcpt);
479 print $msg map {"$_\r\n"} @headers, '', @data, '.';
483 dbg("email forwarding error $!") if isdbg('msg') && !$msg && defined $!;
486 $dxchan->send($dxchan->msg('m9')) if $dxchan && $dxchan->is_user;
489 # store a message away on disc or whatever
491 # NOTE the second arg is a REFERENCE not a list
497 if ($ref->{file}) { # a file
498 dbg("To be stored in $ref->{to}\n") if isdbg('msg');
500 my $fh = new IO::File "$ref->{to}", "w";
503 foreach $line (@{$lines}) {
507 dbg("file $ref->{to} stored\n") if isdbg('msg');
508 Log('msg', "file $ref->{to} from $ref->{from} stored" );
510 confess "can't open file $ref->{to} $!";
512 } else { # a normal message
514 # attempt to open the message file
515 my $fn = filename($ref->{msgno});
517 dbg("To be stored in $fn\n") if isdbg('msg');
519 # now save the file, overwriting what's there, YES I KNOW OK! (I will change it if it's a problem)
520 my $fh = new IO::File "$fn", "w";
522 my $rr = $ref->{rrreq} ? '1' : '0';
523 my $priv = $ref->{private} ? '1': '0';
524 my $del = $ref->{delete} ? '1' : '0';
525 my $delt = $ref->{deletetime} || ($ref->{t} + $maxage);
526 my $keep = $ref->{keep} || '0';
527 print $fh "=== $ref->{msgno}^$ref->{to}^$ref->{from}^$ref->{t}^$priv^$ref->{subject}^$ref->{origin}^$ref->{'read'}^$rr^$del^$delt^$keep\n";
528 print $fh "=== ", join('^', @{$ref->{gotit}}), "\n";
531 foreach $line (@{$lines}) {
532 $line =~ s/[\x00-\x08\x0a-\x1f\x80-\x9f]/./g;
533 $ref->{size} += (length $line) + 1;
537 dbg("msg $ref->{msgno} stored\n") if isdbg('msg');
538 Log('msg', "msg $ref->{msgno} from $ref->{from} to $ref->{to} stored" );
540 confess "can't open msg file $fn $!";
552 $call = ' by ' . $dxchan->call if $dxchan;
554 if ($self->{tonode}) {
556 $self->{deletetime} = 0;
557 dbg("Msgno $self->{msgno} but marked as expunged$call") if isdbg('msg');
559 # remove it from the active message list
560 @msg = grep { $_ != $self } @msg;
562 Log('msg', "Msgno $self->{msgno} expunged$call");
563 dbg("Msgno $self->{msgno} expunged$call") if isdbg('msg');
566 unlink filename($self->{msgno});
575 return if $ref->{keep};
577 $t = $main::systime + $residencetime unless defined $t;
580 $ref->{deletetime} = $t;
581 $ref->store( [$ref->read_msg_body] );
589 $ref->{deletetime} = 0;
592 # clean out old messages from the message queue
597 # mark old messages for deletion
598 foreach $ref (@msg) {
599 if (ref($ref) && !$ref->{keep} && $ref->{deletetime} < $main::systime) {
601 # this is for IMMEDIATE destruction
603 $ref->{deletetime} = 0;
608 # read in a message header
618 $file = new IO::File "$fn";
620 dbg("Error reading $fn $!");
621 Log('err', "Error reading $fn $!");
625 $line = <$file>; # first line
626 if ($size == 0 || !$line) {
628 Log('err', "Empty $fn $!");
632 $size -= length $line;
633 if (! $line =~ /^===/o) {
634 dbg("corrupt first line in $fn ($line)");
635 Log('err', "corrupt first line in $fn ($line)");
639 @f = split /\^/, $line;
640 $ref = DXMsg->alloc(@f);
642 $line = <$file>; # second line
644 $size -= length $line;
645 if (! $line =~ /^===/o) {
646 dbg("corrupt second line in $fn ($line)");
647 Log('err', "corrupt second line in $fn ($line)");
652 @f = split /\^/, $line;
653 push @{$ref->{gotit}}, @f;
654 $ref->{size} = $size;
661 # read in a message header
665 my $msgno = $self->{msgno};
668 my $fn = filename($msgno);
671 $file = new IO::File;
672 if (!open($file, $fn)) {
673 dbg("Error reading $fn $!");
674 Log('err' ,"Error reading $fn $!");
677 @out = map {chomp; $_} <$file>;
680 shift @out if $out[0] =~ /^=== /;
681 shift @out if $out[0] =~ /^=== /;
685 # send a tranche of lines to the other end
688 my ($self, $dxchan) = @_;
690 my $to = $self->{tonode};
691 my $from = $self->{fromnode};
692 my $stream = $self->{stream};
693 my $lines = $self->{lines};
696 for ($i = 0, $c = $self->{count}; $i < $self->{linesreq} && $c < @$lines; $i++, $c++) {
697 push @out, DXProt::pc29($to, $from, $stream, $lines->[$c]);
701 push @out, DXProt::pc32($to, $from, $stream) if $i < $self->{linesreq};
706 # find a message to send out and start the ball rolling
713 # bat down the message list looking for one that needs to go off site and whose
714 # nearest node is not busy.
716 dbg("queue msg ($sort)\n") if isdbg('msg');
717 my @nodelist = DXChannel::get_all_nodes;
718 foreach $ref (@msg) {
720 # ignore 'delayed' messages until their waiting time has expired
721 if (exists $ref->{waitt}) {
722 next if $ref->{waitt} > $main::systime;
723 delete $ref->{waitt};
727 if (exists $ref->{lastt} && $main::systime >= $ref->{lastt} + $timeout) {
728 my $node = $ref->{tonode};
729 dbg("Timeout, stopping msgno: $ref->{msgno} -> $node") if isdbg('msg');
730 Log('msg', "Timeout, stopping msgno: $ref->{msgno} -> $node");
731 $ref->stop_msg($node);
733 # delay any outgoing messages that fail
734 $ref->{waitt} = $main::systime + $waittime + int rand(120) if $node ne $main::mycall;
735 delete $ref->{lastt};
739 # is it being sent anywhere currently?
740 next if $ref->{tonode}; # ignore it if it already being processed
742 # is it awaiting deletion?
743 next if $ref->{delete};
745 # firstly, is it private and unread? if so can I find the recipient
746 # in my cluster node list offsite?
748 # deal with routed private messages
750 if ($ref->{private}) {
751 next if $ref->{'read'}; # if it is read, it is stuck here
752 $clref = Route::get($ref->{to});
754 $dxchan = $clref->dxchan;
756 if ($dxchan->is_node) {
757 next if $clref->call eq $main::mycall; # i.e. it lives here
758 $ref->start_msg($dxchan) if !get_busy($dxchan->call) && $dxchan->state eq 'normal';
761 dbg("Route: No dxchan for $ref->{to} " . ref($clref) ) if isdbg('msg');
766 # otherwise we are dealing with a bulletin or forwarded private message
767 # compare the gotit list with
768 # the nodelist up above, if there are sites that haven't got it yet
769 # then start sending it - what happens when we get loops is anyone's
770 # guess, use (to, from, time, subject) tuple?
771 foreach $dxchan (@nodelist) {
772 my $call = $dxchan->call;
774 next if $call eq $main::mycall;
775 next if ref $ref->{gotit} && grep $_ eq $call, @{$ref->{gotit}};
776 next unless $ref->forward_it($call); # check the forwarding file
777 next if $ref->{tonode}; # ignore it if it already being processed
779 # if we are here we have a node that doesn't have this message
780 if (!get_busy($call) && $dxchan->state eq 'normal') {
781 $ref->start_msg($dxchan);
787 # if all the available nodes are busy then stop
788 last if @nodelist == scalar grep { get_busy($_->call) } @nodelist;
794 # is there a message for me?
801 foreach $ref (@msg) {
802 # is it for me, private and unread?
803 if ($ref->{to} eq $call && $ref->{private}) {
804 $count++ unless $ref->{'read'} || $ref->{delete};
810 # start the message off on its travels with a PC28
813 my ($self, $dxchan) = @_;
815 confess("trying to start started msg $self->{msgno} nodes: $self->{fromnode} -> $self->{tonode}") if $self->{tonode};
816 dbg("start msg $self->{msgno}\n") if isdbg('msg');
817 $self->{linesreq} = 10;
819 $self->{tonode} = $dxchan->call;
820 $self->{fromnode} = $main::mycall;
821 set_busy($self->{tonode}, $self);
822 set_fwq($self->{tonode}, undef, $self);
823 $self->{lastt} = $main::systime;
824 my ($fromnode, $origin);
825 $fromnode = $self->{fromnode};
826 $origin = $self->{origin};
827 $dxchan->send(DXProt::pc28($self->{tonode}, $fromnode, $self->{to}, $self->{from}, $self->{t}, $self->{private}, $self->{subject}, $origin, $self->{rrreq}));
830 # get the ref of a busy node
840 return $busy{$call} = shift;
846 return delete $busy{$call};
849 # get the whole busy queue
855 # get a forwarding queue entry
859 my $stream = shift || '0';
860 return $work{"$call,$stream"};
863 # delete a forwarding queue entry
867 my $stream = shift || '0';
868 return delete $work{"$call,$stream"};
875 my $stream = shift || '0';
876 return $work{"$call,$stream"} = shift;
879 # get the whole forwarding queue
885 # stop a message from continuing, clean it out, unlock interlocks etc
890 my $stream = $self->{stream};
893 dbg("stop msg $self->{msgno} -> node $node\n") if isdbg('msg');
894 del_fwq($node, $stream);
902 delete $ref->{lines};
903 delete $ref->{linesreq};
904 delete $ref->{tonode};
905 delete $ref->{fromnode};
906 delete $ref->{stream};
908 delete $ref->{count};
909 delete $ref->{tempr};
910 delete $ref->{lastt};
911 delete $ref->{waitt};
914 # get a new transaction number from the file specified
918 $name =~ s/\W//og; # remove non-word characters
919 my $fn = "$msgdir/$name";
922 my $fh = new IO::File;
923 if (sysopen($fh, $fn, O_RDWR|O_CREAT, 0666)) {
925 $msgno = $fh->getline || '0';
929 $fh->print("$msgno\n");
930 dbg("msgno $msgno allocated for $name\n") if isdbg('msg');
933 confess "can't open $fn $!";
938 # initialise the message 'system', read in all the message headers
941 my $dir = new IO::File;
945 # load various control files
946 dbg("load badmsg: " . (load_badmsg() or "Ok"));
947 dbg("load forward: " . (load_forward() or "Ok"));
948 dbg("load swop: " . (load_swop() or "Ok"));
950 # read in the directory
951 opendir($dir, $msgdir) or confess "can't open $msgdir $!";
952 @dir = readdir($dir);
957 next unless /^m\d\d\d\d\d\d$/;
959 $ref = read_msg_header("$msgdir/$_");
962 Log('err', "Deleting $_");
967 # delete any messages to 'badmsg.pl' places
968 if ($ref->dump_it('')) {
969 dbg("'Bad' TO address $ref->{to}") if isdbg('msg');
970 Log('msg', "'Bad' TO address $ref->{to}");
975 # add the message to the available queue
980 # add the message to the directory listing
984 confess "tried to add a non-ref to the msg directory" if !ref $ref;
988 # return all the current messages
994 # get a particular message
999 return $_ if $_->{msgno} == $msgno;
1000 last if $_->{msgno} > $msgno;
1005 # return the official filename for a message no
1008 return sprintf "$msgdir/m%06d", shift;
1012 # return a list of valid elements
1017 return keys(%valid);
1021 # return a prompt for a field
1026 my ($self, $ele) = @_;
1027 return $valid{$ele};
1031 # send a message state machine
1038 if ($self->state eq 'send1') {
1040 confess "local var gone missing" if !ref $self->{loc};
1041 my $loc = $self->{loc};
1042 if (my @ans = BadWords::check($line)) {
1043 $self->{badcount} += @ans;
1044 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} in msg");
1047 $loc->{subject} = $line;
1049 $self->state('sendbody');
1050 #push @out, $self->msg('sendbody');
1051 push @out, $self->msg('m8');
1052 } elsif ($self->state eq 'sendbody') {
1053 confess "local var gone missing" if !ref $self->{loc};
1054 my $loc = $self->{loc};
1055 if ($line eq "\032" || $line eq '%1A' || uc $line eq "/EX") {
1057 unless ($loc->{reject}) {
1058 foreach $to (@{$loc->{to}}) {
1060 my $systime = $main::systime;
1061 my $mycall = $main::mycall;
1062 $ref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
1064 exists $loc->{from} ? $loc->{from} : $self->call,
1068 exists $loc->{origin} ? $loc->{origin} : $mycall,
1071 $ref->swop_it($self->call);
1072 $ref->store($loc->{lines});
1074 push @out, $self->msg('m11', $ref->{msgno}, $to);
1075 #push @out, "msgno $ref->{msgno} sent to $to";
1079 Log('msg', $self->call . " swore to @{$loc->{to}} subject: '$loc->{subject}' in msg, REJECTED");
1082 delete $loc->{lines};
1084 delete $self->{loc};
1087 $self->state('prompt');
1088 } elsif ($line eq "\031" || uc $line eq "/ABORT" || uc $line eq "/QUIT") {
1089 #push @out, $self->msg('sendabort');
1090 push @out, $self->msg('m10');
1091 delete $loc->{lines};
1093 delete $self->{loc};
1095 $self->state('prompt');
1096 } elsif ($line =~ m|^/+\w+|) {
1097 # this is a command that you want display for your own reference
1098 # or if it has TWO slashes is a command
1100 my $store = $line =~ s|^/+||;
1101 my @in = $self->run_cmd($line);
1104 foreach my $l (@in) {
1105 if (my @ans = BadWords::check($l)) {
1106 $self->{badcount} += @ans;
1107 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} subject: '$loc->{subject}' in msg") unless $loc->{reject};
1108 Log('msg', "line: $l");
1111 push @{$loc->{lines}}, length($l) > 0 ? $l : " ";
1115 if (my @ans = BadWords::check($line)) {
1116 $self->{badcount} += @ans;
1117 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} subject: '$loc->{subject}' in msg") unless $loc->{reject};
1118 Log('msg', "line: $line");
1122 if ($loc->{lines} && @{$loc->{lines}}) {
1123 push @{$loc->{lines}}, length($line) > 0 ? $line : " ";
1125 # temporarily store any R: lines so that we end up with
1126 # only the first and last ones stored.
1127 if ($line =~ m|^R:\d{6}/\d{4}|) {
1128 push @{$loc->{tempr}}, $line;
1130 if (exists $loc->{tempr}) {
1131 push @{$loc->{lines}}, shift @{$loc->{tempr}};
1132 push @{$loc->{lines}}, pop @{$loc->{tempr}} if @{$loc->{tempr}};
1133 delete $loc->{tempr};
1135 push @{$loc->{lines}}, length($line) > 0 ? $line : " ";
1139 # i.e. it ain't and end or abort, therefore store the line
1145 # return the standard directory line for this ref
1149 my $flag = $ref->{private} && $ref->{read} ? '-' : ' ';
1152 } elsif ($ref->{delete}) {
1153 $flag = $ref->{deletetime} > $main::systime ? 'D' : 'E';
1155 return sprintf("%6d%s%s%5d %8.8s %8.8s %-6.6s %5.5s %-30.30s",
1156 $ref->{msgno}, $flag, $ref->{private} ? 'p' : ' ',
1157 $ref->{size}, $ref->{to}, $ref->{from}, cldate($ref->{t}),
1158 ztime($ref->{t}), $ref->{subject});
1161 # load the forward table
1165 my $s = readfilestr($forwardfn);
1168 push @out, $@ if $@;
1173 # load the bad message table
1177 my $s = readfilestr($badmsgfn);
1180 push @out, $@ if $@;
1185 # load the swop message table
1189 my $s = readfilestr($swopfn);
1192 push @out, $@ if $@;
1198 # forward that message or not according to the forwarding table
1199 # returns 1 for forward, 0 - to ignore
1208 for ($i = 0; $i < @forward; $i += 5) {
1209 my ($sort, $field, $pattern, $action, $bbs) = @forward[$i..($i+4)];
1212 # are we interested?
1213 next if $ref->{private} && $sort ne 'P';
1214 next if !$ref->{private} && $sort ne 'B';
1217 $tested = $ref->{to} if $field eq 'T';
1218 $tested = $ref->{from} if $field eq 'F';
1219 $tested = $ref->{origin} if $field eq 'O';
1220 $tested = $ref->{subject} if $field eq 'S';
1222 if (!$pattern || $tested =~ m{$pattern}i) {
1223 return 0 if $action eq 'I';
1224 return 1 if !$bbs || grep $_ eq $call, @{$bbs};
1231 # look down the forward table to see whether this is a valid bull
1232 # or not (ie it will forward somewhere even if it is only here)
1240 return 1 if $call =~ /^ALL/;
1241 return 1 if $call =~ /^DX/;
1245 for ($i = 0; $i < @forward; $i += 5) {
1246 my ($sort, $field, $pattern, $action, $bbs) = @forward[$i..($i+4)];
1247 if ($field eq 'T') {
1248 if (!$pattern || $call =~ m{$pattern}i) {
1262 for ($i = 0; $i < @badmsg; $i += 3) {
1263 my ($sort, $field, $pattern) = @badmsg[$i..($i+2)];
1266 # are we interested?
1267 next if $ref->{private} && $sort ne 'P';
1268 next if !$ref->{private} && $sort ne 'B';
1271 $tested = $ref->{to} if $field eq 'T';
1272 $tested = $ref->{from} if $field eq 'F';
1273 $tested = $ref->{origin} if $field eq 'O';
1274 $tested = $ref->{subject} if $field eq 'S';
1275 $tested = $call if $field eq 'I';
1277 if (!$pattern || $tested =~ m{$pattern}i) {
1291 for ($i = 0; $i < @swop; $i += 5) {
1292 my ($sort, $field, $pattern, $tfield, $topattern) = @swop[$i..($i+4)];
1297 # are we interested?
1298 next if $ref->{private} && $sort ne 'P';
1299 next if !$ref->{private} && $sort ne 'B';
1302 $tested = $ref->{to} if $field eq 'T';
1303 $tested = $ref->{from} if $field eq 'F';
1304 $tested = $ref->{origin} if $field eq 'O';
1305 $tested = $ref->{subject} if $field eq 'S';
1308 $old = $swop = $ref->{to} if $tfield eq 'T';
1309 $old = $swop = $ref->{from} if $tfield eq 'F';
1310 $old = $swop = $ref->{origin} if $tfield eq 'O';
1311 $old = $swop = $ref->{subject} if $tfield eq 'S';
1313 if ($tested =~ m{$pattern}i) {
1314 if ($tested eq $swop) {
1315 $swop =~ s{$pattern}{$topattern}i;
1319 Log('msg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1320 Log('dbg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1321 $ref->{to} = $swop if $tfield eq 'T';
1322 $ref->{from} = $swop if $tfield eq 'F';
1323 $ref->{origin} = $swop if $tfield eq 'O';
1324 $ref->{subject} = $swop if $tfield eq 'S';
1331 # import any msgs in the import directory
1332 # the messages are in BBS format (but may have cluster extentions
1333 # so SB UK < GB7TLH is legal
1336 # are there any to do in this directory?
1337 return unless -d $importfn;
1338 unless (opendir(DIR, $importfn)) {
1339 dbg("can\'t open $importfn $!") if isdbg('msg');
1340 Log('msg', "can\'t open $importfn $!");
1344 my @names = readdir(DIR);
1347 foreach $name (@names) {
1348 next if $name =~ /^\./;
1349 my $splitit = $name =~ /^split/;
1350 my $fn = "$importfn/$name";
1352 unless (open(MSG, $fn)) {
1353 dbg("can\'t open import file $fn $!") if isdbg('msg');
1354 Log('msg', "can\'t open import file $fn $!");
1358 my @msg = map { chomp; $_ } <MSG>;
1361 my @out = import_one($main::me, \@msg, $splitit);
1366 # import one message as a list in bbs (as extended) mode
1367 # takes a reference to an array containing the whole message
1372 my $splitit = shift;
1376 my $from = $dxchan->call;
1377 my $origin = $main::mycall;
1382 my $line = shift @$ref;
1383 my @f = split /([\s\@\$])/, $line;
1384 @f = map {s/\s+//g; length $_ ? $_ : ()} @f;
1386 unless (@f && $f[0] =~ /^(:?S|SP|SB|SEND)$/ ) {
1387 my $m = "invalid first line in import '$line'";
1388 dbg($m) if isdbg('msg');
1392 my $f = uc shift @f;
1393 next if $f eq 'SEND';
1395 # private / noprivate / rr
1396 if ($notincalls && ($f eq 'B' || $f eq 'SB' || $f =~ /^NOP/oi)) {
1398 } elsif ($notincalls && ($f eq 'P' || $f eq 'SP' || $f =~ /^PRI/oi)) {
1400 } elsif ($notincalls && ($f eq 'RR')) {
1402 } elsif (($f =~ /^[\@\.\#\$]$/ || $f eq '.#') && @f) { # this is bbs syntax, for AT
1404 } elsif ($f eq '<' && @f) { # this is bbs syntax for from call
1405 $from = uc shift @f;
1406 } elsif ($f =~ /^\$/) { # this is bbs syntax for a bid
1408 } elsif ($f =~ /^<(\S+)/) { # this is bbs syntax for from call
1410 } elsif ($f =~ /^\$\S+/) { # this is bbs syntax for bid
1417 # is this callsign a distro?
1418 my $fn = "$msgdir/distro/$f.pl";
1420 my $fh = new IO::File $fn;
1427 return (1, "Error in Distro $f.pl:", $@) if $@;
1435 if (grep $_ eq $f, @DXMsg::badmsg) {
1436 push @out, $dxchan->msg('m3', $f);
1443 # subject is the next line
1444 my $subject = shift @$ref;
1446 # strip off trailing lines
1447 pop @$ref while (@$ref && $$ref[-1] =~ /^\s*$/);
1449 # strip off /EX or /ABORT
1450 return ("aborted") if @$ref && $$ref[-1] =~ m{^/ABORT$}i;
1451 pop @$ref if (@$ref && $$ref[-1] =~ m{^/EX$}i);
1453 # sort out any splitting that needs to be done
1459 if ($lth >= $maxchunk || ($lth > $minchunk && /^\s*$/)) {
1460 push @chunk, $lines;
1467 push @chunk, $lines if @$lines;
1472 # does an identical message already exist?
1475 if (substr($subject,0,28) eq substr($m->{subject},0,28) && $from eq $m->{from} && grep $m->{to} eq $_, @to) {
1476 my $msgno = $m->{msgno};
1477 dbg("duplicate message from $from -> $m->{to} to msg: $msgno") if isdbg('msg');
1478 Log('msg', "duplicate message from $from -> $m->{to} to msg: $msgno");
1483 # write all the messages away
1485 for ( $i = 0; $i < @chunk; $i++) {
1486 my $chunk = $chunk[$i];
1489 my $num = " [" . ($i+1) . "/" . scalar @chunk . "]";
1490 $ch_subject = substr($subject, 0, 27 - length $num) . $num;
1492 $ch_subject = $subject;
1496 my $systime = $main::systime;
1497 my $mycall = $main::mycall;
1498 my $mref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
1507 $mref->swop_it($main::mycall);
1508 $mref->store($chunk);
1510 push @out, $dxchan->msg('m11', $mref->{msgno}, $to);
1511 #push @out, "msgno $ref->{msgno} sent to $to";
1522 my $name = $AUTOLOAD;
1523 return if $name =~ /::DESTROY$/;
1524 $name =~ s/^.*:://o;
1526 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
1527 # this clever line of code creates a subroutine which takes over from autoload
1528 # from OO Perl - Conway
1529 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};