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