]> dxcluster.net Git - spider.git/blob - perl/DXUser.pm
small change to LogDbg
[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,Chat Group,parray',       # used to create a group of users/nodes for some purpose or other
65                   isolate => '9,Isolate network,yesno',
66                   wantbeep => '0,Req Beep,yesno',
67                   wantann => '0,Req Announce,yesno',
68                   wantwwv => '0,Req WWV,yesno',
69                   wantwcy => '0,Req WCY,yesno',
70                   wantecho => '0,Req Echo,yesno',
71                   wanttalk => '0,Req Talk,yesno',
72                   wantwx => '0,Req WX,yesno',
73                   wantdx => '0,Req DX Spots,yesno',
74                   wantemail => '0,Req Msgs as Email,yesno',
75                   pagelth => '0,Current Pagelth',
76                   pingint => '9,Node Ping interval',
77                   nopings => '9,Ping Obs Count',
78                   wantlogininfo => '0,Login Info Req,yesno',
79           wantgrid => '0,Show DX Grid,yesno',
80                   wantann_talk => '0,Talklike Anns,yesno',
81                   wantpc90 => '1,Req PC90,yesno',
82                   wantnp => '1,Req New Proto,yesno',
83                   wantpc16 => '9,Want Users from node,yesno',
84                   wantsendpc16 => '9,Send PC16,yesno',
85                   wantroutepc19 => '9,Route PC19,yesno',
86                   wantusstate => '0,Show US State,yesno',
87                   wantdxcq => '0,Show CQ Zone,yesno',
88                   wantdxitu => '0,Show ITU Zone,yesno',
89                   lastoper => '9,Last for/oper,cldatetime',
90                   nothere => '0,Not Here Text',
91                   registered => '9,Registered?,yesno',
92                   prompt => '0,Required Prompt',
93                   version => '1,Version',
94                   build => '1,Build',
95                   believe => '1,Believable nodes,parray',
96                   lastping => '1,Last Ping at,ptimelist',
97                  );
98
99 #no strict;
100 sub AUTOLOAD
101 {
102         no strict;
103         my $name = $AUTOLOAD;
104   
105         return if $name =~ /::DESTROY$/;
106         $name =~ s/^.*:://o;
107   
108         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
109         # this clever line of code creates a subroutine which takes over from autoload
110         # from OO Perl - Conway
111         *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
112        goto &$AUTOLOAD;
113 }
114
115 #use strict;
116
117 #
118 # initialise the system
119 #
120 sub init
121 {
122         my ($pkg, $fn, $mode) = @_;
123   
124         confess "need a filename in User" if !$fn;
125
126         my $ufn;
127         my $convert;
128         
129         eval {
130                 require Storable;
131         };
132
133 #       eval "use Storable qw(nfreeze thaw)";
134         
135         if ($@) {
136                 $ufn = "$fn.v2";
137                 $v3 = $convert = 0;
138                 dbg("the module Storable appears to be missing!!");
139                 dbg("trying to continue in compatibility mode (this may fail)");
140                 dbg("please install Storable from CPAN as soon as possible");
141         } else {
142                 import Storable qw(nfreeze thaw);
143
144                 $ufn = "$fn.v3";
145                 $v3 = 1;
146                 $convert++ unless -e $ufn;
147         }
148         
149         if ($mode) {
150                 $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?]";
151         } else {
152                 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
153         }
154
155         $lru = LRU->newbase("DXUser", $lrusize);
156         
157         # do a conversion if required
158         if ($convert) {
159                 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
160                 
161                 my %oldu;
162                 dbg("Converting the User File to V3 ");
163                 dbg("This will take a while, I suggest you go and have cup of strong tea");
164                 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?]";
165         for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
166                         my $ref = asc_decode($val);
167                         if ($ref) {
168                                 $ref->put;
169                                 $count++;
170                         } else {
171                                 $err++
172                         }
173                 } 
174                 undef $odbm;
175                 untie %oldu;
176                 dbg("Conversion completed $count records $err errors");
177         }
178         $filename = $ufn;
179 }
180
181 sub del_file
182 {
183         my ($pkg, $fn) = @_;
184   
185         confess "need a filename in User" if !$fn;
186         $fn .= $v3 ? ".v3" : ".v2";
187         unlink $fn;
188 }
189
190 #
191 # periodic processing
192 #
193 sub process
194 {
195         if ($main::systime > $lasttime + 15) {
196                 $dbm->sync;
197                 $lasttime = $main::systime;
198         }
199 }
200
201 #
202 # close the system
203 #
204
205 sub finish
206 {
207         undef $dbm;
208         untie %u;
209 }
210
211 #
212 # new - create a new user
213 #
214
215 sub alloc
216 {
217         my $pkg = shift;
218         my $call = uc shift;
219         my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
220         return $self;
221 }
222
223 sub new
224 {
225         my $pkg = shift;
226         my $call = shift;
227         #  $call =~ s/-\d+$//o;
228   
229 #       confess "can't create existing call $call in User\n!" if $u{$call};
230
231         my $self = $pkg->alloc($call);
232         $self->put;
233         return $self;
234 }
235
236 #
237 # get - get an existing user - this seems to return a different reference everytime it is
238 #       called - see below
239 #
240
241 sub get
242 {
243         my $pkg = shift;
244         my $call = uc shift;
245         my $data;
246         
247         # is it in the LRU cache?
248         my $ref = $lru->get($call);
249         return $ref if $ref;
250         
251         # search for it
252         unless ($dbm->get($call, $data)) {
253                 $ref = decode($data);
254                 $lru->put($call, $ref);
255                 return $ref;
256         }
257         return undef;
258 }
259
260 #
261 # get an existing either from the channel (if there is one) or from the database
262 #
263 # It is important to note that if you have done a get (for the channel say) and you
264 # want access or modify that you must use this call (and you must NOT use get's all
265 # over the place willy nilly!)
266 #
267
268 sub get_current
269 {
270         my $pkg = shift;
271         my $call = uc shift;
272   
273         my $dxchan = DXChannel::get($call);
274         return $dxchan->user if $dxchan;
275         my $rref = Route::get($call);
276         return $rref->user if $rref && exists $rref->{user};
277         return $pkg->get($call);
278 }
279
280 #
281 # get all callsigns in the database 
282 #
283
284 sub get_all_calls
285 {
286         return (sort keys %u);
287 }
288
289 #
290 # put - put a user
291 #
292
293 sub put
294 {
295         my $self = shift;
296         confess "Trying to put nothing!" unless $self && ref $self;
297         my $call = $self->{call};
298         # delete all instances of this 
299 #       for ($dbm->get_dup($call)) {
300 #               $dbm->del_dup($call, $_);
301 #       }
302         $dbm->del($call);
303         delete $self->{annok} if $self->{annok};
304         delete $self->{dxok} if $self->{dxok};
305         $lru->put($call, $self);
306         my $ref = $self->encode;
307         $dbm->put($call, $ref);
308 }
309
310 # freeze the user
311 sub encode
312 {
313         goto &asc_encode unless $v3;
314         my $self = shift;
315         return nfreeze($self);
316 }
317
318 # thaw the user
319 sub decode
320 {
321         goto &asc_decode unless $v3;
322         return thaw(shift);
323 }
324
325
326 # create a string from a user reference (in_ascii)
327 #
328 sub asc_encode
329 {
330         my $self = shift;
331         my $dd = new Data::Dumper([$self]);
332         $dd->Indent(0);
333         $dd->Terse(1);
334     $dd->Quotekeys($] < 5.005 ? 1 : 0);
335         return $dd->Dumpxs;
336 }
337
338 #
339 # create a hash from a string (in ascii)
340 #
341 sub asc_decode
342 {
343         my $s = shift;
344         my $ref;
345         eval '$ref = ' . $s;
346         if ($@) {
347                 dbg($@);
348                 Log('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                                 Log('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                                                 Log('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                                 Log('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 #
590 # return a prompt for a field
591 #
592
593 sub field_prompt
594
595         my ($self, $ele) = @_;
596         return $valid{$ele};
597 }
598
599 # some variable accessors
600 sub sort
601 {
602         my $self = shift;
603         @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
604 }
605
606 # some accessors
607
608 # want is default = 1
609 sub _want
610 {
611         my $n = shift;
612         my $self = shift;
613         my $val = shift;
614         my $s = "want$n";
615         $self->{$s} = $val if defined $val;
616         return exists $self->{$s} ? $self->{$s} : 1;
617 }
618
619 # wantnot is default = 0
620 sub _wantnot
621 {
622         my $n = shift;
623         my $self = shift;
624         my $val = shift;
625         my $s = "want$n";
626         $self->{$s} = $val if defined $val;
627         return exists $self->{$s} ? $self->{$s} : 0;
628 }
629
630 sub wantbeep
631 {
632         return _want('beep', @_);
633 }
634
635 sub wantann
636 {
637         return _want('ann', @_);
638 }
639
640 sub wantwwv
641 {
642         return _want('wwv', @_);
643 }
644
645 sub wantwcy
646 {
647         return _want('wcy', @_);
648 }
649
650 sub wantecho
651 {
652         return _want('echo', @_);
653 }
654
655 sub wantwx
656 {
657         return _want('wx', @_);
658 }
659
660 sub wantdx
661 {
662         return _want('dx', @_);
663 }
664
665 sub wanttalk
666 {
667         return _want('talk', @_);
668 }
669
670 sub wantgrid
671 {
672         return _want('grid', @_);
673 }
674
675 sub wantemail
676 {
677         return _want('email', @_);
678 }
679
680 sub wantann_talk
681 {
682         return _want('ann_talk', @_);
683 }
684
685 sub wantpc16
686 {
687         return _want('pc16', @_);
688 }
689
690 sub wantpc90
691 {
692         return _wantnot('pc90', @_);
693 }
694
695 sub wantsendpc16
696 {
697         return _want('sendpc16', @_);
698 }
699
700 sub wantroutepc16
701 {
702         return _want('routepc16', @_);
703 }
704
705 sub wantusstate
706 {
707         return _want('usstate', @_);
708 }
709
710 sub wantdxcq
711 {
712         return _want('dxcq', @_);
713 }
714
715 sub wantdxitu
716 {
717         return _want('dxitu', @_);
718 }
719
720 sub wantnp
721 {
722         return _wantnot('np', @_);
723 }
724
725 sub wantlogininfo
726 {
727         my $self = shift;
728         my $val = shift;
729         $self->{wantlogininfo} = $val if defined $val;
730         return $self->{wantlogininfo};
731 }
732
733 sub is_node
734 {
735         my $self = shift;
736         return $self->{sort} =~ /[ACRSX]/;
737 }
738
739 sub is_user
740 {
741         my $self = shift;
742         return $self->{sort} eq 'U';
743 }
744
745 sub is_bbs
746 {
747         my $self = shift;
748         return $self->{sort} eq 'B';
749 }
750
751 sub is_spider
752 {
753         my $self = shift;
754         return $self->{sort} eq 'S';
755 }
756
757 sub is_clx
758 {
759         my $self = shift;
760         return $self->{sort} eq 'C';
761 }
762
763 sub is_dxnet
764 {
765         my $self = shift;
766         return $self->{sort} eq 'X';
767 }
768
769 sub is_arcluster
770 {
771         my $self = shift;
772         return $self->{sort} eq 'R';
773 }
774
775 sub is_ak1a
776 {
777         my $self = shift;
778         return $self->{sort} eq 'A';
779 }
780
781 sub unset_passwd
782 {
783         my $self = shift;
784         delete $self->{passwd};
785 }
786
787 sub unset_passphrase
788 {
789         my $self = shift;
790         delete $self->{passphrase};
791 }
792
793 sub set_believe
794 {
795         my $self = shift;
796         my $call = uc shift;
797         $self->{believe} ||= [];
798         push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
799 }
800
801 sub unset_believe
802 {
803         my $self = shift;
804         my $call = uc shift;
805         if (exists $self->{believe}) {
806                 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
807                 delete $self->{believe} unless @{$self->{believe}};
808         }
809 }
810
811 sub believe
812 {
813         my $self = shift;
814         return exists $self->{believe} ? @{$self->{believe}} : ();
815 }
816
817 sub lastping
818 {
819         my $self = shift;
820         my $call = shift;
821         $self->{lastping} ||= {};
822         $self->{lastping} = {} unless ref $self->{lastping};
823         my $b = $self->{lastping};
824         $b->{$call} = shift if @_;
825         return $b->{$call};     
826 }
827 1;
828 __END__
829
830
831
832
833