EXTENSIVE user file and route cleanup, see Changes
[spider.git] / perl / DXUser.pm
index 5d212b078e220388de8b4bbef8e23b9a10e9d240..a4283c33fb984e81450dbfe750f2ce4d7797e7eb 100644 (file)
@@ -17,21 +17,28 @@ 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(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
+use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $veryold $v3);
 
 %u = ();
 $dbm = undef;
 $filename = undef;
 $lastoperinterval = 60*24*60*60;
 $lasttime = 0;
-$lrusize = 10000;
-$tooold = 86400 * 365;         # this marks an old user who hasn't given enough info to be useful
+$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 = (
                  call => '0,Callsign',
@@ -89,7 +96,7 @@ our $maxconnlist = 3;                 # remember this many connection time (duration) [start,
                  wantcw => '0,Want RBN CW,yesno',
                  wantrtty => '0,Want RBN RTTY,yesno',
                  wantpsk => '0,Want RBN PSK,yesno',
-                 wantbeacon => '0,Want (RBN) Beacon,yesno',
+                 wantbeacon => '0,Want RBN Beacon,yesno',
                  lastoper => '9,Last for/oper,cldatetime',
                  nothere => '0,Not Here Text',
                  registered => '9,Registered?,yesno',
@@ -101,6 +108,8 @@ our $maxconnlist = 3;                       # remember this many connection time (duration) [start,
                  maxconnect => '1,Max Connections',
                  startt => '0,Start Time,cldatetime',
                  connlist => '1,Connections,parraydifft',
+                 width => '0,Preferred Width',
+                 rbnseeme => '0,RBN See Me',
                 );
 
 #no strict;
@@ -128,73 +137,36 @@ sub init
 {
        my $mode = shift;
   
-       my $ufn;
-       my $convert;
-       
-       eval {
-               require Storable;
-       };
-
+       $json = DXJSON->new->canonical(1);
        my $fn = "users";
-       
-       if ($@) {
-               $ufn = localdata("users.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 = localdata("users.v3");
-               $v3 = 1;
-               $convert++ if -e localdata("users.v2") && !-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?]";
+       $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;
+               }
        }
-
-       die "Cannot open $ufn ($!)\n" unless $dbm;
-
-       $lru = LRU->newbase("DXUser", $lrusize);
-       
-       # 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', localdata("users.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;
-                       eval { $ref = asc_decode($val) };
-                       unless ($@) {
-                               if ($ref) {
-                                       $ref->put;
-                                       $count++;
-                               } else {
-                                       $err++
-                               }
-                       } else {
-                               Log('err', "DXUser: error decoding $@");
-                       }
-               } 
-               undef $odbm;
-               untie %oldu;
-               dbg("Conversion completed $count records $err errors");
+       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?]";
+               }
        }
-       $filename = $ufn;
+       die "Cannot open $filename ($!)\n" unless $dbm || $mode == 2;
+       return;
 }
 
+# delete files with extreme prejudice
 sub del_file
 {
        # with extreme prejudice
-       unlink "$main::data/users.v3";
-       unlink "$main::local_data/users.v3";
+       unlink "$main::data/users.v3j";
+       unlink "$main::local_data/users.v3j";
 }
 
 #
@@ -240,7 +212,6 @@ sub new
 #      confess "can't create existing call $call in User\n!" if $u{$call};
 
        my $self = $pkg->alloc($call);
-       $self->{lastseen} = $main::systime;
        $self->put;
        return $self;
 }
@@ -258,7 +229,6 @@ sub get
        # is it in the LRU cache?
        my $ref = $lru->get($call);
        if ($ref && ref $ref eq 'DXUser') {
-               $ref->{lastseen} = $main::systime;
                return $ref;
        }
        
@@ -280,7 +250,6 @@ sub get
                        }
                        return undef;
                }
-               $ref->{lastseen} = $main::systime;
                $lru->put($call, $ref);
                return $ref;
        }
@@ -329,68 +298,27 @@ sub put
        my $call = $self->{call};
 
        $dbm->del($call);
-       delete $self->{annok} if $self->{annok};
-       delete $self->{dxok} if $self->{dxok};
-
+       delete $self->{annok};
+       delete $self->{dxok};
+       $self->{lastseen} = $main::systime;
        $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;
