Merge branch 'master' into SIMPLEROUTE
[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                   do_pc9x => '9,Handles PC9x,yesno',
123                   inqueue => '9,Input Queue,parray',
124                  );
125
126 # object destruction
127 sub DESTROY
128 {
129         my $self = shift;
130         for (keys %$self) {
131                 if (ref($self->{$_})) {
132                         delete $self->{$_};
133                 }
134         }
135         dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
136         $count--;
137 }
138
139 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
140 sub alloc
141 {
142         my ($pkg, $call, $conn, $user) = @_;
143         my $self = {};
144   
145         die "trying to create a duplicate channel for $call" if $channels{$call};
146         $self->{call} = $call;
147         $self->{priv} = 0;
148         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
149         if (defined $user) {
150                 $self->{user} = $user;
151                 $self->{lang} = $user->lang;
152                 $user->new_group unless $user->group;
153                 $user->new_buddies unless $user->buddies;
154                 $self->{group} = $user->group;
155                 $self->{sort} = $user->sort;
156         }
157         $self->{startt} = $self->{t} = time;
158         $self->{state} = 0;
159         $self->{oldstate} = 0;
160         $self->{lang} = $main::lang if !$self->{lang};
161         $self->{func} = "";
162
163         # add in all the dxcc, itu, zone info
164         my @dxcc = Prefix::extract($call);
165         if (@dxcc > 0) {
166                 $self->{dxcc} = $dxcc[1]->dxcc;
167                 $self->{itu} = $dxcc[1]->itu;
168                 $self->{cq} = $dxcc[1]->cq;                                             
169         }
170         $self->{inqueue} = [];
171
172         $count++;
173         dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
174         bless $self, $pkg; 
175         return $channels{$call} = $self;
176 }
177
178 # rebless this channel as something else
179 sub rebless
180 {
181         my $self = shift;
182         my $class = shift;
183         return $channels{$self->{call}} = bless $self, $class;
184 }
185
186 sub rec 
187 {
188         my ($self, $msg) = @_;
189         
190         # queue the message and the channel object for later processing
191         if (defined $msg) {
192                 push @{$self->{inqueue}}, $msg;
193         }
194 }
195
196 # obtain a channel object by callsign [$obj = DXChannel::get($call)]
197 sub get
198 {
199         my $call = shift;
200         return $channels{$call};
201 }
202
203 # obtain all the channel objects
204 sub get_all
205 {
206         return values(%channels);
207 }
208
209 #
210 # gimme all the ak1a nodes
211 #
212 sub get_all_nodes
213 {
214         my $ref;
215         my @out;
216         foreach $ref (values %channels) {
217                 push @out, $ref if $ref->is_node;
218         }
219         return @out;
220 }
221
222 # return a list of all users
223 sub get_all_users
224 {
225         my $ref;
226         my @out;
227         foreach $ref (values %channels) {
228                 push @out, $ref if $ref->is_user;
229         }
230         return @out;
231 }
232
233 # return a list of all user callsigns
234 sub get_all_user_calls
235 {
236         my $ref;
237         my @out;
238         foreach $ref (values %channels) {
239                 push @out, $ref->{call} if $ref->is_user;
240         }
241         return @out;
242 }
243
244 # obtain a channel object by searching for its connection reference
245 sub get_by_cnum
246 {
247         my ($pkg, $conn) = @_;
248         my $self;
249   
250         foreach $self (values(%channels)) {
251                 return $self if ($self->{conn} == $conn);
252         }
253         return undef;
254 }
255
256 # get rid of a channel object [$obj->del()]
257 sub del
258 {
259         my $self = shift;
260
261         $self->{group} = undef;         # belt and braces
262         delete $channels{$self->{call}};
263 }
264
265 # is it a bbs
266 sub is_bbs
267 {
268         my $self = shift;
269         return $self->{'sort'} eq 'B';
270 }
271
272 sub is_node
273 {
274         my $self = shift;
275         return $self->{'sort'} =~ /[ACRSXW]/;
276 }
277 # is it an ak1a node ?
278 sub is_ak1a
279 {
280         my $self = shift;
281         return $self->{'sort'} eq 'A';
282 }
283
284 # is it a user?
285 sub is_user
286 {
287         my $self = shift;
288         return $self->{'sort'} eq 'U';
289 }
290
291 # is it a clx node
292 sub is_clx
293 {
294         my $self = shift;
295         return $self->{'sort'} eq 'C';
296 }
297
298 # it is Aranea
299 sub is_aranea
300 {
301         my $self = shift;
302         return $self->{'sort'} eq 'W';
303 }
304
305 # is it a spider node
306 sub is_spider
307 {
308         my $self = shift;
309         return $self->{'sort'} eq 'S';
310 }
311
312 # is it a DXNet node
313 sub is_dxnet
314 {
315         my $self = shift;
316         return $self->{'sort'} eq 'X';
317 }
318
319 # is it a ar-cluster node
320 sub is_arcluster
321 {
322         my $self = shift;
323         return $self->{'sort'} eq 'R';
324 }
325
326 # for perl 5.004's benefit
327 sub sort
328 {
329         my $self = shift;
330         return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
331 }
332
333 # find out whether we are prepared to believe this callsign on this interface
334 sub is_believed
335 {
336         my $self = shift;
337         my $call = shift;
338         
339         return grep $call eq $_, $self->user->believe;
340 }
341
342 # handle out going messages, immediately without waiting for the select to drop
343 # this could, in theory, block
344 sub send_now
345 {
346         my $self = shift;
347         my $conn = $self->{conn};
348         return unless $conn;
349         my $sort = shift;
350         my $call = $self->{call};
351         
352         for (@_) {
353 #               chomp;
354         my @lines = split /\n/;
355                 for (@lines) {
356                         $conn->send_now("$sort$call|$_");
357                         # debug log it, but not if it is a log message
358                         dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
359                 }
360         }
361         $self->{t} = time;
362 }
363
364 #
365 # send later with letter (more control)
366 #
367
368 sub send_later
369 {
370         my $self = shift;
371         my $conn = $self->{conn};
372         return unless $conn;
373         my $sort = shift;
374         my $call = $self->{call};
375         
376         for (@_) {
377 #               chomp;
378         my @lines = split /\n/;
379                 for (@lines) {
380                         $conn->send_later("$sort$call|$_");
381                         # debug log it, but not if it is a log message
382                         dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
383                 }
384         }
385         $self->{t} = time;
386 }
387
388 #
389 # the normal output routine
390 #
391 sub send                                                # this is always later and always data
392 {
393         my $self = shift;
394         my $conn = $self->{conn};
395         return unless $conn;
396         my $call = $self->{call};
397
398         foreach my $l (@_) {
399                 for (ref $l ? @$l : $l) {
400                         my @lines = split /\n/;
401                         for (@lines) {
402                                 $conn->send_later("D$call|$_");
403                                 dbg("-> D $call $_") if isdbg('chan');
404                         }
405                 }
406         }
407         $self->{t} = $main::systime;
408 }
409
410 # send a file (always later)
411 sub send_file
412 {
413         my ($self, $fn) = @_;
414         my $call = $self->{call};
415         my $conn = $self->{conn};
416         my @buf;
417   
418         open(F, $fn) or die "can't open $fn for sending file ($!)";
419         @buf = <F>;
420         close(F);
421         $self->send(@buf);
422 }
423
424 # this will implement language independence (in time)
425 sub msg
426 {
427         my $self = shift;
428         return DXM::msg($self->{lang}, @_);
429 }
430
431 # stick a broadcast on the delayed queue (but only up to 20 items)
432 sub delay
433 {
434         my $self = shift;
435         my $s = shift;
436         
437         $self->{delayed} = [] unless $self->{delayed};
438         push @{$self->{delayed}}, $s;
439         if (@{$self->{delayed}} >= 20) {
440                 shift @{$self->{delayed}};   # lose oldest one
441         }
442 }
443
444 # change the state of the channel - lots of scope for debugging here :-)
445 sub state
446 {
447         my $self = shift;
448         if (@_) {
449                 $self->{oldstate} = $self->{state};
450                 $self->{state} = shift;
451                 $self->{func} = '' unless defined $self->{func};
452                 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
453
454                 # if there is any queued up broadcasts then splurge them out here
455                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
456                         $self->send (@{$self->{delayed}});
457                         delete $self->{delayed};
458                 }
459         }
460         return $self->{state};
461 }
462
463 # disconnect this channel
464 sub disconnect
465 {
466         my $self = shift;
467         my $user = $self->{user};
468         
469         $user->close() if defined $user;
470         $self->{conn}->disconnect if $self->{conn};
471         $self->del();
472 }
473
474 #
475 # just close all the socket connections down without any fiddling about, cleaning, being
476 # nice to other processes and otherwise telling them what is going on.
477 #
478 # This is for the benefit of forked processes to prepare for starting new programs, they
479 # don't want or need all this baggage.
480 #
481
482 sub closeall
483 {
484         my $ref;
485         foreach $ref (values %channels) {
486                 $ref->{conn}->disconnect() if $ref->{conn};
487         }
488 }
489
490 #
491 # Tell all the users that we have come in or out (if they want to know)
492 #
493 sub tell_login
494 {
495         my ($self, $m, $call) = @_;
496         
497         $call ||= $self->{call};
498         
499         # send info to all logged in thingies
500         my @dxchan = get_all_users();
501         my $dxchan;
502         foreach $dxchan (@dxchan) {
503                 next if $dxchan == $self;
504                 next if $dxchan->{call} eq $main::mycall;
505                 $dxchan->send($dxchan->msg($m, $call)) if $dxchan->{logininfo};
506         }
507 }
508
509 #
510 # Tell all the users if a buddy is logged or out
511 #
512 sub tell_buddies
513 {
514         my ($self, $m, $call, $node) = @_;
515         
516         $call ||= $self->{call};
517         $call =~ s/-\d+$//;
518         $m .= 'n' if $node;
519         
520         # send info to all logged in thingies
521         my @dxchan = get_all_users();
522         my $dxchan;
523         foreach $dxchan (@dxchan) {
524                 next if $dxchan == $self;
525                 next if $dxchan->{call} eq $main::mycall;
526                 $dxchan->send($dxchan->msg($m, $call, $node)) if grep $_ eq $call, @{$dxchan->{user}->{buddies}} ;
527         }
528 }
529
530 # various access routines
531
532 #
533 # return a list of valid elements 
534
535
536 sub fields
537 {
538         return keys(%valid);
539 }
540
541 #
542 # return a prompt for a field
543 #
544
545 sub field_prompt
546
547         my ($self, $ele) = @_;
548         return $valid{$ele};
549 }
550
551 # take a standard input message and decode it into its standard parts
552 sub decode_input
553 {
554         my $dxchan = shift;
555         my $data = shift;
556         my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
557
558         my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
559         
560         # the above regexp must work
561         unless (defined $sort && defined $call && defined $line) {
562 #               $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
563                 dbg("DUFF Line on $chcall: $data");
564                 return ();
565         }
566
567         if(ref($dxchan) && $call ne $chcall) {
568                 dbg("DUFF Line come in for $call on wrong channel $chcall");
569                 return();
570         }
571         
572         return ($sort, $call, $line);
573 }
574
575 sub rspfcheck
576 {
577         my ($self, $flag, $node, $user) = @_;
578         my $nref = Route::Node::get($node);
579         my $dxchan = $nref->dxchan if $nref;
580         if ($nref && $dxchan) {
581             if ($dxchan == $self) {
582                         return 1 unless $user;
583                         return 1 if $user eq $node;
584                         my @users = $nref->users;
585                         return 1 if @users == 0 || grep $user eq $_, @users;
586                         dbg("RSPF: $user not on $node") if isdbg('chanerr');
587                 } else {
588                         dbg("RSPF: Shortest path for $node is " . $nref->dxchan->{call}) if isdbg('chanerr');
589                 }
590         } else {
591                 return 1 if $flag;
592                 dbg("RSPF: required $node not found" ) if isdbg('chanerr');
593         }
594         return 0;
595 }
596
597 # broadcast a message to all clusters taking into account isolation
598 # [except those mentioned after buffer]
599 sub broadcast_nodes
600 {
601         my $s = shift;                          # the line to be rebroadcast
602         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
603         my @dxchan = get_all_nodes();
604         my $dxchan;
605         
606         # send it if it isn't the except list and isn't isolated and still has a hop count
607         foreach $dxchan (@dxchan) {
608                 next if grep $dxchan == $_, @except;
609                 next if $dxchan == $main::me;
610                 
611                 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s;      # adjust its hop count by node name
612
613                 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
614         }
615 }
616
617 # broadcast a message to all clusters ignoring isolation
618 # [except those mentioned after buffer]
619 sub broadcast_all_nodes
620 {
621         my $s = shift;                          # the line to be rebroadcast
622         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
623         my @dxchan = get_all_nodes();
624         my $dxchan;
625         
626         # send it if it isn't the except list and isn't isolated and still has a hop count
627         foreach $dxchan (@dxchan) {
628                 next if grep $dxchan == $_, @except;
629                 next if $dxchan == $main::me;
630
631                 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s;      # adjust its hop count by node name
632                 $dxchan->send($routeit);
633         }
634 }
635
636 # broadcast to all users
637 # storing the spot or whatever until it is in a state to receive it
638 sub broadcast_users
639 {
640         my $s = shift;                          # the line to be rebroadcast
641         my $sort = shift;           # the type of transmission
642         my $fref = shift;           # a reference to an object to filter on
643         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
644         my @dxchan = get_all_users();
645         my $dxchan;
646         my @out;
647         
648         foreach $dxchan (@dxchan) {
649                 next if grep $dxchan == $_, @except;
650                 push @out, $dxchan;
651         }
652         broadcast_list($s, $sort, $fref, @out);
653 }
654
655
656 # broadcast to a list of users
657 sub broadcast_list
658 {
659         my $s = shift;
660         my $sort = shift;
661         my $fref = shift;
662         my $dxchan;
663         
664         foreach $dxchan (@_) {
665                 my $filter = 1;
666                 next if $dxchan == $main::me;
667                 
668                 if ($sort eq 'dx') {
669                     next unless $dxchan->{dx};
670                         ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
671                         next unless $filter;
672                 }
673                 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
674                 next if $sort eq 'wwv' && !$dxchan->{wwv};
675                 next if $sort eq 'wcy' && !$dxchan->{wcy};
676                 next if $sort eq 'wx' && !$dxchan->{wx};
677
678                 $s =~ s/\a//og unless $dxchan->{beep};
679
680                 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
681                         $dxchan->send($s);      
682                 } else {
683                         $dxchan->delay($s);
684                 }
685         }
686 }
687
688 sub process
689 {
690         foreach my $dxchan (get_all()) {
691
692                 while (my $data = shift @{$dxchan->{inqueue}}) {
693                         my ($sort, $call, $line) = $dxchan->decode_input($data);
694                         next unless defined $sort;
695
696                         # do the really sexy console interface bit! (Who is going to do the TK interface then?)
697                         dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
698                         if ($dxchan->{disconnecting}) {
699                                 dbg('In disconnection, ignored');
700                                 next;
701                         }
702
703                         # handle A records
704                         my $user = $dxchan->user;
705                         if ($sort eq 'A' || $sort eq 'O') {
706                                 $dxchan->start($line, $sort);
707                         } elsif ($sort eq 'I') {
708                                 die "\$user not defined for $call" if !defined $user;
709                         
710                                 # normal input
711                                 $dxchan->normal($line);
712                         } elsif ($sort eq 'Z') {
713                                 $dxchan->disconnect;
714                         } elsif ($sort eq 'D') {
715                                 ;                               # ignored (an echo)
716                         } elsif ($sort eq 'G') {
717                                 $dxchan->enhanced($line);
718                         } else {
719                                 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
720                         }
721                 }
722         }
723 }
724
725 sub handle_xml
726 {
727         my $self = shift;
728         my $r = 0;
729         
730         if (DXXml::available()) {
731                 $r = $self->{handle_xml} || 0;
732         } else {
733                 delete $self->{handle_xml} if exists $self->{handle_xml};
734         }
735         return $r;
736 }
737
738 #no strict;
739 sub AUTOLOAD
740 {
741         no strict;
742         my $name = $AUTOLOAD;
743         return if $name =~ /::DESTROY$/;
744         $name =~ s/^.*:://o;
745   
746         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
747
748         # this clever line of code creates a subroutine which takes over from autoload
749         # from OO Perl - Conway
750         *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
751         goto &$AUTOLOAD;
752 }
753
754
755 1;
756 __END__;