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,Group,parray', # used to create a group of users/nodes for some purpose or other
65 buddies => '0,Buddies,parray',
66 isolate => '9,Isolate network,yesno',
67 wantbeep => '0,Req Beep,yesno',
68 wantann => '0,Req Announce,yesno',
69 wantwwv => '0,Req WWV,yesno',
70 wantwcy => '0,Req WCY,yesno',
71 wantecho => '0,Req Echo,yesno',
72 wanttalk => '0,Req Talk,yesno',
73 wantwx => '0,Req WX,yesno',
74 wantdx => '0,Req DX Spots,yesno',
75 wantemail => '0,Req Msgs as Email,yesno',
76 pagelth => '0,Current Pagelth',
77 pingint => '9,Node Ping interval',
78 nopings => '9,Ping Obs Count',
79 wantlogininfo => '0,Login Info Req,yesno',
80 wantgrid => '0,Show DX Grid,yesno',
81 wantann_talk => '0,Talklike Anns,yesno',
82 wantpc16 => '9,Want Users from node,yesno',
83 wantsendpc16 => '9,Send PC16,yesno',
84 wantroutepc19 => '9,Route PC19,yesno',
85 wantusstate => '0,Show US State,yesno',
86 wantdxcq => '0,Show CQ Zone,yesno',
87 wantdxitu => '0,Show ITU Zone,yesno',
88 wantgtk => '0,Want GTK interface,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++ if -e "$fn.v2" && !-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 die "Cannot open $ufn ($!)\n" unless $dbm;
157 $lru = LRU->newbase("DXUser", $lrusize);
159 # do a conversion if required
160 if ($dbm && $convert) {
161 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
164 dbg("Converting the User File to V3 ");
165 dbg("This will take a while, I suggest you go and have cup of strong tea");
166 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?]";
167 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
168 my $ref = asc_decode($val);
178 dbg("Conversion completed $count records $err errors");
187 confess "need a filename in User" if !$fn;
188 $fn .= $v3 ? ".v3" : ".v2";
193 # periodic processing
197 if ($main::systime > $lasttime + 15) {
199 $lasttime = $main::systime;
214 # new - create a new user
221 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
229 # $call =~ s/-\d+$//o;
231 # confess "can't create existing call $call in User\n!" if $u{$call};
233 my $self = $pkg->alloc($call);
239 # get - get an existing user - this seems to return a different reference everytime it is
249 # is it in the LRU cache?
250 my $ref = $lru->get($call);
254 unless ($dbm->get($call, $data)) {
255 $ref = decode($data);
256 $lru->put($call, $ref);
263 # get an existing either from the channel (if there is one) or from the database
265 # It is important to note that if you have done a get (for the channel say) and you
266 # want access or modify that you must use this call (and you must NOT use get's all
267 # over the place willy nilly!)
275 my $dxchan = DXChannel::get($call);
276 return $dxchan->user if $dxchan;
277 my $rref = Route::get($call);
278 return $rref->user if $rref && exists $rref->{user};
279 return $pkg->get($call);
283 # get all callsigns in the database
288 return (sort keys %u);
298 confess "Trying to put nothing!" unless $self && ref $self;
299 my $call = $self->{call};
300 # delete all instances of this
301 # for ($dbm->get_dup($call)) {
302 # $dbm->del_dup($call, $_);
305 delete $self->{annok} if $self->{annok};
306 delete $self->{dxok} if $self->{dxok};
307 $lru->put($call, $self);
308 my $ref = $self->encode;
309 $dbm->put($call, $ref);
315 goto &asc_encode unless $v3;
317 return nfreeze($self);
323 goto &asc_decode unless $v3;
328 # create a string from a user reference (in_ascii)
337 # create a hash from a string (in ascii)
343 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
353 # del - delete a user
359 my $call = $self->{call};
360 # delete all instances of this
361 # for ($dbm->get_dup($call)) {
362 # $dbm->del_dup($call, $_);
369 # close - close down a user
375 $self->{lastin} = time;
389 # return a list of valid elements
399 # export the database to an ascii file
407 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
408 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
409 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
410 rename "$fn.o", "$fn.oo" if -e "$fn.o";
411 rename "$fn", "$fn.o" if -e "$fn";
416 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
421 my $t = scalar localtime;
422 print $fh q{#!/usr/bin/perl
424 # The exported userfile for a DXSpider System
426 # Input file: $filename
432 # search local then perl directories
436 # root of directory tree for this system
438 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
440 unshift @INC, "$root/perl"; # this IS the right way round!
441 unshift @INC, "$root/local";
443 # try to detect a lockfile (this isn't atomic but
445 $lockfn = "$root/local/cluster.lck"; # lock file name
447 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
450 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
461 $main::userfn = shift @ARGV;
462 print "user filename now $userfn\n";
465 DXUser->del_file($main::userfn);
466 DXUser->init($main::userfn, 1);
473 my $ref = asc_decode($f[1]);
478 print "# Error: $f[0]\t$f[1]\n";
482 DXUser->sync; DXUser->finish;
483 print "There are $count user records and $err errors\n";
485 print $fh "__DATA__\n";
487 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
488 if (!is_callsign($key) || $key =~ /^0/) {
491 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
492 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
493 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
494 eval {$dbm->del($key)};
495 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
499 my $ref = decode($val);
501 my $t = $ref->{lastin} || 0;
502 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
503 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
504 eval {$dbm->del($key)};
505 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
506 LogDbg('DXCommand', "$ref->{call} deleted, too old");
511 # only store users that are reasonably active or have useful information
512 print $fh "$key\t" . $ref->asc_encode . "\n";
515 LogDbg('DXCommand', "Export Error3: $key\t$val");
516 eval {$dbm->del($key)};
517 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
523 return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
530 # add one or more groups
534 my $ref = $self->{group} || [ 'local' ];
535 $self->{group} = $ref if !$self->{group};
536 push @$ref, @_ if @_;
539 # remove one or more groups
543 my $ref = $self->{group} || [ 'local' ];
546 $self->{group} = $ref if !$self->{group};
548 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
551 # does this thing contain all the groups listed?
555 my $ref = $self->{group};
558 return 0 if !$ref || @_ == 0;
559 return 1 if @$ref == 0 && @_ == 0;
560 for ($n = 0; $n < @_; ) {
563 $n++ if grep $_ eq $a, @_;
569 # simplified group test just for one group
574 my $ref = $self->{group};
577 return grep $_ eq $s, $ref;
580 # set up a default group (only happens for them's that connect direct)
584 $self->{group} = [ 'local' ];
587 # set up empty buddies (only happens for them's that connect direct)
591 $self->{buddies} = [ ];
595 # return a prompt for a field
600 my ($self, $ele) = @_;
604 # some variable accessors
608 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
613 # want is default = 1
620 $self->{$s} = $val if defined $val;
621 return exists $self->{$s} ? $self->{$s} : 1;
624 # wantnot is default = 0
631 $self->{$s} = $val if defined $val;
632 return exists $self->{$s} ? $self->{$s} : 0;
637 return _want('beep', @_);
642 return _want('ann', @_);
647 return _want('wwv', @_);
652 return _want('wcy', @_);
657 return _want('echo', @_);
662 return _want('wx', @_);
667 return _want('dx', @_);
672 return _want('talk', @_);
677 return _want('grid', @_);
682 return _want('email', @_);
687 return _want('ann_talk', @_);
692 return _want('pc16', @_);
697 return _want('sendpc16', @_);
702 return _want('routepc16', @_);
707 return _want('usstate', @_);
712 return _want('dxcq', @_);
717 return _want('dxitu', @_);
722 return _want('gtk', @_);
729 $self->{wantlogininfo} = $val if defined $val;
730 return $self->{wantlogininfo};
736 return $self->{sort} =~ /[ACRSX]/;
742 return grep $_ eq 'local_node', @{$self->{group}};
748 return $self->{sort} eq 'U';
754 return $self->{sort} eq 'B';
760 return $self->{sort} eq 'S';
766 return $self->{sort} eq 'C';
772 return $self->{sort} eq 'X';
778 return $self->{sort} eq 'R';
784 return $self->{sort} eq 'A';
790 delete $self->{passwd};
796 delete $self->{passphrase};
803 $self->{believe} ||= [];
804 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
811 if (exists $self->{believe}) {
812 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
813 delete $self->{believe} unless @{$self->{believe}};
820 return exists $self->{believe} ? @{$self->{believe}} : ();
827 $self->{lastping} ||= {};
828 $self->{lastping} = {} unless ref $self->{lastping};
829 my $b = $self->{lastping};
830 $b->{$call} = shift if @_;