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