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 DXUtil;
  17 use LRU;
  18 use File::Copy;
  19 use JSON;
  20 use DXDebug;
  21
  22 use strict;
  23
  24 use vars qw(%u $dbm $filename %valid $lastoperinterval $lasttime $lru $lrusize $tooold $v3 $v4);
  25
  26 %u = ();
  27 $dbm = undef;
  28 $filename = undef;
  29 $lastoperinterval = 60*24*60*60;
  30 $lasttime = 0;
  31 $lrusize = 2000;
  32 $tooold = 86400 * 365;          # this marks an old user who hasn't given enough info to be useful
  33 $v3 = 0;
  34 $v4 = 0;
  35 my $json;
  36
  37 our $maxconnlist = 3;                   # remember this many connection time (duration) [start, end] pairs
  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,Group,parray',    # used to create a group of users/nodes for some purpose or other
  65                   buddies => '0,Buddies,parray',
  66                   isolate => '9,Isolate network,yesno',
  67                   wantbeep => '0,Req Beep,yesno',
  68                   wantann => '0,Req Announce,yesno',
  69                   wantwwv => '0,Req WWV,yesno',
  70                   wantwcy => '0,Req WCY,yesno',
  71                   wantecho => '0,Req Echo,yesno',
  72                   wanttalk => '0,Req Talk,yesno',
  73                   wantwx => '0,Req WX,yesno',
  74                   wantdx => '0,Req DX Spots,yesno',
  75                   wantemail => '0,Req Msgs as Email,yesno',
  76                   pagelth => '0,Current Pagelth',
  77                   pingint => '9,Node Ping interval',
  78                   nopings => '9,Ping Obs Count',
  79                   wantlogininfo => '0,Login Info Req,yesno',
  80           wantgrid => '0,Show DX Grid,yesno',
  81                   wantann_talk => '0,Talklike Anns,yesno',
  82                   wantpc16 => '9,Want Users from node,yesno',
  83                   wantsendpc16 => '9,Send PC16,yesno',
  84                   wantroutepc19 => '9,Route PC19,yesno',
  85                   wantusstate => '0,Show US State,yesno',
  86                   wantdxcq => '0,Show CQ Zone,yesno',
  87                   wantdxitu => '0,Show ITU Zone,yesno',
  88                   wantgtk => '0,Want GTK interface,yesno',
  89                   wantpc9x => '0,Want PC9X interface,yesno',
  90                   lastoper => '9,Last for/oper,cldatetime',
  91                   nothere => '0,Not Here Text',
  92                   registered => '9,Registered?,yesno',
  93                   prompt => '0,Required Prompt',
  94                   version => '1,Version',
  95                   build => '1,Build',
  96                   believe => '1,Believable nodes,parray',
  97                   lastping => '1,Last Ping at,ptimelist',
  98                   maxconnect => '1,Max Connections',
  99                   startt => '0,Start Time,cldatetime',
 100                   connlist => '1,Connections,parraydifft',
 101                  );
 102
 103 #no strict;
 104 sub AUTOLOAD
 105 {
 106         no strict;
 107         my $name = $AUTOLOAD;
 108
 109         return if $name =~ /::DESTROY$/;
 110         $name =~ s/^.*:://o;
 111
 112         confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 113         # this clever line of code creates a subroutine which takes over from autoload
 114         # from OO Perl - Conway
 115         *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
 116        goto &$AUTOLOAD;
 117 }
 118
 119 #use strict;
 120
 121 #
 122 # initialise the system
 123 #
 124 sub init
 125 {
 126         my $mode = shift;
 127
 128         my $ufn;
 129         my $convert;
 130
 131         my $fn = "users";
 132         unless (-r localdata("$fn.v4")) {
 133
 134         }
 135
 136         eval {
 137                 require Storable;
 138         };
 139
 140         if ($@) {
 141                 $ufn = localdata("users.v2");
 142                 $v3 = $convert = 0;
 143                 dbg("the module Storable appears to be missing!!");
 144                 dbg("trying to continue in compatibility mode (this may fail)");
 145                 dbg("please install Storable from CPAN as soon as possible");
 146         } else {
 147                 import Storable qw(nfreeze thaw);
 148
 149                 $ufn = localdata("users.v3");
 150                 $v3 = 1;
 151                 $convert++ if -e localdata("users.v2") && !-e $ufn;
 152         }
 153
 154         if ($mode) {
 155                 $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?]";
 156         } else {
 157                 $dbm = tie (%u, 'DB_File', $ufn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!) [rebuild it from user_asc?]";
 158         }
 159
 160         die "Cannot open $ufn ($!)\n" unless $dbm;
 161
 162         $lru = LRU->newbase("DXUser", $lrusize);
 163
 164         # do a conversion if required
 165         if ($dbm && $convert) {
 166                 my ($key, $val, $action, $count, $err) = ('','',0,0,0);
 167
 168                 my %oldu;
 169                 dbg("Converting the User File to V$convert ");
 170                 dbg("This will take a while, I suggest you go and have cup of strong tea");
 171                 my $odbm = tie (%oldu, 'DB_File', localdata("users.v2"), O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn.v2 ($!) [rebuild it from user_asc?]";
 172         for ($action = R_FIRST; !$odbm->seq($key, $val, $action); $action = R_NEXT) {
 173                         my $ref;
 174                         eval { $ref = asc_decode($val) };
 175                         unless ($@) {
 176                                 if ($ref) {
 177                                         $ref->put;
 178                                         $count++;
 179                                 } else {
 180                                         $err++
 181                                 }
 182                         } else {
 183                                 Log('err', "DXUser: error decoding $@");
 184                         }
 185                 }
 186                 undef $odbm;
 187                 untie %oldu;
 188                 dbg("Conversion completed $count records $err errors");
 189         }
 190         $filename = $ufn;
 191 }
 192
 193 sub del_file
 194 {
 195         # with extreme prejudice
 196         unlink "$main::data/users.v3";
 197         unlink "$main::local_data/users.v3";
 198 }
 199
 200 #
 201 # periodic processing
 202 #
 203 sub process
 204 {
 205         if ($main::systime > $lasttime + 15) {
 206                 $dbm->sync if $dbm;
 207                 $lasttime = $main::systime;
 208         }
 209 }
 210
 211 #
 212 # close the system
 213 #
 214
 215 sub finish
 216 {
 217         undef $dbm;
 218         untie %u;
 219 }
 220
 221 #
 222 # new - create a new user
 223 #
 224
 225 sub alloc
 226 {
 227         my $pkg = shift;
 228         my $call = uc shift;
 229         my $self = bless {call => $call, 'sort'=>'U'}, $pkg;
 230         return $self;
 231 }
 232
 233 sub new
 234 {
 235         my $pkg = shift;
 236         my $call = shift;
 237         #  $call =~ s/-\d+$//o;
 238
 239 #       confess "can't create existing call $call in User\n!" if $u{$call};
 240
 241         my $self = $pkg->alloc($call);
 242         $self->put;
 243         return $self;
 244 }
 245
 246 #
 247 # get - get an existing user - this seems to return a different reference everytime it is
 248 #       called - see below
 249 #
 250
 251 sub get
 252 {
 253         my $call = uc shift;
 254         my $data;
 255
 256         # is it in the LRU cache?
 257         my $ref = $lru->get($call);
 258         return $ref if $ref && ref $ref eq 'DXUser';
 259
 260         # search for it
 261         unless ($dbm->get($call, $data)) {
 262                 eval { $ref = decode($data); };
 263
 264                 if ($ref) {
 265                         if (!UNIVERSAL::isa($ref, 'DXUser')) {
 266                                 dbg("DXUser::get: got strange answer from decode of $call". ref $ref. " ignoring");
 267                                 return undef;
 268                         }
 269                         # we have a reference and it *is* a DXUser
 270                 } else {
 271                         if ($@) {
 272                                 LogDbg('err', "DXUser::get decode error on $call '$@'");
 273                         } else {
 274                                 dbg("DXUser::get: no reference returned from decode of $call $!");
 275                         }
 276                         return undef;
 277                 }
 278                 $lru->put($call, $ref);
 279                 return $ref;
 280         }
 281         return undef;
 282 }
 283
 284 #
 285 # get an existing either from the channel (if there is one) or from the database
 286 #
 287 # It is important to note that if you have done a get (for the channel say) and you
 288 # want access or modify that you must use this call (and you must NOT use get's all
 289 # over the place willy nilly!)
 290 #
 291
 292 sub get_current
 293 {
 294         my $call = uc shift;
 295
 296         my $dxchan = DXChannel::get($call);
 297         if ($dxchan) {
 298                 my $ref = $dxchan->user;
 299                 return $ref if $ref && UNIVERSAL::isa($ref, 'DXUser');
 300
 301                 dbg("DXUser::get_current: got invalid user ref for $call from dxchan $dxchan->{call} ". ref $ref. " ignoring");
 302         }
 303         return get($call);
 304 }
 305
 306 #
 307 # get all callsigns in the database
 308 #
 309
 310 sub get_all_calls
 311 {
 312         return (sort keys %u);
 313 }
 314
 315 #
 316 # put - put a user
 317 #
 318
 319 sub put
 320 {
 321         my $self = shift;
 322         confess "Trying to put nothing!" unless $self && ref $self;
 323         my $call = $self->{call};
 324
 325         $dbm->del($call);
 326         delete $self->{annok} if $self->{annok};
 327         delete $self->{dxok} if $self->{dxok};
 328
 329         $lru->put($call, $self);
 330         my $ref = $self->encode;
 331         $dbm->put($call, $ref);
 332 }
 333
 334 # freeze the user
 335 sub encode
 336 {
 337         goto &json_encode if $v4;
 338         goto &asc_encode unless $v3;
 339         my $self = shift;
 340         return nfreeze($self);
 341 }
 342
 343 # thaw the user
 344 sub decode
 345 {
 346         goto &json_dncode if $v4;
 347         goto &asc_decode unless $v3;
 348         my $ref;
 349         $ref = thaw(shift);
 350         return $ref;
 351 }
 352
 353 #
 354 # create a string from a user reference (in_ascii)
 355 #
 356 sub asc_encode
 357 {
 358         my $self = shift;
 359         my $strip = shift;
 360         my $p;
 361
 362         if ($strip) {
 363                 my $ref = bless {}, ref $self;
 364                 foreach my $k (qw(qth lat long qra sort call homenode node lastoper lastin)) {
 365                         $ref->{$k} = $self->{$k} if exists $self->{$k};
 366                 }
 367                 $ref->{name} = $self->{name} if exists $self->{name} && $self->{name} !~ /selfspot/i;
 368                 $p = dd($ref);
 369         } else {
 370                 $p = dd($self);
 371         }
 372         return $p;
 373 }
 374
 375 #
 376 # create a hash from a string (in ascii)
 377 #
 378 sub asc_decode
 379 {
 380         my $s = shift;
 381         my $ref;
 382         $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
 383         eval '$ref = ' . $s;
 384         if ($@) {
 385                 LogDbg('err', "DXUser::asc_decode: on '$s' $@");
 386                 $ref = undef;
 387         }
 388         return $ref;
 389 }
 390
 391 sub json_decode
 392 {
 393         my $
 394 }
 395
 396 sub json_encode
 397 {
 398
 399 }
 400
 401 #
 402 # del - delete a user
 403 #
 404
 405 sub del
 406 {
 407         my $self = shift;
 408         my $call = $self->{call};
 409         $lru->remove($call);
 410         $dbm->del($call);
 411 }
 412
 413 #
 414 # close - close down a user
 415 #
 416
 417 sub close
 418 {
 419         my $self = shift;
 420         my $startt = shift;
 421         my $ip = shift;
 422         $self->{lastin} = $main::systime;
 423         # add a record to the connect list
 424         my $ref = [$startt || $self->{startt}, $main::systime];
 425         push @$ref, $ip if $ip;
 426         push @{$self->{connlist}}, $ref;
 427         shift @{$self->{connlist}} if @{$self->{connlist}} > $maxconnlist;
 428         $self->put();
 429 }
 430
 431 #
 432 # sync the database
 433 #
 434
 435 sub sync
 436 {
 437         $dbm->sync;
 438 }
 439
 440 #
 441 # return a list of valid elements
 442 #
 443
 444 sub fields
 445 {
 446         return keys(%valid);
 447 }
 448
 449
 450 #
 451 # export the database to an ascii file
 452 #
 453
 454 sub export
 455 {
 456         my $name = shift || 'user_asc';
 457         my $basic_info_only = shift;
 458
 459         my $fn = $name ne 'user_asc' ? $name : "$main::local_data/$name";                       # force use of local
 460
 461         # save old ones
 462         move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
 463         move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
 464         move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
 465         move "$fn.o", "$fn.oo" if -e "$fn.o";
 466         move "$fn", "$fn.o" if -e "$fn";
 467
 468         my $count = 0;
 469         my $err = 0;
 470         my $del = 0;
 471         my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
 472         if ($fh) {
 473                 my $key = 0;
 474                 my $val = undef;
 475                 my $action;
 476                 my $t = scalar localtime;
 477                 print $fh q{#!/usr/bin/perl
 478 #
 479 # The exported userfile for a DXSpider System
 480 #
 481 # Input file: $filename
 482 #       Time: $t
 483 #
 484
 485 package main;
 486
 487 # search local then perl directories
 488 BEGIN {
 489         umask 002;
 490
 491         # root of directory tree for this system
 492         $root = "/spider";
 493         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
 494
 495         unshift @INC, "$root/perl";     # this IS the right way round!
 496         unshift @INC, "$root/local";
 497
 498         # try to detect a lockfile (this isn't atomic but
 499         # should do for now
 500         $lockfn = "$root/local_data/cluster.lck";       # lock file name
 501         if (-e $lockfn) {
 502                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
 503                 my $pid = <CLLOCK>;
 504                 chomp $pid;
 505                 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
 506                 close CLLOCK;
 507         }
 508 }
 509
 510 use SysVar;
 511 use DXUser;
 512
 513 if (@ARGV) {
 514         $main::userfn = shift @ARGV;
 515         print "user filename now $userfn\n";
 516 }
 517
 518 package DXUser;
 519
 520 del_file();
 521 init(1);
 522 %u = ();
 523 my $count = 0;
 524 my $err = 0;
 525 while (<DATA>) {
 526         chomp;
 527         my @f = split /\t/;
 528         my $ref = asc_decode($f[1]);
 529         if ($ref) {
 530                 $ref->put();
 531                 $count++;
 532         DXUser::sync() unless $count % 10000;
 533         } else {
 534                 print "# Error: $f[0]\t$f[1]\n";
 535                 $err++
 536         }
 537 }
 538 DXUser::sync(); DXUser::finish();
 539 print "There are $count user records and $err errors\n";
 540 };
 541                 print $fh "__DATA__\n";
 542
 543         for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
 544                         if (!is_callsign($key) || $key =~ /^0/) {
 545                                 my $eval = $val;
 546                                 my $ekey = $key;
 547                                 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 548                                 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 549                                 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
 550                                 eval {$dbm->del($key)};
 551                                 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
 552                                 ++$err;
 553                                 next;
 554                         }
 555                         my $ref;
 556                         eval {$ref = decode($val); };
 557                         if ($ref) {
 558                                 my $t = $ref->{lastin} || 0;
 559                                 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
 560                                         unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
 561                                                 eval {$dbm->del($key)};
 562                                                 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
 563                                                 LogDbg('DXCommand', "$ref->{call} deleted, too old");
 564                                                 $del++;
 565                                                 next;
 566                                         }
 567                                 }
 568                                 # only store users that are reasonably active or have useful information
 569                                 print $fh "$key\t" . $ref->asc_encode($basic_info_only) . "\n";
 570                                 ++$count;
 571                         } else {
 572                                 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
 573                                 eval {$dbm->del($key)};
 574                                 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
 575                                 ++$err;
 576                         }
 577                 }
 578         $fh->close;
 579     }
 580         my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
 581         LogDbg('command', $s);
 582         return $s;
 583 }
 584
 585 sub export_json
 586 {
 587         use Data::Structure::Util qw(unbless);
 588
 589         my $name = shift || 'user_json';
 590         my $basic_info_only = shift;
 591
 592         my $fn = $name ne 'user_json' ? $name : "$main::local_data/$name";                       # force use of local
 593
 594         # save old ones
 595         move "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
 596         move "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
 597         move "$fn.oo", "$fn.ooo" if -e "$fn.oo";
 598         move "$fn.o", "$fn.oo" if -e "$fn.o";
 599         move "$fn", "$fn.o" if -e "$fn";
 600
 601         my $json = JSON->new;
 602         $json->canonical(1);
 603         $json->allow_blessed(1);
 604
 605         my $count = 0;
 606         my $err = 0;
 607         my $del = 0;
 608         my $fh = new IO::File ">$fn" or return "cannot open $fn ($!)";
 609         if ($fh) {
 610                 my $key = 0;
 611                 my $val = undef;
 612                 my $action;
 613                 my $t = scalar localtime;
 614                 print $fh q{#!/usr/bin/perl
 615 #
 616 # The exported userfile for a DXSpider System
 617 #
 618 # Input file: $filename
 619 #       Time: $t
 620 #
 621
 622 package main;
 623
 624 # search local then perl directories
 625 BEGIN {
 626         umask 002;
 627
 628         # root of directory tree for this system
 629         $root = "/spider";
 630         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
 631
 632         unshift @INC, "$root/perl";     # this IS the right way round!
 633         unshift @INC, "$root/local";
 634
 635         # try to detect a lockfile (this isn't atomic but
 636         # should do for now
 637         $lockfn = "$root/local_data/cluster.lck";       # lock file name
 638         if (-e $lockfn) {
 639                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
 640                 my $pid = <CLLOCK>;
 641                 chomp $pid;
 642                 die "Lockfile ($lockfn) and process $pid exists - cluster must be stopped first\n" if kill 0, $pid;
 643                 close CLLOCK;
 644         }
 645 }
 646
 647 use SysVar;
 648 use DXUser;
 649
 650 if (@ARGV) {
 651         $main::userfn = shift @ARGV;
 652         print "user filename now $userfn\n";
 653 }
 654
 655 package DXUser;
 656
 657 use JSON;
 658 my $json = JSON->new;
 659
 660 del_file();
 661 init(1);
 662 %u = ();
 663 my $count = 0;
 664 my $err = 0;
 665 while (<DATA>) {
 666         chomp;
 667         my @f = split /\t/;
 668         my $ref;
 669     eval { $ref = $json->decode($f[1]); };
 670         if ($ref && !$@) {
 671         $ref = bless $ref, 'DXUser';
 672                 $ref->put();
 673                 $count++;
 674         DXUser::sync() unless $count % 10000;
 675         } else {
 676                 print "# Error: $f[0]\t$f[1]\n";
 677                 $err++
 678         }
 679 }
 680 DXUser::sync(); DXUser::finish();
 681 print "There are $count user records and $err errors\n";
 682 };
 683                 print $fh "__DATA__\n";
 684
 685         for ($action = R_FIRST; !$dbm->seq($key, $val, $action); $action = R_NEXT) {
 686                         if (!is_callsign($key) || $key =~ /^0/) {
 687                                 my $eval = $val;
 688                                 my $ekey = $key;
 689                                 $eval =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 690                                 $ekey =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 691                                 LogDbg('DXCommand', "Export Error1: $ekey\t$eval");
 692                                 eval {$dbm->del($key)};
 693                                 dbg(carp("Export Error1: $ekey\t$eval\n$@")) if $@;
 694                                 ++$err;
 695                                 next;
 696                         }
 697                         my $ref;
 698                         eval {$ref = decode($val); };
 699                         if ($ref) {
 700                                 my $t = $ref->{lastin} || 0;
 701                                 if ($ref->is_user && !$ref->{priv} && $main::systime > $t + $tooold) {
 702                                         unless ($ref->{lat} && $ref->{long} || $ref->{qth} || $ref->{qra}) {
 703                                                 eval {$dbm->del($key)};
 704                                                 dbg(carp("Export Error2: $key\t$val\n$@")) if $@;
 705                                                 LogDbg('DXCommand', "$ref->{call} deleted, too old");
 706                                                 $del++;
 707                                                 next;
 708                                         }
 709                                 }
 710                                 # only store users that are reasonably active or have useful information
 711                                 unbless($ref);
 712                                 print $fh "$key\t" . $json->encode($ref) . "\n";
 713                                 ++$count;
 714                         } else {
 715                                 LogDbg('DXCommand', "Export Error3: $key\t" . carp($val) ."\n$@");
 716                                 eval {$dbm->del($key)};
 717                                 dbg(carp("Export Error3: $key\t$val\n$@")) if $@;
 718                                 ++$err;
 719                         }
 720                 }
 721         $fh->close;
 722     }
 723         my $s = qq{Exported users to $fn - $count Users $del Deleted $err Errors ('sh/log Export' for details)};
 724         LogDbg('command', $s);
 725         return $s;
 726 }
 727
 728 #
 729 # group handling
 730 #
 731
 732 # add one or more groups
 733 sub add_group
 734 {
 735         my $self = shift;
 736         my $ref = $self->{group} || [ 'local' ];
 737         $self->{group} = $ref if !$self->{group};
 738         push @$ref, @_ if @_;
 739 }
 740
 741 # remove one or more groups
 742 sub del_group
 743 {
 744         my $self = shift;
 745         my $ref = $self->{group} || [ 'local' ];
 746         my @in = @_;
 747
 748         $self->{group} = $ref if !$self->{group};
 749
 750         @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
 751 }
 752
 753 # does this thing contain all the groups listed?
 754 sub union
 755 {
 756         my $self = shift;
 757         my $ref = $self->{group};
 758         my $n;
 759
 760         return 0 if !$ref || @_ == 0;
 761         return 1 if @$ref == 0 && @_ == 0;
 762         for ($n = 0; $n < @_; ) {
 763                 for (@$ref) {
 764                         my $a = $_;
 765                         $n++ if grep $_ eq $a, @_;
 766                 }
 767         }
 768         return $n >= @_;
 769 }
 770
 771 # simplified group test just for one group
 772 sub in_group
 773 {
 774         my $self = shift;
 775         my $s = shift;
 776         my $ref = $self->{group};
 777
 778         return 0 if !$ref;
 779         return grep $_ eq $s, $ref;
 780 }
 781
 782 # set up a default group (only happens for them's that connect direct)
 783 sub new_group
 784 {
 785         my $self = shift;
 786         $self->{group} = [ 'local' ];
 787 }
 788
 789 # set up empty buddies (only happens for them's that connect direct)
 790 sub new_buddies
 791 {
 792         my $self = shift;
 793         $self->{buddies} = [  ];
 794 }
 795
 796 #
 797 # return a prompt for a field
 798 #
 799
 800 sub field_prompt
 801 {
 802         my ($self, $ele) = @_;
 803         return $valid{$ele};
 804 }
 805
 806 # some variable accessors
 807 sub sort
 808 {
 809         my $self = shift;
 810         @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
 811 }
 812
 813 # some accessors
 814
 815 # want is default = 1
 816 sub _want
 817 {
 818         my $n = shift;
 819         my $self = shift;
 820         my $val = shift;
 821         my $s = "want$n";
 822         $self->{$s} = $val if defined $val;
 823         return exists $self->{$s} ? $self->{$s} : 1;
 824 }
 825
 826 # wantnot is default = 0
 827 sub _wantnot
 828 {
 829         my $n = shift;
 830         my $self = shift;
 831         my $val = shift;
 832         my $s = "want$n";
 833         $self->{$s} = $val if defined $val;
 834         return exists $self->{$s} ? $self->{$s} : 0;
 835 }
 836
 837 sub wantbeep
 838 {
 839         return _want('beep', @_);
 840 }
 841
 842 sub wantann
 843 {
 844         return _want('ann', @_);
 845 }
 846
 847 sub wantwwv
 848 {
 849         return _want('wwv', @_);
 850 }
 851
 852 sub wantwcy
 853 {
 854         return _want('wcy', @_);
 855 }
 856
 857 sub wantecho
 858 {
 859         return _want('echo', @_);
 860 }
 861
 862 sub wantwx
 863 {
 864         return _want('wx', @_);
 865 }
 866
 867 sub wantdx
 868 {
 869         return _want('dx', @_);
 870 }
 871
 872 sub wanttalk
 873 {
 874         return _want('talk', @_);
 875 }
 876
 877 sub wantgrid
 878 {
 879         return _want('grid', @_);
 880 }
 881
 882 sub wantemail
 883 {
 884         return _want('email', @_);
 885 }
 886
 887 sub wantann_talk
 888 {
 889         return _want('ann_talk', @_);
 890 }
 891
 892 sub wantpc16
 893 {
 894         return _want('pc16', @_);
 895 }
 896
 897 sub wantsendpc16
 898 {
 899         return _want('sendpc16', @_);
 900 }
 901
 902 sub wantroutepc16
 903 {
 904         return _want('routepc16', @_);
 905 }
 906
 907 sub wantusstate
 908 {
 909         return _want('usstate', @_);
 910 }
 911
 912 sub wantdxcq
 913 {
 914         return _want('dxcq', @_);
 915 }
 916
 917 sub wantdxitu
 918 {
 919         return _want('dxitu', @_);
 920 }
 921
 922 sub wantgtk
 923 {
 924         return _want('gtk', @_);
 925 }
 926
 927 sub wantpc9x
 928 {
 929         return _want('pc9x', @_);
 930 }
 931
 932 sub wantlogininfo
 933 {
 934         my $self = shift;
 935         my $val = shift;
 936         $self->{wantlogininfo} = $val if defined $val;
 937         return $self->{wantlogininfo};
 938 }
 939
 940 sub is_node
 941 {
 942         my $self = shift;
 943         return $self->{sort} =~ /^[ACRSX]$/;
 944 }
 945
 946 sub is_local_node
 947 {
 948         my $self = shift;
 949         return grep $_ eq 'local_node', @{$self->{group}};
 950 }
 951
 952 sub is_user
 953 {
 954         my $self = shift;
 955         return $self->{sort} =~ /^[UW]$/;
 956 }
 957
 958 sub is_web
 959 {
 960         my $self = shift;
 961         return $self->{sort} eq 'W';
 962 }
 963
 964 sub is_bbs
 965 {
 966         my $self = shift;
 967         return $self->{sort} eq 'B';
 968 }
 969
 970 sub is_spider
 971 {
 972         my $self = shift;
 973         return $self->{sort} eq 'S';
 974 }
 975
 976 sub is_clx
 977 {
 978         my $self = shift;
 979         return $self->{sort} eq 'C';
 980 }
 981
 982 sub is_dxnet
 983 {
 984         my $self = shift;
 985         return $self->{sort} eq 'X';
 986 }
 987
 988 sub is_arcluster
 989 {
 990         my $self = shift;
 991         return $self->{sort} eq 'R';
 992 }
 993
 994 sub is_ak1a
 995 {
 996         my $self = shift;
 997         return $self->{sort} eq 'A';
 998 }
 999
