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