3 # This module impliments the user facing command mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
10 package DXCommandmode;
32 use vars qw(%Cache %cmd_cache $errstr %aliases);
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
40 # obtain a new connection this is derived from dxchannel
45 my $self = DXChannel::alloc(@_);
46 $self->{'sort'} = 'U'; # in absence of how to find out what sort of an object I am
50 # this is how a a connection starts, you get a hello message and the motd with
51 # possibly some other messages asking you to set various things up if you are
52 # new (or nearly new and slacking) user.
56 my ($self, $line, $sort) = @_;
57 my $user = $self->{user};
58 my $call = $self->{call};
59 my $name = $user->{name};
61 $self->{name} = $name ? $name : $call;
62 $self->send($self->msg('l2',$self->{name}));
63 $self->send_file($main::motd) if (-e $main::motd);
64 $self->state('prompt'); # a bit of room for further expansion, passwords etc
65 $self->{priv} = $user->priv;
66 $self->{lang} = $user->lang;
67 $self->{pagelth} = 20;
68 $self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
69 $self->{consort} = $line; # save the connection type
71 # set some necessary flags on the user if they are connecting
72 $self->{beep} = $self->{wwv} = $self->{wx} = $self->{talk} = $self->{ann} = $self->{here} = $self->{dx} = 1;
73 # $self->prompt() if $self->{state} =~ /^prompt/o;
75 # add yourself to the database
76 my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
77 my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
78 $node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
80 # issue a pc16 to everybody interested
81 my $nchan = DXChannel->get($main::mycall);
82 my @pc16 = DXProt::pc16($nchan, $cuser);
84 DXProt::broadcast_all_ak1a($_);
86 Log('DXCommand', "$call connected");
88 # send prompts and things
89 my $info = DXCluster::cluster();
90 $self->send("Cluster:$info");
91 $self->send($self->msg('namee1')) if !$user->name;
92 $self->send($self->msg('qthe1')) if !$user->qth;
93 $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
94 $self->send($self->msg('hnodee1')) if !$user->qth;
95 $self->send($self->msg('m9')) if DXMsg::for_me($call);
98 $self->{spotfilter} = Filter::read_in('spots', $call);
100 $self->send($self->msg('pr', $call));
104 # This is the normal command prompt driver
113 # remove leading and trailing spaces
114 $cmdline =~ s/^\s*(.*)\s*$/$1/;
116 if ($self->{state} eq 'page') {
117 my $i = $self->{pagelth};
118 my $ref = $self->{pagedata};
121 # abort if we get a line starting in with a
122 if ($cmdline =~ /^a/io) {
127 # send a tranche of data
128 while ($i-- > 0 && @$ref) {
129 my $line = shift @$ref;
130 $line =~ s/\s+$//o; # why am having to do this?
134 # reset state if none or else chuck out an intermediate prompt
136 $tot -= $self->{pagelth};
137 $self->send($self->msg('page', $tot));
139 $self->state('prompt');
141 } elsif ($self->{state} eq 'sysop') {
142 my $passwd = $self->{user}->passwd;
143 my @pw = split / */, $passwd;
145 my @l = @{$self->{passwd}};
146 my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
147 if ($cmdline =~ /$str/) {
148 $self->{priv} = $self->{user}->priv;
150 $self->send($self->msg('sorry'));
153 $self->send($self->msg('sorry'));
155 delete $self->{passwd};
156 $self->state('prompt');
158 @ans = run_cmd($self, $cmdline); # if length $cmdline;
160 if ($self->{pagelth} && @ans > $self->{pagelth}) {
162 for ($i = $self->{pagelth}; $i-- > 0; ) {
163 my $line = shift @ans;
164 $line =~ s/\s+$//o; # why am having to do this?
167 $self->{pagedata} = \@ans;
168 $self->state('page');
169 $self->send($self->msg('page', scalar @ans));
172 s/\s+$//o; # why ?????????
178 # send a prompt only if we are in a prompt state
179 $self->prompt() if $self->{state} =~ /^prompt/o;
183 # this is the thing that runs the command, it is done like this for the
184 # benefit of remote command execution
190 my $user = $self->{user};
191 my $call = $self->{call};
196 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
197 dbg('eval', "stored func cmd = $c\n");
200 return (1, "Syserr: Eval err $errstr on stored func $self->{func}");
204 return () if length $cmdline == 0;
207 $cmdline =~ s|//|/|og;
209 # split the command line up into parts, the first part is the command
210 my ($cmd, $args) = $cmdline =~ /^([\S\/]+)\s*(.*)/o;
216 dbg('command', "cmd: $cmd");
218 # alias it if possible
219 my $acmd = CmdAlias::get_cmd($cmd);
221 ($cmd, $args) = "$acmd $args" =~ /^([\w\/]+)\s*(.*)/o;
222 dbg('command', "aliased cmd: $cmd $args");
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;
230 dbg('command', "path: $cmd cmd: $fcmd");
232 my $package = find_cmd_name($path, $fcmd);
233 @ans = (0) if !$package ;
236 dbg('command', "package: $package");
238 my $c = qq{ \@ans = $package(\$self, \$args) };
239 dbg('eval', "cluster cmd = $c\n");
242 @ans = (0, "Syserr: Eval err cached $package\n$@");
246 dbg('command', "cmd: $cmd not found");
257 unshift @ans, $self->msg('e2');
259 @ans = $self->msg('e1');
266 # This is called from inside the main cluster processing loop and is used
267 # for despatching commands that are doing some long processing job
272 my @dxchan = DXChannel->get_all();
275 foreach $dxchan (@dxchan) {
276 next if $dxchan->sort ne 'U';
278 # send a prompt if no activity out on this channel
279 if ($t >= $dxchan->t + $main::user_interval) {
280 $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
287 # finish up a user context
292 my $call = $self->call;
295 if (-e "$main::data/logout") {
296 open(I, "$main::data/logout") or confess;
299 $self->send_now('D', @in);
303 if ($call eq $main::myalias) { # unset the channel if it is us really
304 my $node = DXNode->get($main::mycall);
307 my $ref = DXCluster->get_exact($call);
309 # issue a pc17 to everybody interested
310 my $nchan = DXChannel->get($main::mycall);
311 my $pc17 = $nchan->pc17($self);
312 DXProt::broadcast_all_ak1a($pc17);
314 Log('DXCommand', "$call disconnected");
319 # short cut to output a prompt
325 $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call));
328 # broadcast a message to all users [except those mentioned after buffer]
331 my $pkg = shift; # ignored
332 my $s = shift; # the line to be rebroadcast
333 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
334 my @list = DXChannel->get_all(); # just in case we are called from some funny object
335 my ($dxchan, $except);
337 L: foreach $dxchan (@list) {
338 next if !$dxchan->sort eq 'U'; # only interested in user channels
339 foreach $except (@except) {
340 next L if $except == $dxchan; # ignore channels in the 'except' list
342 $dxchan->send($s); # send it
346 # gimme all the users
349 my @list = DXChannel->get_all();
352 foreach $ref (@list) {
353 push @out, $ref if $ref->sort eq 'U';
359 # search for the command in the cache of short->long form commands
364 my ($path, $short_cmd, $suffix) = @_;
367 # commands are lower case
368 $short_cmd = lc $short_cmd;
369 dbg('command', "command: $path $short_cmd\n");
371 # do some checking for funny characters
372 return () if $short_cmd =~ /\/$/;
374 # return immediately if we have it
375 ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
376 if ($apath && $acmd) {
377 dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
378 return ($apath, $acmd);
382 my @parts = split '/', $short_cmd;
389 for ($i = 0; $i < @parts; $i++) {
391 opendir(D, $curdir) or confess "can't open $curdir $!";
395 foreach $l (sort @ls) {
397 if ($i < $#parts) { # we are dealing with directories
398 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
399 dbg('command', "got dir: $curdir/$l\n");
404 } else { # we are dealing with commands
405 @lparts = split /\./, $l;
406 next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
407 if ($p eq substr($l, 0, length $p)) {
408 pop @lparts; # remove the suffix
409 $l = join '.', @lparts;
410 # chop $dirfn; # remove trailing /
411 $dirfn = "" unless $dirfn;
412 $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
413 dbg('command', "got path: $path cmd: $dirfn$l\n");
414 return ($path, "$dirfn$l");
422 # clear the command name cache
429 # the persistant execution of things from the command directories
432 # This allows perl programs to call functions dynamically
434 # This has been nicked directly from the perlembed pages
437 #require Devel::Symdump;
439 sub valid_package_name {
441 $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
443 #second pass only for words starting with a digit
444 $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
446 #Dress it up as a real package name
447 $string =~ s/\//_/og;
448 return "Emb_" . $string;
451 #borrowed from Safe.pm
457 $pkg = "DXCommandmode::$pkg\::"; # expand to full symbol table name
458 ($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
460 if ($stem && $leaf) {
461 my $stem_symtab = *{$stem}{HASH};
462 delete $stem_symtab->{$leaf};
466 # find a cmd reference
467 # this is really for use in user written stubs
469 # use the result as a symbolic reference:-
472 # @out = &$r($self, $line);
481 # first expand out the entry to a command
482 my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
483 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
485 # make sure it is loaded
486 $r = find_cmd_name($path, $fcmd);
492 # this bit of magic finds a command in the offered directory
496 my $package = valid_package_name($cmdname);
497 my $filename = "$path/$cmdname.pl";
498 my $mtime = -M $filename;
500 # return if we can't find it
502 unless (defined $mtime) {
503 $errstr = DXM::msg('e1');
507 if(defined $Cache{$package}{mtime} && $Cache{$package}{mtime } <= $mtime) {
508 #we have compiled this subroutine already,
509 #it has not been updated on disk, nothing left to do
510 #print STDERR "already compiled $package->handler\n";
513 delete_package($package) if defined $Cache{$package}{mtime};
515 my $fh = new IO::File;
516 if (!open $fh, $filename) {
517 $errstr = "Syserr: can't open '$filename' $!";
524 #wrap the code into a subroutine inside our unique package
525 my $eval = qq{ sub $package { $sub } };
528 my @list = split /\n/, $eval;
531 dbg('eval', $_, "\n");
536 #hide our variables within this block
537 my($filename,$mtime,$package,$sub);
544 delete_package($package);
546 #cache it unless we're cleaning out each time
547 $Cache{$package}{'mtime'} = $mtime;
551 #print Devel::Symdump->rnew($package)->as_string, $/;
552 $package = "DXCommandmode::$package" if $package;
553 $package = undef if $errstr;