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                   errors => '9,Errors',
  95                  );
  96
  97 # object destruction
  98 sub DESTROY
  99 {
 100         my $self = shift;
 101         for (keys %$self) {
 102                 if (ref($self->{$_})) {
 103                         delete $self->{$_};
 104                 }
 105         }
 106         dbg('chan', "DXChannel $self->{call} destroyed ($count)");
 107         $count--;
 108 }
 109
 110 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
 111 sub alloc
 112 {
 113         my ($pkg, $call, $conn, $user) = @_;
 114         my $self = {};
 115
 116         die "trying to create a duplicate channel for $call" if $channels{$call};
 117         $self->{call} = $call;
 118         $self->{priv} = 0;
 119         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
 120         if (defined $user) {
 121                 $self->{user} = $user;
 122                 $self->{lang} = $user->lang;
 123                 $user->new_group() if !$user->group;
 124                 $self->{group} = $user->group;
 125                 $self->{sort} = $user->sort;
 126         }
 127         $self->{startt} = $self->{t} = time;
 128         $self->{state} = 0;
 129         $self->{oldstate} = 0;
 130         $self->{lang} = $main::lang if !$self->{lang};
 131         $self->{func} = "";
 132
 133         $count++;
 134         dbg('chan', "DXChannel $self->{call} created ($count)");
 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 #
 154 # gimme all the ak1a nodes
 155 #
 156 sub get_all_nodes
 157 {
 158         my $ref;
 159         my @out;
 160         foreach $ref (values %channels) {
 161                 push @out, $ref if $ref->is_node;
 162         }
 163         return @out;
 164 }
 165
 166 # return a list of all users
 167 sub get_all_users
 168 {
 169         my $ref;
 170         my @out;
 171         foreach $ref (values %channels) {
 172                 push @out, $ref if $ref->is_user;
 173         }
 174         return @out;
 175 }
 176
 177 # return a list of all user callsigns
 178 sub get_all_user_calls
 179 {
 180         my $ref;
 181         my @out;
 182         foreach $ref (values %channels) {
 183                 push @out, $ref->{call} if $ref->is_user;
 184         }
 185         return @out;
 186 }
 187
 188 # obtain a channel object by searching for its connection reference
 189 sub get_by_cnum
 190 {
 191         my ($pkg, $conn) = @_;
 192         my $self;
 193
 194         foreach $self (values(%channels)) {
 195                 return $self if ($self->{conn} == $conn);
 196         }
 197         return undef;
 198 }
 199
 200 # get rid of a channel object [$obj->del()]
 201 sub del
 202 {
 203         my $self = shift;
 204
 205         $self->{group} = undef;         # belt and braces
 206         delete $channels{$self->{call}};
 207 }
 208
 209 # is it a bbs
 210 sub is_bbs
 211 {
 212         my $self = shift;
 213         return $self->{'sort'} eq 'B';
 214 }
 215
 216 sub is_node
 217 {
 218         my $self = shift;
 219         return $self->{'sort'} =~ /[ACRSX]/;
 220 }
 221 # is it an ak1a node ?
 222 sub is_ak1a
 223 {
 224         my $self = shift;
 225         return $self->{'sort'} eq 'A';
 226 }
 227
 228 # is it a user?
 229 sub is_user
 230 {
 231         my $self = shift;
 232         return $self->{'sort'} eq 'U';
 233 }
 234
 235 # is it a clx node
 236 sub is_clx
 237 {
 238         my $self = shift;
 239         return $self->{'sort'} eq 'C';
 240 }
 241
 242 # is it a spider node
 243 sub is_spider
 244 {
 245         my $self = shift;
 246         return $self->{'sort'} eq 'S';
 247 }
 248
 249 # is it a DXNet node
 250 sub is_dxnet
 251 {
 252         my $self = shift;
 253         return $self->{'sort'} eq 'X';
 254 }
 255
 256 # is it a ar-cluster node
 257 sub is_arcluster
 258 {
 259         my $self = shift;
 260         return $self->{'sort'} eq 'R';
 261 }
 262
 263 # for perl 5.004's benefit
 264 sub sort
 265 {
 266         my $self = shift;
 267         return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 268 }
 269
 270 # handle out going messages, immediately without waiting for the select to drop
 271 # this could, in theory, block
 272 sub send_now
 273 {
 274         my $self = shift;
 275         my $conn = $self->{conn};
 276         return unless $conn;
 277         my $sort = shift;
 278         my $call = $self->{call};
 279
 280         for (@_) {
 281 #               chomp;
 282         my @lines = split /\n/;
 283                 for (@lines) {
 284                         $conn->send_now("$sort$call|$_");
 285                         dbg('chan', "-> $sort $call $_");
 286                 }
 287         }
 288         $self->{t} = time;
 289 }
 290
 291 #
 292 # the normal output routine
 293 #
 294 sub send                                                # this is always later and always data
 295 {
 296         my $self = shift;
 297         my $conn = $self->{conn};
 298         return unless $conn;
 299         my $call = $self->{call};
 300
 301         for (@_) {
 302 #               chomp;
 303         my @lines = split /\n/;
 304                 for (@lines) {
 305                         $conn->send_later("D$call|$_");
 306                         dbg('chan', "-> D $call $_");
 307                 }
 308         }
 309         $self->{t} = time;
 310 }
 311
 312 # send a file (always later)
 313 sub send_file
 314 {
 315         my ($self, $fn) = @_;
 316         my $call = $self->{call};
 317         my $conn = $self->{conn};
 318         my @buf;
 319
 320         open(F, $fn) or die "can't open $fn for sending file ($!)";
 321         @buf = <F>;
 322         close(F);
 323         $self->send(@buf);
 324 }
 325
 326 # this will implement language independence (in time)
 327 sub msg
 328 {
 329         my $self = shift;
 330         return DXM::msg($self->{lang}, @_);
 331 }
 332
 333 # stick a broadcast on the delayed queue (but only up to 20 items)
 334 sub delay
 335 {
 336         my $self = shift;
 337         my $s = shift;
 338
 339         $self->{delayed} = [] unless $self->{delayed};
 340         push @{$self->{delayed}}, $s;
 341         if (@{$self->{delayed}} >= 20) {
 342                 shift @{$self->{delayed}};   # lose oldest one
 343         }
 344 }
 345
 346 # change the state of the channel - lots of scope for debugging here :-)
 347 sub state
 348 {
 349         my $self = shift;
 350         if (@_) {
 351                 $self->{oldstate} = $self->{state};
 352                 $self->{state} = shift;
 353                 $self->{func} = '' unless defined $self->{func};
 354                 dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
 355
 356                 # if there is any queued up broadcasts then splurge them out here
 357                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
 358                         $self->send (@{$self->{delayed}});
 359                         delete $self->{delayed};
 360                 }
 361         }
 362         return $self->{state};
 363 }
 364
 365 # disconnect this channel
 366 sub disconnect
 367 {
 368         my $self = shift;
 369         my $user = $self->{user};
 370
 371         $user->close() if defined $user;
 372         $self->{conn}->disconnect;
 373         $self->del();
 374 }
 375
 376 #
 377 # just close all the socket connections down without any fiddling about, cleaning, being
 378 # nice to other processes and otherwise telling them what is going on.
 379 #
 380 # This is for the benefit of forked processes to prepare for starting new programs, they
 381 # don't want or need all this baggage.
 382 #
 383
 384 sub closeall
 385 {
 386         my $ref;
 387         foreach $ref (values %channels) {
 388                 $ref->{conn}->disconnect() if $ref->{conn};
 389         }
 390 }
 391
 392 #
 393 # Tell all the users that we have come in or out (if they want to know)
 394 #
 395 sub tell_login
 396 {
 397         my ($self, $m) = @_;
 398
 399         # send info to all logged in thingies
 400         my @dxchan = get_all_users();
 401         my $dxchan;
 402         foreach $dxchan (@dxchan) {
 403                 next if $dxchan == $self;
 404                 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
 405         }
 406 }
 407
 408 # various access routines
 409
 410 #
 411 # return a list of valid elements
 412 #
 413
 414 sub fields
 415 {
 416         return keys(%valid);
 417 }
 418
 419 #
 420 # return a prompt for a field
 421 #
 422
 423 sub field_prompt
 424 {
 425         my ($self, $ele) = @_;
 426         return $valid{$ele};
 427 }
 428
 429 # take a standard input message and decode it into its standard parts
 430 sub decode_input
 431 {
 432         my $dxchan = shift;
 433         my $data = shift;
 434         my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
 435
 436         my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
 437
 438         # the above regexp must work
 439         unless (defined $sort && defined $call && defined $line) {
 440 #               $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
 441                 dbg('err', "DUFF Line on $chcall: $data");
 442                 return ();
 443         }
 444
 445         if(ref($dxchan) && $call ne $chcall) {
 446                 dbg('err', "DUFF Line come in for $call on wrong channel $chcall" );
 447                 return();
 448         }
 449
 450         return ($sort, $call, $line);
 451 }
 452
 453 no strict;
 454 sub AUTOLOAD
 455 {
 456         my $self = shift;
 457         my $name = $AUTOLOAD;
 458         return if $name =~ /::DESTROY$/;
 459         $name =~ s/.*:://o;
 460
 461         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 462
 463         # this clever line of code creates a subroutine which takes over from autoload
 464         # from OO Perl - Conway
 465         *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
 466     @_ ? $self->{$name} = shift : $self->{$name} ;
 467 }
 468
 469
 470 1;
 471 __END__;