3 # This module impliments the user facing command mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
10 package DXCommandmode;
29 use vars qw(%Cache %cmd_cache $errstr %aliases);
31 %Cache = (); # cache of dynamically loaded routine's mod times
32 %cmd_cache = (); # cache of short names
33 $errstr = (); # error string from eval
34 %aliases = (); # aliases for (parts of) commands
37 # obtain a new connection this is derived from dxchannel
42 my $self = DXChannel::alloc(@_);
43 $self->{'sort'} = 'U'; # in absence of how to find out what sort of an object I am
47 # this is how a a connection starts, you get a hello message and the motd with
48 # possibly some other messages asking you to set various things up if you are
49 # new (or nearly new and slacking) user.
53 my ($self, $line, $sort) = @_;
54 my $user = $self->{user};
55 my $call = $self->{call};
56 my $name = $user->{name};
58 $self->{name} = $name ? $name : $call;
59 $self->send($self->msg('l2',$self->{name}));
60 $self->send_file($main::motd) if (-e $main::motd);
61 $self->state('prompt'); # a bit of room for further expansion, passwords etc
62 $self->{priv} = $user->priv;
63 $self->{lang} = $user->lang;
64 $self->{pagelth} = 20;
65 $self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
66 $self->{consort} = $line; # save the connection type
68 # set some necessary flags on the user if they are connecting
69 $self->{beep} = $self->{wwv} = $self->{wx} = $self->{talk} = $self->{ann} = $self->{here} = $self->{dx} = 1;
70 # $self->prompt() if $self->{state} =~ /^prompt/o;
72 # add yourself to the database
73 my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
74 my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
75 $node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
77 # issue a pc16 to everybody interested
78 my $nchan = DXChannel->get($main::mycall);
79 my @pc16 = DXProt::pc16($nchan, $cuser);
80 DXProt::broadcast_ak1a(@pc16);
81 Log('DXCommand', "$call connected");
83 # send prompts and things
84 my $info = DXCluster::cluster();
85 $self->send("Cluster:$info");
86 $self->send($self->msg('namee1')) if !$user->name;
87 $self->send($self->msg('qthe1')) if !$user->qth;
88 $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
89 $self->send($self->msg('hnodee1')) if !$user->qth;
90 $self->send($self->msg('msgnew')) if DXMsg::for_me($call);
93 $self->{spotfilter} = Filter::read_in('spots', $call);
95 $self->send($self->msg('pr', $call));
99 # This is the normal command prompt driver
108 # remove leading and trailing spaces
109 $cmdline =~ s/^\s*(.*)\s*$/$1/;
111 if ($self->{state} eq 'page') {
112 my $i = $self->{pagelth};
113 my $ref = $self->{pagedata};
116 # abort if we get a line starting in with a
117 if ($cmdline =~ /^a/io) {
122 # send a tranche of data
123 while ($i-- > 0 && @$ref) {
124 my $line = shift @$ref;
125 $line =~ s/\s+$//o; # why am having to do this?
129 # reset state if none or else chuck out an intermediate prompt
131 $tot -= $self->{pagelth};
132 $self->send($self->msg('page', $tot));
134 $self->state('prompt');
136 } elsif ($self->{state} eq 'sysop') {
137 my $passwd = $self->{user}->passwd;
138 my @pw = split / */, $passwd;
140 my @l = @{$self->{passwd}};
141 my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
142 if ($cmdline =~ /$str/) {
143 $self->{priv} = $self->{user}->priv;
145 $self->send($self->msg('sorry'));
148 $self->send($self->msg('sorry'));
150 delete $self->{passwd};
151 $self->state('prompt');
153 @ans = run_cmd($self, $cmdline); # if length $cmdline;
155 if ($self->{pagelth} && @ans > $self->{pagelth}) {
157 for ($i = $self->{pagelth}; $i-- > 0; ) {
158 my $line = shift @ans;
159 $line =~ s/\s+$//o; # why am having to do this?
162 $self->{pagedata} = \@ans;
163 $self->state('page');
164 $self->send($self->msg('page', scalar @ans));
167 s/\s+$//o; # why ?????????
173 # send a prompt only if we are in a prompt state
174 $self->prompt() if $self->{state} =~ /^prompt/o;
178 # this is the thing that runs the command, it is done like this for the
179 # benefit of remote command execution
185 my $user = $self->{user};
186 my $call = $self->{call};
191 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
192 dbg('eval', "stored func cmd = $c\n");
195 return (1, "Syserr: Eval err $errstr on stored func $self->{func}");
199 return () if length $cmdline == 0;
202 $cmdline =~ s|//|/|og;
204 # split the command line up into parts, the first part is the command
205 my ($cmd, $args) = $cmdline =~ /^([\S\/]+)\s*(.*)/o;
211 dbg('command', "cmd: $cmd");
213 # alias it if possible
214 my $acmd = CmdAlias::get_cmd($cmd);
216 ($cmd, $args) = "$acmd $args" =~ /^([\w\/]+)\s*(.*)/o;
217 dbg('command', "aliased cmd: $cmd $args");
220 # first expand out the entry to a command
221 ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
222 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
225 dbg('command', "path: $cmd cmd: $fcmd");
227 my $package = find_cmd_name($path, $fcmd);
228 @ans = (0) if !$package ;
231 dbg('command', "package: $package");
233 my $c = qq{ \@ans = $package(\$self, \$args) };
234 dbg('eval', "cluster cmd = $c\n");
237 @ans = (0, "Syserr: Eval err cached $package\n$@");
241 dbg('command', "cmd: $cmd not found");
252 unshift @ans, $self->msg('e2');
254 @ans = $self->msg('e1');
261 # This is called from inside the main cluster processing loop and is used
262 # for despatching commands that are doing some long processing job
267 my @dxchan = DXChannel->get_all();
270 foreach $dxchan (@dxchan) {
271 next if $dxchan->sort ne 'U';
273 # send a prompt if no activity out on this channel
274 if ($t >= $dxchan->t + $main::user_interval) {
275 $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
282 # finish up a user context
287 my $call = $self->call;
290 if (-e "$main::data/logout") {
291 open(I, "$main::data/logout") or confess;
294 $self->send_now('D', @in);
298 if ($call eq $main::myalias) { # unset the channel if it is us really
299 my $node = DXNode->get($main::mycall);
302 my $ref = DXCluster->get_exact($call);
304 # issue a pc17 to everybody interested
305 my $nchan = DXChannel->get($main::mycall);
306 my $pc17 = $nchan->pc17($self);
307 DXProt::broadcast_ak1a($pc17);
309 Log('DXCommand', "$call disconnected");
314 # short cut to output a prompt
320 $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call));
323 # broadcast a message to all users [except those mentioned after buffer]
326 my $pkg = shift; # ignored
327 my $s = shift; # the line to be rebroadcast
328 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
329 my @list = DXChannel->get_all(); # just in case we are called from some funny object
330 my ($dxchan, $except);
332 L: foreach $dxchan (@list) {
333 next if !$dxchan->sort eq 'U'; # only interested in user channels
334 foreach $except (@except) {
335 next L if $except == $dxchan; # ignore channels in the 'except' list
337 $dxchan->send($s); # send it
341 # gimme all the users
344 my @list = DXChannel->get_all();
347 foreach $ref (@list) {
348 push @out, $ref if $ref->sort eq 'U';
354 # search for the command in the cache of short->long form commands
359 my ($path, $short_cmd, $suffix) = @_;
362 # commands are lower case
363 $short_cmd = lc $short_cmd;
364 dbg('command', "command: $path $short_cmd\n");
366 # do some checking for funny characters
367 return () if $short_cmd =~ /\/$/;
369 # return immediately if we have it
370 ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
371 if ($apath && $acmd) {
372 dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
373 return ($apath, $acmd);
377 my @parts = split '/', $short_cmd;
384 for ($i = 0; $i < @parts; $i++) {
386 opendir(D, $curdir) or confess "can't open $curdir $!";
390 foreach $l (sort @ls) {
392 if ($i < $#parts) { # we are dealing with directories
393 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
394 dbg('command', "got dir: $curdir/$l\n");
399 } else { # we are dealing with commands
400 @lparts = split /\./, $l;
401 next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
402 if ($p eq substr($l, 0, length $p)) {
403 pop @lparts; # remove the suffix
404 $l = join '.', @lparts;
405 # chop $dirfn; # remove trailing /
406 $dirfn = "" unless $dirfn;
407 $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
408 dbg('command', "got path: $path cmd: $dirfn$l\n");
409 return ($path, "$dirfn$l");
417 # clear the command name cache
424 # the persistant execution of things from the command directories
427 # This allows perl programs to call functions dynamically
429 # This has been nicked directly from the perlembed pages
432 #require Devel::Symdump;
434 sub valid_package_name {
436 $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
438 #second pass only for words starting with a digit
439 $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
441 #Dress it up as a real package name
442 $string =~ s/\//_/og;
443 return "Emb_" . $string;
446 #borrowed from Safe.pm
452 $pkg = "DXCommandmode::$pkg\::"; # expand to full symbol table name
453 ($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
455 if ($stem && $leaf) {
456 my $stem_symtab = *{$stem}{HASH};
457 delete $stem_symtab->{$leaf};
461 # find a cmd reference
462 # this is really for use in user written stubs
464 # use the result as a symbolic reference:-
467 # @out = &$r($self, $line);
476 # first expand out the entry to a command
477 my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
478 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
480 # make sure it is loaded
481 $r = find_cmd_name($path, $fcmd);
487 # this bit of magic finds a command in the offered directory
491 my $package = valid_package_name($cmdname);
492 my $filename = "$path/$cmdname.pl";
493 my $mtime = -M $filename;
495 # return if we can't find it
497 unless (defined $mtime) {
498 $errstr = DXM::msg('e1');
502 if(defined $Cache{$package}{mtime} && $Cache{$package}{mtime } <= $mtime) {
503 #we have compiled this subroutine already,
504 #it has not been updated on disk, nothing left to do
505 #print STDERR "already compiled $package->handler\n";
508 delete_package($package) if defined $Cache{$package}{mtime};
510 my $fh = new FileHandle;
511 if (!open $fh, $filename) {
512 $errstr = "Syserr: can't open '$filename' $!";
519 #wrap the code into a subroutine inside our unique package
520 my $eval = qq{ sub $package { $sub } };
523 my @list = split /\n/, $eval;
526 dbg('eval', $_, "\n");
531 #hide our variables within this block
532 my($filename,$mtime,$package,$sub);
539 delete_package($package);
541 #cache it unless we're cleaning out each time
542 $Cache{$package}{'mtime'} = $mtime;
546 #print Devel::Symdump->rnew($package)->as_string, $/;
547 $package = "DXCommandmode::$package" if $package;
548 $package = undef if $errstr;