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(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
  23
  24 %u = ();
  25 $dbm = undef;
  26 $filename = undef;
  27 $lastoperinterval = 60*24*60*60;
  28 $lasttime = 0;
  29 $lrusize = 2000;
  30 $tooold = 86400 * 365;          # this marks an old user who hasn't given enough info to be useful
  31 $v3 = 0;
  32
  33 # hash of valid elements and a simple prompt
  34 %valid = (
  35                   call => '0,Callsign',
  36                   alias => '0,Real Callsign',
  37                   name => '0,Name',
  38                   qth => '0,Home QTH',
  39                   lat => '0,Latitude,slat',
  40                   long => '0,Longitude,slong',
  41                   qra => '0,Locator',
  42                   email => '0,E-mail Address,parray',
  43                   priv => '9,Privilege Level',
  44                   lastin => '0,Last Time in,cldatetime',
  45                   passwd => '9,Password,yesno',
  46                   passphrase => '9,Pass Phrase,yesno',
  47                   addr => '0,Full Address',
  48                   'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
  49                   xpert => '0,Expert Status,yesno',
  50                   bbs => '0,Home BBS',
  51                   node => '0,Last Node',
  52                   homenode => '0,Home Node',
  53                   lockout => '9,Locked out?,yesno',     # won't let them in at all
  54                   dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
  55                   annok => '9,Accept Announces?,yesno', # accept his announces?
  56                   lang => '0,Language',
  57                   hmsgno => '0,Highest Msgno',
  58                   group => '0,Group,parray',    # used to create a group of users/nodes for some purpose or other
  59                   buddies => '0,Buddies,parray',
  60                   isolate => '9,Isolate network,yesno',
  61                   wantbeep => '0,Req Beep,yesno',
  62                   wantann => '0,Req Announce,yesno',
  63                   wantwwv => '0,Req WWV,yesno',
  64                   wantwcy => '0,Req WCY,yesno',
  65                   wantecho => '0,Req Echo,yesno',
  66                   wanttalk => '0,Req Talk,yesno',
  67                   wantwx => '0,Req WX,yesno',
  68                   wantdx => '0,Req DX Spots,yesno',
  69                   wantemail => '0,Req Msgs as Email,yesno',
  70                   pagelth => '0,Current Pagelth',
  71                   pingint => '9,Node Ping interval',
  72                   nopings => '9,Ping Obs Count',
  73                   wantlogininfo => '0,Login Info Req,yesno',
  74           wantgrid => '0,Show DX Grid,yesno',
  75                   wantann_talk => '0,Talklike Anns,yesno',
  76                   wantpc16 => '9,Want Users from node,yesno',
  77                   wantsendpc16 => '9,Send PC16,yesno',
  78                   wantroutepc19 => '9,Route PC19,yesno',
  79                   wantusstate => '0,Show US State,yesno',
  80                   wantdxcq => '0,Show CQ Zone,yesno',
  81                   wantdxitu => '0,Show ITU Zone,yesno',
  82                   wantgtk => '0,Want GTK interface,yesno',
  83                   lastoper => '9,Last for/oper,cldatetime',
  84                   nothere => '0,Not Here Text',
  85                   registered => '9,Registered?,yesno',
  86                   prompt => '0,Required Prompt',
  87                   version => '1,Version',
  88                   build => '1,Build',
  89                   believe => '1,Believable nodes,parray',
  90                   lastping => '1,Last Ping at,ptimelist',
  91                  );
  92
  93 #no strict;
  94 sub AUTOLOAD
  95 {
  96         no strict;
  97         my $name = $AUTOLOAD;
  98
  99         return if $name =~ /::DESTROY$/;
 100         $name =~ s/^.*:://o;
 101
 102         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 103         # this clever line of code creates a subroutine which takes over from autoload
 104         # from OO Perl - Conway
 105         *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
 106        goto &$AUTOLOAD;
 107 }
 108
 109 #use strict;
 110
 111 #
 112 # initialise the system
 113 #
 114 sub init
 115 {
 116         my ($pkg, $fn, $mode) = @_;
 117
 118         confess "need a filename in User" if !$fn;
 119
 120         my $ufn;
 121         my $convert;
 122
 123         eval {
 124                 require Storable;
 125         };
 126
 127 #       eval "use Storable qw(nfreeze thaw)";
 128
 129         if ($@) {
 130                 $ufn = "$fn.v2";
 131                 $v3 = $convert = 0;
 132                 dbg("the module Storable appears to be missing!!");
 133                 dbg("trying to continue in compatibility mode (this may fail)");
 134                 dbg("please install Storable from CPAN as soon as possible");
 135         } else {
 136                 import Storable qw(nfreeze thaw);
 137
 138                 $ufn = "$fn.v3";
 139                 $v3 = 1;
 140                 $convert++ if -e "$fn.v2" && !-e $ufn;
 141         }
 142
 143         if ($mode) {
 144                 $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?]";
 145         } else {
 146                 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
 147         }
 148
 149         die "Cannot open $ufn ($!)\n" unless $dbm;
 150
 151         $lru = LRU->newbase("DXUser", $lrusize);
 152
 153         # do a conversion if required
 154         if ($dbm && $convert) {
 155                 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
 156
 157                 my %oldu;
 158                 dbg("Converting the User File to V3 ");
 159                 dbg("This will take a while, I suggest you go and have cup of strong tea");
 160                 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?]";
 161         for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
 162                         my $ref = asc_decode($val);
 163                         if ($ref) {
 164                                 $ref->put;
 165                                 $count++;
 166                         } else {
 167                                 $err++
 168                         }
 169                 }
 170                 undef $odbm;
 171                 untie %oldu;
 172                 dbg("Conversion completed $count records $err errors");
 173         }
 174         $filename = $ufn;
 175 }
 176
 177 sub del_file
 178 {
 179         my ($pkg, $fn) = @_;
 180
 181         confess "need a filename in User" if !$fn;
 182         $fn .= $v3 ? ".v3" : ".v2";
 183         unlink $fn;
 184 }
 185
 186 #
 187 # periodic processing
 188 #
 189 sub process
 190 {
 191         if ($main::systime > $lasttime + 15) {
 192                 $dbm->sync;
 193                 $lasttime = $main::systime;
 194         }
 195 }
 196
 197 #
 198 # close the system
 199 #
 200
 201 sub finish
 202 {
 203         undef $dbm;
 204         untie %u;
 205 }
 206
 207 #
 208 # new - create a new user
 209 #
 210
 211 sub alloc
 212 {
 213         my $pkg = shift;
 214         my $call = uc shift;
 215         my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
 216         return $self;
 217 }
 218
 219 sub new
 220 {
 221         my $pkg = shift;
 222         my $call = shift;
 223         #  $call =~ s/-\d+$//o;
 224
 225 #       confess "can't create existing call $call in User\n!" if $u{$call};
 226
 227         my $self = $pkg->alloc($call);
 228         $self->put;
 229         return $self;
 230 }
 231
 232 #
 233 # get - get an existing user - this seems to return a different reference everytime it is
 234 #       called - see below
 235 #
 236
 237 sub get
 238 {
 239         my $pkg = shift;
 240         my $call = uc shift;
 241         my $data;
 242
 243         # is it in the LRU cache?
 244         my $ref = $lru->get($call);
 245         return $ref if $ref;
 246
 247         # search for it
 248         unless ($dbm->get($call, $data)) {
 249                 $ref = decode($data);
 250                 $lru->put($call, $ref);
 251                 return $ref;
 252         }
 253         return undef;
 254 }
 255
 256 #
 257 # get an existing either from the channel (if there is one) or from the database
 258 #
 259 # It is important to note that if you have done a get (for the channel say) and you
 260 # want access or modify that you must use this call (and you must NOT use get's all
 261 # over the place willy nilly!)
 262 #
 263
 264 sub get_current
 265 {
 266         my $pkg = shift;
 267         my $call = uc shift;
 268
 269         my $dxchan = DXChannel::get($call);
 270         return $dxchan->user if $dxchan;
 271         my $rref = Route::get($call);
 272         return $rref->user if $rref && exists $rref->{user};
 273         return $pkg->get($call);
 274 }
 275
 276 #
 277 # get all callsigns in the database
 278 #
 279
 280 sub get_all_calls
 281 {
 282         return (sort keys %u);
 283 }
 284
 285 #
 286 # put - put a user
 287 #
 288
 289 sub put
 290 {
 291         my $self = shift;
 292         confess "Trying to put nothing!" unless $self && ref $self;
 293         my $call = $self->{call};
 294         # delete all instances of this
 295 #       for ($dbm->get_dup($call)) {
 296 #               $dbm->del_dup($call, $_);
 297 #       }
 298         $dbm->del($call);
 299         delete $self->{annok} if $self->{annok};
 300         delete $self->{dxok} if $self->{dxok};
 301         $lru->put($call, $self);
 302         my $ref = $self->encode;
 303         $dbm->put($call, $ref);
 304 }
 305
 306 # freeze the user
 307 sub encode
 308 {
 309         goto &asc_encode unless $v3;
 310         my $self = shift;
 311         return nfreeze($self);
 312 }
 313
 314 # thaw the user
 315 sub decode
 316 {
 317         goto &asc_decode unless $v3;
 318         return thaw(shift);
 319 }
 320
 321 #
 322 # create a string from a user reference (in_ascii)
 323 #
 324 sub asc_encode
 325 {
 326         my $self = shift;
 327         return dd($self);
 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         $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
 338         eval '$ref = ' . $s;
 339         if ($@) {
 340                 LogDbg('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                                 my $eval = $val;
 484                                 my $ekey = $key;
 485                                 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 486                                 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 487                                 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
 488                                 eval {$dbm->del($key)};
 489                                 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
 490                                 ++$err;
 491                                 next;
 492                         }
 493                         my $ref = decode($val);
 494                         if ($ref) {
 495                                 my $t = $ref->{lastin} || 0;
 496                                 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
 497                                         unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
 498                                                 eval {$dbm->del($key)};
 499                                                 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
 500                                                 LogDbg('DXCommand', "$ref->{call} deleted, too old");
 501                                                 $del++;
 502                                                 next;
 503                                         }
 504                                 }
 505                                 # only store users that are reasonably active or have useful information
 506                                 print $fh "$key\t" . $ref->asc_encode . "\n";
 507                                 ++$count;
 508                         } else {
 509                                 LogDbg('DXCommand', "Export Error3: $key\t$val");
 510                                 eval {$dbm->del($key)};
 511                                 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
 512                                 ++$err;
 513                         }
 514                 }
 515         $fh->close;
 516     }
 517         return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
 518 }
 519
 520 #
 521 # group handling
 522 #
 523
 524 # add one or more groups
 525 sub add_group
 526 {
 527         my $self = shift;
 528         my $ref = $self->{group} || [ 'local' ];
 529         $self->{group} = $ref if !$self->{group};
 530         push @$ref, @_ if @_;
 531 }
 532
 533 # remove one or more groups
 534 sub del_group
 535 {
 536         my $self = shift;
 537         my $ref = $self->{group} || [ 'local' ];
 538         my @in = @_;
 539
 540         $self->{group} = $ref if !$self->{group};
 541
 542         @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
 543 }
 544
 545 # does this thing contain all the groups listed?
 546 sub union
 547 {
 548         my $self = shift;
 549         my $ref = $self->{group};
 550         my $n;
 551
 552         return 0 if !$ref || @_ == 0;
 553         return 1 if @$ref == 0 && @_ == 0;
 554         for ($n = 0; $n < @_; ) {
 555                 for (@$ref) {
 556                         my $a = $_;
 557                         $n++ if grep $_ eq $a, @_;
 558                 }
 559         }
 560         return $n >= @_;
 561 }
 562
 563 # simplified group test just for one group
 564 sub in_group
 565 {
 566         my $self = shift;
 567         my $s = shift;
 568         my $ref = $self->{group};
 569
 570         return 0 if !$ref;
 571         return grep $_ eq $s, $ref;
 572 }
 573
 574 # set up a default group (only happens for them's that connect direct)
 575 sub new_group
 576 {
 577         my $self = shift;
 578         $self->{group} = [ 'local' ];
 579 }
 580
 581 # set up empty buddies (only happens for them's that connect direct)
 582 sub new_buddies
 583 {
 584         my $self = shift;
 585         $self->{buddies} = [  ];
 586 }
 587
 588 #
 589 # return a prompt for a field
 590 #
 591
 592 sub field_prompt
 593 {
 594         my ($self, $ele) = @_;
 595         return $valid{$ele};
 596 }
 597
 598 # some variable accessors
 599 sub sort
 600 {
 601         my $self = shift;
 602         @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 603 }
 604
 605 # some accessors
 606
 607 # want is default = 1
 608 sub _want
 609 {
 610         my $n = shift;
 611         my $self = shift;
 612         my $val = shift;
 613         my $s = "want$n";
 614         $self->{$s} = $val if defined $val;
 615         return exists $self->{$s} ? $self->{$s} : 1;
 616 }
 617
 618 # wantnot is default = 0
 619 sub _wantnot
 620 {
 621         my $n = shift;
 622         my $self = shift;
 623         my $val = shift;
 624         my $s = "want$n";
 625         $self->{$s} = $val if defined $val;
 626         return exists $self->{$s} ? $self->{$s} : 0;
 627 }
 628
 629 sub wantbeep
 630 {
 631         return _want('beep', @_);
 632 }
 633
 634 sub wantann
 635 {
 636         return _want('ann', @_);
 637 }
 638
 639 sub wantwwv
 640 {
 641         return _want('wwv', @_);
 642 }
 643
 644 sub wantwcy
 645 {
 646         return _want('wcy', @_);
 647 }
 648
 649 sub wantecho
 650 {
 651         return _want('echo', @_);
 652 }
 653
 654 sub wantwx
 655 {
 656         return _want('wx', @_);
 657 }
 658
 659 sub wantdx
 660 {
 661         return _want('dx', @_);
 662 }
 663
 664 sub wanttalk
 665 {
 666         return _want('talk', @_);
 667 }
 668
 669 sub wantgrid
 670 {
 671         return _want('grid', @_);
 672 }
 673
 674 sub wantemail
 675 {
 676         return _want('email', @_);
 677 }
 678
 679 sub wantann_talk
 680 {
 681         return _want('ann_talk', @_);
 682 }
 683
 684 sub wantpc16
 685 {
 686         return _want('pc16', @_);
 687 }
 688
 689 sub wantsendpc16
 690 {
 691         return _want('sendpc16', @_);
 692 }
 693
 694 sub wantroutepc16
 695 {
 696         return _want('routepc16', @_);
 697 }
 698
 699 sub wantusstate
 700 {
 701         return _want('usstate', @_);
 702 }
 703
 704 sub wantdxcq
 705 {
 706         return _want('dxcq', @_);
 707 }
 708
 709 sub wantdxitu
 710 {
 711         return _want('dxitu', @_);
 712 }
 713
 714 sub wantgtk
 715 {
 716         return _want('gtk', @_);
 717 }
 718
 719 sub wantlogininfo
 720 {
 721         my $self = shift;
 722         my $val = shift;
 723         $self->{wantlogininfo} = $val if defined $val;
 724         return $self->{wantlogininfo};
 725 }
 726
 727 sub is_node
 728 {
 729         my $self = shift;
 730         return $self->{sort} =~ /[ACRSX]/;
 731 }
 732
 733 sub is_local_node
 734 {
 735         my $self = shift;
 736         return grep $_ eq 'local_node', @{$self->{group}};
 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