added auto ping and obs count to dxchan
[spider.git] / perl / DXUser.pm
index b593a6b2ad7f22eb33982e275a1aed51923259fd..50cb4796d1e732df106071de8179947201c6c5b4 100644 (file)
@@ -11,52 +11,69 @@ package DXUser;
 require Exporter;
 @ISA = qw(Exporter);
 
-use MLDBM qw(DB_File);
+use DXLog;
+use DB_File;
+use Data::Dumper;
 use Fcntl;
+use Carp;
 
-%u = undef;
+use strict;
+use vars qw(%u $dbm $filename %valid);
+
+%u = ();
 $dbm = undef;
 $filename = undef;
 
 # hash of valid elements and a simple prompt
 %valid = (
-  call => '0,Callsign',
-  alias => '0,Real Callsign',
-  name => '0,Name',
-  qth => '0,Home QTH',
-  lat => '0,Latitude,slat',
-  long => '0,Longitude,slong',
-  qra => '0,Locator',
-  email => '0,E-mail Address',
-  priv => '9,Privilege Level',
-  lastin => '0,Last Time in,cldatetime',
-  passwd => '9,Password',
-  addr => '0,Full Address',
-  sort => '0,Type of User',  # A - ak1a, U - User, S - spider cluster, B - BBS
-  wwv => '0,Want WWV,yesno',
-  talk => '0,Want Talk,yesno',
-  ann => '0,Want Announce,yesno',
-  here => '0,Here Status,yesno',
-  xpert => '0,Expert Status,yesno',
-  bbs => '0,Home BBS',
-  node => '0,Home Node',
-  dx => '0,DX Spots,yesno',
-);
+                 call => '0,Callsign',
+                 alias => '0,Real Callsign',
+                 name => '0,Name',
+                 qth => '0,Home QTH',
+                 lat => '0,Latitude,slat',
+                 long => '0,Longitude,slong',
+                 qra => '0,Locator',
+                 email => '0,E-mail Address',
+                 priv => '9,Privilege Level',
+                 lastin => '0,Last Time in,cldatetime',
+                 passwd => '9,Password',
+                 addr => '0,Full Address',
+                 'sort' => '0,Type of User', # A - ak1a, U - User, S - spider cluster, B - BBS
+                 xpert => '0,Expert Status,yesno',
+                 bbs => '0,Home BBS',
+                 node => '0,Last Node',
+                 homenode => '0,Home Node',
+                 lockout => '9,Locked out?,yesno',     # won't let them in at all
+                 dxok => '9,DX Spots?,yesno', # accept his dx spots?
+                 annok => '9,Announces?,yesno', # accept his announces?
+                 reg => '0,Registered?,yesno', # is this user registered?
+                 lang => '0,Language',
+                 hmsgno => '0,Highest Msgno',
+                 group => '0,Access Group,parray',     # used to create a group of users/nodes for some purpose or other
+                 isolate => '9,Isolate network,yesno',
+                 wantbeep => '0,Rec Beep,yesno',
+                 wantann => '0,Rec Announce,yesno',
+                 wantwwv => '0,Rec WWV,yesno',
+                 wanttalk => '0,Rec Talk,yesno',
+                 wantwx => '0,Rec WX,yesno',
+                 wantdx => '0,Rec DX Spots,yesno',
+                 pingint => '9,Node Ping interval',
+                );
 
+no strict;
 sub AUTOLOAD
 {
-  my $self = shift;
-  my $name = $AUTOLOAD;
+       my $self = shift;
+       my $name = $AUTOLOAD;
   
-  return if $name =~ /::DESTROY$/;
-  $name =~ s/.*:://o;
+       return if $name =~ /::DESTROY$/;
+       $name =~ s/.*:://o;
   
-  die "Non-existant field '$AUTOLOAD'" if !$valid{$name};
-  if (@_) {
-    $self->{$name} = shift;
-       $self->put();
-  }
-  return $self->{$name};
+       confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
+       if (@_) {
+               $self->{$name} = shift;
+       }
+       return $self->{$name};
 }
 
 #
