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