413d56a6446c6678b779498498ef4bfd56146ef9
[spider.git] / perl / DXUser.pm
1 #
2 # DX cluster user routines
3 #
4 # Copyright (c) 1998 - Dirk Koopman G1TLH
5 #
6 # $Id$
7 #
8
9 package DXUser;
10
11 use DXLog;
12 use DB_File;
13 use Data::Dumper;
14 use Fcntl;
15 use IO::File;
16 use DXDebug;
17 use DXUtil;
18 use LRU;
19
20 use strict;
21
22 use vars qw($VERSION $BRANCH);
23 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
24 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
25 $main::build += $VERSION;
26 $main::branch += $BRANCH;
27
28 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
29
30 %u = ();
31 $dbm = undef;
32 $filename = undef;
33 $lastoperinterval = 60*24*60*60;
34 $lasttime = 0;
35 $lrusize = 2000;
36 $tooold = 86400 * 365;          # this marks an old user who hasn't given enough info to be useful
37 $v3 = 0;
38
39 # hash of valid elements and a simple prompt
40 %valid = (
41                   call => '0,Callsign',
42                   alias => '0,Real Callsign',
43                   name => '0,Name',
44                   qth => '0,Home QTH',
45                   lat => '0,Latitude,slat',
46                   long => '0,Longitude,slong',
47                   qra => '0,Locator',
48                   email => '0,E-mail Address,parray',
49                   priv => '9,Privilege Level',
50                   lastin => '0,Last Time in,cldatetime',
51                   passwd => '9,Password,yesno',
52                   passphrase => '9,Pass Phrase,yesno',
53                   addr => '0,Full Address',
54                   'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
55                   xpert => '0,Expert Status,yesno',
56                   bbs => '0,Home BBS',
57                   node => '0,Last Node',
58                   homenode => '0,Home Node',
59                   lockout => '9,Locked out?,yesno',     # won't let them in at all
60                   dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
61                   annok => '9,Accept Announces?,yesno', # accept his announces?
62                   lang => '0,Language',
63                   hmsgno => '0,Highest Msgno',
64                   group => '0,Group,parray',    # used to create a group of users/nodes for some purpose or other
65                   buddies => '0,Buddies,parray',
66                   isolate => '9,Isolate network,yesno',
67                   wantbeep => '0,Req Beep,yesno',
68                   wantann => '0,Req Announce,yesno',
69                   wantwwv => '0,Req WWV,yesno',
70                   wantwcy => '0,Req WCY,yesno',
71                   wantecho => '0,Req Echo,yesno',
72                   wanttalk => '0,Req Talk,yesno',
73                   wantwx => '0,Req WX,yesno',
74                   wantdx => '0,Req DX Spots,yesno',
75                   wantemail => '0,Req Msgs as Email,yesno',
76                   pagelth => '0,Current Pagelth',
77                   pingint => '9,Node Ping interval',
78                   nopings => '9,Ping Obs Count',
79                   wantlogininfo => '0,Login Info Req,yesno',
80           wantgrid => '0,Show DX Grid,yesno',
81                   wantann_talk => '0,Talklike Anns,yesno',
82                   wantpc16 => '9,Want Users from node,yesno',
83                   wantsendpc16 => '9,Send PC16,yesno',
84                   wantroutepc19 => '9,Route PC19,yesno',
85                   wantusstate => '0,Show US State,yesno',
86                   wantdxcq => '0,Show CQ Zone,yesno',
87                   wantdxitu => '0,Show ITU Zone,yesno',
88                   lastoper => '9,Last for/oper,cldatetime',
89                   nothere => '0,Not Here Text',
90                   registered => '9,Registered?,yesno',
91                   prompt => '0,Required Prompt',
92                   version => '1,Version',
93                   build => '1,Build',
94                   believe => '1,Believable nodes,parray',
95                   lastping => '1,Last Ping at,ptimelist',
96                  );
97
98 #no strict;
99 sub AUTOLOAD
100 {
101         no strict;
102         my $name = $AUTOLOAD;
103   
104         return if $name =~ /::DESTROY$/;
105         $name =~ s/^.*:://o;
106   
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}};
111        goto &$AUTOLOAD;
112 }
113
114 #use strict;
115
116 #
117 # initialise the system
118 #
119 sub init
120 {
121         my ($pkg, $fn, $mode) = @_;
122   
123         confess "need a filename in User" if !$fn;
124
125         my $ufn;
126         my $convert;
127         
128         eval {
129                 require Storable;
130         };
131
132 #       eval "use Storable qw(nfreeze thaw)";
133         
134         if ($@) {
135                 $ufn = "$fn.v2";
136                 $v3 = $convert = 0;
137                 dbg("the module Storable appears to be missing!!");
138                 dbg("trying to continue in compatibility mode (this may fail)");
139                 dbg("please install Storable from CPAN as soon as possible");
140         } else {
141                 import Storable qw(nfreeze thaw);
142
143                 $ufn = "$fn.v3";
144                 $v3 = 1;
145                 $convert++ if -e "$fn.v2" && !-e $ufn;
146         }
147         
148         if ($mode) {
149                 $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?]";
150         } else {
151                 $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         }
153
154         die "Cannot open $ufn ($!)\n" unless $dbm;
155
156         $lru = LRU->newbase("DXUser", $lrusize);
157         
158         # do a conversion if required
159         if ($dbm && $convert) {
160                 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
161                 
162                 my %oldu;
163                 dbg("Converting the User File to V3 ");
164                 dbg("This will take a while, I suggest you go and have cup of strong tea");
165                 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?]";
166         for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
167                         my $ref = asc_decode($val);
168                         if ($ref) {
169                                 $ref->put;
170                                 $count++;
171                         } else {
172                                 $err++
173                         }
174                 } 
175                 undef $odbm;
176                 untie %oldu;
177                 dbg("Conversion completed $count records $err errors");
178         }
179         $filename = $ufn;
180 }
181
182 sub del_file
183 {
184         my ($pkg, $fn) = @_;
185   
186         confess "need a filename in User" if !$fn;
187         $fn .= $v3 ? ".v3" : ".v2";
188         unlink $fn;
189 }
190
191 #
192 # periodic processing
193 #
194 sub process
195 {
196         if ($main::systime > $lasttime + 15) {
197                 $dbm->sync;
198                 $lasttime = $main::systime;
199         }
200 }
201
202 #
203 # close the system
204 #
205
206 sub finish
207 {
208         undef $dbm;
209         untie %u;
210 }
211
212 #
213 # new - create a new user
214 #
215
216 sub alloc
217 {
218         my $pkg = shift;
219         my $call = uc shift;
220         my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
221         return $self;
222 }
223
224 sub new
225 {
226         my $pkg = shift;
227         my $call = shift;
228         #  $call =~ s/-\d+$//o;
229   
230 #       confess "can't create existing call $call in User\n!" if $u{$call};
231
232         my $self = $pkg->alloc($call);
233         $self->put;
234         return $self;
235 }
236
237 #
238 # get - get an existing user - this seems to return a different reference everytime it is
239 #       called - see below
240 #
241
242 sub get
243 {
244         my $pkg = shift;
245         my $call = uc shift;
246         my $data;
247         
248         # is it in the LRU cache?
249         my $ref = $lru->get($call);
250         return $ref if $ref;
251         
252         # search for it
253         unless ($dbm->get($call, $data)) {
254                 $ref = decode($data);
255                 $lru->put($call, $ref);
256                 return $ref;
257         }
258         return undef;
259 }
260
261 #
262 # get an existing either from the channel (if there is one) or from the database
263 #
264 # It is important to note that if you have done a get (for the channel say) and you
265 # want access or modify that you must use this call (and you must NOT use get's all
266 # over the place willy nilly!)
267 #
268
269 sub get_current
270 {
271         my $pkg = shift;
272         my $call = uc shift;
273   
274         my $dxchan = DXChannel::get($call);
275         return $dxchan->user if $dxchan;
276         my $rref = Route::get($call);
277         return $rref->user if $rref && exists $rref->{user};
278         return $pkg->get($call);
279 }
280
281 #
282 # get all callsigns in the database 
283 #
284
285 sub get_all_calls
286 {
287         return (sort keys %u);
288 }
289
290 #
291 # put - put a user
292 #
293
294 sub put
295 {
296         my $self = shift;
297         confess "Trying to put nothing!" unless $self && ref $self;
298         my $call = $self->{call};
299         # delete all instances of this 
300 #       for ($dbm->get_dup($call)) {
301 #               $dbm->del_dup($call, $_);
302 #       }
303         $dbm->del($call);
304         delete $self->{annok} if $self->{annok};
305         delete $self->{dxok} if $self->{dxok};
306         $lru->put($call, $self);
307         my $ref = $self->encode;
308         $dbm->put($call, $ref);
309 }
310
311 # freeze the user
312 sub encode
313 {
314         goto &asc_encode unless $v3;
315         my $self = shift;
316         return nfreeze($self);
317 }
318
319 # thaw the user
320 sub decode
321 {
322         goto &asc_decode unless $v3;
323         return thaw(shift);
324 }
325
326
327 # create a string from a user reference (in_ascii)
328 #
329 sub asc_encode
330 {
331         my $self = shift;
332         my $dd = new Data::Dumper([$self]);
333         $dd->Indent(0);
334         $dd->Terse(1);
335     $dd->Quotekeys($] < 5.005 ? 1 : 0);
336         return $dd->Dumpxs;
337 }
338
339 #
340 # create a hash from a string (in ascii)
341 #
342 sub asc_decode
343 {
344         my $s = shift;
345         my $ref;
346         eval '$ref = ' . $s;
347         if ($@) {
348                 LogDbg('err', $@);
349                 $ref = undef;
350         }
351         return $ref;
352 }
353
354 #
355 # del - delete a user
356 #
357
358 sub del
359 {
360         my $self = shift;
361         my $call = $self->{call};
362         # delete all instances of this 
363 #       for ($dbm->get_dup($call)) {
364 #               $dbm->del_dup($call, $_);
365 #       }
366         $lru->remove($call);
367         $dbm->del($call);
368 }
369
370 #
371 # close - close down a user
372 #
373
374 sub close
375 {
376         my $self = shift;
377         $self->{lastin} = time;
378         $self->put();
379 }
380
381 #
382 # sync the database
383 #
384
385 sub sync
386 {
387         $dbm->sync;
388 }
389
390 #
391 # return a list of valid elements 
392
393
394 sub fields
395 {
396         return keys(%valid);
397 }
398
399
400 #
401 # export the database to an ascii file
402 #
403
404 sub export
405 {
406         my $fn = shift;
407         
408         # save old ones
409         rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
410         rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
411         rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
412         rename "$fn.o", "$fn.oo" if -e "$fn.o";
413         rename "$fn", "$fn.o" if -e "$fn";
414
415         my $count = 0;
416         my $err = 0;
417         my $del = 0;
418         my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
419         if ($fh) {
420                 my $key = 0;
421                 my $val = undef;
422                 my $action;
423                 my $t = scalar localtime;
424                 print $fh q{#!/usr/bin/perl
425 #
426 # The exported userfile for a DXSpider System
427 #
428 # Input file: $filename
429 #       Time: $t
430 #
431                         
432 package main;
433                         
434 # search local then perl directories
435 BEGIN {
436         umask 002;
437                                 
438         # root of directory tree for this system
439         $root = "/spider"; 
440         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
441         
442         unshift @INC, "$root/perl";     # this IS the right way round!
443         unshift @INC, "$root/local";
444         
445         # try to detect a lockfile (this isn't atomic but 
446         # should do for now
447         $lockfn = "$root/local/cluster.lck";       # lock file name
448         if (-e $lockfn) {
449                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
450                 my $pid = <CLLOCK>;
451                 chomp $pid;
452                 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
453                 close CLLOCK;
454         }
455 }
456
457 package DXUser;
458
459 use DXVars;
460 use DXUser;
461
462 if (@ARGV) {
463         $main::userfn = shift @ARGV;
464         print "user filename now $userfn\n";
465 }
466
467 DXUser->del_file($main::userfn);
468 DXUser->init($main::userfn, 1);
469 %u = ();
470 my $count = 0;
471 my $err = 0;
472 while (<DATA>) {
473         chomp;
474         my @f = split /\t/;
475         my $ref = asc_decode($f[1]);
476         if ($ref) {
477                 $ref->put();
478                 $count++;
479         } else {
480                 print "# Error: $f[0]\t$f[1]\n";
481                 $err++
482         }
483 }
484 DXUser->sync; DXUser->finish;
485 print "There are $count user records and $err errors\n";
486 };
487                 print $fh "__DATA__\n";
488
489         for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
490                         if (!is_callsign($key) || $key =~ /^0/) {
491                                 my $eval = $val;
492                                 my $ekey = $key;
493                                 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
494                                 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
495                                 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
496                                 eval {$dbm->del($key)};
497                                 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
498                                 ++$err;
499                                 next;
500                         }
501                         my $ref = decode($val);
502                         if ($ref) {
503                                 my $t = $ref->{lastin} || 0;
504                                 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
505                                         unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
506                                                 eval {$dbm->del($key)};
507                                                 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
508                                                 LogDbg('DXCommand', "$ref->{call} deleted, too old");
509                                                 $del++;
510                                                 next;
511                                         }
512                                 }
513                                 # only store users that are reasonably active or have useful information
514                                 print $fh "$key\t" . $ref->asc_encode . "\n";
515                                 ++$count;
516                         } else {
517                                 LogDbg('DXCommand', "Export Error3: $key\t$val");
518                                 eval {$dbm->del($key)};
519                                 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
520                                 ++$err;
521                         }
522                 } 
523         $fh->close;
524     } 
525         return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
526 }
527
528 #
529 # group handling
530 #
531
532 # add one or more groups
533 sub add_group
534 {
535         my $self = shift;
536         my $ref = $self->{group} || [ 'local' ];
537         $self->{group} = $ref if !$self->{group};
538         push @$ref, @_ if @_;
539 }
540
541 # remove one or more groups
542 sub del_group
543 {
544         my $self = shift;
545         my $ref = $self->{group} || [ 'local' ];
546         my @in = @_;
547         
548         $self->{group} = $ref if !$self->{group};
549         
550         @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
551 }
552
553 # does this thing contain all the groups listed?
554 sub union
555 {
556         my $self = shift;
557         my $ref = $self->{group};
558         my $n;
559         
560         return 0 if !$ref || @_ == 0;
561         return 1 if @$ref == 0 && @_ == 0;
562         for ($n = 0; $n < @_; ) {
563                 for (@$ref) {
564                         my $a = $_;
565                         $n++ if grep $_ eq $a, @_; 
566                 }
567         }
568         return $n >= @_;
569 }
570
571 # simplified group test just for one group
572 sub in_group
573 {
574         my $self = shift;
575         my $s = shift;
576         my $ref = $self->{group};
577         
578         return 0 if !$ref;
579         return grep $_ eq $s, $ref;
580 }
581
582 # set up a default group (only happens for them's that connect direct)
583 sub new_group
584 {
585         my $self = shift;
586         $self->{group} = [ 'local' ];
587 }
588
589 # set up empty buddies (only happens for them's that connect direct)
590 sub new_buddies
591 {
592         my $self = shift;
593         $self->{buddies} = [  ];
594 }
595
596 #
597 # return a prompt for a field
598 #
599
600 sub field_prompt
601
602         my ($self, $ele) = @_;
603         return $valid{$ele};
604 }
605
606 # some variable accessors
607 sub sort
608 {
609         my $self = shift;
610         @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
611 }
612
613 # some accessors
614
615 # want is default = 1
616 sub _want
617 {
618         my $n = shift;
619         my $self = shift;
620         my $val = shift;
621         my $s = "want$n";
622         $self->{$s} = $val if defined $val;
623         return exists $self->{$s} ? $self->{$s} : 1;
624 }
625
626 # wantnot is default = 0
627 sub _wantnot
628 {
629         my $n = shift;
630         my $self = shift;
631         my $val = shift;
632         my $s = "want$n";
633         $self->{$s} = $val if defined $val;
634         return exists $self->{$s} ? $self->{$s} : 0;
635 }
636
637 sub wantbeep
638 {
639         return _want('beep', @_);
640 }
641
642 sub wantann
643 {
644         return _want('ann', @_);
645 }
646
647 sub wantwwv
648 {
649         return _want('wwv', @_);
650 }
651
652 sub wantwcy
653 {
654         return _want('wcy', @_);
655 }
656
657 sub wantecho
658 {
659         return _want('echo', @_);
660 }
661
662 sub wantwx
663 {
664         return _want('wx', @_);
665 }
666
667 sub wantdx
668 {
669         return _want('dx', @_);
670 }
671
672 sub wanttalk
673 {
674         return _want('talk', @_);
675 }
676
677 sub wantgrid
678 {
679         return _want('grid', @_);
680 }
681
682 sub wantemail
683 {
684         return _want('email', @_);
685 }
686
687 sub wantann_talk
688 {
689         return _want('ann_talk', @_);
690 }
691
692 sub wantpc16
693 {
694         return _want('pc16', @_);
695 }
696
697 sub wantsendpc16
698 {
699         return _want('sendpc16', @_);
700 }
701
702 sub wantroutepc16
703 {
704         return _want('routepc16', @_);
705 }
706
707 sub wantusstate
708 {
709         return _want('usstate', @_);
710 }
711
712 sub wantdxcq
713 {
714         return _want('dxcq', @_);
715 }
716
717 sub wantdxitu
718 {
719         return _want('dxitu', @_);
720 }
721
722 sub wantlogininfo
723 {
724         my $self = shift;
725         my $val = shift;
726         $self->{wantlogininfo} = $val if defined $val;
727         return $self->{wantlogininfo};
728 }
729
730 sub is_node
731 {
732         my $self = shift;
733         return $self->{sort} =~ /[ACRSX]/;
734 }
735
736 sub is_local_node
737 {
738         my $self = shift;
739         return grep $_ eq 'local_node', @{$self->{group}};
740 }
741
742 sub is_user
743 {
744         my $self = shift;
745         return $self->{sort} eq 'U';
746 }
747
748 sub is_bbs
749 {
750         my $self = shift;
751         return $self->{sort} eq 'B';
752 }
753
754 sub is_spider
755 {
756         my $self = shift;
757         return $self->{sort} eq 'S';
758 }
759
760 sub is_clx
761 {
762         my $self = shift;
763         return $self->{sort} eq 'C';
764 }
765
766 sub is_dxnet
767 {
768         my $self = shift;
769         return $self->{sort} eq 'X';
770 }
771
772 sub is_arcluster
773 {
774         my $self = shift;
775         return $self->{sort} eq 'R';
776 }
777
778 sub is_ak1a
779 {
780         my $self = shift;
781         return $self->{sort} eq 'A';
782 }
783
784 sub unset_passwd
785 {
786         my $self = shift;
787         delete $self->{passwd};
788 }
789
790 sub unset_passphrase
791 {
792         my $self = shift;
793         delete $self->{passphrase};
794 }
795
796 sub set_believe
797 {
798         my $self = shift;
799         my $call = uc shift;
800         $self->{believe} ||= [];
801         push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
802 }
803
804 sub unset_believe
805 {
806         my $self = shift;
807         my $call = uc shift;
808         if (exists $self->{believe}) {
809                 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
810                 delete $self->{believe} unless @{$self->{believe}};
811         }
812 }
813
814 sub believe
815 {
816         my $self = shift;
817         return exists $self->{believe} ? @{$self->{believe}} : ();
818 }
819
820 sub lastping
821 {
822         my $self = shift;
823         my $call = shift;
824         $self->{lastping} ||= {};
825         $self->{lastping} = {} unless ref $self->{lastping};
826         my $b = $self->{lastping};
827         $b->{$call} = shift if @_;
828         return $b->{$call};     
829 }
830 1;
831 __END__
832
833
834
835
836