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 => '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 spotfilter => '5,Spot Filter',
78 inannfilter => '5,Input Ann Filter',
79 inwwvfilter => '5,Input WWV Filter',
80 inspotfilter => '5,Input Spot Filter',
81 passwd => '9,Passwd List,parray',
82 pingint => '5,Ping Interval ',
83 nopings => '5,Ping Obs Count',
84 lastping => '5,Ping last sent,atime',
85 pingtime => '5,Ping totaltime,parray',
86 pingave => '0,Ping ave time',
87 logininfo => '9,Login info req,yesno',
97 undef $self->{pagedata};
99 undef $self->{delayed};
100 undef $self->{annfilter};
101 undef $self->{wwvfilter};
102 undef $self->{spotfilter};
103 undef $self->{inannfilter};
104 undef $self->{inwwvfilter};
105 undef $self->{inspotfilter};
106 undef $self->{passwd};
109 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
112 my ($pkg, $call, $conn, $user) = @_;
115 die "trying to create a duplicate channel for $call" if $channels{$call};
116 $self->{call} = $call;
118 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
120 $self->{user} = $user;
121 $self->{lang} = $user->lang;
122 $user->new_group() if !$user->group;
123 $self->{group} = $user->group;
124 $self->{sort} = $user->sort;
126 $self->{startt} = $self->{t} = time;
128 $self->{oldstate} = 0;
129 $self->{lang} = $main::lang if !$self->{lang};
133 $self->{spotfilter} = Filter::read_in('spots', $call, 0);
134 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0);
135 $self->{annfilter} = Filter::read_in('ann', $call, 0);
138 return $channels{$call} = $self;
141 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
144 my ($pkg, $call) = @_;
145 return $channels{$call};
148 # obtain all the channel objects
152 return values(%channels);
156 # gimme all the ak1a nodes
160 my @list = DXChannel->get_all();
163 foreach $ref (@list) {
164 push @out, $ref if $ref->is_node;
169 # return a list of all users
172 my @list = DXChannel->get_all();
175 foreach $ref (@list) {
176 push @out, $ref if $ref->is_user;
181 # return a list of all user callsigns
182 sub get_all_user_calls
184 my @list = DXChannel->get_all();
187 foreach $ref (@list) {
188 push @out, $ref->call if $ref->is_user;
193 # obtain a channel object by searching for its connection reference
196 my ($pkg, $conn) = @_;
199 foreach $self (values(%channels)) {
200 return $self if ($self->{conn} == $conn);
205 # get rid of a channel object [$obj->del()]
210 $self->{group} = undef; # belt and braces
211 delete $channels{$self->{call}};
218 return $self->{'sort'} eq 'B';
224 return $self->{'sort'} =~ /[ACRSX]/;
226 # is it an ak1a node ?
230 return $self->{'sort'} eq 'A';
237 return $self->{'sort'} eq 'U';
244 return $self->{'sort'} eq 'C';
247 # is it a spider node
251 return $self->{'sort'} eq 'S';
258 return $self->{'sort'} eq 'X';
261 # is it a ar-cluster node
265 return $self->{'sort'} eq 'R';
268 # for perl 5.004's benefit
272 return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
275 # handle out going messages, immediately without waiting for the select to drop
276 # this could, in theory, block
280 my $conn = $self->{conn};
283 my $call = $self->{call};
287 my @lines = split /\n/;
289 $conn->send_now("$sort$call|$_");
290 dbg('chan', "-> $sort $call $_");
297 # the normal output routine
299 sub send # this is always later and always data
302 my $conn = $self->{conn};
304 my $call = $self->{call};
308 my @lines = split /\n/;
310 $conn->send_later("D$call|$_");
311 dbg('chan', "-> D $call $_");
317 # send a file (always later)
320 my ($self, $fn) = @_;
321 my $call = $self->{call};
322 my $conn = $self->{conn};
325 open(F, $fn) or die "can't open $fn for sending file ($!)";
331 # this will implement language independence (in time)
335 return DXM::msg($self->{lang}, @_);
338 # stick a broadcast on the delayed queue (but only up to 20 items)
344 $self->{delayed} = [] unless $self->{delayed};
345 push @{$self->{delayed}}, $s;
346 if (@{$self->{delayed}} >= 20) {
347 shift @{$self->{delayed}}; # lose oldest one
351 # change the state of the channel - lots of scope for debugging here :-)
356 $self->{oldstate} = $self->{state};
357 $self->{state} = shift;
358 $self->{func} = '' unless defined $self->{func};
359 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
361 # if there is any queued up broadcasts then splurge them out here
362 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'convers')) {
363 $self->send (@{$self->{delayed}});
364 delete $self->{delayed};
367 return $self->{state};
370 # disconnect this channel
374 my $user = $self->{user};
375 my $conn = $self->{conn};
376 my $call = $self->{call};
377 my $nopc39 = shift || 0;
379 $self->finish($nopc39);
380 $conn->send_now("Z$call|bye") if $conn; # this will cause 'client' to disconnect
381 $user->close() if defined $user;
382 $conn->disconnect() if $conn;
387 # just close all the socket connections down without any fiddling about, cleaning, being
388 # nice to other processes and otherwise telling them what is going on.
390 # This is for the benefit of forked processes to prepare for starting new programs, they
391 # don't want or need all this baggage.
397 foreach $ref (values %channels) {
398 $ref->{conn}->disconnect() if $ref->{conn};
403 # Tell all the users that we have come in or out (if they want to know)
409 # send info to all logged in thingies
410 my @dxchan = get_all_users();
412 foreach $dxchan (@dxchan) {
413 next if $dxchan == $self;
414 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
418 # various access routines
421 # return a list of valid elements
430 # return a prompt for a field
435 my ($self, $ele) = @_;
443 my $name = $AUTOLOAD;
444 return if $name =~ /::DESTROY$/;
447 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
448 @_ ? $self->{$name} = shift : $self->{$name} ;