2 # DX cluster user routines
4 # Copyright (c) 1998 - Dirk Koopman G1TLH
21 use Data::Structure::Util qw(unbless);
26 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3 $v4);
31 $lastoperinterval = 60*24*60*60;
34 $tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
39 our $maxconnlist = 3; # remember this many connection time (duration) [start, end] pairs
41 # hash of valid elements and a simple prompt
44 alias => '0,Real Callsign',
47 lat => '0,Latitude,slat',
48 long => '0,Longitude,slong',
50 email => '0,E-mail Address,parray',
51 priv => '9,Privilege Level',
52 lastin => '0,Last Time in,cldatetime',
53 passwd => '9,Password,yesno',
54 passphrase => '9,Pass Phrase,yesno',
55 addr => '0,Full Address',
56 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
57 xpert => '0,Expert Status,yesno',
59 node => '0,Last Node',
60 homenode => '0,Home Node',
61 lockout => '9,Locked out?,yesno', # won't let them in at all
62 dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
63 annok => '9,Accept Announces?,yesno', # accept his announces?
65 hmsgno => '0,Highest Msgno',
66 group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
67 buddies => '0,Buddies,parray',
68 isolate => '9,Isolate network,yesno',
69 wantbeep => '0,Req Beep,yesno',
70 wantann => '0,Req Announce,yesno',
71 wantwwv => '0,Req WWV,yesno',
72 wantwcy => '0,Req WCY,yesno',
73 wantecho => '0,Req Echo,yesno',
74 wanttalk => '0,Req Talk,yesno',
75 wantwx => '0,Req WX,yesno',
76 wantdx => '0,Req DX Spots,yesno',
77 wantemail => '0,Req Msgs as Email,yesno',
78 pagelth => '0,Current Pagelth',
79 pingint => '9,Node Ping interval',
80 nopings => '9,Ping Obs Count',
81 wantlogininfo => '0,Login Info Req,yesno',
82 wantgrid => '0,Show DX Grid,yesno',
83 wantann_talk => '0,Talklike Anns,yesno',
84 wantpc16 => '9,Want Users from node,yesno',
85 wantsendpc16 => '9,Send PC16,yesno',
86 wantroutepc19 => '9,Route PC19,yesno',
87 wantusstate => '0,Show US State,yesno',
88 wantdxcq => '0,Show CQ Zone,yesno',
89 wantdxitu => '0,Show ITU Zone,yesno',
90 wantgtk => '0,Want GTK interface,yesno',
91 wantpc9x => '0,Want PC9X interface,yesno',
92 lastoper => '9,Last for/oper,cldatetime',
93 nothere => '0,Not Here Text',
94 registered => '9,Registered?,yesno',
95 prompt => '0,Required Prompt',
96 version => '1,Version',
98 believe => '1,Believable nodes,parray',
99 lastping => '1,Last Ping at,ptimelist',
100 maxconnect => '1,Max Connections',
101 startt => '0,Start Time,cldatetime',
102 connlist => '1,Connections,parraydifft',
109 my $name = $AUTOLOAD;
111 return if $name =~ /::DESTROY$/;
114 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
115 # this clever line of code creates a subroutine which takes over from autoload
116 # from OO Perl - Conway
117 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
124 # initialise the system
135 if ($mode == 4 || -e localdata("users.v4")) {
136 $ufn = localdata("users.v4");
145 $ufn = localdata("users.v2");
147 dbg("the module Storable appears to be missing!!");
148 dbg("trying to continue in compatibility mode (this may fail)");
149 dbg("please install Storable from CPAN as soon as possible");
152 import Storable qw(nfreeze thaw);
153 $ufn = localdata("users.v3");
155 $convert++ if -e localdata("users.v2") && !-e $ufn;
160 $dbm = tie (%u, 'DB_File', $ufn, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $ufn ($!) [rebuild it from user_asc?]";
162 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $ufn ($!) [rebuild it from user_asc?]";
165 die "Cannot open $ufn ($!)\n" unless $dbm;
167 $lru = LRU->newbase("DXUser", $lrusize);
169 # do a conversion if required
170 if ($dbm && $convert) {
171 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
174 dbg("Converting the User File to V$convert ");
175 dbg("This will take a while, I suggest you go and have cup of strong tea");
176 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?]";
177 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
179 eval { $ref = asc_decode($val) };
188 Log('err', "DXUser: error decoding $@");
193 dbg("Conversion completed $count records $err errors");
200 # with extreme prejudice
202 unlink "$main::data/users.v3";
203 unlink "$main::local_data/users.v3";
206 unlink "$main::data/users.v4";
207 unlink "$main::local_data/users.v4";
212 # periodic processing
216 if ($main::systime > $lasttime + 15) {
218 $lasttime = $main::systime;
233 # new - create a new user
240 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
248 # $call =~ s/-\d+$//o;
250 # confess "can't create existing call $call in User\n!" if $u{$call};
252 my $self = $pkg->alloc($call);
258 # get - get an existing user - this seems to return a different reference everytime it is
267 # is it in the LRU cache?
268 my $ref = $lru->get($call);
269 return $ref if $ref && ref $ref eq 'DXUser';
272 unless ($dbm->get($call, $data)) {
273 eval { $ref = decode($data); };
276 if (!UNIVERSAL::isa($ref, 'DXUser')) {
277 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
280 # we have a reference and it *is* a DXUser
283 LogDbg('err', "DXUser::get decode error on $call '$@'");
285 dbg("DXUser::get: no reference returned from decode of $call $!");
289 $lru->put($call, $ref);
296 # get an existing either from the channel (if there is one) or from the database
298 # It is important to note that if you have done a get (for the channel say) and you
299 # want access or modify that you must use this call (and you must NOT use get's all
300 # over the place willy nilly!)
307 my $dxchan = DXChannel::get($call);
309 my $ref = $dxchan->user;
310 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
312 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
318 # get all callsigns in the database
323 return (sort keys %u);
333 confess "Trying to put nothing!" unless $self && ref $self;
334 my $call = $self->{call};
337 delete $self->{annok} if $self->{annok};
338 delete $self->{dxok} if $self->{dxok};
340 $lru->put($call, $self);
341 my $ref = $self->encode;
342 $dbm->put($call, $ref);
348 goto &json_encode if $v4;
349 goto &asc_encode unless $v3;
351 return nfreeze($self);
357 goto &json_decode if $v4;
358 goto &asc_decode unless $v3;
365 # create a string from a user reference (in_ascii)
374 my $ref = bless {}, ref $self;
375 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
376 $ref->{$k} = $self->{$k} if exists $self->{$k};
378 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
387 # create a hash from a string (in ascii)
393 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
396 LogDbg('err', "DXUser::asc_decode: on '$s' $@");
406 eval { $ref = $json->decode($s) };
408 return bless $ref, 'DXUser';
410 LogDbg('err', "DXUser::json_decode: on '$s' $@");
419 my $s = $json->encode($ref);
420 bless $ref, 'DXUser';
425 # del - delete a user
431 my $call = $self->{call};
437 # close - close down a user
445 $self->{lastin} = $main::systime;
446 # add a record to the connect list
447 my $ref = [$startt || $self->{startt}, $main::systime];
448 push @$ref, $ip if $ip;
449 push @{$self->{connlist}}, $ref;
450 shift @{$self->{connlist}} if @{$self->{connlist}} > $maxconnlist;
464 # return a list of valid elements
474 # export the database to an ascii file
479 my $name = shift || 'user_asc';
480 my $basic_info_only = shift;
482 my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name"; # force use of local
485 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
486 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
487 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
488 move "$fn.o", "$fn.oo" if -e "$fn.o";
489 move "$fn", "$fn.o" if -e "$fn";
494 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
499 my $t = scalar localtime;
500 print $fh q{#!/usr/bin/perl
502 # The exported userfile for a DXSpider System
504 # Input file: $filename
510 # search local then perl directories
514 # root of directory tree for this system
516 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
518 unshift @INC, "$root/perl"; # this IS the right way round!
519 unshift @INC, "$root/local";
521 # try to detect a lockfile (this isn't atomic but
523 $lockfn = "$root/local_data/cluster.lck"; # lock file name
525 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
528 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
537 $main::userfn = shift @ARGV;
538 print "user filename now $userfn\n";
551 my $ref = asc_decode($f[1]);
555 DXUser::sync() unless $count % 10000;
557 print "# Error: $f[0]\t$f[1]\n";
561 DXUser::sync(); DXUser::finish();
562 print "There are $count user records and $err errors\n";
564 print $fh "__DATA__\n";
566 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
567 if (!is_callsign($key) || $key =~ /^0/) {
570 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
571 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
572 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
573 eval {$dbm->del($key)};
574 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
579 eval {$ref = decode($val); };
581 my $t = $ref->{lastin} || 0;
582 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
583 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
584 eval {$dbm->del($key)};
585 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
586 LogDbg('DXCommand', "$ref->{call} deleted, too old");
591 # only store users that are reasonably active or have useful information
592 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
595 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
596 eval {$dbm->del($key)};
597 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
603 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
604 LogDbg('command', $s);
610 my $name = shift || 'user_json';
611 my $basic_info_only = shift;
613 my $fn = $name ne 'user_json' ? $name : "$main::local_data/$name"; # force use of local
616 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
617 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
618 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
619 move "$fn.o", "$fn.oo" if -e "$fn.o";
620 move "$fn", "$fn.o" if -e "$fn";
622 my $json = JSON->new;
624 $json->allow_blessed(1);
629 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
634 my $t = scalar localtime;
635 print $fh q{#!/usr/bin/perl
637 # The exported userfile for a DXSpider System
639 # Input file: $filename
645 # search local then perl directories
649 # root of directory tree for this system
651 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
653 unshift @INC, "$root/perl"; # this IS the right way round!
654 unshift @INC, "$root/local";
656 # try to detect a lockfile (this isn't atomic but
658 $lockfn = "$root/local_data/cluster.lck"; # lock file name
660 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
663 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
672 $main::userfn = shift @ARGV;
673 print "user filename now $userfn\n";
679 my $json = JSON->new;
690 eval { $ref = $json->decode($f[1]); };
692 $ref = bless $ref, 'DXUser';
695 DXUser::sync() unless $count % 10000;
697 print "# Error: $f[0]\t$f[1]\n";
701 DXUser::sync(); DXUser::finish();
702 print "There are $count user records and $err errors\n";
704 print $fh "__DATA__\n";
706 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
707 if (!is_callsign($key) || $key =~ /^0/) {
710 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
711 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
712 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
713 eval {$dbm->del($key)};
714 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
719 eval {$ref = decode($val); };
721 my $t = $ref->{lastin} || 0;
722 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
723 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
724 eval {$dbm->del($key)};
725 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
726 LogDbg('DXCommand', "$ref->{call} deleted, too old");
731 # only store users that are reasonably active or have useful information
733 print $fh "$key\t" . $json->encode($ref) . "\n";
736 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
737 eval {$dbm->del($key)};
738 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
744 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
745 LogDbg('command', $s);
753 # add one or more groups
757 my $ref = $self->{group} || [ 'local' ];
758 $self->{group} = $ref if !$self->{group};
759 push @$ref, @_ if @_;
762 # remove one or more groups
766 my $ref = $self->{group} || [ 'local' ];
769 $self->{group} = $ref if !$self->{group};
771 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
774 # does this thing contain all the groups listed?
778 my $ref = $self->{group};
781 return 0 if !$ref || @_ == 0;
782 return 1 if @$ref == 0 && @_ == 0;
783 for ($n = 0; $n < @_; ) {
786 $n++ if grep $_ eq $a, @_;
792 # simplified group test just for one group
797 my $ref = $self->{group};
800 return grep $_ eq $s, $ref;
803 # set up a default group (only happens for them's that connect direct)
807 $self->{group} = [ 'local' ];
810 # set up empty buddies (only happens for them's that connect direct)
814 $self->{buddies} = [ ];
818 # return a prompt for a field
823 my ($self, $ele) = @_;
827 # some variable accessors
831 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
836 # want is default = 1
843 $self->{$s} = $val if defined $val;
844 return exists $self->{$s} ? $self->{$s} : 1;
847 # wantnot is default = 0
854 $self->{$s} = $val if defined $val;
855 return exists $self->{$s} ? $self->{$s} : 0;
860 return _want('beep', @_);
865 return _want('ann', @_);
870 return _want('wwv', @_);
875 return _want('wcy', @_);
880 return _want('echo', @_);
885 return _want('wx', @_);
890 return _want('dx', @_);
895 return _want('talk', @_);
900 return _want('grid', @_);
905 return _want('email', @_);
910 return _want('ann_talk', @_);
915 return _want('pc16', @_);
920 return _want('sendpc16', @_);
925 return _want('routepc16', @_);
930 return _want('usstate', @_);
935 return _want('dxcq', @_);
940 return _want('dxitu', @_);
945 return _want('gtk', @_);
950 return _want('pc9x', @_);
957 $self->{wantlogininfo} = $val if defined $val;
958 return $self->{wantlogininfo};
964 return $self->{sort} =~ /^[ACRSX]$/;
970 return grep $_ eq 'local_node', @{$self->{group}};
976 return $self->{sort} =~ /^[UW]$/;
982 return $self->{sort} eq 'W';
988 return $self->{sort} eq 'B';
994 return $self->{sort} eq 'S';
1000 return $self->{sort} eq 'C';
1006 return $self->{sort} eq 'X';
1012 return $self->{sort} eq 'R';
1018 return $self->{sort} eq 'A';
1024 delete $self->{passwd};
1027 sub unset_passphrase
1030 delete $self->{passphrase};
1036 my $call = uc shift;
1037 $self->{believe} ||= [];
1038 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
1044 my $call = uc shift;
1045 if (exists $self->{believe}) {
1046 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
1047 delete $self->{believe} unless @{$self->{believe}};
1054 return exists $self->{believe} ? @{$self->{believe}} : ();
1061 $self->{lastping} ||= {};
1062 $self->{lastping} = {} unless ref $self->{lastping};
1063 my $b = $self->{lastping};
1064 $b->{$call} = shift if @_;