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 by make it smaller and more efficient, then tough).
22 # Copyright (c) 1998 - Dirk Koopman G1TLH
36 use vars qw(%channels %valid);
42 conn => '9,Msg Conn ref',
43 user => '9,DXUser ref',
44 startt => '0,Start Time,atime',
46 pc50_t => '5,Last PC50 Time,atime',
47 priv => '9,Privilege',
48 state => '0,Current State',
49 oldstate => '5,Last State',
50 list => '9,Dep Chan List',
51 name => '0,User Name',
52 consort => '5,Connection Type',
53 'sort' => '5,Type of Channel',
54 wwv => '0,Want WWV,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 spotfilter => '5,Spot Filter',
77 inannfilter => '5,Input Ann Filter',
78 inwwvfilter => '5,Input WWV Filter',
79 inspotfilter => '5,Input Spot Filter',
80 passwd => '9,Passwd List,parray',
81 pingint => '9,Ping Interval ',
82 nopings => '9,Ping Obs Count',
83 lastping => '9,Ping last sent,atime',
84 pingrec => '9,Pings no rec',
85 pingtime => '9,Ping totaltime',
86 pingave => '0,Ping ave time',
96 undef $self->{pagedata};
98 undef $self->{delayed};
99 undef $self->{annfilter};
100 undef $self->{wwvfilter};
101 undef $self->{spotfilter};
102 undef $self->{inannfilter};
103 undef $self->{inwwvfilter};
104 undef $self->{inspotfilter};
105 undef $self->{passwd};
108 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
111 my ($pkg, $call, $conn, $user) = @_;
114 die "trying to create a duplicate channel for $call" if $channels{$call};
115 $self->{call} = $call;
117 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
119 $self->{user} = $user;
120 $self->{lang} = $user->lang;
121 $user->new_group() if !$user->group;
122 $self->{group} = $user->group;
124 $self->{startt} = $self->{t} = time;
126 $self->{oldstate} = 0;
127 $self->{lang} = $main::lang if !$self->{lang};
131 $self->{spotfilter} = Filter::read_in('spots', $call, 0);
132 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0);
133 $self->{annfilter} = Filter::read_in('ann', $call, 0);
136 return $channels{$call} = $self;
139 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
142 my ($pkg, $call) = @_;
143 return $channels{$call};
146 # obtain all the channel objects
150 return values(%channels);
153 # obtain a channel object by searching for its connection reference
156 my ($pkg, $conn) = @_;
159 foreach $self (values(%channels)) {
160 return $self if ($self->{conn} == $conn);
165 # get rid of a channel object [$obj->del()]
170 $self->{group} = undef; # belt and braces
171 delete $channels{$self->{call}};
178 return $self->{sort} eq 'B';
181 # is it an ak1a cluster ?
185 return $self->{'sort'} eq 'A';
192 return $self->{'sort'} eq 'U';
195 # is it a connect type
199 return $self->{'sort'} eq 'C';
202 # handle out going messages, immediately without waiting for the select to drop
203 # this could, in theory, block
207 my $conn = $self->{conn};
210 my $call = $self->{call};
214 my @lines = split /\n/;
216 $conn->send_now("$sort$call|$_");
217 dbg('chan', "-> $sort $call $_");
224 # the normal output routine
226 sub send # this is always later and always data
229 my $conn = $self->{conn};
231 my $call = $self->{call};
235 my @lines = split /\n/;
237 $conn->send_later("D$call|$_");
238 dbg('chan', "-> D $call $_");
244 # send a file (always later)
247 my ($self, $fn) = @_;
248 my $call = $self->{call};
249 my $conn = $self->{conn};
252 open(F, $fn) or die "can't open $fn for sending file ($!)";
258 # this will implement language independence (in time)
262 return DXM::msg($self->{lang}, @_);
265 # stick a broadcast on the delayed queue (but only up to 20 items)
271 $self->{delayed} = [] unless $self->{delayed};
272 push @{$self->{delayed}}, $s;
273 if (@{$self->{delayed}} >= 20) {
274 shift @{$self->{delayed}}; # lose oldest one
278 # change the state of the channel - lots of scope for debugging here :-)
283 $self->{oldstate} = $self->{state};
284 $self->{state} = shift;
285 $self->{func} = '' unless defined $self->{func};
286 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
288 # if there is any queued up broadcasts then splurge them out here
289 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'convers')) {
290 $self->send (@{$self->{delayed}});
291 delete $self->{delayed};
294 return $self->{state};
297 # disconnect this channel
301 my $user = $self->{user};
302 my $conn = $self->{conn};
303 my $call = $self->{call};
306 $conn->send_now("Z$call|bye") if $conn; # this will cause 'client' to disconnect
307 $user->close() if defined $user;
308 $conn->disconnect() if $conn;
313 # just close all the socket connections down without any fiddling about, cleaning, being
314 # nice to other processes and otherwise telling them what is going on.
316 # This is for the benefit of forked processes to prepare for starting new programs, they
317 # don't want or need all this baggage.
323 foreach $ref (values %channels) {
324 $ref->{conn}->disconnect() if $ref->{conn};
328 # various access routines
331 # return a list of valid elements
340 # return a prompt for a field
345 my ($self, $ele) = @_;
353 my $name = $AUTOLOAD;
354 return if $name =~ /::DESTROY$/;
357 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
358 @_ ? $self->{$name} = shift : $self->{$name} ;