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