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 Filter;
  33 use Carp;
  34
  35 use strict;
  36 use vars qw(%channels %valid);
  37
  38 %channels = ();
  39
  40 %valid = (
  41                   call => '0,Callsign',
  42                   conn => '9,Msg Conn ref',
  43                   user => '9,DXUser ref',
  44                   startt => '0,Start Time,atime',
  45                   t => '9,Time,atime',
  46                   pc50_t => '5,Last PC50 Time,atime',
  47                   priv => '9,Privilege',
  48                   state => '0,Current State',
  49                   oldstate => '5,Last State',
  50                   list => '9,Dep Chan List',
  51                   name => '0,User Name',
  52                   consort => '5,Connection Type',
  53                   'sort' => '5,Type of Channel',
  54                   wwv => '0,Want WWV,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',
  62                   lang => '0,Language',
  63                   func => '5,Function',
  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                   spotfilter => '5,Spot Filter',
  77                   inannfilter => '5,Input Ann Filter',
  78                   inwwvfilter => '5,Input WWV Filter',
  79                   inspotfilter => '5,Input Spot Filter',
  80                   passwd => '9,Passwd List,parray',
  81                   pingint => '9,Ping Interval ',
  82                   nopings => '9,Ping Obs Count',
  83                   lastping => '9,Ping last sent,atime',
  84           pingrec => '9,Pings no rec',
  85                   pingtime => '9,Ping totaltime',
  86                   pingave => '0,Ping ave time',
  87                  );
  88
  89 # object destruction
  90 sub DESTROY
  91 {
  92         my $self = shift;
  93         undef $self->{user};
  94         undef $self->{conn};
  95         undef $self->{loc};
  96         undef $self->{pagedata};
  97         undef $self->{group};
  98         undef $self->{delayed};
  99         undef $self->{annfilter};
 100         undef $self->{wwvfilter};
 101         undef $self->{spotfilter};
 102         undef $self->{inannfilter};
 103         undef $self->{inwwvfilter};
 104         undef $self->{inspotfilter};
 105         undef $self->{passwd};
 106 }
 107
 108 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
 109 sub alloc
 110 {
 111         my ($pkg, $call, $conn, $user) = @_;
 112         my $self = {};
 113
 114         die "trying to create a duplicate channel for $call" if $channels{$call};
 115         $self->{call} = $call;
 116         $self->{priv} = 0;
 117         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
 118         if (defined $user) {
 119                 $self->{user} = $user;
 120                 $self->{lang} = $user->lang;
 121                 $user->new_group() if !$user->group;
 122                 $self->{group} = $user->group;
 123         }
 124         $self->{startt} = $self->{t} = time;
 125         $self->{state} = 0;
 126         $self->{oldstate} = 0;
 127         $self->{lang} = $main::lang if !$self->{lang};
 128         $self->{func} = "";
 129
 130         # get the filters
 131         $self->{spotfilter} = Filter::read_in('spots', $call, 0);
 132         $self->{wwvfilter} = Filter::read_in('wwv', $call, 0);
 133         $self->{annfilter} = Filter::read_in('ann', $call, 0);
 134
 135         bless $self, $pkg;
 136         return $channels{$call} = $self;
 137 }
 138
 139 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
 140 sub get
 141 {
 142         my ($pkg, $call) = @_;
 143         return $channels{$call};
 144 }
 145
 146 # obtain all the channel objects
 147 sub get_all
 148 {
 149         my ($pkg) = @_;
 150         return values(%channels);
 151 }
 152
 153 # obtain a channel object by searching for its connection reference
 154 sub get_by_cnum
 155 {
 156         my ($pkg, $conn) = @_;
 157         my $self;
 158
 159         foreach $self (values(%channels)) {
 160                 return $self if ($self->{conn} == $conn);
 161         }
 162         return undef;
 163 }
 164
 165 # get rid of a channel object [$obj->del()]
 166 sub del
 167 {
 168         my $self = shift;
 169
 170         $self->{group} = undef;         # belt and braces
 171         delete $channels{$self->{call}};
 172 }
 173
 174 # is it a bbs
 175 sub is_bbs
 176 {
 177         my $self = shift;
 178         return $self->{'sort'} eq 'B';
 179 }
 180
 181 # is it an ak1a cluster ?
 182 sub is_ak1a
 183 {
 184         my $self = shift;
 185         return $self->{'sort'} eq 'A';
 186 }
 187
 188 # is it a user?
 189 sub is_user
 190 {
 191         my $self = shift;
 192         return $self->{'sort'} eq 'U';
 193 }
 194
 195 # is it a connect type
 196 sub is_connect
 197 {
 198         my $self = shift;
 199         return $self->{'sort'} eq 'C';
 200 }
 201
 202 # for perl 5.004's benefit
 203 sub sort
 204 {
 205         my $self = shift;
 206         return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 207 }
 208
 209 # handle out going messages, immediately without waiting for the select to drop
 210 # this could, in theory, block
 211 sub send_now
 212 {
 213         my $self = shift;
 214         my $conn = $self->{conn};
 215         return unless $conn;
 216         my $sort = shift;
 217         my $call = $self->{call};
 218
 219         for (@_) {
 220                 chomp;
 221         my @lines = split /\n/;
 222                 for (@lines) {
 223                         $conn->send_now("$sort$call|$_");
 224                         dbg('chan', "-> $sort $call $_");
 225                 }
 226         }
 227         $self->{t} = time;
 228 }
 229
 230 #
 231 # the normal output routine
 232 #
 233 sub send                                                # this is always later and always data
 234 {
 235         my $self = shift;
 236         my $conn = $self->{conn};
 237         return unless $conn;
 238         my $call = $self->{call};
 239
 240         for (@_) {
 241                 chomp;
 242         my @lines = split /\n/;
 243                 for (@lines) {
 244                         $conn->send_later("D$call|$_");
 245                         dbg('chan', "-> D $call $_");
 246                 }
 247         }
 248         $self->{t} = time;
 249 }
 250
 251 # send a file (always later)
 252 sub send_file
 253 {
 254         my ($self, $fn) = @_;
 255         my $call = $self->{call};
 256         my $conn = $self->{conn};
 257         my @buf;
 258
 259         open(F, $fn) or die "can't open $fn for sending file ($!)";
 260         @buf = <F>;
 261         close(F);
 262         $self->send(@buf);
 263 }
 264
 265 # this will implement language independence (in time)
 266 sub msg
 267 {
 268         my $self = shift;
 269         return DXM::msg($self->{lang}, @_);
 270 }
 271
 272 # stick a broadcast on the delayed queue (but only up to 20 items)
 273 sub delay
 274 {
 275         my $self = shift;
 276         my $s = shift;
 277
 278         $self->{delayed} = [] unless $self->{delayed};
 279         push @{$self->{delayed}}, $s;
 280         if (@{$self->{delayed}} >= 20) {
 281                 shift @{$self->{delayed}};   # lose oldest one
 282         }
 283 }
 284
 285 # change the state of the channel - lots of scope for debugging here :-)
 286 sub state
 287 {
 288         my $self = shift;
 289         if (@_) {
 290                 $self->{oldstate} = $self->{state};
 291                 $self->{state} = shift;
 292                 $self->{func} = '' unless defined $self->{func};
 293                 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
 294
 295                 # if there is any queued up broadcasts then splurge them out here
 296                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'convers')) {
 297                         $self->send (@{$self->{delayed}});
 298                         delete $self->{delayed};
 299                 }
 300         }
 301         return $self->{state};
 302 }
 303
 304 # disconnect this channel
 305 sub disconnect
 306 {
 307         my $self = shift;
 308         my $user = $self->{user};
 309         my $conn = $self->{conn};
 310         my $call = $self->{call};
 311
 312         $self->finish();
 313         $conn->send_now("Z$call|bye") if $conn; # this will cause 'client' to disconnect
 314         $user->close() if defined $user;
 315         $conn->disconnect() if $conn;
 316         $self->del();
 317 }
 318
 319 #
 320 # just close all the socket connections down without any fiddling about, cleaning, being
 321 # nice to other processes and otherwise telling them what is going on.
 322 #
 323 # This is for the benefit of forked processes to prepare for starting new programs, they
 324 # don't want or need all this baggage.
 325 #
 326
 327 sub closeall
 328 {
 329         my $ref;
 330         foreach $ref (values %channels) {
 331                 $ref->{conn}->disconnect() if $ref->{conn};
 332         }
 333 }
 334
 335 # various access routines
 336
 337 #
 338 # return a list of valid elements
 339 #
 340
 341 sub fields
 342 {
 343         return keys(%valid);
 344 }
 345
 346 #
 347 # return a prompt for a field
 348 #
 349
 350 sub field_prompt
 351 {
 352         my ($self, $ele) = @_;
 353         return $valid{$ele};
 354 }
 355
 356 no strict;
 357 sub AUTOLOAD
 358 {
 359         my $self = shift;
 360         my $name = $AUTOLOAD;
 361         return if $name =~ /::DESTROY$/;
 362         $name =~ s/.*:://o;
 363
 364         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 365         @_ ? $self->{$name} = shift : $self->{$name} ;
 366 }
 367
 368 1;
 369 __END__;