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