2 # DX cluster user routines
4 # Copyright (c) 1998 - Dirk Koopman G1TLH
22 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
27 $lastoperinterval = 60*24*60*60;
30 $tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
33 # hash of valid elements and a simple prompt
36 alias => '0,Real Callsign',
39 lat => '0,Latitude,slat',
40 long => '0,Longitude,slong',
42 email => '0,E-mail Address,parray',
43 priv => '9,Privilege Level',
44 lastin => '0,Last Time in,cldatetime',
45 passwd => '9,Password,yesno',
46 passphrase => '9,Pass Phrase,yesno',
47 addr => '0,Full Address',
48 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
49 xpert => '0,Expert Status,yesno',
51 node => '0,Last Node',
52 homenode => '0,Home Node',
53 lockout => '9,Locked out?,yesno', # won't let them in at all
54 dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
55 annok => '9,Accept Announces?,yesno', # accept his announces?
57 hmsgno => '0,Highest Msgno',
58 group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
59 buddies => '0,Buddies,parray',
60 isolate => '9,Isolate network,yesno',
61 wantbeep => '0,Req Beep,yesno',
62 wantann => '0,Req Announce,yesno',
63 wantwwv => '0,Req WWV,yesno',
64 wantwcy => '0,Req WCY,yesno',
65 wantecho => '0,Req Echo,yesno',
66 wanttalk => '0,Req Talk,yesno',
67 wantwx => '0,Req WX,yesno',
68 wantdx => '0,Req DX Spots,yesno',
69 wantemail => '0,Req Msgs as Email,yesno',
70 pagelth => '0,Current Pagelth',
71 pingint => '9,Node Ping interval',
72 nopings => '9,Ping Obs Count',
73 wantlogininfo => '0,Login Info Req,yesno',
74 wantgrid => '0,Show DX Grid,yesno',
75 wantann_talk => '0,Talklike Anns,yesno',
76 wantpc16 => '9,Want Users from node,yesno',
77 wantsendpc16 => '9,Send PC16,yesno',
78 wantroutepc19 => '9,Route PC19,yesno',
79 wantusstate => '0,Show US State,yesno',
80 wantdxcq => '0,Show CQ Zone,yesno',
81 wantdxitu => '0,Show ITU Zone,yesno',
82 wantgtk => '0,Want GTK interface,yesno',
83 wantpc9x => '0,Want PC9X interface,yesno',
84 lastoper => '9,Last for/oper,cldatetime',
85 nothere => '0,Not Here Text',
86 registered => '9,Registered?,yesno',
87 prompt => '0,Required Prompt',
88 version => '1,Version',
90 believe => '1,Believable nodes,parray',
91 lastping => '1,Last Ping at,ptimelist',
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)";
133 dbg("the module Storable appears to be missing!!");
134 dbg("trying to continue in compatibility mode (this may fail)");
135 dbg("please install Storable from CPAN as soon as possible");
137 import Storable qw(nfreeze thaw);
141 $convert++ if -e "$fn.v2" && !-e $ufn;
145 $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?]";
147 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
150 die "Cannot open $ufn ($!)\n" unless $dbm;
152 $lru = LRU->newbase("DXUser", $lrusize);
154 # do a conversion if required
155 if ($dbm && $convert) {
156 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
159 dbg("Converting the User File to V3 ");
160 dbg("This will take a while, I suggest you go and have cup of strong tea");
161 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?]";
162 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
163 my $ref = asc_decode($val);
173 dbg("Conversion completed $count records $err errors");
182 confess "need a filename in User" if !$fn;
183 $fn .= $v3 ? ".v3" : ".v2";
188 # periodic processing
192 if ($main::systime > $lasttime + 15) {
194 $lasttime = $main::systime;
209 # new - create a new user
216 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
224 # $call =~ s/-\d+$//o;
226 # confess "can't create existing call $call in User\n!" if $u{$call};
228 my $self = $pkg->alloc($call);
234 # get - get an existing user - this seems to return a different reference everytime it is
243 # is it in the LRU cache?
244 my $ref = $lru->get($call);
248 unless ($dbm->get($call, $data)) {
249 $ref = decode($data);
250 dbg("DXUser::get: data error on $call $!") unless $ref;
251 if ($ref && ref $ref ne 'DXUser') {
252 dbg("DXUser::get: got strange answer from decode ". ref $ref. " ignoring");
255 $lru->put($call, $ref);
262 # get an existing either from the channel (if there is one) or from the database
264 # It is important to note that if you have done a get (for the channel say) and you
265 # want access or modify that you must use this call (and you must NOT use get's all
266 # over the place willy nilly!)
273 my $dxchan = DXChannel::get($call);
274 return $dxchan->user if $dxchan;
279 # get all callsigns in the database
284 return (sort keys %u);
294 confess "Trying to put nothing!" unless $self && ref $self;
295 my $call = $self->{call};
296 # delete all instances of this
297 # for ($dbm->get_dup($call)) {
298 # $dbm->del_dup($call, $_);
301 delete $self->{annok} if $self->{annok};
302 delete $self->{dxok} if $self->{dxok};
303 $lru->put($call, $self);
304 my $ref = $self->encode;
305 $dbm->put($call, $ref);
311 goto &asc_encode unless $v3;
313 return nfreeze($self);
319 goto &asc_decode unless $v3;
324 # create a string from a user reference (in_ascii)
333 # create a hash from a string (in ascii)
339 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
349 # del - delete a user
355 my $call = $self->{call};
356 # delete all instances of this
357 # for ($dbm->get_dup($call)) {
358 # $dbm->del_dup($call, $_);
365 # close - close down a user
371 $self->{lastin} = time;
385 # return a list of valid elements
395 # export the database to an ascii file
403 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
404 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
405 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
406 rename "$fn.o", "$fn.oo" if -e "$fn.o";
407 rename "$fn", "$fn.o" if -e "$fn";
412 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
417 my $t = scalar localtime;
418 print $fh q{#!/usr/bin/perl
420 # The exported userfile for a DXSpider System
422 # Input file: $filename
428 # search local then perl directories
432 # root of directory tree for this system
434 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
436 unshift @INC, "$root/perl"; # this IS the right way round!
437 unshift @INC, "$root/local";
439 # try to detect a lockfile (this isn't atomic but
441 $lockfn = "$root/local/cluster.lck"; # lock file name
443 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
446 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
457 $main::userfn = shift @ARGV;
458 print "user filename now $userfn\n";
461 DXUser->del_file($main::userfn);
462 DXUser->init($main::userfn, 1);
469 my $ref = asc_decode($f[1]);
474 print "# Error: $f[0]\t$f[1]\n";
478 DXUser->sync; DXUser->finish;
479 print "There are $count user records and $err errors\n";
481 print $fh "__DATA__\n";
483 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
484 if (!is_callsign($key) || $key =~ /^0/) {
487 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
488 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
489 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
490 eval {$dbm->del($key)};
491 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
495 my $ref = decode($val);
497 my $t = $ref->{lastin} || 0;
498 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
499 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
500 eval {$dbm->del($key)};
501 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
502 LogDbg('DXCommand', "$ref->{call} deleted, too old");
507 # only store users that are reasonably active or have useful information
508 print $fh "$key\t" . $ref->asc_encode . "\n";
511 LogDbg('DXCommand', "Export Error3: $key\t$val");
512 eval {$dbm->del($key)};
513 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
519 return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
526 # add one or more groups
530 my $ref = $self->{group} || [ 'local' ];
531 $self->{group} = $ref if !$self->{group};
532 push @$ref, @_ if @_;
535 # remove one or more groups
539 my $ref = $self->{group} || [ 'local' ];
542 $self->{group} = $ref if !$self->{group};
544 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
547 # does this thing contain all the groups listed?
551 my $ref = $self->{group};
554 return 0 if !$ref || @_ == 0;
555 return 1 if @$ref == 0 && @_ == 0;
556 for ($n = 0; $n < @_; ) {
559 $n++ if grep $_ eq $a, @_;
565 # simplified group test just for one group
570 my $ref = $self->{group};
573 return grep $_ eq $s, $ref;
576 # set up a default group (only happens for them's that connect direct)
580 $self->{group} = [ 'local' ];
583 # set up empty buddies (only happens for them's that connect direct)
587 $self->{buddies} = [ ];
591 # return a prompt for a field
596 my ($self, $ele) = @_;
600 # some variable accessors
604 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
609 # want is default = 1
616 $self->{$s} = $val if defined $val;
617 return exists $self->{$s} ? $self->{$s} : 1;
620 # wantnot is default = 0
627 $self->{$s} = $val if defined $val;
628 return exists $self->{$s} ? $self->{$s} : 0;
633 return _want('beep', @_);
638 return _want('ann', @_);
643 return _want('wwv', @_);
648 return _want('wcy', @_);
653 return _want('echo', @_);
658 return _want('wx', @_);
663 return _want('dx', @_);
668 return _want('talk', @_);
673 return _want('grid', @_);
678 return _want('email', @_);
683 return _want('ann_talk', @_);
688 return _want('pc16', @_);
693 return _want('sendpc16', @_);
698 return _want('routepc16', @_);
703 return _want('usstate', @_);
708 return _want('dxcq', @_);
713 return _want('dxitu', @_);
718 return _want('gtk', @_);
723 return _want('pc9x', @_);
730 $self->{wantlogininfo} = $val if defined $val;
731 return $self->{wantlogininfo};
737 return $self->{sort} =~ /[ACRSX]/;
743 return grep $_ eq 'local_node', @{$self->{group}};
749 return $self->{sort} eq 'U';
755 return $self->{sort} eq 'B';
761 return $self->{sort} eq 'S';
767 return $self->{sort} eq 'C';
773 return $self->{sort} eq 'X';
779 return $self->{sort} eq 'R';
785 return $self->{sort} eq 'A';
791 delete $self->{passwd};
797 delete $self->{passphrase};
804 $self->{believe} ||= [];
805 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
812 if (exists $self->{believe}) {
813 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
814 delete $self->{believe} unless @{$self->{believe}};
821 return exists $self->{believe} ? @{$self->{believe}} : ();
828 $self->{lastping} ||= {};
829 $self->{lastping} = {} unless ref $self->{lastping};
830 my $b = $self->{lastping};
831 $b->{$call} = shift if @_;