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);
33 $lastoperinterval = 60*24*60*60;
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,Access 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 => '9,Login info req,yesno',
77 wantgrid => '0,DX Grid Info,yesno',
78 wantann_talk => '0,Talklike Anns,yesno',
79 wantpc90 => '1,Req PC90,yesno',
80 wantnp => '1,Req New Protocol,yesno',
81 wantusers => '9,Want Users from node,yesno',
82 wantsendusers => '9,Send users to node,yesno',
83 lastoper => '9,Last for/oper,cldatetime',
84 nothere => '0,Not Here Text',
85 registered => '9,Registered?,yesno',
86 prompt => '0,Required Prompt',
87 version => '1,Version',
98 return if $name =~ /::DESTROY$/;
101 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
102 # this clever line of code creates a subroutine which takes over from autoload
103 # from OO Perl - Conway
104 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
105 &$AUTOLOAD($self, @_);
106 # *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
108 # $self->{$name} = shift;
110 # return $self->{$name};
116 # initialise the system
120 my ($pkg, $fn, $mode) = @_;
122 confess "need a filename in User" if !$fn;
125 $dbm = tie (%u, 'DB_File', $fn, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
127 $dbm = tie (%u, 'DB_File', $fn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
131 $lru = LRU->newbase("DXUser", $lrusize);
138 confess "need a filename in User" if !$fn;
144 # periodic processing
148 if ($main::systime > $lasttime + 15) {
150 $lasttime = $main::systime;
165 # new - create a new user
172 # $call =~ s/-\d+$//o;
174 # confess "can't create existing call $call in User\n!" if $u{$call};
176 my $self = bless {}, $pkg;
177 $self->{call} = $call;
178 $self->{'sort'} = 'U';
184 # get - get an existing user - this seems to return a different reference everytime it is
194 # is it in the LRU cache?
195 my $ref = $lru->get($call);
199 unless ($dbm->get($call, $data)) {
200 $ref = decode($data);
201 $lru->put($call, $ref);
208 # get an existing either from the channel (if there is one) or from the database
210 # It is important to note that if you have done a get (for the channel say) and you
211 # want access or modify that you must use this call (and you must NOT use get's all
212 # over the place willy nilly!)
220 my $dxchan = DXChannel->get($call);
221 return $dxchan->user if $dxchan;
222 my $rref = Route::get($call);
223 return $rref->user if $rref && exists $rref->{user};
224 return $pkg->get($call);
228 # get all callsigns in the database
233 return (sort keys %u);
243 confess "Trying to put nothing!" unless $self && ref $self;
244 my $call = $self->{call};
245 # delete all instances of this
246 # for ($dbm->get_dup($call)) {
247 # $dbm->del_dup($call, $_);
250 delete $self->{annok} if $self->{annok};
251 delete $self->{dxok} if $self->{dxok};
252 $lru->put($call, $self);
253 my $ref = $self->encode;
254 $dbm->put($call, $ref);
258 # create a string from a user reference
263 my $dd = new Data::Dumper([$self]);
266 $dd->Quotekeys($] < 5.005 ? 1 : 0);
271 # create a hash from a string
287 # del - delete a user
293 my $call = $self->{call};
294 # delete all instances of this
295 # for ($dbm->get_dup($call)) {
296 # $dbm->del_dup($call, $_);
303 # close - close down a user
309 $self->{lastin} = time;
323 # return a list of valid elements
333 # export the database to an ascii file
341 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
342 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
343 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
344 rename "$fn.o", "$fn.oo" if -e "$fn.o";
345 rename "$fn", "$fn.o" if -e "$fn";
349 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
354 my $t = scalar localtime;
355 print $fh q{#!/usr/bin/perl
357 # The exported userfile for a DXSpider System
359 # Input file: $filename
365 # search local then perl directories
369 # root of directory tree for this system
371 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
373 unshift @INC, "$root/perl"; # this IS the right way round!
374 unshift @INC, "$root/local";
376 # try to detect a lockfile (this isn't atomic but
378 $lockfn = "$root/perl/cluster.lck"; # lock file name
380 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
383 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
394 $main::userfn = shift @ARGV;
395 print "user filename now $userfn\n";
398 DXUser->del_file($main::userfn);
399 DXUser->init($main::userfn, 1);
406 my $ref = decode($f[1]);
411 print "# Error: $f[0]\t$f[1]\n";
415 DXUser->sync; DXUser->finish;
416 print "There are $count user records and $err errors\n";
418 print $fh "__DATA__\n";
420 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
421 if (!is_callsign($key) || $key =~ /^0/) {
422 Log('DXCommand', "Export Error1: $key\t$val");
423 eval {$dbm->del($key)};
424 dbg(carp("Export Error1: $key\t$val\n$@")) if $@;
428 my $ref = decode($val);
430 print $fh "$key\t" . $ref->encode . "\n";
433 Log('DXCommand', "Export Error2: $key\t$val");
434 eval {$dbm->del($key)};
435 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
441 return "$count Users $err Errors ('sh/log Export' for details)";
448 # add one or more groups
452 my $ref = $self->{group} || [ 'local' ];
453 $self->{group} = $ref if !$self->{group};
454 push @$ref, @_ if @_;
457 # remove one or more groups
461 my $ref = $self->{group} || [ 'local' ];
464 $self->{group} = $ref if !$self->{group};
466 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
469 # does this thing contain all the groups listed?
473 my $ref = $self->{group};
476 return 0 if !$ref || @_ == 0;
477 return 1 if @$ref == 0 && @_ == 0;
478 for ($n = 0; $n < @_; ) {
481 $n++ if grep $_ eq $a, @_;
487 # simplified group test just for one group
492 my $ref = $self->{group};
495 return grep $_ eq $s, $ref;
498 # set up a default group (only happens for them's that connect direct)
502 $self->{group} = [ 'local' ];
506 # return a prompt for a field
511 my ($self, $ele) = @_;
515 # some variable accessors
519 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
529 $self->{$s} = $val if defined $val;
530 return exists $self->{$s} ? $self->{$s} : 1;
535 return _want('beep', @_);
540 return _want('ann', @_);
545 return _want('wwv', @_);
550 return _want('wcy', @_);
555 return _want('echo', @_);
560 return _want('wx', @_);
565 return _want('dx', @_);
570 return _want('talk', @_);
575 return _want('grid', @_);
580 return _want('email', @_);
585 return _want('ann_talk', @_);
590 return _want('users', @_);
595 return _want('annsendusers', @_);
602 $self->{wantlogininfo} = $val if defined $val;
603 return $self->{wantlogininfo};
609 return $self->{sort} =~ /[ACRSX]/;
615 return $self->{sort} eq 'U';
621 return $self->{sort} eq 'B';
627 return $self->{sort} eq 'S';
633 return $self->{sort} eq 'C';
639 return $self->{sort} eq 'X';
645 return $self->{sort} eq 'R';
651 return $self->{sort} eq 'A';
657 delete $self->{passwd};
663 delete $self->{passphrase};