-       my $ref;
-       $ref = thaw(shift);
-       return $ref;
+       return $json->decode(shift, __PACKAGE__);
 }
 
-# 
-# create a string from a user reference (in_ascii)
-#
-sub asc_encode
+# freeze the user
+sub encode
 {
-       my $self = shift;
-       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);
-       }
-       return $p;
+       return $json->encode(shift);
 }
 
-#
-# create a hash from a string (in ascii)
-#
-sub asc_decode
-{
-       my $s = shift;
-       my $ref;
-       $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
-       eval '$ref = ' . $s;
-       if ($@) {
-               LogDbg('err', "DXUser::asc_decode: on '$s' $@");
-               $ref = undef;
-       }
-       return $ref;
-}
 
 #
 # del - delete a user
@@ -413,8 +341,8 @@ sub close
        my $self = shift;
        my $startt = shift;
        my $ip = shift;
-       $self->{lastseen} = $self->{lastin} = $main::systime;
        # 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;
@@ -447,21 +375,33 @@ sub fields
 
 sub export
 {
-       my $name = shift || 'user_asc';
+       my $name = shift || 'user_json';
        my $basic_info_only = shift;
 
-       my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name";                       # force use of local
+       my $fn = $name ne 'user_json' ? $name : "$main::local_data/$name";                       # force use of local
        
        # save old ones
+       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 $key = 0;
@@ -502,35 +442,39 @@ BEGIN {
 }
 
 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";
-}
+our $json = JSON->new->canonical(1);
 
-package DXUser;
+my $ta = [gettimeofday];
+our $filename = "$main::local_data/users.v3j";
+my $exists = -e $filename ? "OVERWRITING" : "CREATING"; 
+print "perl user_json $exists $filename\n";
 
 del_file();
-init(1);
+init(2);
 %u = ();
 my $count = 0;
 my $err = 0;
 while (<DATA>) {
        chomp;
        my @f = split /\t/;
-       my $ref = asc_decode($f[1]);
+       my $ref = decode($f[1]);
        if ($ref) {
                $ref->put();
                $count++;
-        DXUser::sync() unless $count % 10000;
        } else {
                print "# Error: $f[0]\t$f[1]\n";
                $err++
        }
 }
 DXUser::sync(); DXUser::finish();
-print "There are $count user records and $err errors\n";
+my $diff = _diffms($ta);
+print "There are $count user records and $err errors in $diff mS\n";
 };
                print $fh "__DATA__\n";
 
@@ -539,39 +483,90 @@ print "There are $count user records and $err errors\n";
                                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");
+                               $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: $ekey\t$eval\n$@")) if $@;
+                           dbg(carp("Export Error1: delete $key => '$val' $@")) if $@;
                                ++$err;
                                next;
                        }
                        my $ref;
                        eval {$ref = decode($val); };
                        if ($ref) {
-                               my $t = $ref->{lastin} || 0;
-                               if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
-                                       unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
+                               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: $key\t$val\n$@")) if $@;
-                                               LogDbg('DXCommand', "$ref->{call} deleted, too old");
-                                               $del++;
+                                               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;
                                        }
                                }
-                               # 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" . carp($val) ."\n$@");
+                               LogDbg('DXCommand', "Export Error3: '$key'\t" . carp($val) ."\n$@");
                                eval {$dbm->del($key)};
-                               dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
+                               dbg(carp("Export Error3: delete '$key' => '$val' $@")) if $@;
                                ++$err;
+                               next;
                        }
-               } 
-        $fh->close;
-    }
-       my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
+                       
+                       # only store users that are reasonably active or have useful information
+                       print $fh "$key\t" . encode($ref) . "\n";
+                       ++$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;
 }
@@ -727,7 +722,7 @@ sub wanttalk
 
 sub wantgrid
 {
-       return _want('grid', @_);
+       return _wantnot('grid', @_);
 }
 
 sub wantemail
@@ -762,12 +757,12 @@ sub wantusstate
 
 sub wantdxcq
 {
-       return _want('dxcq', @_);
+       return _wantnot('dxcq', @_);
 }
 
 sub wantdxitu
 {
-       return _want('dxitu', @_);
+       return _wantnot('dxitu', @_);
 }
 
 sub wantgtk
@@ -900,6 +895,16 @@ sub 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__