#
# Copyright (c) 1998 - Dirk Koopman G1TLH
#
-# $Id$
+#
#
package DXUser;
use Data::Dumper;
use Fcntl;
use IO::File;
-use DXDebug;
use DXUtil;
use LRU;
+use File::Copy;
+use JSON;
+use DXDebug;
+use Data::Structure::Util qw(unbless);
+use Time::HiRes qw(gettimeofday tv_interval);
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,0));
-$main::build += $VERSION;
-$main::branch += $BRANCH;
-
-use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
+use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3 $v4);
%u = ();
$dbm = 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
+$tooold = 86400 * 365 + 31; # this marks an old user who hasn't given enough info to be useful
$v3 = 0;
+$v4 = 0;
+my $json;
+
+our $maxconnlist = 3; # remember this many connection time (duration) [start, end] pairs
# hash of valid elements and a simple prompt
%valid = (
annok => '9,Accept Announces?,yesno', # accept his announces?
lang => '0,Language',
hmsgno => '0,Highest Msgno',
- group => '0,Chat 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,Req Beep,yesno',
wantann => '0,Req Announce,yesno',
wantlogininfo => '0,Login Info Req,yesno',
wantgrid => '0,Show DX Grid,yesno',
wantann_talk => '0,Talklike Anns,yesno',
- wantpc90 => '1,Req PC90,yesno',
- wantnp => '1,Req New Proto,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',
lastoper => '9,Last for/oper,cldatetime',
nothere => '0,Not Here Text',
registered => '9,Registered?,yesno',
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',
);
#no strict;
#
sub init
{
- my ($pkg, $fn, $mode) = @_;
+ my $mode = shift;
- confess "need a filename in User" if !$fn;
-
my $ufn;
my $convert;
- eval {
- require Storable;
- };
+ my $fn = "users";
-# eval "use Storable qw(nfreeze thaw)";
+ $json = JSON->new();
+ $filename = $ufn = localdata("$fn.json");
- 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");
+ if (-e localdata("$fn.json")) {
+ $v4 = 1;
} else {
- import Storable qw(nfreeze thaw);
+ eval {
+ require Storable;
+ };
- $ufn = "$fn.v3";
- $v3 = 1;
- $convert++ unless -e $ufn;
- }
-
- if ($mode) {
- $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', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
+ if ($@) {
+ if ( ! -e localdata("users.v3") && -e localdata("users.v2") ) {
+ $convert = 2;
+ }
+ LogDbg('',"the module Storable appears to be missing!!");
+ LogDbg('',"trying to continue in compatibility mode (this may fail)");
+ LogDbg('',"please install Storable from CPAN as soon as possible");
+ }
+ else {
+ import Storable qw(nfreeze thaw);
+ $convert = 3 if -e localdata("users.v3") && !-e $ufn;
+ }
}
- $lru = LRU->newbase("DXUser", $lrusize);
-
# do a conversion if required
if ($convert) {
my ($key, $val, $action, $count, $err) = ('','',0,0,0);
+ my $ta = [gettimeofday];
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?]";
+ LogDbg('',"Converting the User File from V$convert to $fn.json ");
+ LogDbg('',"This will take a while, I suggest you go and have cup of strong tea");
+ my $odbm = tie (%oldu, 'DB_File', localdata("users.v$convert"), O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn.v$convert ($!) [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++;
+ my $ref;
+ if ($convert == 3) {
+ eval { $ref = storable_decode($val) };
} else {
- $err++
+ eval { $ref = asc_decode($val) };
+ }
+ unless ($@) {
+ if ($ref) {
+ $u{$key} = $ref;
+ $count++;
+ } else {
+ $err++
+ }
+ } else {
+ Log('err', "DXUser: error decoding $@");
}
}
undef $odbm;
untie %oldu;
- dbg("Conversion completed $count records $err errors");
+ my $t = _diffms($ta);
+ LogDbg('',"Conversion from users.v$convert to users.json completed $count records $err errors $t mS");
+
+ # now write it away for future use
+ $ta = [gettimeofday];
+ $err = 0;
+ $count = writeoutjson();
+ $t = _diffms($ta);
+ LogDbg('',"New Userfile users.json write completed $count records $err errors $t mS");
+ LogDbg('',"Now restarting..");
+ $main::ending = 10;
+ } else {
+ # otherwise (i.e normally) slurp it in
+ readinjson();
}
$filename = $ufn;
}
sub del_file
{
- my ($pkg, $fn) = @_;
-
- confess "need a filename in User" if !$fn;
- $fn .= $v3 ? ".v3" : ".v2";
- unlink $fn;
+ # with extreme prejudice
+ if ($v3) {
+ unlink "$main::data/users.v3";
+ unlink "$main::local_data/users.v3";
+ }
+ if ($v4) {
+ unlink "$main::data/users.v4";
+ unlink "$main::local_data/users.v4";
+ }
}
#
#
sub process
{
- if ($main::systime > $lasttime + 15) {
- $dbm->sync;
- $lasttime = $main::systime;
- }
+# if ($main::systime > $lasttime + 15) {
+# #$dbm->sync if $dbm;
+# $lasttime = $main::systime;
+# }
}
#
# 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);
- return $ref if $ref;
+ my $ref = $u{$call} if exists $u{$call};
+# my $ref = $lru->get($call);
+ return $ref if $ref && ref $ref eq 'DXUser';
# search for it
- unless ($dbm->get($call, $data)) {
- $ref = decode($data);
- $lru->put($call, $ref);
- return $ref;
- }
+ # unless ($dbm->get($call, $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 $rref = Route::get($call);
- return $rref->user if $rref && exists $rref->{user};
- return $pkg->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);
}
#
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};
- $lru->put($call, $self);
- my $ref = $self->encode;
- $dbm->put($call, $ref);
+ $self->{lastin} = $main::systime;
}
# freeze the user
sub encode
{
+ goto &json_encode if $v4;
goto &asc_encode unless $v3;
my $self = shift;
return nfreeze($self);
# thaw the user
sub decode
{
- goto &asc_decode unless $v3;
- return thaw(shift);
+ goto &json_decode if $v4;
+ goto &storable_decode if $v3;
+ goto &asc_decode;
}
-#
-# create a string from a user reference (in_ascii)
-#
-sub asc_encode
+# should now be obsolete for mojo branch build 238 and above
+sub storable_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;
+ my $ref;
+ $ref = thaw(shift);
+ return $ref;
}
+
#
# create a hash from a string (in ascii)
#
{
my $s = shift;
my $ref;
+ $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
eval '$ref = ' . $s;
if ($@) {
- dbg($@);
- Log('err', $@);
+ LogDbg('err', "DXUser::asc_decode: on '$s' $@");
$ref = undef;
}
return $ref;
}
+sub json_decode
+{
+ my $s = shift;
+ my $ref;
+ eval { $ref = $json->decode($s) };
+ if ($ref && !$@) {
+ return bless $ref, 'DXUser';
+ } else {
+ LogDbg('err', "DXUser::json_decode: on '$s' $@");
+ }
+ return undef;
+}
+
+sub json_encode
+{
+ my $ref = shift;
+ unbless($ref);
+ my $s = $json->encode($ref);
+ bless $ref, 'DXUser';
+ return $s;
+}
+
#
# 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);
+# $lru->remove($call);
+ # $dbm->del($call);
+ delete $u{$call};
}
#
sub close
{
my $self = shift;
- $self->{lastin} = time;
- $self->put();
+ my $startt = shift;
+ my $ip = shift;
+ $self->{lastin} = $main::systime;
+ # add a record to the connect list
+ 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 sync
{
- $dbm->sync;
+# $dbm->sync;
}
#
sub export
{
- my $fn = shift;
+ my $name = shift;
+
+ my $fn = $name || "$main::local_data/user_json"; # force use of local_data
# 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";
-
+ 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 $json = JSON->new;
+ $json->canonical(1);
+
my $count = 0;
my $err = 0;
my $del = 0;
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/) {
- Log('DXCommand', "Export Error1: $key\t$val");
- eval {$dbm->del($key)};
- dbg(carp("Export Error1: $key\t$val\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 $@;
- Log('DXCommand', "$ref->{call} deleted, too old");
- $del++;
- next;
- }
+ foreach my $k (sort keys %u) {
+ my $r = $u{$k};
+ if ($r->{sort} eq 'U' && !$r->{priv} && $main::systime > $r->{lastin}+$tooold ) {
+ unless ($r->{lat} || $r->{long} || $r->{qra} || $r->{qth} || $r->{name}) {
+ LogDbg('err', "DXUser::export deleting $k - too old, last in " . cldatetime($r->lastin) . " " . difft([$r->lastin, $main::systime]));
+ delete $u{$k};
+ ++$del;
+ next;
}
- # only store users that are reasonably active or have useful information
- print $fh "$key\t" . $ref->asc_encode . "\n";
- ++$count;
- } else {
- Log('DXCommand', "Export Error3: $key\t$val");
- eval {$dbm->del($key)};
- dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
- ++$err;
}
- }
+ eval {$val = json_encode($r);};
+ if ($@) {
+ LogDbg('err', "DXUser::export error encoding call: $k $@");
+ ++$err;
+ next;
+ }
+ $fh->print("$k\t$val\n");
+ ++$count;
+ }
$fh->close;
- }
- return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
+ }
+ my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('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
#
return _want('pc16', @_);
}
-sub wantpc90
-{
- return _wantnot('pc90', @_);
-}
-
sub wantsendpc16
{
return _want('sendpc16', @_);
return _want('dxitu', @_);
}
-sub wantnp
+sub wantgtk
+{
+ return _want('gtk', @_);
+}
+
+sub wantpc9x
{
- return _wantnot('np', @_);
+ return _want('pc9x', @_);
}
sub wantlogininfo
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
$b->{$call} = shift if @_;
return $b->{$call};
}
+
+sub readinjson
+{
+ my $fn = shift || $filename;
+
+ my $ta = [gettimeofday];
+ my $count = 0;
+ my $s;
+ my $err = 0;
+
+ unless (-r $fn) {
+ dbg("DXUser $fn not found - probably about to convert");
+ return;
+ }
+
+ open DATA, "$fn" or die "$fn read error $!";
+ while (<DATA>) {
+ chomp;
+ my @f = split /\t/;
+ my $ref;
+ eval { $ref = json_decode($f[1]); };
+ if ($ref) {
+ $u{$f[0]} = $ref;
+ $count++;
+ } else {
+ LogDbg('DXCommand', "# readinjson Error: '$f[0]\t$f[1]' $@");
+ $err++
+ }
+ }
+ close DATA;
+ $s = _diffms($ta);
+ dbg("DXUser::readinjson $count records $s mS");
+}
+
+sub writeoutjson()
+{
+ my $fn = shift || $filename;
+
+ link $fn, "$fn.o";
+ unlink $fn;
+ open DATA, ">$fn" or die "$fn write error $!";
+ my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
+ my $count = 0;
+ if ($fh) {
+ my $key = 0;
+ my $val = undef;
+ foreach my $k (keys %u) { # this is to make it as quick as possible (no sort)
+ my $r = $u{$k};
+ $val = json_encode($r);
+ $fh->print("$k\t$val\n");
+ ++$count;
+ }
+ $fh->close;
+ }
+ close DATA;
+ return $count;
+}
1;
__END__