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,yesno',
  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                   badcount => '1,Bad Word Count',
 110                   edit => '7,Edit Function',
 111                   registered => '9,Registered?,yesno',
 112                   prompt => '0,Required Prompt',
 113                   version => '1,Node Version',
 114                   build => '1,Node Build',
 115                   verified => '9,Verified?,yesno',
 116                   newroute => '1,New Style Routing,yesno',
 117                   ve7cc => '0,VE7CC program special,yesno',
 118                   lastmsgpoll => '0,Last Msg Poll,atime',
 119                  );
 120
 121 use vars qw($VERSION $BRANCH);
 122 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
 123 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
 124 $main::build += $VERSION;
 125 $main::branch += $BRANCH;
 126
 127 # object destruction
 128 sub DESTROY
 129 {
 130         my $self = shift;
 131         for (keys %$self) {
 132                 if (ref($self->{$_})) {
 133                         delete $self->{$_};
 134                 }
 135         }
 136         dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
 137         $count--;
 138 }
 139
 140 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
 141 sub alloc
 142 {
 143         my ($pkg, $call, $conn, $user) = @_;
 144         my $self = {};
 145
 146         die "trying to create a duplicate channel for $call" if $channels{$call};
 147         $self->{call} = $call;
 148         $self->{priv} = 0;
 149         $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
 150         if (defined $user) {
 151                 $self->{user} = $user;
 152                 $self->{lang} = $user->lang;
 153                 $user->new_group() if !$user->group;
 154                 $self->{group} = $user->group;
 155                 $self->{sort} = $user->sort;
 156         }
 157         $self->{startt} = $self->{t} = time;
 158         $self->{state} = 0;
 159         $self->{oldstate} = 0;
 160         $self->{lang} = $main::lang if !$self->{lang};
 161         $self->{func} = "";
 162
 163         # add in all the dxcc, itu, zone info
 164         my @dxcc = Prefix::extract($call);
 165         if (@dxcc > 0) {
 166                 $self->{dxcc} = $dxcc[1]->dxcc;
 167                 $self->{itu} = $dxcc[1]->itu;
 168                 $self->{cq} = $dxcc[1]->cq;
 169         }
 170
 171         $count++;
 172         dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
 173         bless $self, $pkg;
 174         return $channels{$call} = $self;
 175 }
 176
 177 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
 178 sub get
 179 {
 180         my ($pkg, $call) = @_;
 181         return $channels{$call};
 182 }
 183
 184 # obtain all the channel objects
 185 sub get_all
 186 {
 187         my ($pkg) = @_;
 188         return values(%channels);
 189 }
 190
 191 #
 192 # gimme all the ak1a nodes
 193 #
 194 sub get_all_nodes
 195 {
 196         my $ref;
 197         my @out;
 198         foreach $ref (values %channels) {
 199                 push @out, $ref if $ref->is_node;
 200         }
 201         return @out;
 202 }
 203
 204 # return a list of all users
 205 sub get_all_users
 206 {
 207         my $ref;
 208         my @out;
 209         foreach $ref (values %channels) {
 210                 push @out, $ref if $ref->is_user;
 211         }
 212         return @out;
 213 }
 214
 215 # return a list of all user callsigns
 216 sub get_all_user_calls
 217 {
 218         my $ref;
 219         my @out;
 220         foreach $ref (values %channels) {
 221                 push @out, $ref->{call} if $ref->is_user;
 222         }
 223         return @out;
 224 }
 225
 226 # obtain a channel object by searching for its connection reference
 227 sub get_by_cnum
 228 {
 229         my ($pkg, $conn) = @_;
 230         my $self;
 231
 232         foreach $self (values(%channels)) {
 233                 return $self if ($self->{conn} == $conn);
 234         }
 235         return undef;
 236 }
 237
 238 # get rid of a channel object [$obj->del()]
 239 sub del
 240 {
 241         my $self = shift;
 242
 243         $self->{group} = undef;         # belt and braces
 244         delete $channels{$self->{call}};
 245 }
 246
 247 # is it a bbs
 248 sub is_bbs
 249 {
 250         my $self = shift;
 251         return $self->{'sort'} eq 'B';
 252 }
 253
 254 sub is_node
 255 {
 256         my $self = shift;
 257         return $self->{'sort'} =~ /[ACRSX]/;
 258 }
 259 # is it an ak1a node ?
 260 sub is_ak1a
 261 {
 262         my $self = shift;
 263         return $self->{'sort'} eq 'A';
 264 }
 265
 266 # is it a user?
 267 sub is_user
 268 {
 269         my $self = shift;
 270         return $self->{'sort'} eq 'U';
 271 }
 272
 273 # is it a clx node
 274 sub is_clx
 275 {
 276         my $self = shift;
 277         return $self->{'sort'} eq 'C';
 278 }
 279
 280 # is it a spider node
 281 sub is_spider
 282 {
 283         my $self = shift;
 284         return $self->{'sort'} eq 'S';
 285 }
 286
 287 # is it a DXNet node
 288 sub is_dxnet
 289 {
 290         my $self = shift;
 291         return $self->{'sort'} eq 'X';
 292 }
 293
 294 # is it a ar-cluster node
 295 sub is_arcluster
 296 {
 297         my $self = shift;
 298         return $self->{'sort'} eq 'R';
 299 }
 300
 301 # for perl 5.004's benefit
 302 sub sort
 303 {
 304         my $self = shift;
 305         return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 306 }
 307
 308 # find out whether we are prepared to believe this callsign on this interface
 309 sub is_believed
 310 {
 311         my $self = shift;
 312         my $call = shift;
 313
 314         return grep $call eq $_, $self->user->believe;
 315 }
 316
 317 # handle out going messages, immediately without waiting for the select to drop
 318 # this could, in theory, block
 319 sub send_now
 320 {
 321         my $self = shift;
 322         my $conn = $self->{conn};
 323         return unless $conn;
 324         my $sort = shift;
 325         my $call = $self->{call};
 326
 327         for (@_) {
 328 #               chomp;
 329         my @lines = split /\n/;
 330                 for (@lines) {
 331                         $conn->send_now("$sort$call|$_");
 332                         dbg("-> $sort $call $_") if isdbg('chan');
 333                 }
 334         }
 335         $self->{t} = time;
 336 }
 337
 338 #
 339 # send later with letter (more control)
 340 #
 341
 342 sub send_later
 343 {
 344         my $self = shift;
 345         my $conn = $self->{conn};
 346         return unless $conn;
 347         my $sort = shift;
 348         my $call = $self->{call};
 349
 350         for (@_) {
 351 #               chomp;
 352         my @lines = split /\n/;
 353                 for (@lines) {
 354                         $conn->send_later("$sort$call|$_");
 355                         dbg("-> $sort $call $_") if isdbg('chan');
 356                 }
 357         }
 358         $self->{t} = time;
 359 }
 360
 361 #
 362 # the normal output routine
 363 #
 364 sub send                                                # this is always later and always data
 365 {
 366         my $self = shift;
 367         my $conn = $self->{conn};
 368         return unless $conn;
 369         my $call = $self->{call};
 370
 371         for (@_) {
 372 #               chomp;
 373         my @lines = split /\n/;
 374                 for (@lines) {
 375                         $conn->send_later("D$call|$_");
 376                         dbg("-> D $call $_") if isdbg('chan');
 377                 }
 378         }
 379         $self->{t} = time;
 380 }
 381
 382 # send a file (always later)
 383 sub send_file
 384 {
 385         my ($self, $fn) = @_;
 386         my $call = $self->{call};
 387         my $conn = $self->{conn};
 388         my @buf;
 389
 390         open(F, $fn) or die "can't open $fn for sending file ($!)";
 391         @buf = <F>;
 392         close(F);
 393         $self->send(@buf);
 394 }
 395
 396 # this will implement language independence (in time)
 397 sub msg
 398 {
 399         my $self = shift;
 400         return DXM::msg($self->{lang}, @_);
 401 }
 402
 403 # stick a broadcast on the delayed queue (but only up to 20 items)
 404 sub delay
 405 {
 406         my $self = shift;
 407         my $s = shift;
 408
 409         $self->{delayed} = [] unless $self->{delayed};
 410         push @{$self->{delayed}}, $s;
 411         if (@{$self->{delayed}} >= 20) {
 412                 shift @{$self->{delayed}};   # lose oldest one
 413         }
 414 }
 415
 416 # change the state of the channel - lots of scope for debugging here :-)
 417 sub state
 418 {
 419         my $self = shift;
 420         if (@_) {
 421                 $self->{oldstate} = $self->{state};
 422                 $self->{state} = shift;
 423                 $self->{func} = '' unless defined $self->{func};
 424                 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
 425
 426                 # if there is any queued up broadcasts then splurge them out here
 427                 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
 428                         $self->send (@{$self->{delayed}});
 429                         delete $self->{delayed};
 430                 }
 431         }
 432         return $self->{state};
 433 }
 434
 435 # disconnect this channel
 436 sub disconnect
 437 {
 438         my $self = shift;
 439         my $user = $self->{user};
 440
 441         main::clean_inqueue($self);          # clear out any remaining incoming frames
 442         $user->close() if defined $user;
 443         $self->{conn}->disconnect;
 444         $self->del();
 445 }
 446
 447 #
 448 # just close all the socket connections down without any fiddling about, cleaning, being
 449 # nice to other processes and otherwise telling them what is going on.
 450 #
 451 # This is for the benefit of forked processes to prepare for starting new programs, they
 452 # don't want or need all this baggage.
 453 #
 454
 455 sub closeall
 456 {
 457         my $ref;
 458         foreach $ref (values %channels) {
 459                 $ref->{conn}->disconnect() if $ref->{conn};
 460         }
 461 }
 462
 463 #
 464 # Tell all the users that we have come in or out (if they want to know)
 465 #
 466 sub tell_login
 467 {
 468         my ($self, $m) = @_;
 469
 470         # send info to all logged in thingies
 471         my @dxchan = get_all_users();
 472         my $dxchan;
 473         foreach $dxchan (@dxchan) {
 474                 next if $dxchan == $self;
 475                 next if $dxchan->{call} eq $main::mycall;
 476                 $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
 477         }
 478 }
 479
 480 # various access routines
 481
 482 #
 483 # return a list of valid elements
 484 #
 485
 486 sub fields
 487 {
 488         return keys(%valid);
 489 }
 490
 491 #
 492 # return a prompt for a field
 493 #
 494
 495 sub field_prompt
 496 {
 497         my ($self, $ele) = @_;
 498         return $valid{$ele};
 499 }
 500
 501 # take a standard input message and decode it into its standard parts
 502 sub decode_input
 503 {
 504         my $dxchan = shift;
 505         my $data = shift;
 506         my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
 507
 508         my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
 509
 510         # the above regexp must work
 511         unless (defined $sort && defined $call && defined $line) {
 512 #               $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
 513                 dbg("DUFF Line on $chcall: $data");
 514                 return ();
 515         }
 516
 517         if(ref($dxchan) && $call ne $chcall) {
 518                 dbg("DUFF Line come in for $call on wrong channel $chcall");
 519                 return();
 520         }
 521
 522         return ($sort, $call, $line);
 523 }
 524
 525 sub rspfcheck
 526 {
 527         my ($self, $flag, $node, $user) = @_;
 528         my $nref = Route::Node::get($node);
 529         my $dxchan = $nref->dxchan if $nref;
 530         if ($nref && $dxchan) {
 531             if ($dxchan == $self) {
 532                         return 1 unless $user;
 533                         return 1 if $user eq $node;
 534                         my @users = $nref->users;
 535                         return 1 if @users == 0 || grep $user eq $_, @users;
 536                         dbg("RSPF: $user not on $node") if isdbg('chanerr');
 537                 } else {
 538                         dbg("RSPF: Shortest path for $node is " . $nref->dxchan->{call}) if isdbg('chanerr');
 539                 }
 540         } else {
 541                 return 1 if $flag;
 542                 dbg("RSPF: required $node not found" ) if isdbg('chanerr');
 543         }
 544         return 0;
 545 }
 546
 547 # broadcast a message to all clusters taking into account isolation
 548 # [except those mentioned after buffer]
 549 sub broadcast_nodes
 550 {
 551         my $s = shift;                          # the line to be rebroadcast
 552         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 553         my @dxchan = DXChannel::get_all_nodes();
 554         my $dxchan;
 555
 556         # send it if it isn't the except list and isn't isolated and still has a hop count
 557         foreach $dxchan (@dxchan) {
 558                 next if grep $dxchan == $_, @except;
 559                 next if $dxchan == $main::me;
 560
 561                 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s;      # adjust its hop count by node name
 562
 563                 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
 564         }
 565 }
 566
 567 # broadcast a message to all clusters ignoring isolation
 568 # [except those mentioned after buffer]
 569 sub broadcast_all_nodes
 570 {
 571         my $s = shift;                          # the line to be rebroadcast
 572         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 573         my @dxchan = DXChannel::get_all_nodes();
 574         my $dxchan;
 575
 576         # send it if it isn't the except list and isn't isolated and still has a hop count
 577         foreach $dxchan (@dxchan) {
 578                 next if grep $dxchan == $_, @except;
 579                 next if $dxchan == $main::me;
 580
 581                 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s;      # adjust its hop count by node name
 582                 $dxchan->send($routeit);
 583         }
 584 }
 585
 586 # broadcast to all users
 587 # storing the spot or whatever until it is in a state to receive it
 588 sub broadcast_users
 589 {
 590         my $s = shift;                          # the line to be rebroadcast
 591         my $sort = shift;           # the type of transmission
 592         my $fref = shift;           # a reference to an object to filter on
 593         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 594         my @dxchan = DXChannel::get_all_users();
 595         my $dxchan;
 596         my @out;
 597
 598         foreach $dxchan (@dxchan) {
 599                 next if grep $dxchan == $_, @except;
 600                 push @out, $dxchan;
 601         }
 602         broadcast_list($s, $sort, $fref, @out);
 603 }
 604
 605
 606 # broadcast to a list of users
 607 sub broadcast_list
 608 {
 609         my $s = shift;
 610         my $sort = shift;
 611         my $fref = shift;
 612         my $dxchan;
 613
 614         foreach $dxchan (@_) {
 615                 my $filter = 1;
 616                 next if $dxchan == $main::me;
 617
 618                 if ($sort eq 'dx') {
 619                     next unless $dxchan->{dx};
 620                         ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
 621                         next unless $filter;
 622                 }
 623                 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
 624                 next if $sort eq 'wwv' && !$dxchan->{wwv};
 625                 next if $sort eq 'wcy' && !$dxchan->{wcy};
 626                 next if $sort eq 'wx' && !$dxchan->{wx};
 627
 628                 $s =~ s/\a//og unless $dxchan->{beep};
 629
 630                 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
 631                         $dxchan->send($s);
 632                 } else {
 633                         $dxchan->delay($s);
 634                 }
 635         }
 636 }
 637
 638
 639 #no strict;
 640 sub AUTOLOAD
 641 {
 642         no strict;
 643         my $name = $AUTOLOAD;
 644         return if $name =~ /::DESTROY$/;
 645         $name =~ s/^.*:://o;
 646
 647         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 648
 649         # this clever line of code creates a subroutine which takes over from autoload
 650         # from OO Perl - Conway
 651         *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
 652         goto &$AUTOLOAD;
 653 }
 654
 655
 656 1;
 657 __END__;