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 wcyfilter => '5,WCY Filt-out',
127 width => '0,Column Width',
128 wwvfilter => '5,WWV Filt-out',
131 $maxerrors = 20; # the maximum number of concurrent errors allowed before disconnection
138 if (ref($self->{$_})) {
142 dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
146 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
149 my ($pkg, $call, $conn, $user) = @_;
152 die "trying to create a duplicate channel for $call" if $channels{$call};
153 $self->{call} = $call;
155 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
157 $self->{user} = $user;
158 $self->{lang} = $user->lang;
159 $user->new_group unless $user->group;
160 $user->new_buddies unless $user->buddies;
161 $self->{group} = $user->group;
162 $self->{sort} = $user->sort;
163 $self->{width} = $user->width;
165 $self->{startt} = $self->{t} = $main::systime;
167 $self->{oldstate} = 0;
168 $self->{lang} = $main::lang if !$self->{lang};
170 $self->{width} ||= 80;
172 # add in all the dxcc, itu, zone info
173 my @dxcc = Prefix::extract($call);
175 $self->{dxcc} = $dxcc[1]->dxcc;
176 $self->{itu} = $dxcc[1]->itu;
177 $self->{cq} = $dxcc[1]->cq;
179 $self->{inqueue} = [];
182 dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
184 return $channels{$call} = $self;
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.
194 if (++$self->{errors} > $maxerrors) {
195 $self->send($self->msg('e26'));
199 return ($self->msg($e));
203 # rebless this channel as something else
208 return $channels{$self->{call}} = bless $self, $class;
213 my ($self, $msg) = @_;
215 # queue the message and the channel object for later processing
217 push @{$self->{inqueue}}, $msg;
222 # obtain a channel object by callsign [$obj = DXChannel::get($call)]
226 return $channels{$call};
229 # obtain all the channel objects
232 return values(%channels);
236 # gimme all the ak1a nodes
242 foreach $ref (values %channels) {
243 push @out, $ref if $ref->is_node;
248 # return a list of node calls
249 sub get_all_node_calls
253 foreach $ref (values %channels) {
254 push @out, $ref->{call} if $ref->is_node;
259 # return a list of all users
264 foreach $ref (values %channels) {
265 push @out, $ref if $ref->is_user;
270 # return a list of all user callsigns
271 sub get_all_user_calls
275 foreach $ref (values %channels) {
276 push @out, $ref->{call} if $ref->is_user;
281 # obtain a channel object by searching for its connection reference
284 my ($pkg, $conn) = @_;
287 foreach $self (values(%channels)) {
288 return $self if ($self->{conn} == $conn);
293 # get rid of a channel object [$obj->del()]
298 $self->{group} = undef; # belt and braces
299 delete $channels{$self->{call}};
305 return $_[0]->{sort} eq 'B';
310 return $_[0]->{sort} =~ /^[ACRSX]$/;
312 # is it an ak1a node ?
315 return $_[0]->{sort} eq 'A';
321 return $_[0]->{sort} =~ /^[UW]$/;
327 return $_[0]->{sort} eq 'C';
330 # it is a Web connected user
333 return $_[0]->{sort} eq 'W';
336 # is it a spider node
339 return $_[0]->{sort} eq 'S';
345 return $_[0]->{sort} eq 'X';
348 # is it a ar-cluster node
351 return $_[0]->{sort} eq 'R';
356 return $_[0]->{sort} eq 'N';
361 return $_[0]->{sort} eq 'L';
364 # for perl 5.004's benefit
368 return @_ ? $self->{sort} = shift : $self->{sort} ;
371 # find out whether we are prepared to believe this callsign on this interface
377 return grep $call eq $_, $self->user->believe;
380 # handle out going messages, immediately without waiting for the select to drop
381 # this could, in theory, block
385 my $conn = $self->{conn};
388 my $call = $self->{call};
392 my @lines = split /\n/;
394 $conn->send_now("$sort$call|$_");
395 # debug log it, but not if it is a log message
396 dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
403 # send later with letter (more control)
409 my $conn = $self->{conn};
412 my $call = $self->{call};
416 my @lines = split /\n/;
418 $conn->send_later("$sort$call|$_");
419 # debug log it, but not if it is a log message
420 dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
427 # the normal output routine
429 sub send # this is always later and always data
432 my $conn = $self->{conn};
434 my $call = $self->{call};
437 for (ref $l ? @$l : $l) {
438 my @lines = split /\n/;
440 $conn->send_later("D$call|$_");
441 dbg("-> D $call $_") if isdbg('chan');
445 $self->{t} = $main::systime;
448 # send a file (always later)
451 my ($self, $fn) = @_;
452 my $call = $self->{call};
453 my $conn = $self->{conn};
456 open(F, $fn) or die "can't open $fn for sending file ($!)";
462 # this will implement language independence (in time)
466 return DXM::msg($self->{lang}, @_);
469 # stick a broadcast on the delayed queue (but only up to 20 items)
475 $self->{delayed} = [] unless $self->{delayed};
476 push @{$self->{delayed}}, $s;
477 if (@{$self->{delayed}} >= 20) {
478 shift @{$self->{delayed}}; # lose oldest one
482 # change the state of the channel - lots of scope for debugging here :-)
487 $self->{oldstate} = $self->{state};
488 $self->{state} = shift;
489 $self->{func} = '' unless defined $self->{func};
490 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
492 # if there is any queued up broadcasts then splurge them out here
493 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
494 $self->send (@{$self->{delayed}});
495 delete $self->{delayed};
498 return $self->{state};
501 # disconnect this channel
505 my $user = $self->{user};
507 $user->close($self->{startt}, $self->{hostname}) if defined $user;
508 $self->{conn}->disconnect if $self->{conn};
513 # just close all the socket connections down without any fiddling about, cleaning, being
514 # nice to other processes and otherwise telling them what is going on.
516 # This is for the benefit of forked processes to prepare for starting new programs, they
517 # don't want or need all this baggage.
523 foreach $ref (values %channels) {
524 $ref->{conn}->disconnect() if $ref->{conn};
529 # Tell all the users that we have come in or out (if they want to know)
533 my ($self, $m, $call) = @_;
535 $call ||= $self->{call};
537 # send info to all logged in thingies
538 my @dxchan = get_all_users();
540 foreach $dxchan (@dxchan) {
541 next if $dxchan == $self;
542 next if $dxchan->{call} eq $main::mycall;
543 $dxchan->send($dxchan->msg($m, $call)) if $dxchan->{logininfo};
548 # Tell all the users if a buddy is logged or out
552 my ($self, $m, $call, $node) = @_;
554 $call ||= $self->{call};
558 # send info to all logged in thingies
559 my @dxchan = get_all_users();
561 foreach $dxchan (@dxchan) {
562 next if $dxchan == $self;
563 next if $dxchan->{call} eq $main::mycall;
564 $dxchan->send($dxchan->msg($m, $call, $node)) if grep $_ eq $call, @{$dxchan->{user}->{buddies}} ;
568 # various access routines
571 # return a list of valid elements
580 # return a prompt for a field
585 my ($self, $ele) = @_;
589 # take a standard input message and decode it into its standard parts
594 my ($sort, $call, $line) = $data =~ /^([A-Z])(#?[A-Z0-9\/\-]{3,25})\|(.*)$/;
596 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
598 # the above regexp must work
599 unless (defined $sort && defined $call && defined $line) {
600 # $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
601 dbg("DUFF Line on $chcall: $data");
605 if(ref($dxchan) && $call ne $chcall) {
606 dbg("DUFF Line come in for $call on wrong channel $chcall");
610 return ($sort, $call, $line);
613 # broadcast a message to all clusters taking into account isolation
614 # [except those mentioned after buffer]
617 my $s = shift; # the line to be rebroadcast
618 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
619 my @dxchan = get_all_nodes();
622 # send it if it isn't the except list and isn't isolated and still has a hop count
623 foreach $dxchan (@dxchan) {
624 next if grep $dxchan == $_, @except;
625 next if $dxchan == $main::me;
627 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
629 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
633 # broadcast a message to all clusters ignoring isolation
634 # [except those mentioned after buffer]
635 sub broadcast_all_nodes
637 my $s = shift; # the line to be rebroadcast
638 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
639 my @dxchan = get_all_nodes();
642 # send it if it isn't the except list and isn't isolated and still has a hop count
643 foreach $dxchan (@dxchan) {
644 next if grep $dxchan == $_, @except;
645 next if $dxchan == $main::me;
647 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
648 $dxchan->send($routeit);
652 # broadcast to all users
653 # storing the spot or whatever until it is in a state to receive it
656 my $s = shift; # the line to be rebroadcast
657 my $sort = shift; # the type of transmission
658 my $fref = shift; # a reference to an object to filter on
659 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
660 my @dxchan = get_all_users();
664 foreach $dxchan (@dxchan) {
665 next if grep $dxchan == $_, @except;
668 broadcast_list($s, $sort, $fref, @out);
672 # broadcast to a list of users
680 foreach $dxchan (@_) {
682 next if $dxchan == $main::me;
685 next unless $dxchan->{dx};
686 ($filter) = $dxchan->{spotsfilter}->it($fref) if $dxchan->{spotsfilter} && ref $fref;
689 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
690 next if $sort eq 'wwv' && !$dxchan->{wwv};
691 next if $sort eq 'wcy' && !$dxchan->{wcy};
692 next if $sort eq 'wx' && !$dxchan->{wx};
694 $s =~ s/\a//og unless $dxchan->{beep};
696 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
708 while (my $data = shift @{$self->{inqueue}}) {
709 my ($sort, $call, $line) = $self->decode_input($data);
710 next unless defined $sort;
712 # do the really sexy console interface bit! (Who is going to do the TK interface then?)
713 dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
716 my $user = $self->user;
718 die "\$user not defined for $call" unless defined $user;
721 $self->normal($line);
722 } elsif ($sort eq 'G') {
723 $self->enhanced($line);
724 } elsif ($sort eq 'A' || $sort eq 'O' || $sort eq 'W') {
725 $self->start($line, $sort);
726 } elsif ($sort eq 'C') {
727 $self->width($line); # change number of columns
728 } elsif ($sort eq 'Z') {
730 } elsif ($sort eq 'D') {
731 ; # ignored (an echo)
733 dbg atime . " DXChannel::process_one: Unknown command letter ($sort) received from $call\n";
740 foreach my $dxchan (values %channels) {
741 next if $dxchan->{disconnecting};
742 $dxchan->process_one;
751 if (DXXml::available()) {
752 $r = $self->{handle_xml} || 0;
754 delete $self->{handle_xml} if exists $self->{handle_xml};
762 my $error = shift || '';
763 dbg("$self->{call} ERROR '$error', closing") if isdbg('chan');
764 $self->{conn}->set_error(undef) if exists $self->{conn};
765 $self->disconnect(1);
773 # the sysop is registered!
774 return 1 if $self->{call} eq $main::myalias || $self->{call} eq $main::mycall;
777 return $self->{registered};
787 my $name = $AUTOLOAD;
788 return if $name =~ /::DESTROY$/;
791 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
793 # this clever line of code creates a subroutine which takes over from autoload
794 # from OO Perl - Conway
795 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};