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