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
37 use vars qw(%channels %valid @ISA $count);
44 conn => '9,Msg Conn ref',
45 user => '9,DXUser ref',
46 startt => '0,Start Time,atime',
48 pc50_t => '5,Last PC50 Time,atime',
49 priv => '9,Privilege',
50 state => '0,Current State',
51 oldstate => '5,Last State',
52 list => '9,Dep Chan List',
53 name => '0,User Name',
54 consort => '5,Connection Type',
55 'sort' => '5,Type of Channel',
56 wwv => '0,Want WWV,yesno',
57 wcy => '0,Want WCY,yesno',
58 wx => '0,Want WX,yesno',
59 talk => '0,Want Talk,yesno',
60 ann => '0,Want Announce,yesno',
61 here => '0,Here?,yesno',
62 conf => '0,In Conference?,yesno',
63 dx => '0,DX Spots,yesno',
64 redirect => '0,Redirect messages to',
67 loc => '9,Local Vars', # used by func to store local variables in
68 beep => '0,Want Beeps,yesno',
69 lastread => '5,Last Msg Read',
70 outbound => '5,outbound?,yesno',
71 remotecmd => '9,doing rcmd,yesno',
72 pagelth => '0,Page Length',
73 pagedata => '9,Page Data Store',
74 group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
75 isolate => '5,Isolate network,yesno',
76 delayed => '5,Delayed messages,parray',
77 annfilter => '5,Ann Filt-out',
78 wwvfilter => '5,WWV Filt-out',
79 wcyfilter => '5,WCY Filt-out',
80 spotsfilter => '5,Spot Filt-out',
81 routefilter => '5,Route Filt-out',
82 inannfilter => '5,Ann Filt-inp',
83 inwwvfilter => '5,WWV Filt-inp',
84 inwcyfilter => '5,WCY Filt-inp',
85 inspotsfilter => '5,Spot Filt-inp',
86 inroutefilter => '5,Route Filt-inp',
87 passwd => '9,Passwd List,parray',
88 pingint => '5,Ping Interval ',
89 nopings => '5,Ping Obs Count',
90 lastping => '5,Ping last sent,atime',
91 pingtime => '5,Ping totaltime,parray',
92 pingave => '0,Ping ave time',
93 logininfo => '9,Login info req,yesno',
94 talklist => '0,Talk List,parray',
95 cluster => '5,Cluster data',
96 isbasic => '9,Internal Connection',
98 route => '9,Route Data',
99 dxcc => '0,Country Code',
102 enhanced => '5,Enhanced Client,yesno',
103 senddbg => '8,Sending Debug,yesno',
104 width => '0,Column Width',
105 disconnecting => '9,Disconnecting,yesno',
106 ann_talk => '0,Suppress Talk Anns,yesno',
109 use vars qw($VERSION $BRANCH);
110 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
111 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
112 $main::build += $VERSION;
113 $main::branch += $BRANCH;
120 if (ref($self->{$_})) {
124 dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
128 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
131 my ($pkg, $call, $conn, $user) = @_;
134 die "trying to create a duplicate channel for $call" if $channels{$call};
135 $self->{call} = $call;
137 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
139 $self->{user} = $user;
140 $self->{lang} = $user->lang;
141 $user->new_group() if !$user->group;
142 $self->{group} = $user->group;
143 $self->{sort} = $user->sort;
145 $self->{startt} = $self->{t} = time;
147 $self->{oldstate} = 0;
148 $self->{lang} = $main::lang if !$self->{lang};
151 # add in all the dxcc, itu, zone info
152 my @dxcc = Prefix::extract($call);
154 $self->{dxcc} = $dxcc[1]->dxcc;
155 $self->{itu} = $dxcc[1]->itu;
156 $self->{cq} = $dxcc[1]->cq;
160 dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
162 return $channels{$call} = $self;
165 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
168 my ($pkg, $call) = @_;
169 return $channels{$call};
172 # obtain all the channel objects
176 return values(%channels);
180 # gimme all the ak1a nodes
186 foreach $ref (values %channels) {
187 push @out, $ref if $ref->is_node;
192 # return a list of all users
197 foreach $ref (values %channels) {
198 push @out, $ref if $ref->is_user;
203 # return a list of all user callsigns
204 sub get_all_user_calls
208 foreach $ref (values %channels) {
209 push @out, $ref->{call} if $ref->is_user;
214 # obtain a channel object by searching for its connection reference
217 my ($pkg, $conn) = @_;
220 foreach $self (values(%channels)) {
221 return $self if ($self->{conn} == $conn);
226 # get rid of a channel object [$obj->del()]
231 $self->{group} = undef; # belt and braces
232 delete $channels{$self->{call}};
239 return $self->{'sort'} eq 'B';
245 return $self->{'sort'} =~ /[ACRSX]/;
247 # is it an ak1a node ?
251 return $self->{'sort'} eq 'A';
258 return $self->{'sort'} eq 'U';
265 return $self->{'sort'} eq 'C';
268 # is it a spider node
272 return $self->{'sort'} eq 'S';
279 return $self->{'sort'} eq 'X';
282 # is it a ar-cluster node
286 return $self->{'sort'} eq 'R';
289 # for perl 5.004's benefit
293 return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
296 # handle out going messages, immediately without waiting for the select to drop
297 # this could, in theory, block
301 my $conn = $self->{conn};
304 my $call = $self->{call};
308 my @lines = split /\n/;
310 $conn->send_now("$sort$call|$_");
311 dbg("-> $sort $call $_") if isdbg('chan');
318 # send later with letter (more control)
324 my $conn = $self->{conn};
327 my $call = $self->{call};
331 my @lines = split /\n/;
333 $conn->send_later("$sort$call|$_");
334 dbg("-> $sort $call $_") if isdbg('chan');
341 # the normal output routine
343 sub send # this is always later and always data
346 my $conn = $self->{conn};
348 my $call = $self->{call};
352 my @lines = split /\n/;
354 $conn->send_later("D$call|$_");
355 dbg("-> D $call $_") if isdbg('chan');
361 # send a file (always later)
364 my ($self, $fn) = @_;
365 my $call = $self->{call};
366 my $conn = $self->{conn};
369 open(F, $fn) or die "can't open $fn for sending file ($!)";
375 # this will implement language independence (in time)
379 return DXM::msg($self->{lang}, @_);
382 # stick a broadcast on the delayed queue (but only up to 20 items)
388 $self->{delayed} = [] unless $self->{delayed};
389 push @{$self->{delayed}}, $s;
390 if (@{$self->{delayed}} >= 20) {
391 shift @{$self->{delayed}}; # lose oldest one
395 # change the state of the channel - lots of scope for debugging here :-)
400 $self->{oldstate} = $self->{state};
401 $self->{state} = shift;
402 $self->{func} = '' unless defined $self->{func};
403 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
405 # if there is any queued up broadcasts then splurge them out here
406 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
407 $self->send (@{$self->{delayed}});
408 delete $self->{delayed};
411 return $self->{state};
414 # disconnect this channel
418 my $user = $self->{user};
420 $user->close() if defined $user;
421 $self->{conn}->disconnect;
426 # just close all the socket connections down without any fiddling about, cleaning, being
427 # nice to other processes and otherwise telling them what is going on.
429 # This is for the benefit of forked processes to prepare for starting new programs, they
430 # don't want or need all this baggage.
436 foreach $ref (values %channels) {
437 $ref->{conn}->disconnect() if $ref->{conn};
442 # Tell all the users that we have come in or out (if they want to know)
448 # send info to all logged in thingies
449 my @dxchan = get_all_users();
451 foreach $dxchan (@dxchan) {
452 next if $dxchan == $self;
453 next if $dxchan->{call} eq $main::mycall;
454 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
458 # various access routines
461 # return a list of valid elements
470 # return a prompt for a field
475 my ($self, $ele) = @_;
479 # take a standard input message and decode it into its standard parts
484 my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
486 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
488 # the above regexp must work
489 unless (defined $sort && defined $call && defined $line) {
490 # $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
491 dbg("DUFF Line on $chcall: $data") if isdbg('err');
495 if(ref($dxchan) && $call ne $chcall) {
496 dbg("DUFF Line come in for $call on wrong channel $chcall") if isdbg('err');
500 return ($sort, $call, $line);
507 my $name = $AUTOLOAD;
508 return if $name =~ /::DESTROY$/;
511 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
513 # this clever line of code creates a subroutine which takes over from autoload
514 # from OO Perl - Conway
515 *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
516 @_ ? $self->{$name} = shift : $self->{$name} ;