#
# Copyright (c) 1998 - Dirk Koopman G1TLH
#
-# $Id$
+#
#
package DXUser;
use Fcntl;
use IO::File;
use DXDebug;
+use DXUtil;
+use LRU;
+use File::Copy;
+use Data::Structure::Util qw(unbless);
+use Time::HiRes qw(gettimeofday tv_interval);
+use IO::File;
+use DXJSON;
use strict;
-use vars qw($VERSION $BRANCH);
-$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
-$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
-$main::build += $VERSION;
-$main::branch += $BRANCH;
-
-use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime);
+use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $veryold $v3);
%u = ();
$dbm = undef;
$filename = undef;
-$lastoperinterval = 30*24*60*60;
+$lastoperinterval = 60*24*60*60;
$lasttime = 0;
+$lrusize = 5000;
+$tooold = 86400 * 365 * 2; # this marks an old user who hasn't given enough info to be useful
+$veryold = $tooold * 6; # Ancient default 12 years
+$v3 = 0;
+our $maxconnlist = 3; # remember this many connection time (duration) [start, end] pairs
+
+my $json;
# hash of valid elements and a simple prompt
%valid = (
email => '0,E-mail Address,parray',
priv => '9,Privilege Level',
lastin => '0,Last Time in,cldatetime',
+ lastseen => '0,Last Seen,cldatetime',
passwd => '9,Password,yesno',
+ passphrase => '9,Pass Phrase,yesno',
addr => '0,Full Address',
'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
xpert => '0,Expert Status,yesno',
annok => '9,Accept Announces?,yesno', # accept his announces?
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
+ group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
+ buddies => '0,Buddies,parray',
isolate => '9,Isolate network,yesno',
- wantbeep => '0,Rec Beep,yesno',
- wantann => '0,Rec Announce,yesno',
- wantwwv => '0,Rec WWV,yesno',
- wantwcy => '0,Rec WCY,yesno',
- wantecho => '0,Rec Echo,yesno',
- wanttalk => '0,Rec Talk,yesno',
- wantwx => '0,Rec WX,yesno',
- wantdx => '0,Rec DX Spots,yesno',
- wantemail => '0,Rec Msgs as Email,yesno',
+ wantbeep => '0,Req Beep,yesno',
+ wantann => '0,Req Announce,yesno',
+ wantwwv => '0,Req WWV,yesno',
+ wantwcy => '0,Req WCY,yesno',
+ wantecho => '0,Req Echo,yesno',
+ wanttalk => '0,Req Talk,yesno',
+ wantwx => '0,Req WX,yesno',
+ wantdx => '0,Req DX Spots,yesno',
+ wantemail => '0,Req Msgs as Email,yesno',
pagelth => '0,Current Pagelth',
pingint => '9,Node Ping interval',
nopings => '9,Ping Obs Count',
- wantlogininfo => '9,Login info req,yesno',
- wantgrid => '0,DX Grid Info,yesno',
+ wantlogininfo => '0,Login Info Req,yesno',
+ wantgrid => '0,Show DX Grid,yesno',
wantann_talk => '0,Talklike Anns,yesno',
+ wantpc16 => '9,Want Users from node,yesno',
+ wantsendpc16 => '9,Send PC16,yesno',
+ wantroutepc19 => '9,Route PC19,yesno',
+ wantusstate => '0,Show US State,yesno',
+ wantdxcq => '0,Show CQ Zone,yesno',
+ wantdxitu => '0,Show ITU Zone,yesno',
+ wantgtk => '0,Want GTK interface,yesno',
+ wantpc9x => '0,Want PC9X interface,yesno',
+ wantrbn => '0,Want RBN spots,yesno',
+ wantft => '0,Want RBN FT4/8,yesno',
+ wantcw => '0,Want RBN CW,yesno',
+ wantrtty => '0,Want RBN RTTY,yesno',
+ wantpsk => '0,Want RBN PSK,yesno',
+ wantbeacon => '0,Want RBN Beacon,yesno',
lastoper => '9,Last for/oper,cldatetime',
nothere => '0,Not Here Text',
registered => '9,Registered?,yesno',
+ prompt => '0,Required Prompt',
+ version => '1,Version',
+ build => '1,Build',
+ believe => '1,Believable nodes,parray',
+ lastping => '1,Last Ping at,ptimelist',
+ maxconnect => '1,Max Connections',
+ startt => '0,Start Time,cldatetime',
+ connlist => '1,Connections,parraydifft',
+ width => '0,Preferred Width',
+ rbnseeme => '0,RBN See Me',
);
-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};
# 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}} ;
- if (@_) {
- $self->{$name} = shift;
- }
- return $self->{$name};
+ *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
+ goto &$AUTOLOAD;
}
-use strict;
+#use strict;
#
# initialise the system
#
sub init
{
- my ($pkg, $fn, $mode) = @_;
+ my $mode = shift;
- confess "need a filename in User" if !$fn;
- $fn .= ".v2";
- if ($mode) {
- $dbm = tie (%u, 'DB_File', $fn, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
- } else {
- $dbm = tie (%u, 'DB_File', $fn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
+ $json = DXJSON->new->canonical(1);
+ my $fn = "users";
+ $filename = localdata("$fn.v3j");
+ unless (-e $filename || $mode == 2 ) {
+ if (-e localdata("$fn.v3") || -e localdata("$fn.v2")) {
+ LogDbg('DXUser', "New User File version $filename does not exist, running conversion from users.v3 or v2, please wait");
+ system('/spider/perl/convert-users-v3-to-v3j.pl');
+ init(1);
+ export();
+ return;
+ }
}
-
- $filename = $fn;
+ if (-e $filename || $mode) {
+ $lru = LRU->newbase("DXUser", $lrusize);
+ if ($mode) {
+ $dbm = tie (%u, 'DB_File', $filename, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_json?]";
+ } else {
+ $dbm = tie (%u, 'DB_File', $filename, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_json?]";
+ }
+ }
+ die "Cannot open $filename ($!)\n" unless $dbm || $mode == 2;
+ return;
}
+# delete files with extreme prejudice
sub del_file
{
- my ($pkg, $fn) = @_;
-
- confess "need a filename in User" if !$fn;
- $fn .= ".v2";
- unlink $fn;
+ # with extreme prejudice
+ unlink "$main::data/users.v3j";
+ unlink "$main::local_data/users.v3j";
}
#
sub process
{
if ($main::systime > $lasttime + 15) {
- $dbm->sync;
+ $dbm->sync if $dbm;
$lasttime = $main::systime;
}
}
sub finish
{
+ $dbm->sync;
undef $dbm;
untie %u;
}
# 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';
+ my $self = $pkg->alloc($call);
$self->put;
return $self;
}
sub get
{
- my $pkg = shift;
my $call = uc shift;
my $data;
+
+ # is it in the LRU cache?
+ my $ref = $lru->get($call);
+ if ($ref && ref $ref eq 'DXUser') {
+ return $ref;
+ }
+
+ # search for it
unless ($dbm->get($call, $data)) {
- return decode($data);
+ eval { $ref = 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 {
+ if ($@) {
+ LogDbg('err', "DXUser::get decode error on $call '$@'");
+ } 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;
- my $dxchan = DXChannel->get($call);
- return $dxchan->user if $dxchan;
- my $data;
- unless ($dbm->get($call, $data)) {
- return decode($data);
+ 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 undef;
+ return get($call);
}
#
my $self = shift;
confess "Trying to put nothing!" unless $self && ref $self;
my $call = $self->{call};
- # delete all instances of this
-# for ($dbm->get_dup($call)) {
-# $dbm->del_dup($call, $_);
-# }
+
$dbm->del($call);
- delete $self->{annok} if $self->{annok};
- delete $self->{dxok} if $self->{dxok};
- $dbm->put($call, $self->encode);
+ delete $self->{annok};
+ delete $self->{dxok};
+ $self->{lastseen} = $main::systime;
+ $lru->put($call, $self);
+ my $ref = $self->encode;
+ $dbm->put($call, $ref);
}
-#
-# create a string from a user reference
-#
-sub encode
+
+# thaw the user
+sub decode
{
- my $self = shift;
- my $dd = new Data::Dumper([$self]);
- $dd->Indent(0);
- $dd->Terse(1);
- $dd->Quotekeys($] < 5.005 ? 1 : 0);
- return $dd->Dumpxs;
+ return $json->decode(shift, __PACKAGE__);
}
-#
-# create a hash from a string
-#
-sub decode
+# freeze the user
+sub encode
{
- my $s = shift;
- my $ref;
- eval '$ref = ' . $s;
- if ($@) {
- dbg($@);
- Log('err', $@);
- $ref = undef;
- }
- return $ref;
+ return $json->encode(shift);
}
+
#
# del - delete a user
#
{
my $self = shift;
my $call = $self->{call};
- # delete all instances of this
-# for ($dbm->get_dup($call)) {
-# $dbm->del_dup($call, $_);
-# }
+ $lru->remove($call);
$dbm->del($call);
}
sub close
{
my $self = shift;
- $self->{lastin} = time;
+ my $startt = shift;
+ my $ip = shift;
+ # add a record to the connect list
+ $self->{lastin} = $main::systime;
+ my $ref = [$startt || $self->{startt}, $main::systime];
+ push @$ref, $ip if $ip;
+ push @{$self->{connlist}}, $ref;
+ shift @{$self->{connlist}} if @{$self->{connlist}} > $maxconnlist;
$self->put();
}
sub export
{
- my $fn = shift;
+ my $name = shift || 'user_json';
+ my $basic_info_only = shift;
+
+ my $fn = $name ne 'user_json' ? $name : "$main::local_data/$name"; # force use of local
# 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";
+ copy $fn, "$fn.keep" unless -e "$fn.keep";
+ copy "$fn.ooooo", "$fn.backstop" unless -e "$fn,backstop";
+
+ move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
+ move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
+ move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
+ move "$fn.o", "$fn.oo" if -e "$fn.o";
+ move "$fn", "$fn.o" if -e "$fn";
+
+ my $ta = [gettimeofday];
my $count = 0;
+ my $err = 0;
+ my $del = 0;
+ my $spurious = 0;
+ my $unlocked = 0;
+ my $old = 0;
+ my $ancient = 0;
+ my $nodes = 0;
+ my $renamed = 0;
+
my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
if ($fh) {
- my $ref = 0;
my $key = 0;
+ my $val = undef;
my $action;
my $t = scalar localtime;
print $fh q{#!/usr/bin/perl
# try to detect a lockfile (this isn't atomic but
# should do for now
- $lockfn = "$root/perl/cluster.lck"; # lock file name
+ $lockfn = "$root/local_data/cluster.lck"; # lock file name
if (-e $lockfn) {
open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
my $pid = <CLLOCK>;
}
}
-package DXUser;
-
-use DXVars;
+use SysVar;
+use DXUtil;
use DXUser;
+use JSON;
+use Time::HiRes qw(gettimeofday tv_interval);
+package DXUser;
-if (@ARGV) {
- $main::userfn = shift @ARGV;
- print "user filename now $userfn\n";
-}
-
-DXUser->del_file($main::userfn);
-DXUser->init($main::userfn, 1);
+our $json = JSON->new->canonical(1);
-%u = (
- };
+my $ta = [gettimeofday];
+our $filename = "$main::local_data/users.v3j";
+my $exists = -e $filename ? "OVERWRITING" : "CREATING";
+print "perl user_json $exists $filename\n";
- for ($action = R_FIRST; !$dbm->seq($key, $ref, $action); $action = R_NEXT) {
- print $fh "'$key' => q{$ref},\n";
+del_file();
+init(2);
+%u = ();
+my $count = 0;
+my $err = 0;
+while (<DATA>) {
+ chomp;
+ my @f = split /\t/;
+ my $ref = decode($f[1]);
+ if ($ref) {
+ $ref->put();
+ $count++;
+ } else {
+ print "# Error: $f[0]\t$f[1]\n";
+ $err++
+ }
+}
+DXUser::sync(); DXUser::finish();
+my $diff = _diffms($ta);
+print "There are $count user records and $err errors in $diff mS\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: invalid call '$key' => '$val'");
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error1: delete $key => '$val' $@")) if $@;
+ ++$err;
+ next;
+ }
+ my $ref;
+ eval {$ref = decode($val); };
+ if ($ref) {
+ my $t = $ref->{lastseen} if exists $ref->{lastseen};
+ $t ||= $ref->{lastin} if exists $ref->{lastin};
+ $t ||= $ref->{lastoper} if exists $ref->{lastoper};
+ $t //= 0;
+
+ if ($ref->is_user) {
+ if ($ref->{priv} == 0 && $main::systime > $t + $tooold) {
+ unless (($ref->{lat} && $ref->{long}) || $ref->{qth} || $ref->{name} || $ref->{qra}) {
+ LogDbg('DXCommand', sprintf("$ref->{call} deleted, empty and too Old at %s", difft($t, ' ')));
+ ++$del;
+ ++$old;
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error2: delete '$key' => '$val' $@")) if $@;
+ next;
+ }
+ }
+ if ($main::systime > $t + $veryold) {
+ LogDbg('DXCommand', sprintf("$ref->{call} deleted, POSITIVELY ANCIENT at %s", difft($t, ' ')));
+ ++$del;
+ ++$ancient;
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error2: delete '$key' => '$val' $@")) if $@;
+ next;
+ }
+ if ($ref->{lockout} == 1 && $ref->{priv} == 1) {
+ LogDbg('DXCommand', "$ref->{call} depriv'd and unlocked");
+ $ref->{lockout} = $ref->{priv} = 0;
+ $ref->put;
+ ++$unlocked;
+ }
+ if ($ref->is_node && $main::systime > $t + $veryold) {
+ LogDbg('DXCommand', sprintf("NODE $ref->{call} deleted (%s) old", difft($t, ' ')));
+ ++$del;
+ ++$nodes;
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error2: delete '$key' => '$val' $@")) if $@;
+ next;
+ }
+
+ my $normcall = normalise_call($key);
+ if ($normcall ne $key) {
+ # if the normalised call does not exist, create it from the duff call.
+ my $nref = DXUser::get_current($normcall);
+ unless ($nref) {
+ $ref->{call} = $normcall;
+ $ref->put;
+ LogDbg('DXCommand', "DXProt: spurious call $key normalises to $normcall renaming $key -> $normcall");
+ ++$renamed;
+ }
+ LogDbg('DXCommand', "DXProt: spurious call $key (should be $normcall), removing");
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error1: delete $key => '$val' $@")) if $@;
+ ++$spurious;
+ ++$del;
+ next;
+ }
+ }
+ } else {
+ LogDbg('DXCommand', "Export Error3: '$key'\t" . carp($val) ."\n$@");
+ eval {$dbm->del($key)};
+ dbg(carp("Export Error3: delete '$key' => '$val' $@")) if $@;
+ ++$err;
+ next;
+ }
+
+ # only store users that are reasonably active or have useful information
+ print $fh "$key\t" . encode($ref) . "\n";
++$count;
- }
- print $fh ");\n#\nprint \"there were $count records\\n\";\n#\n";
- print $fh "DXUser->sync; DXUser->finish;\n#\n";
- $fh->close;
- }
- return $count;
+ }
+ }
+ $fh->close;
+
+ my $diff = _diffms($ta);
+ my $s = qq{Exported users to $fn - $count Users, $del Deleted ($old empty \& too old, $ancient ancient, $nodes nodes, $spurious spurious), $renamed renamed, $unlocked Unlocked, $err Errors in $diff mS ('sh/log Export' for details)};
+ LogDbg('command', $s);
+ return $s;
}
#
$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
#
}
# some accessors
+
+# want is default = 1
sub _want
{
my $n = shift;
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 wantgrid
{
- return _want('grid', @_);
+ return _wantnot('grid', @_);
}
sub wantemail
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 _wantnot('dxcq', @_);
+}
+
+sub wantdxitu
+{
+ return _wantnot('dxitu', @_);
+}
+
+sub wantgtk
+{
+ return _want('gtk', @_);
+}
+
+sub wantpc9x
+{
+ return _want('pc9x', @_);
+}
+
sub wantlogininfo
{
my $self = shift;
sub is_node
{
my $self = shift;
- return $self->{sort} =~ /[ACRSX]/;
+ 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';
+ return $self->{sort} =~ /^[UW]$/;
+}
+
+sub is_web
+{
+ my $self = shift;
+ return $self->{sort} eq 'W';
}
sub is_bbs
return $self->{sort} eq 'A';
}
+sub is_rbn
+{
+ my $self = shift;
+ return $self->{sort} eq 'N'
+}
+
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};
+}
+
+sub registered
+{
+ my $self = shift;
+ if (exists $self->{registered}) {
+ return $self->{registered} || 0;
+ }
+ return ''; # to stop undef warnings
+}
+
1;
__END__
projects / spider.git / blobdiff