fix grepdbg so it does what grepdbg -h says
[spider.git] / perl / DXUser.pm
index 13c5ba8101f55a66213d17be199e69901800710d..911f35bc99c7c778a0fba7529d262c07df0bf96c 100644 (file)
@@ -3,7 +3,7 @@
 #
 # Copyright (c) 1998 - Dirk Koopman G1TLH
 #
-# $Id$
+#
 #
 
 package DXUser;
@@ -19,12 +19,6 @@ use LRU;
 
 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);
 
 %u = ();
@@ -38,60 +32,76 @@ $v3 = 0;
 
 # hash of valid elements and a simple prompt
 %valid = (
-                 call => '0,Callsign',
-                 alias => '0,Real Callsign',
-                 name => '0,Name',
-                 qth => '0,Home QTH',
-                 lat => '0,Latitude,slat',
-                 long => '0,Longitude,slong',
-                 qra => '0,Locator',
-                 email => '0,E-mail Address,parray',
-                 priv => '9,Privilege Level',
-                 lastin => '0,Last Time in,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',
+                 addr => '0,Full Address',
+                 alias => '0,Real Callsign',
+                 annok => '9,Accept Announces?,yesno', # accept his announces?
                  bbs => '0,Home BBS',
-                 node => '0,Last Node',
-                 homenode => '0,Home Node',
-                 lockout => '9,Locked out?,yesno',     # won't let them in at all
+                 believe => '1,Believable nodes,parray',
+                 buddies => '0,Buddies,parray',
+                 build => '1,Build',
+                 call => '0,Callsign',
+                 connlist => '1,Connections,parraydifft',
                  dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
-                 annok => '9,Accept Announces?,yesno', # accept his announces?
-                 lang => '0,Language',
+                 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',
-                 group => '0,Chat Group,parray',       # used to create a group of users/nodes for some purpose or other
+                 homenode => '0,Home Node',
                  isolate => '9,Isolate network,yesno',
-                 wantbeep => '0,Req Beep,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',
+                 lastseen => '0,Last Seen,cldatetime',
+                 lat => '0,Latitude,slat',
+                 lockout => '9,Locked out?,yesno',     # won't let them in at all
+                 long => '0,Longitude,slong',
+                 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',
+                 prompt => '0,Required Prompt',
+                 qra => '0,Locator',
+                 qth => '0,Home QTH',
+                 rbnseeme => '0,RBN See Me',
+                 registered => '9,Registered?,yesno',
+                 startt => '0,Start Time,cldatetime',
+                 version => '1,Version',
                  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',
+                 wantann_talk => '0,Talklike Anns,yesno',
+                 wantbeacon => '0,Want RBN Beacon,yesno',
+                 wantbeep => '0,Req Beep,yesno',
+                 wantcw => '0,Want RBN CW,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',
-                 pagelth => '0,Current Pagelth',
-                 pingint => '9,Node Ping interval',
-                 nopings => '9,Ping Obs Count',
+                 wantft => '0,Want RBN FT4/8,yesno',
+                 wantgtk => '0,Want GTK interface,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',
+                 wantpc9x => '0,Want PC9X interface,yesno',
+                 wantpsk => '0,Want RBN PSK,yesno',
+                 wantrbn => '0,Want RBN spots,yesno',
                  wantroutepc19 => '9,Route PC19,yesno',
+                 wantrtty => '0,Want RBN RTTY,yesno',
+                 wantsendpc16 => '9,Send PC16,yesno',
+                 wanttalk => '0,Req Talk,yesno',
                  wantusstate => '0,Show US State,yesno',
-                 wantdxcq => '0,Show CQ Zone,yesno',
-                 wantdxitu => '0,Show ITU Zone,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',
+                 wantwcy => '0,Req WCY,yesno',
+                 wantwwv => '0,Req WWV,yesno',
+                 wantwx => '0,Req WX,yesno',
+                 width => '0,Preferred Width',
+                 xpert => '0,Expert Status,yesno',
+          wantgrid => '0,Show DX Grid,yesno',
                 );
 
 #no strict;
@@ -141,7 +151,7 @@ sub init
 
                $ufn = "$fn.v3";
                $v3 = 1;
-               $convert++ unless -e $ufn;
+               $convert++ if -e "$fn.v2" && !-e $ufn;
        }
        
        if ($mode) {
@@ -150,10 +160,12 @@ sub init
                $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);
        
        # do a conversion if required
-       if ($convert) {
+       if ($dbm && $convert) {
                my ($key, $val, $action, $count, $err) = ('','',0,0,0);
                
                my %oldu;
@@ -238,17 +250,26 @@ sub new
 
 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;
+       return $ref if $ref && ref $ref eq 'DXUser';
        
        # search for it
        unless ($dbm->get($call, $data)) {
-               $ref = decode($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;
        }
@@ -265,14 +286,16 @@ sub get
 
 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);
 }
 
 #
@@ -293,13 +316,11 @@ sub put
        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);
@@ -326,11 +347,20 @@ sub decode
 sub asc_encode
 {
        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 $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;
 }
 
 #
@@ -340,6 +370,7 @@ 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', $@);
@@ -356,10 +387,6 @@ sub del
 {
        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);
 }
@@ -394,134 +421,6 @@ sub fields
 }
 
 
-#
-# export the database to an ascii file
-#
-
-sub export
-{
-       my $fn = 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 . "\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
 #
@@ -583,6 +482,13 @@ sub new_group
        $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
 #
@@ -709,6 +615,16 @@ sub wantdxitu
        return _want('dxitu', @_);
 }
 
+sub wantgtk
+{
+       return _want('gtk', @_);
+}
+
+sub wantpc9x
+{
+       return _want('pc9x', @_);
+}
+
 sub wantlogininfo
 {
        my $self = shift;
@@ -723,6 +639,12 @@ sub is_node
        return $self->{sort} =~ /[ACRSX]/;
 }
 
+sub is_local_node
+{
+       my $self = shift;
+       return grep $_ eq 'local_node', @{$self->{group}};
+}
+
 sub is_user
 {
        my $self = shift;
@@ -811,6 +733,147 @@ sub lastping
        $b->{$call} = shift if @_;
        return $b->{$call};     
 }
+
+#
+# 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  export_preamble();
+
+        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)";
+}
+
+sub export_preamble
+{
+
+return 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";
+exit $err ? -1 : 1;
+
+__DATA__
+};
+       
+}
+
+
 1;
 __END__