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',
92 maxconnect => '1,Max Connections',
101 return if $name =~ /::DESTROY$/;
104 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
105 # this clever line of code creates a subroutine which takes over from autoload
106 # from OO Perl - Conway
107 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
114 # initialise the system
118 my ($pkg, $fn, $mode) = @_;
120 confess "need a filename in User" if !$fn;
129 # eval "use Storable qw(nfreeze thaw)";
134 dbg("the module Storable appears to be missing!!");
135 dbg("trying to continue in compatibility mode (this may fail)");
136 dbg("please install Storable from CPAN as soon as possible");
138 import Storable qw(nfreeze thaw);
142 $convert++ if -e "$fn.v2" && !-e $ufn;
146 $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?]";
148 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
151 die "Cannot open $ufn ($!)\n" unless $dbm;
153 $lru = LRU->newbase("DXUser", $lrusize);
155 # do a conversion if required
156 if ($dbm && $convert) {
157 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
160 dbg("Converting the User File to V3 ");
161 dbg("This will take a while, I suggest you go and have cup of strong tea");
162 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?]";
163 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
164 my $ref = asc_decode($val);
174 dbg("Conversion completed $count records $err errors");
183 confess "need a filename in User" if !$fn;
184 $fn .= $v3 ? ".v3" : ".v2";
189 # periodic processing
193 if ($main::systime > $lasttime + 15) {
195 $lasttime = $main::systime;
210 # new - create a new user
217 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
225 # $call =~ s/-\d+$//o;
227 # confess "can't create existing call $call in User\n!" if $u{$call};
229 my $self = $pkg->alloc($call);
235 # get - get an existing user - this seems to return a different reference everytime it is
244 # is it in the LRU cache?
245 my $ref = $lru->get($call);
246 return $ref if $ref && ref $ref eq 'DXUser';
249 unless ($dbm->get($call, $data)) {
250 $ref = eval{decode($data)};
252 if (!UNIVERSAL::isa($ref, 'DXUser')) {
253 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
256 # we have a reference and it *is* a DXUser
258 dbg("DXUser::get: no reference returned from decode of $call $! $@");
261 $lru->put($call, $ref);
268 # get an existing either from the channel (if there is one) or from the database
270 # It is important to note that if you have done a get (for the channel say) and you
271 # want access or modify that you must use this call (and you must NOT use get's all
272 # over the place willy nilly!)
279 my $dxchan = DXChannel::get($call);
281 my $ref = $dxchan->user;
282 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
284 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
290 # get all callsigns in the database
295 return (sort keys %u);
305 confess "Trying to put nothing!" unless $self && ref $self;
306 my $call = $self->{call};
309 delete $self->{annok} if $self->{annok};
310 delete $self->{dxok} if $self->{dxok};
312 $lru->put($call, $self);
313 my $ref = $self->encode;
314 $dbm->put($call, $ref);
320 goto &asc_encode unless $v3;
322 return nfreeze($self);
328 goto &asc_decode unless $v3;
333 # create a string from a user reference (in_ascii)
342 my $ref = bless {}, ref $self;
343 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
344 $ref->{$k} = $self->{$k} if exists $self->{$k};
346 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
355 # create a hash from a string (in ascii)
361 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
371 # del - delete a user
377 my $call = $self->{call};
383 # close - close down a user
389 $self->{lastin} = time;
403 # return a list of valid elements
413 # export the database to an ascii file
419 my $basic_info_only = shift;
422 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
423 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
424 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
425 rename "$fn.o", "$fn.oo" if -e "$fn.o";
426 rename "$fn", "$fn.o" if -e "$fn";
431 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
436 my $t = scalar localtime;
437 print $fh q{#!/usr/bin/perl
439 # The exported userfile for a DXSpider System
441 # Input file: $filename
447 # search local then perl directories
451 # root of directory tree for this system
453 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
455 unshift @INC, "$root/perl"; # this IS the right way round!
456 unshift @INC, "$root/local";
458 # try to detect a lockfile (this isn't atomic but
460 $lockfn = "$root/local/cluster.lck"; # lock file name
462 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
465 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
476 $main::userfn = shift @ARGV;
477 print "user filename now $userfn\n";
480 DXUser->del_file($main::userfn);
481 DXUser->init($main::userfn, 1);
488 my $ref = asc_decode($f[1]);
493 print "# Error: $f[0]\t$f[1]\n";
497 DXUser->sync; DXUser->finish;
498 print "There are $count user records and $err errors\n";
500 print $fh "__DATA__\n";
502 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
503 if (!is_callsign($key) || $key =~ /^0/) {
506 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
507 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
508 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
509 eval {$dbm->del($key)};
510 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
514 my $ref = decode($val);
516 my $t = $ref->{lastin} || 0;
517 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
518 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
519 eval {$dbm->del($key)};
520 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
521 LogDbg('DXCommand', "$ref->{call} deleted, too old");
526 # only store users that are reasonably active or have useful information
527 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
530 LogDbg('DXCommand', "Export Error3: $key\t$val");
531 eval {$dbm->del($key)};
532 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
538 return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
545 # add one or more groups
549 my $ref = $self->{group} || [ 'local' ];
550 $self->{group} = $ref if !$self->{group};
551 push @$ref, @_ if @_;
554 # remove one or more groups
558 my $ref = $self->{group} || [ 'local' ];
561 $self->{group} = $ref if !$self->{group};
563 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
566 # does this thing contain all the groups listed?
570 my $ref = $self->{group};
573 return 0 if !$ref || @_ == 0;
574 return 1 if @$ref == 0 && @_ == 0;
575 for ($n = 0; $n < @_; ) {
578 $n++ if grep $_ eq $a, @_;
584 # simplified group test just for one group
589 my $ref = $self->{group};
592 return grep $_ eq $s, $ref;
595 # set up a default group (only happens for them's that connect direct)
599 $self->{group} = [ 'local' ];
602 # set up empty buddies (only happens for them's that connect direct)
606 $self->{buddies} = [ ];
610 # return a prompt for a field
615 my ($self, $ele) = @_;
619 # some variable accessors
623 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
628 # want is default = 1
635 $self->{$s} = $val if defined $val;
636 return exists $self->{$s} ? $self->{$s} : 1;
639 # wantnot is default = 0
646 $self->{$s} = $val if defined $val;
647 return exists $self->{$s} ? $self->{$s} : 0;
652 return _want('beep', @_);
657 return _want('ann', @_);
662 return _want('wwv', @_);
667 return _want('wcy', @_);
672 return _want('echo', @_);
677 return _want('wx', @_);
682 return _want('dx', @_);
687 return _want('talk', @_);
692 return _want('grid', @_);
697 return _want('email', @_);
702 return _want('ann_talk', @_);
707 return _want('pc16', @_);
712 return _want('sendpc16', @_);
717 return _want('routepc16', @_);
722 return _want('usstate', @_);
727 return _want('dxcq', @_);
732 return _want('dxitu', @_);
737 return _want('gtk', @_);
742 return _want('pc9x', @_);
749 $self->{wantlogininfo} = $val if defined $val;
750 return $self->{wantlogininfo};
756 return $self->{sort} =~ /[ACRSX]/;
762 return grep $_ eq 'local_node', @{$self->{group}};
768 return $self->{sort} eq 'U';
774 return $self->{sort} eq 'B';
780 return $self->{sort} eq 'S';
786 return $self->{sort} eq 'C';
792 return $self->{sort} eq 'X';
798 return $self->{sort} eq 'R';
804 return $self->{sort} eq 'A';
810 delete $self->{passwd};
816 delete $self->{passphrase};
823 $self->{believe} ||= [];
824 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
831 if (exists $self->{believe}) {
832 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
833 delete $self->{believe} unless @{$self->{believe}};
840 return exists $self->{believe} ? @{$self->{believe}} : ();
847 $self->{lastping} ||= {};
848 $self->{lastping} = {} unless ref $self->{lastping};
849 my $b = $self->{lastping};
850 $b->{$call} = shift if @_;