@@ -64,21 +81,29 @@ sub AUTOLOAD
 #
 sub init
 {
-  my ($pkg, $fn) = @_;
+       my ($pkg, $fn, $mode) = @_;
   
-  die "need a filename in User" if !$fn;
-  $dbm = tie %u, MLDBM, $fn, O_CREAT|O_RDWR, 0666 or die "can't open user file: $fn ($!)";
-  $filename = $fn;
+       confess "need a filename in User" if !$fn;
+       $fn .= ".v2";
+       if ($mode) {
+               $dbm = tie (%u, 'DB_File', $fn, O_CREAT|O_RDWR, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
+       } else {
+               $dbm = tie (%u, 'DB_File', $fn, O_RDONLY, 0666, $DB_BTREE) or confess "can't open user file: $fn ($!)";
+       }
+       
+       $filename = $fn;
 }
 
+use strict;
+
 #
 # close the system
 #
 
 sub finish
 {
-  $dbm = undef;
-  untie %u;
+       undef $dbm;
+       untie %u;
 }
 
 #
@@ -87,23 +112,63 @@ sub finish
 
 sub new
 {
-  my ($pkg, $call) = @_;
-  die "can't create existing call $call in User\n!" if $u{$call};
+       my $pkg = shift;
+       my $call = uc shift;
+       #  $call =~ s/-\d+$//o;
+  
+#      confess "can't create existing call $call in User\n!" if $u{$call};
 
-  my $self = {};
-  $self->{call} = $call;
-  bless $self, $pkg;
-  $u{call} = $self;
+       my $self = bless {}, $pkg;
+       $self->{call} = $call;
+       $self->{'sort'} = 'U';
+       $self->{dxok} = 1;
+       $self->{annok} = 1;
+       $self->{lang} = $main::lang;
+       $self->put;
+       return $self;
 }
 
 #
-# get - get an existing user
+# get - get an existing user - this seems to return a different reference everytime it is
+#       called - see below
 #
 
 sub get
 {
-  my ($pkg, $call) = @_;
-  return $u{$call};
+       my $pkg = shift;
+       my $call = uc shift;
+       #  $call =~ s/-\d+$//o;       # strip ssid
+       my $s = $u{$call};
+       return $s ?  decode($s) : undef;
+}
+
+#
+# get all callsigns in the database 
+#
+
+sub get_all_calls
+{
+       return (sort keys %u);
+}
+
+#
+# get an existing either from the channel (if there is one) or from the database
+#
+# It is important to note that if you have done a get (for the channel say) and you
+# want access or modify that you must use this call (and you must NOT use get's all
+# over the place willy nilly!)
+#
+
+sub get_current
+{
+       my $pkg = shift;
+       my $call = uc shift;
+       #  $call =~ s/-\d+$//o;       # strip ssid
+  
+       my $dxchan = DXChannel->get($call);
+       return $dxchan->user if $dxchan;
+       my $s = $u{$call};
+       return $s ? decode($s) : undef;
 }
 
 #
@@ -112,9 +177,37 @@ sub get
 
 sub put
 {
-  my $self = shift;
-  my $call = $self->{call};
-  $u{$call} = $self;
+       my $self = shift;
+       confess "Trying to put nothing!" unless $self && ref $self;
+       my $call = $self->{call};
+       $u{$call} = $self->encode();
+}
+
+# 
+# create a string from a user reference
+#
+sub encode
+{
+       my $self = shift;
+       my $dd = new Data::Dumper([$self]);
+       $dd->Indent(0);
+       $dd->Terse(1);
+    $dd->Quotekeys(0);
+       return $dd->Dumpxs;
+}
+
+#
+# create a hash from a string
+#
+sub decode
+{
+       my $s = shift;
+       my $ref;
+       $s = '$ref = ' . $s;
+       eval $s;
+       Log('DXUser', $@) if $@;
+       $ref = undef if $@;
+       return $ref;
 }
 
 #
@@ -123,9 +216,9 @@ sub put
 
 sub del
 {
-  my $self = shift;
-  my $call = $self->{call};
-  delete $u{$call};
+       my $self = shift;
+       my $call = $self->{call};
+       delete $u{$call};
 }
 
 #
@@ -134,9 +227,9 @@ sub del
 
 sub close
 {
-  my $self = shift;
-  $self->{lastin} = time;
-  $self->put();
+       my $self = shift;
+       $self->{lastin} = time;
+       $self->put();
 }
 
 #
@@ -145,7 +238,68 @@ sub close
 
 sub fields
 {
-  return keys(%valid);
+       return keys(%valid);
+}
+
+#
+# group handling
+#
+
+# add one or more groups
+sub add_group
+{
+       my $self = shift;
+       my $ref = $self->{group} || [ 'local' ];
+       $self->{group} = $ref if !$self->{group};
+       push @$ref, @_ if @_;
+}
+
+# remove one or more groups
+sub del_group
+{
+       my $self = shift;
+       my $ref = $self->{group} || [ 'local' ];
+       my @in = @_;
+       
+       $self->{group} = $ref if !$self->{group};
+       
+       @$ref = map { my $a = $_; return (grep { $_ eq $a } @in) ? () : $a } @$ref;
+}
+
+# does this thing contain all the groups listed?
+sub union
+{
+       my $self = shift;
+       my $ref = $self->{group};
+       my $n;
+       
+       return 0 if !$ref || @_ == 0;
+       return 1 if @$ref == 0 && @_ == 0;
+       for ($n = 0; $n < @_; ) {
+               for (@$ref) {
+                       my $a = $_;
+                       $n++ if grep $_ eq $a, @_; 
+               }
+       }
+       return $n >= @_;
+}
+
+# simplified group test just for one group
+sub in_group
+{
+       my $self = shift;
+       my $s = shift;
+       my $ref = $self->{group};
+       
+       return 0 if !$ref;
+       return grep $_ eq $s, $ref;
+}
+
+# set up a default group (only happens for them's that connect direct)
+sub new_group
+{
+       my $self = shift;
+       $self->{group} = [ 'local' ];
 }
 
 #
@@ -154,49 +308,51 @@ sub fields
 
 sub field_prompt
 { 
-  my ($self, $ele) = @_;
-  return $valid{$ele};
-}
-
-#
-# enter an element from input, returns 1 for success
-#
-
-sub enter
-{
-  my ($self, $ele, $value) = @_;
-  return 0 if (!defined $valid{$ele});
-  chomp $value;
-  return 0 if $value eq "";
-  if ($ele eq 'long') {
-    my ($longd, $longm, $longl) = $value =~ /(\d+) (\d+) ([EWew])/;
-       return 0 if (!$longl || $longd < 0 || $longd > 180 || $longm < 0 || $longm > 59);
-       $longd += ($longm/60);
-       $longd = 0-$longd if (uc $longl) eq 'W'; 
-       $self->{'long'} = $longd;
-       return 1;
-  } elsif ($ele eq 'lat') {
-    my ($latd, $latm, $latl) = $value =~ /(\d+) (\d+) ([NSns])/;
-       return 0 if (!$latl || $latd < 0 || $latd > 90 || $latm < 0 || $latm > 59);
-       $latd += ($latm/60);
-       $latd = 0-$latd if (uc $latl) eq 'S';
-       $self->{'lat'} = $latd;
-       return 1;
-  } elsif ($ele eq 'qra') {
-    $self->{'qra'} = UC $value;
-       return 1;
-  } else {
-    $self->{$ele} = $value;               # default action
-       return 1;
-  }
-  return 0;
+       my ($self, $ele) = @_;
+       return $valid{$ele};
 }
 
 # some variable accessors
 sub sort
 {
-  my $self = shift;
-  @_ ? $self->{sort} = shift : $self->{sort} ;
+       my $self = shift;
+       @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
+}
+
+# some accessors
+sub _want
+{
+       my $n = shift;
+       my $self = shift;
+       my $s = "want$n";
+       return $self->{$n} = shift if @_;
+       return defined $self->{$n} ? $self->{$n} : 1;
 }
+
+sub wantbeep
+{
+       return _want('beep', @_);
+}
+
+sub wantann
+{
+       return _want('ann', @_);
+}
+
+sub wantwwv
+{
+       return _want('wwv', @_);
+}
+
+sub wantwx
+{
+       return _want('wx', @_);
+}
+
+sub wantdx
+{
+       return _want('dx', @_);
+}
+
 1;
 __END__