2 # DX cluster user routines
4 # Copyright (c) 1998 - Dirk Koopman G1TLH
22 use vars qw($VERSION $BRANCH);
24 main::mkver($VERSION = q$Revision$);
26 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
31 $lastoperinterval = 60*24*60*60;
34 $tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
37 # hash of valid elements and a simple prompt
40 alias => '0,Real Callsign',
43 lat => '0,Latitude,slat',
44 long => '0,Longitude,slong',
46 email => '0,E-mail Address,parray',
47 priv => '9,Privilege Level',
48 lastin => '0,Last Time in,cldatetime',
49 passwd => '9,Password,yesno',
50 passphrase => '9,Pass Phrase,yesno',
51 addr => '0,Full Address',
52 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
53 xpert => '0,Expert Status,yesno',
55 node => '0,Last Node',
56 homenode => '0,Home Node',
57 lockout => '9,Locked out?,yesno', # won't let them in at all
58 dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
59 annok => '9,Accept Announces?,yesno', # accept his announces?
61 hmsgno => '0,Highest Msgno',
62 group => '0,Chat Group,parray', # used to create a group of users/nodes for some purpose or other
63 isolate => '9,Isolate network,yesno',
64 wantbeep => '0,Req Beep,yesno',
65 wantann => '0,Req Announce,yesno',
66 wantwwv => '0,Req WWV,yesno',
67 wantwcy => '0,Req WCY,yesno',
68 wantecho => '0,Req Echo,yesno',
69 wanttalk => '0,Req Talk,yesno',
70 wantwx => '0,Req WX,yesno',
71 wantdx => '0,Req DX Spots,yesno',
72 wantemail => '0,Req Msgs as Email,yesno',
73 pagelth => '0,Current Pagelth',
74 pingint => '9,Node Ping interval',
75 nopings => '9,Ping Obs Count',
76 wantlogininfo => '0,Login Info Req,yesno',
77 wantgrid => '0,Show DX Grid,yesno',
78 wantann_talk => '0,Talklike Anns,yesno',
79 wantpc90 => '1,Req PC90,yesno',
80 wantnp => '1,Req New Proto,yesno',
81 wantpc16 => '9,Want Users from node,yesno',
82 wantsendpc16 => '9,Send PC16,yesno',
83 wantroutepc19 => '9,Route PC19,yesno',
84 wantusstate => '0,Show US State,yesno',
85 wantdxcq => '0,Show CQ Zone,yesno',
86 wantdxitu => '0,Show ITU Zone,yesno',
87 lastoper => '9,Last for/oper,cldatetime',
88 nothere => '0,Not Here Text',
89 registered => '9,Registered?,yesno',
90 prompt => '0,Required Prompt',
91 version => '1,Version',
93 believe => '1,Believable nodes,parray',
94 lastping => '1,Last Ping at,ptimelist',
101 my $name = $AUTOLOAD;
103 return if $name =~ /::DESTROY$/;
106 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
107 # this clever line of code creates a subroutine which takes over from autoload
108 # from OO Perl - Conway
109 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
116 # initialise the system
120 my ($pkg, $fn, $mode) = @_;
122 confess "need a filename in User" if !$fn;
131 # eval "use Storable qw(nfreeze thaw)";
136 dbg("the module Storable appears to be missing!!");
137 dbg("trying to continue in compatibility mode (this may fail)");
138 dbg("please install Storable from CPAN as soon as possible");
140 import Storable qw(nfreeze thaw);
144 $convert++ unless -e $ufn;
148 $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?]";
150 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
153 $lru = LRU->newbase("DXUser", $lrusize);
155 # do a conversion if required
157 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
160 dbg("Converting the User File to V3 ");
161 dbg("This will take a while, I suggest you go and have cup of strong tea");
162 my $odbm = tie (%oldu, 'DB_File', "$fn.v2", O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn.v2 ($!) [rebuild it from user_asc?]";
163 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
164 my $ref = asc_decode($val);
174 dbg("Conversion completed $count records $err errors");
183 confess "need a filename in User" if !$fn;
184 $fn .= $v3 ? ".v3" : ".v2";
189 # periodic processing
193 if ($main::systime > $lasttime + 15) {
195 $lasttime = $main::systime;
210 # new - create a new user
217 # $call =~ s/-\d+$//o;
219 # confess "can't create existing call $call in User\n!" if $u{$call};
221 my $self = bless {}, $pkg;
222 $self->{call} = $call;
223 $self->{'sort'} = 'U';
229 # get - get an existing user - this seems to return a different reference everytime it is
239 # is it in the LRU cache?
240 my $ref = $lru->get($call);
244 unless ($dbm->get($call, $data)) {
245 $ref = decode($data);
246 $lru->put($call, $ref);
253 # get an existing either from the channel (if there is one) or from the database
255 # It is important to note that if you have done a get (for the channel say) and you
256 # want access or modify that you must use this call (and you must NOT use get's all
257 # over the place willy nilly!)
265 my $dxchan = DXChannel::get($call);
266 return $dxchan->user if $dxchan;
267 my $rref = Route::get($call);
268 return $rref->user if $rref && exists $rref->{user};
269 return $pkg->get($call);
273 # get all callsigns in the database
278 return (sort keys %u);
288 confess "Trying to put nothing!" unless $self && ref $self;
289 my $call = $self->{call};
290 # delete all instances of this
291 # for ($dbm->get_dup($call)) {
292 # $dbm->del_dup($call, $_);
295 delete $self->{annok} if $self->{annok};
296 delete $self->{dxok} if $self->{dxok};
297 $lru->put($call, $self);
298 my $ref = $self->encode;
299 $dbm->put($call, $ref);
305 goto &asc_encode unless $v3;
307 return nfreeze($self);
313 goto &asc_decode unless $v3;
318 # create a string from a user reference (in_ascii)
323 my $dd = new Data::Dumper([$self]);
326 $dd->Quotekeys($] < 5.005 ? 1 : 0);
331 # create a hash from a string (in ascii)
347 # del - delete a user
353 my $call = $self->{call};
354 # delete all instances of this
355 # for ($dbm->get_dup($call)) {
356 # $dbm->del_dup($call, $_);
363 # close - close down a user
369 $self->{lastin} = time;
383 # return a list of valid elements
393 # export the database to an ascii file
401 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
402 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
403 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
404 rename "$fn.o", "$fn.oo" if -e "$fn.o";
405 rename "$fn", "$fn.o" if -e "$fn";
410 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
415 my $t = scalar localtime;
416 print $fh q{#!/usr/bin/perl
418 # The exported userfile for a DXSpider System
420 # Input file: $filename
426 # search local then perl directories
430 # root of directory tree for this system
432 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
434 unshift @INC, "$root/perl"; # this IS the right way round!
435 unshift @INC, "$root/local";
437 # try to detect a lockfile (this isn't atomic but
439 $lockfn = "$root/local/cluster.lck"; # lock file name
441 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
444 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
455 $main::userfn = shift @ARGV;
456 print "user filename now $userfn\n";
459 DXUser->del_file($main::userfn);
460 DXUser->init($main::userfn, 1);
467 my $ref = asc_decode($f[1]);
472 print "# Error: $f[0]\t$f[1]\n";
476 DXUser->sync; DXUser->finish;
477 print "There are $count user records and $err errors\n";
479 print $fh "__DATA__\n";
481 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
482 if (!is_callsign($key) || $key =~ /^0/) {
483 Log('DXCommand', "Export Error1: $key\t$val");
484 eval {$dbm->del($key)};
485 dbg(carp("Export Error1: $key\t$val\n$@")) if $@;
489 my $ref = decode($val);
491 my $t = $ref->{lastin} || 0;
492 if ($main::systime > $t + $tooold) {
493 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
494 eval {$dbm->del($key)};
495 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
496 Log('DXCommand', "$ref->{call} deleted, too old");
501 # only store users that are reasonably active or have useful information
502 print $fh "$key\t" . $ref->asc_encode . "\n";
505 Log('DXCommand', "Export Error3: $key\t$val");
506 eval {$dbm->del($key)};
507 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
513 return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
520 # add one or more groups
524 my $ref = $self->{group} || [ 'local' ];
525 $self->{group} = $ref if !$self->{group};
526 push @$ref, @_ if @_;
529 # remove one or more groups
533 my $ref = $self->{group} || [ 'local' ];
536 $self->{group} = $ref if !$self->{group};
538 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
541 # does this thing contain all the groups listed?
545 my $ref = $self->{group};
548 return 0 if !$ref || @_ == 0;
549 return 1 if @$ref == 0 && @_ == 0;
550 for ($n = 0; $n < @_; ) {
553 $n++ if grep $_ eq $a, @_;
559 # simplified group test just for one group
564 my $ref = $self->{group};
567 return grep $_ eq $s, $ref;
570 # set up a default group (only happens for them's that connect direct)
574 $self->{group} = [ 'local' ];
578 # return a prompt for a field
583 my ($self, $ele) = @_;
587 # some variable accessors
591 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
596 # want is default = 1
603 $self->{$s} = $val if defined $val;
604 return exists $self->{$s} ? $self->{$s} : 1;
607 # wantnot is default = 0
614 $self->{$s} = $val if defined $val;
615 return exists $self->{$s} ? $self->{$s} : 0;
620 return _want('beep', @_);
625 return _want('ann', @_);
630 return _want('wwv', @_);
635 return _want('wcy', @_);
640 return _want('echo', @_);
645 return _want('wx', @_);
650 return _want('dx', @_);
655 return _want('talk', @_);
660 return _want('grid', @_);
665 return _want('email', @_);
670 return _want('ann_talk', @_);
675 return _want('pc16', @_);
680 return _wantnot('pc90', @_);
685 return _want('sendpc16', @_);
690 return _want('routepc16', @_);
695 return _want('usstate', @_);
700 return _want('dxcq', @_);
705 return _want('dxitu', @_);
710 return _wantnot('np', @_);
717 $self->{wantlogininfo} = $val if defined $val;
718 return $self->{wantlogininfo};
724 return $self->{sort} =~ /[ACRSX]/;
730 return $self->{sort} eq 'W';
736 return $self->{sort} eq 'U';
742 return $self->{sort} eq 'B';
748 return $self->{sort} eq 'S';
754 return $self->{sort} eq 'C';
760 return $self->{sort} eq 'X';
766 return $self->{sort} eq 'R';
772 return $self->{sort} eq 'A';
778 delete $self->{passwd};
784 delete $self->{passphrase};
791 $self->{believe} ||= [];
792 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
799 if (exists $self->{believe}) {
800 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
801 delete $self->{believe} unless @{$self->{believe}};
808 return exists $self->{believe} ? @{$self->{believe}} : ();
815 $self->{lastping} ||= {};
816 $self->{lastping} = {} unless ref $self->{lastping};
817 my $b = $self->{lastping};
818 $b->{$call} = shift if @_;