added the hooks for internationalisation
[spider.git] / perl / DXChannel.pm
index 093bfb003ca2ae6e9b824f0e097d8e8f4eb48d6a..3eb387efaea99492f3038a555589d451e6ee74a7 100644 (file)
 package DXChannel;
 
 use Msg;
-use DXUtil;
 use DXM;
+use DXUtil;
+use DXDebug;
+use Carp;
+
+use strict;
+use vars qw(%channels %valid);
 
 %channels = undef;
 
 %valid = (
-  call => 'Callsign',
-  conn => 'Msg Connection ref',
-  user => 'DXUser ref',
-  t => 'Time',
-  priv => 'Privilege',
-  state => 'Current State',
-  oldstate => 'Last State',
-  list => 'Dependant DXChannels list',
-  name => 'User Name',
+  call => '0,Callsign',
+  conn => '9,Msg Conn ref',
+  user => '9,DXUser ref',
+  startt => '0,Start Time,atime',
+  t => '9,Time,atime',
+  pc50_t => '9,Last PC50 Time,atime',
+  priv => '9,Privilege',
+  state => '0,Current State',
+  oldstate => '5,Last State',
+  list => '9,Dep Chan List',
+  name => '0,User Name',
+  consort => '9,Connection Type',
+  sort => '9,Type of Channel',
+  wwv => '0,Want WWV,yesno',
+  talk => '0,Want Talk,yesno',
+  ann => '0,Want Announce,yesno',
+  here => '0,Here?,yesno',
+  confmode => '0,In Conference?,yesno',
+  dx => '0,DX Spots,yesno',
+  redirect => '0,Redirect messages to',
+  lang => '0,Language',
+  func => '9,Function',
+  loc => '9,Local Vars',     # used by func to store local variables in
+  lastread => '9,Last Msg Read',
 );
 
-
-# create a new connection object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
-sub new
+# create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
+sub alloc
 {
   my ($pkg, $call, $conn, $user) = @_;
   my $self = {};
@@ -54,28 +73,30 @@ sub new
   $self->{call} = $call;
   $self->{conn} = $conn if defined $conn;   # if this isn't defined then it must be a list
   $self->{user} = $user if defined $user; 
-  $self->{t} = time;
+  $self->{startt} = $self->{t} = time;
   $self->{state} = 0;
   $self->{oldstate} = 0;
+  $self->{lang} = $user->{lang} if defined $user;
+  $self->{lang} = $main::lang if !$self->{lang};
   bless $self, $pkg; 
   return $channels{$call} = $self;
 }
 
-# obtain a connection object by callsign [$obj = DXChannel->get($call)]
+# obtain a channel object by callsign [$obj = DXChannel->get($call)]
 sub get
 {
   my ($pkg, $call) = @_;
-  return $connect{$call};
+  return $channels{$call};
 }
 
-# obtain all the connection objects
+# obtain all the channel objects
 sub get_all
 {
   my ($pkg) = @_;
   return values(%channels);
 }
 
-# obtain a connection object by searching for its connection reference
+# obtain a channel object by searching for its connection reference
 sub get_by_cnum
 {
   my ($pkg, $conn) = @_;
@@ -87,13 +108,33 @@ sub get_by_cnum
   return undef;
 }
 
-# get rid of a connection object [$obj->del()]
+# get rid of a channel object [$obj->del()]
 sub del
 {
   my $self = shift;
   delete $channels{$self->{call}};
 }
 
+# is it an ak1a cluster ?
+sub is_ak1a
+{
+  my $self = shift;
+  return $self->{sort} eq 'A';
+}
+
+# is it a user?
+sub is_user
+{
+  my $self = shift;
+  return $self->{sort} eq 'U';
+}
+
+# is it a connect type
+sub is_connect
+{
+  my $self = shift;
+  return $self->{sort} eq 'C';
+}
 
 # handle out going messages, immediately without waiting for the select to drop
 # this could, in theory, block
