WIP DXUser no storable, no db_file
[spider.git] / perl / DXUser.pm
index d385382b80fe13469bc9e8f85360ed26a54b39e0..17a78f707528dac6175514c97f4bb5dd70a138c5 100644 (file)
@@ -13,14 +13,17 @@ use DB_File;
 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(%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;
@@ -28,8 +31,12 @@ $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
+$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 = (
@@ -91,6 +98,8 @@ $v3 = 0;
                  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;
@@ -121,50 +130,51 @@ sub init
        my $ufn;
        my $convert;
        
-       eval {
-               require Storable;
-       };
-
        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;
-       }
+       $json = JSON->new();
+       $filename = $ufn = localdata("$fn.json");
        
-       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?]";
+       if (-e localdata("$fn.json")) {
+               $v4 = 1;
        } 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?]";
-       }
+               eval {
+                       require Storable;
+               };
 
-       die "Cannot open $ufn ($!)\n" unless $dbm;
+               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 ($dbm && $convert) {
+       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', localdata("users.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;
-                       eval { $ref = asc_decode($val) };
+                       if ($convert == 3) {
+                               eval { $ref = storable_decode($val) };
+                       } else {
+                               eval { $ref = asc_decode($val) };
+                       }
                        unless ($@) {
                                if ($ref) {
-                                       $ref->put;
+                                       $u{$key} = $ref;
                                        $count++;
                                } else {
                                        $err++
@@ -175,7 +185,20 @@ sub init
                } 
                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;
 }
@@ -183,8 +206,14 @@ sub init
 sub del_file
 {
        # with extreme prejudice
-       unlink "$main::data/users.v3";
-       unlink "$main::local_data/users.v3";
+       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";
+       }
 }
 
 #
@@ -192,10 +221,10 @@ sub del_file
 #
 sub process
 {
-       if ($main::systime > $lasttime + 15) {
-               $dbm->sync if $dbm;
-               $lasttime = $main::systime;
-       }
+#      if ($main::systime > $lasttime + 15) {
+#              #$dbm->sync if $dbm;
+#              $lasttime = $main::systime;
+#      }
 }
 
 #
@@ -244,30 +273,31 @@ sub get
        my $data;
        
        # is it in the LRU cache?
-       my $ref = $lru->get($call);
+       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)) {
-               eval { $ref = decode($data); };
+       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;
-       }
+       #       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;
 }
 
@@ -311,19 +341,13 @@ sub put
        my $self = shift;
        confess "Trying to put nothing!" unless $self && ref $self;
        my $call = $self->{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);
@@ -332,33 +356,19 @@ sub encode
 # thaw the user
 sub decode
 {
-       goto &asc_decode unless $v3;
+       goto &json_decode if $v4;
+       goto &storable_decode if $v3;
+       goto &asc_decode;
+}
+
+# should now be obsolete for mojo branch build 238 and above
+sub storable_decode
+{
        my $ref;
        $ref = thaw(shift);
        return $ref;
 }
 
-# 
-# create a string from a user reference (in_ascii)
-#
-sub asc_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;
-}
 
 #
 # create a hash from a string (in ascii)
@@ -376,6 +386,28 @@ sub asc_decode
        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
 #
@@ -384,8 +416,9 @@ sub del
 {
        my $self = shift;
        my $call = $self->{call};
-       $lru->remove($call);
-       $dbm->del($call);
+#      $lru->remove($call);
+       #       $dbm->del($call);
+       delete $u{$call};
 }
 
 #
@@ -395,8 +428,15 @@ sub del
 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();
 }
 
 #
@@ -405,7 +445,7 @@ sub close
 
 sub sync
 {
-       $dbm->sync;
+#      $dbm->sync;
 }
 
 #
@@ -424,10 +464,9 @@ sub fields
 
 sub export
 {
-       my $name = shift || 'user_asc';
-       my $basic_info_only = shift;
+       my $name = shift;
 
-       my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name";                       # force use of local
+       my $fn = $name || "$main::local_data/user_json"; # force use of local_data
        
        # save old ones
        move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
@@ -436,6 +475,9 @@ sub export
        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;
@@ -443,109 +485,25 @@ sub export
        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_data/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;
-       }
-}
-
-use SysVar;
-use DXUser;
-
-if (@ARGV) {
-       $main::userfn = shift @ARGV;
-       print "user filename now $userfn\n";
-}
-
-package DXUser;
-
-del_file();
-init(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++;
-        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";
-};
-               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;
-                       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}) {
-                                               eval {$dbm->del($key)};
-                                               dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
-                                               LogDbg('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($basic_info_only) . "\n";
-                               ++$count;
-                       } else {
-                               LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
-                               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;
     }
        my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
@@ -871,6 +829,63 @@ sub lastping
        $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__