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);
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 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',
99 route => '9,Route Data',
100 dxcc => '0,Country Code',
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',
118 use vars qw($VERSION $BRANCH);
119 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
120 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
121 $main::build += $VERSION;
122 $main::branch += $BRANCH;
129 if (ref($self->{$_})) {
133 dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
137 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
140 my ($pkg, $call, $conn, $user) = @_;
143 die "trying to create a duplicate channel for $call" if $channels{$call};
144 $self->{call} = $call;
146 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
148 $self->{user} = $user;
149 $self->{lang} = $user->lang;
150 $user->new_group() if !$user->group;
151 $self->{group} = $user->group;
152 $self->{sort} = $user->sort;
154 $self->{startt} = $self->{t} = time;
156 $self->{oldstate} = 0;
157 $self->{lang} = $main::lang if !$self->{lang};
160 # add in all the dxcc, itu, zone info
161 my @dxcc = Prefix::extract($call);
163 $self->{dxcc} = $dxcc[1]->dxcc;
164 $self->{itu} = $dxcc[1]->itu;
165 $self->{cq} = $dxcc[1]->cq;
169 dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
171 return $channels{$call} = $self;
174 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
177 my ($pkg, $call) = @_;
178 return $channels{$call};
181 # obtain all the channel objects
185 return values(%channels);
189 # gimme all the ak1a nodes
195 foreach $ref (values %channels) {
196 push @out, $ref if $ref->is_node;
201 # return a list of all users
206 foreach $ref (values %channels) {
207 push @out, $ref if $ref->is_user;
212 # return a list of all user callsigns
213 sub get_all_user_calls
217 foreach $ref (values %channels) {
218 push @out, $ref->{call} if $ref->is_user;
223 # obtain a channel object by searching for its connection reference
226 my ($pkg, $conn) = @_;
229 foreach $self (values(%channels)) {
230 return $self if ($self->{conn} == $conn);
235 # get rid of a channel object [$obj->del()]
240 $self->{group} = undef; # belt and braces
241 delete $channels{$self->{call}};
248 return $self->{'sort'} eq 'B';
254 return $self->{'sort'} =~ /[ACRSX]/;
256 # is it an ak1a node ?
260 return $self->{'sort'} eq 'A';
267 return $self->{'sort'} eq 'U';
274 return $self->{'sort'} eq 'C';
277 # is it a spider node
281 return $self->{'sort'} eq 'S';
288 return $self->{'sort'} eq 'X';
291 # is it a ar-cluster node
295 return $self->{'sort'} eq 'R';
298 # for perl 5.004's benefit
302 return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
305 # handle out going messages, immediately without waiting for the select to drop
306 # this could, in theory, block
310 my $conn = $self->{conn};
313 my $call = $self->{call};
317 my @lines = split /\n/;
319 $conn->send_now("$sort$call|$_");
320 dbg("-> $sort $call $_") if isdbg('chan');
327 # send later with letter (more control)
333 my $conn = $self->{conn};
336 my $call = $self->{call};
340 my @lines = split /\n/;
342 $conn->send_later("$sort$call|$_");
343 dbg("-> $sort $call $_") if isdbg('chan');
350 # the normal output routine
352 sub send # this is always later and always data
355 my $conn = $self->{conn};
357 my $call = $self->{call};
361 my @lines = split /\n/;
363 $conn->send_later("D$call|$_");
364 dbg("-> D $call $_") if isdbg('chan');
370 # send a file (always later)
373 my ($self, $fn) = @_;
374 my $call = $self->{call};
375 my $conn = $self->{conn};
378 open(F, $fn) or die "can't open $fn for sending file ($!)";
384 # this will implement language independence (in time)
388 return DXM::msg($self->{lang}, @_);
391 # stick a broadcast on the delayed queue (but only up to 20 items)
397 $self->{delayed} = [] unless $self->{delayed};
398 push @{$self->{delayed}}, $s;
399 if (@{$self->{delayed}} >= 20) {
400 shift @{$self->{delayed}}; # lose oldest one
404 # change the state of the channel - lots of scope for debugging here :-)
409 $self->{oldstate} = $self->{state};
410 $self->{state} = shift;
411 $self->{func} = '' unless defined $self->{func};
412 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
414 # if there is any queued up broadcasts then splurge them out here
415 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
416 $self->send (@{$self->{delayed}});
417 delete $self->{delayed};
420 return $self->{state};
423 # disconnect this channel
427 my $user = $self->{user};
429 main::clean_inqueue($self); # clear out any remaining incoming frames
430 $user->close() if defined $user;
431 $self->{conn}->disconnect;
436 # just close all the socket connections down without any fiddling about, cleaning, being
437 # nice to other processes and otherwise telling them what is going on.
439 # This is for the benefit of forked processes to prepare for starting new programs, they
440 # don't want or need all this baggage.
446 foreach $ref (values %channels) {
447 $ref->{conn}->disconnect() if $ref->{conn};
452 # Tell all the users that we have come in or out (if they want to know)
458 # send info to all logged in thingies
459 my @dxchan = get_all_users();
461 foreach $dxchan (@dxchan) {
462 next if $dxchan == $self;
463 next if $dxchan->{call} eq $main::mycall;
464 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
468 # various access routines
471 # return a list of valid elements
480 # return a prompt for a field
485 my ($self, $ele) = @_;
489 # take a standard input message and decode it into its standard parts
494 my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
496 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
498 # the above regexp must work
499 unless (defined $sort && defined $call && defined $line) {
500 # $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
501 dbg("DUFF Line on $chcall: $data");
505 if(ref($dxchan) && $call ne $chcall) {
506 dbg("DUFF Line come in for $call on wrong channel $chcall");
510 return ($sort, $call, $line);
515 my ($self, $flag, $node, $user) = @_;
516 my $nref = Route::Node::get($node);
517 my $dxchan = $nref->dxchan if $nref;
518 if ($nref && $dxchan) {
519 if ($dxchan == $self) {
520 return 1 unless $user;
521 return 1 if $user eq $node;
522 my @users = $nref->users;
523 return 1 if @users == 0 || grep $user eq $_, @users;
524 dbg("RSPF: $user not on $node") if isdbg('chanerr');
526 dbg("RSPF: Shortest path for $node is " . $nref->dxchan->{call}) if isdbg('chanerr');
530 dbg("RSPF: required $node not found" ) if isdbg('chanerr');
535 # broadcast a message to all clusters taking into account isolation
536 # [except those mentioned after buffer]
539 my $s = shift; # the line to be rebroadcast
540 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
541 my @dxchan = DXChannel::get_all_nodes();
544 # send it if it isn't the except list and isn't isolated and still has a hop count
545 foreach $dxchan (@dxchan) {
546 next if grep $dxchan == $_, @except;
547 next if $dxchan == $main::me;
549 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
551 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
555 # broadcast a message to all clusters ignoring isolation
556 # [except those mentioned after buffer]
557 sub broadcast_all_nodes
559 my $s = shift; # the line to be rebroadcast
560 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
561 my @dxchan = DXChannel::get_all_nodes();
564 # send it if it isn't the except list and isn't isolated and still has a hop count
565 foreach $dxchan (@dxchan) {
566 next if grep $dxchan == $_, @except;
567 next if $dxchan == $main::me;
569 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
570 $dxchan->send($routeit);
574 # broadcast to all users
575 # storing the spot or whatever until it is in a state to receive it
578 my $s = shift; # the line to be rebroadcast
579 my $sort = shift; # the type of transmission
580 my $fref = shift; # a reference to an object to filter on
581 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
582 my @dxchan = DXChannel::get_all_users();
586 foreach $dxchan (@dxchan) {
587 next if grep $dxchan == $_, @except;
590 broadcast_list($s, $sort, $fref, @out);
594 # broadcast to a list of users
602 foreach $dxchan (@_) {
604 next if $dxchan == $main::me;
607 next unless $dxchan->{dx};
608 ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
611 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
612 next if $sort eq 'wwv' && !$dxchan->{wwv};
613 next if $sort eq 'wcy' && !$dxchan->{wcy};
614 next if $sort eq 'wx' && !$dxchan->{wx};
616 $s =~ s/\a//og unless $dxchan->{beep};
618 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
631 my $name = $AUTOLOAD;
632 return if $name =~ /::DESTROY$/;
635 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
637 # this clever line of code creates a subroutine which takes over from autoload
638 # from OO Perl - Conway
639 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};