1000 sub unset_passwd
1001 {
1002         my $self = shift;
1003         delete $self->{passwd};
1004 }
1005
1006 sub unset_passphrase
1007 {
1008         my $self = shift;
1009         delete $self->{passphrase};
1010 }
1011
1012 sub set_believe
1013 {
1014         my $self = shift;
1015         my $call = uc shift;
1016         $self->{believe} ||= [];
1017         push @{$self->{believe}}, $call unless grep $_ eq $call, @{$self->{believe}};
1018 }
1019
1020 sub unset_believe
1021 {
1022         my $self = shift;
1023         my $call = uc shift;
1024         if (exists $self->{believe}) {
1025                 $self->{believe} = [grep {$_ ne $call} @{$self->{believe}}];
1026                 delete $self->{believe} unless @{$self->{believe}};
1027         }
1028 }
1029
1030 sub believe
1031 {
1032         my $self = shift;
1033         return exists $self->{believe} ? @{$self->{believe}} : ();
1034 }
1035
1036 sub lastping
1037 {
1038         my $self = shift;
1039         my $call = shift;
1040         $self->{lastping} ||= {};
1041         $self->{lastping} = {} unless ref $self->{lastping};
1042         my $b = $self->{lastping};
1043         $b->{$call} = shift if @_;
1044         return $b->{$call};
1045 }
1046 1;
1047 __END__
1048
1049
1050
1051
1052