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);
  29
  30 %u = ();
  31 $dbm = undef;
  32 $filename = undef;
  33 $lastoperinterval = 60*24*60*60;
  34 $lasttime = 0;
  35 $lrusize = 2000;
  36
  37 # hash of valid elements and a simple prompt
  38 %valid = (
  39                   call => '0,Callsign',
  40                   alias => '0,Real Callsign',
  41                   name => '0,Name',
  42                   qth => '0,Home QTH',
  43                   lat => '0,Latitude,slat',
  44                   long => '0,Longitude,slong',
  45                   qra => '0,Locator',
  46                   email => '0,E-mail Address,parray',
  47                   priv => '9,Privilege Level',
  48                   lastin => '0,Last Time in,cldatetime',
  49                   passwd => '9,Password,yesno',
  50                   passphrase => '9,Pass Phrase,yesno',
  51                   addr => '0,Full Address',
  52                   'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
  53                   xpert => '0,Expert Status,yesno',
  54                   bbs => '0,Home BBS',
  55                   node => '0,Last Node',
  56                   homenode => '0,Home Node',
  57                   lockout => '9,Locked out?,yesno',     # won't let them in at all
  58                   dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
  59                   annok => '9,Accept Announces?,yesno', # accept his announces?
  60                   lang => '0,Language',
  61                   hmsgno => '0,Highest Msgno',
  62                   group => '0,Access Group,parray',     # used to create a group of users/nodes for some purpose or other
  63                   isolate => '9,Isolate network,yesno',
  64                   wantbeep => '0,Req Beep,yesno',
  65                   wantann => '0,Req Announce,yesno',
  66                   wantwwv => '0,Req WWV,yesno',
  67                   wantwcy => '0,Req WCY,yesno',
  68                   wantecho => '0,Req Echo,yesno',
  69                   wanttalk => '0,Req Talk,yesno',
  70                   wantwx => '0,Req WX,yesno',
  71                   wantdx => '0,Req DX Spots,yesno',
  72                   wantemail => '0,Req Msgs as Email,yesno',
  73                   pagelth => '0,Current Pagelth',
  74                   pingint => '9,Node Ping interval',
  75                   nopings => '9,Ping Obs Count',
  76                   wantlogininfo => '9,Login info req,yesno',
  77           wantgrid => '0,DX Grid Info,yesno',
  78                   wantann_talk => '0,Talklike Anns,yesno',
  79                   wantpc90 => '1,Req PC90,yesno',
  80                   wantnp => '1,Req New Protocol,yesno',
  81                   lastoper => '9,Last for/oper,cldatetime',
  82                   nothere => '0,Not Here Text',
  83                   registered => '9,Registered?,yesno',
  84                   prompt => '0,Required Prompt',
  85                   version => '1,Version',
  86                   build => '1,Build',
  87                  );
  88
  89 #no strict;
  90 sub AUTOLOAD
  91 {
  92         my $self = shift;
  93         no strict;
  94         my $name = $AUTOLOAD;
  95
  96         return if $name =~ /::DESTROY$/;
  97         $name =~ s/^.*:://o;
  98
  99         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 100         # this clever line of code creates a subroutine which takes over from autoload
 101         # from OO Perl - Conway
 102         *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
 103         &$AUTOLOAD($self, @_);
 104 #       *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
 105 #       if (@_) {
 106 #               $self->{$name} = shift;
 107 #       }
 108 #       return $self->{$name};
 109 }
 110
 111 #use strict;
 112
 113 #
 114 # initialise the system
 115 #
 116 sub init
 117 {
 118         my ($pkg, $fn, $mode) = @_;
 119
 120         confess "need a filename in User" if !$fn;
 121         $fn .= ".v2";
 122         if ($mode) {
 123                 $dbm = tie (%u, 'DB_File', $fn, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
 124         } else {
 125                 $dbm = tie (%u, 'DB_File', $fn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
 126         }
 127
 128         $filename = $fn;
 129         $lru = LRU->newbase("DXUser", $lrusize);
 130 }
 131
 132 sub del_file
 133 {
 134         my ($pkg, $fn) = @_;
 135
 136         confess "need a filename in User" if !$fn;
 137         $fn .= ".v2";
 138         unlink $fn;
 139 }
 140
 141 #
 142 # periodic processing
 143 #
 144 sub process
 145 {
 146         if ($main::systime > $lasttime + 15) {
 147                 $dbm->sync;
 148                 $lasttime = $main::systime;
 149         }
 150 }
 151
 152 #
 153 # close the system
 154 #
 155
 156 sub finish
 157 {
 158         undef $dbm;
 159         untie %u;
 160 }
 161
 162 #
 163 # new - create a new user
 164 #
 165
 166 sub new
 167 {
 168         my $pkg = shift;
 169         my $call = uc shift;
 170         #  $call =~ s/-\d+$//o;
 171
 172 #       confess "can't create existing call $call in User\n!" if $u{$call};
 173
 174         my $self = bless {}, $pkg;
 175         $self->{call} = $call;
 176         $self->{'sort'} = 'U';
 177         $self->put;
 178         return $self;
 179 }
 180
 181 #
 182 # get - get an existing user - this seems to return a different reference everytime it is
 183 #       called - see below
 184 #
 185
 186 sub get
 187 {
 188         my $pkg = shift;
 189         my $call = uc shift;
 190         my $data;
 191
 192         # is it in the LRU cache?
 193         my $ref = $lru->get($call);
 194         return $ref if $ref;
 195
 196         # search for it
 197         unless ($dbm->get($call, $data)) {
 198                 $ref = decode($data);
 199                 $lru->put($call, $ref);
 200                 return $ref;
 201         }
 202         return undef;
 203 }
 204
 205 #
 206 # get an existing either from the channel (if there is one) or from the database
 207 #
 208 # It is important to note that if you have done a get (for the channel say) and you
 209 # want access or modify that you must use this call (and you must NOT use get's all
 210 # over the place willy nilly!)
 211 #
 212
 213 sub get_current
 214 {
 215         my $pkg = shift;
 216         my $call = uc shift;
 217
 218         my $dxchan = DXChannel->get($call);
 219         return $dxchan->user if $dxchan;
 220         my $rref = Route::get($call);
 221         return $rref->user if $rref && exists $rref->{user};
 222         return $pkg->get($call);
 223 }
 224
 225 #
 226 # get all callsigns in the database
 227 #
 228
 229 sub get_all_calls
 230 {
 231         return (sort keys %u);
 232 }
 233
 234 #
 235 # put - put a user
 236 #
 237
 238 sub put
 239 {
 240         my $self = shift;
 241         confess "Trying to put nothing!" unless $self && ref $self;
 242         my $call = $self->{call};
 243         # delete all instances of this
 244 #       for ($dbm->get_dup($call)) {
 245 #               $dbm->del_dup($call, $_);
 246 #       }
 247         $dbm->del($call);
 248         delete $self->{annok} if $self->{annok};
 249         delete $self->{dxok} if $self->{dxok};
 250         $lru->put($call, $self);
 251         my $ref = $self->encode;
 252         $dbm->put($call, $ref);
 253 }
 254
 255 #
 256 # create a string from a user reference
 257 #
 258 sub encode
 259 {
 260         my $self = shift;
 261         my $dd = new Data::Dumper([$self]);
 262         $dd->Indent(0);
 263         $dd->Terse(1);
 264     $dd->Quotekeys($] < 5.005 ? 1 : 0);
 265         return $dd->Dumpxs;
 266 }
 267
 268 #
 269 # create a hash from a string
 270 #
 271 sub decode
 272 {
 273         my $s = shift;
 274         my $ref;
 275         eval '$ref = ' . $s;
 276         if ($@) {
 277                 dbg($@);
 278                 Log('err', $@);
 279                 $ref = undef;
 280         }
 281         return $ref;
 282 }
 283
 284 #
 285 # del - delete a user
 286 #
 287
 288 sub del
 289 {
 290         my $self = shift;
 291         my $call = $self->{call};
 292         # delete all instances of this
 293 #       for ($dbm->get_dup($call)) {
 294 #               $dbm->del_dup($call, $_);
 295 #       }
 296         $lru->remove($call);
 297         $dbm->del($call);
 298 }
 299
 300 #
 301 # close - close down a user
 302 #
 303
 304 sub close
 305 {
 306         my $self = shift;
 307         $self->{lastin} = time;
 308         $self->put();
 309 }
 310
 311 #
 312 # sync the database
 313 #
 314
 315 sub sync
 316 {
 317         $dbm->sync;
 318 }
 319
 320 #
 321 # return a list of valid elements
 322 #
 323
 324 sub fields
 325 {
 326         return keys(%valid);
 327 }
 328
 329
 330 #
 331 # export the database to an ascii file
 332 #
 333
 334 sub export
 335 {
 336         my $fn = shift;
 337
 338         # save old ones
 339         rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
 340         rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
 341         rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
 342         rename "$fn.o", "$fn.oo" if -e "$fn.o";
 343         rename "$fn", "$fn.o" if -e "$fn";
 344
 345         my $count = 0;
 346         my $err = 0;
 347         my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
 348         if ($fh) {
 349                 my $key = 0;
 350                 my $val = undef;
 351                 my $action;
 352                 my $t = scalar localtime;
 353                 print $fh q{#!/usr/bin/perl
 354 #
 355 # The exported userfile for a DXSpider System
 356 #
 357 # Input file: $filename
 358 #       Time: $t
 359 #
 360
 361 package main;
 362
 363 # search local then perl directories
 364 BEGIN {
 365         umask 002;
 366
 367         # root of directory tree for this system
 368         $root = "/spider";
 369         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
 370
 371         unshift @INC, "$root/perl";     # this IS the right way round!
 372         unshift @INC, "$root/local";
 373
 374         # try to detect a lockfile (this isn't atomic but
 375         # should do for now
 376         $lockfn = "$root/perl/cluster.lck";       # lock file name
 377         if (-e $lockfn) {
 378                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
 379                 my $pid = <CLLOCK>;
 380                 chomp $pid;
 381                 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
 382                 close CLLOCK;
 383         }
 384 }
 385
 386 package DXUser;
 387
 388 use DXVars;
 389 use DXUser;
 390
 391 if (@ARGV) {
 392         $main::userfn = shift @ARGV;
 393         print "user filename now $userfn\n";
 394 }
 395
 396 DXUser->del_file($main::userfn);
 397 DXUser->init($main::userfn, 1);
 398 %u = ();
 399 my $count = 0;
 400 my $err = 0;
 401 while (<DATA>) {
 402         chomp;
 403         my @f = split /\t/;
 404         my $ref = decode($f[1]);
 405         if ($ref) {
 406                 $ref->put();
 407                 $count++;
 408         } else {
 409                 print "# Error: $f[0]\t$f[1]\n";
 410                 $err++
 411         }
 412 }
 413 DXUser->sync; DXUser->finish;
 414 print "There are $count user records and $err errors\n";
 415 };
 416                 print $fh "__DATA__\n";
 417
 418         for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
 419                         if (!is_callsign($key) || $key =~ /^0/) {
 420                                 Log('DXCommand', "Export Error1: $key\t$val");
 421                                 eval {$dbm->del($key)};
 422                                 dbg(carp("Export Error1: $key\t$val\n$@")) if $@;
 423                                 ++$err;
 424                                 next;
 425                         }
 426                         my $ref = decode($val);
 427                         if ($ref) {
 428                                 print $fh "$key\t" . $ref->encode . "\n";
 429                                 ++$count;
 430                         } else {
 431                                 Log('DXCommand', "Export Error2: $key\t$val");
 432                                 eval {$dbm->del($key)};
 433                                 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
 434                                 ++$err;
 435                         }
 436                 }
 437         $fh->close;
 438     }
 439         return "$count Users $err Errors ('sh/log Export' for details)";
 440 }
 441
 442 #
 443 # group handling
 444 #
 445
 446 # add one or more groups
 447 sub add_group
 448 {
 449         my $self = shift;
 450         my $ref = $self->{group} || [ 'local' ];
 451         $self->{group} = $ref if !$self->{group};
 452         push @$ref, @_ if @_;
 453 }
 454
 455 # remove one or more groups
 456 sub del_group
 457 {
 458         my $self = shift;
 459         my $ref = $self->{group} || [ 'local' ];
 460         my @in = @_;
 461
 462         $self->{group} = $ref if !$self->{group};
 463
 464         @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
 465 }
 466
 467 # does this thing contain all the groups listed?
 468 sub union
 469 {
 470         my $self = shift;
 471         my $ref = $self->{group};
 472         my $n;
 473
 474         return 0 if !$ref || @_ == 0;
 475         return 1 if @$ref == 0 && @_ == 0;
 476         for ($n = 0; $n < @_; ) {
 477                 for (@$ref) {
 478                         my $a = $_;
 479                         $n++ if grep $_ eq $a, @_;
 480                 }
 481         }
 482         return $n >= @_;
 483 }
 484
 485 # simplified group test just for one group
 486 sub in_group
 487 {
 488         my $self = shift;
 489         my $s = shift;
 490         my $ref = $self->{group};
 491
 492         return 0 if !$ref;
 493         return grep $_ eq $s, $ref;
 494 }
 495
 496 # set up a default group (only happens for them's that connect direct)
 497 sub new_group
 498 {
 499         my $self = shift;
 500         $self->{group} = [ 'local' ];
 501 }
 502
 503 #
 504 # return a prompt for a field
 505 #
 506
 507 sub field_prompt
 508 {
 509         my ($self, $ele) = @_;
 510         return $valid{$ele};
 511 }
 512
 513 # some variable accessors
 514 sub sort
 515 {
 516         my $self = shift;
 517         @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 518 }
 519
 520 # some accessors
 521 sub _want
 522 {
 523         my $n = shift;
 524         my $self = shift;
 525         my $val = shift;
 526         my $s = "want$n";
 527         $self->{$s} = $val if defined $val;
 528         return exists $self->{$s} ? $self->{$s} : 1;
 529 }
 530
 531 sub wantbeep
 532 {
 533         return _want('beep', @_);
 534 }
 535
 536 sub wantann
 537 {
 538         return _want('ann', @_);
 539 }
 540
 541 sub wantwwv
 542 {
 543         return _want('wwv', @_);
 544 }
 545
 546 sub wantwcy
 547 {
 548         return _want('wcy', @_);
 549 }
 550
 551 sub wantecho
 552 {
 553         return _want('echo', @_);
 554 }
 555
 556 sub wantwx
 557 {
 558         return _want('wx', @_);
 559 }
 560
 561 sub wantdx
 562 {
 563         return _want('dx', @_);
 564 }
 565
 566 sub wanttalk
 567 {
 568         return _want('talk', @_);
 569 }
 570
 571 sub wantgrid
 572 {
 573         return _want('grid', @_);
 574 }
 575
 576 sub wantemail
 577 {
 578         return _want('email', @_);
 579 }
 580
 581 sub wantann_talk
 582 {
 583         return _want('ann_talk', @_);
 584 }
 585
 586 sub wantlogininfo
 587 {
 588         my $self = shift;
 589         my $val = shift;
 590         $self->{wantlogininfo} = $val if defined $val;
 591         return $self->{wantlogininfo};
 592 }
 593
 594 sub is_node
 595 {
 596         my $self = shift;
 597         return $self->{sort} =~ /[ACRSX]/;
 598 }
 599
 600 sub is_user
 601 {
 602         my $self = shift;
 603         return $self->{sort} eq 'U';
 604 }
 605
 606 sub is_bbs
 607 {
 608         my $self = shift;
 609         return $self->{sort} eq 'B';
 610 }
 611
 612 sub is_spider
 613 {
 614         my $self = shift;
 615         return $self->{sort} eq 'S';
 616 }
 617
 618 sub is_clx
 619 {
 620         my $self = shift;
 621         return $self->{sort} eq 'C';
 622 }
 623
 624 sub is_dxnet
 625 {
 626         my $self = shift;
 627         return $self->{sort} eq 'X';
 628 }
 629
 630 sub is_arcluster
 631 {
 632         my $self = shift;
 633         return $self->{sort} eq 'R';
 634 }
 635
 636 sub is_ak1a
 637 {
 638         my $self = shift;
 639         return $self->{sort} eq 'A';
 640 }
 641
 642 sub unset_passwd
 643 {
 644         my $self = shift;
 645         delete $self->{passwd};
 646 }
 647
 648 sub unset_passphrase
 649 {
 650         my $self = shift;
 651         delete $self->{passphrase};
 652 }
 653 1;
 654 __END__
 655
 656
 657
 658
 659