perl/DXCommandmode.pm

   1 #!/usr/bin/perl
   2 #
   3 # This module impliments the user facing command mode for a dx cluster
   4 #
   5 # Copyright (c) 1998 Dirk Koopman G1TLH
   6 #
   7 # $Id$
   8 #
   9
  10 package DXCommandmode;
  11
  12 use POSIX;
  13
  14 @ISA = qw(DXChannel);
  15
  16 use DXUtil;
  17 use DXChannel;
  18 use DXUser;
  19 use DXVars;
  20 use DXDebug;
  21 use DXM;
  22 use DXLog;
  23 use DXLogPrint;
  24 use DXBearing;
  25 use CmdAlias;
  26 use Filter;
  27 use Minimuf;
  28 use DXDb;
  29 use AnnTalk;
  30 use WCY;
  31 use Sun;
  32
  33 use strict;
  34 use vars qw(%Cache %cmd_cache $errstr %aliases $scriptbase);
  35
  36 %Cache = ();                                    # cache of dynamically loaded routine's mod times
  37 %cmd_cache = ();                                # cache of short names
  38 $errstr = ();                                   # error string from eval
  39 %aliases = ();                                  # aliases for (parts of) commands
  40 $scriptbase = "$main::root/scripts"; # the place where all users start scripts go
  41
  42 #
  43 # obtain a new connection this is derived from dxchannel
  44 #
  45
  46 sub new
  47 {
  48         my $self = DXChannel::alloc(@_);
  49         return $self;
  50 }
  51
  52 # this is how a a connection starts, you get a hello message and the motd with
  53 # possibly some other messages asking you to set various things up if you are
  54 # new (or nearly new and slacking) user.
  55
  56 sub start
  57 {
  58         my ($self, $line, $sort) = @_;
  59         my $user = $self->{user};
  60         my $call = $self->{call};
  61         my $name = $user->{name};
  62
  63         $self->{name} = $name ? $name : $call;
  64         $self->send($self->msg('l2',$self->{name}));
  65         $self->send_file($main::motd) if (-e $main::motd);
  66         $self->state('prompt');         # a bit of room for further expansion, passwords etc
  67         $self->{priv} = $user->priv || 0;
  68         $self->{lang} = $user->lang || 'en';
  69         $self->{pagelth} = $user->pagelth || 20;
  70         $self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
  71         $self->{consort} = $line;       # save the connection type
  72
  73         # set some necessary flags on the user if they are connecting
  74         $self->{beep} = $user->wantbeep;
  75         $self->{ann} = $user->wantann;
  76         $self->{wwv} = $user->wantwwv;
  77         $self->{wcy} = $user->wantwcy;
  78         $self->{talk} = $user->wanttalk;
  79         $self->{wx} = $user->wantwx;
  80         $self->{dx} = $user->wantdx;
  81         $self->{logininfo} = $user->wantlogininfo;
  82         $self->{here} = 1;
  83
  84         # get the filters
  85         $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'user_default', 0);
  86         $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'user_default', 0);
  87         $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'user_default', 0);
  88         $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'user_default', 0) ;
  89
  90         # clean up qra locators
  91         my $qra = $user->qra;
  92         $qra = undef if ($qra && !DXBearing::is_qra($qra));
  93         unless ($qra) {
  94                 my $lat = $user->lat;
  95                 my $long = $user->long;
  96                 $user->qra(DXBearing::lltoqra($lat, $long)) if (defined $lat && defined $long);
  97         }
  98
  99         # add yourself to the database
 100         my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
 101         my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
 102         $node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
 103
 104         # issue a pc16 to everybody interested
 105         my $nchan = DXChannel->get($main::mycall);
 106         my @pc16 = DXProt::pc16($nchan, $cuser);
 107         for (@pc16) {
 108                 DXProt::broadcast_all_ak1a($_);
 109         }
 110         Log('DXCommand', "$call connected");
 111
 112         # send prompts and things
 113         my $info = DXCluster::cluster();
 114         $self->send("Cluster:$info");
 115         $self->send($self->msg('namee1')) if !$user->name;
 116         $self->send($self->msg('qthe1')) if !$user->qth;
 117         $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
 118         $self->send($self->msg('hnodee1')) if !$user->qth;
 119         $self->send($self->msg('m9')) if DXMsg::for_me($call);
 120         $self->send($self->msg('pr', $call));
 121
 122         # decide on echo
 123         if (!$user->wantecho) {
 124                 $self->send_now('E', "0");
 125                 $self->send($self->msg('echow'));
 126         }
 127
 128         $self->tell_login('loginu');
 129
 130 }
 131
 132 #
 133 # This is the normal command prompt driver
 134 #
 135
 136 sub normal
 137 {
 138         my $self = shift;
 139         my $cmdline = shift;
 140         my @ans;
 141
 142         # remove leading and trailing spaces
 143         $cmdline =~ s/^\s*(.*)\s*$/$1/;
 144
 145         if ($self->{state} eq 'page') {
 146                 my $i = $self->{pagelth};
 147                 my $ref = $self->{pagedata};
 148                 my $tot = @$ref;
 149
 150                 # abort if we get a line starting in with a
 151                 if ($cmdline =~ /^a/io) {
 152                         undef $ref;
 153                         $i = 0;
 154                 }
 155
 156                 # send a tranche of data
 157                 while ($i-- > 0 && @$ref) {
 158                         my $line = shift @$ref;
 159                         $line =~ s/\s+$//o;     # why am having to do this?
 160                         $self->send($line);
 161                 }
 162
 163                 # reset state if none or else chuck out an intermediate prompt
 164                 if ($ref && @$ref) {
 165                         $tot -= $self->{pagelth};
 166                         $self->send($self->msg('page', $tot));
 167                 } else {
 168                         $self->state('prompt');
 169                 }
 170         } elsif ($self->{state} eq 'sysop') {
 171                 my $passwd = $self->{user}->passwd;
 172                 my @pw = split / */, $passwd;
 173                 if ($passwd) {
 174                         my @l = @{$self->{passwd}};
 175                         my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
 176                         if ($cmdline =~ /$str/) {
 177                                 $self->{priv} = $self->{user}->priv;
 178                         } else {
 179                                 $self->send($self->msg('sorry'));
 180                         }
 181                 } else {
 182                         $self->send($self->msg('sorry'));
 183                 }
 184                 delete $self->{passwd};
 185                 $self->state('prompt');
 186         } elsif ($self->{state} eq 'talk') {
 187                 if ($cmdline =~ m{^(?:/EX|/ABORT)}i) {
 188                         for (@{$self->{talklist}}) {
 189                                 $self->send_talks($_,  $self->msg('talkend'));
 190                         }
 191                         $self->state('prompt');
 192                         delete $self->{talklist};
 193                 } elsif ($cmdline =~ m(^/\w+)) {
 194                         $cmdline =~ s(^/)();
 195                         $self->send_ans(run_cmd($self, $cmdline));
 196                         $self->send($self->talk_prompt);
 197                 } elsif ($self->{talklist} && @{$self->{talklist}}) {
 198                         # send what has been said to whoever is in this person's talk list
 199                         for (@{$self->{talklist}}) {
 200                                 $self->send_talks($_, $cmdline);
 201                         }
 202                         $self->send($self->talk_prompt) if $self->{state} eq 'talk';
 203                 } else {
 204                         # for safety
 205                         $self->state('prompt');
 206                 }
 207         } else {
 208                 $self->send_ans(run_cmd($self, $cmdline));
 209         }
 210
 211         # send a prompt only if we are in a prompt state
 212         $self->prompt() if $self->{state} =~ /^prompt/o;
 213 }
 214
 215 # send out the talk messages taking into account vias and connectivity
 216 sub send_talks
 217 {
 218         my ($self, $ent, $line) = @_;
 219
 220         my ($to, $via) = $ent =~ /(\S+)>(\S+)/;
 221         $to = $ent unless $to;
 222         my $call = $via ? $via : $to;
 223         my $clref = DXCluster->get_exact($call);
 224         my $dxchan = $clref->dxchan if $clref;
 225         if ($dxchan) {
 226                 $dxchan->talk($self->{call}, $to, $via, $line);
 227         } else {
 228                 $self->send($self->msg('disc2', $via ? $via : $to));
 229                 my @l = grep { $_ ne $ent } @{$self->{talklist}};
 230                 if (@l) {
 231                         $self->{talklist} = \@l;
 232                 } else {
 233                         delete $self->{talklist};
 234                         $self->state('prompt');
 235                 }
 236         }
 237 }
 238
 239 sub talk_prompt
 240 {
 241         my $self = shift;
 242         my @call;
 243         for (@{$self->{talklist}}) {
 244                 my ($to, $via) = /(\S+)>(\S+)/;
 245                 $to = $_ unless $to;
 246                 push @call, $to;
 247         }
 248         return $self->msg('talkprompt', join(',', @call));
 249 }
 250
 251 #
 252 # send a load of stuff to a command user with page prompting
 253 # and stuff
 254 #
 255
 256 sub send_ans
 257 {
 258         my $self = shift;
 259
 260         if ($self->{pagelth} && @_ > $self->{pagelth}) {
 261                 my $i;
 262                 for ($i = $self->{pagelth}; $i-- > 0; ) {
 263                         my $line = shift @_;
 264                         $line =~ s/\s+$//o;     # why am having to do this?
 265                         $self->send($line);
 266                 }
 267                 $self->{pagedata} =  [ @_ ];
 268                 $self->state('page');
 269                 $self->send($self->msg('page', scalar @_));
 270         } else {
 271                 for (@_) {
 272                         $self->send($_) if $_;
 273                 }
 274         }
 275 }
 276 #
 277 # this is the thing that runs the command, it is done like this for the
 278 # benefit of remote command execution
 279 #
 280
 281 sub run_cmd
 282 {
 283         my $self = shift;
 284         my $user = $self->{user};
 285         my $call = $self->{call};
 286         my $cmdline = shift;
 287         my @ans;
 288
 289         if ($self->{func}) {
 290                 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
 291                 dbg('eval', "stored func cmd = $c\n");
 292                 eval  $c;
 293                 if ($@) {
 294                         return ("Syserr: Eval err $errstr on stored func $self->{func}", $@);
 295                 }
 296         } else {
 297
 298                 return () if length $cmdline == 0;
 299
 300                 # strip out //
 301                 $cmdline =~ s|//|/|og;
 302
 303                 # split the command line up into parts, the first part is the command
 304                 my ($cmd, $args) = split /\s+/, $cmdline, 2;
 305                 $args = "" unless defined $args;
 306
 307                 if ($cmd) {
 308
 309                         my ($path, $fcmd);
 310
 311                         dbg('command', "cmd: $cmd");
 312
 313                         # alias it if possible
 314                         my $acmd = CmdAlias::get_cmd($cmd);
 315                         if ($acmd) {
 316                                 ($cmd, $args) = split /\s+/, "$acmd $args", 2;
 317                                 $args = "" unless defined $args;
 318                                 dbg('command', "aliased cmd: $cmd $args");
 319                         }
 320
 321                         # first expand out the entry to a command
 322                         ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
 323                         ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
 324
 325                         if ($path && $cmd) {
 326                                 dbg('command', "path: $cmd cmd: $fcmd");
 327
 328                                 my $package = find_cmd_name($path, $fcmd);
 329                                 @ans = (0) if !$package ;
 330
 331                                 if ($package) {
 332                                         dbg('command', "package: $package");
 333                                         my $c;
 334                                         unless (exists $Cache{$package}->{'sub'}) {
 335                                                 $c = eval $Cache{$package}->{'eval'};
 336                                                 if ($@) {
 337                                                         return DXDebug::shortmess($@);
 338                                                 }
 339                                                 $Cache{$package}->{'sub'} = $c;
 340                                         }
 341                                         $c = $Cache{$package}->{'sub'};
 342                                         eval {
 343                                                 @ans = &{$c}($self, $args);
 344                                     };
 345
 346                                         if ($@) {
 347                                                 #cluck($@);
 348                                                 return (DXDebug::shortmess($@));
 349                                         };
 350                                 }
 351                         } else {
 352                                 dbg('command', "cmd: $cmd not found");
 353                                 return ($self->msg('e1'));
 354                         }
 355                 }
 356         }
 357
 358         shift @ans;
 359         return (@ans);
 360 }
 361
 362 #
 363 # This is called from inside the main cluster processing loop and is used
 364 # for despatching commands that are doing some long processing job
 365 #
 366 sub process
 367 {
 368         my $t = time;
 369         my @dxchan = DXChannel->get_all();
 370         my $dxchan;
 371
 372         foreach $dxchan (@dxchan) {
 373                 next if $dxchan->sort ne 'U';
 374
 375                 # send a prompt if no activity out on this channel
 376                 if ($t >= $dxchan->t + $main::user_interval) {
 377                         $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
 378                         $dxchan->t($t);
 379                 }
 380         }
 381 }
 382
 383 #
 384 # finish up a user context
 385 #
 386 sub finish
 387 {
 388         my $self = shift;
 389         my $conn = shift;
 390         my $call = $self->call;
 391
 392         # I was the last node visited
 393     $self->user->node($main::mycall);
 394
 395         # log out text
 396         if ($conn && -e "$main::data/logout") {
 397                 open(I, "$main::data/logout") or confess;
 398                 my @in = <I>;
 399                 close(I);
 400                 $self->send_now('D', @in);
 401                 sleep(1);
 402         }
 403
 404 #       if ($call eq $main::myalias) { # unset the channel if it is us really
 405 #               my $node = DXNode->get($main::mycall);
 406 #               $node->{dxchan} = 0;
 407 #       }
 408
 409         # issue a pc17 to everybody interested
 410         my $nchan = DXChannel->get($main::mycall);
 411         my $pc17 = $nchan->pc17($self);
 412         DXProt::broadcast_all_ak1a($pc17);
 413
 414         # send info to all logged in thingies
 415         $self->tell_login('logoutu');
 416
 417         Log('DXCommand', "$call disconnected");
 418         my $ref = DXCluster->get_exact($call);
 419         $ref->del() if $ref;
 420 }
 421
 422 #
 423 # short cut to output a prompt
 424 #
 425
 426 sub prompt
 427 {
 428         my $self = shift;
 429         $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call));
 430 }
 431
 432 # broadcast a message to all users [except those mentioned after buffer]
 433 sub broadcast
 434 {
 435         my $pkg = shift;                        # ignored
 436         my $s = shift;                          # the line to be rebroadcast
 437         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 438         my @list = DXChannel->get_all(); # just in case we are called from some funny object
 439         my ($dxchan, $except);
 440
 441  L: foreach $dxchan (@list) {
 442                 next if !$dxchan->sort eq 'U'; # only interested in user channels
 443                 foreach $except (@except) {
 444                         next L if $except == $dxchan;   # ignore channels in the 'except' list
 445                 }
 446                 $dxchan->send($s);                      # send it
 447         }
 448 }
 449
 450 # gimme all the users
 451 sub get_all
 452 {
 453         my @list = DXChannel->get_all();
 454         my $ref;
 455         my @out;
 456         foreach $ref (@list) {
 457                 push @out, $ref if $ref->sort eq 'U';
 458         }
 459         return @out;
 460 }
 461
 462 # run a script for this user
 463 sub run_script
 464 {
 465         my $self = shift;
 466         my $silent = shift || 0;
 467
 468 }
 469
 470 #
 471 # search for the command in the cache of short->long form commands
 472 #
 473
 474 sub search
 475 {
 476         my ($path, $short_cmd, $suffix) = @_;
 477         my ($apath, $acmd);
 478
 479         # commands are lower case
 480         $short_cmd = lc $short_cmd;
 481         dbg('command', "command: $path $short_cmd\n");
 482
 483         # do some checking for funny characters
 484         return () if $short_cmd =~ /\/$/;
 485
 486         # return immediately if we have it
 487         ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
 488         if ($apath && $acmd) {
 489                 dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
 490                 return ($apath, $acmd);
 491         }
 492
 493         # if not guess
 494         my @parts = split '/', $short_cmd;
 495         my $dirfn;
 496         my $curdir = $path;
 497         my $p;
 498         my $i;
 499         my @lparts;
 500
 501         for ($i = 0; $i < @parts; $i++) {
 502                 my  $p = $parts[$i];
 503                 opendir(D, $curdir) or confess "can't open $curdir $!";
 504                 my @ls = readdir D;
 505                 closedir D;
 506                 my $l;
 507                 foreach $l (sort @ls) {
 508                         next if $l =~ /^\./;
 509                         if ($i < $#parts) {             # we are dealing with directories
 510                                 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
 511                                         dbg('command', "got dir: $curdir/$l\n");
 512                                         $dirfn .= "$l/";
 513                                         $curdir .= "/$l";
 514                                         last;
 515                                 }
 516                         } else {                        # we are dealing with commands
 517                                 @lparts = split /\./, $l;
 518                                 next if $lparts[$#lparts] ne $suffix;        # only look for .$suffix files
 519                                 if ($p eq substr($l, 0, length $p)) {
 520                                         pop @lparts; #  remove the suffix
 521                                         $l = join '.', @lparts;
 522                                         #                 chop $dirfn;               # remove trailing /
 523                                         $dirfn = "" unless $dirfn;
 524                                         $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
 525                                         dbg('command', "got path: $path cmd: $dirfn$l\n");
 526                                         return ($path, "$dirfn$l");
 527                                 }
 528                         }
 529                 }
 530         }
 531         return ();
 532 }
 533
 534 # clear the command name cache
 535 sub clear_cmd_cache
 536 {
 537         %cmd_cache = ();
 538 }
 539
 540 #
 541 # the persistant execution of things from the command directories
 542 #
 543 #
 544 # This allows perl programs to call functions dynamically
 545 #
 546 # This has been nicked directly from the perlembed pages
 547 #
 548
 549 #require Devel::Symdump;
 550
 551 sub valid_package_name {
 552         my($string) = @_;
 553         $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
 554
 555         #second pass only for words starting with a digit
 556         $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
 557
 558         #Dress it up as a real package name
 559         $string =~ s/\//_/og;
 560         return $string;
 561 }
 562
 563 # find a cmd reference
 564 # this is really for use in user written stubs
 565 #
 566 # use the result as a symbolic reference:-
 567 #
 568 # no strict 'refs';
 569 # @out = &$r($self, $line);
 570 #
 571 sub find_cmd_ref
 572 {
 573         my $cmd = shift;
 574         my $r;
 575
 576         if ($cmd) {
 577
 578                 # first expand out the entry to a command
 579                 my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
 580                 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
 581
 582                 # make sure it is loaded
 583                 $r = find_cmd_name($path, $fcmd);
 584         }
 585         return $r;
 586 }
 587
 588 #
 589 # this bit of magic finds a command in the offered directory
 590 sub find_cmd_name {
 591         my $path = shift;
 592         my $cmdname = shift;
 593         my $package = valid_package_name($cmdname);
 594         my $filename = "$path/$cmdname.pl";
 595         my $mtime = -M $filename;
 596
 597         # return if we can't find it
 598         $errstr = undef;
 599         unless (defined $mtime) {
 600                 $errstr = DXM::msg('e1');
 601                 return undef;
 602         }
 603
 604         if(defined $Cache{$package}->{mtime} &&$Cache{$package}->{mtime} <= $mtime) {
 605                 #we have compiled this subroutine already,
 606                 #it has not been updated on disk, nothing left to do
 607                 #print STDERR "already compiled $package->handler\n";
 608                 ;
 609         } else {
 610
 611                 my $sub = readfilestr($filename);
 612                 unless ($sub) {
 613                         $errstr = "Syserr: can't open '$filename' $!";
 614                         return undef;
 615                 };
 616
 617                 #wrap the code into a subroutine inside our unique package
 618                 my $eval = qq( sub { $sub } );
 619
 620                 if (isdbg('eval')) {
 621                         my @list = split /\n/, $eval;
 622                         my $line;
 623                         for (@list) {
 624                                 dbg('eval', $_, "\n");
 625                         }
 626                 }
 627
 628                 $Cache{$package} = {mtime => $mtime, 'eval' => $eval };
 629         }
 630
 631         return $package;
 632 }
 633
 634 # send a talk message here
 635 sub talk
 636 {
 637         my ($self, $from, $to, $via, $line) = @_;
 638         $line =~ s/\\5E/\^/g;
 639         $self->send("$to de $from: $line") if $self->{talk};
 640         Log('talk', $to, $from, $main::mycall, $line);
 641 }
 642
 643 # send an announce
 644 sub announce
 645 {
 646
 647 }
 648
 649 # send a dx spot
 650 sub dx_spot
 651 {
 652
 653 }
 654
 655 1;
 656 __END__