3 # This module impliments the user facing command mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
10 package DXCommandmode;
28 use vars qw(%Cache %cmd_cache $errstr %aliases);
30 %Cache = (); # cache of dynamically loaded routine's mod times
31 %cmd_cache = (); # cache of short names
32 $errstr = (); # error string from eval
33 %aliases = (); # aliases for (parts of) commands
36 # obtain a new connection this is derived from dxchannel
41 my $self = DXChannel::alloc(@_);
42 $self->{sort} = 'U'; # in absence of how to find out what sort of an object I am
46 # this is how a a connection starts, you get a hello message and the motd with
47 # possibly some other messages asking you to set various things up if you are
48 # new (or nearly new and slacking) user.
52 my ($self, $line, $sort) = @_;
53 my $user = $self->{user};
54 my $call = $self->{call};
55 my $name = $user->{name};
57 $self->{name} = $name ? $name : $call;
58 $self->send($self->msg('l2',$self->{name}));
59 $self->send_file($main::motd) if (-e $main::motd);
60 $self->state('prompt'); # a bit of room for further expansion, passwords etc
61 $self->{priv} = $user->priv;
62 $self->{lang} = $user->lang;
63 $self->{pagelth} = 20;
64 $self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
65 $self->{consort} = $line; # save the connection type
67 # set some necessary flags on the user if they are connecting
68 $self->{beep} = $self->{wwv} = $self->{talk} = $self->{ann} = $self->{here} = $self->{dx} = 1;
69 # $self->prompt() if $self->{state} =~ /^prompt/o;
71 # add yourself to the database
72 my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
73 my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
74 $node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
76 # issue a pc16 to everybody interested
77 my $nchan = DXChannel->get($main::mycall);
78 my @pc16 = DXProt::pc16($nchan, $cuser);
79 DXProt::broadcast_ak1a(@pc16);
80 Log('DXCommand', "$call connected");
82 # send prompts and things
83 my $info = DXCluster::cluster();
84 $self->send("Cluster:$info");
85 $self->send($self->msg('pr', $call));
89 # This is the normal command prompt driver
98 # remove leading and trailing spaces
99 $cmdline =~ s/^\s*(.*)\s*$/$1/;
101 if ($self->{state} eq 'page') {
102 my $i = $self->{pagelth};
103 my $ref = $self->{pagedata};
106 # abort if we get a line starting in with a
107 if ($cmdline =~ /^a/io) {
112 # send a tranche of data
113 while ($i-- > 0 && @$ref) {
114 my $line = shift @$ref;
115 $line =~ s/\s+$//o; # why am having to do this?
119 # reset state if none or else chuck out an intermediate prompt
121 $tot -= $self->{pagelth};
122 $self->send($self->msg('page', $tot));
124 $self->state('prompt');
127 @ans = run_cmd($self, $cmdline) if length $cmdline;
129 if ($self->{pagelth} && @ans > $self->{pagelth}) {
131 for ($i = $self->{pagelth}; $i-- > 0; ) {
132 my $line = shift @ans;
133 $line =~ s/\s+$//o; # why am having to do this?
136 $self->{pagedata} = \@ans;
137 $self->state('page');
138 $self->send($self->msg('page', scalar @ans));
141 s/\s+$//o; # why ?????????
147 # send a prompt only if we are in a prompt state
148 $self->prompt() if $self->{state} =~ /^prompt/o;
152 # this is the thing that runs the command, it is done like this for the
153 # benefit of remote command execution
159 my $user = $self->{user};
160 my $call = $self->{call};
165 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
166 dbg('eval', "stored func cmd = $c\n");
169 return (1, "Syserr: Eval err $errstr on stored func $self->{func}");
174 $cmdline =~ s|//|/|og;
176 # split the command line up into parts, the first part is the command
177 my ($cmd, $args) = $cmdline =~ /^([\S\/]+)\s*(.*)/o;
183 dbg('command', "cmd: $cmd");
185 # alias it if possible
186 my $acmd = CmdAlias::get_cmd($cmd);
188 ($cmd, $args) = "$acmd $args" =~ /^([\w\/]+)\s*(.*)/o;
189 dbg('command', "aliased cmd: $cmd $args");
192 # first expand out the entry to a command
193 ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
194 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
196 dbg('command', "path: $cmd cmd: $fcmd");
198 my $package = find_cmd_name($path, $fcmd);
199 @ans = (0) if !$package ;
202 dbg('command', "package: $package");
204 my $c = qq{ \@ans = $package(\$self, \$args) };
205 dbg('eval', "cluster cmd = $c\n");
208 @ans = (0, "Syserr: Eval err cached $package\n$@");
219 unshift @ans, $self->msg('e2');
221 @ans = $self->msg('e1');
228 # This is called from inside the main cluster processing loop and is used
229 # for despatching commands that are doing some long processing job
234 my @chan = DXChannel->get_all();
237 foreach $chan (@chan) {
238 next if $chan->sort ne 'U';
240 # send a prompt if no activity out on this channel
241 if ($t >= $chan->t + $main::user_interval) {
242 $chan->prompt() if $chan->{state} =~ /^prompt/o;
249 # finish up a user context
254 my $call = $self->call;
256 if ($call eq $main::myalias) { # unset the channel if it is us really
257 my $node = DXNode->get($main::mycall);
260 my $ref = DXNodeuser->get($call);
262 # issue a pc17 to everybody interested
263 my $nchan = DXChannel->get($main::mycall);
264 my $pc17 = $nchan->pc17($self);
265 DXProt::broadcast_ak1a($pc17);
267 Log('DXCommand', "$call disconnected");
272 # short cut to output a prompt
278 my $call = $self->{call};
279 $self->send($self->msg('pr', $call));
280 #DXChannel::msg($self, 'pr', $call);
283 # broadcast a message to all users [except those mentioned after buffer]
286 my $pkg = shift; # ignored
287 my $s = shift; # the line to be rebroadcast
288 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
289 my @list = DXChannel->get_all(); # just in case we are called from some funny object
292 L: foreach $chan (@list) {
293 next if !$chan->sort eq 'U'; # only interested in user channels
294 foreach $except (@except) {
295 next L if $except == $chan; # ignore channels in the 'except' list
297 chan->send($s); # send it
301 # gimme all the users
304 my @list = DXChannel->get_all();
307 foreach $ref (@list) {
308 push @out, $ref if $ref->sort eq 'U';
314 # search for the command in the cache of short->long form commands
319 my ($path, $short_cmd, $suffix) = @_;
322 # commands are lower case
323 $short_cmd = lc $short_cmd;
324 dbg('command', "command: $path $short_cmd\n");
326 # do some checking for funny characters
327 return () if $short_cmd =~ /\/$/;
329 # return immediately if we have it
330 my ($apath, $acmd) = split ',', $cmd_cache{$short_cmd};
331 if ($apath && $acmd) {
332 dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
333 return ($apath, $acmd);
337 my @parts = split '/', $short_cmd;
344 for ($i = 0; $i < @parts; $i++) {
346 opendir(D, $curdir) or confess "can't open $curdir $!";
350 foreach $l (sort @ls) {
352 if ($i < $#parts) { # we are dealing with directories
353 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
354 dbg('command', "got dir: $curdir/$l\n");
359 } else { # we are dealing with commands
360 @lparts = split /\./, $l;
361 next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
362 if ($p eq substr($l, 0, length $p)) {
363 pop @lparts; # remove the suffix
364 $l = join '.', @lparts;
365 # chop $dirfn; # remove trailing /
366 $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
367 dbg('command', "got path: $path cmd: $dirfn$l\n");
368 return ($path, "$dirfn$l");
376 # clear the command name cache
383 # the persistant execution of things from the command directories
386 # This allows perl programs to call functions dynamically
388 # This has been nicked directly from the perlembed pages
391 #require Devel::Symdump;
393 sub valid_package_name {
395 $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
397 #second pass only for words starting with a digit
398 $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
400 #Dress it up as a real package name
401 $string =~ s/\//_/og;
402 return "Emb_" . $string;
405 #borrowed from Safe.pm
411 $pkg = "DXCommandmode::$pkg\::"; # expand to full symbol table name
412 ($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
414 if ($stem && $leaf) {
415 my $stem_symtab = *{$stem}{HASH};
416 delete $stem_symtab->{$leaf};
420 # find a cmd reference
421 # this is really for use in user written stubs
423 # use the result as a symbolic reference:-
426 # @out = &$r($self, $line);
435 # first expand out the entry to a command
436 my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
437 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
439 # make sure it is loaded
440 $r = find_cmd_name($path, $fcmd);
446 # this bit of magic finds a command in the offered directory
450 my $package = valid_package_name($cmdname);
451 my $filename = "$path/$cmdname.pl";
452 my $mtime = -M $filename;
454 # return if we can't find it
457 $errstr = DXM::msg('e1');
461 if(defined $Cache{$package}{mtime} && $Cache{$package}{mtime } <= $mtime) {
462 #we have compiled this subroutine already,
463 #it has not been updated on disk, nothing left to do
464 #print STDERR "already compiled $package->handler\n";
467 my $fh = new FileHandle;
468 if (!open $fh, $filename) {
469 $errstr = "Syserr: can't open '$filename' $!";
476 #wrap the code into a subroutine inside our unique package
484 my @list = split /\n/, $eval;
487 dbg('eval', $_, "\n");
492 #hide our variables within this block
493 my($filename,$mtime,$package,$sub);
500 delete_package($package);
502 #cache it unless we're cleaning out each time
503 $Cache{$package}{mtime} = $mtime;
507 #print Devel::Symdump->rnew($package)->as_string, $/;
508 $package = "DXCommandmode::$package" if $package;
509 $package = undef if $errstr;