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 lastread => '9,Last Msg Read',
66 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
69 my ($pkg, $call, $conn, $user) = @_;
72 die "trying to create a duplicate channel for $call" if $channels{$call};
73 $self->{call} = $call;
74 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
75 $self->{user} = $user if defined $user;
76 $self->{startt} = $self->{t} = time;
78 $self->{oldstate} = 0;
79 $self->{lang} = $user->{lang} if defined $user;
80 $self->{lang} = $main::lang if !$self->{lang};
82 return $channels{$call} = $self;
85 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
88 my ($pkg, $call) = @_;
89 return $channels{$call};
92 # obtain all the channel objects
96 return values(%channels);
99 # obtain a channel object by searching for its connection reference
102 my ($pkg, $conn) = @_;
105 foreach $self (values(%channels)) {
106 return $self if ($self->{conn} == $conn);
111 # get rid of a channel object [$obj->del()]
115 delete $channels{$self->{call}};
118 # is it an ak1a cluster ?
122 return $self->{sort} eq 'A';
129 return $self->{sort} eq 'U';
132 # is it a connect type
136 return $self->{sort} eq 'C';
139 # handle out going messages, immediately without waiting for the select to drop
140 # this could, in theory, block
144 my $conn = $self->{conn};
146 my $call = $self->{call};
151 dbg('chan', "-> $sort $call $line\n") if $conn;
152 $conn->send_now("$sort$call|$line") if $conn;
158 # the normal output routine
160 sub send # this is always later and always data
163 my $conn = $self->{conn};
164 my $call = $self->{call};
169 dbg('chan', "-> D $call $line\n") if $conn;
170 $conn->send_later("D$call|$line") if $conn;
175 # send a file (always later)
178 my ($self, $fn) = @_;
179 my $call = $self->{call};
180 my $conn = $self->{conn};
183 open(F, $fn) or die "can't open $fn for sending file ($!)";
189 # this will implement language independence (in time)
193 return DXM::msg($self->{lang}, @_);
196 # change the state of the channel - lots of scope for debugging here :-)
201 $self->{oldstate} = $self->{state};
202 $self->{state} = shift;
203 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
205 return $self->{state};
208 # disconnect this channel
212 my $user = $self->{user};
213 my $conn = $self->{conn};
215 $user->close() if defined $user;
216 $conn->disconnect() if defined $conn;
220 # various access routines
223 # return a list of valid elements
232 # return a prompt for a field
237 my ($self, $ele) = @_;
245 my $name = $AUTOLOAD;
246 return if $name =~ /::DESTROY$/;
249 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
250 @_ ? $self->{$name} = shift : $self->{$name} ;