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