add some flesh to a gtk based console program
[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                   wantgtk => '0,Want GTK interface,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++ if -e "$fn.v2" && !-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         die "Cannot open $ufn ($!)\n" unless $dbm;
156
157         $lru = LRU->newbase("DXUser", $lrusize);
158         
159         # do a conversion if required
160         if ($dbm && $convert) {
161                 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
162                 
163                 my %oldu;
164                 dbg("Converting the User File to V3 ");
165                 dbg("This will take a while, I suggest you go and have cup of strong tea");
166                 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?]";
167         for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
168                         my $ref = asc_decode($val);
169                         if ($ref) {
170                                 $ref->put;
171                                 $count++;
172                         } else {
173                                 $err++
174                         }
175                 } 
176                 undef $odbm;
177                 untie %oldu;
178                 dbg("Conversion completed $count records $err errors");
179         }
180         $filename = $ufn;
181 }
182
183 sub del_file
184 {
185         my ($pkg, $fn) = @_;
186   
187         confess "need a filename in User" if !$fn;
188         $fn .= $v3 ? ".v3" : ".v2";
189         unlink $fn;
190 }
191
192 #
193 # periodic processing
194 #
195 sub process
196 {
197         if ($main::systime > $lasttime + 15) {
198                 $dbm->sync;
199                 $lasttime = $main::systime;
200         }
201 }
202
203 #
204 # close the system
205 #
206
207 sub finish
208 {
209         undef $dbm;
210         untie %u;
211 }
212
213 #
214 # new - create a new user
215 #
216
217 sub alloc
218 {
219         my $pkg = shift;
220         my $call = uc shift;
221         my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
222         return $self;
223 }
224
225 sub new
226 {
227         my $pkg = shift;
228         my $call = shift;
229         #  $call =~ s/-\d+$//o;
230   
231 #       confess "can't create existing call $call in User\n!" if $u{$call};
232
233         my $self = $pkg->alloc($call);
234         $self->put;
235         return $self;
236 }
237
238 #
239 # get - get an existing user - this seems to return a different reference everytime it is
240 #       called - see below
241 #
242
243 sub get
244 {
245         my $pkg = shift;
246         my $call = uc shift;
247         my $data;
248         
249         # is it in the LRU cache?
250         my $ref = $lru->get($call);
251         return $ref if $ref;
252         
253         # search for it
254         unless ($dbm->get($call, $data)) {
255                 $ref = decode($data);
256                 $lru->put($call, $ref);
257                 return $ref;
258         }
259         return undef;
260 }
261
262 #
263 # get an existing either from the channel (if there is one) or from the database
264 #
265 # It is important to note that if you have done a get (for the channel say) and you
266 # want access or modify that you must use this call (and you must NOT use get's all
267 # over the place willy nilly!)
268 #
269
270 sub get_current
271 {
272         my $pkg = shift;
273         my $call = uc shift;
274   
275         my $dxchan = DXChannel::get($call);
276         return $dxchan->user if $dxchan;
277         my $rref = Route::get($call);
278         return $rref->user if $rref && exists $rref->{user};
279         return $pkg->get($call);
280 }
281
282 #
283 # get all callsigns in the database 
284 #
285
286 sub get_all_calls
287 {
288         return (sort keys %u);
289 }
290
291 #
292 # put - put a user
293 #
294
295 sub put
296 {
297         my $self = shift;
298         confess "Trying to put nothing!" unless $self && ref $self;
299         my $call = $self->{call};
300         # delete all instances of this 
301 #       for ($dbm->get_dup($call)) {
302 #               $dbm->del_dup($call, $_);
303 #       }
304         $dbm->del($call);
305         delete $self->{annok} if $self->{annok};
306         delete $self->{dxok} if $self->{dxok};
307         $lru->put($call, $self);
308         my $ref = $self->encode;
309         $dbm->put($call, $ref);
310 }
311
312 # freeze the user
313 sub encode
314 {
315         goto &asc_encode unless $v3;
316         my $self = shift;
317         return nfreeze($self);
318 }
319
320 # thaw the user
321 sub decode
322 {
323         goto &asc_decode unless $v3;
324         return thaw(shift);
325 }
326
327
328 # create a string from a user reference (in_ascii)
329 #
330 sub asc_encode
331 {
332         my $self = shift;
333         return dd($self);
334 }
335
336 #
337 # create a hash from a string (in ascii)
338 #
339 sub asc_decode
340 {
341         my $s = shift;
342         my $ref;
343         $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
344         eval '$ref = ' . $s;
345         if ($@) {
346                 LogDbg('err', $@);
347                 $ref = undef;
348         }
349         return $ref;
350 }
351
352 #
353 # del - delete a user
354 #
355
356 sub del
357 {
358         my $self = shift;
359         my $call = $self->{call};
360         # delete all instances of this 
361 #       for ($dbm->get_dup($call)) {
362 #               $dbm->del_dup($call, $_);
363 #       }
364         $lru->remove($call);
365         $dbm->del($call);
366 }
367
368 #
369 # close - close down a user
370 #
371
372 sub close
373 {
374         my $self = shift;
375         $self->{lastin} = time;
376         $self->put();
377 }
378
379 #
380 # sync the database
381 #
382
383 sub sync
384 {
385         $dbm->sync;
386 }
387
388 #
389 # return a list of valid elements 
390
391
392 sub fields
393 {
394         return keys(%valid);
395 }
396
397
398 #
399 # export the database to an ascii file
400 #
401
402 sub export
403 {
404         my $fn = shift;
405         
406         # save old ones
407         rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
408         rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
409         rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
410         rename "$fn.o", "$fn.oo" if -e "$fn.o";
411         rename "$fn", "$fn.o" if -e "$fn";
412
413         my $count = 0;
414         my $err = 0;
415         my $del = 0;
416         my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
417         if ($fh) {
418                 my $key = 0;
419                 my $val = undef;
420                 my $action;
421                 my $t = scalar localtime;
422                 print $fh q{#!/usr/bin/perl
423 #
424 # The exported userfile for a DXSpider System
425 #
426 # Input file: $filename
427 #       Time: $t
428 #
429                         
430 package main;
431                         
432 # search local then perl directories
433 BEGIN {
434         umask 002;
435                                 
436         # root of directory tree for this system
437         $root = "/spider"; 
438         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
439         
440         unshift @INC, "$root/perl";     # this IS the right way round!
441         unshift @INC, "$root/local";
442         
443         # try to detect a lockfile (this isn't atomic but 
444         # should do for now
445         $lockfn = "$root/local/cluster.lck";       # lock file name
446         if (-e $lockfn) {
447                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
448                 my $pid = <CLLOCK>;
449                 chomp $pid;
450                 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
451                 close CLLOCK;
452         }
453 }
454
455 package DXUser;
456
457 use DXVars;
458 use DXUser;
459
460 if (@ARGV) {
461         $main::userfn = shift @ARGV;
462         print "user filename now $userfn\n";
463 }
464
465 DXUser->del_file($main::userfn);
466 DXUser->init($main::userfn, 1);
467 %u = ();
468 my $count = 0;
469 my $err = 0;
470 while (<DATA>) {
471         chomp;
472         my @f = split /\t/;
473         my $ref = asc_decode($f[1]);
474         if ($ref) {
475                 $ref->put();
476                 $count++;
477         } else {
478                 print "# Error: $f[0]\t$f[1]\n";
479                 $err++
480         }
481 }
482 DXUser->sync; DXUser->finish;
483 print "There are $count user records and $err errors\n";
484 };
485                 print $fh "__DATA__\n";
486
487         for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
488                         if (!is_callsign($key) || $key =~ /^0/) {
489                                 my $eval = $val;
490                                 my $ekey = $key;
491                                 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
492                                 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
493                                 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
494                                 eval {$dbm->del($key)};
495                                 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
496                                 ++$err;
497                                 next;
498                         }
499                         my $ref = decode($val);
500                         if ($ref) {
501                                 my $t = $ref->{lastin} || 0;
502                                 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
503                                         unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
504                                                 eval {$dbm->del($key)};
505                                                 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
506                                                 LogDbg('DXCommand', "$ref->{call} deleted, too old");
507                                                 $del++;
508                                                 next;
509                                         }
510                                 }
511                                 # only store users that are reasonably active or have useful information
512                                 print $fh "$key\t" . $ref->asc_encode . "\n";
513                                 ++$count;
514                         } else {
515                                 LogDbg('DXCommand', "Export Error3: $key\t$val");
516                                 eval {$dbm->del($key)};
517                                 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
518                                 ++$err;
519                         }
520                 } 
521         $fh->close;
522     } 
523         return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
524 }
525
526 #
527 # group handling
528 #
529
530 # add one or more groups
531 sub add_group
532 {
533         my $self = shift;
534         my $ref = $self->{group} || [ 'local' ];
535         $self->{group} = $ref if !$self->{group};
536         push @$ref, @_ if @_;
537 }
538
539 # remove one or more groups
540 sub del_group
541 {
542         my $self = shift;
543         my $ref = $self->{group} || [ 'local' ];
544         my @in = @_;
545         
546         $self->{group} = $ref if !$self->{group};
547         
548         @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
549 }
550
551 # does this thing contain all the groups listed?
552 sub union
553 {
554         my $self = shift;
555         my $ref = $self->{group};
556         my $n;
557         
558         return 0 if !$ref || @_ == 0;
559         return 1 if @$ref == 0 && @_ == 0;
560         for ($n = 0; $n < @_; ) {
561                 for (@$ref) {
562                         my $a = $_;
563                         $n++ if grep $_ eq $a, @_; 
564                 }
565         }
566         return $n >= @_;
567 }
568
569 # simplified group test just for one group
570 sub in_group
571 {
572         my $self = shift;
573         my $s = shift;
574         my $ref = $self->{group};
575         
576         return 0 if !$ref;
577         return grep $_ eq $s, $ref;
578 }
579
580 # set up a default group (only happens for them's that connect direct)
581 sub new_group
582 {
583         my $self = shift;
584         $self->{group} = [ 'local' ];
585 }
586
587 # set up empty buddies (only happens for them's that connect direct)
588 sub new_buddies
589 {
590         my $self = shift;
591         $self->{buddies} = [  ];
592 }
593
594 #
595 # return a prompt for a field
596 #
597
598 sub field_prompt
599
600         my ($self, $ele) = @_;
601         return $valid{$ele};
602 }
603
604 # some variable accessors
605 sub sort
606 {
607         my $self = shift;
608         @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
609 }
610
611 # some accessors
612
613 # want is default = 1
614 sub _want
615 {
616         my $n = shift;
617         my $self = shift;
618         my $val = shift;
619         my $s = "want$n";
620         $self->{$s} = $val if defined $val;
621         return exists $self->{$s} ? $self->{$s} : 1;
622 }
623
624 # wantnot is default = 0
625 sub _wantnot
626 {
627         my $n = shift;
628         my $self = shift;
629         my $val = shift;
630         my $s = "want$n";
631         $self->{$s} = $val if defined $val;
632         return exists $self->{$s} ? $self->{$s} : 0;
633 }
634
635 sub wantbeep
636 {
637         return _want('beep', @_);
638 }
639
640 sub wantann
641 {
642         return _want('ann', @_);
643 }
644
645 sub wantwwv
646 {
647         return _want('wwv', @_);
648 }
649
650 sub wantwcy
651 {
652         return _want('wcy', @_);
653 }
654
655 sub wantecho
656 {
657         return _want('echo', @_);
658 }
659
660 sub wantwx
661 {
662         return _want('wx', @_);
663 }
664
665 sub wantdx
666 {
667         return _want('dx', @_);
668 }
669
670 sub wanttalk
671 {
672         return _want('talk', @_);
673 }
674
675 sub wantgrid
676 {
677         return _want('grid', @_);
678 }
679
680 sub wantemail
681 {
682         return _want('email', @_);
683 }
684
685 sub wantann_talk
686 {
687         return _want('ann_talk', @_);
688 }
689
690 sub wantpc16
691 {
692         return _want('pc16', @_);
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 wantgtk
721 {
722         return _want('gtk', @_);
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_local_node
740 {
741         my $self = shift;
742         return grep $_ eq 'local_node', @{$self->{group}};
743 }
744
745 sub is_user
746 {
747         my $self = shift;
748         return $self->{sort} eq 'U';
749 }
750
751 sub is_bbs
752 {
753         my $self = shift;
754         return $self->{sort} eq 'B';
755 }
756
757 sub is_spider
758 {
759         my $self = shift;
760         return $self->{sort} eq 'S';
761 }
762
763 sub is_clx
764 {
765         my $self = shift;
766         return $self->{sort} eq 'C';
767 }
768
769 sub is_dxnet
770 {
771         my $self = shift;
772         return $self->{sort} eq 'X';
773 }
774
775 sub is_arcluster
776 {
777         my $self = shift;
778         return $self->{sort} eq 'R';
779 }
780
781 sub is_ak1a
782 {
783         my $self = shift;
784         return $self->{sort} eq 'A';
785 }
786
787 sub unset_passwd
788 {
789         my $self = shift;
790         delete $self->{passwd};
791 }
792
793 sub unset_passphrase
794 {
795         my $self = shift;
796         delete $self->{passphrase};
797 }
798
799 sub set_believe
800 {
801         my $self = shift;
802         my $call = uc shift;
803         $self->{believe} ||= [];
804         push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
805 }
806
807 sub unset_believe
808 {
809         my $self = shift;
810         my $call = uc shift;
811         if (exists $self->{believe}) {
812                 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
813                 delete $self->{believe} unless @{$self->{believe}};
814         }
815 }
816
817 sub believe
818 {
819         my $self = shift;
820         return exists $self->{believe} ? @{$self->{believe}} : ();
821 }
822
823 sub lastping
824 {
825         my $self = shift;
826         my $call = shift;
827         $self->{lastping} ||= {};
828         $self->{lastping} = {} unless ref $self->{lastping};
829         my $b = $self->{lastping};
830         $b->{$call} = shift if @_;
831         return $b->{$call};     
832 }
833 1;
834 __END__
835
836
837
838
839