2 # DX cluster user routines
4 # Copyright (c) 1998 - Dirk Koopman G1TLH
22 use vars qw($VERSION $BRANCH);
23 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
24 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
25 $main::build += $VERSION;
26 $main::branch += $BRANCH;
28 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
33 $lastoperinterval = 60*24*60*60;
36 $tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
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,Access Group,parray', # used to create a group of users/nodes for some purpose or other
65 isolate => '9,Isolate network,yesno',
66 wantbeep => '0,Req Beep,yesno',
67 wantann => '0,Req Announce,yesno',
68 wantwwv => '0,Req WWV,yesno',
69 wantwcy => '0,Req WCY,yesno',
70 wantecho => '0,Req Echo,yesno',
71 wanttalk => '0,Req Talk,yesno',
72 wantwx => '0,Req WX,yesno',
73 wantdx => '0,Req DX Spots,yesno',
74 wantemail => '0,Req Msgs as Email,yesno',
75 pagelth => '0,Current Pagelth',
76 pingint => '9,Node Ping interval',
77 nopings => '9,Ping Obs Count',
78 wantlogininfo => '9,Login info req,yesno',
79 wantgrid => '0,DX Grid Info,yesno',
80 wantann_talk => '0,Talklike Anns,yesno',
81 wantpc90 => '1,Req PC90,yesno',
82 wantnp => '1,Req New Protocol,yesno',
83 wantpc16 => '9,Want Users from node,yesno',
84 wantsendpc16 => '9,Send PC16,yesno',
85 wantroutepc19 => '9,Route PC19,yesno',
86 wantusstate => '9,Show US State,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',
101 return if $name =~ /::DESTROY$/;
104 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
105 # this clever line of code creates a subroutine which takes over from autoload
106 # from OO Perl - Conway
107 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
114 # initialise the system
118 my ($pkg, $fn, $mode) = @_;
120 confess "need a filename in User" if !$fn;
129 # eval "use Storable qw(nfreeze thaw)";
134 dbg("the module Storable appears to be missing!!");
135 dbg("trying to continue in compatibility mode (this may fail)");
136 dbg("please install Storable from CPAN as soon as possible");
138 import Storable qw(nfreeze thaw);
142 $convert++ unless -e $ufn;
146 $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?]";
148 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
151 $lru = LRU->newbase("DXUser", $lrusize);
153 # do a conversion if required
155 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
158 dbg("Converting the User File to V3 ");
159 dbg("This will take a while, I suggest you go and have cup of strong tea");
160 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?]";
161 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
162 my $ref = asc_decode($val);
172 dbg("Conversion completed $count records $err errors");
181 confess "need a filename in User" if !$fn;
182 $fn .= $v3 ? ".v3" : ".v2";
187 # periodic processing
191 if ($main::systime > $lasttime + 15) {
193 $lasttime = $main::systime;
208 # new - create a new user
215 # $call =~ s/-\d+$//o;
217 # confess "can't create existing call $call in User\n!" if $u{$call};
219 my $self = bless {}, $pkg;
220 $self->{call} = $call;
221 $self->{'sort'} = 'U';
227 # get - get an existing user - this seems to return a different reference everytime it is
237 # is it in the LRU cache?
238 my $ref = $lru->get($call);
242 unless ($dbm->get($call, $data)) {
243 $ref = decode($data);
244 $lru->put($call, $ref);
251 # get an existing either from the channel (if there is one) or from the database
253 # It is important to note that if you have done a get (for the channel say) and you
254 # want access or modify that you must use this call (and you must NOT use get's all
255 # over the place willy nilly!)
263 my $dxchan = DXChannel->get($call);
264 return $dxchan->user if $dxchan;
265 my $rref = Route::get($call);
266 return $rref->user if $rref && exists $rref->{user};
267 return $pkg->get($call);
271 # get all callsigns in the database
276 return (sort keys %u);
286 confess "Trying to put nothing!" unless $self && ref $self;
287 my $call = $self->{call};
288 # delete all instances of this
289 # for ($dbm->get_dup($call)) {
290 # $dbm->del_dup($call, $_);
293 delete $self->{annok} if $self->{annok};
294 delete $self->{dxok} if $self->{dxok};
295 $lru->put($call, $self);
296 my $ref = $self->encode;
297 $dbm->put($call, $ref);
303 goto &asc_encode unless $v3;
305 return nfreeze($self);
311 goto &asc_decode unless $v3;
316 # create a string from a user reference (in_ascii)
321 my $dd = new Data::Dumper([$self]);
324 $dd->Quotekeys($] < 5.005 ? 1 : 0);
329 # create a hash from a string (in ascii)
345 # del - delete a user
351 my $call = $self->{call};
352 # delete all instances of this
353 # for ($dbm->get_dup($call)) {
354 # $dbm->del_dup($call, $_);
361 # close - close down a user
367 $self->{lastin} = time;
381 # return a list of valid elements
391 # export the database to an ascii file
399 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
400 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
401 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
402 rename "$fn.o", "$fn.oo" if -e "$fn.o";
403 rename "$fn", "$fn.o" if -e "$fn";
408 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
413 my $t = scalar localtime;
414 print $fh q{#!/usr/bin/perl
416 # The exported userfile for a DXSpider System
418 # Input file: $filename
424 # search local then perl directories
428 # root of directory tree for this system
430 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
432 unshift @INC, "$root/perl"; # this IS the right way round!
433 unshift @INC, "$root/local";
435 # try to detect a lockfile (this isn't atomic but
437 $lockfn = "$root/local/cluster.lck"; # lock file name
439 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
442 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
453 $main::userfn = shift @ARGV;
454 print "user filename now $userfn\n";
457 DXUser->del_file($main::userfn);
458 DXUser->init($main::userfn, 1);
465 my $ref = asc_decode($f[1]);
470 print "# Error: $f[0]\t$f[1]\n";
474 DXUser->sync; DXUser->finish;
475 print "There are $count user records and $err errors\n";
477 print $fh "__DATA__\n";
479 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
480 if (!is_callsign($key) || $key =~ /^0/) {
481 Log('DXCommand', "Export Error1: $key\t$val");
482 eval {$dbm->del($key)};
483 dbg(carp("Export Error1: $key\t$val\n$@")) if $@;
487 my $ref = decode($val);
489 my $t = $ref->{lastin} || 0;
490 if ($main::systime > $t + $tooold) {
491 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
492 eval {$dbm->del($key)};
493 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
494 Log('DXCommand', "$ref->{call} deleted, too old");
499 # only store users that are reasonably active or have useful information
500 print $fh "$key\t" . $ref->asc_encode . "\n";
503 Log('DXCommand', "Export Error3: $key\t$val");
504 eval {$dbm->del($key)};
505 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
511 return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
518 # add one or more groups
522 my $ref = $self->{group} || [ 'local' ];
523 $self->{group} = $ref if !$self->{group};
524 push @$ref, @_ if @_;
527 # remove one or more groups
531 my $ref = $self->{group} || [ 'local' ];
534 $self->{group} = $ref if !$self->{group};
536 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
539 # does this thing contain all the groups listed?
543 my $ref = $self->{group};
546 return 0 if !$ref || @_ == 0;
547 return 1 if @$ref == 0 && @_ == 0;
548 for ($n = 0; $n < @_; ) {
551 $n++ if grep $_ eq $a, @_;
557 # simplified group test just for one group
562 my $ref = $self->{group};
565 return grep $_ eq $s, $ref;
568 # set up a default group (only happens for them's that connect direct)
572 $self->{group} = [ 'local' ];
576 # return a prompt for a field
581 my ($self, $ele) = @_;
585 # some variable accessors
589 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
599 $self->{$s} = $val if defined $val;
600 return exists $self->{$s} ? $self->{$s} : 1;
605 return _want('beep', @_);
610 return _want('ann', @_);
615 return _want('wwv', @_);
620 return _want('wcy', @_);
625 return _want('echo', @_);
630 return _want('wx', @_);
635 return _want('dx', @_);
640 return _want('talk', @_);
645 return _want('grid', @_);
650 return _want('email', @_);
655 return _want('ann_talk', @_);
660 return _want('pc16', @_);
665 return _want('sendpc16', @_);
670 return _want('routepc16', @_);
675 return _want('usstate', @_);
682 $self->{wantlogininfo} = $val if defined $val;
683 return $self->{wantlogininfo};
689 return $self->{sort} =~ /[ACRSX]/;
695 return $self->{sort} eq 'U';
701 return $self->{sort} eq 'B';
707 return $self->{sort} eq 'S';
713 return $self->{sort} eq 'C';
719 return $self->{sort} eq 'X';
725 return $self->{sort} eq 'R';
731 return $self->{sort} eq 'A';
737 delete $self->{passwd};
743 delete $self->{passphrase};