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->{delete} ? 0 : ($self->{t} + $maxage);
130 # $self->{lastt} = $main::systime;
132 $self->{private} = 1 if $bulltopriv && DXUser->get_current($self->{to});
140 my ($self, $line) = @_;
142 # this is periodic processing
143 if (!$self || !$line) {
145 if ($main::systime >= $lastq + $queueinterval) {
147 # queue some message if the interval timer has gone off
150 # import any messages in the import directory
153 $lastq = $main::systime;
156 # clean the message queue
157 clean_old() if $main::systime - $last_clean > 3600 ;
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} && $_->{deletetime} < $main::systime} @msg;
167 $last_clean = $main::systime;
171 my @f = split /\^/, $line;
172 my ($pcno) = $f[0] =~ /^PC(\d\d)/; # just get the number
173 my ($tonode, $fromnode) = @f[1, 2];
174 my $stream = $f[3] if ($pcno >= 29 && $pcno <= 33) || $pcno == 42;
177 if ($pcno == 28) { # incoming message
179 # sort out various extant protocol errors that occur
181 $origin = $self->call unless $origin && $origin gt ' ';
183 # first look for any messages in the busy queue
184 # and cancel them this should both resolve timed out incoming messages
185 # and crossing of message between nodes, incoming messages have priority
187 my $ref = get_busy($fromnode);
189 my $otonode = $ref->{tonode} || "unknown";
190 dbg("Busy, stopping msgno: $ref->{msgno} $fromnode->$otonode") if isdbg('msg');
191 $ref->stop_msg($fromnode);
194 my $t = cltounix($f[5], $f[6]);
195 $stream = next_transno($fromnode);
196 $ref = DXMsg->alloc($stream, uc $f[3], $f[4], $t, $f[7], $f[8], $origin, '0', $f[11]);
198 # fill in various forwarding state variables
199 $ref->{fromnode} = $fromnode;
200 $ref->{tonode} = $tonode;
201 $ref->{rrreq} = $f[11];
202 $ref->{linesreq} = $f[10];
203 $ref->{stream} = $stream;
204 $ref->{count} = 0; # no of lines between PC31s
205 dbg("new message from $f[4] to $f[3] '$f[8]' stream $fromnode/$stream\n") if isdbg('msg');
206 Log('msg', "Incoming message $f[4] to $f[3] '$f[8]' origin: $origin" );
207 set_fwq($fromnode, $stream, $ref); # store in work
208 set_busy($fromnode, $ref); # set interlock
209 $self->send(DXProt::pc30($fromnode, $tonode, $stream)); # send ack
210 $ref->{lastt} = $main::systime;
212 # look to see whether this is a non private message sent to a known callsign
213 my $uref = DXUser->get_current($ref->{to});
214 if (is_callsign($ref->{to}) && !$ref->{private} && $uref && $uref->homenode) {
216 dbg("set bull to $ref->{to} to private") if isdbg('msg');
217 Log('msg', "set bull to $ref->{to} to private");
222 if ($pcno == 29) { # incoming text
223 my $ref = get_fwq($fromnode, $stream);
226 if (@{$ref->{lines}}) {
227 push @{$ref->{lines}}, $f[4];
229 # temporarily store any R: lines so that we end up with
230 # only the first and last ones stored.
231 if ($f[4] =~ m|^R:\d{6}/\d{4}|) {
232 push @{$ref->{tempr}}, $f[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}}, $f[4];
243 if ($ref->{count} >= $ref->{linesreq}) {
244 $self->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 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
256 if ($pcno == 30) { # this is a incoming subject ack
257 my $ref = get_fwq($fromnode); # note no stream at this stage
260 $ref->{stream} = $stream;
262 $ref->{linesreq} = 5;
263 set_fwq($fromnode, $stream, $ref); # new ref
264 set_busy($fromnode, $ref); # interlock
265 dbg("incoming subject ack stream $stream\n") if isdbg('msg');
266 $ref->{lines} = [ $ref->read_msg_body ];
267 $ref->send_tranche($self);
268 $ref->{lastt} = $main::systime;
270 dbg("PC30 from unknown stream $stream from $fromnode") if isdbg('msg');
271 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
276 if ($pcno == 31) { # acknowledge a tranche of lines
277 my $ref = get_fwq($fromnode, $stream);
279 dbg("tranche ack stream $stream\n") if isdbg('msg');
280 $ref->send_tranche($self);
281 $ref->{lastt} = $main::systime;
283 dbg("PC31 from unknown stream $stream from $fromnode") if isdbg('msg');
284 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
289 if ($pcno == 32) { # incoming EOM
290 dbg("stream $stream: EOM received\n") if isdbg('msg');
291 my $ref = get_fwq($fromnode, $stream);
293 $self->send(DXProt::pc33($fromnode, $tonode, $stream)); # acknowledge it
295 # get the next msg no - note that this has NOTHING to do with the stream number in PC protocol
296 # store the file or message
297 # remove extraneous rubbish from the hash
298 # remove it from the work in progress vector
299 # stuff it on the msg queue
302 $ref->store($ref->{lines});
305 # does an identical message already exist?
308 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}) {
309 $ref->stop_msg($fromnode);
310 my $msgno = $m->{msgno};
311 dbg("duplicate message from $ref->{from} -> $ref->{to} to msg: $msgno") if isdbg('msg');
312 Log('msg', "duplicate message from $ref->{from} -> $ref->{to} to msg: $msgno");
318 $ref->swop_it($self->call);
320 # look for 'bad' to addresses
321 if ($ref->dump_it($self->call)) {
322 $ref->stop_msg($fromnode);
323 dbg("'Bad' message $ref->{to}") if isdbg('msg');
324 Log('msg', "'Bad' message $ref->{to}");
328 # check the message for bad words
330 for (@{$ref->{lines}}) {
331 push @words, BadWords::check($_);
333 push @words, BadWords::check($ref->{subject});
335 dbg("$ref->{from} swore: '@words' -> $ref->{to} '$ref->{subject}' origin: $ref->{origin} via " . $self->call) if isdbg('msg');
336 Log('msg',"$ref->{from} swore: '@words' -> $ref->{to} origin: $ref->{origin} via " . $self->call);
337 Log('msg',"subject: $ref->{subject}");
338 for (@{$ref->{lines}}) {
339 Log('msg', "line: $_");
341 $ref->stop_msg($fromnode);
345 $ref->{msgno} = next_transno("Msgno");
346 push @{$ref->{gotit}}, $fromnode; # mark this up as being received
347 $ref->store($ref->{lines});
350 Log('msg', "Message $ref->{msgno} from $ref->{from} received from $fromnode for $ref->{to}");
353 $ref->stop_msg($fromnode);
355 dbg("PC32 from unknown stream $stream from $fromnode") if isdbg('msg');
356 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
362 if ($pcno == 33) { # acknowledge the end of message
363 my $ref = get_fwq($fromnode, $stream);
365 if ($ref->{private}) { # remove it if it private and gone off site#
366 Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $fromnode and deleted");
369 Log('msg', "Message $ref->{msgno} from $ref->{from} sent to $fromnode");
370 push @{$ref->{gotit}}, $fromnode; # mark this up as being received
371 $ref->store($ref->{lines}); # re- store the file
373 $ref->stop_msg($fromnode);
375 dbg("PC33 from unknown stream $stream from $fromnode") if isdbg('msg');
376 $self->send(DXProt::pc42($fromnode, $tonode, $stream)); # unknown stream
379 # send next one if present
384 if ($pcno == 40) { # this is a file request
385 $f[3] =~ s/\\/\//og; # change the slashes
386 $f[3] =~ s/\.//og; # remove dots
387 $f[3] =~ s/^\///o; # remove the leading /
388 $f[3] = lc $f[3]; # to lower case;
389 dbg("incoming file $f[3]\n") if isdbg('msg');
390 $f[3] = 'packclus/' . $f[3] unless $f[3] =~ /^packclus\//o;
392 # create any directories
393 my @part = split /\//, $f[3];
395 my $fn = "$main::root";
396 pop @part; # remove last part
397 foreach $part (@part) {
400 last SWITCH if !mkdir $fn, 0777;
401 dbg("created directory $fn\n") if isdbg('msg');
403 my $stream = next_transno($fromnode);
404 my $ref = DXMsg->alloc($stream, "$main::root/$f[3]", $self->call, time, !$f[4], $f[3], ' ', '0', '0');
406 # forwarding variables
407 $ref->{fromnode} = $tonode;
408 $ref->{tonode} = $fromnode;
409 $ref->{linesreq} = $f[5];
410 $ref->{stream} = $stream;
411 $ref->{count} = 0; # no of lines between PC31s
413 $ref->{lastt} = $main::systime;
414 set_fwq($fromnode, $stream, $ref); # store in work
415 $self->send(DXProt::pc30($fromnode, $tonode, $stream)); # send ack
420 if ($pcno == 42) { # abort transfer
421 dbg("stream $stream: abort received\n") if isdbg('msg');
422 my $ref = get_fwq($fromnode, $stream);
424 $ref->stop_msg($fromnode);
430 if ($pcno == 49) { # global delete on subject
432 if ($_->{from} eq $f[1] && $_->{subject} eq $f[2]) {
434 Log('msg', "Message $_->{msgno} from $_->{from} ($_->{subject}) fully deleted");
435 DXChannel::broadcast_nodes($line, $self);
447 my $uref = DXUser->get_current($to);
448 my $dxchan = DXChannel->get($to);
449 if (((*Net::SMTP && $email_server) || $email_prog) && $uref && $uref->wantemail) {
450 my $email = $uref->email;
452 my @rcpt = ref $email ? @{$email} : $email;
453 my $fromaddr = $email_from || $main::myemail;
454 my @headers = ("To: $ref->{to}",
456 "Subject: [DXSpider: $ref->{from}] $ref->{subject}",
457 "X-DXSpider-To: $ref->{to}",
458 "X-DXSpider-From: $ref->{from}\@$ref->{origin}",
459 "X-DXSpider-Gateway: $main::mycall"
461 my @data = ("Msgno: $ref->{msgno} To: $to From: $ref->{from}\@$ref->{origin} Gateway: $main::mycall",
467 if (*Net::SMTP && $email_server) {
468 $msg = Net::SMTP->new($email_server);
470 $msg->mail($fromaddr);
472 $msg->data(map {"$_\n"} @headers, '', @data);
475 } elsif ($email_prog) {
476 $msg = new IO::File "|$email_prog " . join(' ', @rcpt);
478 print $msg map {"$_\r\n"} @headers, '', @data, '.';
482 dbg("email forwarding error $!") if isdbg('msg') && !$msg && defined $!;
485 $dxchan->send($dxchan->msg('m9')) if $dxchan && $dxchan->is_user;
488 # store a message away on disc or whatever
490 # NOTE the second arg is a REFERENCE not a list
496 if ($ref->{file}) { # a file
497 dbg("To be stored in $ref->{to}\n") if isdbg('msg');
499 my $fh = new IO::File "$ref->{to}", "w";
502 foreach $line (@{$lines}) {
506 dbg("file $ref->{to} stored\n") if isdbg('msg');
507 Log('msg', "file $ref->{to} from $ref->{from} stored" );
509 confess "can't open file $ref->{to} $!";
511 } else { # a normal message
513 # attempt to open the message file
514 my $fn = filename($ref->{msgno});
516 dbg("To be stored in $fn\n") if isdbg('msg');
518 # now save the file, overwriting what's there, YES I KNOW OK! (I will change it if it's a problem)
519 my $fh = new IO::File "$fn", "w";
521 my $rr = $ref->{rrreq} ? '1' : '0';
522 my $priv = $ref->{private} ? '1': '0';
523 my $del = $ref->{delete} ? '1' : '0';
524 my $delt = $ref->{deletetime} || $ref->{t} + $maxage;
525 print $fh "=== $ref->{msgno}^$ref->{to}^$ref->{from}^$ref->{t}^$priv^$ref->{subject}^$ref->{origin}^$ref->{'read'}^$rr^$del^$delt\n";
526 print $fh "=== ", join('^', @{$ref->{gotit}}), "\n";
529 foreach $line (@{$lines}) {
530 $line =~ s/[\x00-\x08\x0a-\x1f\x80-\x9f]/./g;
531 $ref->{size} += (length $line) + 1;
535 dbg("msg $ref->{msgno} stored\n") if isdbg('msg');
536 Log('msg', "msg $ref->{msgno} from $ref->{from} to $ref->{to} stored" );
538 confess "can't open msg file $fn $!";
550 $call = ' by ' . $dxchan->call if $dxchan;
552 if ($self->{tonode}) {
554 $self->{deletetime} = 0;
555 dbg("Msgno $self->{msgno} but marked as expunged$call") if isdbg('msg');
557 # remove it from the active message list
558 @msg = grep { $_ != $self } @msg;
560 Log('msg', "Msgno $self->{msgno} expunged$call");
561 dbg("Msgno $self->{msgno} expunged$call") if isdbg('msg');
564 unlink filename($self->{msgno});
572 $t = $main::systime + $residencetime unless defined $t;
575 $ref->{deletetime} = $t;
576 $ref->store( [$ref->read_msg_body] );
583 delete $ref->{delete};
584 delete $ref->{deletetime};
587 # clean out old messages from the message queue
592 # mark old messages for deletion
593 foreach $ref (@msg) {
594 if (ref($ref) && !$ref->{keep} && $ref->{deletetime} < $main::systime) {
596 # this is for IMMEDIATE destruction
598 $ref->{deletetime} = 0;
603 # read in a message header
613 $file = new IO::File "$fn";
615 dbg("Error reading $fn $!");
616 Log('err', "Error reading $fn $!");
620 $line = <$file>; # first line
621 if ($size == 0 || !$line) {
623 Log('err', "Empty $fn $!");
627 $size -= length $line;
628 if (! $line =~ /^===/o) {
629 dbg("corrupt first line in $fn ($line)");
630 Log('err', "corrupt first line in $fn ($line)");
634 @f = split /\^/, $line;
635 $ref = DXMsg->alloc(@f);
637 $line = <$file>; # second line
639 $size -= length $line;
640 if (! $line =~ /^===/o) {
641 dbg("corrupt second line in $fn ($line)");
642 Log('err', "corrupt second line in $fn ($line)");
647 @f = split /\^/, $line;
648 push @{$ref->{gotit}}, @f;
649 $ref->{size} = $size;
656 # read in a message header
660 my $msgno = $self->{msgno};
663 my $fn = filename($msgno);
666 $file = new IO::File;
667 if (!open($file, $fn)) {
668 dbg("Error reading $fn $!");
669 Log('err' ,"Error reading $fn $!");
672 @out = map {chomp; $_} <$file>;
675 shift @out if $out[0] =~ /^=== /;
676 shift @out if $out[0] =~ /^=== /;
680 # send a tranche of lines to the other end
683 my ($self, $dxchan) = @_;
685 my $to = $self->{tonode};
686 my $from = $self->{fromnode};
687 my $stream = $self->{stream};
688 my $lines = $self->{lines};
691 for ($i = 0, $c = $self->{count}; $i < $self->{linesreq} && $c < @$lines; $i++, $c++) {
692 push @out, DXProt::pc29($to, $from, $stream, $lines->[$c]);
696 push @out, DXProt::pc32($to, $from, $stream) if $i < $self->{linesreq};
701 # find a message to send out and start the ball rolling
708 # bat down the message list looking for one that needs to go off site and whose
709 # nearest node is not busy.
711 dbg("queue msg ($sort)\n") if isdbg('msg');
712 my @nodelist = DXChannel::get_all_nodes;
713 foreach $ref (@msg) {
715 # ignore 'delayed' messages until their waiting time has expired
716 if (exists $ref->{waitt}) {
717 next if $ref->{waitt} > $main::systime;
718 delete $ref->{waitt};
722 if (exists $ref->{lastt} && $main::systime >= $ref->{lastt} + $timeout) {
723 my $node = $ref->{tonode};
724 dbg("Timeout, stopping msgno: $ref->{msgno} -> $node") if isdbg('msg');
725 Log('msg', "Timeout, stopping msgno: $ref->{msgno} -> $node");
726 $ref->stop_msg($node);
728 # delay any outgoing messages that fail
729 $ref->{waitt} = $main::systime + $waittime + int rand(120) if $node ne $main::mycall;
730 delete $ref->{lastt};
734 # is it being sent anywhere currently?
735 next if $ref->{tonode}; # ignore it if it already being processed
737 # is it awaiting deletion?
738 next if $ref->{delete};
740 # firstly, is it private and unread? if so can I find the recipient
741 # in my cluster node list offsite?
743 # deal with routed private messages
745 if ($ref->{private}) {
746 next if $ref->{'read'}; # if it is read, it is stuck here
747 $clref = Route::get($ref->{to});
749 $dxchan = $clref->dxchan;
751 if ($dxchan->is_node) {
752 next if $clref->call eq $main::mycall; # i.e. it lives here
753 $ref->start_msg($dxchan) if !get_busy($dxchan->call) && $dxchan->state eq 'normal';
756 dbg("Route: No dxchan for $ref->{to} " . ref($clref) ) if isdbg('msg');
761 # otherwise we are dealing with a bulletin or forwarded private message
762 # compare the gotit list with
763 # the nodelist up above, if there are sites that haven't got it yet
764 # then start sending it - what happens when we get loops is anyone's
765 # guess, use (to, from, time, subject) tuple?
766 foreach $dxchan (@nodelist) {
767 my $call = $dxchan->call;
769 next if $call eq $main::mycall;
770 next if ref $ref->{gotit} && grep $_ eq $call, @{$ref->{gotit}};
771 next unless $ref->forward_it($call); # check the forwarding file
772 next if $ref->{tonode}; # ignore it if it already being processed
774 # if we are here we have a node that doesn't have this message
775 if (!get_busy($call) && $dxchan->state eq 'normal') {
776 $ref->start_msg($dxchan);
782 # if all the available nodes are busy then stop
783 last if @nodelist == scalar grep { get_busy($_->call) } @nodelist;
789 # is there a message for me?
796 foreach $ref (@msg) {
797 # is it for me, private and unread?
798 if ($ref->{to} eq $call && $ref->{private}) {
799 $count++ unless $ref->{'read'} || $ref->{delete};
805 # start the message off on its travels with a PC28
808 my ($self, $dxchan) = @_;
810 confess("trying to start started msg $self->{msgno} nodes: $self->{fromnode} -> $self->{tonode}") if $self->{tonode};
811 dbg("start msg $self->{msgno}\n") if isdbg('msg');
812 $self->{linesreq} = 10;
814 $self->{tonode} = $dxchan->call;
815 $self->{fromnode} = $main::mycall;
816 set_busy($self->{tonode}, $self);
817 set_fwq($self->{tonode}, undef, $self);
818 $self->{lastt} = $main::systime;
819 my ($fromnode, $origin);
820 $fromnode = $self->{fromnode};
821 $origin = $self->{origin};
822 $dxchan->send(DXProt::pc28($self->{tonode}, $fromnode, $self->{to}, $self->{from}, $self->{t}, $self->{private}, $self->{subject}, $origin, $self->{rrreq}));
825 # get the ref of a busy node
835 return $busy{$call} = shift;
841 return delete $busy{$call};
844 # get the whole busy queue
850 # get a forwarding queue entry
854 my $stream = shift || '0';
855 return $work{"$call,$stream"};
858 # delete a forwarding queue entry
862 my $stream = shift || '0';
863 return delete $work{"$call,$stream"};
870 my $stream = shift || '0';
871 return $work{"$call,$stream"} = shift;
874 # get the whole forwarding queue
880 # stop a message from continuing, clean it out, unlock interlocks etc
885 my $stream = $self->{stream};
888 dbg("stop msg $self->{msgno} -> node $node\n") if isdbg('msg');
889 del_fwq($node, $stream);
897 delete $ref->{lines};
898 delete $ref->{linesreq};
899 delete $ref->{tonode};
900 delete $ref->{fromnode};
901 delete $ref->{stream};
903 delete $ref->{count};
904 delete $ref->{tempr};
905 delete $ref->{lastt};
906 delete $ref->{waitt};
909 # get a new transaction number from the file specified
913 $name =~ s/\W//og; # remove non-word characters
914 my $fn = "$msgdir/$name";
917 my $fh = new IO::File;
918 if (sysopen($fh, $fn, O_RDWR|O_CREAT, 0666)) {
920 $msgno = $fh->getline || '0';
924 $fh->print("$msgno\n");
925 dbg("msgno $msgno allocated for $name\n") if isdbg('msg');
928 confess "can't open $fn $!";
933 # initialise the message 'system', read in all the message headers
936 my $dir = new IO::File;
940 # load various control files
941 dbg("load badmsg: " . (load_badmsg() or "Ok"));
942 dbg("load forward: " . (load_forward() or "Ok"));
943 dbg("load swop: " . (load_swop() or "Ok"));
945 # read in the directory
946 opendir($dir, $msgdir) or confess "can't open $msgdir $!";
947 @dir = readdir($dir);
952 next unless /^m\d\d\d\d\d\d$/;
954 $ref = read_msg_header("$msgdir/$_");
957 Log('err', "Deleting $_");
962 # delete any messages to 'badmsg.pl' places
963 if ($ref->dump_it('')) {
964 dbg("'Bad' TO address $ref->{to}") if isdbg('msg');
965 Log('msg', "'Bad' TO address $ref->{to}");
970 # add the message to the available queue
975 # add the message to the directory listing
979 confess "tried to add a non-ref to the msg directory" if !ref $ref;
983 # return all the current messages
989 # get a particular message
994 return $_ if $_->{msgno} == $msgno;
995 last if $_->{msgno} > $msgno;
1000 # return the official filename for a message no
1003 return sprintf "$msgdir/m%06d", shift;
1007 # return a list of valid elements
1012 return keys(%valid);
1016 # return a prompt for a field
1021 my ($self, $ele) = @_;
1022 return $valid{$ele};
1026 # send a message state machine
1033 if ($self->state eq 'send1') {
1035 confess "local var gone missing" if !ref $self->{loc};
1036 my $loc = $self->{loc};
1037 if (my @ans = BadWords::check($line)) {
1038 $self->{badcount} += @ans;
1039 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} in msg");
1042 $loc->{subject} = $line;
1044 $self->state('sendbody');
1045 #push @out, $self->msg('sendbody');
1046 push @out, $self->msg('m8');
1047 } elsif ($self->state eq 'sendbody') {
1048 confess "local var gone missing" if !ref $self->{loc};
1049 my $loc = $self->{loc};
1050 if ($line eq "\032" || $line eq '%1A' || uc $line eq "/EX") {
1052 unless ($loc->{reject}) {
1053 foreach $to (@{$loc->{to}}) {
1055 my $systime = $main::systime;
1056 my $mycall = $main::mycall;
1057 $ref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
1059 exists $loc->{from} ? $loc->{from} : $self->call,
1063 exists $loc->{origin} ? $loc->{origin} : $mycall,
1066 $ref->swop_it($self->call);
1067 $ref->store($loc->{lines});
1069 push @out, $self->msg('m11', $ref->{msgno}, $to);
1070 #push @out, "msgno $ref->{msgno} sent to $to";
1074 Log('msg', $self->call . " swore to @{$loc->{to}} subject: '$loc->{subject}' in msg, REJECTED");
1077 delete $loc->{lines};
1079 delete $self->{loc};
1082 $self->state('prompt');
1083 } elsif ($line eq "\031" || uc $line eq "/ABORT" || uc $line eq "/QUIT") {
1084 #push @out, $self->msg('sendabort');
1085 push @out, $self->msg('m10');
1086 delete $loc->{lines};
1088 delete $self->{loc};
1090 $self->state('prompt');
1091 } elsif ($line =~ m|^/+\w+|) {
1092 # this is a command that you want display for your own reference
1093 # or if it has TWO slashes is a command
1095 my $store = $line =~ s|^/+||;
1096 my @in = $self->run_cmd($line);
1099 foreach my $l (@in) {
1100 if (my @ans = BadWords::check($l)) {
1101 $self->{badcount} += @ans;
1102 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} subject: '$loc->{subject}' in msg") unless $loc->{reject};
1103 Log('msg', "line: $l");
1106 push @{$loc->{lines}}, length($l) > 0 ? $l : " ";
1110 if (my @ans = BadWords::check($line)) {
1111 $self->{badcount} += @ans;
1112 Log('msg', $self->call . " used badwords: @ans to @{$loc->{to}} subject: '$loc->{subject}' in msg") unless $loc->{reject};
1113 Log('msg', "line: $line");
1117 if ($loc->{lines} && @{$loc->{lines}}) {
1118 push @{$loc->{lines}}, length($line) > 0 ? $line : " ";
1120 # temporarily store any R: lines so that we end up with
1121 # only the first and last ones stored.
1122 if ($line =~ m|^R:\d{6}/\d{4}|) {
1123 push @{$loc->{tempr}}, $line;
1125 if (exists $loc->{tempr}) {
1126 push @{$loc->{lines}}, shift @{$loc->{tempr}};
1127 push @{$loc->{lines}}, pop @{$loc->{tempr}} if @{$loc->{tempr}};
1128 delete $loc->{tempr};
1130 push @{$loc->{lines}}, length($line) > 0 ? $line : " ";
1134 # i.e. it ain't and end or abort, therefore store the line
1140 # return the standard directory line for this ref
1144 my $flag = $ref->{private} && $ref->{read} ? '-' : ' ';
1145 if ($ref->{delete}) {
1146 $flag = $ref->{deletetime} > $main::systime ? 'D' : 'E';
1148 return sprintf("%6d%s%s%5d %8.8s %8.8s %-6.6s %5.5s %-30.30s",
1149 $ref->{msgno}, $flag, $ref->{private} ? 'p' : ' ',
1150 $ref->{size}, $ref->{to}, $ref->{from}, cldate($ref->{t}),
1151 ztime($ref->{t}), $ref->{subject});
1154 # load the forward table
1158 my $s = readfilestr($forwardfn);
1161 push @out, $@ if $@;
1166 # load the bad message table
1170 my $s = readfilestr($badmsgfn);
1173 push @out, $@ if $@;
1178 # load the swop message table
1182 my $s = readfilestr($swopfn);
1185 push @out, $@ if $@;
1191 # forward that message or not according to the forwarding table
1192 # returns 1 for forward, 0 - to ignore
1201 for ($i = 0; $i < @forward; $i += 5) {
1202 my ($sort, $field, $pattern, $action, $bbs) = @forward[$i..($i+4)];
1205 # are we interested?
1206 next if $ref->{private} && $sort ne 'P';
1207 next if !$ref->{private} && $sort ne 'B';
1210 $tested = $ref->{to} if $field eq 'T';
1211 $tested = $ref->{from} if $field eq 'F';
1212 $tested = $ref->{origin} if $field eq 'O';
1213 $tested = $ref->{subject} if $field eq 'S';
1215 if (!$pattern || $tested =~ m{$pattern}i) {
1216 return 0 if $action eq 'I';
1217 return 1 if !$bbs || grep $_ eq $call, @{$bbs};
1224 # look down the forward table to see whether this is a valid bull
1225 # or not (ie it will forward somewhere even if it is only here)
1233 return 1 if $call =~ /^ALL/;
1234 return 1 if $call =~ /^DX/;
1238 for ($i = 0; $i < @forward; $i += 5) {
1239 my ($sort, $field, $pattern, $action, $bbs) = @forward[$i..($i+4)];
1240 if ($field eq 'T') {
1241 if (!$pattern || $call =~ m{$pattern}i) {
1255 for ($i = 0; $i < @badmsg; $i += 3) {
1256 my ($sort, $field, $pattern) = @badmsg[$i..($i+2)];
1259 # are we interested?
1260 next if $ref->{private} && $sort ne 'P';
1261 next if !$ref->{private} && $sort ne 'B';
1264 $tested = $ref->{to} if $field eq 'T';
1265 $tested = $ref->{from} if $field eq 'F';
1266 $tested = $ref->{origin} if $field eq 'O';
1267 $tested = $ref->{subject} if $field eq 'S';
1268 $tested = $call if $field eq 'I';
1270 if (!$pattern || $tested =~ m{$pattern}i) {
1284 for ($i = 0; $i < @swop; $i += 5) {
1285 my ($sort, $field, $pattern, $tfield, $topattern) = @swop[$i..($i+4)];
1290 # are we interested?
1291 next if $ref->{private} && $sort ne 'P';
1292 next if !$ref->{private} && $sort ne 'B';
1295 $tested = $ref->{to} if $field eq 'T';
1296 $tested = $ref->{from} if $field eq 'F';
1297 $tested = $ref->{origin} if $field eq 'O';
1298 $tested = $ref->{subject} if $field eq 'S';
1301 $old = $swop = $ref->{to} if $tfield eq 'T';
1302 $old = $swop = $ref->{from} if $tfield eq 'F';
1303 $old = $swop = $ref->{origin} if $tfield eq 'O';
1304 $old = $swop = $ref->{subject} if $tfield eq 'S';
1306 if ($tested =~ m{$pattern}i) {
1307 if ($tested eq $swop) {
1308 $swop =~ s{$pattern}{$topattern}i;
1312 Log('msg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1313 Log('dbg', "Msg $ref->{msgno}: $tfield $old -> $swop");
1314 $ref->{to} = $swop if $tfield eq 'T';
1315 $ref->{from} = $swop if $tfield eq 'F';
1316 $ref->{origin} = $swop if $tfield eq 'O';
1317 $ref->{subject} = $swop if $tfield eq 'S';
1324 # import any msgs in the import directory
1325 # the messages are in BBS format (but may have cluster extentions
1326 # so SB UK < GB7TLH is legal
1329 # are there any to do in this directory?
1330 return unless -d $importfn;
1331 unless (opendir(DIR, $importfn)) {
1332 dbg("can\'t open $importfn $!") if isdbg('msg');
1333 Log('msg', "can\'t open $importfn $!");
1337 my @names = readdir(DIR);
1340 foreach $name (@names) {
1341 next if $name =~ /^\./;
1342 my $splitit = $name =~ /^split/;
1343 my $fn = "$importfn/$name";
1345 unless (open(MSG, $fn)) {
1346 dbg("can\'t open import file $fn $!") if isdbg('msg');
1347 Log('msg', "can\'t open import file $fn $!");
1351 my @msg = map { chomp; $_ } <MSG>;
1354 my @out = import_one($main::me, \@msg, $splitit);
1359 # import one message as a list in bbs (as extended) mode
1360 # takes a reference to an array containing the whole message
1365 my $splitit = shift;
1369 my $from = $dxchan->call;
1370 my $origin = $main::mycall;
1375 my $line = shift @$ref;
1376 my @f = split /([\s\@\$])/, $line;
1377 @f = map {s/\s+//g; length $_ ? $_ : ()} @f;
1379 unless (@f && $f[0] =~ /^(:?S|SP|SB|SEND)$/ ) {
1380 my $m = "invalid first line in import '$line'";
1381 dbg($m) if isdbg('msg');
1385 my $f = uc shift @f;
1386 next if $f eq 'SEND';
1388 # private / noprivate / rr
1389 if ($notincalls && ($f eq 'B' || $f eq 'SB' || $f =~ /^NOP/oi)) {
1391 } elsif ($notincalls && ($f eq 'P' || $f eq 'SP' || $f =~ /^PRI/oi)) {
1393 } elsif ($notincalls && ($f eq 'RR')) {
1395 } elsif (($f =~ /^[\@\.\#\$]$/ || $f eq '.#') && @f) { # this is bbs syntax, for AT
1397 } elsif ($f eq '<' && @f) { # this is bbs syntax for from call
1398 $from = uc shift @f;
1399 } elsif ($f =~ /^\$/) { # this is bbs syntax for a bid
1401 } elsif ($f =~ /^<(\S+)/) { # this is bbs syntax for from call
1403 } elsif ($f =~ /^\$\S+/) { # this is bbs syntax for bid
1410 # is this callsign a distro?
1411 my $fn = "$msgdir/distro/$f.pl";
1413 my $fh = new IO::File $fn;
1420 return (1, "Error in Distro $f.pl:", $@) if $@;
1428 if (grep $_ eq $f, @DXMsg::badmsg) {
1429 push @out, $dxchan->msg('m3', $f);
1436 # subject is the next line
1437 my $subject = shift @$ref;
1439 # strip off trailing lines
1440 pop @$ref while (@$ref && $$ref[-1] =~ /^\s*$/);
1442 # strip off /EX or /ABORT
1443 return ("aborted") if @$ref && $$ref[-1] =~ m{^/ABORT$}i;
1444 pop @$ref if (@$ref && $$ref[-1] =~ m{^/EX$}i);
1446 # sort out any splitting that needs to be done
1452 if ($lth >= $maxchunk || ($lth > $minchunk && /^\s*$/)) {
1453 push @chunk, $lines;
1460 push @chunk, $lines if @$lines;
1465 # does an identical message already exist?
1468 if (substr($subject,0,28) eq substr($m->{subject},0,28) && $from eq $m->{from} && grep $m->{to} eq $_, @to) {
1469 my $msgno = $m->{msgno};
1470 dbg("duplicate message from $from -> $m->{to} to msg: $msgno") if isdbg('msg');
1471 Log('msg', "duplicate message from $from -> $m->{to} to msg: $msgno");
1476 # write all the messages away
1478 for ( $i = 0; $i < @chunk; $i++) {
1479 my $chunk = $chunk[$i];
1482 my $num = " [" . ($i+1) . "/" . scalar @chunk . "]";
1483 $ch_subject = substr($subject, 0, 27 - length $num) . $num;
1485 $ch_subject = $subject;
1489 my $systime = $main::systime;
1490 my $mycall = $main::mycall;
1491 my $mref = DXMsg->alloc(DXMsg::next_transno('Msgno'),
1500 $mref->swop_it($main::mycall);
1501 $mref->store($chunk);
1503 push @out, $dxchan->msg('m11', $mref->{msgno}, $to);
1504 #push @out, "msgno $ref->{msgno} sent to $to";
1516 my $name = $AUTOLOAD;
1517 return if $name =~ /::DESTROY$/;
1518 $name =~ s/^.*:://o;
1520 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
1521 # this clever line of code creates a subroutine which takes over from autoload
1522 # from OO Perl - Conway
1523 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
1524 &$AUTOLOAD($self, @_);
1525 # *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
1526 # @_ ? $self->{$name} = shift : $self->{$name} ;