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 @ISA = qw(DXChannel);
  13
  14 use DXUtil;
  15 use DXChannel;
  16 use DXUser;
  17 use DXVars;
  18 use DXDebug;
  19 use DXM;
  20 use DXLog;
  21 use DXLogPrint;
  22 use CmdAlias;
  23 use FileHandle;
  24 use Carp;
  25
  26 use strict;
  27 use vars qw(%Cache %cmd_cache $errstr %aliases);
  28
  29 %Cache = ();                  # cache of dynamically loaded routine's mod times
  30 %cmd_cache = ();            # cache of short names
  31 $errstr = ();                # error string from eval
  32 %aliases = ();              # aliases for (parts of) commands
  33
  34 #
  35 # obtain a new connection this is derived from dxchannel
  36 #
  37
  38 sub new
  39 {
  40   my $self = DXChannel::alloc(@_);
  41   $self->{sort} = 'U';   # in absence of how to find out what sort of an object I am
  42   return $self;
  43 }
  44
  45 # this is how a a connection starts, you get a hello message and the motd with
  46 # possibly some other messages asking you to set various things up if you are
  47 # new (or nearly new and slacking) user.
  48
  49 sub start
  50 {
  51   my ($self, $line, $sort) = @_;
  52   my $user = $self->{user};
  53   my $call = $self->{call};
  54   my $name = $user->{name};
  55
  56   $self->{name} = $name ? $name : $call;
  57   $self->send($self->msg('l2',$self->{name}));
  58   $self->send_file($main::motd) if (-e $main::motd);
  59   $self->state('prompt');                  # a bit of room for further expansion, passwords etc
  60   $self->{priv} = $user->priv;
  61   $self->{lang} = $user->lang;
  62   $self->{pagelth} = 20;
  63   $self->{priv} = 0 if $line =~ /^(ax|te)/;     # set the connection priv to 0 - can be upgraded later
  64   $self->{consort} = $line;                # save the connection type
  65
  66   # set some necessary flags on the user if they are connecting
  67   $self->{wwv} = $self->{talk} = $self->{ann} = $self->{here} = $self->{dx} = 1;
  68 #  $self->prompt() if $self->{state} =~ /^prompt/o;
  69
  70   # add yourself to the database
  71   my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
  72   my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
  73   $node->dxchan($self) if $call eq $main::myalias;       # send all output for mycall to myalias
  74
  75   # issue a pc16 to everybody interested
  76   my $nchan = DXChannel->get($main::mycall);
  77   my @pc16 = DXProt::pc16($nchan, $cuser);
  78   DXProt::broadcast_ak1a(@pc16);
  79   Log('DXCommand', "$call connected");
  80
  81   # send prompts and things
  82   my $info = DXCluster::cluster();
  83   $self->send("Cluster:$info");
  84   $self->send($self->msg('pr', $call));
  85 }
  86
  87 #
  88 # This is the normal command prompt driver
  89 #
  90
  91 sub normal
  92 {
  93         my $self = shift;
  94         my $cmdline = shift;
  95         my @ans;
  96
  97         # remove leading and trailing spaces
  98         $cmdline =~ s/^\s*(.*)\s*$/$1/;
  99
 100         if ($self->{state} eq 'page') {
 101                 my $i = $self->{pagelth};
 102                 my $ref = $self->{pagedata};
 103                 my $tot = @$ref;
 104
 105                 # abort if we get a line starting in with a
 106                 if ($cmdline =~ /^a/io) {
 107                         undef $ref;
 108                         $i = 0;
 109                 }
 110
 111                 # send a tranche of data
 112                 while ($i-- > 0 && @$ref) {
 113                         my $line = shift @$ref;
 114                         $line =~ s/\s+$//o;            # why am having to do this?
 115                         $self->send($line);
 116                 }
 117
 118                 # reset state if none or else chuck out an intermediate prompt
 119                 if ($ref && @$ref) {
 120                         $tot -= $self->{pagelth};
 121                         $self->send($self->msg('page', $tot));
 122                 } else {
 123                         $self->state('prompt');
 124                 }
 125         } else {
 126                 @ans = run_cmd($self, $cmdline) if length $cmdline;
 127
 128                 if ($self->{pagelth} && @ans > $self->{pagelth}) {
 129                         my $i;
 130                         for ($i = $self->{pagelth}; $i-- > 0; ) {
 131                                 my $line = shift @ans;
 132                                 $line =~ s/\s+$//o;            # why am having to do this?
 133                                 $self->send($line);
 134                         }
 135                         $self->{pagedata} =  \@ans;
 136                         $self->state('page');
 137                         $self->send($self->msg('page', scalar @ans));
 138                 } else {
 139                         for (@ans) {
 140                                 s/\s+$//o;                     # why ?????????
 141                                 $self->send($_);
 142                         }
 143                 }
 144         }
 145
 146         # send a prompt only if we are in a prompt state
 147         $self->prompt() if $self->{state} =~ /^prompt/o;
 148 }
 149
 150 #
 151 # this is the thing that runs the command, it is done like this for the
 152 # benefit of remote command execution
 153 #
 154
 155 sub run_cmd
 156 {
 157         my $self = shift;
 158         my $user = $self->{user};
 159         my $call = $self->{call};
 160         my $cmdline = shift;
 161         my @ans;
 162
 163         if ($self->{func}) {
 164                 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
 165                 dbg('eval', "stored func cmd = $c\n");
 166                 eval  $c;
 167                 if ($@) {
 168                         return (1, "Syserr: Eval err $errstr on stored func $self->{func}");
 169                 }
 170         } else {
 171
 172                 # strip out //
 173                 $cmdline =~ s|//|/|og;
 174
 175                 # split the command line up into parts, the first part is the command
 176                 my ($cmd, $args) = $cmdline =~ /^([\w\/]+)\s*(.*)/o;
 177
 178                 if ($cmd) {
 179
 180                         my ($path, $fcmd);
 181
 182                         # alias it if possible
 183                         my $acmd = CmdAlias::get_cmd($cmd);
 184                         if ($acmd) {
 185                                 ($cmd, $args) = "$acmd $args" =~ /^([\w\/]+)\s*(.*)/o;
 186                         }
 187
 188                         # first expand out the entry to a command
 189                         ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
 190                         ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
 191
 192                         my $package = find_cmd_name($path, $fcmd);
 193                         @ans = (0) if !$package ;
 194
 195                         if ($package) {
 196                                 my $c = qq{ \@ans = $package(\$self, \$args) };
 197                                 dbg('eval', "cluster cmd = $c\n");
 198                                 eval  $c;
 199                                 if ($@) {
 200                                         @ans = (0, "Syserr: Eval err cached $package\n$@");
 201                                 }
 202                         }
 203                 }
 204         }
 205
 206         if ($ans[0]) {
 207                 shift @ans;
 208         } else {
 209                 shift @ans;
 210                 if (@ans > 0) {
 211                         unshift @ans, $self->msg('e2');
 212                 } else {
 213                         @ans = $self->msg('e1');
 214                 }
 215         }
 216         return (@ans);
 217 }
 218
 219 #
 220 # This is called from inside the main cluster processing loop and is used
 221 # for despatching commands that are doing some long processing job
 222 #
 223 sub process
 224 {
 225   my $t = time;
 226   my @chan = DXChannel->get_all();
 227   my $chan;
 228
 229   foreach $chan (@chan) {
 230     next if $chan->sort ne 'U';
 231
 232     # send a prompt if no activity out on this channel
 233     if ($t >= $chan->t + $main::user_interval) {
 234       $chan->prompt() if $chan->{state} =~ /^prompt/o;
 235           $chan->t($t);
 236         }
 237   }
 238 }
 239
 240 #
 241 # finish up a user context
 242 #
 243 sub finish
 244 {
 245   my $self = shift;
 246   my $call = $self->call;
 247
 248   if ($call eq $main::myalias) {   # unset the channel if it is us really
 249     my $node = DXNode->get($main::mycall);
 250         $node->{dxchan} = 0;
 251   }
 252   my $ref = DXNodeuser->get($call);
 253
 254   # issue a pc17 to everybody interested
 255   my $nchan = DXChannel->get($main::mycall);
 256   my $pc17 = $nchan->pc17($self);
 257   DXProt::broadcast_ak1a($pc17);
 258
 259   Log('DXCommand', "$call disconnected");
 260   $ref->del() if $ref;
 261 }
 262
 263 #
 264 # short cut to output a prompt
 265 #
 266
 267 sub prompt
 268 {
 269   my $self = shift;
 270   my $call = $self->{call};
 271   $self->send($self->msg('pr', $call));
 272   #DXChannel::msg($self, 'pr', $call);
 273 }
 274
 275 # broadcast a message to all users [except those mentioned after buffer]
 276 sub broadcast
 277 {
 278   my $pkg = shift;                # ignored
 279   my $s = shift;                  # the line to be rebroadcast
 280   my @except = @_;                # to all channels EXCEPT these (dxchannel refs)
 281   my @list = DXChannel->get_all();   # just in case we are called from some funny object
 282   my ($chan, $except);
 283
 284 L: foreach $chan (@list) {
 285      next if !$chan->sort eq 'U';  # only interested in user channels
 286          foreach $except (@except) {
 287            next L if $except == $chan;  # ignore channels in the 'except' list
 288          }
 289          chan->send($s);              # send it
 290   }
 291 }
 292
 293 # gimme all the users
 294 sub get_all
 295 {
 296   my @list = DXChannel->get_all();
 297   my $ref;
 298   my @out;
 299   foreach $ref (@list) {
 300     push @out, $ref if $ref->sort eq 'U';
 301   }
 302   return @out;
 303 }
 304
 305 #
 306 # search for the command in the cache of short->long form commands
 307 #
 308
 309 sub search
 310 {
 311   my ($path, $short_cmd, $suffix) = @_;
 312   my ($apath, $acmd);
 313
 314   # commands are lower case
 315   $short_cmd = lc $short_cmd;
 316   dbg('command', "command: $path $short_cmd\n");
 317
 318   # return immediately if we have it
 319   my ($apath, $acmd) = split ',', $cmd_cache{$short_cmd};
 320   if ($apath && $acmd) {
 321     dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
 322     return ($apath, $acmd);
 323   }
 324
 325   # if not guess
 326   my @parts = split '/', $short_cmd;
 327   my $dirfn;
 328   my $curdir = $path;
 329   my $p;
 330   my $i;
 331   my @lparts;
 332
 333   for ($i = 0; $i < @parts; $i++) {
 334     my  $p = $parts[$i];
 335         opendir(D, $curdir) or confess "can't open $curdir $!";
 336         my @ls = readdir D;
 337         closedir D;
 338         my $l;
 339         foreach $l (sort @ls) {
 340           next if $l =~ /^\./;
 341       if ($i < $#parts) {            # we are dealing with directories
 342         if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
 343                   dbg('command', "got dir: $curdir/$l\n");
 344                   $dirfn .= "$l/";
 345                   $curdir .= "/$l";
 346                   last;
 347                 }
 348       } else {                # we are dealing with commands
 349             @lparts = split /\./, $l;
 350                 next if $lparts[$#lparts] ne $suffix;       # only look for .$suffix files
 351                 if ($p eq substr($l, 0, length $p)) {
 352                   pop @lparts;        #  remove the suffix
 353                   $l = join '.', @lparts;
 354 #                 chop $dirfn;               # remove trailing /
 355                   $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l"));   # cache it
 356           dbg('command', "got path: $path cmd: $dirfn$l\n");
 357                   return ($path, "$dirfn$l");
 358                 }
 359           }
 360         }
 361   }
 362   return ();
 363 }
 364
 365 # clear the command name cache
 366 sub clear_cmd_cache
 367 {
 368   %cmd_cache = ();
 369 }
 370
 371 #
 372 # the persistant execution of things from the command directories
 373 #
 374 #
 375 # This allows perl programs to call functions dynamically
 376 #
 377 # This has been nicked directly from the perlembed pages
 378 #
 379
 380 #require Devel::Symdump;
 381
 382 sub valid_package_name {
 383   my($string) = @_;
 384   $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
 385
 386   #second pass only for words starting with a digit
 387   $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
 388
 389   #Dress it up as a real package name
 390   $string =~ s/\//_/og;
 391   return "Emb_" . $string;
 392 }
 393
 394 #borrowed from Safe.pm
 395 sub delete_package {
 396   my $pkg = shift;
 397   my ($stem, $leaf);
 398
 399   no strict 'refs';
 400   $pkg = "DXCommandmode::$pkg\::";    # expand to full symbol table name
 401   ($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
 402
 403   if ($stem && $leaf) {
 404     my $stem_symtab = *{$stem}{HASH};
 405     delete $stem_symtab->{$leaf};
 406   }
 407 }
 408
 409 # find a cmd reference
 410 # this is really for use in user written stubs
 411 #
 412 # use the result as a symbolic reference:-
 413 #
 414 # no strict 'refs';
 415 # @out = &$r($self, $line);
 416 #
 417 sub find_cmd_ref
 418 {
 419   my $cmd = shift;
 420   my $r;
 421
 422   if ($cmd) {
 423
 424     # first expand out the entry to a command
 425     my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
 426     ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
 427
 428     # make sure it is loaded
 429     $r = find_cmd_name($path, $fcmd);
 430   }
 431   return $r;
 432 }
 433
 434 #
 435 # this bit of magic finds a command in the offered directory
 436 sub find_cmd_name {
 437   my $path = shift;
 438   my $cmdname = shift;
 439   my $package = valid_package_name($cmdname);
 440   my $filename = "$path/$cmdname.pl";
 441   my $mtime = -M $filename;
 442
 443   # return if we can't find it
 444   $errstr = undef;
 445   if (undef $mtime) {
 446     $errstr = DXM::msg('e1');
 447         return undef;
 448   }
 449
 450   if(defined $Cache{$package}{mtime} && $Cache{$package}{mtime } <= $mtime) {
 451     #we have compiled this subroutine already,
 452         #it has not been updated on disk, nothing left to do
 453         #print STDERR "already compiled $package->handler\n";
 454         ;
 455   } else {
 456         my $fh = new FileHandle;
 457         if (!open $fh, $filename) {
 458           $errstr = "Syserr: can't open '$filename' $!";
 459           return undef;
 460         };
 461         local $/ = undef;
 462         my $sub = <$fh>;
 463         close $fh;
 464
 465     #wrap the code into a subroutine inside our unique package
 466         my $eval = qq{
 467         sub $package
 468         {
 469           $sub
 470         } };
 471
 472         if (isdbg('eval')) {
 473           my @list = split /\n/, $eval;
 474           my $line;
 475           for (@list) {
 476             dbg('eval', $_, "\n");
 477           }
 478         }
 479
 480         {
 481           #hide our variables within this block
 482           my($filename,$mtime,$package,$sub);
 483           eval $eval;
 484         }
 485
 486         if ($@) {
 487           print "\$\@ = $@";
 488           $errstr = $@;
 489           delete_package($package);
 490         } else {
 491       #cache it unless we're cleaning out each time
 492           $Cache{$package}{mtime} = $mtime;
 493         }
 494   }
 495
 496   #print Devel::Symdump->rnew($package)->as_string, $/;
 497   $package = "DXCommandmode::$package" if $package;
 498   $package = undef if $errstr;
 499   return $package;
 500 }
 501
 502 1;
 503 __END__