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,Chat 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 => '0,Login Info Req,yesno',
79 wantgrid => '0,Show DX Grid,yesno',
80 wantann_talk => '0,Talklike Anns,yesno',
81 wantpc90 => '1,Req PC90,yesno',
82 wantnp => '1,Req New Proto,yesno',
83 wantpc16 => '9,Want Users from node,yesno',
84 wantsendpc16 => '9,Send PC16,yesno',
85 wantroutepc19 => '9,Route PC19,yesno',
86 wantusstate => '0,Show US State,yesno',
87 wantdxcq => '0,Show CQ Zone,yesno',
88 wantdxitu => '0,Show ITU Zone,yesno',
89 lastoper => '9,Last for/oper,cldatetime',
90 nothere => '0,Not Here Text',
91 registered => '9,Registered?,yesno',
92 prompt => '0,Required Prompt',
93 version => '1,Version',
95 believe => '1,Believable nodes,parray',
96 lastping => '1,Last Ping at,ptimelist',
103 my $name = $AUTOLOAD;
105 return if $name =~ /::DESTROY$/;
108 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
109 # this clever line of code creates a subroutine which takes over from autoload
110 # from OO Perl - Conway
111 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
118 # initialise the system
122 my ($pkg, $fn, $mode) = @_;
124 confess "need a filename in User" if !$fn;
133 # eval "use Storable qw(nfreeze thaw)";
138 dbg("the module Storable appears to be missing!!");
139 dbg("trying to continue in compatibility mode (this may fail)");
140 dbg("please install Storable from CPAN as soon as possible");
142 import Storable qw(nfreeze thaw);
146 $convert++ unless -e $ufn;
150 $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?]";
152 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
155 $lru = LRU->newbase("DXUser", $lrusize);
157 # do a conversion if required
159 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
162 dbg("Converting the User File to V3 ");
163 dbg("This will take a while, I suggest you go and have cup of strong tea");
164 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?]";
165 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
166 my $ref = asc_decode($val);
176 dbg("Conversion completed $count records $err errors");
185 confess "need a filename in User" if !$fn;
186 $fn .= $v3 ? ".v3" : ".v2";
191 # periodic processing
195 if ($main::systime > $lasttime + 15) {
197 $lasttime = $main::systime;
212 # new - create a new user
219 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
227 # $call =~ s/-\d+$//o;
229 # confess "can't create existing call $call in User\n!" if $u{$call};
231 my $self = $pkg->alloc($call);
237 # get - get an existing user - this seems to return a different reference everytime it is
247 # is it in the LRU cache?
248 my $ref = $lru->get($call);
252 unless ($dbm->get($call, $data)) {
253 $ref = decode($data);
254 $lru->put($call, $ref);
261 # get an existing either from the channel (if there is one) or from the database
263 # It is important to note that if you have done a get (for the channel say) and you
264 # want access or modify that you must use this call (and you must NOT use get's all
265 # over the place willy nilly!)
273 my $dxchan = DXChannel::get($call);
274 return $dxchan->user if $dxchan;
275 my $rref = Route::get($call);
276 return $rref->user if $rref && exists $rref->{user};
277 return $pkg->get($call);
281 # get all callsigns in the database
286 return (sort keys %u);
296 confess "Trying to put nothing!" unless $self && ref $self;
297 my $call = $self->{call};
298 # delete all instances of this
299 # for ($dbm->get_dup($call)) {
300 # $dbm->del_dup($call, $_);
303 delete $self->{annok} if $self->{annok};
304 delete $self->{dxok} if $self->{dxok};
305 $lru->put($call, $self);
306 my $ref = $self->encode;
307 $dbm->put($call, $ref);
313 goto &asc_encode unless $v3;
315 return nfreeze($self);
321 goto &asc_decode unless $v3;
326 # create a string from a user reference (in_ascii)
331 my $dd = new Data::Dumper([$self]);
334 $dd->Quotekeys($] < 5.005 ? 1 : 0);
339 # create a hash from a string (in ascii)
355 # del - delete a user
361 my $call = $self->{call};
362 # delete all instances of this
363 # for ($dbm->get_dup($call)) {
364 # $dbm->del_dup($call, $_);
371 # close - close down a user
377 $self->{lastin} = time;
391 # return a list of valid elements
401 # export the database to an ascii file
409 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
410 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
411 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
412 rename "$fn.o", "$fn.oo" if -e "$fn.o";
413 rename "$fn", "$fn.o" if -e "$fn";
418 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
423 my $t = scalar localtime;
424 print $fh q{#!/usr/bin/perl
426 # The exported userfile for a DXSpider System
428 # Input file: $filename
434 # search local then perl directories
438 # root of directory tree for this system
440 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
442 unshift @INC, "$root/perl"; # this IS the right way round!
443 unshift @INC, "$root/local";
445 # try to detect a lockfile (this isn't atomic but
447 $lockfn = "$root/local/cluster.lck"; # lock file name
449 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
452 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
463 $main::userfn = shift @ARGV;
464 print "user filename now $userfn\n";
467 DXUser->del_file($main::userfn);
468 DXUser->init($main::userfn, 1);
475 my $ref = asc_decode($f[1]);
480 print "# Error: $f[0]\t$f[1]\n";
484 DXUser->sync; DXUser->finish;
485 print "There are $count user records and $err errors\n";
487 print $fh "__DATA__\n";
489 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
490 if (!is_callsign($key) || $key =~ /^0/) {
493 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
494 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
495 Log('DXCommand', "Export Error1: $ekey\t$eval");
496 eval {$dbm->del($key)};
497 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
501 my $ref = decode($val);
503 my $t = $ref->{lastin} || 0;
504 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
505 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
506 eval {$dbm->del($key)};
507 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
508 Log('DXCommand', "$ref->{call} deleted, too old");
513 # only store users that are reasonably active or have useful information
514 print $fh "$key\t" . $ref->asc_encode . "\n";
517 Log('DXCommand', "Export Error3: $key\t$val");
518 eval {$dbm->del($key)};
519 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
525 return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
532 # add one or more groups
536 my $ref = $self->{group} || [ 'local' ];
537 $self->{group} = $ref if !$self->{group};
538 push @$ref, @_ if @_;
541 # remove one or more groups
545 my $ref = $self->{group} || [ 'local' ];
548 $self->{group} = $ref if !$self->{group};
550 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
553 # does this thing contain all the groups listed?
557 my $ref = $self->{group};
560 return 0 if !$ref || @_ == 0;
561 return 1 if @$ref == 0 && @_ == 0;
562 for ($n = 0; $n < @_; ) {
565 $n++ if grep $_ eq $a, @_;
571 # simplified group test just for one group
576 my $ref = $self->{group};
579 return grep $_ eq $s, $ref;
582 # set up a default group (only happens for them's that connect direct)
586 $self->{group} = [ 'local' ];
590 # return a prompt for a field
595 my ($self, $ele) = @_;
599 # some variable accessors
603 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
608 # want is default = 1
615 $self->{$s} = $val if defined $val;
616 return exists $self->{$s} ? $self->{$s} : 1;
619 # wantnot is default = 0
626 $self->{$s} = $val if defined $val;
627 return exists $self->{$s} ? $self->{$s} : 0;
632 return _want('beep', @_);
637 return _want('ann', @_);
642 return _want('wwv', @_);
647 return _want('wcy', @_);
652 return _want('echo', @_);
657 return _want('wx', @_);
662 return _want('dx', @_);
667 return _want('talk', @_);
672 return _want('grid', @_);
677 return _want('email', @_);
682 return _want('ann_talk', @_);
687 return _want('pc16', @_);
692 return _wantnot('pc90', @_);
697 return _want('sendpc16', @_);
702 return _want('routepc16', @_);
707 return _want('usstate', @_);
712 return _want('dxcq', @_);
717 return _want('dxitu', @_);
722 return _wantnot('np', @_);
729 $self->{wantlogininfo} = $val if defined $val;
730 return $self->{wantlogininfo};
736 return $self->{sort} =~ /[ACRSX]/;
742 return $self->{sort} eq 'U';
748 return $self->{sort} eq 'B';
754 return $self->{sort} eq 'S';
760 return $self->{sort} eq 'C';
766 return $self->{sort} eq 'X';
772 return $self->{sort} eq 'R';
778 return $self->{sort} eq 'A';
784 delete $self->{passwd};
790 delete $self->{passphrase};
797 $self->{believe} ||= [];
798 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
805 if (exists $self->{believe}) {
806 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
807 delete $self->{believe} unless @{$self->{believe}};
814 return exists $self->{believe} ? @{$self->{believe}} : ();
821 $self->{lastping} ||= {};
822 $self->{lastping} = {} unless ref $self->{lastping};
823 my $b = $self->{lastping};
824 $b->{$call} = shift if @_;