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