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                   annfilter => '9,Announce Filter',
  74                   wwvfilter => '9,WWV Filter',
  75                   spotfilter => '9,Spot Filter',
  76                   passwd => '9,Passwd List,parray',
  77                  );
  78
  79 # object destruction
  80 sub DESTROY
  81 {
  82         my $self = shift;
  83         undef $self->{user};
  84         undef $self->{conn};
  85         undef $self->{loc};
  86         undef $self->{pagedata};
  87         undef $self->{group};
  88         undef $self->{delayed};
  89         undef $self->{annfilter};
  90         undef $self->{wwvfilter};
  91         undef $self->{spotfilter};
  92         undef $self->{passwd};
  93 }
  94
  95 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
  96 sub alloc
  97 {
  98         my ($pkg, $call, $conn, $user) = @_;
  99         my $self = {};
 100
 101         die "trying to create a duplicate channel for $call" if $channels{$call};
 102         $self->{call} = $call;
 103         $self->{priv} = 0;
 104         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
 105         if (defined $user) {
 106                 $self->{user} = $user;
 107                 $self->{lang} = $user->lang;
 108                 $user->new_group() if !$user->group;
 109                 $self->{group} = $user->group;
 110         }
 111         $self->{startt} = $self->{t} = time;
 112         $self->{state} = 0;
 113         $self->{oldstate} = 0;
 114         $self->{lang} = $main::lang if !$self->{lang};
 115         $self->{func} = "";
 116         bless $self, $pkg;
 117         return $channels{$call} = $self;
 118 }
 119
 120 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
 121 sub get
 122 {
 123         my ($pkg, $call) = @_;
 124         return $channels{$call};
 125 }
 126
 127 # obtain all the channel objects
 128 sub get_all
 129 {
 130         my ($pkg) = @_;
 131         return values(%channels);
 132 }
 133
 134 # obtain a channel object by searching for its connection reference
 135 sub get_by_cnum
 136 {
 137         my ($pkg, $conn) = @_;
 138         my $self;
 139
 140         foreach $self (values(%channels)) {
 141                 return $self if ($self->{conn} == $conn);
 142         }
 143         return undef;
 144 }
 145
 146 # get rid of a channel object [$obj->del()]
 147 sub del
 148 {
 149         my $self = shift;
 150
 151         $self->{group} = undef;         # belt and braces
 152         delete $channels{$self->{call}};
 153 }
 154
 155 # is it an ak1a cluster ?
 156 sub is_ak1a
 157 {
 158         my $self = shift;
 159         return $self->{'sort'} eq 'A';
 160 }
 161
 162 # is it a user?
 163 sub is_user
 164 {
 165         my $self = shift;
 166         return $self->{'sort'} eq 'U';
 167 }
 168
 169 # is it a connect type
 170 sub is_connect
 171 {
 172         my $self = shift;
 173         return $self->{'sort'} eq 'C';
 174 }
 175
 176 # handle out going messages, immediately without waiting for the select to drop
 177 # this could, in theory, block
 178 sub send_now
 179 {
 180         my $self = shift;
 181         my $conn = $self->{conn};
 182         my $sort = shift;
 183         my $call = $self->{call};
 184
 185         for (@_) {
 186                 chomp;
 187                 $conn->send_now("$sort$call|$_") if $conn;
 188                 dbg('chan', "-> $sort $call $_") if $conn;
 189         }
 190         $self->{t} = time;
 191 }
 192
 193 #
 194 # the normal output routine
 195 #
 196 sub send                                                # this is always later and always data
 197 {
 198         my $self = shift;
 199         my $conn = $self->{conn};
 200         my $call = $self->{call};
 201
 202         for (@_) {
 203                 chomp;
 204                 $conn->send_later("D$call|$_") if $conn;
 205                 dbg('chan', "-> D $call $_") if $conn;
 206         }
 207         $self->{t} = time;
 208 }
 209
 210 # send a file (always later)
 211 sub send_file
 212 {
 213         my ($self, $fn) = @_;
 214         my $call = $self->{call};
 215         my $conn = $self->{conn};
 216         my @buf;
 217
 218         open(F, $fn) or die "can't open $fn for sending file ($!)";
 219         @buf = <F>;
 220         close(F);
 221         $self->send(@buf);
 222 }
 223
 224 # this will implement language independence (in time)
 225 sub msg
 226 {
 227         my $self = shift;
 228         return DXM::msg($self->{lang}, @_);
 229 }
 230
 231 # stick a broadcast on the delayed queue (but only up to 20 items)
 232 sub delay
 233 {
 234         my $self = shift;
 235         my $s = shift;
 236
 237         $self->{delayed} = [] unless $self->{delayed};
 238         push @{$self->{delayed}}, $s;
 239         if (@{$self->{delayed}} >= 20) {
 240                 shift @{$self->{delayed}};   # lose oldest one
 241         }
 242 }
 243
 244 # change the state of the channel - lots of scope for debugging here :-)
 245 sub state
 246 {
 247         my $self = shift;
 248         if (@_) {
 249                 $self->{oldstate} = $self->{state};
 250                 $self->{state} = shift;
 251                 $self->{func} = '' unless defined $self->{func};
 252                 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
 253
 254                 # if there is any queued up broadcasts then splurge them out here
 255                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'convers')) {
 256                         $self->send (@{$self->{delayed}});
 257                         delete $self->{delayed};
 258                 }
 259         }
 260         return $self->{state};
 261 }
 262
 263 # disconnect this channel
 264 sub disconnect
 265 {
 266         my $self = shift;
 267         my $user = $self->{user};
 268         my $conn = $self->{conn};
 269         my $call = $self->{call};
 270
 271         $self->finish();
 272         $conn->send_now("Z$call|bye") if $conn; # this will cause 'client' to disconnect
 273         $user->close() if defined $user;
 274         $conn->disconnect() if $conn;
 275         $self->del();
 276 }
 277
 278 #
 279 # just close all the socket connections down without any fiddling about, cleaning, being
 280 # nice to other processes and otherwise telling them what is going on.
 281 #
 282 # This is for the benefit of forked processes to prepare for starting new programs, they
 283 # don't want or need all this baggage.
 284 #
 285
 286 sub closeall
 287 {
 288         my $ref;
 289         foreach $ref (values %channels) {
 290                 $ref->{conn}->disconnect() if $ref->{conn};
 291         }
 292 }
 293
 294 # various access routines
 295
 296 #
 297 # return a list of valid elements
 298 #
 299
 300 sub fields
 301 {
 302         return keys(%valid);
 303 }
 304
 305 #
 306 # return a prompt for a field
 307 #
 308
 309 sub field_prompt
 310 {
 311         my ($self, $ele) = @_;
 312         return $valid{$ele};
 313 }
 314
 315 no strict;
 316 sub AUTOLOAD
 317 {
 318         my $self = shift;
 319         my $name = $AUTOLOAD;
 320         return if $name =~ /::DESTROY$/;
 321         $name =~ s/.*:://o;
 322
 323         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 324         @_ ? $self->{$name} = shift : $self->{$name} ;
 325 }
 326
 327 1;
 328 __END__;