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 $noips);
28 $lastoperinterval = 60*24*60*60;
31 $tooold = 86400 * 365; # this marks an old user who hasn't given enough info to be useful
35 # hash of valid elements and a simple prompt
38 alias => '0,Real Callsign',
41 lat => '0,Latitude,slat',
42 long => '0,Longitude,slong',
44 email => '0,E-mail Address,parray',
45 priv => '9,Privilege Level',
46 lastin => '0,Last Time in,cldatetime',
47 passwd => '9,Password,yesno',
48 passphrase => '9,Pass Phrase,yesno',
49 addr => '0,Full Address',
50 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
51 xpert => '0,Expert Status,yesno',
53 node => '0,Last Node',
54 homenode => '0,Home Node',
55 lockout => '9,Locked out?,yesno', # won't let them in at all
56 dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
57 annok => '9,Accept Announces?,yesno', # accept his announces?
59 hmsgno => '0,Highest Msgno',
60 group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
61 buddies => '0,Buddies,parray',
62 isolate => '9,Isolate network,yesno',
63 wantbeep => '0,Req Beep,yesno',
64 wantann => '0,Req Announce,yesno',
65 wantwwv => '0,Req WWV,yesno',
66 wantwcy => '0,Req WCY,yesno',
67 wantecho => '0,Req Echo,yesno',
68 wanttalk => '0,Req Talk,yesno',
69 wantwx => '0,Req WX,yesno',
70 wantdx => '0,Req DX Spots,yesno',
71 wantemail => '0,Req Msgs as Email,yesno',
72 pagelth => '0,Current Pagelth',
73 pingint => '9,Node Ping interval',
74 nopings => '9,Ping Obs Count',
75 wantlogininfo => '0,Login Info Req,yesno',
76 wantgrid => '0,Show DX Grid,yesno',
77 wantann_talk => '0,Talklike Anns,yesno',
78 wantpc16 => '9,Want Users from node,yesno',
79 wantsendpc16 => '9,Send PC16,yesno',
80 wantroutepc19 => '9,Route PC19,yesno',
81 wantusstate => '0,Show US State,yesno',
82 wantdxcq => '0,Show CQ Zone,yesno',
83 wantdxitu => '0,Show ITU Zone,yesno',
84 wantgtk => '0,Want GTK interface,yesno',
85 wantpc9x => '0,Want PC9X interface,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',
92 believe => '1,Believable nodes,parray',
93 lastping => '1,Last Ping at,ptimelist',
94 maxconnect => '1,Max Connections',
102 my $name = $AUTOLOAD;
104 return if $name =~ /::DESTROY$/;
107 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
108 # this clever line of code creates a subroutine which takes over from autoload
109 # from OO Perl - Conway
110 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
117 # initialise the system
133 $ufn = localdata("users.v2");
135 dbg("the module Storable appears to be missing!!");
136 dbg("trying to continue in compatibility mode (this may fail)");
137 dbg("please install Storable from CPAN as soon as possible");
139 import Storable qw(nfreeze thaw);
141 $ufn = localdata("users.v3");
143 $convert++ if -e localdata("users.v2") && !-e $ufn;
147 $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?]";
149 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
152 die "Cannot open $ufn ($!)\n" unless $dbm;
154 $lru = LRU->newbase("DXUser", $lrusize);
156 # do a conversion if required
157 if ($dbm && $convert) {
158 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
161 dbg("Converting the User File to V3 ");
162 dbg("This will take a while, I suggest you go and have cup of strong tea");
163 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?]";
164 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
166 eval { $ref = asc_decode($val) };
175 Log('err', "DXUser: error decoding $@");
180 dbg("Conversion completed $count records $err errors");
187 # with extreme prejudice
188 unlink "$main::data/users.v3";
189 unlink "$main::local_data/users.v3";
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
248 # is it in the LRU cache?
249 my $ref = $lru->get($call);
250 return $ref if $ref && ref $ref eq 'DXUser';
253 unless ($dbm->get($call, $data)) {
254 eval { $ref = decode($data); };
257 if (!UNIVERSAL::isa($ref, 'DXUser')) {
258 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
261 # we have a reference and it *is* a DXUser
264 LogDbg('err', "DXUser::get decode error on $call '$@'");
266 dbg("DXUser::get: no reference returned from decode of $call $!");
270 $lru->put($call, $ref);
277 # get an existing either from the channel (if there is one) or from the database
279 # It is important to note that if you have done a get (for the channel say) and you
280 # want access or modify that you must use this call (and you must NOT use get's all
281 # over the place willy nilly!)
288 my $dxchan = DXChannel::get($call);
290 my $ref = $dxchan->user;
291 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
293 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
299 # get all callsigns in the database
304 return (sort keys %u);
314 confess "Trying to put nothing!" unless $self && ref $self;
315 my $call = $self->{call};
318 delete $self->{annok} if $self->{annok};
319 delete $self->{dxok} if $self->{dxok};
321 $lru->put($call, $self);
322 my $ref = $self->encode;
323 $dbm->put($call, $ref);
329 goto &asc_encode unless $v3;
331 return nfreeze($self);
337 goto &asc_decode unless $v3;
344 # create a string from a user reference (in_ascii)
353 my $ref = bless {}, ref $self;
354 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
355 $ref->{$k} = $self->{$k} if exists $self->{$k};
357 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
366 # create a hash from a string (in ascii)
372 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
375 LogDbg('err', "DXUser::asc_decode: on '$s' $@");
382 # del - delete a user
388 my $call = $self->{call};
394 # close - close down a user
400 $self->{lastin} = time;
414 # return a list of valid elements
424 # export the database to an ascii file
429 my $name = shift || 'user_asc';
430 my $basic_info_only = shift;
432 my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name"; # force use of local
435 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
436 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
437 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
438 move "$fn.o", "$fn.oo" if -e "$fn.o";
439 move "$fn", "$fn.o" if -e "$fn";
444 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
449 my $t = scalar localtime;
450 print $fh q{#!/usr/bin/perl
452 # The exported userfile for a DXSpider System
454 # Input file: $filename
460 # search local then perl directories
464 # root of directory tree for this system
466 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
468 unshift @INC, "$root/perl"; # this IS the right way round!
469 unshift @INC, "$root/local";
471 # try to detect a lockfile (this isn't atomic but
473 $lockfn = "$root/local_data/cluster.lck"; # lock file name
475 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
478 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
487 $main::userfn = shift @ARGV;
488 print "user filename now $userfn\n";
501 my $ref = asc_decode($f[1]);
505 DXUser::sync() unless $count % 10000;
507 print "# Error: $f[0]\t$f[1]\n";
511 DXUser::sync(); DXUser::finish();
512 print "There are $count user records and $err errors\n";
514 print $fh "__DATA__\n";
516 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
517 if (!is_callsign($key) || $key =~ /^0/) {
520 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
521 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
522 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
523 eval {$dbm->del($key)};
524 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
529 eval {$ref = decode($val); };
531 my $t = $ref->{lastin} || 0;
532 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
533 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
534 eval {$dbm->del($key)};
535 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
536 LogDbg('DXCommand', "$ref->{call} deleted, too old");
541 # only store users that are reasonably active or have useful information
542 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
545 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
546 eval {$dbm->del($key)};
547 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
553 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
554 LogDbg('command', $s);
562 # add one or more groups
566 my $ref = $self->{group} || [ 'local' ];
567 $self->{group} = $ref if !$self->{group};
568 push @$ref, @_ if @_;
571 # remove one or more groups
575 my $ref = $self->{group} || [ 'local' ];
578 $self->{group} = $ref if !$self->{group};
580 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
583 # does this thing contain all the groups listed?
587 my $ref = $self->{group};
590 return 0 if !$ref || @_ == 0;
591 return 1 if @$ref == 0 && @_ == 0;
592 for ($n = 0; $n < @_; ) {
595 $n++ if grep $_ eq $a, @_;
601 # simplified group test just for one group
606 my $ref = $self->{group};
609 return grep $_ eq $s, $ref;
612 # set up a default group (only happens for them's that connect direct)
616 $self->{group} = [ 'local' ];
619 # set up empty buddies (only happens for them's that connect direct)
623 $self->{buddies} = [ ];
627 # return a prompt for a field
632 my ($self, $ele) = @_;
636 # some variable accessors
640 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
645 # want is default = 1
652 $self->{$s} = $val if defined $val;
653 return exists $self->{$s} ? $self->{$s} : 1;
656 # wantnot is default = 0
663 $self->{$s} = $val if defined $val;
664 return exists $self->{$s} ? $self->{$s} : 0;
669 return _want('beep', @_);
674 return _want('ann', @_);
679 return _want('wwv', @_);
684 return _want('wcy', @_);
689 return _want('echo', @_);
694 return _want('wx', @_);
699 return _want('dx', @_);
704 return _want('talk', @_);
709 return _want('grid', @_);
714 return _want('email', @_);
719 return _want('ann_talk', @_);
724 return _want('pc16', @_);
729 return _want('sendpc16', @_);
734 return _want('routepc16', @_);
739 return _want('usstate', @_);
744 return _want('dxcq', @_);
749 return _want('dxitu', @_);
754 return _want('gtk', @_);
759 return _want('pc9x', @_);
766 $self->{wantlogininfo} = $val if defined $val;
767 return $self->{wantlogininfo};
773 return $self->{sort} =~ /^[ACRSX]$/;
779 return grep $_ eq 'local_node', @{$self->{group}};
785 return $self->{sort} =~ /^[UW]$/;
791 return $self->{sort} eq 'W';
797 return $self->{sort} eq 'B';
803 return $self->{sort} eq 'S';
809 return $self->{sort} eq 'C';
815 return $self->{sort} eq 'X';
821 return $self->{sort} eq 'R';
827 return $self->{sort} eq 'A';
833 delete $self->{passwd};
839 delete $self->{passphrase};
846 $self->{believe} ||= [];
847 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
854 if (exists $self->{believe}) {
855 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
856 delete $self->{believe} unless @{$self->{believe}};
863 return exists $self->{believe} ? @{$self->{believe}} : ();
870 $self->{lastping} ||= {};
871 $self->{lastping} = {} unless ref $self->{lastping};
872 my $b = $self->{lastping};
873 $b->{$call} = shift if @_;