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