@@ -101,27 +142,16 @@ sub send_now
 {
   my $self = shift;
   my $conn = $self->{conn};
-
-  # is this a list of channels ?
-  if (!defined $conn) {
-    die "tried to send_now to an invalid channel list" if !defined $self->{list};
-       my $lself;
-       foreach $lself (@$self->{list}) {
-         $lself->send_now(@_);             # it's recursive :-)
-       }
-  } else {
-    my $sort = shift;
-    my $call = $self->{call};
-    my $line;
+  my $sort = shift;
+  my $call = $self->{call};
+  my $line;
        
-    foreach $line (@_) {
-      my $t = atime;
-         chomp $line;
-      print main::DEBUG "$t -> $sort $call $line\n" if defined DEBUG;
-         print "-> $sort $call $line\n";
-      $conn->send_now("$sort$call|$line");
-       }
+  foreach $line (@_) {
+    chomp $line;
+       dbg('chan', "-> $sort $call $line\n") if $conn;
+       $conn->send_now("$sort$call|$line") if $conn;
   }
+  $self->{t} = time;
 }
 
 #
@@ -131,26 +161,15 @@ sub send              # this is always later and always data
 {
   my $self = shift;
   my $conn = $self->{conn};
-  # is this a list of channels ?
-  if (!defined $conn) {
-    die "tried to send to an invalid channel list" if !defined $self->{list};
-       my $lself;
-       foreach $lself (@$self->{list}) {
-         $lself->send(@_);                 # here as well :-) :-)
-       }
-  } else {
-    my $call = $self->{call};
-    my $line;
-
-    foreach $line (@_) {
-      my $t = atime;
-         chomp $line;
-         print main::DEBUG "$t -> D $call $line\n" if defined DEBUG;
-         print "-> D $call $line\n";
-         $conn->send_later("D$call|$line");
-       }
+  my $call = $self->{call};
+  my $line;
+
+  foreach $line (@_) {
+    chomp $line;
+       dbg('chan', "-> D $call $line\n") if $conn;
+       $conn->send_later("D$call|$line") if $conn;
   }
+  $self->{t} = time;
 }
 
 # send a file (always later)
@@ -167,32 +186,67 @@ sub send_file
   $self->send(@buf);
 }
 
-# just a shortcut for $dxchan->send(msg(...));
+# this will implement language independence (in time)
 sub msg
 {
   my $self = shift;
-  $self->send(DXM::msg(@_));
+  return DXM::msg($self->{lang}, @_);
 }
 
 # change the state of the channel - lots of scope for debugging here :-)
 sub state
 {
   my $self = shift;
-  $self->{oldstate} = $self->{state};
-  $self->{state} = shift;
-  print "Db   $self->{call} channel state $self->{oldstate} -> $self->{state}\n" if $main::debug;
+  if (@_) {
+    $self->{oldstate} = $self->{state};
+    $self->{state} = shift;
+    dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
+  }
+  return $self->{state};
+}
+
+# disconnect this channel
+sub disconnect
+{
+  my $self = shift;
+  my $user = $self->{user};
+  my $conn = $self->{conn};
+  $self->finish();
+  $user->close() if defined $user;
+  $conn->disconnect() if defined $conn;
+  $self->del();
 }
 
 # various access routines
+
+#
+# return a list of valid elements 
+# 
+
+sub fields
+{
+  return keys(%valid);
+}
+
+#
+# return a prompt for a field
+#
+
+sub field_prompt
+{ 
+  my ($self, $ele) = @_;
+  return $valid{$ele};
+}
+
+no strict;
 sub AUTOLOAD
 {
   my $self = shift;
   my $name = $AUTOLOAD;
-  
   return if $name =~ /::DESTROY$/;
   $name =~ s/.*:://o;
   
-  die "Non-existant field '$AUTOLOAD'" if !$valid{$name};
+  confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
   @_ ? $self->{$name} = shift : $self->{$name} ;
 }