spider/perl/DXCommandmode.pm
djk 324bd80ed4 1. Do some range checking for spots and WWV in the future (got a WWV for Oct
2034 whhich caused a bit of confusion!)
2. Make WWV spots broadcast them to the users! (as opposed to merely storing
them)(thank you G0RDI).
3. Allow users to do show/announce (thank you JE1SGH).
4. Delay broadcasts to users if they are not in a 'prompt' state (means you can
add messages and see what you are doing on a busy system)
5. Made set/unset dx,ann,wx,talk,wwv do what is expected
6. added set/sys_location and set/set_qra to set the cluster lat/long and qra
7. New messages will now be announced on logon (if there are any)
1999-01-07 00:57:39 +00:00

534 lines
12 KiB
Perl

#!/usr/bin/perl
#
# This module impliments the user facing command mode for a dx cluster
#
# Copyright (c) 1998 Dirk Koopman G1TLH
#
# $Id$
#
package DXCommandmode;
@ISA = qw(DXChannel);
use DXUtil;
use DXChannel;
use DXUser;
use DXVars;
use DXDebug;
use DXM;
use DXLog;
use DXLogPrint;
use DXBearing;
use CmdAlias;
use FileHandle;
use Carp;
use strict;
use vars qw(%Cache %cmd_cache $errstr %aliases);
%Cache = (); # cache of dynamically loaded routine's mod times
%cmd_cache = (); # cache of short names
$errstr = (); # error string from eval
%aliases = (); # aliases for (parts of) commands
#
# obtain a new connection this is derived from dxchannel
#
sub new
{
my $self = DXChannel::alloc(@_);
$self->{'sort'} = 'U'; # in absence of how to find out what sort of an object I am
return $self;
}
# this is how a a connection starts, you get a hello message and the motd with
# possibly some other messages asking you to set various things up if you are
# new (or nearly new and slacking) user.
sub start
{
my ($self, $line, $sort) = @_;
my $user = $self->{user};
my $call = $self->{call};
my $name = $user->{name};
$self->{name} = $name ? $name : $call;
$self->send($self->msg('l2',$self->{name}));
$self->send_file($main::motd) if (-e $main::motd);
$self->state('prompt'); # a bit of room for further expansion, passwords etc
$self->{priv} = $user->priv;
$self->{lang} = $user->lang;
$self->{pagelth} = 20;
$self->{priv} = 0 if $line =~ /^(ax|te)/; # set the connection priv to 0 - can be upgraded later
$self->{consort} = $line; # save the connection type
# set some necessary flags on the user if they are connecting
$self->{beep} = $self->{wwv} = $self->{wx} = $self->{talk} = $self->{ann} = $self->{here} = $self->{dx} = 1;
# $self->prompt() if $self->{state} =~ /^prompt/o;
# add yourself to the database
my $node = DXNode->get($main::mycall) or die "$main::mycall not allocated in DXNode database";
my $cuser = DXNodeuser->new($self, $node, $call, 0, 1);
$node->dxchan($self) if $call eq $main::myalias; # send all output for mycall to myalias
# issue a pc16 to everybody interested
my $nchan = DXChannel->get($main::mycall);
my @pc16 = DXProt::pc16($nchan, $cuser);
DXProt::broadcast_ak1a(@pc16);
Log('DXCommand', "$call connected");
# send prompts and things
my $info = DXCluster::cluster();
$self->send("Cluster:$info");
$self->send($self->msg('namee1')) if !$user->name;
$self->send($self->msg('qthe1')) if !$user->qth;
$self->send($self->msg('qll')) if !$user->qra || (!$user->lat && !$user->long);
$self->send($self->msg('hnodee1')) if !$user->qth;
$self->send($self->msg('msgnew')) if DXMsg::for_me($call);
$self->send($self->msg('pr', $call));
}
#
# This is the normal command prompt driver
#
sub normal
{
my $self = shift;
my $cmdline = shift;
my @ans;
# remove leading and trailing spaces
$cmdline =~ s/^\s*(.*)\s*$/$1/;
if ($self->{state} eq 'page') {
my $i = $self->{pagelth};
my $ref = $self->{pagedata};
my $tot = @$ref;
# abort if we get a line starting in with a
if ($cmdline =~ /^a/io) {
undef $ref;
$i = 0;
}
# send a tranche of data
while ($i-- > 0 && @$ref) {
my $line = shift @$ref;
$line =~ s/\s+$//o; # why am having to do this?
$self->send($line);
}
# reset state if none or else chuck out an intermediate prompt
if ($ref && @$ref) {
$tot -= $self->{pagelth};
$self->send($self->msg('page', $tot));
} else {
$self->state('prompt');
}
} else {
@ans = run_cmd($self, $cmdline); # if length $cmdline;
if ($self->{pagelth} && @ans > $self->{pagelth}) {
my $i;
for ($i = $self->{pagelth}; $i-- > 0; ) {
my $line = shift @ans;
$line =~ s/\s+$//o; # why am having to do this?
$self->send($line);
}
$self->{pagedata} = \@ans;
$self->state('page');
$self->send($self->msg('page', scalar @ans));
} else {
for (@ans) {
s/\s+$//o; # why ?????????
$self->send($_);
}
}
}
# send a prompt only if we are in a prompt state
$self->prompt() if $self->{state} =~ /^prompt/o;
}
#
# this is the thing that runs the command, it is done like this for the
# benefit of remote command execution
#
sub run_cmd
{
my $self = shift;
my $user = $self->{user};
my $call = $self->{call};
my $cmdline = shift;
my @ans;
if ($self->{func}) {
my $c = qq{ \@ans = $self->{func}(\$self, \$cmdline) };
dbg('eval', "stored func cmd = $c\n");
eval $c;
if ($@) {
return (1, "Syserr: Eval err $errstr on stored func $self->{func}");
}
} else {
return () if length $cmdline == 0;
# strip out //
$cmdline =~ s|//|/|og;
# split the command line up into parts, the first part is the command
my ($cmd, $args) = $cmdline =~ /^([\S\/]+)\s*(.*)/o;
if ($cmd) {
my ($path, $fcmd);
dbg('command', "cmd: $cmd");
# alias it if possible
my $acmd = CmdAlias::get_cmd($cmd);
if ($acmd) {
($cmd, $args) = "$acmd $args" =~ /^([\w\/]+)\s*(.*)/o;
dbg('command', "aliased cmd: $cmd $args");
}
# first expand out the entry to a command
($path, $fcmd) = search($main::localcmd, $cmd, "pl");
($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
if ($path && $cmd) {
dbg('command', "path: $cmd cmd: $fcmd");
my $package = find_cmd_name($path, $fcmd);
@ans = (0) if !$package ;
if ($package) {
dbg('command', "package: $package");
my $c = qq{ \@ans = $package(\$self, \$args) };
dbg('eval', "cluster cmd = $c\n");
eval $c;
if ($@) {
@ans = (0, "Syserr: Eval err cached $package\n$@");
}
}
} else {
dbg('command', "cmd: $cmd not found");
@ans = (0);
}
}
}
if ($ans[0]) {
shift @ans;
} else {
shift @ans;
if (@ans > 0) {
unshift @ans, $self->msg('e2');
} else {
@ans = $self->msg('e1');
}
}
return (@ans);
}
#
# This is called from inside the main cluster processing loop and is used
# for despatching commands that are doing some long processing job
#
sub process
{
my $t = time;
my @dxchan = DXChannel->get_all();
my $dxchan;
foreach $dxchan (@dxchan) {
next if $dxchan->sort ne 'U';
# send a prompt if no activity out on this channel
if ($t >= $dxchan->t + $main::user_interval) {
$dxchan->prompt() if $dxchan->{state} =~ /^prompt/o;
$dxchan->t($t);
}
}
}
#
# finish up a user context
#
sub finish
{
my $self = shift;
my $call = $self->call;
# log out text
if (-e "$main::data/logout") {
open(I, "$main::data/logout") or confess;
my @in = <I>;
close(I);
$self->send_now('D', @in);
sleep(1);
}
if ($call eq $main::myalias) { # unset the channel if it is us really
my $node = DXNode->get($main::mycall);
$node->{dxchan} = 0;
}
my $ref = DXCluster->get_exact($call);
# issue a pc17 to everybody interested
my $nchan = DXChannel->get($main::mycall);
my $pc17 = $nchan->pc17($self);
DXProt::broadcast_ak1a($pc17);
Log('DXCommand', "$call disconnected");
$ref->del() if $ref;
}
#
# short cut to output a prompt
#
sub prompt
{
my $self = shift;
$self->send($self->msg($self->here ? 'pr' : 'pr2', $self->call));
}
# broadcast a message to all users [except those mentioned after buffer]
sub broadcast
{
my $pkg = shift; # ignored
my $s = shift; # the line to be rebroadcast
my @except = @_; # to all channels EXCEPT these (dxchannel refs)
my @list = DXChannel->get_all(); # just in case we are called from some funny object
my ($dxchan, $except);
L: foreach $dxchan (@list) {
next if !$dxchan->sort eq 'U'; # only interested in user channels
foreach $except (@except) {
next L if $except == $dxchan; # ignore channels in the 'except' list
}
$dxchan->send($s); # send it
}
}
# gimme all the users
sub get_all
{
my @list = DXChannel->get_all();
my $ref;
my @out;
foreach $ref (@list) {
push @out, $ref if $ref->sort eq 'U';
}
return @out;
}
#
# search for the command in the cache of short->long form commands
#
sub search
{
my ($path, $short_cmd, $suffix) = @_;
my ($apath, $acmd);
# commands are lower case
$short_cmd = lc $short_cmd;
dbg('command', "command: $path $short_cmd\n");
# do some checking for funny characters
return () if $short_cmd =~ /\/$/;
# return immediately if we have it
($apath, $acmd) = split ',', $cmd_cache{$short_cmd} if $cmd_cache{$short_cmd};
if ($apath && $acmd) {
dbg('command', "cached $short_cmd = ($apath, $acmd)\n");
return ($apath, $acmd);
}
# if not guess
my @parts = split '/', $short_cmd;
my $dirfn;
my $curdir = $path;
my $p;
my $i;
my @lparts;
for ($i = 0; $i < @parts; $i++) {
my $p = $parts[$i];
opendir(D, $curdir) or confess "can't open $curdir $!";
my @ls = readdir D;
closedir D;
my $l;
foreach $l (sort @ls) {
next if $l =~ /^\./;
if ($i < $#parts) { # we are dealing with directories
if ((-d "$curdir/$l") && $p eq substr($l, 0, length $p)) {
dbg('command', "got dir: $curdir/$l\n");
$dirfn .= "$l/";
$curdir .= "/$l";
last;
}
} else { # we are dealing with commands
@lparts = split /\./, $l;
next if $lparts[$#lparts] ne $suffix; # only look for .$suffix files
if ($p eq substr($l, 0, length $p)) {
pop @lparts; # remove the suffix
$l = join '.', @lparts;
# chop $dirfn; # remove trailing /
$dirfn = "" unless $dirfn;
$cmd_cache{"$short_cmd"} = join(',', ($path, "$dirfn$l")); # cache it
dbg('command', "got path: $path cmd: $dirfn$l\n");
return ($path, "$dirfn$l");
}
}
}
}
return ();
}
# clear the command name cache
sub clear_cmd_cache
{
%cmd_cache = ();
}
#
# the persistant execution of things from the command directories
#
#
# This allows perl programs to call functions dynamically
#
# This has been nicked directly from the perlembed pages
#
#require Devel::Symdump;
sub valid_package_name {
my($string) = @_;
$string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
#second pass only for words starting with a digit
$string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
#Dress it up as a real package name
$string =~ s/\//_/og;
return "Emb_" . $string;
}
#borrowed from Safe.pm
sub delete_package {
my $pkg = shift;
my ($stem, $leaf);
no strict 'refs';
$pkg = "DXCommandmode::$pkg\::"; # expand to full symbol table name
($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
if ($stem && $leaf) {
my $stem_symtab = *{$stem}{HASH};
delete $stem_symtab->{$leaf};
}
}
# find a cmd reference
# this is really for use in user written stubs
#
# use the result as a symbolic reference:-
#
# no strict 'refs';
# @out = &$r($self, $line);
#
sub find_cmd_ref
{
my $cmd = shift;
my $r;
if ($cmd) {
# first expand out the entry to a command
my ($path, $fcmd) = search($main::localcmd, $cmd, "pl");
($path, $fcmd) = search($main::cmd, $cmd, "pl") if !$path || !$fcmd;
# make sure it is loaded
$r = find_cmd_name($path, $fcmd);
}
return $r;
}
#
# this bit of magic finds a command in the offered directory
sub find_cmd_name {
my $path = shift;
my $cmdname = shift;
my $package = valid_package_name($cmdname);
my $filename = "$path/$cmdname.pl";
my $mtime = -M $filename;
# return if we can't find it
$errstr = undef;
unless (defined $mtime) {
$errstr = DXM::msg('e1');
return undef;
}
if(defined $Cache{$package}{mtime} && $Cache{$package}{mtime } <= $mtime) {
#we have compiled this subroutine already,
#it has not been updated on disk, nothing left to do
#print STDERR "already compiled $package->handler\n";
;
} else {
delete_package($package) if defined $Cache{$package}{mtime};
my $fh = new FileHandle;
if (!open $fh, $filename) {
$errstr = "Syserr: can't open '$filename' $!";
return undef;
};
local $/ = undef;
my $sub = <$fh>;
close $fh;
#wrap the code into a subroutine inside our unique package
my $eval = qq{ sub $package { $sub } };
if (isdbg('eval')) {
my @list = split /\n/, $eval;
my $line;
for (@list) {
dbg('eval', $_, "\n");
}
}
{
#hide our variables within this block
my($filename,$mtime,$package,$sub);
eval $eval;
}
if ($@) {
print "\$\@ = $@";
$errstr = $@;
delete_package($package);
} else {
#cache it unless we're cleaning out each time
$Cache{$package}{'mtime'} = $mtime;
}
}
#print Devel::Symdump->rnew($package)->as_string, $/;
$package = "DXCommandmode::$package" if $package;
$package = undef if $errstr;
return $package;
}
1;
__END__