X-Git-Url: http://www.dxcluster.org/gitweb/gitweb.cgi?a=blobdiff_plain;f=perl%2FDXChannel.pm;h=36a84aa162c756e9c68d78aeb643921e9fc4d1dc;hb=07ea293f3919d2da76220b5fbc55b734008ed44c;hp=d4b20a2bedffe94f48dc1ab40e5fd83215259133;hpb=0017002e2dc438d49fcc090dc99b6d22f7037aa7;p=spider.git

diff --git a/perl/DXChannel.pm b/perl/DXChannel.pm
index d4b20a2b..36a84aa1 100644
--- a/perl/DXChannel.pm
+++ b/perl/DXChannel.pm
@@ -1,64 +1,217 @@
 #
 # module to manage channel lists & data
 #
+# This is the base class for all channel operations, which is everything to do 
+# with input and output really.
+#
+# The instance variable in the outside world will be generally be called $dxchann
+#
+# This class is 'inherited' (if that is the goobledegook for what I am doing)
+# by various other modules. The point to understand is that the 'instance variable'
+# is in fact what normal people would call the state vector and all useful info
+# about a connection goes in there.
+#
+# Another point to note is that a vector may contain a list of other vectors. 
+# I have simply added another variable to the vector for 'simplicity' (or laziness
+# as it is more commonly called)
+#
+# PLEASE NOTE - I am a C programmer using this as a method of learning perl
+# firstly and OO about ninthly (if you don't like the design and you can't 
+# improve it with better OO by make it smaller and more efficient, then tough). 
+#
 # Copyright (c) 1998 - Dirk Koopman G1TLH
 #
 # $Id$
 #
 package DXChannel;
 
-require Exporter;
-@ISA = qw(Exporter);
+use Msg;
+use DXUtil;
+use DXM;
+use DXDebug;
+
+%channels = undef;
+
+%valid = (
+  call => '0,Callsign',
+  conn => '9,Msg Conn ref',
+  user => '9,DXUser ref',
+  t => '0,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'
+);
 
-%connects = undef;
 
-# create a new connection object [$obj = Connect->new($call, $msg_conn_obj, $user_obj)]
+# create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
 sub new
 {
   my ($pkg, $call, $conn, $user) = @_;
   my $self = {};
   
-  die "trying to create a duplicate Connect for call $call\n" if $connects{$call};
+  die "trying to create a duplicate channel for $call" if $channels{$call};
   $self->{call} = $call;
-  $self->{conn} = $conn;
-  $self->{user} = $user;
+  $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->{state} = 0;
+  $self->{oldstate} = 0;
   bless $self, $pkg; 
-  return $connects{$call} = $self;
+  return $channels{$call} = $self;
 }
 
-# obtain a connection object by callsign [$obj = Connect->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(%connects);
+  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) = @_;
   my $self;
   
-  foreach $self (values(%connects)) {
+  foreach $self (values(%channels)) {
     return $self if ($self->{conn} == $conn);
   }
   return undef;
 }
 
-# get rid of a connection object [$obj->del()]
+# get rid of a channel object [$obj->del()]
 sub del
 {
   my $self = shift;
-  delete $connects{$self->{call}};
+  delete $channels{$self->{call}};
+}
+
+
+# handle out going messages, immediately without waiting for the select to drop
+# this could, in theory, block
+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;
+	
+    foreach $line (@_) {
+	  chomp $line;
+      dbg('chan', "-> $sort $call $line\n");
+      $conn->send_now("$sort$call|$line");
+	}
+  }
+}
+
+#
+# the normal output routine
+#
+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 (@_) {
+	  chomp $line;
+	  dbg('chan', "-> D $call $line\n");
+	  $conn->send_later("D$call|$line");
+	}
+  }
+}
+
+# send a file (always later)
+sub send_file
+{
+  my ($self, $fn) = @_;
+  my $call = $self->{call};
+  my $conn = $self->{conn};
+  my @buf;
+  
+  open(F, $fn) or die "can't open $fn for sending file ($!)";
+  @buf = <F>;
+  close(F);
+  $self->send(@buf);
+}
+
+# just a shortcut for $dxchan->send(msg(...));
+sub msg
+{
+  my $self = shift;
+  $self->send(DXM::msg(@_));
+}
+
+# change the state of the channel - lots of scope for debugging here :-)
+sub state
+{
+  my $self = shift;
+  $self->{oldstate} = $self->{state};
+  $self->{state} = shift;
+  dbg('state', "$self->{call} channel state $self->{oldstate} -> $self->{state}\n");
+}
+
+# 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};
+}
+
+sub AUTOLOAD
+{
+  my $self = shift;
+  my $name = $AUTOLOAD;
+  
+  return if $name =~ /::DESTROY$/;
+  $name =~ s/.*:://o;
+  
+  die "Non-existant field '$AUTOLOAD'" if !$valid{$name};
+  @_ ? $self->{$name} = shift : $self->{$name} ;
 }
 
 1;