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