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,Announce Filter',
78 wwvfilter => '5,WWV Filter',
79 wcyfilter => '5,WCY Filter',
80 spotsfilter => '5,Spot Filter',
81 routefilter => '5,route Filter',
82 inannfilter => '5,Input Ann Filter',
83 inwwvfilter => '5,Input WWV Filter',
84 inwcyfilter => '5,Input WCY Filter',
85 inspotsfilter => '5,Input Spot Filter',
86 inroutefilter => '5,Input Route Filter',
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',
107 use vars qw($VERSION $BRANCH);
108 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
109 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
110 $main::build += $VERSION;
111 $main::branch += $BRANCH;
118 if (ref($self->{$_})) {
122 dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
126 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
129 my ($pkg, $call, $conn, $user) = @_;
132 die "trying to create a duplicate channel for $call" if $channels{$call};
133 $self->{call} = $call;
135 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
137 $self->{user} = $user;
138 $self->{lang} = $user->lang;
139 $user->new_group() if !$user->group;
140 $self->{group} = $user->group;
141 $self->{sort} = $user->sort;
143 $self->{startt} = $self->{t} = time;
145 $self->{oldstate} = 0;
146 $self->{lang} = $main::lang if !$self->{lang};
149 # add in all the dxcc, itu, zone info
150 my @dxcc = Prefix::extract($call);
152 $self->{dxcc} = $dxcc[1]->dxcc;
153 $self->{itu} = $dxcc[1]->itu;
154 $self->{cq} = $dxcc[1]->cq;
158 dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
160 return $channels{$call} = $self;
163 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
166 my ($pkg, $call) = @_;
167 return $channels{$call};
170 # obtain all the channel objects
174 return values(%channels);
178 # gimme all the ak1a nodes
184 foreach $ref (values %channels) {
185 push @out, $ref if $ref->is_node;
190 # return a list of all users
195 foreach $ref (values %channels) {
196 push @out, $ref if $ref->is_user;
201 # return a list of all user callsigns
202 sub get_all_user_calls
206 foreach $ref (values %channels) {
207 push @out, $ref->{call} if $ref->is_user;
212 # obtain a channel object by searching for its connection reference
215 my ($pkg, $conn) = @_;
218 foreach $self (values(%channels)) {
219 return $self if ($self->{conn} == $conn);
224 # get rid of a channel object [$obj->del()]
229 $self->{group} = undef; # belt and braces
230 delete $channels{$self->{call}};
237 return $self->{'sort'} eq 'B';
243 return $self->{'sort'} =~ /[ACRSX]/;
245 # is it an ak1a node ?
249 return $self->{'sort'} eq 'A';
256 return $self->{'sort'} eq 'U';
263 return $self->{'sort'} eq 'C';
266 # is it a spider node
270 return $self->{'sort'} eq 'S';
277 return $self->{'sort'} eq 'X';
280 # is it a ar-cluster node
284 return $self->{'sort'} eq 'R';
287 # for perl 5.004's benefit
291 return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
294 # handle out going messages, immediately without waiting for the select to drop
295 # this could, in theory, block
299 my $conn = $self->{conn};
302 my $call = $self->{call};
306 my @lines = split /\n/;
308 $conn->send_now("$sort$call|$_");
309 dbg("-> $sort $call $_") if isdbg('chan');
316 # send later with letter (more control)
322 my $conn = $self->{conn};
325 my $call = $self->{call};
329 my @lines = split /\n/;
331 $conn->send_later("$sort$call|$_");
332 dbg("-> $sort $call $_") if isdbg('chan');
339 # the normal output routine
341 sub send # this is always later and always data
344 my $conn = $self->{conn};
346 my $call = $self->{call};
350 my @lines = split /\n/;
352 $conn->send_later("D$call|$_");
353 dbg("-> D $call $_") if isdbg('chan');
359 # send a file (always later)
362 my ($self, $fn) = @_;
363 my $call = $self->{call};
364 my $conn = $self->{conn};
367 open(F, $fn) or die "can't open $fn for sending file ($!)";
373 # this will implement language independence (in time)
377 return DXM::msg($self->{lang}, @_);
380 # stick a broadcast on the delayed queue (but only up to 20 items)
386 $self->{delayed} = [] unless $self->{delayed};
387 push @{$self->{delayed}}, $s;
388 if (@{$self->{delayed}} >= 20) {
389 shift @{$self->{delayed}}; # lose oldest one
393 # change the state of the channel - lots of scope for debugging here :-)
398 $self->{oldstate} = $self->{state};
399 $self->{state} = shift;
400 $self->{func} = '' unless defined $self->{func};
401 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
403 # if there is any queued up broadcasts then splurge them out here
404 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
405 $self->send (@{$self->{delayed}});
406 delete $self->{delayed};
409 return $self->{state};
412 # disconnect this channel
416 my $user = $self->{user};
418 $user->close() if defined $user;
419 $self->{conn}->disconnect;
424 # just close all the socket connections down without any fiddling about, cleaning, being
425 # nice to other processes and otherwise telling them what is going on.
427 # This is for the benefit of forked processes to prepare for starting new programs, they
428 # don't want or need all this baggage.
434 foreach $ref (values %channels) {
435 $ref->{conn}->disconnect() if $ref->{conn};
440 # Tell all the users that we have come in or out (if they want to know)
446 # send info to all logged in thingies
447 my @dxchan = get_all_users();
449 foreach $dxchan (@dxchan) {
450 next if $dxchan == $self;
451 next if $dxchan->{call} eq $main::mycall;
452 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
456 # various access routines
459 # return a list of valid elements
468 # return a prompt for a field
473 my ($self, $ele) = @_;
477 # take a standard input message and decode it into its standard parts
482 my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
484 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
486 # the above regexp must work
487 unless (defined $sort && defined $call && defined $line) {
488 # $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
489 dbg("DUFF Line on $chcall: $data") if isdbg('err');
493 if(ref($dxchan) && $call ne $chcall) {
494 dbg("DUFF Line come in for $call on wrong channel $chcall") if isdbg('err');
498 return ($sort, $call, $line);
505 my $name = $AUTOLOAD;
506 return if $name =~ /::DESTROY$/;
509 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
511 # this clever line of code creates a subroutine which takes over from autoload
512 # from OO Perl - Conway
513 *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
514 @_ ? $self->{$name} = shift : $self->{$name} ;