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 $dxchann
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
35 use vars qw(%channels %valid);
41 conn => '9,Msg Conn ref',
42 user => '9,DXUser ref',
43 startt => '0,Start Time,atime',
45 pc50_t => '5,Last PC50 Time,atime',
46 priv => '9,Privilege',
47 state => '0,Current State',
48 oldstate => '5,Last State',
49 list => '9,Dep Chan List',
50 name => '0,User Name',
51 consort => '5,Connection Type',
52 'sort' => '5,Type of Channel',
53 wwv => '0,Want WWV,yesno',
54 wcy => '0,Want WCY,yesno',
55 wx => '0,Want WX,yesno',
56 talk => '0,Want Talk,yesno',
57 ann => '0,Want Announce,yesno',
58 here => '0,Here?,yesno',
59 confmode => '0,In Conference?,yesno',
60 dx => '0,DX Spots,yesno',
61 redirect => '0,Redirect messages to',
64 loc => '9,Local Vars', # used by func to store local variables in
65 beep => '0,Want Beeps,yesno',
66 lastread => '5,Last Msg Read',
67 outbound => '5,outbound?,yesno',
68 remotecmd => '9,doing rcmd,yesno',
69 pagelth => '0,Page Length',
70 pagedata => '9,Page Data Store',
71 group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
72 isolate => '5,Isolate network,yesno',
73 delayed => '5,Delayed messages,parray',
74 annfilter => '5,Announce Filter',
75 wwvfilter => '5,WWV Filter',
76 wcyfilter => '5,WCY Filter',
77 spotsfilter => '5,Spot Filter',
78 inannfilter => '5,Input Ann Filter',
79 inwwvfilter => '5,Input WWV Filter',
80 inwcyfilter => '5,Input WCY Filter',
81 inspotsfilter => '5,Input Spot Filter',
82 passwd => '9,Passwd List,parray',
83 pingint => '5,Ping Interval ',
84 nopings => '5,Ping Obs Count',
85 lastping => '5,Ping last sent,atime',
86 pingtime => '5,Ping totaltime,parray',
87 pingave => '0,Ping ave time',
88 logininfo => '9,Login info req,yesno',
89 talklist => '0,Talk List,parray',
90 cluster => '5,Cluster data',
100 undef $self->{pagedata};
101 undef $self->{group};
102 undef $self->{delayed};
103 undef $self->{annfilter};
104 undef $self->{wwvfilter};
105 undef $self->{spotsfilter};
106 undef $self->{inannfilter};
107 undef $self->{inwwvfilter};
108 undef $self->{inspotsfilter};
109 undef $self->{passwd};
113 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
116 my ($pkg, $call, $conn, $user) = @_;
119 die "trying to create a duplicate channel for $call" if $channels{$call};
120 $self->{call} = $call;
122 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
124 $self->{user} = $user;
125 $self->{lang} = $user->lang;
126 $user->new_group() if !$user->group;
127 $self->{group} = $user->group;
128 $self->{sort} = $user->sort;
130 $self->{startt} = $self->{t} = time;
132 $self->{oldstate} = 0;
133 $self->{lang} = $main::lang if !$self->{lang};
137 return $channels{$call} = $self;
140 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
143 my ($pkg, $call) = @_;
144 return $channels{$call};
147 # obtain all the channel objects
151 return values(%channels);
155 # gimme all the ak1a nodes
161 foreach $ref (values %channels) {
162 push @out, $ref if $ref->is_node;
167 # return a list of all users
172 foreach $ref (values %channels) {
173 push @out, $ref if $ref->is_user;
178 # return a list of all user callsigns
179 sub get_all_user_calls
183 foreach $ref (values %channels) {
184 push @out, $ref->{call} if $ref->is_user;
189 # obtain a channel object by searching for its connection reference
192 my ($pkg, $conn) = @_;
195 foreach $self (values(%channels)) {
196 return $self if ($self->{conn} == $conn);
201 # get rid of a channel object [$obj->del()]
206 $self->{group} = undef; # belt and braces
207 delete $channels{$self->{call}};
214 return $self->{'sort'} eq 'B';
220 return $self->{'sort'} =~ /[ACRSX]/;
222 # is it an ak1a node ?
226 return $self->{'sort'} eq 'A';
233 return $self->{'sort'} eq 'U';
240 return $self->{'sort'} eq 'C';
243 # is it a spider node
247 return $self->{'sort'} eq 'S';
254 return $self->{'sort'} eq 'X';
257 # is it a ar-cluster node
261 return $self->{'sort'} eq 'R';
264 # for perl 5.004's benefit
268 return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
271 # handle out going messages, immediately without waiting for the select to drop
272 # this could, in theory, block
276 my $conn = $self->{conn};
279 my $call = $self->{call};
283 my @lines = split /\n/;
285 $conn->send_now("$sort$call|$_");
286 dbg('chan', "-> $sort $call $_");
293 # the normal output routine
295 sub send # this is always later and always data
298 my $conn = $self->{conn};
300 my $call = $self->{call};
304 my @lines = split /\n/;
306 $conn->send_later("D$call|$_");
307 dbg('chan', "-> D $call $_");
313 # send a file (always later)
316 my ($self, $fn) = @_;
317 my $call = $self->{call};
318 my $conn = $self->{conn};
321 open(F, $fn) or die "can't open $fn for sending file ($!)";
327 # this will implement language independence (in time)
331 return DXM::msg($self->{lang}, @_);
334 # stick a broadcast on the delayed queue (but only up to 20 items)
340 $self->{delayed} = [] unless $self->{delayed};
341 push @{$self->{delayed}}, $s;
342 if (@{$self->{delayed}} >= 20) {
343 shift @{$self->{delayed}}; # lose oldest one
347 # change the state of the channel - lots of scope for debugging here :-)
352 $self->{oldstate} = $self->{state};
353 $self->{state} = shift;
354 $self->{func} = '' unless defined $self->{func};
355 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
357 # if there is any queued up broadcasts then splurge them out here
358 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
359 $self->send (@{$self->{delayed}});
360 delete $self->{delayed};
363 return $self->{state};
366 # disconnect this channel
370 my $user = $self->{user};
371 my $conn = $self->{conn};
372 my $call = $self->{call};
374 $self->finish($conn);
375 $user->close() if defined $user;
376 $conn->disconnect() if $conn;
381 # just close all the socket connections down without any fiddling about, cleaning, being
382 # nice to other processes and otherwise telling them what is going on.
384 # This is for the benefit of forked processes to prepare for starting new programs, they
385 # don't want or need all this baggage.
391 foreach $ref (values %channels) {
392 $ref->{conn}->disconnect() if $ref->{conn};
397 # Tell all the users that we have come in or out (if they want to know)
403 # send info to all logged in thingies
404 my @dxchan = get_all_users();
406 foreach $dxchan (@dxchan) {
407 next if $dxchan == $self;
408 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
412 # various access routines
415 # return a list of valid elements
424 # return a prompt for a field
429 my ($self, $ele) = @_;
433 # take a standard input message and decode it into its standard parts
438 my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
440 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
442 # the above regexp must work
443 unless (defined $sort && defined $call && defined $line) {
444 $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
445 dbg('err', "DUFF Line on $chcall: $data");
449 if(ref($dxchan) && $call ne $chcall) {
450 dbg('err', "DUFF Line come in for $call on wrong channel $chcall" );
454 return ($sort, $call, $line);
461 my $name = $AUTOLOAD;
462 return if $name =~ /::DESTROY$/;
465 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
467 # this clever line of code creates a subroutine which takes over from autoload
468 # from OO Perl - Conway
469 *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
470 @_ ? $self->{$name} = shift : $self->{$name} ;