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);
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
44 # obtain a new connection this is derived from dxchannel
49 my $self = DXChannel::alloc(@_);
53 # this is how a a connection starts, you get a hello message and the motd with
54 # possibly some other messages asking you to set various things up if you are
55 # new (or nearly new and slacking) user.
59 my ($self, $line, $sort) = @_;
60 my $user = $self->{user};
61 my $call = $self->{call};
62 my $name = $user->{name};
64 $self->{name} = $name ? $name : $call;
65 $self->send($self->msg('l2',$self->{name}));
66 $self->send_file($main::motd) if (-e $main::motd);
67 $self->state('prompt'); # a bit of room for further expansion, passwords etc
68 $self->{priv} = $user->priv || 0;
69 $self->{lang} = $user->lang || 'en';
70 $self->{pagelth} = $user->pagelth || 20;
71 $self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
72 $self->{consort} = $line; # save the connection type
74 # set some necessary flags on the user if they are connecting
75 $self->{beep} = $user->wantbeep;
76 $self->{ann} = $user->wantann;
77 $self->{wwv} = $user->wantwwv;
78 $self->{wcy} = $user->wantwcy;
79 $self->{talk} = $user->wanttalk;
80 $self->{wx} = $user->wantwx;
81 $self->{dx} = $user->wantdx;
82 $self->{logininfo} = $user->wantlogininfo;
85 # clean up qra locators
87 $qra = undef if ($qra && !DXBearing::is_qra($qra));
90 my $long = $user->long;
91 $user->qra(DXBearing::lltoqra($lat, $long)) if (defined $lat && defined $long);
94 # add yourself to the database
95 my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
96 my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
97 $node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
99 # issue a pc16 to everybody interested
100 my $nchan = DXChannel->get($main::mycall);
101 my @pc16 = DXProt::pc16($nchan, $cuser);
103 DXProt::broadcast_all_ak1a($_);
105 Log('DXCommand', "$call connected");
107 # send prompts and things
108 my $info = DXCluster::cluster();
109 $self->send("Cluster:$info");
110 $self->send($self->msg('namee1')) if !$user->name;
111 $self->send($self->msg('qthe1')) if !$user->qth;
112 $self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
113 $self->send($self->msg('hnodee1')) if !$user->qth;
114 $self->send($self->msg('m9')) if DXMsg::for_me($call);
115 $self->send($self->msg('pr', $call));
118 if (!$user->wantecho) {
119 $self->send_now('E', "0");
120 $self->send($self->msg('echow'));
123 $self->tell_login('loginu');
128 # This is the normal command prompt driver
137 # remove leading and trailing spaces
138 $cmdline =~ s/^\s*(.*)\s*$/$1/;
140 if ($self->{state} eq 'page') {
141 my $i = $self->{pagelth};
142 my $ref = $self->{pagedata};
145 # abort if we get a line starting in with a
146 if ($cmdline =~ /^a/io) {
151 # send a tranche of data
152 while ($i-- > 0 && @$ref) {
153 my $line = shift @$ref;
154 $line =~ s/\s+$//o; # why am having to do this?
158 # reset state if none or else chuck out an intermediate prompt
160 $tot -= $self->{pagelth};
161 $self->send($self->msg('page', $tot));
163 $self->state('prompt');
165 } elsif ($self->{state} eq 'sysop') {
166 my $passwd = $self->{user}->passwd;
167 my @pw = split / */, $passwd;
169 my @l = @{$self->{passwd}};
170 my $str = "$pw[$l[0]].*$pw[$l[1]].*$pw[$l[2]].*$pw[$l[3]].*$pw[$l[4]]";
171 if ($cmdline =~ /$str/) {
172 $self->{priv} = $self->{user}->priv;
174 $self->send($self->msg('sorry'));
177 $self->send($self->msg('sorry'));
179 delete $self->{passwd};
180 $self->state('prompt');
181 } elsif ($self->{state} eq 'talk') {
182 if ($cmdline =~ m{^(?:/EX|/ABORT)}i) {
183 for (@{$self->{talklist}}) {
184 $self->send_talks($_, $self->msg('talkend'));
186 $self->state('prompt');
187 delete $self->{talklist};
188 } elsif ($cmdline =~ m(^/\w+)) {
190 $self->send_ans(run_cmd($self, $cmdline));
191 $self->send($self->talk_prompt);
192 } elsif ($self->{talklist} && @{$self->{talklist}}) {
193 # send what has been said to whoever is in this person's talk list
194 for (@{$self->{talklist}}) {
195 $self->send_talks($_, $cmdline);
197 $self->send($self->talk_prompt) if $self->{state} eq 'talk';
200 $self->state('prompt');
203 $self->send_ans(run_cmd($self, $cmdline));
206 # send a prompt only if we are in a prompt state
207 $self->prompt() if $self->{state} =~ /^prompt/o;
210 # send out the talk messages taking into account vias and connectivity
213 my ($self, $ent, $line) = @_;
215 my ($to, $via) = $ent =~ /(\S+)>(\S+)/;
216 $to = $ent unless $to;
217 my $call = $via ? $via : $to;
218 my $clref = DXCluster->get_exact($call);
219 my $dxchan = $clref->dxchan if $clref;
221 $dxchan->talk($self->{call}, $to, $via, $line);
223 $self->send($self->msg('disc2', $via ? $via : $to));
224 my @l = grep { $_ ne $ent } @{$self->{talklist}};
226 $self->{talklist} = \@l;
228 delete $self->{talklist};
229 $self->state('prompt');
238 for (@{$self->{talklist}}) {
239 my ($to, $via) = /(\S+)>(\S+)/;
243 return $self->msg('talkprompt', join(',', @call));
247 # send a load of stuff to a command user with page prompting
255 if ($self->{pagelth} && @_ > $self->{pagelth}) {
257 for ($i = $self->{pagelth}; $i-- > 0; ) {
259 $line =~ s/\s+$//o; # why am having to do this?
262 $self->{pagedata} = [ @_ ];
263 $self->state('page');
264 $self->send($self->msg('page', scalar @_));
267 $self->send($_) if $_;
272 # this is the thing that runs the command, it is done like this for the
273 # benefit of remote command execution
279 my $user = $self->{user};
280 my $call = $self->{call};
285 my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
286 dbg('eval', "stored func cmd = $c\n");
289 return ("Syserr: Eval err $errstr on stored func $self->{func}", $@);
293 return () if length $cmdline == 0;
296 $cmdline =~ s|//|/|og;
298 # split the command line up into parts, the first part is the command
299 my ($cmd, $args) = split /\s+/, $cmdline, 2;
300 $args = "" unless $args;
306 dbg('command', "cmd: $cmd");
308 # alias it if possible
309 my $acmd = CmdAlias::get_cmd($cmd);
311 ($cmd, $args) = split /\s+/, "$acmd $args", 2;
312 $args = "" unless $args;
313 dbg('command', "aliased cmd: $cmd $args");
316 # first expand out the entry to a command
317 ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
318 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
321 dbg('command', "path: $cmd cmd: $fcmd");
323 my $package = find_cmd_name($path, $fcmd);
324 @ans = (0) if !$package ;
327 dbg('command', "package: $package");
329 unless (exists $Cache{$package}->{'sub'}) {
330 $c = eval $Cache{$package}->{'eval'};
332 return DXDebug::shortmess($@);
334 $Cache{$package}->{'sub'} = $c;
336 $c = $Cache{$package}->{'sub'};
338 @ans = &{$c}($self, $args);
343 return (DXDebug::shortmess($@));
347 dbg('command', "cmd: $cmd not found");
348 return ($self->msg('e1'));
358 # This is called from inside the main cluster processing loop and is used
359 # for despatching commands that are doing some long processing job
364 my @dxchan = DXChannel->get_all();
367 foreach $dxchan (@dxchan) {
368 next if $dxchan->sort ne 'U';
370 # send a prompt if no activity out on this channel
371 if ($t >= $dxchan->t + $main::user_interval) {
372 $dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
379 # finish up a user context
385 my $call = $self->call;
387 # I was the last node visited
388 $self->user->node($main::mycall);
391 if ($conn && -e "$main::data/logout") {
392 open(I, "$main::data/logout") or confess;
395 $self->send_now('D', @in);
399 if ($call eq $main::myalias) { # unset the channel if it is us really
400 my $node = DXNode->get($main::mycall);
404 # issue a pc17 to everybody interested
405 my $nchan = DXChannel->get($main::mycall);
406 my $pc17 = $nchan->pc17($self);
407 DXProt::broadcast_all_ak1a($pc17);
409 # send info to all logged in thingies
410 $self->tell_login('logoutu');
412 Log('DXCommand', "$call disconnected");
413 my $ref = DXCluster->get_exact($call);
418 # short cut to output a prompt
424 $self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call));
427 # broadcast a message to all users [except those mentioned after buffer]
430 my $pkg = shift; # ignored
431 my $s = shift; # the line to be rebroadcast
432 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
433 my @list = DXChannel->get_all(); # just in case we are called from some funny object
434 my ($dxchan, $except);
436 L: foreach $dxchan (@list) {
437 next if !$dxchan->sort eq 'U'; # only interested in user channels
438 foreach $except (@except) {
439 next L if $except == $dxchan; # ignore channels in the 'except' list
441 $dxchan->send($s); # send it
445 # gimme all the users
448 my @list = DXChannel->get_all();
451 foreach $ref (@list) {
452 push @out, $ref if $ref->sort eq 'U';
457 # run a script for this user
461 my $silent = shift || 0;
466 # search for the command in the cache of short->long form commands
471 my ($path, $short_cmd, $suffix) = @_;
474 # commands are lower case
475 $short_cmd = lc $short_cmd;
476 dbg('command', "command: $path $short_cmd\n");
478 # do some checking for funny characters
479 return () if $short_cmd =~ /\/$/;
481 # return immediately if we have it
482 ($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
483 if ($apath && $acmd) {
484 dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
485 return ($apath, $acmd);
489 my @parts = split '/', $short_cmd;
496 for ($i = 0; $i < @parts; $i++) {
498 opendir(D, $curdir) or confess "can't open $curdir $!";
502 foreach $l (sort @ls) {
504 if ($i < $#parts) { # we are dealing with directories
505 if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
506 dbg('command', "got dir: $curdir/$l\n");
511 } else { # we are dealing with commands
512 @lparts = split /\./, $l;
513 next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
514 if ($p eq substr($l, 0, length $p)) {
515 pop @lparts; # remove the suffix
516 $l = join '.', @lparts;
517 # chop $dirfn; # remove trailing /
518 $dirfn = "" unless $dirfn;
519 $cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
520 dbg('command', "got path: $path cmd: $dirfn$l\n");
521 return ($path, "$dirfn$l");
529 # clear the command name cache
536 # the persistant execution of things from the command directories
539 # This allows perl programs to call functions dynamically
541 # This has been nicked directly from the perlembed pages
544 #require Devel::Symdump;
546 sub valid_package_name {
548 $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
550 #second pass only for words starting with a digit
551 $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
553 #Dress it up as a real package name
554 $string =~ s/\//_/og;
558 # find a cmd reference
559 # this is really for use in user written stubs
561 # use the result as a symbolic reference:-
564 # @out = &$r($self, $line);
573 # first expand out the entry to a command
574 my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
575 ($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
577 # make sure it is loaded
578 $r = find_cmd_name($path, $fcmd);
584 # this bit of magic finds a command in the offered directory
588 my $package = valid_package_name($cmdname);
589 my $filename = "$path/$cmdname.pl";
590 my $mtime = -M $filename;
592 # return if we can't find it
594 unless (defined $mtime) {
595 $errstr = DXM::msg('e1');
599 if(defined $Cache{$package}->{mtime} &&$Cache{$package}->{mtime} <= $mtime) {
600 #we have compiled this subroutine already,
601 #it has not been updated on disk, nothing left to do
602 #print STDERR "already compiled $package->handler\n";
606 my $sub = readfilestr($filename);
608 $errstr = "Syserr: can't open '$filename' $!";
612 #wrap the code into a subroutine inside our unique package
613 my $eval = qq( sub { $sub } );
616 my @list = split /\n/, $eval;
619 dbg('eval', $_, "\n");
623 $Cache{$package} = {mtime => $mtime, 'eval' => $eval };
629 # send a talk message here
632 my ($self, $from, $to, $via, $line) = @_;
633 $line =~ s/\\5E/\^/g;
634 $self->send("$to de $from $line") if $self->{talk};
635 Log('talk', $to, $from, $main::mycall, $line);