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