3 # This module impliments the user facing command mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
10 package DXCommandmode;
35 use vars qw(%Cache %cmd_cache $errstr %aliases $scriptbase $maxerrors);
37 %Cache = (); # cache of dynamically loaded routine's mod times
38 %cmd_cache = (); # cache of short names
39 $errstr = (); # error string from eval
40 %aliases = (); # aliases for (parts of) commands
41 $scriptbase = "$main::root/scripts"; # the place where all users start scripts go
42 $maxerrors = 20; # the maximum number of concurrent errors allowed before disconnection
45 # obtain a new connection this is derived from dxchannel
50 my $self = DXChannel::alloc(@_);
54 # this is how a a connection starts, you get a hello message and the motd with
55 # possibly some other messages asking you to set various things up if you are
56 # new (or nearly new and slacking) user.
60 my ($self, $line, $sort) = @_;
61 my $user = $self->{user};
62 my $call = $self->{call};
63 my $name = $user->{name};
65 $self->{name} = $name ? $name : $call;
66 $self->send($self->msg('l2',$self->{name}));
67 $self->send_file($main::motd) if (-e $main::motd);
68 $self->state('prompt'); # a bit of room for further expansion, passwords etc
69 $self->{priv} = $user->priv || 0;
70 $self->{lang} = $user->lang || $main::lang || 'en';
71 $self->{pagelth} = $user->pagelth || 20;
72 $self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
73 $self->{consort} = $line; # save the connection type
75 # set some necessary flags on the user if they are connecting
76 $self->{beep} = $user->wantbeep;
77 $self->{ann} = $user->wantann;
78 $self->{wwv} = $user->wantwwv;
79 $self->{wcy} = $user->wantwcy;
80 $self->{talk} = $user->wanttalk;
81 $self->{wx} = $user->wantwx;
82 $self->{dx} = $user->wantdx;
83 $self->{logininfo} = $user->wantlogininfo;
87 $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'user_default', 0);
88 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'user_default', 0);
89 $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'user_default', 0);
90 $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'user_default', 0) ;
92 # clean up qra locators
94 $qra = undef if ($qra && !DXBearing::is_qra($qra));
97 my $long = $user->long;
98 $user->qra(DXBearing::lltoqra($lat, $long)) if (defined $lat && defined $long);
101 # add yourself to the database
102 my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
103 my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
104 $node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
107 my $pref = Route::Node::get($main::mycall) or die "$main::mycall not allocated in Route database";
108 $pref->add_user($call, Route::here($self->{here}));
109 dbg('route', "B/C PC16 on $main::mycall for: $call");
111 # issue a pc16 to everybody interested
112 my $nchan = DXChannel->get($main::mycall);
113 my @pc16 = DXProt::pc16($nchan, $cuser);
115 DXProt::broadcast_all_ak1a($_);
117 Log('DXCommand', "$call connected");
119 # send prompts and things
120 my $info = DXCluster::cluster();
121 $self->send("Cluster:$info");
122 $self->send($self->msg('namee1')) if !$user->name;
123 $self->send($self->msg('qthe1')) if !$user->qth;
124 $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
125 $self->send($self->msg('hnodee1')) if !$user->qth;
126 $self->send($self->msg('m9')) if DXMsg::for_me($call);
130 if (!$user->wantecho) {
131 $self->send_now('E', "0");
132 $self->send($self->msg('echow'));
135 $self->tell_login('loginu');
140 # This is the normal command prompt driver
149 # remove leading and trailing spaces
150 $cmdline =~ s/^\s*(.*)\s*$/$1/;
152 if ($self->{state} eq 'page') {
153 my $i = $self->{pagelth};
154 my $ref = $self->{pagedata};
157 # abort if we get a line starting in with a
158 if ($cmdline =~ /^a/io) {
163 # send a tranche of data
164 while ($i-- > 0 && @$ref) {
165 my $line = shift @$ref;
166 $line =~ s/\s+$//o; # why am having to do this?
170 # reset state if none or else chuck out an intermediate prompt
172 $tot -= $self->{pagelth};
173 $self->send($self->msg('page', $tot));
175 $self->state('prompt');
177 } elsif ($self->{state} eq 'sysop') {
178 my $passwd = $self->{user}->passwd;
179 my @pw = split / */, $passwd;
181 my @l = @{$self->{passwd}};
182 my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
183 if ($cmdline =~ /$str/) {
184 $self->{priv} = $self->{user}->priv;
186 $self->send($self->msg('sorry'));
189 $self->send($self->msg('sorry'));
191 delete $self->{passwd};
192 $self->state('prompt');
193 } elsif ($self->{state} eq 'talk') {
194 if ($cmdline =~ m{^(?:/EX|/ABORT)}i) {
195 for (@{$self->{talklist}}) {
196 $self->send_talks($_, $self->msg('talkend'));
198 $self->state('prompt');
199 delete $self->{talklist};
200 } elsif ($cmdline =~ m(^/\w+)) {
202 $self->send_ans(run_cmd($self, $cmdline));
203 $self->send($self->talk_prompt);
204 } elsif ($self->{talklist} && @{$self->{talklist}}) {
205 # send what has been said to whoever is in this person's talk list
206 for (@{$self->{talklist}}) {
207 $self->send_talks($_, $cmdline);
209 $self->send($self->talk_prompt) if $self->{state} eq 'talk';
212 $self->state('prompt');
215 $self->send_ans(run_cmd($self, $cmdline));
218 # send a prompt only if we are in a prompt state
219 $self->prompt() if $self->{state} =~ /^prompt/o;
222 # send out the talk messages taking into account vias and connectivity
225 my ($self, $ent, $line) = @_;
227 my ($to, $via) = $ent =~ /(\S+)>(\S+)/;
228 $to = $ent unless $to;
229 my $call = $via ? $via : $to;
230 my $clref = DXCluster->get_exact($call);
231 my $dxchan = $clref->dxchan if $clref;
233 $dxchan->talk($self->{call}, $to, $via, $line);
235 $self->send($self->msg('disc2', $via ? $via : $to));
236 my @l = grep { $_ ne $ent } @{$self->{talklist}};
238 $self->{talklist} = \@l;
240 delete $self->{talklist};
241 $self->state('prompt');
250 for (@{$self->{talklist}}) {
251 my ($to, $via) = /(\S+)>(\S+)/;
255 return $self->msg('talkprompt', join(',', @call));
259 # send a load of stuff to a command user with page prompting
267 if ($self->{pagelth} && @_ > $self->{pagelth}) {
269 for ($i = $self->{pagelth}; $i-- > 0; ) {
271 $line =~ s/\s+$//o; # why am having to do this?
274 $self->{pagedata} = [ @_ ];
275 $self->state('page');
276 $self->send($self->msg('page', scalar @_));
279 $self->send($_) if $_;
284 # this is the thing that runs the command, it is done like this for the
285 # benefit of remote command execution
291 my $user = $self->{user};
292 my $call = $self->{call};
297 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
298 dbg('eval', "stored func cmd = $c\n");
301 return ("Syserr: Eval err $errstr on stored func $self->{func}", $@);
305 return () if length $cmdline == 0;
308 $cmdline =~ s|//|/|og;
310 # split the command line up into parts, the first part is the command
311 my ($cmd, $args) = split /\s+/, $cmdline, 2;
312 $args = "" unless defined $args;
318 dbg('command', "cmd: $cmd");
320 # alias it if possible
321 my $acmd = CmdAlias::get_cmd($cmd);
323 ($cmd, $args) = split /\s+/, "$acmd $args", 2;
324 $args = "" unless defined $args;
325 dbg('command', "aliased cmd: $cmd $args");
328 # first expand out the entry to a command
329 ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
330 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
333 dbg('command', "path: $cmd cmd: $fcmd");
335 my $package = find_cmd_name($path, $fcmd);
336 @ans = (0) if !$package ;
339 dbg('command', "package: $package");
341 unless (exists $Cache{$package}->{'sub'}) {
342 $c = eval $Cache{$package}->{'eval'};
344 return DXDebug::shortmess($@);
346 $Cache{$package}->{'sub'} = $c;
348 $c = $Cache{$package}->{'sub'};
350 @ans = &{$c}($self, $args);
355 return (DXDebug::shortmess($@));
359 dbg('command', "cmd: $cmd not found");
360 if (++$self->{errors} > $maxerrors) {
361 $self->send($self->msg('e26'));
365 return ($self->msg('e1'));
373 delete $self->{errors};
375 if (++$self->{errors} > $maxerrors) {
376 $self->send($self->msg('e26'));
385 # This is called from inside the main cluster processing loop and is used
386 # for despatching commands that are doing some long processing job
391 my @dxchan = DXChannel->get_all();
394 foreach $dxchan (@dxchan) {
395 next if $dxchan->sort ne 'U';
397 # send a prompt if no activity out on this channel
398 if ($t >= $dxchan->t + $main::user_interval) {
399 $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
406 # finish up a user context
411 my $call = $self->call;
413 # reset the redirection of messages back to 'normal' if we are the sysop
414 if ($call eq $main::myalias) {
415 my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
416 $node->dxchan($DXProt::me);
419 my @rout = $main::routeroot->del_user($call);
420 dbg('route', "B/C PC17 on $main::mycall for: $call");
422 # I was the last node visited
423 $self->user->node($main::mycall);
425 # issue a pc17 to everybody interested
426 my $nchan = DXChannel->get($main::mycall);
427 my $pc17 = $nchan->pc17($self);
428 DXProt::broadcast_all_ak1a($pc17);
430 # send info to all logged in thingies
431 $self->tell_login('logoutu');
433 Log('DXCommand', "$call disconnected");
434 my $ref = DXCluster->get_exact($call);
437 $self->SUPER::disconnect;
441 # short cut to output a prompt
447 $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call, cldate($main::systime), ztime($main::systime)));
450 # broadcast a message to all users [except those mentioned after buffer]
453 my $pkg = shift; # ignored
454 my $s = shift; # the line to be rebroadcast
455 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
456 my @list = DXChannel->get_all(); # just in case we are called from some funny object
457 my ($dxchan, $except);
459 L: foreach $dxchan (@list) {
460 next if !$dxchan->sort eq 'U'; # only interested in user channels
461 foreach $except (@except) {
462 next L if $except == $dxchan; # ignore channels in the 'except' list
464 $dxchan->send($s); # send it
468 # gimme all the users
471 my @list = DXChannel->get_all();
474 foreach $ref (@list) {
475 push @out, $ref if $ref->sort eq 'U';
480 # run a script for this user
484 my $silent = shift || 0;
489 # search for the command in the cache of short->long form commands
494 my ($path, $short_cmd, $suffix) = @_;
497 # commands are lower case
498 $short_cmd = lc $short_cmd;
499 dbg('command', "command: $path $short_cmd\n");
501 # do some checking for funny characters
502 return () if $short_cmd =~ /\/$/;
504 # return immediately if we have it
505 ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
506 if ($apath && $acmd) {
507 dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
508 return ($apath, $acmd);
512 my @parts = split '/', $short_cmd;
519 for ($i = 0; $i < @parts; $i++) {
521 opendir(D, $curdir) or confess "can't open $curdir $!";
525 foreach $l (sort @ls) {
527 if ($i < $#parts) { # we are dealing with directories
528 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
529 dbg('command', "got dir: $curdir/$l\n");
534 } else { # we are dealing with commands
535 @lparts = split /\./, $l;
536 next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
537 if ($p eq substr($l, 0, length $p)) {
538 pop @lparts; # remove the suffix
539 $l = join '.', @lparts;
540 # chop $dirfn; # remove trailing /
541 $dirfn = "" unless $dirfn;
542 $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
543 dbg('command', "got path: $path cmd: $dirfn$l\n");
544 return ($path, "$dirfn$l");
552 # clear the command name cache
559 # the persistant execution of things from the command directories
562 # This allows perl programs to call functions dynamically
564 # This has been nicked directly from the perlembed pages
567 #require Devel::Symdump;
569 sub valid_package_name {
571 $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
573 #second pass only for words starting with a digit
574 $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
576 #Dress it up as a real package name
577 $string =~ s/\//_/og;
581 # find a cmd reference
582 # this is really for use in user written stubs
584 # use the result as a symbolic reference:-
587 # @out = &$r($self, $line);
596 # first expand out the entry to a command
597 my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
598 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
600 # make sure it is loaded
601 $r = find_cmd_name($path, $fcmd);
607 # this bit of magic finds a command in the offered directory
611 my $package = valid_package_name($cmdname);
612 my $filename = "$path/$cmdname.pl";
613 my $mtime = -M $filename;
615 # return if we can't find it
617 unless (defined $mtime) {
618 $errstr = DXM::msg('e1');
622 if(defined $Cache{$package}->{mtime} &&$Cache{$package}->{mtime} <= $mtime) {
623 #we have compiled this subroutine already,
624 #it has not been updated on disk, nothing left to do
625 #print STDERR "already compiled $package->handler\n";
629 my $sub = readfilestr($filename);
631 $errstr = "Syserr: can't open '$filename' $!";
635 #wrap the code into a subroutine inside our unique package
636 my $eval = qq( sub { $sub } );
639 my @list = split /\n/, $eval;
642 dbg('eval', $_, "\n");
646 $Cache{$package} = {mtime => $mtime, 'eval' => $eval };
652 # send a talk message here
655 my ($self, $from, $to, $via, $line) = @_;
656 $line =~ s/\\5E/\^/g;
657 $self->send("$to de $from: $line") if $self->{talk};
658 Log('talk', $to, $from, $main::mycall, $line);