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 lastseen => '0,Last Seen,cldatetime',
48 passwd => '9,Password,yesno',
49 passphrase => '9,Pass Phrase,yesno',
50 addr => '0,Full Address',
51 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
52 xpert => '0,Expert Status,yesno',
54 node => '0,Last Node',
55 homenode => '0,Home Node',
56 lockout => '9,Locked out?,yesno', # won't let them in at all
57 dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
58 annok => '9,Accept Announces?,yesno', # accept his announces?
60 hmsgno => '0,Highest Msgno',
61 group => '0,Group,parray', # used to create a group of users/nodes for some purpose or other
62 buddies => '0,Buddies,parray',
63 isolate => '9,Isolate network,yesno',
64 wantbeep => '0,Req Beep,yesno',
65 wantann => '0,Req Announce,yesno',
66 wantwwv => '0,Req WWV,yesno',
67 wantwcy => '0,Req WCY,yesno',
68 wantecho => '0,Req Echo,yesno',
69 wanttalk => '0,Req Talk,yesno',
70 wantwx => '0,Req WX,yesno',
71 wantdx => '0,Req DX Spots,yesno',
72 wantemail => '0,Req Msgs as Email,yesno',
73 pagelth => '0,Current Pagelth',
74 pingint => '9,Node Ping interval',
75 nopings => '9,Ping Obs Count',
76 wantlogininfo => '0,Login Info Req,yesno',
77 wantgrid => '0,Show DX Grid,yesno',
78 wantann_talk => '0,Talklike Anns,yesno',
79 wantpc16 => '9,Want Users from node,yesno',
80 wantsendpc16 => '9,Send PC16,yesno',
81 wantroutepc19 => '9,Route PC19,yesno',
82 wantusstate => '0,Show US State,yesno',
83 wantdxcq => '0,Show CQ Zone,yesno',
84 wantdxitu => '0,Show ITU Zone,yesno',
85 wantgtk => '0,Want GTK interface,yesno',
86 wantpc9x => '0,Want PC9X interface,yesno',
87 wantrbn => '0,Want RBN spots,yesno',
88 wantft => '0,Want RBN FT4/8,yesno',
89 wantcw => '0,Want RBN CW,yesno',
90 wantrtty => '0,Want RBN RTTY,yesno',
91 wantpsk => '0,Want RBN PSK,yesno',
92 wantbeacon => '0,Want (RBN) Beacon,yesno',
93 lastoper => '9,Last for/oper,cldatetime',
94 nothere => '0,Not Here Text',
95 registered => '9,Registered?,yesno',
96 prompt => '0,Required Prompt',
97 version => '1,Version',
99 believe => '1,Believable nodes,parray',
100 lastping => '1,Last Ping at,ptimelist',
101 maxconnect => '1,Max Connections',
102 startt => '0,Start Time,cldatetime',
103 connlist => '1,Connections,parraydifft',
104 width => '0,Preferred Width'
111 my $name = $AUTOLOAD;
113 return if $name =~ /::DESTROY$/;
116 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
117 # this clever line of code creates a subroutine which takes over from autoload
118 # from OO Perl - Conway
119 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
126 # initialise the system
142 $ufn = localdata("users.v2");
144 dbg("the module Storable appears to be missing!!");
145 dbg("trying to continue in compatibility mode (this may fail)");
146 dbg("please install Storable from CPAN as soon as possible");
148 import Storable qw(nfreeze thaw);
150 $ufn = localdata("users.v3");
152 $convert++ if -e localdata("users.v2") && !-e $ufn;
156 $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?]";
158 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
161 die "Cannot open $ufn ($!)\n" unless $dbm;
163 $lru = LRU->newbase("DXUser", $lrusize);
165 # do a conversion if required
166 if ($dbm && $convert) {
167 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
170 dbg("Converting the User File to V3 ");
171 dbg("This will take a while, I suggest you go and have cup of strong tea");
172 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?]";
173 for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
175 eval { $ref = asc_decode($val) };
184 Log('err', "DXUser: error decoding $@");
189 dbg("Conversion completed $count records $err errors");
196 # with extreme prejudice
197 unlink "$main::data/users.v3";
198 unlink "$main::local_data/users.v3";
202 # periodic processing
206 if ($main::systime > $lasttime + 15) {
208 $lasttime = $main::systime;
224 # new - create a new user
231 my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
239 # $call =~ s/-\d+$//o;
241 # confess "can't create existing call $call in User\n!" if $u{$call};
243 my $self = $pkg->alloc($call);
244 $self->{lastseen} = $main::systime;
250 # get - get an existing user - this seems to return a different reference everytime it is
259 # is it in the LRU cache?
260 my $ref = $lru->get($call);
261 if ($ref && ref $ref eq 'DXUser') {
262 $ref->{lastseen} = $main::systime;
267 unless ($dbm->get($call, $data)) {
268 eval { $ref = decode($data); };
271 if (!UNIVERSAL::isa($ref, 'DXUser')) {
272 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
275 # we have a reference and it *is* a DXUser
278 LogDbg('err', "DXUser::get decode error on $call '$@'");
280 dbg("DXUser::get: no reference returned from decode of $call $!");
284 $ref->{lastseen} = $main::systime;
285 $lru->put($call, $ref);
292 # get an existing either from the channel (if there is one) or from the database
294 # It is important to note that if you have done a get (for the channel say) and you
295 # want access or modify that you must use this call (and you must NOT use get's all
296 # over the place willy nilly!)
303 my $dxchan = DXChannel::get($call);
305 my $ref = $dxchan->user;
306 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
308 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
314 # get all callsigns in the database
319 return (sort keys %u);
329 confess "Trying to put nothing!" unless $self && ref $self;
330 my $call = $self->{call};
333 delete $self->{annok} if $self->{annok};
334 delete $self->{dxok} if $self->{dxok};
336 $lru->put($call, $self);
337 my $ref = $self->encode;
338 $dbm->put($call, $ref);
344 goto &asc_encode unless $v3;
346 return nfreeze($self);
352 goto &asc_decode unless $v3;
359 # create a string from a user reference (in_ascii)
368 my $ref = bless {}, ref $self;
369 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
370 $ref->{$k} = $self->{$k} if exists $self->{$k};
372 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
381 # create a hash from a string (in ascii)
387 $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
390 LogDbg('err', "DXUser::asc_decode: on '$s' $@");
397 # del - delete a user
403 my $call = $self->{call};
409 # close - close down a user
417 $self->{lastseen} = $self->{lastin} = $main::systime;
418 # add a record to the connect list
419 my $ref = [$startt || $self->{startt}, $main::systime];
420 push @$ref, $ip if $ip;
421 push @{$self->{connlist}}, $ref;
422 shift @{$self->{connlist}} if @{$self->{connlist}} > $maxconnlist;
436 # return a list of valid elements
446 # export the database to an ascii file
451 my $name = shift || 'user_asc';
452 my $basic_info_only = shift;
454 my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name"; # force use of local
457 move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
458 move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
459 move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
460 move "$fn.o", "$fn.oo" if -e "$fn.o";
461 move "$fn", "$fn.o" if -e "$fn";
466 my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
471 my $t = scalar localtime;
472 print $fh q{#!/usr/bin/perl
474 # The exported userfile for a DXSpider System
476 # Input file: $filename
482 # search local then perl directories
486 # root of directory tree for this system
488 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
490 unshift @INC, "$root/perl"; # this IS the right way round!
491 unshift @INC, "$root/local";
493 # try to detect a lockfile (this isn't atomic but
495 $lockfn = "$root/local_data/cluster.lck"; # lock file name
497 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
500 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
509 $main::userfn = shift @ARGV;
510 print "user filename now $userfn\n";
523 my $ref = asc_decode($f[1]);
527 DXUser::sync() unless $count % 10000;
529 print "# Error: $f[0]\t$f[1]\n";
533 DXUser::sync(); DXUser::finish();
534 print "There are $count user records and $err errors\n";
536 print $fh "__DATA__\n";
538 for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
539 if (!is_callsign($key) || $key =~ /^0/) {
542 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
543 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
544 LogDbg('DXCommand', "Export Error1: invalid call '$key' => '$val'");
545 eval {$dbm->del($key)};
546 dbg(carp("Export Error1: delete $key => '$val' $@")) if $@;
551 eval {$ref = decode($val); };
553 my $t = $ref->{lastin} || 0;
554 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
555 unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
556 eval {$dbm->del($key)};
557 dbg(carp("Export Error2: delete '$key' => '$val' $@")) if $@;
558 LogDbg('DXCommand', "$ref->{call} deleted, too old");
563 # only store users that are reasonably active or have useful information
564 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
567 LogDbg('DXCommand', "Export Error3: '$key'\t" . carp($val) ."\n$@");
568 eval {$dbm->del($key)};
569 dbg(carp("Export Error3: delete '$key' => '$val' $@")) if $@;
575 my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
576 LogDbg('command', $s);
584 # add one or more groups
588 my $ref = $self->{group} || [ 'local' ];
589 $self->{group} = $ref if !$self->{group};
590 push @$ref, @_ if @_;
593 # remove one or more groups
597 my $ref = $self->{group} || [ 'local' ];
600 $self->{group} = $ref if !$self->{group};
602 @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
605 # does this thing contain all the groups listed?
609 my $ref = $self->{group};
612 return 0 if !$ref || @_ == 0;
613 return 1 if @$ref == 0 && @_ == 0;
614 for ($n = 0; $n < @_; ) {
617 $n++ if grep $_ eq $a, @_;
623 # simplified group test just for one group
628 my $ref = $self->{group};
631 return grep $_ eq $s, $ref;
634 # set up a default group (only happens for them's that connect direct)
638 $self->{group} = [ 'local' ];
641 # set up empty buddies (only happens for them's that connect direct)
645 $self->{buddies} = [ ];
649 # return a prompt for a field
654 my ($self, $ele) = @_;
658 # some variable accessors
662 @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
667 # want is default = 1
674 $self->{$s} = $val if defined $val;
675 return exists $self->{$s} ? $self->{$s} : 1;
678 # wantnot is default = 0
685 $self->{$s} = $val if defined $val;
686 return exists $self->{$s} ? $self->{$s} : 0;
691 return _want('beep', @_);
696 return _want('ann', @_);
701 return _want('wwv', @_);
706 return _want('wcy', @_);
711 return _want('echo', @_);
716 return _want('wx', @_);
721 return _want('dx', @_);
726 return _want('talk', @_);
731 return _want('grid', @_);
736 return _want('email', @_);
741 return _want('ann_talk', @_);
746 return _want('pc16', @_);
751 return _want('sendpc16', @_);
756 return _want('routepc16', @_);
761 return _want('usstate', @_);
766 return _want('dxcq', @_);
771 return _want('dxitu', @_);
776 return _want('gtk', @_);
781 return _want('pc9x', @_);
788 $self->{wantlogininfo} = $val if defined $val;
789 return $self->{wantlogininfo};
795 return $self->{sort} =~ /^[ACRSX]$/;
801 return grep $_ eq 'local_node', @{$self->{group}};
807 return $self->{sort} =~ /^[UW]$/;
813 return $self->{sort} eq 'W';
819 return $self->{sort} eq 'B';
825 return $self->{sort} eq 'S';
831 return $self->{sort} eq 'C';
837 return $self->{sort} eq 'X';
843 return $self->{sort} eq 'R';
849 return $self->{sort} eq 'A';
855 return $self->{sort} eq 'N'
861 delete $self->{passwd};
867 delete $self->{passphrase};
874 $self->{believe} ||= [];
875 push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
882 if (exists $self->{believe}) {
883 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
884 delete $self->{believe} unless @{$self->{believe}};
891 return exists $self->{believe} ? @{$self->{believe}} : ();
898 $self->{lastping} ||= {};
899 $self->{lastping} = {} unless ref $self->{lastping};
900 my $b = $self->{lastping};
901 $b->{$call} = shift if @_;