#!/usr/bin/perl
#
# This module impliments the abstracted routing for all protocols and
-# is probably what I SHOULD have done the first time.
+# is probably what I SHOULD have done the first time.
#
# Heyho.
#
-# This is just a container class which I expect to subclass
+# This is just a container class which I expect to subclass
#
# Copyright (c) 2001 Dirk Koopman G1TLH
#
-# $Id$
-#
+#
+#
package Route;
use DXDebug;
+use DXChannel;
+use Prefix;
+use DXUtil;
use strict;
-use vars qw(%list %valid);
+
+use vars qw(%list %valid $filterdef);
%valid = (
call => "0,Callsign",
+ flags => "0,Flags,phex",
+ dxcc => '0,Country Code',
+ itu => '0,ITU Zone',
+ cq => '0,CQ Zone',
+ state => '0,State',
+ city => '0,City',
);
+$filterdef = bless ([
+ # tag, sort, field, priv, special parser
+ ['channel', 'c', 0],
+ ['channel_dxcc', 'nc', 1],
+ ['channel_itu', 'ni', 2],
+ ['channel_zone', 'nz', 3],
+ ['call', 'c', 4],
+ ['by', 'c', 4],
+ ['call_dxcc', 'nc', 5],
+ ['by_dxcc', 'nc', 5],
+ ['call_itu', 'ni', 6],
+ ['by_itu', 'ni', 6],
+ ['call_zone', 'nz', 7],
+ ['by_zone', 'nz', 7],
+ ['channel_state', 'ns', 8],
+ ['call_state', 'ns', 9],
+ ['by_state', 'ns', 9],
+ ], 'Filter::Cmd');
+
+
sub new
{
my ($pkg, $call) = @_;
- dbg('route', "$pkg created $call");
- return bless {call => $call}, $pkg;
+ $pkg = ref $pkg if ref $pkg;
+
+ my $self = bless {call => $call}, $pkg;
+ dbg("create $pkg with $call") if isdbg('routelow');
+
+ # add in all the dxcc, itu, zone info
+ ($self->{dxcc}, $self->{itu}, $self->{cq}, $self->{state}, $self->{city}) =
+ Prefix::cty_data($call);
+
+ $self->{flags} = here(1);
+
+ return $self;
}
#
return $thingy;
}
-#
+#
# add and delete a callsign to/from a list
#
{
my $self = shift;
my $field = shift;
+ my @out;
foreach my $c (@_) {
- my $call = _getcall($c);
- unless (grep {$_ eq $call} @{$self->{$field}}) {
+ confess "Need a ref here" unless ref($c);
+
+ my $call = $c->{call};
+ unless (grep $_ eq $call, @{$self->{$field}}) {
push @{$self->{$field}}, $call;
- dbg('route', ref($self) . " adding $call to " . $self->{call} . "->\{$field\}");
+ dbg(ref($self) . " adding $call to " . $self->{call} . "->\{$field\}") if isdbg('routelow');
+ push @out, $c;
}
}
+ return @out;
}
sub _dellist
{
my $self = shift;
my $field = shift;
+ my @out;
foreach my $c (@_) {
- my $call = _getcall($c);
- if (grep {$_ eq $call} @{$self->{$field}}) {
+ confess "Need a ref here" unless ref($c);
+ my $call = $c->{call};
+ if (grep $_ eq $call, @{$self->{$field}}) {
$self->{$field} = [ grep {$_ ne $call} @{$self->{$field}} ];
- dbg('route', ref($self) . " deleting $call from " . $self->{call} . "->\{$field\}");
+ dbg(ref($self) . " deleting $call from " . $self->{call} . "->\{$field\}") if isdbg('routelow');
+ push @out, $c;
}
}
+ return @out;
+}
+
+sub is_empty
+{
+ my $self = shift;
+ return @{$self->{$_[0]}} == 0;
+}
+
+#
+# flag field constructors/enquirers
+#
+# These can be called in various ways:-
+#
+# Route::here or $ref->here returns 1 or 0 depending on value of the here flag
+# Route::here(1) returns 2 (the bit value of the here flag)
+# $ref->here(1) or $ref->here(0) sets the here flag
+#
+
+sub here
+{
+ my $self = shift;
+ my $r = shift;
+ return $self ? 2 : 0 unless ref $self;
+ return ($self->{flags} & 2) ? 1 : 0 unless defined $r;
+ $self->{flags} = (($self->{flags} & ~2) | ($r ? 2 : 0));
+ return $r ? 1 : 0;
+}
+
+sub conf
+{
+ my $self = shift;
+ my $r = shift;
+ return $self ? 1 : 0 unless ref $self;
+ return ($self->{flags} & 1) ? 1 : 0 unless defined $r;
+ $self->{flags} = (($self->{flags} & ~1) | ($r ? 1 : 0));
+ return $r ? 1 : 0;
+}
+
+sub parents
+{
+ my $self = shift;
+ return @{$self->{parent}};
}
+#
+# display routines
+#
+
+sub user_call
+{
+ my $self = shift;
+ my $call = sprintf "%s", $self->{call};
+ return $self->here ? "$call" : "($call)";
+}
+
+sub config
+{
+ my $self = shift;
+ my $nodes_only = shift || 0;
+ my $level = shift;
+ my $seen = shift;
+ my @out;
+ my $line;
+ my $call = $self->{call};
+ my $printit = 1;
+
+ dbg("config: $call nodes: $nodes_only level: $level calls: " . join(',', @_)) if isdbg('routec');
+
+ # allow ranges
+ if (@_) {
+ $printit = grep $call =~ m|$_|, @_;
+ }
+
+ if ($printit) {
+ my $pcall = $self->user_call;
+ $pcall .= ":" . $self->obscount if isdbg('obscount');
+
+
+ $line = ' ' x ($level*2) . $pcall;
+ $pcall = ' ' x length $pcall;
+
+ # recursion detector
+ if ((DXChannel::get($call) && $level > 1) || $seen->{$call}) {
+ $line .= ' ...';
+ push @out, $line;
+ return @out;
+ }
+ $seen->{$call}++;
+
+ # print users
+ unless ($nodes_only) {
+ if (@{$self->{users}}) {
+ $line .= '->';
+ foreach my $ucall (sort @{$self->{users}}) {
+ my $uref = Route::User::get($ucall);
+ my $c;
+ if ($uref) {
+ $c = $uref->user_call;
+ } else {
+ $c = "$ucall?";
+ }
+ if ((length $line) + (length $c) + 1 < 79) {
+ $line .= $c . ' ';
+ } else {
+ $line =~ s/\s+$//;
+ push @out, $line;
+ $line = ' ' x ($level*2) . "$pcall->$c ";
+ }
+ }
+ }
+ }
+ $line =~ s/->$//g;
+ $line =~ s/\s+$//;
+ push @out, $line if length $line;
+ } else {
+ # recursion detector
+ if ((DXChannel::get($call) && $level > 1) || $seen->{$call}) {
+ return @out;
+ }
+ $seen->{$call}++;
+ }
+
+ # deal with more nodes
+ foreach my $ncall (sort @{$self->{nodes}}) {
+ my $nref = Route::Node::get($ncall);
+
+ if ($nref) {
+ my $c = $nref->user_call;
+ dbg("recursing from $call -> $c") if isdbg('routec');
+ my @rout = $nref->config($nodes_only, $level+1, $seen, @_);
+ if (@rout && @_) {
+ push @out, ' ' x ($level*2) . $self->user_call unless grep /^\s+$call/, @out;
+ }
+ push @out, @rout;
+ } else {
+ push @out, ' ' x (($level+1)*2) . "$ncall?" if @_ == 0 || (@_ && grep $ncall =~ m|$_|, @_);
+ }
+ }
+
+ return @out;
+}
+
+sub cluster
+{
+ my $nodes = Route::Node::count();
+ my $tot = Route::User::count();
+ my $users = scalar DXCommandmode::get_all();
+ my $maxusers = Route::User::max();
+ my $uptime = main::uptime();
+
+ return " $nodes nodes, $users local / $tot total users Max users $maxusers Uptime $uptime";
+}
+
+#
+# routing things
+#
+
+sub get
+{
+ my $call = shift;
+ return Route::Node::get($call) || Route::User::get($call);
+}
+
+sub findroutes
+{
+ my $call = shift;
+ my $level = shift || 0;
+ my $seen = shift || {};
+ my @out;
+
+ dbg("findroutes: $call level: $level calls: " . join(',', @_)) if isdbg('routec');
+
+ # recursion detector
+ return () if $seen->{$call};
+ if (my $dxchan = DXChannel::get($call)) {
+ $seen->{$call}++;
+ push @out, $level ? [$level, $dxchan] : $dxchan;
+ return @out;
+ }
+ $seen->{$call}++;
+
+ # deal with more nodes
+ my $nref = Route::get($call);
+ foreach my $ncall (@{$nref->{parent}}) {
+ unless ($seen->{$ncall}) {
+ dbg("recursing from $call -> $ncall") if isdbg('routec');
+ my @rout = findroutes($ncall, $level+1, $seen);
+ push @out, @rout;
+ }
+ }
+
+ if ($level == 0) {
+ my @nout = map {$_->[1]} sort {$a->[0] <=> $b->[0]} @out;
+ my $last;
+ if ($nref->isa('Route::Node')) {
+ my $ncall = $nref->PC92C_dxchan;
+ $last = DXChannel::get($ncall) if $ncall;
+ } else {
+ my $pcall = $nref->{parent}->[0];
+ my ($ref, $ncall);
+ $ref = Route::Node::get($pcall) if $pcall;
+ $ncall = $ref->PC92C_dxchan if $ref;
+ $last = DXChannel::get($ncall) if $ncall;
+ }
+
+ if (isdbg('findroutes')) {
+ if (@out) {
+ foreach (sort {$a->[0] <=> $b->[0]} @out) {
+ dbg("ROUTE: findroute $call -> $_->[0] " . $_->[1]->call);
+ }
+ } else {
+ dbg("ROUTE: findroute $call -> PC92C_dxchan " . $last->call) if $last;
+ }
+ }
+ push @nout, $last if @out == 0 && $last;
+ return @nout;
+ } else {
+ return @out;
+ }
+}
+
+# find all the possible dxchannels which this object might be on
+sub alldxchan
+{
+ my $self = shift;
+ my @dxchan = findroutes($self->{call});
+ return @dxchan;
+}
+
+sub dxchan
+{
+ my $self = shift;
+
+ # ALWAYS return the locally connected channel if present;
+ my $dxchan = DXChannel::get($self->call);
+ return $dxchan if $dxchan;
+
+ my @dxchan = $self->alldxchan;
+ return undef unless @dxchan;
+
+ # determine the minimum ping channel
+# my $minping = 99999999;
+# foreach my $dxc (@dxchan) {
+# my $p = $dxc->pingave;
+# if (defined $p && $p < $minping) {
+# $minping = $p;
+# $dxchan = $dxc;
+# }
+# }
+# $dxchan = shift @dxchan unless $dxchan;
+
+ # dxchannels are now returned in order of "closeness"
+ return $dxchan[0];
+}
+
+
+
#
# track destruction
#
{
my $self = shift;
my $pkg = ref $self;
-
- dbg('route', "$pkg $self->{call} destroyed");
+
+ dbg("$pkg $self->{call} destroyed") if isdbg('routelow');
}
no strict;
#
-# return a list of valid elements
-#
+# return a list of valid elements
+#
sub fields
{
my $pkg = shift;
- my @out, keys %pkg::valid if ref $pkg;
+ $pkg = ref $pkg if ref $pkg;
+ my $val = "${pkg}::valid";
+ my @out = keys %$val;
push @out, keys %valid;
return @out;
}
#
sub field_prompt
-{
+{
my ($self, $ele) = @_;
my $pkg = ref $self;
- return $pkg::valid{$ele} || $valid{$ele};
+ my $val = "${pkg}::valid";
+ return $val->{$ele} || $valid{$ele};
}
#
#
sub AUTOLOAD
{
- my $self = shift;
- my ($pkg, $name) = $AUTOLOAD =~ /^(.*)::([^:]*)$/;
- return if $name eq 'DESTROY';
-
- confess "Non-existant field '$AUTOLOAD'" unless $valid{$name} || $pkg::valid{$name};
+ no strict;
+ my $name = $AUTOLOAD;
+ return if $name =~ /::DESTROY$/;
+ $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;
+
}
1;