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 talk => '0,Want Talk,yesno',
55 ann => '0,Want Announce,yesno',
56 here => '0,Here?,yesno',
57 confmode => '0,In Conference?,yesno',
58 dx => '0,DX Spots,yesno',
59 redirect => '0,Redirect messages to',
62 loc => '9,Local Vars', # used by func to store local variables in
63 beep => '0,Want Beeps,yesno',
64 lastread => '9,Last Msg Read',
65 outbound => '9,outbound?,yesno',
66 remotecmd => '9,doing rcmd,yesno',
67 pagelth => '0,Page Length',
68 pagedata => '9,Page Data Store',
69 group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
72 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
75 my ($pkg, $call, $conn, $user) = @_;
78 die "trying to create a duplicate channel for $call" if $channels{$call};
79 $self->{call} = $call;
80 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
81 $self->{user} = $user if defined $user;
82 $self->{startt} = $self->{t} = time;
84 $self->{oldstate} = 0;
85 $self->{lang} = $user->{lang} if defined $user;
86 $self->{lang} = $main::lang if !$self->{lang};
87 $user->new_group() if !$user->group;
88 $self->{group} = $user->group;
90 return $channels{$call} = $self;
93 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
96 my ($pkg, $call) = @_;
97 return $channels{$call};
100 # obtain all the channel objects
104 return values(%channels);
107 # obtain a channel object by searching for its connection reference
110 my ($pkg, $conn) = @_;
113 foreach $self (values(%channels)) {
114 return $self if ($self->{conn} == $conn);
119 # get rid of a channel object [$obj->del()]
123 $self->{group} = undef; # belt and braces
124 delete $channels{$self->{call}};
127 # is it an ak1a cluster ?
131 return $self->{sort} eq 'A';
138 return $self->{sort} eq 'U';
141 # is it a connect type
145 return $self->{sort} eq 'C';
148 # handle out going messages, immediately without waiting for the select to drop
149 # this could, in theory, block
153 my $conn = $self->{conn};
155 my $call = $self->{call};
160 $conn->send_now("$sort$call|$line") if $conn;
161 dbg('chan', "-> $sort $call $line") if $conn;
167 # the normal output routine
169 sub send # this is always later and always data
172 my $conn = $self->{conn};
173 my $call = $self->{call};
178 $conn->send_later("D$call|$line") if $conn;
179 dbg('chan', "-> D $call $line") if $conn;
184 # send a file (always later)
187 my ($self, $fn) = @_;
188 my $call = $self->{call};
189 my $conn = $self->{conn};
192 open(F, $fn) or die "can't open $fn for sending file ($!)";
198 # this will implement language independence (in time)
202 return DXM::msg($self->{lang}, @_);
205 # change the state of the channel - lots of scope for debugging here :-)
210 $self->{oldstate} = $self->{state};
211 $self->{state} = shift;
212 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
214 return $self->{state};
217 # disconnect this channel
221 my $user = $self->{user};
222 my $conn = $self->{conn};
224 $user->close() if defined $user;
225 $conn->disconnect() if defined $conn;
229 # various access routines
232 # return a list of valid elements
241 # return a prompt for a field
246 my ($self, $ele) = @_;
254 my $name = $AUTOLOAD;
255 return if $name =~ /::DESTROY$/;
258 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
259 @_ ? $self->{$name} = shift : $self->{$name} ;