c9395e3e4d5dd0471f17e71dcc978fdeda482f92
[spider.git] / perl / DXChannel.pm
1 #
2 # module to manage channel lists & data
3 #
4 # This is the base class for all channel operations, which is everything to do 
5 # with input and output really.
6 #
7 # The instance variable in the outside world will be generally be called $dxchan
8 #
9 # This class is 'inherited' (if that is the goobledegook for what I am doing)
10 # by various other modules. The point to understand is that the 'instance variable'
11 # is in fact what normal people would call the state vector and all useful info
12 # about a connection goes in there.
13 #
14 # Another point to note is that a vector may contain a list of other vectors. 
15 # I have simply added another variable to the vector for 'simplicity' (or laziness
16 # as it is more commonly called)
17 #
18 # PLEASE NOTE - I am a C programmer using this as a method of learning perl
19 # firstly and OO about ninthly (if you don't like the design and you can't 
20 # improve it with better OO and thus make it smaller and more efficient, then tough). 
21 #
22 # Copyright (c) 1998-2000 - Dirk Koopman G1TLH
23 #
24 # $Id$
25 #
26 package DXChannel;
27
28 use Msg;
29 use DXM;
30 use DXUtil;
31 use DXVars;
32 use DXDebug;
33 use Filter;
34 use Prefix;
35 use Route;
36
37 use strict;
38 use vars qw(%channels %valid @ISA $count);
39
40 %channels = ();
41 $count = 0;
42
43 %valid = (
44                   call => '0,Callsign',
45                   conn => '9,Msg Conn ref',
46                   user => '9,DXUser ref',
47                   startt => '0,Start Time,atime',
48                   t => '9,Time,atime',
49                   pc50_t => '5,Last PC50 Time,atime',
50                   priv => '9,Privilege',
51                   state => '0,Current State',
52                   oldstate => '5,Last State',
53                   list => '9,Dep Chan List',
54                   name => '0,User Name',
55                   consort => '5,Connection Type',
56                   'sort' => '5,Type of Channel',
57                   wwv => '0,Want WWV,yesno',
58                   wcy => '0,Want WCY,yesno',
59                   wx => '0,Want WX,yesno',
60                   talk => '0,Want Talk,yesno',
61                   ann => '0,Want Announce,yesno',
62                   here => '0,Here?,yesno',
63                   conf => '0,In Conference?,yesno',
64                   dx => '0,DX Spots,yesno',
65                   redirect => '0,Redirect messages to',
66                   lang => '0,Language',
67                   func => '5,Function',
68                   loc => '9,Local Vars', # used by func to store local variables in
69                   beep => '0,Want Beeps,yesno',
70                   lastread => '5,Last Msg Read',
71                   outbound => '5,outbound?,yesno',
72                   remotecmd => '9,doing rcmd,yesno',
73                   pagelth => '0,Page Length',
74                   pagedata => '9,Page Data Store',
75                   group => '0,Access Group,parray',     # used to create a group of users/nodes for some purpose or other
76                   isolate => '5,Isolate network,yesno',
77                   delayed => '5,Delayed messages,parray',
78                   annfilter => '5,Ann Filt-out',
79                   wwvfilter => '5,WWV Filt-out',
80                   wcyfilter => '5,WCY Filt-out',
81                   spotsfilter => '5,Spot Filt-out',
82                   routefilter => '5,Route Filt-out',
83                   inannfilter => '5,Ann Filt-inp',
84                   inwwvfilter => '5,WWV Filt-inp',
85                   inwcyfilter => '5,WCY Filt-inp',
86                   inspotsfilter => '5,Spot Filt-inp',
87                   inroutefilter => '5,Route Filt-inp',
88                   passwd => '9,Passwd List,yesno',
89                   pingint => '5,Ping Interval ',
90                   nopings => '5,Ping Obs Count',
91                   lastping => '5,Ping last sent,atime',
92                   pingtime => '5,Ping totaltime,parray',
93                   pingave => '0,Ping ave time',
94                   logininfo => '9,Login info req,yesno',
95                   talklist => '0,Talk List,parray',
96                   cluster => '5,Cluster data',
97                   isbasic => '9,Internal Connection', 
98                   errors => '9,Errors',
99                   route => '9,Route Data',
100                   dxcc => '0,Country Code',
101                   itu => '0,ITU Zone',
102                   cq => '0,CQ Zone',
103                   enhanced => '5,Enhanced Client,yesno',
104                   gtk => '5,Using GTK,yesno',
105                   senddbg => '8,Sending Debug,yesno',
106                   width => '0,Column Width',
107                   disconnecting => '9,Disconnecting,yesno',
108                   ann_talk => '0,Suppress Talk Anns,yesno',
109                   metric => '1,Route metric',
110                   badcount => '1,Bad Word Count',
111                   edit => '7,Edit Function',
112                   registered => '9,Registered?,yesno',
113                   prompt => '0,Required Prompt',
114                   version => '1,Node Version',
115                   build => '1,Node Build',
116                   verified => '9,Verified?,yesno',
117                   newroute => '1,New Style Routing,yesno',
118                   ve7cc => '0,VE7CC program special,yesno',
119                   lastmsgpoll => '0,Last Msg Poll,atime',
120                   inscript => '9,In a script,yesno',
121                   handle_xml => '9,Handles XML,yesno',
122                   inqueue => '9,Input Queue,parray',
123                  );
124
125 use vars qw($VERSION $BRANCH);
126 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
127 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
128 $main::build += $VERSION;
129 $main::branch += $BRANCH;
130
131 # object destruction
132 sub DESTROY
133 {
134         my $self = shift;
135         for (keys %$self) {
136                 if (ref($self->{$_})) {
137                         delete $self->{$_};
138                 }
139         }
140         dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
141         $count--;
142 }
143
144 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
145 sub alloc
146 {
147         my ($pkg, $call, $conn, $user) = @_;
148         my $self = {};
149   
150         die "trying to create a duplicate channel for $call" if $channels{$call};
151         $self->{call} = $call;
152         $self->{priv} = 0;
153         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
154         if (defined $user) {
155                 $self->{user} = $user;
156                 $self->{lang} = $user->lang;
157                 $user->new_group unless $user->group;
158                 $user->new_buddies unless $user->buddies;
159                 $self->{group} = $user->group;
160                 $self->{sort} = $user->sort;
161         }
162         $self->{startt} = $self->{t} = time;
163         $self->{state} = 0;
164         $self->{oldstate} = 0;
165         $self->{lang} = $main::lang if !$self->{lang};
166         $self->{func} = "";
167
168         # add in all the dxcc, itu, zone info
169         my @dxcc = Prefix::extract($call);
170         if (@dxcc > 0) {
171                 $self->{dxcc} = $dxcc[1]->dxcc;
172                 $self->{itu} = $dxcc[1]->itu;
173                 $self->{cq} = $dxcc[1]->cq;                                             
174         }
175         $self->{inqueue} = [];
176
177         $count++;
178         dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
179         bless $self, $pkg; 
180         return $channels{$call} = $self;
181 }
182
183 # rebless this channel as something else
184 sub rebless
185 {
186         my $self = shift;
187         my $class = shift;
188         return $channels{$self->{call}} = bless $self, $class;
189 }
190
191 sub rec 
192 {
193         my ($self, $msg) = @_;
194         
195         # queue the message and the channel object for later processing
196         if (defined $msg) {
197                 push @{$self->{inqueue}}, $msg;
198         }
199 }
200
201 # obtain a channel object by callsign [$obj = DXChannel::get($call)]
202 sub get
203 {
204         my $call = shift;
205         return $channels{$call};
206 }
207
208 # obtain all the channel objects
209 sub get_all
210 {
211         return values(%channels);
212 }
213
214 #
215 # gimme all the ak1a nodes
216 #
217 sub get_all_nodes
218 {
219         my $ref;
220         my @out;
221         foreach $ref (values %channels) {
222                 push @out, $ref if $ref->is_node;
223         }
224         return @out;
225 }
226
227 # return a list of all users
228 sub get_all_users
229 {
230         my $ref;
231         my @out;
232         foreach $ref (values %channels) {
233                 push @out, $ref if $ref->is_user;
234         }
235         return @out;
236 }
237
238 # return a list of all user callsigns
239 sub get_all_user_calls
240 {
241         my $ref;
242         my @out;
243         foreach $ref (values %channels) {
244                 push @out, $ref->{call} if $ref->is_user;
245         }
246         return @out;
247 }
248
249 # obtain a channel object by searching for its connection reference
250 sub get_by_cnum
251 {
252         my ($pkg, $conn) = @_;
253         my $self;
254   
255         foreach $self (values(%channels)) {
256                 return $self if ($self->{conn} == $conn);
257         }
258         return undef;
259 }
260
261 # get rid of a channel object [$obj->del()]
262 sub del
263 {
264         my $self = shift;
265
266         $self->{group} = undef;         # belt and braces
267         delete $channels{$self->{call}};
268 }
269
270 # is it a bbs
271 sub is_bbs
272 {
273         my $self = shift;
274         return $self->{'sort'} eq 'B';
275 }
276
277 sub is_node
278 {
279         my $self = shift;
280         return $self->{'sort'} =~ /[ACRSXW]/;
281 }
282 # is it an ak1a node ?
283 sub is_ak1a
284 {
285         my $self = shift;
286         return $self->{'sort'} eq 'A';
287 }
288
289 # is it a user?
290 sub is_user
291 {
292         my $self = shift;
293         return $self->{'sort'} eq 'U';
294 }
295
296 # is it a clx node
297 sub is_clx
298 {
299         my $self = shift;
300         return $self->{'sort'} eq 'C';
301 }
302
303 # it is Aranea
304 sub is_aranea
305 {
306         my $self = shift;
307         return $self->{'sort'} eq 'W';
308 }
309
310 # is it a spider node
311 sub is_spider
312 {
313         my $self = shift;
314         return $self->{'sort'} eq 'S';
315 }
316
317 # is it a DXNet node
318 sub is_dxnet
319 {
320         my $self = shift;
321         return $self->{'sort'} eq 'X';
322 }
323
324 # is it a ar-cluster node
325 sub is_arcluster
326 {
327         my $self = shift;
328         return $self->{'sort'} eq 'R';
329 }
330
331 # for perl 5.004's benefit
332 sub sort
333 {
334         my $self = shift;
335         return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
336 }
337
338 # find out whether we are prepared to believe this callsign on this interface
339 sub is_believed
340 {
341         my $self = shift;
342         my $call = shift;
343         
344         return grep $call eq $_, $self->user->believe;
345 }
346
347 # handle out going messages, immediately without waiting for the select to drop
348 # this could, in theory, block
349 sub send_now
350 {
351         my $self = shift;
352         my $conn = $self->{conn};
353         return unless $conn;
354         my $sort = shift;
355         my $call = $self->{call};
356         
357         for (@_) {
358 #               chomp;
359         my @lines = split /\n/;
360                 for (@lines) {
361                         $conn->send_now("$sort$call|$_");
362                         # debug log it, but not if it is a log message
363                         dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
364                 }
365         }
366         $self->{t} = time;
367 }
368
369 #
370 # send later with letter (more control)
371 #
372
373 sub send_later
374 {
375         my $self = shift;
376         my $conn = $self->{conn};
377         return unless $conn;
378         my $sort = shift;
379         my $call = $self->{call};
380         
381         for (@_) {
382 #               chomp;
383         my @lines = split /\n/;
384                 for (@lines) {
385                         $conn->send_later("$sort$call|$_");
386                         # debug log it, but not if it is a log message
387                         dbg("-> $sort $call $_") if $sort ne 'L' isdbg('chan');
388                 }
389         }
390         $self->{t} = time;
391 }
392
393 #
394 # the normal output routine
395 #
396 sub send                                                # this is always later and always data
397 {
398         my $self = shift;
399         my $conn = $self->{conn};
400         return unless $conn;
401         my $call = $self->{call};
402
403         foreach my $l (@_) {
404                 for (ref $l ? @$l : $l) {
405                         my @lines = split /\n/;
406                         for (@lines) {
407                                 $conn->send_later("D$call|$_");
408                                 dbg("-> D $call $_") if isdbg('chan');
409                         }
410                 }
411         }
412         $self->{t} = $main::systime;
413 }
414
415 # send a file (always later)
416 sub send_file
417 {
418         my ($self, $fn) = @_;
419         my $call = $self->{call};
420         my $conn = $self->{conn};
421         my @buf;
422   
423         open(F, $fn) or die "can't open $fn for sending file ($!)";
424         @buf = <F>;
425         close(F);
426         $self->send(@buf);
427 }
428
429 # this will implement language independence (in time)
430 sub msg
431 {
432         my $self = shift;
433         return DXM::msg($self->{lang}, @_);
434 }
435
436 # stick a broadcast on the delayed queue (but only up to 20 items)
437 sub delay
438 {
439         my $self = shift;
440         my $s = shift;
441         
442         $self->{delayed} = [] unless $self->{delayed};
443         push @{$self->{delayed}}, $s;
444         if (@{$self->{delayed}} >= 20) {
445                 shift @{$self->{delayed}};   # lose oldest one
446         }
447 }
448
449 # change the state of the channel - lots of scope for debugging here :-)
450 sub state
451 {
452         my $self = shift;
453         if (@_) {
454                 $self->{oldstate} = $self->{state};
455                 $self->{state} = shift;
456                 $self->{func} = '' unless defined $self->{func};
457                 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
458
459                 # if there is any queued up broadcasts then splurge them out here
460                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
461                         $self->send (@{$self->{delayed}});
462                         delete $self->{delayed};
463                 }
464         }
465         return $self->{state};
466 }
467
468 # disconnect this channel
469 sub disconnect
470 {
471         my $self = shift;
472         my $user = $self->{user};
473         
474         $user->close() if defined $user;
475         $self->{conn}->disconnect;
476         $self->del();
477 }
478
479 #
480 # just close all the socket connections down without any fiddling about, cleaning, being
481 # nice to other processes and otherwise telling them what is going on.
482 #
483 # This is for the benefit of forked processes to prepare for starting new programs, they
484 # don't want or need all this baggage.
485 #
486
487 sub closeall
488 {
489         my $ref;
490         foreach $ref (values %channels) {
491                 $ref->{conn}->disconnect() if $ref->{conn};
492         }
493 }
494
495 #
496 # Tell all the users that we have come in or out (if they want to know)
497 #
498 sub tell_login
499 {
500         my ($self, $m, $call) = @_;
501         
502         $call ||= $self->{call};
503         
504         # send info to all logged in thingies
505         my @dxchan = get_all_users();
506         my $dxchan;
507         foreach $dxchan (@dxchan) {
508                 next if $dxchan == $self;
509                 next if $dxchan->{call} eq $main::mycall;
510                 $dxchan->send($dxchan->msg($m, $call)) if $dxchan->{logininfo};
511         }
512 }
513
514 #
515 # Tell all the users if a buddy is logged or out
516 #
517 sub tell_buddies
518 {
519         my ($self, $m, $call, $node) = @_;
520         
521         $call ||= $self->{call};
522         $call =~ s/-\d+$//;
523         $m .= 'n' if $node;
524         
525         # send info to all logged in thingies
526         my @dxchan = get_all_users();
527         my $dxchan;
528         foreach $dxchan (@dxchan) {
529                 next if $dxchan == $self;
530                 next if $dxchan->{call} eq $main::mycall;
531                 $dxchan->send($dxchan->msg($m, $call, $node)) if grep $_ eq $call, @{$dxchan->{user}->{buddies}} ;
532         }
533 }
534
535 # various access routines
536
537 #
538 # return a list of valid elements 
539
540
541 sub fields
542 {
543         return keys(%valid);
544 }
545
546 #
547 # return a prompt for a field
548 #
549
550 sub field_prompt
551
552         my ($self, $ele) = @_;
553         return $valid{$ele};
554 }
555
556 # take a standard input message and decode it into its standard parts
557 sub decode_input
558 {
559         my $dxchan = shift;
560         my $data = shift;
561         my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
562
563         my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
564         
565         # the above regexp must work
566         unless (defined $sort && defined $call && defined $line) {
567 #               $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
568                 dbg("DUFF Line on $chcall: $data");
569                 return ();
570         }
571
572         if(ref($dxchan) && $call ne $chcall) {
573                 dbg("DUFF Line come in for $call on wrong channel $chcall");
574                 return();
575         }
576         
577         return ($sort, $call, $line);
578 }
579
580 sub rspfcheck
581 {
582         my ($self, $flag, $node, $user) = @_;
583         my $nref = Route::Node::get($node);
584         my $dxchan = $nref->dxchan if $nref;
585         if ($nref && $dxchan) {
586             if ($dxchan == $self) {
587                         return 1 unless $user;
588                         return 1 if $user eq $node;
589                         my @users = $nref->users;
590                         return 1 if @users == 0 || grep $user eq $_, @users;
591                         dbg("RSPF: $user not on $node") if isdbg('chanerr');
592                 } else {
593                         dbg("RSPF: Shortest path for $node is " . $nref->dxchan->{call}) if isdbg('chanerr');
594                 }
595         } else {
596                 return 1 if $flag;
597                 dbg("RSPF: required $node not found" ) if isdbg('chanerr');
598         }
599         return 0;
600 }
601
602 # broadcast a message to all clusters taking into account isolation
603 # [except those mentioned after buffer]
604 sub broadcast_nodes
605 {
606         my $s = shift;                          # the line to be rebroadcast
607         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
608         my @dxchan = get_all_nodes();
609         my $dxchan;
610         
611         # send it if it isn't the except list and isn't isolated and still has a hop count
612         foreach $dxchan (@dxchan) {
613                 next if grep $dxchan == $_, @except;
614                 next if $dxchan == $main::me;
615                 
616                 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s;      # adjust its hop count by node name
617
618                 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
619         }
620 }
621
622 # broadcast a message to all clusters ignoring isolation
623 # [except those mentioned after buffer]
624 sub broadcast_all_nodes
625 {
626         my $s = shift;                          # the line to be rebroadcast
627         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
628         my @dxchan = get_all_nodes();
629         my $dxchan;
630         
631         # send it if it isn't the except list and isn't isolated and still has a hop count
632         foreach $dxchan (@dxchan) {
633                 next if grep $dxchan == $_, @except;
634                 next if $dxchan == $main::me;
635
636                 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s;      # adjust its hop count by node name
637                 $dxchan->send($routeit);
638         }
639 }
640
641 # broadcast to all users
642 # storing the spot or whatever until it is in a state to receive it
643 sub broadcast_users
644 {
645         my $s = shift;                          # the line to be rebroadcast
646         my $sort = shift;           # the type of transmission
647         my $fref = shift;           # a reference to an object to filter on
648         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
649         my @dxchan = get_all_users();
650         my $dxchan;
651         my @out;
652         
653         foreach $dxchan (@dxchan) {
654                 next if grep $dxchan == $_, @except;
655                 push @out, $dxchan;
656         }
657         broadcast_list($s, $sort, $fref, @out);
658 }
659
660
661 # broadcast to a list of users
662 sub broadcast_list
663 {
664         my $s = shift;
665         my $sort = shift;
666         my $fref = shift;
667         my $dxchan;
668         
669         foreach $dxchan (@_) {
670                 my $filter = 1;
671                 next if $dxchan == $main::me;
672                 
673                 if ($sort eq 'dx') {
674                     next unless $dxchan->{dx};
675                         ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
676                         next unless $filter;
677                 }
678                 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
679                 next if $sort eq 'wwv' && !$dxchan->{wwv};
680                 next if $sort eq 'wcy' && !$dxchan->{wcy};
681                 next if $sort eq 'wx' && !$dxchan->{wx};
682
683                 $s =~ s/\a//og unless $dxchan->{beep};
684
685                 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
686                         $dxchan->send($s);      
687                 } else {
688                         $dxchan->delay($s);
689                 }
690         }
691 }
692
693 sub process
694 {
695         foreach my $dxchan (get_all()) {
696
697                 while (my $data = shift @{$dxchan->{inqueue}}) {
698                         my ($sort, $call, $line) = $dxchan->decode_input($data);
699                         next unless defined $sort;
700
701                         # do the really sexy console interface bit! (Who is going to do the TK interface then?)
702                         dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
703                         if ($dxchan->{disconnecting}) {
704                                 dbg('In disconnection, ignored');
705                                 next;
706                         }
707
708                         # handle A records
709                         my $user = $dxchan->user;
710                         if ($sort eq 'A' || $sort eq 'O') {
711                                 $dxchan->start($line, $sort);
712                         } elsif ($sort eq 'I') {
713                                 die "\$user not defined for $call" if !defined $user;
714                         
715                                 # normal input
716                                 $dxchan->normal($line);
717                         } elsif ($sort eq 'Z') {
718                                 $dxchan->disconnect;
719                         } elsif ($sort eq 'D') {
720                                 ;                               # ignored (an echo)
721                         } elsif ($sort eq 'G') {
722                                 $dxchan->enhanced($line);
723                         } else {
724                                 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
725                         }
726                 }
727         }
728 }
729
730 sub handle_xml
731 {
732         my $self = shift;
733         my $r = 0;
734         
735         if (DXXml::available()) {
736                 $r = $self->{handle_xml} || 0;
737         } else {
738                 delete $self->{handle_xml} if exists $self->{handle_xml};
739         }
740         return $r;
741 }
742
743 #no strict;
744 sub AUTOLOAD
745 {
746         no strict;
747         my $name = $AUTOLOAD;
748         return if $name =~ /::DESTROY$/;
749         $name =~ s/^.*:://o;
750   
751         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
752
753         # this clever line of code creates a subroutine which takes over from autoload
754         # from OO Perl - Conway
755         *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
756         goto &$AUTOLOAD;
757 }
758
759
760 1;
761 __END__;