2 # DX cluster user routines
4 # Copyright (c) 1998 - Dirk Koopman G1TLH
24 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3 $v4);
29 $lastoperinterval = 60*24*60*60;
32 $tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
37 our $maxconnlist = 3; # remember this many connection time (duration) [start, end] pairs
39 # hash of valid elements and a simple prompt
42 alias => '0,Real Callsign',
45 lat => '0,Latitude,slat',
46 long => '0,Longitude,slong',
48 email => '0,E-mail Address,parray',
49 priv => '9,Privilege Level',
50 lastin => '0,Last Time in,cldatetime',
51 passwd => '9,Password,yesno',
52 passphrase => '9,Pass Phrase,yesno',
53 addr => '0,Full Address',
54 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
55 xpert => '0,Expert Status,yesno',
57 node => '0,Last Node',
58 homenode => '0,Home Node',
59 lockout => '9,Locked out?,yesno', # won't let them in at all
60 dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
61 annok => '9,Accept Announces?,yesno', # accept his announces?
63 hmsgno => '0,Highest Msgno',
64 group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
65 buddies => '0,Buddies,parray',
66 isolate => '9,Isolate network,yesno',
67 wantbeep => '0,Req Beep,yesno',
68 wantann => '0,Req Announce,yesno',
69 wantwwv => '0,Req WWV,yesno',
70 wantwcy => '0,Req WCY,yesno',
71 wantecho => '0,Req Echo,yesno',
72 wanttalk => '0,Req Talk,yesno',
73 wantwx => '0,Req WX,yesno',
74 wantdx => '0,Req DX Spots,yesno',
75 wantemail => '0,Req Msgs as Email,yesno',
76 pagelth => '0,Current Pagelth',
77 pingint => '9,Node Ping interval',
78 nopings => '9,Ping Obs Count',
79 wantlogininfo => '0,Login Info Req,yesno',
80 wantgrid => '0,Show DX Grid,yesno',
81 wantann_talk => '0,Talklike Anns,yesno',
82 wantpc16 => '9,Want Users from node,yesno',
83 wantsendpc16 => '9,Send PC16,yesno',
84 wantroutepc19 => '9,Route PC19,yesno',
85 wantusstate => '0,Show US State,yesno',
86 wantdxcq => '0,Show CQ Zone,yesno',
87 wantdxitu => '0,Show ITU Zone,yesno',
88 wantgtk => '0,Want GTK interface,yesno',
89 wantpc9x => '0,Want PC9X interface,yesno',
90 lastoper => '9,Last for/oper,cldatetime',
91 nothere => '0,Not Here Text',
92 registered => '9,Registered?,yesno',
93 prompt => '0,Required Prompt',
94 version => '1,Version',
96 believe => '1,Believable nodes,parray',
97 lastping => '1,Last Ping at,ptimelist',
98 maxconnect => '1,Max Connections',
99 startt => '0,Start Time,cldatetime',
100 connlist => '1,Connections,parraydifft',
107 my $name = $AUTOLOAD;
109 return if $name =~ /::DESTROY$/;
112 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
113 # this clever line of code creates a subroutine which takes over from autoload
114 # from OO Perl - Conway
115 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
122 # initialise the system
138 $ufn = localdata("users.v2");
140 dbg("the module Storable appears to be missing!!");
141 dbg("trying to continue in compatibility mode (this may fail)");
142 dbg("please install Storable from CPAN as soon as possible");
144 import Storable qw(nfreeze thaw);
146 $ufn = localdata("users.v3");
148 $convert++ if -e localdata("users.v2") && !-e $ufn;
152 $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?]";
154 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
157 die "Cannot open $ufn ($!)\n" unless $dbm;
159 $lru = LRU->newbase("DXUser", $lrusize);
161 # do a conversion if required
162 if ($dbm && $convert) {
163 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
166 dbg("Converting the User File to V$convert ");
167 dbg("This will take a while, I suggest you go and have cup of strong tea");
168 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?]";
169 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
171 eval { $ref = asc_decode($val) };
180 Log('err', "DXUser: error decoding $@");
185 dbg("Conversion completed $count records $err errors");
192 # with extreme prejudice
193 unlink "$main::data/users.v3";
194 unlink "$main::local_data/users.v3";
198 # periodic processing
202 if ($main::systime > $lasttime + 15) {
204 $lasttime = $main::systime;
219 # new - create a new user
226 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
234 # $call =~ s/-\d+$//o;
236 # confess "can't create existing call $call in User\n!" if $u{$call};
238 my $self = $pkg->alloc($call);
244 # get - get an existing user - this seems to return a different reference everytime it is
253 # is it in the LRU cache?
254 my $ref = $lru->get($call);
255 return $ref if $ref && ref $ref eq 'DXUser';
258 unless ($dbm->get($call, $data)) {
259 eval { $ref = decode($data); };
262 if (!UNIVERSAL::isa($ref, 'DXUser')) {
263 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
266 # we have a reference and it *is* a DXUser
269 LogDbg('err', "DXUser::get decode error on $call '$@'");
271 dbg("DXUser::get: no reference returned from decode of $call $!");
275 $lru->put($call, $ref);
282 # get an existing either from the channel (if there is one) or from the database
284 # It is important to note that if you have done a get (for the channel say) and you
285 # want access or modify that you must use this call (and you must NOT use get's all
286 # over the place willy nilly!)
293 my $dxchan = DXChannel::get($call);
295 my $ref = $dxchan->user;
296 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
298 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
304 # get all callsigns in the database
309 return (sort keys %u);
319 confess "Trying to put nothing!" unless $self && ref $self;
320 my $call = $self->{call};
323 delete $self->{annok} if $self->{annok};
324 delete $self->{dxok} if $self->{dxok};
326 $lru->put($call, $self);
327 my $ref = $self->encode;
328 $dbm->put($call, $ref);
334 goto &json_encode if $v4;
335 goto &asc_encode unless $v3;
337 return nfreeze($self);
343 goto &json_dncode if $v4;
344 goto &asc_decode unless $v3;
351 # create a string from a user reference (in_ascii)
360 my $ref = bless {}, ref $self;
361 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
362 $ref->{$k} = $self->{$k} if exists $self->{$k};
364 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
373 # create a hash from a string (in ascii)
379 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
382 LogDbg('err', "DXUser::asc_decode: on '$s' $@");
399 # del - delete a user
405 my $call = $self->{call};
411 # close - close down a user
419 $self->{lastin} = $main::systime;
420 # add a record to the connect list
421 my $ref = [$startt || $self->{startt}, $main::systime];
422 push @$ref, $ip if $ip;
423 push @{$self->{connlist}}, $ref;
424 shift @{$self->{connlist}} if @{$self->{connlist}} > $maxconnlist;
438 # return a list of valid elements
448 # export the database to an ascii file
453 my $name = shift || 'user_asc';
454 my $basic_info_only = shift;
456 my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name"; # force use of local
459 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
460 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
461 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
462 move "$fn.o", "$fn.oo" if -e "$fn.o";
463 move "$fn", "$fn.o" if -e "$fn";
468 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
473 my $t = scalar localtime;
474 print $fh q{#!/usr/bin/perl
476 # The exported userfile for a DXSpider System
478 # Input file: $filename
484 # search local then perl directories
488 # root of directory tree for this system
490 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
492 unshift @INC, "$root/perl"; # this IS the right way round!
493 unshift @INC, "$root/local";
495 # try to detect a lockfile (this isn't atomic but
497 $lockfn = "$root/local_data/cluster.lck"; # lock file name
499 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
502 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
511 $main::userfn = shift @ARGV;
512 print "user filename now $userfn\n";
525 my $ref = asc_decode($f[1]);
529 DXUser::sync() unless $count % 10000;
531 print "# Error: $f[0]\t$f[1]\n";
535 DXUser::sync(); DXUser::finish();
536 print "There are $count user records and $err errors\n";
538 print $fh "__DATA__\n";
540 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
541 if (!is_callsign($key) || $key =~ /^0/) {
544 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
545 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
546 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
547 eval {$dbm->del($key)};
548 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
553 eval {$ref = decode($val); };
555 my $t = $ref->{lastin} || 0;
556 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
557 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
558 eval {$dbm->del($key)};
559 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
560 LogDbg('DXCommand', "$ref->{call} deleted, too old");
565 # only store users that are reasonably active or have useful information
566 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
569 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
570 eval {$dbm->del($key)};
571 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
577 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
578 LogDbg('command', $s);
584 use Data::Structure::Util qw(unbless);
586 my $name = shift || 'user_json';
587 my $basic_info_only = shift;
589 my $fn = $name ne 'user_json' ? $name : "$main::local_data/$name"; # force use of local
592 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
593 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
594 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
595 move "$fn.o", "$fn.oo" if -e "$fn.o";
596 move "$fn", "$fn.o" if -e "$fn";
598 my $json = JSON->new;
600 $json->allow_blessed(1);
605 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
610 my $t = scalar localtime;
611 print $fh q{#!/usr/bin/perl
613 # The exported userfile for a DXSpider System
615 # Input file: $filename
621 # search local then perl directories
625 # root of directory tree for this system
627 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
629 unshift @INC, "$root/perl"; # this IS the right way round!
630 unshift @INC, "$root/local";
632 # try to detect a lockfile (this isn't atomic but
634 $lockfn = "$root/local_data/cluster.lck"; # lock file name
636 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
639 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
648 $main::userfn = shift @ARGV;
649 print "user filename now $userfn\n";
655 my $json = JSON->new;
666 eval { $ref = $json->decode($f[1]); };
668 $ref = bless $ref, 'DXUser';
671 DXUser::sync() unless $count % 10000;
673 print "# Error: $f[0]\t$f[1]\n";
677 DXUser::sync(); DXUser::finish();
678 print "There are $count user records and $err errors\n";
680 print $fh "__DATA__\n";
682 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
683 if (!is_callsign($key) || $key =~ /^0/) {
686 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
687 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
688 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
689 eval {$dbm->del($key)};
690 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
695 eval {$ref = decode($val); };
697 my $t = $ref->{lastin} || 0;
698 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
699 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
700 eval {$dbm->del($key)};
701 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
702 LogDbg('DXCommand', "$ref->{call} deleted, too old");
707 # only store users that are reasonably active or have useful information
709 print $fh "$key\t" . $json->encode($ref) . "\n";
712 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
713 eval {$dbm->del($key)};
714 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
720 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
721 LogDbg('command', $s);
729 # add one or more groups
733 my $ref = $self->{group} || [ 'local' ];
734 $self->{group} = $ref if !$self->{group};
735 push @$ref, @_ if @_;
738 # remove one or more groups
742 my $ref = $self->{group} || [ 'local' ];
745 $self->{group} = $ref if !$self->{group};
747 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
750 # does this thing contain all the groups listed?
754 my $ref = $self->{group};
757 return 0 if !$ref || @_ == 0;
758 return 1 if @$ref == 0 && @_ == 0;
759 for ($n = 0; $n < @_; ) {
762 $n++ if grep $_ eq $a, @_;
768 # simplified group test just for one group
773 my $ref = $self->{group};
776 return grep $_ eq $s, $ref;
779 # set up a default group (only happens for them's that connect direct)
783 $self->{group} = [ 'local' ];
786 # set up empty buddies (only happens for them's that connect direct)
790 $self->{buddies} = [ ];
794 # return a prompt for a field
799 my ($self, $ele) = @_;
803 # some variable accessors
807 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
812 # want is default = 1
819 $self->{$s} = $val if defined $val;
820 return exists $self->{$s} ? $self->{$s} : 1;
823 # wantnot is default = 0
830 $self->{$s} = $val if defined $val;
831 return exists $self->{$s} ? $self->{$s} : 0;
836 return _want('beep', @_);
841 return _want('ann', @_);
846 return _want('wwv', @_);
851 return _want('wcy', @_);
856 return _want('echo', @_);
861 return _want('wx', @_);
866 return _want('dx', @_);
871 return _want('talk', @_);
876 return _want('grid', @_);
881 return _want('email', @_);
886 return _want('ann_talk', @_);
891 return _want('pc16', @_);
896 return _want('sendpc16', @_);
901 return _want('routepc16', @_);
906 return _want('usstate', @_);
911 return _want('dxcq', @_);
916 return _want('dxitu', @_);
921 return _want('gtk', @_);
926 return _want('pc9x', @_);
933 $self->{wantlogininfo} = $val if defined $val;
934 return $self->{wantlogininfo};
940 return $self->{sort} =~ /^[ACRSX]$/;
946 return grep $_ eq 'local_node', @{$self->{group}};
952 return $self->{sort} =~ /^[UW]$/;
958 return $self->{sort} eq 'W';
964 return $self->{sort} eq 'B';
970 return $self->{sort} eq 'S';
976 return $self->{sort} eq 'C';
982 return $self->{sort} eq 'X';
988 return $self->{sort} eq 'R';
994 return $self->{sort} eq 'A';
1000 delete $self->{passwd};
1003 sub unset_passphrase
1006 delete $self->{passphrase};
1012 my $call = uc shift;
1013 $self->{believe} ||= [];
1014 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
1020 my $call = uc shift;
1021 if (exists $self->{believe}) {
1022 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
1023 delete $self->{believe} unless @{$self->{believe}};
1030 return exists $self->{believe} ? @{$self->{believe}} : ();
1037 $self->{lastping} ||= {};
1038 $self->{lastping} = {} unless ref $self->{lastping};
1039 my $b = $self->{lastping};
1040 $b->{$call} = shift if @_;