3 # This module impliments the user facing command mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
10 package DXCommandmode;
40 use vars qw(%Cache %cmd_cache $errstr %aliases $scriptbase $maxerrors %nothereslug $maxbadcount);
42 %Cache = (); # cache of dynamically loaded routine's mod times
43 %cmd_cache = (); # cache of short names
44 $errstr = (); # error string from eval
45 %aliases = (); # aliases for (parts of) commands
46 $scriptbase = "$main::root/scripts"; # the place where all users start scripts go
47 $maxerrors = 20; # the maximum number of concurrent errors allowed before disconnection
48 $maxbadcount = 3; # no of bad words allowed before disconnection
51 use vars qw($VERSION $BRANCH);
52 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
53 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
54 $main::build += $VERSION;
55 $main::branch += $BRANCH;
58 # obtain a new connection this is derived from dxchannel
63 my $self = DXChannel::alloc(@_);
65 # routing, this must go out here to prevent race condx
68 my @rout = $main::routeroot->add_user($call, Route::here(1));
70 # ALWAYS output the user
71 my $ref = Route::User::get($call);
72 $main::me->route_pc16($main::mycall, undef, $main::routeroot, $ref) if $ref;
77 # this is how a a connection starts, you get a hello message and the motd with
78 # possibly some other messages asking you to set various things up if you are
79 # new (or nearly new and slacking) user.
83 my ($self, $line, $sort) = @_;
84 my $user = $self->{user};
85 my $call = $self->{call};
86 my $name = $user->{name};
89 my $host = $self->{conn}->{peerhost} || "unknown";
90 Log('DXCommand', "$call connected from $host");
92 $self->{name} = $name ? $name : $call;
93 $self->send($self->msg('l2',$self->{name}));
94 $self->state('prompt'); # a bit of room for further expansion, passwords etc
95 $self->{priv} = $user->priv || 0;
96 $self->{lang} = $user->lang || $main::lang || 'en';
97 $self->{pagelth} = $user->pagelth || 20;
98 ($self->{width}) = $line =~ /width=(\d+)/; $line =~ s/\s*width=\d+\s*//;
99 $self->{width} = 80 unless $self->{width} && $self->{width} > 80;
100 $self->{consort} = $line; # save the connection type
102 # set some necessary flags on the user if they are connecting
103 $self->{beep} = $user->wantbeep;
104 $self->{ann} = $user->wantann;
105 $self->{wwv} = $user->wantwwv;
106 $self->{wcy} = $user->wantwcy;
107 $self->{talk} = $user->wanttalk;
108 $self->{wx} = $user->wantwx;
109 $self->{dx} = $user->wantdx;
110 $self->{logininfo} = $user->wantlogininfo;
111 $self->{ann_talk} = $user->wantann_talk;
113 $self->{prompt} = $user->prompt if $user->prompt;
115 # sort out new dx spot stuff
116 $user->wantdxcq(0) unless defined $user->{wantdxcq};
117 $user->wantdxitu(0) unless defined $user->{wantdxitu};
118 $user->wantusstate(0) unless defined $user->{wantusstate};
120 # sort out registration
121 if ($main::reqreg == 1) {
122 $self->{registered} = $user->registered;
123 } elsif ($main::reqreg == 2) {
124 $self->{registered} = !$user->registered;
126 $self->{registered} = 1;
130 # decide which motd to send
131 my $motd = "${main::motd}_nor" unless $self->{registered};
132 $motd = $main::motd unless $motd && -e $motd;
133 $self->send_file($motd) if -e $motd;
135 # sort out privilege reduction
136 $self->{priv} = 0 if $line =~ /^(ax|te)/ && !$self->conn->{usedpasswd};
139 $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'user_default', 0);
140 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'user_default', 0);
141 $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'user_default', 0);
142 $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'user_default', 0) ;
144 # clean up qra locators
145 my $qra = $user->qra;
146 $qra = undef if ($qra && !DXBearing::is_qra($qra));
148 my $lat = $user->lat;
149 my $long = $user->long;
150 $user->qra(DXBearing::lltoqra($lat, $long)) if (defined $lat && defined $long);
154 my $echo = $user->wantecho;
156 $self->send_now('E', "0");
157 $self->send($self->msg('echow'));
158 $self->conn->echo($echo) if $self->conn->can('echo');
161 $self->tell_login('loginu');
163 # do we need to send a forward/opernam?
164 my $lastoper = $user->lastoper || 0;
165 my $homenode = $user->homenode || "";
166 if ($homenode eq $main::mycall && $main::systime >= $lastoper + $DXUser::lastoperinterval) {
167 run_cmd($main::me, "forward/opernam $call");
168 $user->lastoper($main::systime + ((int rand(10)) * 86400));
171 # run a script send the output to the punter
172 my $script = new Script(lc $call) || new Script('user_default');
173 $script->run($self) if $script;
176 my $info = Route::cluster();
177 $self->send("Cluster:$info");
179 # send prompts and things
180 $self->send($self->msg('namee1')) if !$user->name;
181 $self->send($self->msg('qthe1')) if !$user->qth;
182 $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
183 $self->send($self->msg('hnodee1')) if !$user->qth;
184 $self->send($self->msg('m9')) if DXMsg::for_me($call);
189 # This is the normal command prompt driver
198 # save this for them's that need it
199 my $rawline = $cmdline;
201 # remove leading and trailing spaces
202 $cmdline =~ s/^\s*(.*)\s*$/$1/;
204 if ($self->{state} eq 'page') {
205 my $i = $self->{pagelth};
206 my $ref = $self->{pagedata};
209 # abort if we get a line starting in with a
210 if ($cmdline =~ /^a/io) {
215 # send a tranche of data
216 while ($i-- > 0 && @$ref) {
217 my $line = shift @$ref;
218 $line =~ s/\s+$//o; # why am having to do this?
222 # reset state if none or else chuck out an intermediate prompt
224 $tot -= $self->{pagelth};
225 $self->send($self->msg('page', $tot));
227 $self->state('prompt');
229 } elsif ($self->{state} eq 'sysop') {
230 my $passwd = $self->{user}->passwd;
232 my @pw = grep {$_ !~ /\s/} split //, $passwd;
233 my @l = @{$self->{passwd}};
234 my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
235 if ($cmdline =~ /$str/) {
236 $self->{priv} = $self->{user}->priv;
238 $self->send($self->msg('sorry'));
241 $self->send($self->msg('sorry'));
243 $self->state('prompt');
244 } elsif ($self->{state} eq 'passwd') {
245 my $passwd = $self->{user}->passwd;
246 if ($passwd && $cmdline eq $passwd) {
247 $self->send($self->msg('pw1'));
248 $self->state('passwd1');
250 $self->conn->{echo} = $self->conn->{decho};
251 delete $self->conn->{decho};
252 $self->send($self->msg('sorry'));
253 $self->state('prompt');
255 } elsif ($self->{state} eq 'passwd1') {
256 $self->{passwd} = $cmdline;
257 $self->send($self->msg('pw2'));
258 $self->state('passwd2');
259 } elsif ($self->{state} eq 'passwd2') {
260 if ($cmdline eq $self->{passwd}) {
261 $self->{user}->passwd($cmdline);
262 $self->send($self->msg('pw3'));
264 $self->send($self->msg('pw4'));
266 $self->conn->{echo} = $self->conn->{decho};
267 delete $self->conn->{decho};
268 $self->state('prompt');
269 } elsif ($self->{state} eq 'talk') {
270 if ($cmdline =~ m{^(?:/EX|/ABORT)}i) {
271 for (@{$self->{talklist}}) {
272 $self->send_talks($_, $self->msg('talkend'));
274 $self->state('prompt');
275 delete $self->{talklist};
276 } elsif ($cmdline =~ m|^/+\w+|) {
278 my $sendit = $cmdline =~ s|^/+||;
279 my @in = $self->run_cmd($cmdline);
280 $self->send_ans(@in);
281 if ($sendit && $self->{talklist} && @{$self->{talklist}}) {
282 foreach my $l (@in) {
284 if (@bad = BadWords::check($l)) {
285 $self->badcount(($self->badcount||0) + @bad);
286 Log('DXCommand', "$self->{call} swore: $l");
288 for (@{$self->{talklist}}) {
289 $self->send_talks($_, $l);
294 $self->send($self->talk_prompt);
295 } elsif ($self->{talklist} && @{$self->{talklist}}) {
296 # send what has been said to whoever is in this person's talk list
298 if (@bad = BadWords::check($cmdline)) {
299 $self->badcount(($self->badcount||0) + @bad);
300 Log('DXCommand', "$self->{call} swore: $cmdline");
302 for (@{$self->{talklist}}) {
303 $self->send_talks($_, $rawline);
306 $self->send($self->talk_prompt) if $self->{state} eq 'talk';
309 $self->state('prompt');
311 } elsif (my $func = $self->{func}) {
314 if (ref $self->{edit}) {
315 eval { @ans = $self->{edit}->$func($self, $rawline)};
317 eval { @ans = &{$self->{func}}($self, $rawline) };
320 $self->send_ans("Syserr: on stored func $self->{func}", $@);
321 delete $self->{func};
322 $self->state('prompt');
325 $self->send_ans(@ans);
327 $self->send_ans(run_cmd($self, $cmdline));
330 # check for excessive swearing
331 if ($self->{badcount} && $self->{badcount} >= $maxbadcount) {
332 Log('DXCommand', "$self->{call} logged out for excessive swearing");
337 # send a prompt only if we are in a prompt state
338 $self->prompt() if $self->{state} =~ /^prompt/o;
341 # send out the talk messages taking into account vias and connectivity
344 my ($self, $ent, $line) = @_;
346 my ($to, $via) = $ent =~ /(\S+)>(\S+)/;
347 $to = $ent unless $to;
348 my $call = $via ? $via : $to;
349 my $clref = Route::get($call);
350 my $dxchan = $clref->dxchan if $clref;
352 $dxchan->talk($self->{call}, $to, $via, $line);
354 $self->send($self->msg('disc2', $via ? $via : $to));
355 my @l = grep { $_ ne $ent } @{$self->{talklist}};
357 $self->{talklist} = \@l;
359 delete $self->{talklist};
360 $self->state('prompt');
369 for (@{$self->{talklist}}) {
370 my ($to, $via) = /(\S+)>(\S+)/;
374 return $self->msg('talkprompt', join(',', @call));
378 # send a load of stuff to a command user with page prompting
386 if ($self->{pagelth} && @_ > $self->{pagelth}) {
388 for ($i = $self->{pagelth}; $i-- > 0; ) {
390 $line =~ s/\s+$//o; # why am having to do this?
393 $self->{pagedata} = [ @_ ];
394 $self->state('page');
395 $self->send($self->msg('page', scalar @_));
407 # this is the thing that runs the command, it is done like this for the
408 # benefit of remote command execution
414 my $user = $self->{user};
415 my $call = $self->{call};
420 return () if length $cmdline == 0;
422 # split the command line up into parts, the first part is the command
423 my ($cmd, $args) = split /\s+/, $cmdline, 2;
424 $args = "" unless defined $args;
427 # strip out // on command only
432 dbg("cmd: $cmd") if isdbg('command');
434 # alias it if possible
435 my $acmd = CmdAlias::get_cmd($cmd);
437 ($cmd, $args) = split /\s+/, "$acmd $args", 2;
438 $args = "" unless defined $args;
439 dbg("aliased cmd: $cmd $args") if isdbg('command');
442 # first expand out the entry to a command
443 ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
444 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
447 dbg("path: $cmd cmd: $fcmd") if isdbg('command');
449 my $package = find_cmd_name($path, $fcmd);
454 dbg("package: $package") if isdbg('command');
455 eval { @ans = &$package($self, $args) };
456 return (DXDebug::shortmess($@)) if $@;
459 dbg("cmd: $cmd not found") if isdbg('command');
460 if (++$self->{errors} > $maxerrors) {
461 $self->send($self->msg('e26'));
465 return ($self->msg('e1'));
472 delete $self->{errors};
474 if (++$self->{errors} > $maxerrors) {
475 $self->send($self->msg('e26'));
480 return map {s/([^\s])\s+$/$1/; $_} @ans;
484 # This is called from inside the main cluster processing loop and is used
485 # for despatching commands that are doing some long processing job
490 my @dxchan = DXChannel->get_all();
493 foreach $dxchan (@dxchan) {
494 next if $dxchan->sort ne 'U';
496 # send a prompt if no activity out on this channel
497 if ($t >= $dxchan->t + $main::user_interval) {
498 $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
503 while (my ($k, $v) = each %nothereslug) {
504 if ($main::systime >= $v + 300) {
505 delete $nothereslug{$k};
511 # finish up a user context
516 my $call = $self->call;
518 return if $self->{disconnecting}++;
520 delete $self->{senddbg};
522 my $uref = Route::User::get($call);
525 @rout = $main::routeroot->del_user($uref);
526 dbg("B/C PC17 on $main::mycall for: $call") if isdbg('route');
528 # issue a pc17 to everybody interested
529 $main::me->route_pc17($main::mycall, undef, $main::routeroot, $uref);
531 confess "trying to disconnect a non existant user $call";
534 # I was the last node visited
535 $self->user->node($main::mycall);
537 # send info to all logged in thingies
538 $self->tell_login('logoutu');
540 Log('DXCommand', "$call disconnected");
542 $self->SUPER::disconnect;
546 # short cut to output a prompt
552 if ($self->{prompt}) {
553 $self->send($self->{prompt});
555 $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call, cldate($main::systime), ztime($main::systime)));
559 # broadcast a message to all users [except those mentioned after buffer]
562 my $pkg = shift; # ignored
563 my $s = shift; # the line to be rebroadcast
565 foreach my $dxchan (DXChannel->get_all()) {
566 next unless $dxchan->{sort} eq 'U'; # only interested in user channels
567 next if grep $dxchan == $_, @_;
568 $dxchan->send($s); # send it
572 # gimme all the users
575 return grep {$_->{sort} eq 'U'} DXChannel->get_all();
578 # run a script for this user
582 my $silent = shift || 0;
587 # search for the command in the cache of short->long form commands
592 my ($path, $short_cmd, $suffix) = @_;
595 # commands are lower case
596 $short_cmd = lc $short_cmd;
597 dbg("command: $path $short_cmd\n") if isdbg('command');
599 # do some checking for funny characters
600 return () if $short_cmd =~ /\/$/;
602 # return immediately if we have it
603 ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
604 if ($apath && $acmd) {
605 dbg("cached $short_cmd = ($apath, $acmd)\n") if isdbg('command');
606 return ($apath, $acmd);
610 my @parts = split '/', $short_cmd;
617 for ($i = 0; $i < @parts; $i++) {
619 opendir(D, $curdir) or confess "can't open $curdir $!";
623 foreach $l (sort @ls) {
625 if ($i < $#parts) { # we are dealing with directories
626 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
627 dbg("got dir: $curdir/$l\n") if isdbg('command');
632 } else { # we are dealing with commands
633 @lparts = split /\./, $l;
634 next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
635 if ($p eq substr($l, 0, length $p)) {
636 pop @lparts; # remove the suffix
637 $l = join '.', @lparts;
638 # chop $dirfn; # remove trailing /
639 $dirfn = "" unless $dirfn;
640 $cmd_cache{$short_cmd} = join(',', ($path, "$dirfn$l")); # cache it
641 dbg("got path: $path cmd: $dirfn$l\n") if isdbg('command');
642 return ($path, "$dirfn$l");
650 # clear the command name cache
656 undef *{$_} unless /cmd_cache/;
657 dbg("Undefining cmd $_") if isdbg('command');
664 # the persistant execution of things from the command directories
667 # This allows perl programs to call functions dynamically
669 # This has been nicked directly from the perlembed pages
672 #require Devel::Symdump;
674 sub valid_package_name {
676 $string =~ s|([^A-Za-z0-9_/])|sprintf("_%2x",unpack("C",$1))|eg;
679 return "cmd_$string";
683 # this bit of magic finds a command in the offered directory
687 my $package = valid_package_name($cmdname);
688 my $filename = "$path/$cmdname.pl";
689 my $mtime = -M $filename;
691 # return if we can't find it
693 unless (defined $mtime) {
694 $errstr = DXM::msg('e1');
698 if(defined $Cache{$package}->{mtime} &&$Cache{$package}->{mtime} <= $mtime) {
699 #we have compiled this subroutine already,
700 #it has not been updated on disk, nothing left to do
701 #print STDERR "already compiled $package->handler\n";
705 my $sub = readfilestr($filename);
707 $errstr = "Syserr: can't open '$filename' $!";
711 #wrap the code into a subroutine inside our unique package
712 my $eval = qq( sub $package { $sub } );
715 my @list = split /\n/, $eval;
718 dbg($_ . "\n") if isdbg('eval');
722 # get rid of any existing sub and try to compile the new one
725 if (exists $Cache{$package}) {
726 dbg("Redefining $package") if isdbg('command');
729 dbg("Defining $package") if isdbg('command');
733 $Cache{$package} = {mtime => $mtime };
742 my ($self, $let, $buf) = @_;
743 if ($self->{state} eq 'prompt' || $self->{state} eq 'talk') {
744 if ($self->{enhanced}) {
745 $self->send_later($let, $buf);
754 # send a talk message here
757 my ($self, $from, $to, $via, $line) = @_;
758 $line =~ s/\\5E/\^/g;
759 $self->local_send('T', "$to de $from: $line") if $self->{talk};
760 Log('talk', $to, $from, $via?$via:$main::mycall, $line);
761 # send a 'not here' message if required
762 unless ($self->{here} && $from ne $to) {
763 my $key = "$to$from";
764 unless (exists $nothereslug{$key}) {
766 if (($ref = Route::get($from)) && ($dxchan = $ref->dxchan)) {
767 my $name = $self->user->name || $to;
768 my $s = $self->user->nothere || $dxchan->msg('nothere', $name);
769 $nothereslug{$key} = $main::systime;
770 $dxchan->talk($to, $from, undef, $s);
787 if (!$self->{ann_talk} && $to ne $self->{call}) {
788 my $call = AnnTalk::is_talk_candidate($_[0], $text);
792 if ($self->{annfilter}) {
793 ($filter, $hops) = $self->{annfilter}->it(@_ );
794 return unless $filter;
797 unless ($self->{ann}) {
798 return if $_[0] ne $main::myalias && $_[0] ne $main::mycall;
800 return if $target eq 'SYSOP' && $self->{priv} < 5;
801 my $buf = "$to$target de $_[0]: $text";
803 $buf .= "\a\a" if $self->{beep};
804 $self->local_send($target eq 'WX' ? 'W' : 'N', $buf);
818 return unless grep uc $_ eq $target, @{$self->{user}->{group}};
820 $text =~ s/^\#\d+ //;
821 my $buf = "$target de $_[0]: $text";
823 $buf .= "\a\a" if $self->{beep};
824 $self->local_send('C', $buf);
831 my $t = ztime($_[2]);
833 my $clth = $self->{consort} eq 'local' ? 29 : 30;
834 my $comment = substr $_[3], 0, $clth;
835 $comment .= ' ' x ($clth - length($comment));
836 if ($self->{user}->wantgrid) {
837 my $ref = DXUser->get_current($_[4]);
839 $loc = $ref->qra || '';
840 $loc = ' ' . substr($loc, 0, 4) if $loc;
844 if ($self->{user}->wantdxitu) {
845 $loc = ' ' . sprintf("%2d", $_[10]) if defined $_[10];
846 $comment = substr($comment, 0, $self->{consort} eq 'local' ? 26 : 27) . ' ' . sprintf("%2d", $_[8]) if defined $_[8];
847 } elsif ($self->{user}->wantdxcq) {
848 $loc = ' ' . sprintf("%2d", $_[11]) if defined $_[11];
849 $comment = substr($comment, 0, $self->{consort} eq 'local' ? 26 : 27) . ' ' . sprintf("%2d", $_[9]) if defined $_[9];
850 } elsif ($self->{user}->wantusstate) {
851 $loc = ' ' . $_[13] if $_[13];
852 $comment = substr($comment, 0, $self->{consort} eq 'local' ? 26 : 27) . ' ' . $_[12] if $_[12];
855 return sprintf "DX de %-7.7s%11.1f %-12.12s %-s $t$loc", "$_[4]:", $_[0], $_[1], $comment;
864 return unless $self->{dx};
868 if ($self->{spotsfilter}) {
869 ($filter, $hops) = $self->{spotsfilter}->it(@_ );
870 return unless $filter;
873 dbg('spot: "' . join('","', @_) . '"') if isdbg('dxspot');
876 if ($self->{ve7cc}) {
877 $buf = VE7CC::dx_spot($self, @_);
879 $buf = $self->format_dx_spot(@_);
880 $buf .= "\a\a" if $self->{beep};
884 $self->local_send('X', $buf);
894 return unless $self->{wwv};
896 if ($self->{wwvfilter}) {
897 ($filter, $hops) = $self->{wwvfilter}->it(@_ );
898 return unless $filter;
901 my $buf = "WWV de $_[6] <$_[1]>: SFI=$_[2], A=$_[3], K=$_[4], $_[5]";
902 $buf .= "\a\a" if $self->{beep};
903 $self->local_send('V', $buf);
913 return unless $self->{wcy};
915 if ($self->{wcyfilter}) {
916 ($filter, $hops) = $self->{wcyfilter}->it(@_ );
917 return unless $filter;
920 my $buf = "WCY de $_[10] <$_[1]> : K=$_[4] expK=$_[5] A=$_[3] R=$_[6] SFI=$_[2] SA=$_[7] GMF=$_[8] Au=$_[9]";
921 $buf .= "\a\a" if $self->{beep};
922 $self->local_send('Y', $buf);
925 # broadcast debug stuff to all interested parties
928 my $s = shift; # the line to be rebroadcast
930 foreach my $dxchan (DXChannel->get_all) {
931 next unless $dxchan->{enhanced} && $dxchan->{senddbg};
932 $dxchan->send_later('L', $s);