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