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 and thus make it smaller and more efficient, then tough).
  21 #
  22 # Copyright (c) 1998-2000 - Dirk Koopman G1TLH
  23 #
  24 # $Id$
  25 #
  26 package DXChannel;
  27
  28 use Msg;
  29 use DXM;
  30 use DXUtil;
  31 use DXVars;
  32 use DXDebug;
  33 use Filter;
  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                   wcy => '0,Want WCY,yesno',
  56                   wx => '0,Want WX,yesno',
  57                   talk => '0,Want Talk,yesno',
  58                   ann => '0,Want Announce,yesno',
  59                   here => '0,Here?,yesno',
  60                   confmode => '0,In Conference?,yesno',
  61                   dx => '0,DX Spots,yesno',
  62                   redirect => '0,Redirect messages to',
  63                   lang => '0,Language',
  64                   func => '5,Function',
  65                   loc => '9,Local Vars', # used by func to store local variables in
  66                   beep => '0,Want Beeps,yesno',
  67                   lastread => '5,Last Msg Read',
  68                   outbound => '5,outbound?,yesno',
  69                   remotecmd => '9,doing rcmd,yesno',
  70                   pagelth => '0,Page Length',
  71                   pagedata => '9,Page Data Store',
  72                   group => '0,Access Group,parray',     # used to create a group of users/nodes for some purpose or other
  73                   isolate => '5,Isolate network,yesno',
  74                   delayed => '5,Delayed messages,parray',
  75                   annfilter => '5,Announce Filter',
  76                   wwvfilter => '5,WWV Filter',
  77                   wcyfilter => '5,WCY Filter',
  78                   spotsfilter => '5,Spot Filter',
  79                   inannfilter => '5,Input Ann Filter',
  80                   inwwvfilter => '5,Input WWV Filter',
  81                   inwcyfilter => '5,Input WCY Filter',
  82                   inspotsfilter => '5,Input Spot Filter',
  83                   passwd => '9,Passwd List,parray',
  84                   pingint => '5,Ping Interval ',
  85                   nopings => '5,Ping Obs Count',
  86                   lastping => '5,Ping last sent,atime',
  87                   pingtime => '5,Ping totaltime,parray',
  88                   pingave => '0,Ping ave time',
  89                   logininfo => '9,Login info req,yesno',
  90                   talklist => '0,Talk List,parray',
  91                   cluster => '5,Cluster data',
  92                   isbasic => '9,Internal Connection',
  93                  );
  94
  95 # object destruction
  96 sub DESTROY
  97 {
  98         my $self = shift;
  99         undef $self->{user};
 100         undef $self->{conn};
 101         undef $self->{loc};
 102         undef $self->{pagedata};
 103         undef $self->{group};
 104         undef $self->{delayed};
 105         undef $self->{annfilter};
 106         undef $self->{wwvfilter};
 107         undef $self->{spotsfilter};
 108         undef $self->{inannfilter};
 109         undef $self->{inwwvfilter};
 110         undef $self->{inspotsfilter};
 111         undef $self->{passwd};
 112         undef $self->{node};
 113 }
 114
 115 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
 116 sub alloc
 117 {
 118         my ($pkg, $call, $conn, $user) = @_;
 119         my $self = {};
 120
 121         die "trying to create a duplicate channel for $call" if $channels{$call};
 122         $self->{call} = $call;
 123         $self->{priv} = 0;
 124         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
 125         if (defined $user) {
 126                 $self->{user} = $user;
 127                 $self->{lang} = $user->lang;
 128                 $user->new_group() if !$user->group;
 129                 $self->{group} = $user->group;
 130                 $self->{sort} = $user->sort;
 131         }
 132         $self->{startt} = $self->{t} = time;
 133         $self->{state} = 0;
 134         $self->{oldstate} = 0;
 135         $self->{lang} = $main::lang if !$self->{lang};
 136         $self->{func} = "";
 137
 138         bless $self, $pkg;
 139         return $channels{$call} = $self;
 140 }
 141
 142 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
 143 sub get
 144 {
 145         my ($pkg, $call) = @_;
 146         return $channels{$call};
 147 }
 148
 149 # obtain all the channel objects
 150 sub get_all
 151 {
 152         my ($pkg) = @_;
 153         return values(%channels);
 154 }
 155
 156 #
 157 # gimme all the ak1a nodes
 158 #
 159 sub get_all_nodes
 160 {
 161         my $ref;
 162         my @out;
 163         foreach $ref (values %channels) {
 164                 push @out, $ref if $ref->is_node;
 165         }
 166         return @out;
 167 }
 168
 169 # return a list of all users
 170 sub get_all_users
 171 {
 172         my $ref;
 173         my @out;
 174         foreach $ref (values %channels) {
 175                 push @out, $ref if $ref->is_user;
 176         }
 177         return @out;
 178 }
 179
 180 # return a list of all user callsigns
 181 sub get_all_user_calls
 182 {
 183         my $ref;
 184         my @out;
 185         foreach $ref (values %channels) {
 186                 push @out, $ref->{call} if $ref->is_user;
 187         }
 188         return @out;
 189 }
 190
 191 # obtain a channel object by searching for its connection reference
 192 sub get_by_cnum
 193 {
 194         my ($pkg, $conn) = @_;
 195         my $self;
 196
 197         foreach $self (values(%channels)) {
 198                 return $self if ($self->{conn} == $conn);
 199         }
 200         return undef;
 201 }
 202
 203 # get rid of a channel object [$obj->del()]
 204 sub del
 205 {
 206         my $self = shift;
 207
 208         $self->{group} = undef;         # belt and braces
 209         delete $channels{$self->{call}};
 210 }
 211
 212 # is it a bbs
 213 sub is_bbs
 214 {
 215         my $self = shift;
 216         return $self->{'sort'} eq 'B';
 217 }
 218
 219 sub is_node
 220 {
 221         my $self = shift;
 222         return $self->{'sort'} =~ /[ACRSX]/;
 223 }
 224 # is it an ak1a node ?
 225 sub is_ak1a
 226 {
 227         my $self = shift;
 228         return $self->{'sort'} eq 'A';
 229 }
 230
 231 # is it a user?
 232 sub is_user
 233 {
 234         my $self = shift;
 235         return $self->{'sort'} eq 'U';
 236 }
 237
 238 # is it a clx node
 239 sub is_clx
 240 {
 241         my $self = shift;
 242         return $self->{'sort'} eq 'C';
 243 }
 244
 245 # is it a spider node
 246 sub is_spider
 247 {
 248         my $self = shift;
 249         return $self->{'sort'} eq 'S';
 250 }
 251
 252 # is it a DXNet node
 253 sub is_dxnet
 254 {
 255         my $self = shift;
 256         return $self->{'sort'} eq 'X';
 257 }
 258
 259 # is it a ar-cluster node
 260 sub is_arcluster
 261 {
 262         my $self = shift;
 263         return $self->{'sort'} eq 'R';
 264 }
 265
 266 # for perl 5.004's benefit
 267 sub sort
 268 {
 269         my $self = shift;
 270         return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 271 }
 272
 273 # handle out going messages, immediately without waiting for the select to drop
 274 # this could, in theory, block
 275 sub send_now
 276 {
 277         my $self = shift;
 278         my $conn = $self->{conn};
 279         return unless $conn;
 280         my $sort = shift;
 281         my $call = $self->{call};
 282
 283         for (@_) {
 284 #               chomp;
 285         my @lines = split /\n/;
 286                 for (@lines) {
 287                         $conn->send_now("$sort$call|$_");
 288                         dbg('chan', "-> $sort $call $_");
 289                 }
 290         }
 291         $self->{t} = time;
 292 }
 293
 294 #
 295 # the normal output routine
 296 #
 297 sub send                                                # this is always later and always data
 298 {
 299         my $self = shift;
 300         my $conn = $self->{conn};
 301         return unless $conn;
 302         my $call = $self->{call};
 303
 304         for (@_) {
 305 #               chomp;
 306         my @lines = split /\n/;
 307                 for (@lines) {
 308                         $conn->send_later("D$call|$_");
 309                         dbg('chan', "-> D $call $_");
 310                 }
 311         }
 312         $self->{t} = time;
 313 }
 314
 315 # send a file (always later)
 316 sub send_file
 317 {
 318         my ($self, $fn) = @_;
 319         my $call = $self->{call};
 320         my $conn = $self->{conn};
 321         my @buf;
 322
 323         open(F, $fn) or die "can't open $fn for sending file ($!)";
 324         @buf = <F>;
 325         close(F);
 326         $self->send(@buf);
 327 }
 328
 329 # this will implement language independence (in time)
 330 sub msg
 331 {
 332         my $self = shift;
 333         return DXM::msg($self->{lang}, @_);
 334 }
 335
 336 # stick a broadcast on the delayed queue (but only up to 20 items)
 337 sub delay
 338 {
 339         my $self = shift;
 340         my $s = shift;
 341
 342         $self->{delayed} = [] unless $self->{delayed};
 343         push @{$self->{delayed}}, $s;
 344         if (@{$self->{delayed}} >= 20) {
 345                 shift @{$self->{delayed}};   # lose oldest one
 346         }
 347 }
 348
 349 # change the state of the channel - lots of scope for debugging here :-)
 350 sub state
 351 {
 352         my $self = shift;
 353         if (@_) {
 354                 $self->{oldstate} = $self->{state};
 355                 $self->{state} = shift;
 356                 $self->{func} = '' unless defined $self->{func};
 357                 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
 358
 359                 # if there is any queued up broadcasts then splurge them out here
 360                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
 361                         $self->send (@{$self->{delayed}});
 362                         delete $self->{delayed};
 363                 }
 364         }
 365         return $self->{state};
 366 }
 367
 368 # disconnect this channel
 369 sub disconnect
 370 {
 371         my $self = shift;
 372         my $user = $self->{user};
 373         my $conn = $self->{conn};
 374         my $call = $self->{call};
 375
 376         $self->finish($conn);
 377         $user->close() if defined $user;
 378         $conn->disconnect() if $conn;
 379         $self->del();
 380 }
 381
 382 #
 383 # just close all the socket connections down without any fiddling about, cleaning, being
 384 # nice to other processes and otherwise telling them what is going on.
 385 #
 386 # This is for the benefit of forked processes to prepare for starting new programs, they
 387 # don't want or need all this baggage.
 388 #
 389
 390 sub closeall
 391 {
 392         my $ref;
 393         foreach $ref (values %channels) {
 394                 $ref->{conn}->disconnect() if $ref->{conn};
 395         }
 396 }
 397
 398 #
 399 # Tell all the users that we have come in or out (if they want to know)
 400 #
 401 sub tell_login
 402 {
 403         my ($self, $m) = @_;
 404
 405         # send info to all logged in thingies
 406         my @dxchan = get_all_users();
 407         my $dxchan;
 408         foreach $dxchan (@dxchan) {
 409                 next if $dxchan == $self;
 410                 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
 411         }
 412 }
 413
 414 # various access routines
 415
 416 #
 417 # return a list of valid elements
 418 #
 419
 420 sub fields
 421 {
 422         return keys(%valid);
 423 }
 424
 425 #
 426 # return a prompt for a field
 427 #
 428
 429 sub field_prompt
 430 {
 431         my ($self, $ele) = @_;
 432         return $valid{$ele};
 433 }
 434
 435 # take a standard input message and decode it into its standard parts
 436 sub decode_input
 437 {
 438         my $dxchan = shift;
 439         my $data = shift;
 440         my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
 441
 442         my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
 443
 444         # the above regexp must work
 445         unless (defined $sort && defined $call && defined $line) {
 446 #               $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
 447                 dbg('err', "DUFF Line on $chcall: $data");
 448                 return ();
 449         }
 450
 451         if(ref($dxchan) && $call ne $chcall) {
 452                 dbg('err', "DUFF Line come in for $call on wrong channel $chcall" );
 453                 return();
 454         }
 455
 456         return ($sort, $call, $line);
 457 }
 458
 459 no strict;
 460 sub AUTOLOAD
 461 {
 462         my $self = shift;
 463         my $name = $AUTOLOAD;
 464         return if $name =~ /::DESTROY$/;
 465         $name =~ s/.*:://o;
 466
 467         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 468
 469         # this clever line of code creates a subroutine which takes over from autoload
 470         # from OO Perl - Conway
 471         *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
 472     @_ ? $self->{$name} = shift : $self->{$name} ;
 473 }
 474
 475
 476 1;
 477 __END__;