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
33 our $maxconnlist = 3; # remember this many connection time (duration) [start, end] pairs
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 wantrbn => '0,Want RBN spots,yesno',
87 wantft => '0,Want RBN FT4/8,yesno',
88 wantcw => '0,Want RBN CW,yesno',
89 wantrtty => '0,Want RBN RTTY,yesno',
90 wantpsk => '0,Want RBN PSK,yesno',
91 wantbeacon => '0,Want (RBN) Beacon,yesno',
92 lastoper => '9,Last for/oper,cldatetime',
93 nothere => '0,Not Here Text',
94 registered => '9,Registered?,yesno',
95 prompt => '0,Required Prompt',
96 version => '1,Version',
98 believe => '1,Believable nodes,parray',
99 lastping => '1,Last Ping at,ptimelist',
100 maxconnect => '1,Max Connections',
101 startt => '0,Start Time,cldatetime',
102 connlist => '1,Connections,parraydifft',
109 my $name = $AUTOLOAD;
111 return if $name =~ /::DESTROY$/;
114 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
115 # this clever line of code creates a subroutine which takes over from autoload
116 # from OO Perl - Conway
117 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
124 # initialise the system
140 $ufn = localdata("users.v2");
142 dbg("the module Storable appears to be missing!!");
143 dbg("trying to continue in compatibility mode (this may fail)");
144 dbg("please install Storable from CPAN as soon as possible");
146 import Storable qw(nfreeze thaw);
148 $ufn = localdata("users.v3");
150 $convert++ if -e localdata("users.v2") && !-e $ufn;
154 $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?]";
156 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
159 die "Cannot open $ufn ($!)\n" unless $dbm;
161 $lru = LRU->newbase("DXUser", $lrusize);
163 # do a conversion if required
164 if ($dbm && $convert) {
165 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
168 dbg("Converting the User File to V3 ");
169 dbg("This will take a while, I suggest you go and have cup of strong tea");
170 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?]";
171 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
173 eval { $ref = asc_decode($val) };
182 Log('err', "DXUser: error decoding $@");
187 dbg("Conversion completed $count records $err errors");
194 # with extreme prejudice
195 unlink "$main::data/users.v3";
196 unlink "$main::local_data/users.v3";
200 # periodic processing
204 if ($main::systime > $lasttime + 15) {
206 $lasttime = $main::systime;
221 # new - create a new user
228 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
236 # $call =~ s/-\d+$//o;
238 # confess "can't create existing call $call in User\n!" if $u{$call};
240 my $self = $pkg->alloc($call);
246 # get - get an existing user - this seems to return a different reference everytime it is
255 # is it in the LRU cache?
256 my $ref = $lru->get($call);
257 return $ref if $ref && ref $ref eq 'DXUser';
260 unless ($dbm->get($call, $data)) {
261 eval { $ref = decode($data); };
264 if (!UNIVERSAL::isa($ref, 'DXUser')) {
265 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
268 # we have a reference and it *is* a DXUser
271 LogDbg('err', "DXUser::get decode error on $call '$@'");
273 dbg("DXUser::get: no reference returned from decode of $call $!");
277 $lru->put($call, $ref);
284 # get an existing either from the channel (if there is one) or from the database
286 # It is important to note that if you have done a get (for the channel say) and you
287 # want access or modify that you must use this call (and you must NOT use get's all
288 # over the place willy nilly!)
295 my $dxchan = DXChannel::get($call);
297 my $ref = $dxchan->user;
298 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
300 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
306 # get all callsigns in the database
311 return (sort keys %u);
321 confess "Trying to put nothing!" unless $self && ref $self;
322 my $call = $self->{call};
325 delete $self->{annok} if $self->{annok};
326 delete $self->{dxok} if $self->{dxok};
328 $lru->put($call, $self);
329 my $ref = $self->encode;
330 $dbm->put($call, $ref);
336 goto &asc_encode unless $v3;
338 return nfreeze($self);
344 goto &asc_decode unless $v3;
351 # create a string from a user reference (in_ascii)
360 my $ref = bless {}, ref $self;
361 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
362 $ref->{$k} = $self->{$k} if exists $self->{$k};
364 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
373 # create a hash from a string (in ascii)
379 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
382 LogDbg('err', "DXUser::asc_decode: on '$s' $@");
389 # del - delete a user
395 my $call = $self->{call};
401 # close - close down a user
409 $self->{lastin} = $main::systime;
410 # add a record to the connect list
411 my $ref = [$startt || $self->{startt}, $main::systime];
412 push @$ref, $ip if $ip;
413 push @{$self->{connlist}}, $ref;
414 shift @{$self->{connlist}} if @{$self->{connlist}} > $maxconnlist;
428 # return a list of valid elements
438 # export the database to an ascii file
443 my $name = shift || 'user_asc';
444 my $basic_info_only = shift;
446 my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name"; # force use of local
449 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
450 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
451 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
452 move "$fn.o", "$fn.oo" if -e "$fn.o";
453 move "$fn", "$fn.o" if -e "$fn";
458 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
463 my $t = scalar localtime;
464 print $fh q{#!/usr/bin/perl
466 # The exported userfile for a DXSpider System
468 # Input file: $filename
474 # search local then perl directories
478 # root of directory tree for this system
480 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
482 unshift @INC, "$root/perl"; # this IS the right way round!
483 unshift @INC, "$root/local";
485 # try to detect a lockfile (this isn't atomic but
487 $lockfn = "$root/local_data/cluster.lck"; # lock file name
489 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
492 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
501 $main::userfn = shift @ARGV;
502 print "user filename now $userfn\n";
515 my $ref = asc_decode($f[1]);
519 DXUser::sync() unless $count % 10000;
521 print "# Error: $f[0]\t$f[1]\n";
525 DXUser::sync(); DXUser::finish();
526 print "There are $count user records and $err errors\n";
528 print $fh "__DATA__\n";
530 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
531 if (!is_callsign($key) || $key =~ /^0/) {
534 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
535 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
536 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
537 eval {$dbm->del($key)};
538 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
543 eval {$ref = decode($val); };
545 my $t = $ref->{lastin} || 0;
546 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
547 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
548 eval {$dbm->del($key)};
549 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
550 LogDbg('DXCommand', "$ref->{call} deleted, too old");
555 # only store users that are reasonably active or have useful information
556 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
559 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
560 eval {$dbm->del($key)};
561 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
567 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
568 LogDbg('command', $s);
576 # add one or more groups
580 my $ref = $self->{group} || [ 'local' ];
581 $self->{group} = $ref if !$self->{group};
582 push @$ref, @_ if @_;
585 # remove one or more groups
589 my $ref = $self->{group} || [ 'local' ];
592 $self->{group} = $ref if !$self->{group};
594 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
597 # does this thing contain all the groups listed?
601 my $ref = $self->{group};
604 return 0 if !$ref || @_ == 0;
605 return 1 if @$ref == 0 && @_ == 0;
606 for ($n = 0; $n < @_; ) {
609 $n++ if grep $_ eq $a, @_;
615 # simplified group test just for one group
620 my $ref = $self->{group};
623 return grep $_ eq $s, $ref;
626 # set up a default group (only happens for them's that connect direct)
630 $self->{group} = [ 'local' ];
633 # set up empty buddies (only happens for them's that connect direct)
637 $self->{buddies} = [ ];
641 # return a prompt for a field
646 my ($self, $ele) = @_;
650 # some variable accessors
654 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
659 # want is default = 1
666 $self->{$s} = $val if defined $val;
667 return exists $self->{$s} ? $self->{$s} : 1;
670 # wantnot is default = 0
677 $self->{$s} = $val if defined $val;
678 return exists $self->{$s} ? $self->{$s} : 0;
683 return _want('beep', @_);
688 return _want('ann', @_);
693 return _want('wwv', @_);
698 return _want('wcy', @_);
703 return _want('echo', @_);
708 return _want('wx', @_);
713 return _want('dx', @_);
718 return _want('talk', @_);
723 return _want('grid', @_);
728 return _want('email', @_);
733 return _want('ann_talk', @_);
738 return _want('pc16', @_);
743 return _want('sendpc16', @_);
748 return _want('routepc16', @_);
753 return _want('usstate', @_);
758 return _want('dxcq', @_);
763 return _want('dxitu', @_);
768 return _want('gtk', @_);
773 return _want('pc9x', @_);
780 $self->{wantlogininfo} = $val if defined $val;
781 return $self->{wantlogininfo};
787 return $self->{sort} =~ /^[ACRSX]$/;
793 return grep $_ eq 'local_node', @{$self->{group}};
799 return $self->{sort} =~ /^[UW]$/;
805 return $self->{sort} eq 'W';
811 return $self->{sort} eq 'B';
817 return $self->{sort} eq 'S';
823 return $self->{sort} eq 'C';
829 return $self->{sort} eq 'X';
835 return $self->{sort} eq 'R';
841 return $self->{sort} eq 'A';
847 return $self->{sort} eq 'N'
853 delete $self->{passwd};
859 delete $self->{passphrase};
866 $self->{believe} ||= [];
867 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
874 if (exists $self->{believe}) {
875 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
876 delete $self->{believe} unless @{$self->{believe}};
883 return exists $self->{believe} ? @{$self->{believe}} : ();
890 $self->{lastping} ||= {};
891 $self->{lastping} = {} unless ref $self->{lastping};
892 my $b = $self->{lastping};
893 $b->{$call} = shift if @_;