2 # DX cluster user routines
4 # Copyright (c) 1998 - Dirk Koopman G1TLH
23 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
28 $lastoperinterval = 60*24*60*60;
31 $tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
34 # hash of valid elements and a simple prompt
37 alias => '0,Real Callsign',
40 lat => '0,Latitude,slat',
41 long => '0,Longitude,slong',
43 email => '0,E-mail Address,parray',
44 priv => '9,Privilege Level',
45 lastin => '0,Last Time in,cldatetime',
46 passwd => '9,Password,yesno',
47 passphrase => '9,Pass Phrase,yesno',
48 addr => '0,Full Address',
49 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
50 xpert => '0,Expert Status,yesno',
52 node => '0,Last Node',
53 homenode => '0,Home Node',
54 lockout => '9,Locked out?,yesno', # won't let them in at all
55 dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
56 annok => '9,Accept Announces?,yesno', # accept his announces?
58 hmsgno => '0,Highest Msgno',
59 group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
60 buddies => '0,Buddies,parray',
61 isolate => '9,Isolate network,yesno',
62 wantbeep => '0,Req Beep,yesno',
63 wantann => '0,Req Announce,yesno',
64 wantwwv => '0,Req WWV,yesno',
65 wantwcy => '0,Req WCY,yesno',
66 wantecho => '0,Req Echo,yesno',
67 wanttalk => '0,Req Talk,yesno',
68 wantwx => '0,Req WX,yesno',
69 wantdx => '0,Req DX Spots,yesno',
70 wantemail => '0,Req Msgs as Email,yesno',
71 pagelth => '0,Current Pagelth',
72 pingint => '9,Node Ping interval',
73 nopings => '9,Ping Obs Count',
74 wantlogininfo => '0,Login Info Req,yesno',
75 wantgrid => '0,Show DX Grid,yesno',
76 wantann_talk => '0,Talklike Anns,yesno',
77 wantpc16 => '9,Want Users from node,yesno',
78 wantsendpc16 => '9,Send PC16,yesno',
79 wantroutepc19 => '9,Route PC19,yesno',
80 wantusstate => '0,Show US State,yesno',
81 wantdxcq => '0,Show CQ Zone,yesno',
82 wantdxitu => '0,Show ITU Zone,yesno',
83 wantgtk => '0,Want GTK interface,yesno',
84 wantpc9x => '0,Want PC9X interface,yesno',
85 lastoper => '9,Last for/oper,cldatetime',
86 nothere => '0,Not Here Text',
87 registered => '9,Registered?,yesno',
88 prompt => '0,Required Prompt',
89 version => '1,Version',
91 believe => '1,Believable nodes,parray',
92 lastping => '1,Last Ping at,ptimelist',
93 maxconnect => '1,Max Connections',
100 my $name = $AUTOLOAD;
102 return if $name =~ /::DESTROY$/;
105 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
106 # this clever line of code creates a subroutine which takes over from autoload
107 # from OO Perl - Conway
108 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
115 # initialise the system
131 $ufn = localdata("users.v2");
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);
139 $ufn = localdata("users.v3");
141 $convert++ if -e localdata("users.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', localdata("users.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) {
164 eval { $ref = asc_decode($val) };
173 Log('err', "DXUser: error decoding $@");
178 dbg("Conversion completed $count records $err errors");
185 # with extreme prejudice
186 unlink "$main::data/users.v3";
187 unlink "$main::local_data/users.v3";
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
246 # is it in the LRU cache?
247 my $ref = $lru->get($call);
248 return $ref if $ref && ref $ref eq 'DXUser';
251 unless ($dbm->get($call, $data)) {
252 eval { $ref = decode($data); };
255 if (!UNIVERSAL::isa($ref, 'DXUser')) {
256 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
259 # we have a reference and it *is* a DXUser
262 LogDbg('err', "DXUser::get decode error on $call '$@'");
264 dbg("DXUser::get: no reference returned from decode of $call $!");
268 $lru->put($call, $ref);
275 # get an existing either from the channel (if there is one) or from the database
277 # It is important to note that if you have done a get (for the channel say) and you
278 # want access or modify that you must use this call (and you must NOT use get's all
279 # over the place willy nilly!)
286 my $dxchan = DXChannel::get($call);
288 my $ref = $dxchan->user;
289 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
291 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
297 # get all callsigns in the database
302 return (sort keys %u);
312 confess "Trying to put nothing!" unless $self && ref $self;
313 my $call = $self->{call};
316 delete $self->{annok} if $self->{annok};
317 delete $self->{dxok} if $self->{dxok};
319 $lru->put($call, $self);
320 my $ref = $self->encode;
321 $dbm->put($call, $ref);
327 goto &asc_encode unless $v3;
329 return nfreeze($self);
335 goto &asc_decode unless $v3;
342 # create a string from a user reference (in_ascii)
351 my $ref = bless {}, ref $self;
352 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
353 $ref->{$k} = $self->{$k} if exists $self->{$k};
355 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
364 # create a hash from a string (in ascii)
370 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
373 LogDbg('err', "DXUser::asc_decode: on '$s' $@");
380 # del - delete a user
386 my $call = $self->{call};
392 # close - close down a user
398 $self->{lastin} = time;
412 # return a list of valid elements
422 # export the database to an ascii file
427 my $name = shift || 'user_asc';
428 my $basic_info_only = shift;
430 my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name"; # force use of local
433 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
434 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
435 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
436 move "$fn.o", "$fn.oo" if -e "$fn.o";
437 move "$fn", "$fn.o" if -e "$fn";
442 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
447 my $t = scalar localtime;
448 print $fh q{#!/usr/bin/perl
450 # The exported userfile for a DXSpider System
452 # Input file: $filename
458 # search local then perl directories
462 # root of directory tree for this system
464 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
466 unshift @INC, "$root/perl"; # this IS the right way round!
467 unshift @INC, "$root/local";
469 # try to detect a lockfile (this isn't atomic but
471 $lockfn = "$root/local_data/cluster.lck"; # lock file name
473 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
476 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
485 $main::userfn = shift @ARGV;
486 print "user filename now $userfn\n";
499 my $ref = asc_decode($f[1]);
503 DXUser::sync() unless $count % 10000;
505 print "# Error: $f[0]\t$f[1]\n";
509 DXUser::sync(); DXUser::finish();
510 print "There are $count user records and $err errors\n";
512 print $fh "__DATA__\n";
514 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
515 if (!is_callsign($key) || $key =~ /^0/) {
518 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
519 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
520 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
521 eval {$dbm->del($key)};
522 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
527 eval {$ref = decode($val); };
529 my $t = $ref->{lastin} || 0;
530 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
531 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
532 eval {$dbm->del($key)};
533 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
534 LogDbg('DXCommand', "$ref->{call} deleted, too old");
539 # only store users that are reasonably active or have useful information
540 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
543 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
544 eval {$dbm->del($key)};
545 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
551 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
552 LogDbg('command', $s);
560 # add one or more groups
564 my $ref = $self->{group} || [ 'local' ];
565 $self->{group} = $ref if !$self->{group};
566 push @$ref, @_ if @_;
569 # remove one or more groups
573 my $ref = $self->{group} || [ 'local' ];
576 $self->{group} = $ref if !$self->{group};
578 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
581 # does this thing contain all the groups listed?
585 my $ref = $self->{group};
588 return 0 if !$ref || @_ == 0;
589 return 1 if @$ref == 0 && @_ == 0;
590 for ($n = 0; $n < @_; ) {
593 $n++ if grep $_ eq $a, @_;
599 # simplified group test just for one group
604 my $ref = $self->{group};
607 return grep $_ eq $s, $ref;
610 # set up a default group (only happens for them's that connect direct)
614 $self->{group} = [ 'local' ];
617 # set up empty buddies (only happens for them's that connect direct)
621 $self->{buddies} = [ ];
625 # return a prompt for a field
630 my ($self, $ele) = @_;
634 # some variable accessors
638 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
643 # want is default = 1
650 $self->{$s} = $val if defined $val;
651 return exists $self->{$s} ? $self->{$s} : 1;
654 # wantnot is default = 0
661 $self->{$s} = $val if defined $val;
662 return exists $self->{$s} ? $self->{$s} : 0;
667 return _want('beep', @_);
672 return _want('ann', @_);
677 return _want('wwv', @_);
682 return _want('wcy', @_);
687 return _want('echo', @_);
692 return _want('wx', @_);
697 return _want('dx', @_);
702 return _want('talk', @_);
707 return _want('grid', @_);
712 return _want('email', @_);
717 return _want('ann_talk', @_);
722 return _want('pc16', @_);
727 return _want('sendpc16', @_);
732 return _want('routepc16', @_);
737 return _want('usstate', @_);
742 return _want('dxcq', @_);
747 return _want('dxitu', @_);
752 return _want('gtk', @_);
757 return _want('pc9x', @_);
764 $self->{wantlogininfo} = $val if defined $val;
765 return $self->{wantlogininfo};
771 return $self->{sort} =~ /^[ACRSX]$/;
777 return grep $_ eq 'local_node', @{$self->{group}};
783 return $self->{sort} =~ /^[UW]$/;
789 return $self->{sort} eq 'W';
795 return $self->{sort} eq 'B';
801 return $self->{sort} eq 'S';
807 return $self->{sort} eq 'C';
813 return $self->{sort} eq 'X';
819 return $self->{sort} eq 'R';
825 return $self->{sort} eq 'A';
831 delete $self->{passwd};
837 delete $self->{passphrase};
844 $self->{believe} ||= [];
845 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
852 if (exists $self->{believe}) {
853 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
854 delete $self->{believe} unless @{$self->{believe}};
861 return exists $self->{believe} ? @{$self->{believe}} : ();
868 $self->{lastping} ||= {};
869 $self->{lastping} = {} unless ref $self->{lastping};
870 my $b = $self->{lastping};
871 $b->{$call} = shift if @_;