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 Carp;
  28 use Minimuf;
  29 use DXDb;
  30 use Sun;
  31
  32 use strict;
  33 use vars qw(%Cache %cmd_cache $errstr %aliases $scriptbase);
  34
  35 %Cache = ();                                    # cache of dynamically loaded routine's mod times
  36 %cmd_cache = ();                                # cache of short names
  37 $errstr = ();                                   # error string from eval
  38 %aliases = ();                                  # aliases for (parts of) commands
  39 $scriptbase = "$main::root/scripts"; # the place where all users start scripts go
  40
  41 #
  42 # obtain a new connection this is derived from dxchannel
  43 #
  44
  45 sub new
  46 {
  47         my $self = DXChannel::alloc(@_);
  48         $self->{'sort'} = 'U';          # in absence of how to find out what sort of an object I am
  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;
  68         $self->{lang} = $user->lang;
  69         $self->{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->{talk} = $user->wanttalk;
  78         $self->{wx} = $user->wantwx;
  79         $self->{dx} = $user->wantdx;
  80         $self->{logininfo} = $user->wantlogininfo;
  81         $self->{here} = 1;
  82
  83         # add yourself to the database
  84         my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
  85         my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
  86         $node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
  87
  88         # issue a pc16 to everybody interested
  89         my $nchan = DXChannel->get($main::mycall);
  90         my @pc16 = DXProt::pc16($nchan, $cuser);
  91         for (@pc16) {
  92                 DXProt::broadcast_all_ak1a($_);
  93         }
  94         Log('DXCommand', "$call connected");
  95
  96         # send prompts and things
  97         my $info = DXCluster::cluster();
  98         $self->send("Cluster:$info");
  99         $self->send($self->msg('namee1')) if !$user->name;
 100         $self->send($self->msg('qthe1')) if !$user->qth;
 101         $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
 102         $self->send($self->msg('hnodee1')) if !$user->qth;
 103         $self->send($self->msg('m9')) if DXMsg::for_me($call);
 104         $self->send($self->msg('pr', $call));
 105
 106         $self->tell_login('loginu');
 107
 108 }
 109
 110 #
 111 # This is the normal command prompt driver
 112 #
 113
 114 sub normal
 115 {
 116         my $self = shift;
 117         my $cmdline = shift;
 118         my @ans;
 119
 120         # remove leading and trailing spaces
 121         $cmdline =~ s/^\s*(.*)\s*$/$1/;
 122
 123         if ($self->{state} eq 'page') {
 124                 my $i = $self->{pagelth};
 125                 my $ref = $self->{pagedata};
 126                 my $tot = @$ref;
 127
 128                 # abort if we get a line starting in with a
 129                 if ($cmdline =~ /^a/io) {
 130                         undef $ref;
 131                         $i = 0;
 132                 }
 133
 134                 # send a tranche of data
 135                 while ($i-- > 0 && @$ref) {
 136                         my $line = shift @$ref;
 137                         $line =~ s/\s+$//o;     # why am having to do this?
 138                         $self->send($line);
 139                 }
 140
 141                 # reset state if none or else chuck out an intermediate prompt
 142                 if ($ref && @$ref) {
 143                         $tot -= $self->{pagelth};
 144                         $self->send($self->msg('page', $tot));
 145                 } else {
 146                         $self->state('prompt');
 147                 }
 148         } elsif ($self->{state} eq 'sysop') {
 149                 my $passwd = $self->{user}->passwd;
 150                 my @pw = split / */, $passwd;
 151                 if ($passwd) {
 152                         my @l = @{$self->{passwd}};
 153                         my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
 154                         if ($cmdline =~ /$str/) {
 155                                 $self->{priv} = $self->{user}->priv;
 156                         } else {
 157                                 $self->send($self->msg('sorry'));
 158                         }
 159                 } else {
 160                         $self->send($self->msg('sorry'));
 161                 }
 162                 delete $self->{passwd};
 163                 $self->state('prompt');
 164         } else {
 165                 @ans = run_cmd($self, $cmdline);           # if length $cmdline;
 166
 167                 if ($self->{pagelth} && @ans > $self->{pagelth}) {
 168                         my $i;
 169                         for ($i = $self->{pagelth}; $i-- > 0; ) {
 170                                 my $line = shift @ans;
 171                                 $line =~ s/\s+$//o;     # why am having to do this?
 172                                 $self->send($line);
 173                         }
 174                         $self->{pagedata} =  \@ans;
 175                         $self->state('page');
 176                         $self->send($self->msg('page', scalar @ans));
 177                 } else {
 178                         for (@ans) {
 179                                 $self->send($_) if $_;
 180                         }
 181                 }
 182         }
 183
 184         # send a prompt only if we are in a prompt state
 185         $self->prompt() if $self->{state} =~ /^prompt/o;
 186 }
 187
 188 #
 189 # this is the thing that runs the command, it is done like this for the
 190 # benefit of remote command execution
 191 #
 192
 193 sub run_cmd
 194 {
 195         my $self = shift;
 196         my $user = $self->{user};
 197         my $call = $self->{call};
 198         my $cmdline = shift;
 199         my @ans;
 200
 201         if ($self->{func}) {
 202                 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
 203                 dbg('eval', "stored func cmd = $c\n");
 204                 eval  $c;
 205                 if ($@) {
 206                         return ("Syserr: Eval err $errstr on stored func $self->{func}", $@);
 207                 }
 208         } else {
 209
 210                 return () if length $cmdline == 0;
 211
 212                 # strip out //
 213                 $cmdline =~ s|//|/|og;
 214
 215                 # split the command line up into parts, the first part is the command
 216                 my ($cmd, $args) = split /\s+/, $cmdline, 2;
 217                 $args = "" unless $args;
 218
 219                 if ($cmd) {
 220
 221                         my ($path, $fcmd);
 222
 223                         dbg('command', "cmd: $cmd");
 224
 225                         # alias it if possible
 226                         my $acmd = CmdAlias::get_cmd($cmd);
 227                         if ($acmd) {
 228                                 ($cmd, $args) = split /\s+/, "$acmd $args", 2;
 229                                 $args = "" unless $args;
 230                                 dbg('command', "aliased cmd: $cmd $args");
 231                         }
 232
 233                         # first expand out the entry to a command
 234                         ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
 235                         ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
 236
 237                         if ($path && $cmd) {
 238                                 dbg('command', "path: $cmd cmd: $fcmd");
 239
 240                                 my $package = find_cmd_name($path, $fcmd);
 241                                 @ans = (0) if !$package ;
 242
 243                                 if ($package) {
 244                                         dbg('command', "package: $package");
 245                                         my $c;
 246                                         unless (exists $Cache{$package}->{'sub'}) {
 247                                                 $c = eval $Cache{$package}->{'eval'};
 248                                                 if ($@) {
 249                                                         return ("Syserr: Syntax error in $package", $@);
 250                                                 }
 251                                                 $Cache{$package}->{'sub'} = $c;
 252                                         }
 253                                         $c = $Cache{$package}->{'sub'};
 254                                         eval {
 255                                                 @ans = &{$c}($self, $args);
 256                                     };
 257
 258                                         return ($@) if $@;
 259                                 }
 260                         } else {
 261                                 dbg('command', "cmd: $cmd not found");
 262                                 return ($self->msg('e1'));
 263                         }
 264                 }
 265         }
 266
 267         shift @ans;
 268         return (@ans);
 269 }
 270
 271 #
 272 # This is called from inside the main cluster processing loop and is used
 273 # for despatching commands that are doing some long processing job
 274 #
 275 sub process
 276 {
 277         my $t = time;
 278         my @dxchan = DXChannel->get_all();
 279         my $dxchan;
 280
 281         foreach $dxchan (@dxchan) {
 282                 next if $dxchan->sort ne 'U';
 283
 284                 # send a prompt if no activity out on this channel
 285                 if ($t >= $dxchan->t + $main::user_interval) {
 286                         $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
 287                         $dxchan->t($t);
 288                 }
 289         }
 290 }
 291
 292 #
 293 # finish up a user context
 294 #
 295 sub finish
 296 {
 297         my $self = shift;
 298         my $call = $self->call;
 299
 300         # I was the last node visited
 301     $self->user->node($main::mycall);
 302
 303         # log out text
 304         if (-e "$main::data/logout") {
 305                 open(I, "$main::data/logout") or confess;
 306                 my @in = <I>;
 307                 close(I);
 308                 $self->send_now('D', @in);
 309                 sleep(1);
 310         }
 311
 312         if ($call eq $main::myalias) { # unset the channel if it is us really
 313                 my $node = DXNode->get($main::mycall);
 314                 $node->{dxchan} = 0;
 315         }
 316
 317         # issue a pc17 to everybody interested
 318         my $nchan = DXChannel->get($main::mycall);
 319         my $pc17 = $nchan->pc17($self);
 320         DXProt::broadcast_all_ak1a($pc17);
 321
 322         # send info to all logged in thingies
 323         $self->tell_login('logoutu');
 324
 325         Log('DXCommand', "$call disconnected");
 326         my $ref = DXCluster->get_exact($call);
 327         $ref->del() if $ref;
 328 }
 329
 330 #
 331 # short cut to output a prompt
 332 #
 333
 334 sub prompt
 335 {
 336         my $self = shift;
 337         $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call));
 338 }
 339
 340 # broadcast a message to all users [except those mentioned after buffer]
 341 sub broadcast
 342 {
 343         my $pkg = shift;                        # ignored
 344         my $s = shift;                          # the line to be rebroadcast
 345         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 346         my @list = DXChannel->get_all(); # just in case we are called from some funny object
 347         my ($dxchan, $except);
 348
 349  L: foreach $dxchan (@list) {
 350                 next if !$dxchan->sort eq 'U'; # only interested in user channels
 351                 foreach $except (@except) {
 352                         next L if $except == $dxchan;   # ignore channels in the 'except' list
 353                 }
 354                 $dxchan->send($s);                      # send it
 355         }
 356 }
 357
 358 # gimme all the users
 359 sub get_all
 360 {
 361         my @list = DXChannel->get_all();
 362         my $ref;
 363         my @out;
 364         foreach $ref (@list) {
 365                 push @out, $ref if $ref->sort eq 'U';
 366         }
 367         return @out;
 368 }
 369
 370 # run a script for this user
 371 sub run_script
 372 {
 373         my $self = shift;
 374         my $silent = shift || 0;
 375
 376 }
 377
 378 #
 379 # search for the command in the cache of short->long form commands
 380 #
 381
 382 sub search
 383 {
 384         my ($path, $short_cmd, $suffix) = @_;
 385         my ($apath, $acmd);
 386
 387         # commands are lower case
 388         $short_cmd = lc $short_cmd;
 389         dbg('command', "command: $path $short_cmd\n");
 390
 391         # do some checking for funny characters
 392         return () if $short_cmd =~ /\/$/;
 393
 394         # return immediately if we have it
 395         ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
 396         if ($apath && $acmd) {
 397                 dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
 398                 return ($apath, $acmd);
 399         }
 400
 401         # if not guess
 402         my @parts = split '/', $short_cmd;
 403         my $dirfn;
 404         my $curdir = $path;
 405         my $p;
 406         my $i;
 407         my @lparts;
 408
 409         for ($i = 0; $i < @parts; $i++) {
 410                 my  $p = $parts[$i];
 411                 opendir(D, $curdir) or confess "can't open $curdir $!";
 412                 my @ls = readdir D;
 413                 closedir D;
 414                 my $l;
 415                 foreach $l (sort @ls) {
 416                         next if $l =~ /^\./;
 417                         if ($i < $#parts) {             # we are dealing with directories
 418                                 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
 419                                         dbg('command', "got dir: $curdir/$l\n");
 420                                         $dirfn .= "$l/";
 421                                         $curdir .= "/$l";
 422                                         last;
 423                                 }
 424                         } else {                        # we are dealing with commands
 425                                 @lparts = split /\./, $l;
 426                                 next if $lparts[$#lparts] ne $suffix;        # only look for .$suffix files
 427                                 if ($p eq substr($l, 0, length $p)) {
 428                                         pop @lparts; #  remove the suffix
 429                                         $l = join '.', @lparts;
 430                                         #                 chop $dirfn;               # remove trailing /
 431                                         $dirfn = "" unless $dirfn;
 432                                         $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
 433                                         dbg('command', "got path: $path cmd: $dirfn$l\n");
 434                                         return ($path, "$dirfn$l");
 435                                 }
 436                         }
 437                 }
 438         }
 439         return ();
 440 }
 441
 442 # clear the command name cache
 443 sub clear_cmd_cache
 444 {
 445         %cmd_cache = ();
 446 }
 447
 448 #
 449 # the persistant execution of things from the command directories
 450 #
 451 #
 452 # This allows perl programs to call functions dynamically
 453 #
 454 # This has been nicked directly from the perlembed pages
 455 #
 456
 457 #require Devel::Symdump;
 458
 459 sub valid_package_name {
 460         my($string) = @_;
 461         $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
 462
 463         #second pass only for words starting with a digit
 464         $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
 465
 466         #Dress it up as a real package name
 467         $string =~ s/\//_/og;
 468         return $string;
 469 }
 470
 471 # find a cmd reference
 472 # this is really for use in user written stubs
 473 #
 474 # use the result as a symbolic reference:-
 475 #
 476 # no strict 'refs';
 477 # @out = &$r($self, $line);
 478 #
 479 sub find_cmd_ref
 480 {
 481         my $cmd = shift;
 482         my $r;
 483
 484         if ($cmd) {
 485
 486                 # first expand out the entry to a command
 487                 my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
 488                 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
 489
 490                 # make sure it is loaded
 491                 $r = find_cmd_name($path, $fcmd);
 492         }
 493         return $r;
 494 }
 495
 496 #
 497 # this bit of magic finds a command in the offered directory
 498 sub find_cmd_name {
 499         my $path = shift;
 500         my $cmdname = shift;
 501         my $package = valid_package_name($cmdname);
 502         my $filename = "$path/$cmdname.pl";
 503         my $mtime = -M $filename;
 504
 505         # return if we can't find it
 506         $errstr = undef;
 507         unless (defined $mtime) {
 508                 $errstr = DXM::msg('e1');
 509                 return undef;
 510         }
 511
 512         if(defined $Cache{$package}->{mtime} &&$Cache{$package}->{mtime} <= $mtime) {
 513                 #we have compiled this subroutine already,
 514                 #it has not been updated on disk, nothing left to do
 515                 #print STDERR "already compiled $package->handler\n";
 516                 ;
 517         } else {
 518
 519                 my $sub = readfilestr($filename);
 520                 unless ($sub) {
 521                         $errstr = "Syserr: can't open '$filename' $!";
 522                         return undef;
 523                 };
 524
 525                 #wrap the code into a subroutine inside our unique package
 526                 my $eval = qq( sub { $sub } );
 527
 528                 if (isdbg('eval')) {
 529                         my @list = split /\n/, $eval;
 530                         my $line;
 531                         for (@list) {
 532                                 dbg('eval', $_, "\n");
 533                         }
 534                 }
 535
 536                 $Cache{$package} = {mtime => $mtime, 'eval' => $eval };
 537         }
 538
 539         return $package;
 540 }
 541
 542 1;
 543 __END__