#
# Copyright (c) 1998 - Dirk Koopman G1TLH
#
-# $Id$
+#
#
package DXUser;
-require Exporter;
-@ISA = qw(Exporter);
-
+use DXLog;
use DB_File;
+use Data::Dumper;
use Fcntl;
-use Carp;
+use IO::File;
+use DXDebug;
+use DXUtil;
+use LRU;
use strict;
-use vars qw(%u $dbm $filename %valid);
+
+use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
%u = ();
$dbm = undef;
$filename = undef;
+$lastoperinterval = 60*24*60*60;
+$lasttime = 0;
+$lrusize = 2000;
+$tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
+$v3 = 0;
# hash of valid elements and a simple prompt
%valid = (
- call => '0,Callsign',
+ 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
+ addr => '0,Full Address',
alias => '0,Real Callsign',
- name => '0,Name',
- qth => '0,Home QTH',
+ annok => '9,Accept Announces?,yesno', # accept his announces?
+ bbs => '0,Home BBS',
+ believe => '1,Believable nodes,parray',
+ buddies => '0,Buddies,parray',
+ build => '1,Build',
+ call => '0,Callsign',
+ dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
+ email => '0,E-mail Address,parray',
+ group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
+ hmsgno => '0,Highest Msgno',
+ homenode => '0,Home Node',
+ isolate => '9,Isolate network,yesno',
+ K => '9,Seen on PC92 K,yesno',
+ lang => '0,Language',
+ lastin => '0,Last Time in,cldatetime',
+ lastoper => '9,Last for/oper,cldatetime',
+ lastping => '1,Last Ping at,ptimelist',
lat => '0,Latitude,slat',
+ lockout => '9,Locked out?,yesno', # won't let them in at all
long => '0,Longitude,slong',
- qra => '0,Locator',
- email => '0,E-mail Address',
+ maxconnect => '1,Max Connections',
+ name => '0,Name',
+ node => '0,Last Node',
+ nopings => '9,Ping Obs Count',
+ nothere => '0,Not Here Text',
+ pagelth => '0,Current Pagelth',
+ passphrase => '9,Pass Phrase,yesno',
+ passwd => '9,Password,yesno',
+ pingint => '9,Node Ping interval',
priv => '9,Privilege Level',
- lastin => '0,Last Time in,cldatetime',
- passwd => '9,Password',
- addr => '0,Full Address',
- 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
+ prompt => '0,Required Prompt',
+ qra => '0,Locator',
+ qth => '0,Home QTH',
+ registered => '9,Registered?,yesno',
+ version => '1,Version',
+ wantann => '0,Req Announce,yesno',
+ wantann_talk => '0,Talklike Anns,yesno',
+ wantbeep => '0,Req Beep,yesno',
+ wantdx => '0,Req DX Spots,yesno',
+ wantdxcq => '0,Show CQ Zone,yesno',
+ wantdxitu => '0,Show ITU Zone,yesno',
+ wantecho => '0,Req Echo,yesno',
+ wantemail => '0,Req Msgs as Email,yesno',
+ wantgtk => '0,Want GTK interface,yesno',
+ wantlogininfo => '0,Login Info Req,yesno',
+ wantpc16 => '9,Want Users from node,yesno',
+ wantpc9x => '0,Want PC9X interface,yesno',
+ wantroutepc19 => '9,Route PC19,yesno',
+ wantsendpc16 => '9,Send PC16,yesno',
+ wanttalk => '0,Req Talk,yesno',
+ wantusstate => '0,Show US State,yesno',
+ wantwcy => '0,Req WCY,yesno',
+ wantwwv => '0,Req WWV,yesno',
+ wantwx => '0,Req WX,yesno',
+ width => '0,Preferred Width',
xpert => '0,Expert Status,yesno',
- bbs => '0,Home BBS',
- node => '0,Last Node',
- homenode => '0,Home Node',
- lockout => '9,Locked out?,yesno', # won't let them in at all
- dxok => '9,DX Spots?,yesno', # accept his dx spots?
- annok => '9,Announces?,yesno', # accept his announces?
- reg => '0,Registered?,yesno', # is this user registered?
- lang => '0,Language',
- hmsgno => '0,Highest Msgno',
- group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
- isolate => '9,Isolate network,yesno',
+ wantgrid => '0,Show DX Grid,yesno',
);
-no strict;
+#no strict;
sub AUTOLOAD
{
- my $self = shift;
+ no strict;
my $name = $AUTOLOAD;
return if $name =~ /::DESTROY$/;
- $name =~ s/.*:://o;
+ $name =~ s/^.*:://o;
confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
- if (@_) {
- $self->{$name} = shift;
- # $self->put();
- }
- return $self->{$name};
+ # this clever line of code creates a subroutine which takes over from autoload
+ # from OO Perl - Conway
+ *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
+ goto &$AUTOLOAD;
}
+#use strict;
+
#
# initialise the system
#
my ($pkg, $fn, $mode) = @_;
confess "need a filename in User" if !$fn;
- $fn .= ".v2";
+
+ my $ufn;
+ my $convert;
+
+ eval {
+ require Storable;
+ };
+
+# eval "use Storable qw(nfreeze thaw)";
+
+ if ($@) {
+ $ufn = "$fn.v2";
+ $v3 = $convert = 0;
+ dbg("the module Storable appears to be missing!!");
+ dbg("trying to continue in compatibility mode (this may fail)");
+ dbg("please install Storable from CPAN as soon as possible");
+ } else {
+ import Storable qw(nfreeze thaw);
+
+ $ufn = "$fn.v3";
+ $v3 = 1;
+ $convert++ if -e "$fn.v2" && !-e $ufn;
+ }
+
if ($mode) {
- $dbm = tie (%u, 'DB_File', $fn, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
+ $dbm = tie (%u, 'DB_File', $ufn, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
} else {
- $dbm = tie (%u, 'DB_File', $fn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
+ $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
}
+
+ die "Cannot open $ufn ($!)\n" unless $dbm;
+
+ $lru = LRU->newbase("DXUser", $lrusize);
- $filename = $fn;
+ # do a conversion if required
+ if ($dbm && $convert) {
+ my ($key, $val, $action, $count, $err) = ('','',0,0,0);
+
+ my %oldu;
+ dbg("Converting the User File to V3 ");
+ dbg("This will take a while, I suggest you go and have cup of strong tea");
+ my $odbm = tie (%oldu, 'DB_File', "$fn.v2", O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn.v2 ($!) [rebuild it from user_asc?]";
+ for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
+ my $ref = asc_decode($val);
+ if ($ref) {
+ $ref->put;
+ $count++;
+ } else {
+ $err++
+ }
+ }
+ undef $odbm;
+ untie %oldu;
+ dbg("Conversion completed $count records $err errors");
+ }
+ $filename = $ufn;
}
-use strict;
+sub del_file
+{
+ my ($pkg, $fn) = @_;
+
+ confess "need a filename in User" if !$fn;
+ $fn .= $v3 ? ".v3" : ".v2";
+ unlink $fn;
+}
+
+#
+# periodic processing
+#
+sub process
+{
+ if ($main::systime > $lasttime + 15) {
+ $dbm->sync;
+ $lasttime = $main::systime;
+ }
+}
#
# close the system
# new - create a new user
#
-sub new
+sub alloc
{
my $pkg = shift;
my $call = uc shift;
+ my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
+ return $self;
+}
+
+sub new
+{
+ my $pkg = shift;
+ my $call = shift;
# $call =~ s/-\d+$//o;
- confess "can't create existing call $call in User\n!" if $u{$call};
-
- my $self = bless {}, $pkg;
- $self->{call} = $call;
- $self->{'sort'} = 'U';
- $self->{dxok} = 1;
- $self->{annok} = 1;
- $self->{lang} = $main::lang;
- $u{call} = $self->encode();
+# confess "can't create existing call $call in User\n!" if $u{$call};
+
+ my $self = $pkg->alloc($call);
+ $self->put;
return $self;
}
sub get
{
- my $pkg = shift;
my $call = uc shift;
- # $call =~ s/-\d+$//o; # strip ssid
- my $s = $u{$call};
- return $s ? decode($s) : undef;
-}
-
-#
-# get all callsigns in the database
-#
-
-sub get_all_calls
-{
- return (sort keys %u);
+ my $data;
+
+ # is it in the LRU cache?
+ my $ref = $lru->get($call);
+ return $ref if $ref && ref $ref eq 'DXUser';
+
+ # search for it
+ unless ($dbm->get($call, $data)) {
+ $ref = eval{decode($data)};
+ if ($ref) {
+ if (!UNIVERSAL::isa($ref, 'DXUser')) {
+ dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
+ return undef;
+ }
+ # we have a reference and it *is* a DXUser
+ } else {
+ dbg("DXUser::get: no reference returned from decode of $call $! $@");
+ return undef;
+ }
+ $lru->put($call, $ref);
+ return $ref;
+ }
+ return undef;
}
#
sub get_current
{
- my $pkg = shift;
my $call = uc shift;
- # $call =~ s/-\d+$//o; # strip ssid
- my $dxchan = DXChannel->get($call);
- return $dxchan->user if $dxchan;
- my $s = $u{$call};
- return $s ? decode($s) : undef;
+ my $dxchan = DXChannel::get($call);
+ if ($dxchan) {
+ my $ref = $dxchan->user;
+ return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
+
+ dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
+ }
+ return get($call);
+}
+
+#
+# get all callsigns in the database
+#
+
+sub get_all_calls
+{
+ return (sort keys %u);
}
#
sub put
{
my $self = shift;
+ confess "Trying to put nothing!" unless $self && ref $self;
my $call = $self->{call};
- $u{$call} = $self->encode();
+
+ $dbm->del($call);
+ delete $self->{annok} if $self->{annok};
+ delete $self->{dxok} if $self->{dxok};
+
+ $lru->put($call, $self);
+ my $ref = $self->encode;
+ $dbm->put($call, $ref);
+}
+
+# freeze the user
+sub encode
+{
+ goto &asc_encode unless $v3;
+ my $self = shift;
+ return nfreeze($self);
+}
+
+# thaw the user
+sub decode
+{
+ goto &asc_decode unless $v3;
+ return thaw(shift);
}
#
-# create a string from a user reference
+# create a string from a user reference (in_ascii)
#
-sub encode
+sub asc_encode
{
my $self = shift;
- my $out;
- my $f;
-
- $out = "bless( { ";
- for $f (sort keys %$self) {
- my $val = $$self{$f};
- if (ref $val) { # it's an array (we think)
- $out .= "'$f'=>[ ";
- foreach (@$val) {
- my $s = $_;
- $out .= "'$s',";
- }
- $out .= " ],";
- } else {
- $val =~ s/'/\\'/og;
- $val =~ s/\@/\\@/og;
- $out .= "'$f'=>q{$val},";
+ my $strip = shift;
+ my $p;
+
+ if ($strip) {
+ my $ref = bless {}, ref $self;
+ foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
+ $ref->{$k} = $self->{$k} if exists $self->{$k};
}
+ $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
+ $p = dd($ref);
+ } else {
+ $p = dd($self);
}
- $out .= " }, 'DXUser')";
- return $out;
+ return $p;
}
#
-# create a hash from a string
+# create a hash from a string (in ascii)
#
-sub decode
+sub asc_decode
{
my $s = shift;
my $ref;
- $s = '$ref = ' . $s;
- eval $s;
- confess $@ if $@;
+ $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
+ eval '$ref = ' . $s;
+ if ($@) {
+ LogDbg('err', $@);
+ $ref = undef;
+ }
return $ref;
}
{
my $self = shift;
my $call = $self->{call};
- delete $u{$call};
+ $lru->remove($call);
+ $dbm->del($call);
}
#
$self->put();
}
+#
+# sync the database
+#
+
+sub sync
+{
+ $dbm->sync;
+}
+
#
# return a list of valid elements
#
return keys(%valid);
}
+
+#
+# export the database to an ascii file
+#
+
+sub export
+{
+ my $fn = shift;
+ my $basic_info_only = shift;
+
+ # save old ones
+ rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
+ rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
+ rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
+ rename "$fn.o", "$fn.oo" if -e "$fn.o";
+ rename "$fn", "$fn.o" if -e "$fn";
+
+ my $count = 0;
+ my $err = 0;
+ my $del = 0;
+ my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
+ if ($fh) {
+ my $key = 0;
+ my $val = undef;
+ my $action;
+ my $t = scalar localtime;
+ print $fh q{#!/usr/bin/perl
+#
+# The exported userfile for a DXSpider System
+#
+# Input file: $filename
+# Time: $t
+#
+
+package main;
+
+# search local then perl directories
+BEGIN {
+ umask 002;
+
+ # root of directory tree for this system
+ $root = "/spider";
+ $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
+
+ unshift @INC, "$root/perl"; # this IS the right way round!
+ unshift @INC, "$root/local";
+
+ # try to detect a lockfile (this isn't atomic but
+ # should do for now
+ $lockfn = "$root/local/cluster.lck"; # lock file name
+ if (-e $lockfn) {
+ open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
+ my $pid = <CLLOCK>;
+ chomp $pid;
+ die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
+ close CLLOCK;
+ }
+}
+
+package DXUser;
+
+use DXVars;
+use DXUser;
+
+if (@ARGV) {
+ $main::userfn = shift @ARGV;
+ print "user filename now $userfn\n";
+}
+
+DXUser->del_file($main::userfn);
+DXUser->init($main::userfn, 1);
+%u = ();
+my $count = 0;
+my $err = 0;
+while (<DATA>) {
+ chomp;
+ my @f = split /\t/;
+ my $ref = asc_decode($f[1]);
+ if ($ref) {
+ $ref->put();
+ $count++;
+ } else {
+ print "# Error: $f[0]\t$f[1]\n";
+ $err++
+ }
+}
+DXUser->sync; DXUser->finish;
+print "There are $count user records and $err errors\n";
+};
+ print $fh "__DATA__\n";
+
+ for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
+ if (!is_callsign($key) || $key =~ /^0/) {
+ my $eval = $val;
+ my $ekey = $key;
+ $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
+ $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
+ LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
+ ++$err;
+ next;
+ }
+ my $ref = decode($val);
+ if ($ref) {
+ my $t = $ref->{lastin} || 0;
+ if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
+ unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
+ LogDbg('DXCommand', "$ref->{call} deleted, too old");
+ $del++;
+ next;
+ }
+ }
+ # only store users that are reasonably active or have useful information
+ print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
+ ++$count;
+ } else {
+ LogDbg('DXCommand', "Export Error3: $key\t$val");
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
+ ++$err;
+ }
+ }
+ $fh->close;
+ }
+ return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
+}
+
#
# group handling
#
$self->{group} = [ 'local' ];
}
+# set up empty buddies (only happens for them's that connect direct)
+sub new_buddies
+{
+ my $self = shift;
+ $self->{buddies} = [ ];
+}
+
#
# return a prompt for a field
#
my $self = shift;
@_ ? $self->{'sort'} = shift : $self->{'sort'} ;
}
+
+# some accessors
+
+# want is default = 1
+sub _want
+{
+ my $n = shift;
+ my $self = shift;
+ my $val = shift;
+ my $s = "want$n";
+ $self->{$s} = $val if defined $val;
+ return exists $self->{$s} ? $self->{$s} : 1;
+}
+
+# wantnot is default = 0
+sub _wantnot
+{
+ my $n = shift;
+ my $self = shift;
+ my $val = shift;
+ my $s = "want$n";
+ $self->{$s} = $val if defined $val;
+ return exists $self->{$s} ? $self->{$s} : 0;
+}
+
+sub wantbeep
+{
+ return _want('beep', @_);
+}
+
+sub wantann
+{
+ return _want('ann', @_);
+}
+
+sub wantwwv
+{
+ return _want('wwv', @_);
+}
+
+sub wantwcy
+{
+ return _want('wcy', @_);
+}
+
+sub wantecho
+{
+ return _want('echo', @_);
+}
+
+sub wantwx
+{
+ return _want('wx', @_);
+}
+
+sub wantdx
+{
+ return _want('dx', @_);
+}
+
+sub wanttalk
+{
+ return _want('talk', @_);
+}
+
+sub wantgrid
+{
+ return _want('grid', @_);
+}
+
+sub wantemail
+{
+ return _want('email', @_);
+}
+
+sub wantann_talk
+{
+ return _want('ann_talk', @_);
+}
+
+sub wantpc16
+{
+ return _want('pc16', @_);
+}
+
+sub wantsendpc16
+{
+ return _want('sendpc16', @_);
+}
+
+sub wantroutepc16
+{
+ return _want('routepc16', @_);
+}
+
+sub wantusstate
+{
+ return _want('usstate', @_);
+}
+
+sub wantdxcq
+{
+ return _want('dxcq', @_);
+}
+
+sub wantdxitu
+{
+ return _want('dxitu', @_);
+}
+
+sub wantgtk
+{
+ return _want('gtk', @_);
+}
+
+sub wantpc9x
+{
+ return _want('pc9x', @_);
+}
+
+sub wantlogininfo
+{
+ my $self = shift;
+ my $val = shift;
+ $self->{wantlogininfo} = $val if defined $val;
+ return $self->{wantlogininfo};
+}
+
+sub is_node
+{
+ my $self = shift;
+ return $self->{sort} =~ /[ACRSX]/;
+}
+
+sub is_local_node
+{
+ my $self = shift;
+ return grep $_ eq 'local_node', @{$self->{group}};
+}
+
+sub is_user
+{
+ my $self = shift;
+ return $self->{sort} eq 'U';
+}
+
+sub is_bbs
+{
+ my $self = shift;
+ return $self->{sort} eq 'B';
+}
+
+sub is_spider
+{
+ my $self = shift;
+ return $self->{sort} eq 'S';
+}
+
+sub is_clx
+{
+ my $self = shift;
+ return $self->{sort} eq 'C';
+}
+
+sub is_dxnet
+{
+ my $self = shift;
+ return $self->{sort} eq 'X';
+}
+
+sub is_arcluster
+{
+ my $self = shift;
+ return $self->{sort} eq 'R';
+}
+
+sub is_ak1a
+{
+ my $self = shift;
+ return $self->{sort} eq 'A';
+}
+
+sub unset_passwd
+{
+ my $self = shift;
+ delete $self->{passwd};
+}
+
+sub unset_passphrase
+{
+ my $self = shift;
+ delete $self->{passphrase};
+}
+
+sub set_believe
+{
+ my $self = shift;
+ my $call = uc shift;
+ $self->{believe} ||= [];
+ push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
+}
+
+sub unset_believe
+{
+ my $self = shift;
+ my $call = uc shift;
+ if (exists $self->{believe}) {
+ $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
+ delete $self->{believe} unless @{$self->{believe}};
+ }
+}
+
+sub believe
+{
+ my $self = shift;
+ return exists $self->{believe} ? @{$self->{believe}} : ();
+}
+
+sub lastping
+{
+ my $self = shift;
+ my $call = shift;
+ $self->{lastping} ||= {};
+ $self->{lastping} = {} unless ref $self->{lastping};
+ my $b = $self->{lastping};
+ $b->{$call} = shift if @_;
+ return $b->{$call};
+}
1;
__END__
+
+
+
+
+
projects / spider.git / blobdiff