perl/DXUser.pm

   1 #
   2 # DX cluster user routines
   3 #
   4 # Copyright (c) 1998 - Dirk Koopman G1TLH
   5 #
   6 #
   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(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3);
  23
  24 %u = ();
  25 $dbm = undef;
  26 $filename = undef;
  27 $lastoperinterval = 60*24*60*60;
  28 $lasttime = 0;
  29 $lrusize = 2000;
  30 $tooold = 86400 * 365;          # this marks an old user who hasn't given enough info to be useful
  31 $v3 = 0;
  32
  33 # hash of valid elements and a simple prompt
  34 %valid = (
  35                   call => '0,Callsign',
  36                   alias => '0,Real Callsign',
  37                   name => '0,Name',
  38                   qth => '0,Home QTH',
  39                   lat => '0,Latitude,slat',
  40                   long => '0,Longitude,slong',
  41                   qra => '0,Locator',
  42                   email => '0,E-mail Address,parray',
  43                   priv => '9,Privilege Level',
  44                   lastin => '0,Last Time in,cldatetime',
  45                   passwd => '9,Password,yesno',
  46                   passphrase => '9,Pass Phrase,yesno',
  47                   addr => '0,Full Address',
  48                   'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
  49                   xpert => '0,Expert Status,yesno',
  50                   bbs => '0,Home BBS',
  51                   node => '0,Last Node',
  52                   homenode => '0,Home Node',
  53                   lockout => '9,Locked out?,yesno',     # won't let them in at all
  54                   dxok => '9,Accept DX Spots?,yesno', # accept his dx spots?
  55                   annok => '9,Accept Announces?,yesno', # accept his announces?
  56                   lang => '0,Language',
  57                   hmsgno => '0,Highest Msgno',
  58                   group => '0,Group,parray',    # used to create a group of users/nodes for some purpose or other
  59                   buddies => '0,Buddies,parray',
  60                   isolate => '9,Isolate network,yesno',
  61                   wantbeep => '0,Req Beep,yesno',
  62                   wantann => '0,Req Announce,yesno',
  63                   wantwwv => '0,Req WWV,yesno',
  64                   wantwcy => '0,Req WCY,yesno',
  65                   wantecho => '0,Req Echo,yesno',
  66                   wanttalk => '0,Req Talk,yesno',
  67                   wantwx => '0,Req WX,yesno',
  68                   wantdx => '0,Req DX Spots,yesno',
  69                   wantemail => '0,Req Msgs as Email,yesno',
  70                   pagelth => '0,Current Pagelth',
  71                   pingint => '9,Node Ping interval',
  72                   nopings => '9,Ping Obs Count',
  73                   wantlogininfo => '0,Login Info Req,yesno',
  74           wantgrid => '0,Show DX Grid,yesno',
  75                   wantann_talk => '0,Talklike Anns,yesno',
  76                   wantpc16 => '9,Want Users from node,yesno',
  77                   wantsendpc16 => '9,Send PC16,yesno',
  78                   wantroutepc19 => '9,Route PC19,yesno',
  79                   wantusstate => '0,Show US State,yesno',
  80                   wantdxcq => '0,Show CQ Zone,yesno',
  81                   wantdxitu => '0,Show ITU Zone,yesno',
  82                   wantgtk => '0,Want GTK interface,yesno',
  83                   wantpc9x => '0,Want PC9X interface,yesno',
  84                   lastoper => '9,Last for/oper,cldatetime',
  85                   nothere => '0,Not Here Text',
  86                   registered => '9,Registered?,yesno',
  87                   prompt => '0,Required Prompt',
  88                   version => '1,Version',
  89                   build => '1,Build',
  90                   believe => '1,Believable nodes,parray',
  91                   lastping => '1,Last Ping at,ptimelist',
  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++ if -e "$fn.v2" && !-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         die "Cannot open $ufn ($!)\n" unless $dbm;
 151
 152         $lru = LRU->newbase("DXUser", $lrusize);
 153
 154         # do a conversion if required
 155         if ($dbm && $convert) {
 156                 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
 157
 158                 my %oldu;
 159                 dbg("Converting the User File to V3 ");
 160                 dbg("This will take a while, I suggest you go and have cup of strong tea");
 161                 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?]";
 162         for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
 163                         my $ref = asc_decode($val);
 164                         if ($ref) {
 165                                 $ref->put;
 166                                 $count++;
 167                         } else {
 168                                 $err++
 169                         }
 170                 }
 171                 undef $odbm;
 172                 untie %oldu;
 173                 dbg("Conversion completed $count records $err errors");
 174         }
 175         $filename = $ufn;
 176 }
 177
 178 sub del_file
 179 {
 180         my ($pkg, $fn) = @_;
 181
 182         confess "need a filename in User" if !$fn;
 183         $fn .= $v3 ? ".v3" : ".v2";
 184         unlink $fn;
 185 }
 186
 187 #
 188 # periodic processing
 189 #
 190 sub process
 191 {
 192         if ($main::systime > $lasttime + 15) {
 193                 $dbm->sync;
 194                 $lasttime = $main::systime;
 195         }
 196 }
 197
 198 #
 199 # close the system
 200 #
 201
 202 sub finish
 203 {
 204         undef $dbm;
 205         untie %u;
 206 }
 207
 208 #
 209 # new - create a new user
 210 #
 211
 212 sub alloc
 213 {
 214         my $pkg = shift;
 215         my $call = uc shift;
 216         my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
 217         return $self;
 218 }
 219
 220 sub new
 221 {
 222         my $pkg = shift;
 223         my $call = shift;
 224         #  $call =~ s/-\d+$//o;
 225
 226 #       confess "can't create existing call $call in User\n!" if $u{$call};
 227
 228         my $self = $pkg->alloc($call);
 229         $self->put;
 230         return $self;
 231 }
 232
 233 #
 234 # get - get an existing user - this seems to return a different reference everytime it is
 235 #       called - see below
 236 #
 237
 238 sub get
 239 {
 240         my $call = uc shift;
 241         my $data;
 242
 243         # is it in the LRU cache?
 244         my $ref = $lru->get($call);
 245         return $ref if $ref;
 246
 247         # search for it
 248         unless ($dbm->get($call, $data)) {
 249                 $ref = decode($data);
 250                 dbg("DXUser::get: data error on $call $!") unless $ref;
 251                 if ($ref && ref $ref ne 'DXUser') {
 252                         dbg("DXUser::get: got strange answer from decode ". ref $ref. " ignoring");
 253                         return undef;
 254                 }
 255                 $lru->put($call, $ref);
 256                 return $ref;
 257         }
 258         return undef;
 259 }
 260
 261 #
 262 # get an existing either from the channel (if there is one) or from the database
 263 #
 264 # It is important to note that if you have done a get (for the channel say) and you
 265 # want access or modify that you must use this call (and you must NOT use get's all
 266 # over the place willy nilly!)
 267 #
 268
 269 sub get_current
 270 {
 271         my $call = uc shift;
 272
 273         my $dxchan = DXChannel::get($call);
 274         return $dxchan->user if $dxchan;
 275         return get($call);
 276 }
 277
 278 #
 279 # get all callsigns in the database
 280 #
 281
 282 sub get_all_calls
 283 {
 284         return (sort keys %u);
 285 }
 286
 287 #
 288 # put - put a user
 289 #
 290
 291 sub put
 292 {
 293         my $self = shift;
 294         confess "Trying to put nothing!" unless $self && ref $self;
 295         my $call = $self->{call};
 296         # delete all instances of this
 297 #       for ($dbm->get_dup($call)) {
 298 #               $dbm->del_dup($call, $_);
 299 #       }
 300         $dbm->del($call);
 301         delete $self->{annok} if $self->{annok};
 302         delete $self->{dxok} if $self->{dxok};
 303         $lru->put($call, $self);
 304         my $ref = $self->encode;
 305         $dbm->put($call, $ref);
 306 }
 307
 308 # freeze the user
 309 sub encode
 310 {
 311         goto &asc_encode unless $v3;
 312         my $self = shift;
 313         return nfreeze($self);
 314 }
 315
 316 # thaw the user
 317 sub decode
 318 {
 319         goto &asc_decode unless $v3;
 320         return thaw(shift);
 321 }
 322
 323 #
 324 # create a string from a user reference (in_ascii)
 325 #
 326 sub asc_encode
 327 {
 328         my $self = shift;
 329         return dd($self);
 330 }
 331
 332 #
 333 # create a hash from a string (in ascii)
 334 #
 335 sub asc_decode
 336 {
 337         my $s = shift;
 338         my $ref;
 339         $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
 340         eval '$ref = ' . $s;
 341         if ($@) {
 342                 LogDbg('err', $@);
 343                 $ref = undef;
 344         }
 345         return $ref;
 346 }
 347
 348 #
 349 # del - delete a user
 350 #
 351
 352 sub del
 353 {
 354         my $self = shift;
 355         my $call = $self->{call};
 356         # delete all instances of this
 357 #       for ($dbm->get_dup($call)) {
 358 #               $dbm->del_dup($call, $_);
 359 #       }
 360         $lru->remove($call);
 361         $dbm->del($call);
 362 }
 363
 364 #
 365 # close - close down a user
 366 #
 367
 368 sub close
 369 {
 370         my $self = shift;
 371         $self->{lastin} = time;
 372         $self->put();
 373 }
 374
 375 #
 376 # sync the database
 377 #
 378
 379 sub sync
 380 {
 381         $dbm->sync;
 382 }
 383
 384 #
 385 # return a list of valid elements
 386 #
 387
 388 sub fields
 389 {
 390         return keys(%valid);
 391 }
 392
 393
 394 #
 395 # export the database to an ascii file
 396 #
 397
 398 sub export
 399 {
 400         my $fn = shift;
 401
 402         # save old ones
 403         rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
 404         rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
 405         rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
 406         rename "$fn.o", "$fn.oo" if -e "$fn.o";
 407         rename "$fn", "$fn.o" if -e "$fn";
 408
 409         my $count = 0;
 410         my $err = 0;
 411         my $del = 0;
 412         my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
 413         if ($fh) {
 414                 my $key = 0;
 415                 my $val = undef;
 416                 my $action;
 417                 my $t = scalar localtime;
 418                 print $fh q{#!/usr/bin/perl
 419 #
 420 # The exported userfile for a DXSpider System
 421 #
 422 # Input file: $filename
 423 #       Time: $t
 424 #
 425
 426 package main;
 427
 428 # search local then perl directories
 429 BEGIN {
 430         umask 002;
 431
 432         # root of directory tree for this system
 433         $root = "/spider";
 434         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
 435
 436         unshift @INC, "$root/perl";     # this IS the right way round!
 437         unshift @INC, "$root/local";
 438
 439         # try to detect a lockfile (this isn't atomic but
 440         # should do for now
 441         $lockfn = "$root/local/cluster.lck";       # lock file name
 442         if (-e $lockfn) {
 443                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
 444                 my $pid = <CLLOCK>;
 445                 chomp $pid;
 446                 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
 447                 close CLLOCK;
 448         }
 449 }
 450
 451 package DXUser;
 452
 453 use DXVars;
 454 use DXUser;
 455
 456 if (@ARGV) {
 457         $main::userfn = shift @ARGV;
 458         print "user filename now $userfn\n";
 459 }
 460
 461 DXUser->del_file($main::userfn);
 462 DXUser->init($main::userfn, 1);
 463 %u = ();
 464 my $count = 0;
 465 my $err = 0;
 466 while (<DATA>) {
 467         chomp;
 468         my @f = split /\t/;
 469         my $ref = asc_decode($f[1]);
 470         if ($ref) {
 471                 $ref->put();
 472                 $count++;
 473         } else {
 474                 print "# Error: $f[0]\t$f[1]\n";
 475                 $err++
 476         }
 477 }
 478 DXUser->sync; DXUser->finish;
 479 print "There are $count user records and $err errors\n";
 480 };
 481                 print $fh "__DATA__\n";
 482
 483         for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
 484                         if (!is_callsign($key) || $key =~ /^0/) {
 485                                 my $eval = $val;
 486                                 my $ekey = $key;
 487                                 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 488                                 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 489                                 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
 490                                 eval {$dbm->del($key)};
 491                                 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
 492                                 ++$err;
 493                                 next;
 494                         }
 495                         my $ref = decode($val);
 496                         if ($ref) {
 497                                 my $t = $ref->{lastin} || 0;
 498                                 if ($ref->{sort} eq 'U' && !$ref->{priv} && $main::systime > $t + $tooold) {
 499                                         unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
 500                                                 eval {$dbm->del($key)};
 501                                                 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
 502                                                 LogDbg('DXCommand', "$ref->{call} deleted, too old");
 503                                                 $del++;
 504                                                 next;
 505                                         }
 506                                 }
 507                                 # only store users that are reasonably active or have useful information
 508                                 print $fh "$key\t" . $ref->asc_encode . "\n";
 509                                 ++$count;
 510                         } else {
 511                                 LogDbg('DXCommand', "Export Error3: $key\t$val");
 512                                 eval {$dbm->del($key)};
 513                                 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
 514                                 ++$err;
 515                         }
 516                 }
 517         $fh->close;
 518     }
 519         return "$count Users $del Deleted $err Errors ('sh/log Export' for details)";
 520 }
 521
 522 #
 523 # group handling
 524 #
 525
 526 # add one or more groups
 527 sub add_group
 528 {
 529         my $self = shift;
 530         my $ref = $self->{group} || [ 'local' ];
 531         $self->{group} = $ref if !$self->{group};
 532         push @$ref, @_ if @_;
 533 }
 534
 535 # remove one or more groups
 536 sub del_group
 537 {
 538         my $self = shift;
 539         my $ref = $self->{group} || [ 'local' ];
 540         my @in = @_;
 541
 542         $self->{group} = $ref if !$self->{group};
 543
 544         @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
 545 }
 546
 547 # does this thing contain all the groups listed?
 548 sub union
 549 {
 550         my $self = shift;
 551         my $ref = $self->{group};
 552         my $n;
 553
 554         return 0 if !$ref || @_ == 0;
 555         return 1 if @$ref == 0 && @_ == 0;
 556         for ($n = 0; $n < @_; ) {
 557                 for (@$ref) {
 558                         my $a = $_;
 559                         $n++ if grep $_ eq $a, @_;
 560                 }
 561         }
 562         return $n >= @_;
 563 }
 564
 565 # simplified group test just for one group
 566 sub in_group
 567 {
 568         my $self = shift;
 569         my $s = shift;
 570         my $ref = $self->{group};
 571
 572         return 0 if !$ref;
 573         return grep $_ eq $s, $ref;
 574 }
 575
 576 # set up a default group (only happens for them's that connect direct)
 577 sub new_group
 578 {
 579         my $self = shift;
 580         $self->{group} = [ 'local' ];
 581 }
 582
 583 # set up empty buddies (only happens for them's that connect direct)
 584 sub new_buddies
 585 {
 586         my $self = shift;
 587         $self->{buddies} = [  ];
 588 }
 589
 590 #
 591 # return a prompt for a field
 592 #
 593
 594 sub field_prompt
 595 {
 596         my ($self, $ele) = @_;
 597         return $valid{$ele};
 598 }
 599
 600 # some variable accessors
 601 sub sort
 602 {
 603         my $self = shift;
 604         @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 605 }
 606
 607 # some accessors
 608
 609 # want is default = 1
 610 sub _want
 611 {
 612         my $n = shift;
 613         my $self = shift;
 614         my $val = shift;
 615         my $s = "want$n";
 616         $self->{$s} = $val if defined $val;
 617         return exists $self->{$s} ? $self->{$s} : 1;
 618 }
 619
 620 # wantnot is default = 0
 621 sub _wantnot
 622 {
 623         my $n = shift;
 624         my $self = shift;
 625         my $val = shift;
 626         my $s = "want$n";
 627         $self->{$s} = $val if defined $val;
 628         return exists $self->{$s} ? $self->{$s} : 0;
 629 }
 630
 631 sub wantbeep
 632 {
 633         return _want('beep', @_);
 634 }
 635
 636 sub wantann
 637 {
 638         return _want('ann', @_);
 639 }
 640
 641 sub wantwwv
 642 {
 643         return _want('wwv', @_);
 644 }
 645
 646 sub wantwcy
 647 {
 648         return _want('wcy', @_);
 649 }
 650
 651 sub wantecho
 652 {
 653         return _want('echo', @_);
 654 }
 655
 656 sub wantwx
 657 {
 658         return _want('wx', @_);
 659 }
 660
 661 sub wantdx
 662 {
 663         return _want('dx', @_);
 664 }
 665
 666 sub wanttalk
 667 {
 668         return _want('talk', @_);
 669 }
 670
 671 sub wantgrid
 672 {
 673         return _want('grid', @_);
 674 }
 675
 676 sub wantemail
 677 {
 678         return _want('email', @_);
 679 }
 680
 681 sub wantann_talk
 682 {
 683         return _want('ann_talk', @_);
 684 }
 685
 686 sub wantpc16
 687 {
 688         return _want('pc16', @_);
 689 }
 690
 691 sub wantsendpc16
 692 {
 693         return _want('sendpc16', @_);
 694 }
 695
 696 sub wantroutepc16
 697 {
 698         return _want('routepc16', @_);
 699 }
 700
 701 sub wantusstate
 702 {
 703         return _want('usstate', @_);
 704 }
 705
 706 sub wantdxcq
 707 {
 708         return _want('dxcq', @_);
 709 }
 710
 711 sub wantdxitu
 712 {
 713         return _want('dxitu', @_);
 714 }
 715
 716 sub wantgtk
 717 {
 718         return _want('gtk', @_);
 719 }
 720
 721 sub wantpc9x
 722 {
 723         return _want('pc9x', @_);
 724 }
 725
 726 sub wantlogininfo
 727 {
 728         my $self = shift;
 729         my $val = shift;
 730         $self->{wantlogininfo} = $val if defined $val;
 731         return $self->{wantlogininfo};
 732 }
 733
 734 sub is_node
 735 {
 736         my $self = shift;
 737         return $self->{sort} =~ /[ACRSX]/;
 738 }
 739
 740 sub is_local_node
 741 {
 742         my $self = shift;
 743         return grep $_ eq 'local_node', @{$self->{group}};
 744 }
 745
 746 sub is_user
 747 {
 748         my $self = shift;
 749         return $self->{sort} eq 'U';
 750 }
 751
 752 sub is_bbs
 753 {
 754         my $self = shift;
 755         return $self->{sort} eq 'B';
 756 }
 757
 758 sub is_spider
 759 {
 760         my $self = shift;
 761         return $self->{sort} eq 'S';
 762 }
 763
 764 sub is_clx
 765 {
 766         my $self = shift;
 767         return $self->{sort} eq 'C';
 768 }
 769
 770 sub is_dxnet
 771 {
 772         my $self = shift;
 773         return $self->{sort} eq 'X';
 774 }
 775
 776 sub is_arcluster
 777 {
 778         my $self = shift;
 779         return $self->{sort} eq 'R';
 780 }
 781
 782 sub is_ak1a
 783 {
 784         my $self = shift;
 785         return $self->{sort} eq 'A';
 786 }
 787
 788 sub unset_passwd
 789 {
 790         my $self = shift;
 791         delete $self->{passwd};
 792 }
 793
 794 sub unset_passphrase
 795 {
 796         my $self = shift;
 797         delete $self->{passphrase};
 798 }
 799
 800 sub set_believe
 801 {
 802         my $self = shift;
 803         my $call = uc shift;
 804         $self->{believe} ||= [];
 805         push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
 806 }
 807
 808 sub unset_believe
 809 {
 810         my $self = shift;
 811         my $call = uc shift;
 812         if (exists $self->{believe}) {
 813                 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
 814                 delete $self->{believe} unless @{$self->{believe}};
 815         }
 816 }
 817
 818 sub believe
 819 {
 820         my $self = shift;
 821         return exists $self->{believe} ? @{$self->{believe}} : ();
 822 }
 823
 824 sub lastping
 825 {
 826         my $self = shift;
 827         my $call = shift;
 828         $self->{lastping} ||= {};
 829         $self->{lastping} = {} unless ref $self->{lastping};
 830         my $b = $self->{lastping};
 831         $b->{$call} = shift if @_;
 832         return $b->{$call};
 833 }
 834 1;
 835 __END__
 836
 837
 838
 839
 840