# 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
+# The instance variable in the outside world will be generally be called $dxchan
#
# 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'
#
# 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).
+# improve it with better OO and thus make it smaller and more efficient, then tough).
#
-# Copyright (c) 1998 - Dirk Koopman G1TLH
+# Copyright (c) 1998-2000 - Dirk Koopman G1TLH
#
# $Id$
#
use Msg;
use DXM;
use DXUtil;
+use DXVars;
use DXDebug;
use Filter;
+use Prefix;
+use Route;
use strict;
-use vars qw(%channels %valid);
+use vars qw(%channels %valid @ISA $count);
%channels = ();
+$count = 0;
%valid = (
call => '0,Callsign',
talk => '0,Want Talk,yesno',
ann => '0,Want Announce,yesno',
here => '0,Here?,yesno',
- confmode => '0,In Conference?,yesno',
+ conf => '0,In Conference?,yesno',
dx => '0,DX Spots,yesno',
redirect => '0,Redirect messages to',
lang => '0,Language',
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',
+ annfilter => '5,Ann Filt-out',
+ wwvfilter => '5,WWV Filt-out',
+ wcyfilter => '5,WCY Filt-out',
+ spotsfilter => '5,Spot Filt-out',
+ routefilter => '5,Route Filt-out',
+ inannfilter => '5,Ann Filt-inp',
+ inwwvfilter => '5,WWV Filt-inp',
+ inwcyfilter => '5,WCY Filt-inp',
+ inspotsfilter => '5,Spot Filt-inp',
+ inroutefilter => '5,Route Filt-inp',
+ passwd => '9,Passwd List,yesno',
pingint => '5,Ping Interval ',
nopings => '5,Ping Obs Count',
lastping => '5,Ping last sent,atime',
pingave => '0,Ping ave time',
logininfo => '9,Login info req,yesno',
talklist => '0,Talk List,parray',
- node => '5,Node data',
+ cluster => '5,Cluster data',
+ isbasic => '9,Internal Connection',
+ errors => '9,Errors',
+ route => '9,Route Data',
+ dxcc => '0,Country Code',
+ itu => '0,ITU Zone',
+ cq => '0,CQ Zone',
+ enhanced => '5,Enhanced Client,yesno',
+ senddbg => '8,Sending Debug,yesno',
+ width => '0,Column Width',
+ disconnecting => '9,Disconnecting,yesno',
+ ann_talk => '0,Suppress Talk Anns,yesno',
+ metric => '1,Route metric',
+ badcount => '1,Bad Word Count',
+ edit => '7,Edit Function',
+ registered => '9,Registered?,yesno',
+ prompt => '0,Required Prompt',
+ version => '1,Node Version',
+ build => '1,Node Build',
+ verified => '9,Verified?,yesno',
+ newroute => '1,New Style Routing,yesno',
+ ve7cc => '0,VE7CC program special,yesno',
+ lastmsgpoll => '0,Last Msg Poll,atime',
+ inscript => '9,In a script,yesno',
+ inqueue => '9,Input Queue,parray',
);
+use vars qw($VERSION $BRANCH);
+$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
+$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
+$main::build += $VERSION;
+$main::branch += $BRANCH;
+
# object destruction
sub DESTROY
{
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};
- undef $self->{node};
+ for (keys %$self) {
+ if (ref($self->{$_})) {
+ delete $self->{$_};
+ }
+ }
+ dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
+ $count--;
}
# create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
$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);
+ # add in all the dxcc, itu, zone info
+ my @dxcc = Prefix::extract($call);
+ if (@dxcc > 0) {
+ $self->{dxcc} = $dxcc[1]->dxcc;
+ $self->{itu} = $dxcc[1]->itu;
+ $self->{cq} = $dxcc[1]->cq;
+ }
+ $self->{inqueue} = [];
+ $count++;
+ dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
bless $self, $pkg;
return $channels{$call} = $self;
}
-# obtain a channel object by callsign [$obj = DXChannel->get($call)]
+sub rec
+{
+ my ($self, $msg) = @_;
+
+ # queue the message and the channel object for later processing
+ if (defined $msg) {
+ push @{$self->{inqueue}}, $msg;
+ }
+}
+
+# obtain a channel object by callsign [$obj = DXChannel::get($call)]
sub get
{
- my ($pkg, $call) = @_;
+ my $call = shift;
return $channels{$call};
}
# obtain all the channel objects
sub get_all
{
- my ($pkg) = @_;
return values(%channels);
}
sub is_node
{
my $self = shift;
- return $self->{'sort'} =~ /[ACRSX]/;
+ return $self->{'sort'} =~ /[ACRSXW]/;
}
# is it an ak1a node ?
sub is_ak1a
return $self->{'sort'} eq 'C';
}
+# it is Aranea
+sub is_aranea
+{
+ my $self = shift;
+ return $self->{'sort'} eq 'W';
+}
+
# is it a spider node
sub is_spider
{
return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
}
+# find out whether we are prepared to believe this callsign on this interface
+sub is_believed
+{
+ my $self = shift;
+ my $call = shift;
+
+ return grep $call eq $_, $self->user->believe;
+}
+
# handle out going messages, immediately without waiting for the select to drop
# this could, in theory, block
sub send_now
my @lines = split /\n/;
for (@lines) {
$conn->send_now("$sort$call|$_");
- dbg('chan', "-> $sort $call $_");
+ dbg("-> $sort $call $_") if isdbg('chan');
+ }
+ }
+ $self->{t} = time;
+}
+
+#
+# send later with letter (more control)
+#
+
+sub send_later
+{
+ my $self = shift;
+ my $conn = $self->{conn};
+ return unless $conn;
+ my $sort = shift;
+ my $call = $self->{call};
+
+ for (@_) {
+# chomp;
+ my @lines = split /\n/;
+ for (@lines) {
+ $conn->send_later("$sort$call|$_");
+ dbg("-> $sort $call $_") if isdbg('chan');
}
}
$self->{t} = time;
my @lines = split /\n/;
for (@lines) {
$conn->send_later("D$call|$_");
- dbg('chan', "-> D $call $_");
+ dbg("-> D $call $_") if isdbg('chan');
}
}
$self->{t} = time;
$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");
+ dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
# if there is any queued up broadcasts then splurge them out here
if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
{
my $self = shift;
my $user = $self->{user};
- my $conn = $self->{conn};
- my $call = $self->{call};
- $self->finish($conn);
$user->close() if defined $user;
- $conn->disconnect() if $conn;
+ $self->{conn}->disconnect;
$self->del();
}
my $dxchan;
foreach $dxchan (@dxchan) {
next if $dxchan == $self;
+ next if $dxchan->{call} eq $main::mycall;
$dxchan->send($dxchan->msg($m, $self->{call})) if $dxchan->{logininfo};
}
}
my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
# the above regexp must work
- if (!defined $sort || !defined $call || !defined $line ||
- (ref $dxchan && $call ne $chcall)) {
- $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
- dbg('chan', "DUFF Line from $chcall: $data");
+ unless (defined $sort && defined $call && defined $line) {
+# $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
+ dbg("DUFF Line on $chcall: $data");
return ();
}
+
+ if(ref($dxchan) && $call ne $chcall) {
+ dbg("DUFF Line come in for $call on wrong channel $chcall");
+ return();
+ }
return ($sort, $call, $line);
}
-no strict;
+sub rspfcheck
+{
+ my ($self, $flag, $node, $user) = @_;
+ my $nref = Route::Node::get($node);
+ my $dxchan = $nref->dxchan if $nref;
+ if ($nref && $dxchan) {
+ if ($dxchan == $self) {
+ return 1 unless $user;
+ return 1 if $user eq $node;
+ my @users = $nref->users;
+ return 1 if @users == 0 || grep $user eq $_, @users;
+ dbg("RSPF: $user not on $node") if isdbg('chanerr');
+ } else {
+ dbg("RSPF: Shortest path for $node is " . $nref->dxchan->{call}) if isdbg('chanerr');
+ }
+ } else {
+ return 1 if $flag;
+ dbg("RSPF: required $node not found" ) if isdbg('chanerr');
+ }
+ return 0;
+}
+
+# broadcast a message to all clusters taking into account isolation
+# [except those mentioned after buffer]
+sub broadcast_nodes
+{
+ my $s = shift; # the line to be rebroadcast
+ my @except = @_; # to all channels EXCEPT these (dxchannel refs)
+ my @dxchan = get_all_nodes();
+ my $dxchan;
+
+ # send it if it isn't the except list and isn't isolated and still has a hop count
+ foreach $dxchan (@dxchan) {
+ next if grep $dxchan == $_, @except;
+ next if $dxchan == $main::me;
+
+ my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
+
+ $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
+ }
+}
+
+# broadcast a message to all clusters ignoring isolation
+# [except those mentioned after buffer]
+sub broadcast_all_nodes
+{
+ my $s = shift; # the line to be rebroadcast
+ my @except = @_; # to all channels EXCEPT these (dxchannel refs)
+ my @dxchan = get_all_nodes();
+ my $dxchan;
+
+ # send it if it isn't the except list and isn't isolated and still has a hop count
+ foreach $dxchan (@dxchan) {
+ next if grep $dxchan == $_, @except;
+ next if $dxchan == $main::me;
+
+ my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
+ $dxchan->send($routeit);
+ }
+}
+
+# broadcast to all users
+# storing the spot or whatever until it is in a state to receive it
+sub broadcast_users
+{
+ my $s = shift; # the line to be rebroadcast
+ my $sort = shift; # the type of transmission
+ my $fref = shift; # a reference to an object to filter on
+ my @except = @_; # to all channels EXCEPT these (dxchannel refs)
+ my @dxchan = get_all_users();
+ my $dxchan;
+ my @out;
+
+ foreach $dxchan (@dxchan) {
+ next if grep $dxchan == $_, @except;
+ push @out, $dxchan;
+ }
+ broadcast_list($s, $sort, $fref, @out);
+}
+
+
+# broadcast to a list of users
+sub broadcast_list
+{
+ my $s = shift;
+ my $sort = shift;
+ my $fref = shift;
+ my $dxchan;
+
+ foreach $dxchan (@_) {
+ my $filter = 1;
+ next if $dxchan == $main::me;
+
+ if ($sort eq 'dx') {
+ next unless $dxchan->{dx};
+ ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
+ next unless $filter;
+ }
+ next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
+ next if $sort eq 'wwv' && !$dxchan->{wwv};
+ next if $sort eq 'wcy' && !$dxchan->{wcy};
+ next if $sort eq 'wx' && !$dxchan->{wx};
+
+ $s =~ s/\a//og unless $dxchan->{beep};
+
+ if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
+ $dxchan->send($s);
+ } else {
+ $dxchan->delay($s);
+ }
+ }
+}
+
+sub process
+{
+ foreach my $dxchan (get_all()) {
+
+ while (my $data = shift @{$dxchan->{inqueue}}) {
+ my ($sort, $call, $line) = $dxchan->decode_input($data);
+ next unless defined $sort;
+
+ # do the really sexy console interface bit! (Who is going to do the TK interface then?)
+ dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
+ if ($dxchan->{disconnecting}) {
+ dbg('In disconnection, ignored');
+ next;
+ }
+
+ # handle A records
+ my $user = $dxchan->user;
+ if ($sort eq 'A' || $sort eq 'O') {
+ $dxchan->start($line, $sort);
+ } elsif ($sort eq 'I') {
+ die "\$user not defined for $call" if !defined $user;
+
+ # normal input
+ $dxchan->normal($line);
+ } elsif ($sort eq 'Z') {
+ $dxchan->disconnect;
+ } elsif ($sort eq 'D') {
+ ; # ignored (an echo)
+ } elsif ($sort eq 'G') {
+ $dxchan->enhanced($line);
+ } else {
+ print STDERR atime, " Unknown command letter ($sort) received from $call\n";
+ }
+ }
+ }
+}
+
+#no strict;
sub AUTOLOAD
{
- my $self = shift;
+ no strict;
my $name = $AUTOLOAD;
return if $name =~ /::DESTROY$/;
- $name =~ s/.*:://o;
+ $name =~ s/^.*:://o;
confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
# this clever line of code creates a subroutine which takes over from autoload
# from OO Perl - Conway
- *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
- @_ ? $self->{$name} = shift : $self->{$name} ;
+ *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};
+ goto &$AUTOLOAD;
}