3 # This module impliments the user facing command mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
10 package DXCommandmode;
37 use vars qw(%Cache %cmd_cache $errstr %aliases $scriptbase $maxerrors %nothereslug);
39 %Cache = (); # cache of dynamically loaded routine's mod times
40 %cmd_cache = (); # cache of short names
41 $errstr = (); # error string from eval
42 %aliases = (); # aliases for (parts of) commands
43 $scriptbase = "$main::root/scripts"; # the place where all users start scripts go
44 $maxerrors = 20; # the maximum number of concurrent errors allowed before disconnection
46 use vars qw($VERSION $BRANCH);
47 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
48 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
49 $main::build += $VERSION;
50 $main::branch += $BRANCH;
53 # obtain a new connection this is derived from dxchannel
58 my $self = DXChannel::alloc(@_);
60 # routing, this must go out here to prevent race condx
63 my @rout = $main::routeroot->add_user($call, Route::here(1));
64 DXProt::route_pc16($main::me, $main::routeroot, @rout) if @rout;
69 # this is how a a connection starts, you get a hello message and the motd with
70 # possibly some other messages asking you to set various things up if you are
71 # new (or nearly new and slacking) user.
75 my ($self, $line, $sort) = @_;
76 my $user = $self->{user};
77 my $call = $self->{call};
78 my $name = $user->{name};
81 my $host = $self->{conn}->{peerhost} || "unknown";
82 Log('DXCommand', "$call connected from $host");
84 $self->{name} = $name ? $name : $call;
85 $self->send($self->msg('l2',$self->{name}));
86 $self->send_file($main::motd) if (-e $main::motd);
87 $self->state('prompt'); # a bit of room for further expansion, passwords etc
88 $self->{priv} = $user->priv || 0;
89 $self->{lang} = $user->lang || $main::lang || 'en';
90 $self->{pagelth} = $user->pagelth || 20;
91 $self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
92 ($self->{width}) = $line =~ /width=(\d+)/;
93 $self->{width} = 80 unless $self->{width} && $self->{width} > 80;
94 $self->{consort} = $line; # save the connection type
96 # set some necessary flags on the user if they are connecting
97 $self->{beep} = $user->wantbeep;
98 $self->{ann} = $user->wantann;
99 $self->{wwv} = $user->wantwwv;
100 $self->{wcy} = $user->wantwcy;
101 $self->{talk} = $user->wanttalk;
102 $self->{wx} = $user->wantwx;
103 $self->{dx} = $user->wantdx;
104 $self->{logininfo} = $user->wantlogininfo;
105 $self->{ann_talk} = $user->wantann_talk;
109 $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'user_default', 0);
110 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'user_default', 0);
111 $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'user_default', 0);
112 $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'user_default', 0) ;
114 # clean up qra locators
115 my $qra = $user->qra;
116 $qra = undef if ($qra && !DXBearing::is_qra($qra));
118 my $lat = $user->lat;
119 my $long = $user->long;
120 $user->qra(DXBearing::lltoqra($lat, $long)) if (defined $lat && defined $long);
124 if (!$user->wantecho) {
125 $self->send_now('E', "0");
126 $self->send($self->msg('echow'));
129 $self->tell_login('loginu');
131 # do we need to send a forward/opernam?
132 my $lastoper = $user->lastoper || 0;
133 my $homenode = $user->homenode || "";
134 if ($homenode eq $main::mycall && $lastoper + $DXUser::lastoperinterval < $main::systime) {
135 run_cmd($main::me, "forward/opernam $call");
136 $user->lastoper($main::systime);
139 # run a script send the output to the punter
140 my $script = new Script(lc $call) || new Script('user_default');
141 $script->run($self) if $script;
144 my $info = Route::cluster();
145 $self->send("Cluster:$info");
147 # send prompts and things
148 $self->send($self->msg('namee1')) if !$user->name;
149 $self->send($self->msg('qthe1')) if !$user->qth;
150 $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
151 $self->send($self->msg('hnodee1')) if !$user->qth;
152 $self->send($self->msg('m9')) if DXMsg::for_me($call);
157 # This is the normal command prompt driver
166 # remove leading and trailing spaces
167 $cmdline =~ s/^\s*(.*)\s*$/$1/;
169 if ($self->{state} eq 'page') {
170 my $i = $self->{pagelth};
171 my $ref = $self->{pagedata};
174 # abort if we get a line starting in with a
175 if ($cmdline =~ /^a/io) {
180 # send a tranche of data
181 while ($i-- > 0 && @$ref) {
182 my $line = shift @$ref;
183 $line =~ s/\s+$//o; # why am having to do this?
187 # reset state if none or else chuck out an intermediate prompt
189 $tot -= $self->{pagelth};
190 $self->send($self->msg('page', $tot));
192 $self->state('prompt');
194 } elsif ($self->{state} eq 'sysop') {
195 my $passwd = $self->{user}->passwd;
196 my @pw = split / */, $passwd;
198 my @l = @{$self->{passwd}};
199 my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
200 if ($cmdline =~ /$str/) {
201 $self->{priv} = $self->{user}->priv;
203 $self->send($self->msg('sorry'));
206 $self->send($self->msg('sorry'));
208 delete $self->{passwd};
209 $self->state('prompt');
210 } elsif ($self->{state} eq 'talk') {
211 if ($cmdline =~ m{^(?:/EX|/ABORT)}i) {
212 for (@{$self->{talklist}}) {
213 $self->send_talks($_, $self->msg('talkend'));
215 $self->state('prompt');
216 delete $self->{talklist};
217 } elsif ($cmdline =~ m(^/\w+)) {
219 $self->send_ans(run_cmd($self, $cmdline));
220 $self->send($self->talk_prompt);
221 } elsif ($self->{talklist} && @{$self->{talklist}}) {
222 # send what has been said to whoever is in this person's talk list
223 for (@{$self->{talklist}}) {
224 $self->send_talks($_, $cmdline);
226 $self->send($self->talk_prompt) if $self->{state} eq 'talk';
229 $self->state('prompt');
231 } elsif (my $func = $self->{func}) {
234 if (ref $self->{edit}) {
235 eval { @ans = $self->{edit}->$func($self, $cmdline)};
237 eval { @ans = &{$self->{func}}($self, $cmdline) };
239 $self->send_ans("Syserr: on stored func $self->{func}", $@) if $@;
240 $self->send_ans(@ans);
242 $self->send_ans(run_cmd($self, $cmdline));
245 # send a prompt only if we are in a prompt state
246 $self->prompt() if $self->{state} =~ /^prompt/o;
249 # send out the talk messages taking into account vias and connectivity
252 my ($self, $ent, $line) = @_;
254 my ($to, $via) = $ent =~ /(\S+)>(\S+)/;
255 $to = $ent unless $to;
256 my $call = $via ? $via : $to;
257 my $clref = Route::get($call);
258 my $dxchan = $clref->dxchan if $clref;
260 $dxchan->talk($self->{call}, $to, $via, $line);
262 $self->send($self->msg('disc2', $via ? $via : $to));
263 my @l = grep { $_ ne $ent } @{$self->{talklist}};
265 $self->{talklist} = \@l;
267 delete $self->{talklist};
268 $self->state('prompt');
277 for (@{$self->{talklist}}) {
278 my ($to, $via) = /(\S+)>(\S+)/;
282 return $self->msg('talkprompt', join(',', @call));
286 # send a load of stuff to a command user with page prompting
294 if ($self->{pagelth} && @_ > $self->{pagelth}) {
296 for ($i = $self->{pagelth}; $i-- > 0; ) {
298 $line =~ s/\s+$//o; # why am having to do this?
301 $self->{pagedata} = [ @_ ];
302 $self->state('page');
303 $self->send($self->msg('page', scalar @_));
315 # this is the thing that runs the command, it is done like this for the
316 # benefit of remote command execution
322 my $user = $self->{user};
323 my $call = $self->{call};
328 return () if length $cmdline == 0;
331 $cmdline =~ s|//|/|og;
333 # split the command line up into parts, the first part is the command
334 my ($cmd, $args) = split /\s+/, $cmdline, 2;
335 $args = "" unless defined $args;
341 dbg("cmd: $cmd") if isdbg('command');
343 # alias it if possible
344 my $acmd = CmdAlias::get_cmd($cmd);
346 ($cmd, $args) = split /\s+/, "$acmd $args", 2;
347 $args = "" unless defined $args;
348 dbg("aliased cmd: $cmd $args") if isdbg('command');
351 # first expand out the entry to a command
352 ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
353 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
356 dbg("path: $cmd cmd: $fcmd") if isdbg('command');
358 my $package = find_cmd_name($path, $fcmd);
363 dbg("package: $package") if isdbg('command');
364 eval { @ans = &$package($self, $args) };
365 return (DXDebug::shortmess($@)) if $@;
368 dbg("cmd: $cmd not found") if isdbg('command');
369 if (++$self->{errors} > $maxerrors) {
370 $self->send($self->msg('e26'));
374 return ($self->msg('e1'));
381 delete $self->{errors};
383 if (++$self->{errors} > $maxerrors) {
384 $self->send($self->msg('e26'));
393 # This is called from inside the main cluster processing loop and is used
394 # for despatching commands that are doing some long processing job
399 my @dxchan = DXChannel->get_all();
402 foreach $dxchan (@dxchan) {
403 next if $dxchan->sort ne 'U';
405 # send a prompt if no activity out on this channel
406 if ($t >= $dxchan->t + $main::user_interval) {
407 $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
412 while (my ($k, $v) = each %nothereslug) {
413 if ($main::systime >= $v + 300) {
414 delete $nothereslug{$k};
420 # finish up a user context
425 my $call = $self->call;
427 return if $self->{disconnecting}++;
429 delete $self->{senddbg};
431 my $uref = Route::User::get($call);
434 @rout = $main::routeroot->del_user($uref);
435 dbg("B/C PC17 on $main::mycall for: $call") if isdbg('route');
437 confess "trying to disconnect a non existant user $call";
440 # issue a pc17 to everybody interested
441 DXProt::route_pc17($main::me, $main::routeroot, @rout) if @rout;
443 # I was the last node visited
444 $self->user->node($main::mycall);
446 # send info to all logged in thingies
447 $self->tell_login('logoutu');
449 Log('DXCommand', "$call disconnected");
451 $self->SUPER::disconnect;
455 # short cut to output a prompt
461 $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call, cldate($main::systime), ztime($main::systime)));
464 # broadcast a message to all users [except those mentioned after buffer]
467 my $pkg = shift; # ignored
468 my $s = shift; # the line to be rebroadcast
470 foreach my $dxchan (DXChannel->get_all()) {
471 next unless $dxchan->{sort} eq 'U'; # only interested in user channels
472 next if grep $dxchan == $_, @_;
473 $dxchan->send($s); # send it
477 # gimme all the users
480 return grep {$_->{sort} eq 'U'} DXChannel->get_all();
483 # run a script for this user
487 my $silent = shift || 0;
492 # search for the command in the cache of short->long form commands
497 my ($path, $short_cmd, $suffix) = @_;
500 # commands are lower case
501 $short_cmd = lc $short_cmd;
502 dbg("command: $path $short_cmd\n") if isdbg('command');
504 # do some checking for funny characters
505 return () if $short_cmd =~ /\/$/;
507 # return immediately if we have it
508 ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
509 if ($apath && $acmd) {
510 dbg("cached $short_cmd = ($apath, $acmd)\n") if isdbg('command');
511 return ($apath, $acmd);
515 my @parts = split '/', $short_cmd;
522 for ($i = 0; $i < @parts; $i++) {
524 opendir(D, $curdir) or confess "can't open $curdir $!";
528 foreach $l (sort @ls) {
530 if ($i < $#parts) { # we are dealing with directories
531 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
532 dbg("got dir: $curdir/$l\n") if isdbg('command');
537 } else { # we are dealing with commands
538 @lparts = split /\./, $l;
539 next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
540 if ($p eq substr($l, 0, length $p)) {
541 pop @lparts; # remove the suffix
542 $l = join '.', @lparts;
543 # chop $dirfn; # remove trailing /
544 $dirfn = "" unless $dirfn;
545 $cmd_cache{$short_cmd} = join(',', ($path, "$dirfn$l")); # cache it
546 dbg("got path: $path cmd: $dirfn$l\n") if isdbg('command');
547 return ($path, "$dirfn$l");
555 # clear the command name cache
562 dbg("Undefining cmd $_") if isdbg('command');
569 # the persistant execution of things from the command directories
572 # This allows perl programs to call functions dynamically
574 # This has been nicked directly from the perlembed pages
577 #require Devel::Symdump;
579 sub valid_package_name {
581 $string =~ s|([^A-Za-z0-9_/])|sprintf("_%2x",unpack("C",$1))|eg;
584 return "cmd_$string";
588 # this bit of magic finds a command in the offered directory
592 my $package = valid_package_name($cmdname);
593 my $filename = "$path/$cmdname.pl";
594 my $mtime = -M $filename;
596 # return if we can't find it
598 unless (defined $mtime) {
599 $errstr = DXM::msg('e1');
603 if(defined $Cache{$package}->{mtime} &&$Cache{$package}->{mtime} <= $mtime) {
604 #we have compiled this subroutine already,
605 #it has not been updated on disk, nothing left to do
606 #print STDERR "already compiled $package->handler\n";
610 my $sub = readfilestr($filename);
612 $errstr = "Syserr: can't open '$filename' $!";
616 #wrap the code into a subroutine inside our unique package
617 my $eval = qq( sub $package { $sub } );
620 my @list = split /\n/, $eval;
623 dbg($_ . "\n") if isdbg('eval');
627 # get rid of any existing sub and try to compile the new one
630 if (exists $Cache{$package}) {
631 dbg("Redefining $package") if isdbg('command');
634 dbg("Defining $package") if isdbg('command');
638 $Cache{$package} = {mtime => $mtime };
647 my ($self, $let, $buf) = @_;
648 if ($self->{state} eq 'prompt' || $self->{state} eq 'talk') {
649 if ($self->{enhanced}) {
650 $self->send_later($let, $buf);
659 # send a talk message here
662 my ($self, $from, $to, $via, $line) = @_;
663 $line =~ s/\\5E/\^/g;
664 $self->local_send('T', "$to de $from: $line") if $self->{talk};
665 Log('talk', $to, $from, $main::mycall, $line);
666 # send a 'not here' message if required
667 unless ($self->{here} && $from ne $to) {
668 my $key = "$to$from";
669 unless (exists $nothereslug{$key}) {
671 if (($ref = Route::get($from)) && ($dxchan = $ref->dxchan)) {
672 my $name = $self->user->name || $to;
673 my $s = $self->user->nothere || $dxchan->msg('nothere', $name);
674 $nothereslug{$key} = $main::systime;
675 $dxchan->talk($to, $from, undef, $s);
692 if (!$self->{ann_talk} && $to ne $self->{call}) {
693 my $call = AnnTalk::is_talk_candidate($_[0], $text);
697 if ($self->{annfilter}) {
698 ($filter, $hops) = $self->{annfilter}->it(@_ );
699 return unless $filter;
702 unless ($self->{ann}) {
703 return if $_[0] ne $main::myalias && $_[0] ne $main::mycall;
705 return if $target eq 'SYSOP' && $self->{priv} < 5;
706 my $buf = "$to$target de $_[0]: $text";
708 $buf .= "\a\a" if $self->{beep};
709 $self->local_send($target eq 'WX' ? 'W' : 'N', $buf);
720 return unless $self->{dx};
722 if ($self->{spotsfilter}) {
723 ($filter, $hops) = $self->{spotsfilter}->it(@_ );
724 return unless $filter;
727 my $buf = Spot::formatb($self->{user}->wantgrid, $_[0], $_[1], $_[2], $_[3], $_[4]);
728 $buf .= "\a\a" if $self->{beep};
730 $self->local_send('X', $buf);
740 return unless $self->{wwv};
742 if ($self->{wwvfilter}) {
743 ($filter, $hops) = $self->{wwvfilter}->it(@_ );
744 return unless $filter;
747 my $buf = "WWV de $_[6] <$_[1]>: SFI=$_[2], A=$_[3], K=$_[4], $_[5]";
748 $buf .= "\a\a" if $self->{beep};
749 $self->local_send('V', $buf);
759 return unless $self->{wcy};
761 if ($self->{wcyfilter}) {
762 ($filter, $hops) = $self->{wcyfilter}->it(@_ );
763 return unless $filter;
766 my $buf = "WCY de $_[10] <$_[1]> : K=$_[4] expK=$_[5] A=$_[3] R=$_[6] SFI=$_[2] SA=$_[7] GMF=$_[8] Au=$_[9]";
767 $buf .= "\a\a" if $self->{beep};
768 $self->local_send('Y', $buf);
771 # broadcast debug stuff to all interested parties
774 my $s = shift; # the line to be rebroadcast
776 foreach my $dxchan (DXChannel->get_all) {
777 next unless $dxchan->{enhanced} && $dxchan->{senddbg};
778 $dxchan->send_later('L', $s);