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