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-2000 - Dirk Koopman G1TLH
38 use vars qw(%channels %valid @ISA $count $maxerrors);
45 conn => '9,Msg Conn ref',
46 user => '9,DXUser ref',
47 startt => '0,Start 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',
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',
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',
130 $maxerrors = 20; # the maximum number of concurrent errors allowed before disconnection
137 if (ref($self->{$_})) {
141 dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
145 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
148 my ($pkg, $call, $conn, $user) = @_;
151 die "trying to create a duplicate channel for $call" if $channels{$call};
152 $self->{call} = $call;
154 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
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;
164 $self->{startt} = $self->{t} = time;
166 $self->{oldstate} = 0;
167 $self->{lang} = $main::lang if !$self->{lang};
169 $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;
221 # obtain a channel object by callsign [$obj = DXChannel::get($call)]
225 return $channels{$call};
228 # obtain all the channel objects
231 return values(%channels);
235 # gimme all the ak1a nodes
241 foreach $ref (values %channels) {
242 push @out, $ref if $ref->is_node;
247 # return a list of node calls
248 sub get_all_node_calls
252 foreach $ref (values %channels) {
253 push @out, $ref->{call} if $ref->is_node;
258 # return a list of all users
263 foreach $ref (values %channels) {
264 push @out, $ref if $ref->is_user;
269 # return a list of all user callsigns
270 sub get_all_user_calls
274 foreach $ref (values %channels) {
275 push @out, $ref->{call} if $ref->is_user;
280 # obtain a channel object by searching for its connection reference
283 my ($pkg, $conn) = @_;
286 foreach $self (values(%channels)) {
287 return $self if ($self->{conn} == $conn);
292 # get rid of a channel object [$obj->del()]
297 $self->{group} = undef; # belt and braces
298 delete $channels{$self->{call}};
305 return $self->{'sort'} eq 'B';
311 return $self->{'sort'} =~ /[ACRSXW]/;
313 # is it an ak1a node ?
317 return $self->{'sort'} eq 'A';
324 return $self->{'sort'} eq 'U';
331 return $self->{'sort'} eq 'C';
338 return $self->{'sort'} eq 'W';
341 # is it a spider node
345 return $self->{'sort'} eq 'S';
352 return $self->{'sort'} eq 'X';
355 # is it a ar-cluster node
359 return $self->{'sort'} eq 'R';
362 # for perl 5.004's benefit
366 return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
369 # find out whether we are prepared to believe this callsign on this interface
375 return grep $call eq $_, $self->user->believe;
378 # handle out going messages, immediately without waiting for the select to drop
379 # this could, in theory, block
383 my $conn = $self->{conn};
386 my $call = $self->{call};
390 my @lines = split /\n/;
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');
401 # send later with letter (more control)
407 my $conn = $self->{conn};
410 my $call = $self->{call};
414 my @lines = split /\n/;
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');
425 # the normal output routine
427 sub send # this is always later and always data
430 my $conn = $self->{conn};
432 my $call = $self->{call};
435 for (ref $l ? @$l : $l) {
436 my @lines = split /\n/;
438 $conn->send_later("D$call|$_");
439 dbg("-> D $call $_") if isdbg('chan');
443 $self->{t} = $main::systime;
446 # send a file (always later)
449 my ($self, $fn) = @_;
450 my $call = $self->{call};
451 my $conn = $self->{conn};
454 open(F, $fn) or die "can't open $fn for sending file ($!)";
460 # this will implement language independence (in time)
464 return DXM::msg($self->{lang}, @_);
467 # stick a broadcast on the delayed queue (but only up to 20 items)
473 $self->{delayed} = [] unless $self->{delayed};
474 push @{$self->{delayed}}, $s;
475 if (@{$self->{delayed}} >= 20) {
476 shift @{$self->{delayed}}; # lose oldest one
480 # change the state of the channel - lots of scope for debugging here :-)
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');
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};
496 return $self->{state};
499 # disconnect this channel
503 my $user = $self->{user};
505 $user->close() if defined $user;
506 $self->{conn}->disconnect if $self->{conn};
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.
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.
521 foreach $ref (values %channels) {
522 $ref->{conn}->disconnect() if $ref->{conn};
527 # Tell all the users that we have come in or out (if they want to know)
531 my ($self, $m, $call) = @_;
533 $call ||= $self->{call};
535 # send info to all logged in thingies
536 my @dxchan = get_all_users();
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};
546 # Tell all the users if a buddy is logged or out
550 my ($self, $m, $call, $node) = @_;
552 $call ||= $self->{call};
556 # send info to all logged in thingies
557 my @dxchan = get_all_users();
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}} ;
566 # various access routines
569 # return a list of valid elements
578 # return a prompt for a field
583 my ($self, $ele) = @_;
587 # take a standard input message and decode it into its standard parts
592 my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
594 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
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");
603 if(ref($dxchan) && $call ne $chcall) {
604 dbg("DUFF Line come in for $call on wrong channel $chcall");
608 return ($sort, $call, $line);
611 # broadcast a message to all clusters taking into account isolation
612 # [except those mentioned after buffer]
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();
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;
625 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
627 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
631 # broadcast a message to all clusters ignoring isolation
632 # [except those mentioned after buffer]
633 sub broadcast_all_nodes
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();
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;
645 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
646 $dxchan->send($routeit);
650 # broadcast to all users
651 # storing the spot or whatever until it is in a state to receive it
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();
662 foreach $dxchan (@dxchan) {
663 next if grep $dxchan == $_, @except;
666 broadcast_list($s, $sort, $fref, @out);
670 # broadcast to a list of users
678 foreach $dxchan (@_) {
680 next if $dxchan == $main::me;
683 next unless $dxchan->{dx};
684 ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
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};
692 $s =~ s/\a//og unless $dxchan->{beep};
694 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
704 foreach my $dxchan (get_all()) {
705 next if $dxchan->{disconnecting};
707 while (my $data = shift @{$dxchan->{inqueue}}) {
708 my ($sort, $call, $line) = $dxchan->decode_input($data);
709 next unless defined $sort;
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');
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;
722 $dxchan->normal($line);
723 } elsif ($sort eq 'Z') {
725 } elsif ($sort eq 'D') {
726 ; # ignored (an echo)
727 } elsif ($sort eq 'G') {
728 $dxchan->enhanced($line);
730 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
741 if (DXXml::available()) {
742 $r = $self->{handle_xml} || 0;
744 delete $self->{handle_xml} if exists $self->{handle_xml};
753 my $name = $AUTOLOAD;
754 return if $name =~ /::DESTROY$/;
757 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
759 # this clever line of code creates a subroutine which takes over from autoload
760 # from OO Perl - Conway
761 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};