2 # module to manage channel lists & data
4 # This is the base class for all channel operations, which is everything to do
5 # with input and output really.
7 # The instance variable in the outside world will be generally be called $dxchan
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.
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)
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).
22 # Copyright (c) 1998-2016 - Dirk Koopman G1TLH
38 use vars qw(%channels %valid @ISA $count $maxerrors);
44 'sort' => '5,Type of Channel',
45 ann => '0,Want Announce,yesno',
46 ann_talk => '0,Suppress Talk Anns,yesno',
47 annfilter => '5,Ann Filt-out',
48 badcount => '1,Bad Word Count',
49 badip => '9,BAD IP address',
50 beep => '0,Want Beeps,yesno',
51 build => '1,Node Build',
53 cluster => '5,Cluster data',
54 conf => '0,In Conference?,yesno',
55 conn => '9,Msg Conn ref',
56 consort => '5,Connection Type',
58 delayed => '5,Delayed messages,parray',
59 disconnecting => '9,Disconnecting,yesno',
60 do_pc9x => '9,Handles PC9x,yesno',
61 dx => '0,DX Spots,yesno',
62 dxcc => '0,Country Code',
63 edit => '7,Edit Function',
64 enhanced => '5,Enhanced Client,yesno',
67 group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
68 handle_xml => '9,Handles XML,yesno',
69 here => '0,Here?,yesno',
70 hostname => '0,Hostname',
71 inannfilter => '5,Ann Filt-inp',
72 inpc92filter => '5,PC92 Route Filt-inp',
73 inqueue => '9,Input Queue,parray',
74 inrbnfilter => '5,RBN Filt-inp',
75 inroutefilter => '5,Route Filt-inp',
76 inscript => '9,In a script,yesno',
77 inspotsfilter => '5,Spot Filt-inp',
78 inwcyfilter => '5,WCY Filt-inp',
79 inwwvfilter => '5,WWV Filt-inp',
80 isolate => '5,Isolate network,yesno',
81 isslugged => '9,Still Slugged,yesno',
84 lastmsgpoll => '0,Last Msg Poll,atime',
85 lastping => '5,Ping last sent,atime',
86 lastread => '5,Last Msg Read',
87 list => '9,Dep Chan List',
88 loc => '9,Local Vars', # used by func to store local variables in
89 logininfo => '9,Login info req,yesno',
90 metric => '1,Route metric',
91 name => '0,User Name',
92 newroute => '1,New Style Routing,yesno',
93 next_pc92_keepalive => '9,Next PC92 KeepAlive,atime',
94 next_pc92_update => '9,Next PC92 Update,atime',
95 nopings => '5,Ping Obs Count',
96 oldstate => '5,Last State',
97 outbound => '5,outbound?,yesno',
98 pagedata => '9,Page Data Store',
99 pagelth => '0,Page Length',
100 passwd => '9,Passwd List,yesno',
101 pc50_t => '5,Last PC50 Time,atime',
102 pc92filter => '5,PC92 Route Filt-out',
103 pingave => '0,Ping ave time',
104 pingint => '5,Ping Interval ',
105 pingtime => '5,Ping totaltime,parray',
106 priv => '9,Privilege',
107 prompt => '0,Required Prompt',
108 rbnfilter => '5,RBN Filt-out',
109 redirect => '0,Redirect messages to',
110 registered => '9,Registered?,yesno',
111 remotecmd => '9,doing rcmd,yesno',
112 route => '9,Route Data',
113 routefilter => '5,Route Filt-out',
114 senddbg => '8,Sending Debug,yesno',
115 sluggedpcs => '9,Slugged PCxx Queue,parray',
116 spotsfilter => '5,Spot Filt-out',
117 startt => '0,Start Time,atime',
118 state => '0,Current State',
120 talk => '0,Want Talk,yesno',
121 talklist => '0,Talk List,parray',
122 user => '9,DXUser ref',
123 ve7cc => '0,VE7CC program special,yesno',
124 verified => '9,Verified?,yesno',
125 version => '1,Node Version',
126 wcy => '0,Want WCY,yesno',
127 wcyfilter => '5,WCY Filt-out',
128 width => '0,Column Width',
129 wwv => '0,Want WWV,yesno',
130 wwvfilter => '5,WWV Filt-out',
131 wx => '0,Want WX,yesno',
134 $maxerrors = 20; # the maximum number of concurrent errors allowed before disconnection
141 if (ref($self->{$_})) {
145 dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
149 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
152 my ($pkg, $call, $conn, $user) = @_;
155 die "trying to create a duplicate channel for $call" if $channels{$call};
156 $self->{call} = $call;
158 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
160 $self->{user} = $user;
161 $self->{lang} = $user->lang;
162 $user->new_group unless $user->group;
163 $user->new_buddies unless $user->buddies;
164 $self->{group} = $user->group;
165 $self->{sort} = $user->sort;
166 $self->{width} = $user->width;
168 $self->{startt} = $self->{t} = $main::systime;
170 $self->{oldstate} = 0;
171 $self->{lang} = $main::lang if !$self->{lang};
173 $self->{width} ||= 80;
175 # add in all the dxcc, itu, zone info
176 my @dxcc = Prefix::extract($call);
178 $self->{dxcc} = $dxcc[1]->dxcc;
179 $self->{itu} = $dxcc[1]->itu;
180 $self->{cq} = $dxcc[1]->cq;
182 $self->{inqueue} = [];
185 dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
187 return $channels{$call} = $self;
190 # count errors and disconnect if too many
191 # this has to be here because it can come from rcmd (DXProt) as
192 # well as DXCommandmode.
197 if (++$self->{errors} > $maxerrors) {
198 $self->send($self->msg('e26'));
202 return ($self->msg($e));
206 # rebless this channel as something else
211 return $channels{$self->{call}} = bless $self, $class;
216 my ($self, $msg) = @_;
218 # queue the message and the channel object for later processing
220 push @{$self->{inqueue}}, $msg;
225 # obtain a channel object by callsign [$obj = DXChannel::get($call)]
229 return $channels{$call};
232 # obtain all the channel objects
235 return values(%channels);
239 # gimme all the ak1a nodes
245 foreach $ref (values %channels) {
246 push @out, $ref if $ref->is_node;
251 # return a list of node calls
252 sub get_all_node_calls
256 foreach $ref (values %channels) {
257 push @out, $ref->{call} if $ref->is_node;
262 # return a list of all users
267 foreach $ref (values %channels) {
268 push @out, $ref if $ref->is_user;
273 # return a list of all user callsigns
274 sub get_all_user_calls
278 foreach $ref (values %channels) {
279 push @out, $ref->{call} if $ref->is_user;
284 # obtain a channel object by searching for its connection reference
287 my ($pkg, $conn) = @_;
290 foreach $self (values(%channels)) {
291 return $self if ($self->{conn} == $conn);
296 # get rid of a channel object [$obj->del()]
301 $self->{group} = undef; # belt and braces
302 delete $channels{$self->{call}};
308 return $_[0]->{sort} eq 'B';
313 return $_[0]->{sort} =~ /^[ACRSX]$/;
315 # is it an ak1a node ?
318 return $_[0]->{sort} eq 'A';
324 return $_[0]->{sort} =~ /^[UW]$/;
330 return $_[0]->{sort} eq 'C';
333 # it is a Web connected user
336 return $_[0]->{sort} eq 'W';
339 # is it a spider node
342 return $_[0]->{sort} eq 'S';
348 return $_[0]->{sort} eq 'X';
351 # is it a ar-cluster node
354 return $_[0]->{sort} eq 'R';
359 return $_[0]->{sort} eq 'N';
364 return $_[0]->{sort} eq 'L';
367 # for perl 5.004's benefit
371 return @_ ? $self->{sort} = shift : $self->{sort} ;
374 # find out whether we are prepared to believe this callsign on this interface
380 return grep $call eq $_, $self->user->believe;
383 # handle out going messages, immediately without waiting for the select to drop
384 # this could, in theory, block
388 my $conn = $self->{conn};
391 my $call = $self->{call};
395 my @lines = split /\n/;
397 $conn->send_now("$sort$call|$_");
398 # debug log it, but not if it is a log message
399 dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
406 # send later with letter (more control)
412 my $conn = $self->{conn};
415 my $call = $self->{call};
419 my @lines = split /\n/;
421 $conn->send_later("$sort$call|$_");
422 # debug log it, but not if it is a log message
423 dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
430 # the normal output routine
432 sub send # this is always later and always data
435 my $conn = $self->{conn};
437 my $call = $self->{call};
440 for (ref $l ? @$l : $l) {
441 my @lines = split /\n/;
443 $conn->send_later("D$call|$_");
444 dbg("-> D $call $_") if isdbg('chan');
448 $self->{t} = $main::systime;
451 # send a file (always later)
454 my ($self, $fn) = @_;
455 my $call = $self->{call};
456 my $conn = $self->{conn};
459 open(F, $fn) or die "can't open $fn for sending file ($!)";
465 # this will implement language independence (in time)
469 return DXM::msg($self->{lang}, @_);
472 # stick a broadcast on the delayed queue (but only up to 20 items)
478 $self->{delayed} = [] unless $self->{delayed};
479 push @{$self->{delayed}}, $s;
480 if (@{$self->{delayed}} >= 20) {
481 shift @{$self->{delayed}}; # lose oldest one
485 # change the state of the channel - lots of scope for debugging here :-)
490 $self->{oldstate} = $self->{state};
491 $self->{state} = shift;
492 $self->{func} = '' unless defined $self->{func};
493 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
495 # if there is any queued up broadcasts then splurge them out here
496 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
497 $self->send (@{$self->{delayed}});
498 delete $self->{delayed};
501 return $self->{state};
504 # disconnect this channel
508 my $user = $self->{user};
510 $user->close($self->{startt}, $self->{hostname}) if defined $user;
511 $self->{conn}->disconnect if $self->{conn};
516 # just close all the socket connections down without any fiddling about, cleaning, being
517 # nice to other processes and otherwise telling them what is going on.
519 # This is for the benefit of forked processes to prepare for starting new programs, they
520 # don't want or need all this baggage.
526 foreach $ref (values %channels) {
527 $ref->{conn}->disconnect() if $ref->{conn};
532 # Tell all the users that we have come in or out (if they want to know)
536 my ($self, $m, $call) = @_;
538 $call ||= $self->{call};
540 # send info to all logged in thingies
541 my @dxchan = get_all_users();
543 foreach $dxchan (@dxchan) {
544 next if $dxchan == $self;
545 next if $dxchan->{call} eq $main::mycall;
546 $dxchan->send($dxchan->msg($m, $call)) if $dxchan->{logininfo};
551 # Tell all the users if a buddy is logged or out
555 my ($self, $m, $call, $node) = @_;
557 $call ||= $self->{call};
561 # send info to all logged in thingies
562 my @dxchan = get_all_users();
564 foreach $dxchan (@dxchan) {
565 next if $dxchan == $self;
566 next if $dxchan->{call} eq $main::mycall;
567 $dxchan->send($dxchan->msg($m, $call, $node)) if grep $_ eq $call, @{$dxchan->{user}->{buddies}} ;
571 # various access routines
574 # return a list of valid elements
583 # return a prompt for a field
588 my ($self, $ele) = @_;
592 # take a standard input message and decode it into its standard parts
597 my ($sort, $call, $line) = $data =~ /^([A-Z])(#?[A-Z0-9\/\-]{3,25})\|(.*)$/;
599 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
601 # the above regexp must work
602 unless (defined $sort && defined $call && defined $line) {
603 # $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
604 dbg("DUFF Line on $chcall: $data");
608 if(ref($dxchan) && $call ne $chcall) {
609 dbg("DUFF Line come in for $call on wrong channel $chcall");
613 return ($sort, $call, $line);
616 # broadcast a message to all clusters taking into account isolation
617 # [except those mentioned after buffer]
620 my $s = shift; # the line to be rebroadcast
621 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
622 my @dxchan = get_all_nodes();
625 # send it if it isn't the except list and isn't isolated and still has a hop count
626 foreach $dxchan (@dxchan) {
627 next if grep $dxchan == $_, @except;
628 next if $dxchan == $main::me;
630 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
632 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
636 # broadcast a message to all clusters ignoring isolation
637 # [except those mentioned after buffer]
638 sub broadcast_all_nodes
640 my $s = shift; # the line to be rebroadcast
641 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
642 my @dxchan = get_all_nodes();
645 # send it if it isn't the except list and isn't isolated and still has a hop count
646 foreach $dxchan (@dxchan) {
647 next if grep $dxchan == $_, @except;
648 next if $dxchan == $main::me;
650 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
651 $dxchan->send($routeit);
655 # broadcast to all users
656 # storing the spot or whatever until it is in a state to receive it
659 my $s = shift; # the line to be rebroadcast
660 my $sort = shift; # the type of transmission
661 my $fref = shift; # a reference to an object to filter on
662 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
663 my @dxchan = get_all_users();
667 foreach $dxchan (@dxchan) {
668 next if grep $dxchan == $_, @except;
671 broadcast_list($s, $sort, $fref, @out);
675 # broadcast to a list of users
683 foreach $dxchan (@_) {
685 next if $dxchan == $main::me;
688 next unless $dxchan->{dx};
689 ($filter) = $dxchan->{spotsfilter}->it($fref) if $dxchan->{spotsfilter} && ref $fref;
692 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
693 next if $sort eq 'wwv' && !$dxchan->{wwv};
694 next if $sort eq 'wcy' && !$dxchan->{wcy};
695 next if $sort eq 'wx' && !$dxchan->{wx};
697 $s =~ s/\a//og unless $dxchan->{beep};
699 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
711 while (my $data = shift @{$self->{inqueue}}) {
712 my ($sort, $call, $line) = $self->decode_input($data);
713 next unless defined $sort;
715 # do the really sexy console interface bit! (Who is going to do the TK interface then?)
716 dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
719 my $user = $self->user;
721 die "\$user not defined for $call" unless defined $user;
724 $self->normal($line);
725 } elsif ($sort eq 'G') {
726 $self->enhanced($line);
727 } elsif ($sort eq 'A' || $sort eq 'O' || $sort eq 'W') {
728 $self->start($line, $sort);
729 } elsif ($sort eq 'C') {
730 $self->width($line); # change number of columns
731 } elsif ($sort eq 'Z') {
733 } elsif ($sort eq 'D') {
734 ; # ignored (an echo)
736 dbg atime . " DXChannel::process_one: Unknown command letter ($sort) received from $call\n";
743 foreach my $dxchan (values %channels) {
744 next if $dxchan->{disconnecting};
745 $dxchan->process_one;
754 if (DXXml::available()) {
755 $r = $self->{handle_xml} || 0;
757 delete $self->{handle_xml} if exists $self->{handle_xml};
765 my $error = shift || '';
766 dbg("$self->{call} ERROR '$error', closing") if isdbg('chan');
767 $self->{conn}->set_error(undef) if exists $self->{conn};
768 $self->disconnect(1);
776 # the sysop is registered!
777 return 1 if $self->{call} eq $main::myalias || $self->{call} eq $main::mycall;
780 return $self->{registered};
790 my $name = $AUTOLOAD;
791 return if $name =~ /::DESTROY$/;
794 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
796 # this clever line of code creates a subroutine which takes over from autoload
797 # from OO Perl - Conway
798 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};