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
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 => '9,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 => '9,Connection Type',
52 'sort' => '9,Type of Channel',
53 wwv => '0,Want WWV,yesno',
54 wx => '0,Want WX,yesno',
55 talk => '0,Want Talk,yesno',
56 ann => '0,Want Announce,yesno',
57 here => '0,Here?,yesno',
58 confmode => '0,In Conference?,yesno',
59 dx => '0,DX Spots,yesno',
60 redirect => '0,Redirect messages to',
63 loc => '9,Local Vars', # used by func to store local variables in
64 beep => '0,Want Beeps,yesno',
65 lastread => '9,Last Msg Read',
66 outbound => '9,outbound?,yesno',
67 remotecmd => '9,doing rcmd,yesno',
68 pagelth => '0,Page Length',
69 pagedata => '9,Page Data Store',
70 group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
71 isolate => '9,Isolate network,yesno',
72 delayed => '9,Delayed messages,parray',
73 annfilter => '9,Announce Filter',
74 wwvfilter => '9,WWV Filter',
75 spotfilter => '9,Spot Filter',
76 passwd => '9,Passwd List,parray',
79 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
82 my ($pkg, $call, $conn, $user) = @_;
85 die "trying to create a duplicate channel for $call" if $channels{$call};
86 $self->{call} = $call;
88 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
90 $self->{user} = $user;
91 $self->{lang} = $user->lang;
92 $user->new_group() if !$user->group;
93 $self->{group} = $user->group;
95 $self->{startt} = $self->{t} = time;
97 $self->{oldstate} = 0;
98 $self->{lang} = $main::lang if !$self->{lang};
101 return $channels{$call} = $self;
104 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
107 my ($pkg, $call) = @_;
108 return $channels{$call};
111 # obtain all the channel objects
115 return values(%channels);
118 # obtain a channel object by searching for its connection reference
121 my ($pkg, $conn) = @_;
124 foreach $self (values(%channels)) {
125 return $self if ($self->{conn} == $conn);
130 # get rid of a channel object [$obj->del()]
135 $self->{group} = undef; # belt and braces
136 delete $channels{$self->{call}};
139 # is it an ak1a cluster ?
143 return $self->{'sort'} eq 'A';
150 return $self->{'sort'} eq 'U';
153 # is it a connect type
157 return $self->{'sort'} eq 'C';
160 # handle out going messages, immediately without waiting for the select to drop
161 # this could, in theory, block
165 my $conn = $self->{conn};
167 my $call = $self->{call};
171 $conn->send_now("$sort$call|$_") if $conn;
172 dbg('chan', "-> $sort $call $_") if $conn;
178 # the normal output routine
180 sub send # this is always later and always data
183 my $conn = $self->{conn};
184 my $call = $self->{call};
188 $conn->send_later("D$call|$_") if $conn;
189 dbg('chan', "-> D $call $_") if $conn;
194 # send a file (always later)
197 my ($self, $fn) = @_;
198 my $call = $self->{call};
199 my $conn = $self->{conn};
202 open(F, $fn) or die "can't open $fn for sending file ($!)";
208 # this will implement language independence (in time)
212 return DXM::msg($self->{lang}, @_);
215 # stick a broadcast on the delayed queue (but only up to 20 items)
221 $self->{delayed} = [] unless $self->{delayed};
222 push @{$self->{delayed}}, $s;
223 if (@{$self->{delayed}} >= 20) {
224 shift @{$self->{delayed}}; # lose oldest one
228 # change the state of the channel - lots of scope for debugging here :-)
233 $self->{oldstate} = $self->{state};
234 $self->{state} = shift;
235 $self->{func} = '' unless defined $self->{func};
236 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
238 # if there is any queued up broadcasts then splurge them out here
239 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'convers')) {
240 $self->send (@{$self->{delayed}});
241 delete $self->{delayed};
244 return $self->{state};
247 # disconnect this channel
251 my $user = $self->{user};
252 my $conn = $self->{conn};
253 my $call = $self->{call};
256 $conn->send_now("Z$call|bye") if $conn; # this will cause 'client' to disconnect
257 $user->close() if defined $user;
258 $conn->disconnect() if $conn;
263 # just close all the socket connections down without any fiddling about, cleaning, being
264 # nice to other processes and otherwise telling them what is going on.
266 # This is for the benefit of forked processes to prepare for starting new programs, they
267 # don't want or need all this baggage.
273 foreach $ref (values %channels) {
274 $ref->{conn}->disconnect() if $ref->{conn};
278 # various access routines
281 # return a list of valid elements
290 # return a prompt for a field
295 my ($self, $ele) = @_;
303 my $name = $AUTOLOAD;
304 return if $name =~ /::DESTROY$/;
307 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
308 @_ ? $self->{$name} = shift : $self->{$name} ;