perl/DXChannel.pm

   1 #
   2 # module to manage channel lists & data
   3 #
   4 # This is the base class for all channel operations, which is everything to do
   5 # with input and output really.
   6 #
   7 # The instance variable in the outside world will be generally be called $dxchann
   8 #
   9 # This class is 'inherited' (if that is the goobledegook for what I am doing)
  10 # by various other modules. The point to understand is that the 'instance variable'
  11 # is in fact what normal people would call the state vector and all useful info
  12 # about a connection goes in there.
  13 #
  14 # Another point to note is that a vector may contain a list of other vectors.
  15 # I have simply added another variable to the vector for 'simplicity' (or laziness
  16 # as it is more commonly called)
  17 #
  18 # PLEASE NOTE - I am a C programmer using this as a method of learning perl
  19 # firstly and OO about ninthly (if you don't like the design and you can't
  20 # improve it with better OO by make it smaller and more efficient, then tough).
  21 #
  22 # Copyright (c) 1998 - Dirk Koopman G1TLH
  23 #
  24 # $Id$
  25 #
  26 package DXChannel;
  27
  28 use Msg;
  29 use DXUtil;
  30 use DXM;
  31 use DXDebug;
  32 use Carp;
  33
  34 use strict;
  35 use vars qw(%channels %valid);
  36
  37 %channels = undef;
  38
  39 %valid = (
  40   call => '0,Callsign',
  41   conn => '9,Msg Conn ref',
  42   user => '9,DXUser ref',
  43   startt => '0,Start Time,atime',
  44   t => '9,Time,atime',
  45   pc50_t => '9,Last PC50 Time,atime',
  46   priv => '9,Privilege',
  47   state => '0,Current State',
  48   oldstate => '5,Last State',
  49   list => '9,Dep Chan List',
  50   name => '0,User Name',
  51   consort => '9,Connection Type',
  52   sort => '9,Type of Channel',
  53   wwv => '0,Want WWV,yesno',
  54   talk => '0,Want Talk,yesno',
  55   ann => '0,Want Announce,yesno',
  56   here => '0,Here?,yesno',
  57   confmode => '0,In Conference?,yesno',
  58   dx => '0,DX Spots,yesno',
  59   redirect => '0,Redirect messages to',
  60   lang => '0,Language',
  61 );
  62
  63 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
  64 sub alloc
  65 {
  66   my ($pkg, $call, $conn, $user) = @_;
  67   my $self = {};
  68
  69   die "trying to create a duplicate channel for $call" if $channels{$call};
  70   $self->{call} = $call;
  71   $self->{conn} = $conn if defined $conn;   # if this isn't defined then it must be a list
  72   $self->{user} = $user if defined $user;
  73   $self->{startt} = $self->{t} = time;
  74   $self->{state} = 0;
  75   $self->{oldstate} = 0;
  76   bless $self, $pkg;
  77   return $channels{$call} = $self;
  78 }
  79
  80 # obtain a channel object by callsign [$obj = DXChannel->get($call)]
  81 sub get
  82 {
  83   my ($pkg, $call) = @_;
  84   return $channels{$call};
  85 }
  86
  87 # obtain all the channel objects
  88 sub get_all
  89 {
  90   my ($pkg) = @_;
  91   return values(%channels);
  92 }
  93
  94 # obtain a channel object by searching for its connection reference
  95 sub get_by_cnum
  96 {
  97   my ($pkg, $conn) = @_;
  98   my $self;
  99
 100   foreach $self (values(%channels)) {
 101     return $self if ($self->{conn} == $conn);
 102   }
 103   return undef;
 104 }
 105
 106 # get rid of a channel object [$obj->del()]
 107 sub del
 108 {
 109   my $self = shift;
 110   delete $channels{$self->{call}};
 111 }
 112
 113 # is it an ak1a cluster ?
 114 sub is_ak1a
 115 {
 116   my $self = shift;
 117   return $self->{sort} eq 'A';
 118 }
 119
 120 # is it a user?
 121 sub is_user
 122 {
 123   my $self = shift;
 124   return $self->{sort} eq 'U';
 125 }
 126
 127 # handle out going messages, immediately without waiting for the select to drop
 128 # this could, in theory, block
 129 sub send_now
 130 {
 131   my $self = shift;
 132   my $conn = $self->{conn};
 133   my $sort = shift;
 134   my $call = $self->{call};
 135   my $line;
 136
 137   foreach $line (@_) {
 138     chomp $line;
 139         dbg('chan', "-> $sort $call $line\n") if $conn;
 140         $conn->send_now("$sort$call|$line") if $conn;
 141   }
 142   $self->{t} = time;
 143 }
 144
 145 #
 146 # the normal output routine
 147 #
 148 sub send              # this is always later and always data
 149 {
 150   my $self = shift;
 151   my $conn = $self->{conn};
 152   my $call = $self->{call};
 153   my $line;
 154
 155   foreach $line (@_) {
 156     chomp $line;
 157         dbg('chan', "-> D $call $line\n") if $conn;
 158         $conn->send_later("D$call|$line") if $conn;
 159   }
 160   $self->{t} = time;
 161 }
 162
 163 # send a file (always later)
 164 sub send_file
 165 {
 166   my ($self, $fn) = @_;
 167   my $call = $self->{call};
 168   my $conn = $self->{conn};
 169   my @buf;
 170
 171   open(F, $fn) or die "can't open $fn for sending file ($!)";
 172   @buf = <F>;
 173   close(F);
 174   $self->send(@buf);
 175 }
 176
 177 # just a shortcut for $dxchan->send(msg(...));
 178 sub msg
 179 {
 180   my $self = shift;
 181   $self->send(DXM::msg(@_));
 182 }
 183
 184 # change the state of the channel - lots of scope for debugging here :-)
 185 sub state
 186 {
 187   my $self = shift;
 188   $self->{oldstate} = $self->{state};
 189   $self->{state} = shift;
 190   dbg('state', "$self->{call} channel state $self->{oldstate} -> $self->{state}\n");
 191 }
 192
 193 # disconnect this channel
 194 sub disconnect
 195 {
 196   my $self = shift;
 197   my $user = $self->{user};
 198   my $conn = $self->{conn};
 199   $self->finish();
 200   $user->close() if defined $user;
 201   $conn->disconnect() if defined $conn;
 202   $self->del();
 203 }
 204
 205 # various access routines
 206
 207 #
 208 # return a list of valid elements
 209 #
 210
 211 sub fields
 212 {
 213   return keys(%valid);
 214 }
 215
 216 #
 217 # return a prompt for a field
 218 #
 219
 220 sub field_prompt
 221 {
 222   my ($self, $ele) = @_;
 223   return $valid{$ele};
 224 }
 225
 226 no strict;
 227 sub AUTOLOAD
 228 {
 229   my $self = shift;
 230   my $name = $AUTOLOAD;
 231   return if $name =~ /::DESTROY$/;
 232   $name =~ s/.*:://o;
 233
 234   confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
 235   @_ ? $self->{$name} = shift : $self->{$name} ;
 236 }
 237
 238 1;
 239 __END__;