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