#
package DXChannel;
-require Exporter;
-@ISA = qw(DXCommandmode DXProt Exporter);
-
use Msg;
-use DXUtil;
use DXM;
+use DXUtil;
+use DXDebug;
+use Filter;
+
+use strict;
+use vars qw(%channels %valid);
-%channels = undef;
+%channels = ();
-# create a new connection object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
-sub new
+%valid = (
+ call => '0,Callsign',
+ conn => '9,Msg Conn ref',
+ user => '9,DXUser ref',
+ startt => '0,Start Time,atime',
+ t => '9,Time,atime',
+ pc50_t => '5,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 => '5,Connection Type',
+ 'sort' => '5,Type of Channel',
+ wwv => '0,Want WWV,yesno',
+ wcy => '0,Want WCY,yesno',
+ wx => '0,Want WX,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 => '5,Function',
+ loc => '9,Local Vars', # used by func to store local variables in
+ beep => '0,Want Beeps,yesno',
+ lastread => '5,Last Msg Read',
+ outbound => '5,outbound?,yesno',
+ remotecmd => '9,doing rcmd,yesno',
+ pagelth => '0,Page Length',
+ pagedata => '9,Page Data Store',
+ group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
+ isolate => '5,Isolate network,yesno',
+ delayed => '5,Delayed messages,parray',
+ annfilter => '5,Announce Filter',
+ wwvfilter => '5,WWV Filter',
+ wcyfilter => '5,WCY Filter',
+ spotfilter => '5,Spot Filter',
+ inannfilter => '5,Input Ann Filter',
+ inwwvfilter => '5,Input WWV Filter',
+ inwcyfilter => '5,Input WCY Filter',
+ inspotfilter => '5,Input Spot Filter',
+ passwd => '9,Passwd List,parray',
+ pingint => '5,Ping Interval ',
+ nopings => '5,Ping Obs Count',
+ lastping => '5,Ping last sent,atime',
+ pingtime => '5,Ping totaltime,parray',
+ pingave => '0,Ping ave time',
+ logininfo => '9,Login info req,yesno',
+ );
+
+# object destruction
+sub DESTROY
{
- my ($pkg, $call, $conn, $user) = @_;
- my $self = {};
+ my $self = shift;
+ undef $self->{user};
+ undef $self->{conn};
+ undef $self->{loc};
+ undef $self->{pagedata};
+ undef $self->{group};
+ undef $self->{delayed};
+ undef $self->{annfilter};
+ undef $self->{wwvfilter};
+ undef $self->{spotfilter};
+ undef $self->{inannfilter};
+ undef $self->{inwwvfilter};
+ undef $self->{inspotfilter};
+ undef $self->{passwd};
+}
+
+# create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
+sub alloc
+{
+ my ($pkg, $call, $conn, $user) = @_;
+ my $self = {};
- die "trying to create a duplicate channel for $call" if $channels{$call};
- $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->{state} = 0;
- $self->{oldstate} = 0;
- bless $self, $pkg;
- return $channels{$call} = $self;
-}
-
-# obtain a connection object by callsign [$obj = DXChannel->get($call)]
+ die "trying to create a duplicate channel for $call" if $channels{$call};
+ $self->{call} = $call;
+ $self->{priv} = 0;
+ $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
+ if (defined $user) {
+ $self->{user} = $user;
+ $self->{lang} = $user->lang;
+ $user->new_group() if !$user->group;
+ $self->{group} = $user->group;
+ $self->{sort} = $user->sort;
+ }
+ $self->{startt} = $self->{t} = time;
+ $self->{state} = 0;
+ $self->{oldstate} = 0;
+ $self->{lang} = $main::lang if !$self->{lang};
+ $self->{func} = "";
+
+ # get the filters
+ $self->{spotfilter} = Filter::read_in('spots', $call, 0);
+ $self->{wwvfilter} = Filter::read_in('wwv', $call, 0);
+ $self->{wcyfilter} = Filter::read_in('wcy', $call, 0);
+ $self->{annfilter} = Filter::read_in('ann', $call, 0);
+
+ bless $self, $pkg;
+ return $channels{$call} = $self;
+}
+
+# obtain a channel object by callsign [$obj = DXChannel->get($call)]
sub get
{
- my ($pkg, $call) = @_;
- return $connect{$call};
+ my ($pkg, $call) = @_;
+ return $channels{$call};
}
-# obtain all the connection objects
+# obtain all the channel objects
sub get_all
{
- my ($pkg) = @_;
- return values(%channels);
+ my ($pkg) = @_;
+ return values(%channels);
+}
+
+#
+# gimme all the ak1a nodes
+#
+sub get_all_ak1a
+{
+ my @list = DXChannel->get_all();
+ my $ref;
+ my @out;
+ foreach $ref (@list) {
+ push @out, $ref if $ref->is_node;
+ }
+ return @out;
+}
+
+# return a list of all users
+sub get_all_users
+{
+ my @list = DXChannel->get_all();
+ my $ref;
+ my @out;
+ foreach $ref (@list) {
+ push @out, $ref if $ref->is_user;
+ }
+ return @out;
+}
+
+# return a list of all user callsigns
+sub get_all_user_calls
+{
+ my @list = DXChannel->get_all();
+ my $ref;
+ my @out;
+ foreach $ref (@list) {
+ push @out, $ref->call if $ref->is_user;
+ }
+ return @out;
}
-# 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;
+ my ($pkg, $conn) = @_;
+ my $self;
- foreach $self (values(%channels)) {
- return $self if ($self->{conn} == $conn);
- }
- return undef;
+ 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 $channels{$self->{call}};
+ my $self = shift;
+
+ $self->{group} = undef; # belt and braces
+ delete $channels{$self->{call}};
+}
+
+# is it a bbs
+sub is_bbs
+{
+ my $self = shift;
+ return $self->{'sort'} eq 'B';
+}
+
+sub is_node
+{
+ my $self = shift;
+ return $self->{'sort'} =~ /[ACRSX]/;
+}
+# is it an ak1a node ?
+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 clx node
+sub is_clx
+{
+ my $self = shift;
+ return $self->{'sort'} eq 'C';
+}
+
+# is it a spider node
+sub is_spider
+{
+ my $self = shift;
+ return $self->{'sort'} eq 'S';
+}
+
+# is it a DXNet node
+sub is_dxnet
+{
+ my $self = shift;
+ return $self->{'sort'} eq 'X';
+}
+
+# is it a ar-cluster node
+sub is_arcluster
+{
+ my $self = shift;
+ return $self->{'sort'} eq 'R';
}
+# for perl 5.004's benefit
+sub sort
+{
+ my $self = shift;
+ return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
+}
# 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;
+ my $self = shift;
+ my $conn = $self->{conn};
+ return unless $conn;
+ my $sort = shift;
+ my $call = $self->{call};
- 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");
+ for (@_) {
+ chomp;
+ my @lines = split /\n/;
+ for (@lines) {
+ $conn->send_now("$sort$call|$_");
+ dbg('chan', "-> $sort $call $_");
+ }
}
- }
+ $self->{t} = time;
}
#
# 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 (@_) {
- 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");
+sub send # this is always later and always data
+{
+ my $self = shift;
+ my $conn = $self->{conn};
+ return unless $conn;
+ my $call = $self->{call};
+
+ for (@_) {
+ chomp;
+ my @lines = split /\n/;
+ for (@lines) {
+ $conn->send_later("D$call|$_");
+ dbg('chan', "-> D $call $_");
+ }
}
- }
+ $self->{t} = time;
}
# send a file (always later)
sub send_file
{
- my ($self, $fn) = @_;
- my $call = $self->{call};
- my $conn = $self->{conn};
- my @buf;
+ 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);
+ 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(...));
+# this will implement language independence (in time)
sub msg
{
- my $self = shift;
- $self->send(DXM::msg(@_));
+ my $self = shift;
+ return DXM::msg($self->{lang}, @_);
+}
+
+# stick a broadcast on the delayed queue (but only up to 20 items)
+sub delay
+{
+ my $self = shift;
+ my $s = shift;
+
+ $self->{delayed} = [] unless $self->{delayed};
+ push @{$self->{delayed}}, $s;
+ if (@{$self->{delayed}} >= 20) {
+ shift @{$self->{delayed}}; # lose oldest one
+ }
}
# 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;
+ my $self = shift;
+ if (@_) {
+ $self->{oldstate} = $self->{state};
+ $self->{state} = shift;
+ $self->{func} = '' unless defined $self->{func};
+ dbg('state', "$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n");
+
+ # if there is any queued up broadcasts then splurge them out here
+ if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'convers')) {
+ $self->send (@{$self->{delayed}});
+ delete $self->{delayed};
+ }
+ }
+ return $self->{state};
+}
+
+# disconnect this channel
+sub disconnect
+{
+ my $self = shift;
+ my $user = $self->{user};
+ my $conn = $self->{conn};
+ my $call = $self->{call};
+ my $nopc39 = shift || 0;
+
+ $self->finish($nopc39);
+ $conn->send_now("Z$call|bye") if $conn; # this will cause 'client' to disconnect
+ $user->close() if defined $user;
+ $conn->disconnect() if $conn;
+ $self->del();
+}
+
+#
+# just close all the socket connections down without any fiddling about, cleaning, being
+# nice to other processes and otherwise telling them what is going on.
+#
+# This is for the benefit of forked processes to prepare for starting new programs, they
+# don't want or need all this baggage.
+#
+
+sub closeall
+{
+ my $ref;
+ foreach $ref (values %channels) {
+ $ref->{conn}->disconnect() if $ref->{conn};
+ }
+}
+
+#
+# Tell all the users that we have come in or out (if they want to know)
+#
+sub tell_login
+{
+ my ($self, $m) = @_;
+
+ # send info to all logged in thingies
+ my @dxchan = get_all_users();
+ my $dxchan;
+ foreach $dxchan (@dxchan) {
+ next if $dxchan == $self;
+ $dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
+ }
+}
+
+# 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;
+
+ confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
+ @_ ? $self->{$name} = shift : $self->{$name} ;
}
1;
projects / spider.git / blobdiff