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