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