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