perl/DXChannel.pm

   1 #
   2 # module to manage channel lists & data
   3 #
   4 # This is the base class for all channel operations, which is everything to do
   5 # with input and output really.
   6 #
   7 # The instance variable in the outside world will be generally be called $dxchann
   8 #
   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.
  13 #
  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)
  17 #
  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).
  21 #
  22 # Copyright (c) 1998 - Dirk Koopman G1TLH
  23 #
  24 # $Id$
  25 #
  26 package DXChannel;
  27
  28 use Msg;
  29 use DXM;
  30 use DXUtil;
  31 use DXDebug;
  32 use Carp;
  33
  34 use strict;
  35 use vars qw(%channels %valid);
  36
  37 %channels = ();
  38
  39 %valid = (
  40                   call => '0,Callsign',
  41                   conn => '9,Msg Conn ref',
  42                   user => '9,DXUser ref',
  43                   startt => '0,Start Time,atime',
  44                   t => '9,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',
  61                   lang => '0,Language',
  62                   func => '9,Function',
  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                  );
  74
  75 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
  76 sub alloc
  77 {
  78         my ($pkg, $call, $conn, $user) = @_;
  79         my $self = {};
  80
  81         die "trying to create a duplicate channel for $call" if $channels{$call};
  82         $self->{call} = $call;
  83         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
  84         $self->{user} = $user if defined $user;
  85         $self->{startt} = $self->{t} = time;
  86         $self->{state} = 0;
  87         $self->{oldstate} = 0;
  88         $self->{lang} = $user->{lang} if defined $user;
  89         $self->{lang} = $main::lang if !$self->{lang};
  90         $user->new_group() if !$user->group;
  91         $self->{group} = $user->group;
  92         $self->{func} = "";
  93         bless $self, $pkg;
  94         return $channels{$call} = $self;
  95 }
  96
  97 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
  98 sub get
  99 {
 100         my ($pkg, $call) = @_;
 101         return $channels{$call};
 102 }
 103
 104 # obtain all the channel objects
 105 sub get_all
 106 {
 107         my ($pkg) = @_;
 108         return values(%channels);
 109 }
 110
 111 # obtain a channel object by searching for its connection reference
 112 sub get_by_cnum
 113 {
 114         my ($pkg, $conn) = @_;
 115         my $self;
 116
 117         foreach $self (values(%channels)) {
 118                 return $self if ($self->{conn} == $conn);
 119         }
 120         return undef;
 121 }
 122
 123 # get rid of a channel object [$obj->del()]
 124 sub del
 125 {
 126         my $self = shift;
 127
 128         $self->{group} = undef;         # belt and braces
 129         delete $channels{$self->{call}};
 130 }
 131
 132 # is it an ak1a cluster ?
 133 sub is_ak1a
 134 {
 135         my $self = shift;
 136         return $self->{'sort'} eq 'A';
 137 }
 138
 139 # is it a user?
 140 sub is_user
 141 {
 142         my $self = shift;
 143         return $self->{'sort'} eq 'U';
 144 }
 145
 146 # is it a connect type
 147 sub is_connect
 148 {
 149         my $self = shift;
 150         return $self->{'sort'} eq 'C';
 151 }
 152
 153 # handle out going messages, immediately without waiting for the select to drop
 154 # this could, in theory, block
 155 sub send_now
 156 {
 157         my $self = shift;
 158         my $conn = $self->{conn};
 159         my $sort = shift;
 160         my $call = $self->{call};
 161
 162         for (@_) {
 163                 chomp;
 164                 $conn->send_now("$sort$call|$_") if $conn;
 165                 dbg('chan', "-> $sort $call $_") if $conn;
 166         }
 167         $self->{t} = time;
 168 }
 169
 170 #
 171 # the normal output routine
 172 #
 173 sub send                                                # this is always later and always data
 174 {
 175         my $self = shift;
 176         my $conn = $self->{conn};
 177         my $call = $self->{call};
 178
 179         for (@_) {
 180                 chomp;
 181                 $conn->send_later("D$call|$_") if $conn;
 182                 dbg('chan', "-> D $call $_") if $conn;
 183         }
 184         $self->{t} = time;
 185 }
 186
 187 # send a file (always later)
 188 sub send_file
 189 {
 190         my ($self, $fn) = @_;
 191         my $call = $self->{call};
 192         my $conn = $self->{conn};
 193         my @buf;
 194
 195         open(F, $fn) or die "can't open $fn for sending file ($!)";
 196         @buf = <F>;
 197         close(F);
 198         $self->send(@buf);
 199 }
 200
 201 # this will implement language independence (in time)
 202 sub msg
 203 {
 204         my $self = shift;
 205         return DXM::msg($self->{lang}, @_);
 206 }
 207
 208 # stick a broadcast on the delayed queue
 209 sub delay
 210 {
 211         my $self = shift;
 212         my $s = shift;
 213
 214         $self->{delayed} = [] unless $self->{delayed};
 215         push @{$self->{delayed}}, $s;
 216 }
 217
 218 # change the state of the channel - lots of scope for debugging here :-)
 219 sub state
 220 {
 221         my $self = shift;
 222         if (@_) {
 223                 $self->{oldstate} = $self->{state};
 224                 $self->{state} = shift;
 225                 $self->{func} = '' unless defined $self->{func};
 226                 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
 227
 228                 # if there is any queued up broadcasts then splurge them out here
 229                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'convers')) {
 230                         for (@{$self->{delayed}}) {
 231                                 $self->send($_);
 232                         }
 233                         delete $self->{delayed};
 234                 }
 235         }
 236         return $self->{state};
 237 }
 238
 239 # disconnect this channel
 240 sub disconnect
 241 {
 242         my $self = shift;
 243         my $user = $self->{user};
 244         my $conn = $self->{conn};
 245         my $call = $self->{call};
 246
 247         $self->finish();
 248         $conn->send_now("Z$call|bye") if $conn; # this will cause 'client' to disconnect
 249         $user->close() if defined $user;
 250         $conn->disconnect() if $conn;
 251         $self->del();
 252 }
 253
 254 #
 255 # just close all the socket connections down without any fiddling about, cleaning, being
 256 # nice to other processes and otherwise telling them what is going on.
 257 #
 258 # This is for the benefit of forked processes to prepare for starting new programs, they
 259 # don't want or need all this baggage.
 260 #
 261
 262 sub closeall
 263 {
 264         my $ref;
 265         foreach $ref (values %channels) {
 266                 $ref->{conn}->disconnect() if $ref->{conn};
 267         }
 268 }
 269
 270 # various access routines
 271
 272 #
 273 # return a list of valid elements
 274 #
 275
 276 sub fields
 277 {
 278         return keys(%valid);
 279 }
 280
 281 #
 282 # return a prompt for a field
 283 #
 284
 285 sub field_prompt
 286 {
 287         my ($self, $ele) = @_;
 288         return $valid{$ele};
 289 }
 290
 291 no strict;
 292 sub AUTOLOAD
 293 {
 294         my $self = shift;
 295         my $name = $AUTOLOAD;
 296         return if $name =~ /::DESTROY$/;
 297         $name =~ s/.*:://o;
 298
 299         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 300         @_ ? $self->{$name} = shift : $self->{$name} ;
 301 }
 302
 303 1;
 304 __END__;