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