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 lastoper => '9,Last for/oper,cldatetime',
87 nothere => '0,Not Here Text',
88 registered => '9,Registered?,yesno',
89 prompt => '0,Required Prompt',
90 version => '1,Version',
100 return if $name =~ /::DESTROY$/;
103 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
104 # this clever line of code creates a subroutine which takes over from autoload
105 # from OO Perl - Conway
106 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
113 # initialise the system
117 my ($pkg, $fn, $mode) = @_;
119 confess "need a filename in User" if !$fn;
128 # eval "use Storable qw(nfreeze thaw)";
134 import Storable qw(nfreeze thaw);
138 $convert++ unless -e $ufn;
142 $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?]";
144 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
147 $lru = LRU->newbase("DXUser", $lrusize);
149 # do a conversion if required
151 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
154 dbg("Converting the User File to V3 ");
155 dbg("This will take a while, I suggest you go and have cup of strong tea");
156 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?]";
157 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
158 my $ref = asc_decode($val);
168 dbg("Conversion completed $count records $err errors");
177 confess "need a filename in User" if !$fn;
178 $fn .= $v3 ? ".v3" : ".v2";
183 # periodic processing
187 if ($main::systime > $lasttime + 15) {
189 $lasttime = $main::systime;
204 # new - create a new user
211 # $call =~ s/-\d+$//o;
213 # confess "can't create existing call $call in User\n!" if $u{$call};
215 my $self = bless {}, $pkg;
216 $self->{call} = $call;
217 $self->{'sort'} = 'U';
223 # get - get an existing user - this seems to return a different reference everytime it is
233 # is it in the LRU cache?
234 my $ref = $lru->get($call);
238 unless ($dbm->get($call, $data)) {
239 $ref = decode($data);
240 $lru->put($call, $ref);
247 # get an existing either from the channel (if there is one) or from the database
249 # It is important to note that if you have done a get (for the channel say) and you
250 # want access or modify that you must use this call (and you must NOT use get's all
251 # over the place willy nilly!)
259 my $dxchan = DXChannel->get($call);
260 return $dxchan->user if $dxchan;
261 my $rref = Route::get($call);
262 return $rref->user if $rref && exists $rref->{user};
263 return $pkg->get($call);
267 # get all callsigns in the database
272 return (sort keys %u);
282 confess "Trying to put nothing!" unless $self && ref $self;
283 my $call = $self->{call};
284 # delete all instances of this
285 # for ($dbm->get_dup($call)) {
286 # $dbm->del_dup($call, $_);
289 delete $self->{annok} if $self->{annok};
290 delete $self->{dxok} if $self->{dxok};
291 $lru->put($call, $self);
292 my $ref = $self->encode;
293 $dbm->put($call, $ref);
299 goto &asc_encode unless $v3;
301 return nfreeze($self);
307 goto &asc_decode unless $v3;
312 # create a string from a user reference (in_ascii)
317 my $dd = new Data::Dumper([$self]);
320 $dd->Quotekeys($] < 5.005 ? 1 : 0);
325 # create a hash from a string (in ascii)
341 # del - delete a user
347 my $call = $self->{call};
348 # delete all instances of this
349 # for ($dbm->get_dup($call)) {
350 # $dbm->del_dup($call, $_);
357 # close - close down a user
363 $self->{lastin} = time;
377 # return a list of valid elements
387 # export the database to an ascii file
395 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
396 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
397 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
398 rename "$fn.o", "$fn.oo" if -e "$fn.o";
399 rename "$fn", "$fn.o" if -e "$fn";
404 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
409 my $t = scalar localtime;
410 print $fh q{#!/usr/bin/perl
412 # The exported userfile for a DXSpider System
414 # Input file: $filename
420 # search local then perl directories
424 # root of directory tree for this system
426 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
428 unshift @INC, "$root/perl"; # this IS the right way round!
429 unshift @INC, "$root/local";
431 # try to detect a lockfile (this isn't atomic but
433 $lockfn = "$root/local/cluster.lck"; # lock file name
435 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
438 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
449 $main::userfn = shift @ARGV;
450 print "user filename now $userfn\n";
453 DXUser->del_file($main::userfn);
454 DXUser->init($main::userfn, 1);
461 my $ref = asc_decode($f[1]);
466 print "# Error: $f[0]\t$f[1]\n";
470 DXUser->sync; DXUser->finish;
471 print "There are $count user records and $err errors\n";
473 print $fh "__DATA__\n";
475 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
476 if (!is_callsign($key) || $key =~ /^0/) {
477 Log('DXCommand', "Export Error1: $key\t$val");
478 eval {$dbm->del($key)};
479 dbg(carp("Export Error1: $key\t$val\n$@")) if $@;
483 my $ref = decode($val);
485 my $t = $ref->{lastin} || 0;
486 if ($main::systime > $t + $tooold) {
487 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
488 eval {$dbm->del($key)};
489 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
490 Log('DXCommand', "$ref->{call} deleted, too old");
495 # only store users that are reasonably active or have useful information
496 print $fh "$key\t" . $ref->asc_encode . "\n";
499 Log('DXCommand', "Export Error3: $key\t$val");
500 eval {$dbm->del($key)};
501 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
507 return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
514 # add one or more groups
518 my $ref = $self->{group} || [ 'local' ];
519 $self->{group} = $ref if !$self->{group};
520 push @$ref, @_ if @_;
523 # remove one or more groups
527 my $ref = $self->{group} || [ 'local' ];
530 $self->{group} = $ref if !$self->{group};
532 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
535 # does this thing contain all the groups listed?
539 my $ref = $self->{group};
542 return 0 if !$ref || @_ == 0;
543 return 1 if @$ref == 0 && @_ == 0;
544 for ($n = 0; $n < @_; ) {
547 $n++ if grep $_ eq $a, @_;
553 # simplified group test just for one group
558 my $ref = $self->{group};
561 return grep $_ eq $s, $ref;
564 # set up a default group (only happens for them's that connect direct)
568 $self->{group} = [ 'local' ];
572 # return a prompt for a field
577 my ($self, $ele) = @_;
581 # some variable accessors
585 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
595 $self->{$s} = $val if defined $val;
596 return exists $self->{$s} ? $self->{$s} : 1;
601 return _want('beep', @_);
606 return _want('ann', @_);
611 return _want('wwv', @_);
616 return _want('wcy', @_);
621 return _want('echo', @_);
626 return _want('wx', @_);
631 return _want('dx', @_);
636 return _want('talk', @_);
641 return _want('grid', @_);
646 return _want('email', @_);
651 return _want('ann_talk', @_);
656 return _want('pc16', @_);
661 return _want('sendpc16', @_);
666 return _want('routepc16', @_);
673 $self->{wantlogininfo} = $val if defined $val;
674 return $self->{wantlogininfo};
680 return $self->{sort} =~ /[ACRSX]/;
686 return $self->{sort} eq 'U';
692 return $self->{sort} eq 'B';
698 return $self->{sort} eq 'S';
704 return $self->{sort} eq 'C';
710 return $self->{sort} eq 'X';
716 return $self->{sort} eq 'R';
722 return $self->{sort} eq 'A';
728 delete $self->{passwd};
734 delete $self->{passphrase};