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