1 #!/usr/bin/perl## This module impliments the abstracted routing for all protocols and# is probably what I SHOULD have done the first time.## Heyho.## 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 $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) = @_; $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;}## get a callsign from a passed reference or a string#sub _getcall{ my $self = shift; my $thingy = shift; $thingy = $self unless $thingy; $thingy = $thingy->call if ref $thingy; $thingy = uc $thingy if $thingy; return $thingy;}## add and delete a callsign to/from a list#sub _addlist{ my $self = shift; my $field = shift; my @out; foreach my $c (@_) { confess "Need a ref here" unless ref($c); my $call = $c->{call}; unless (grep $_ eq $call, @{$self->{$field}}) { push @{$self->{$field}}, $call; 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 (@_) { 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(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; my $level = shift; my $seen = shift; my @out; my $line; my $call = $self->user_call; my $printit = 1; # allow ranges if (@_) { $printit = grep $call =~ m|$_|, @_; } if ($printit) { my $pcall = $call; $pcall .= ":" . $self->obscount if $self->via_pc92; $line = ' ' x ($level*2) . "$pcall"; $call = ' ' x length $pcall; # recursion detector if ((DXChannel::get($self->{call}) && $level > 1) || grep $self->{call} eq $_, @$seen) { $line .= ' ...'; push @out, $line; return @out; } push @$seen, $self->{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) . "$call->$c "; } } } } $line =~ s/->$//g; $line =~ s/\s+$//; push @out, $line if length $line; } # 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'); push @out, $nref->config($nodes_only, $level+1, $seen, @_); } 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);}# find all the possible dxchannels which this object might be onsub alldxchan{ my $self = shift; my @dxchan;# dbg("Trying node $self->{call}") if isdbg('routech'); my $dxchan = DXChannel::get($self->{call}); push @dxchan, $dxchan if $dxchan; # it isn't, build up a list of dxchannels and possible ping times # for all the candidates. unless (@dxchan) { foreach my $p (@{$self->{parent}}) {# dbg("Trying parent $p") if isdbg('routech'); next if $p eq $main::mycall; # the root my $dxchan = DXChannel::get($p); if ($dxchan) { push @dxchan, $dxchan unless grep $dxchan == $_, @dxchan; } else { next if grep $p eq $_, @_; my $ref = Route::Node::get($p);# dbg("Next node $p " . ($ref ? 'Found' : 'NOT Found') if isdbg('routech') ); push @dxchan, $ref->alldxchan($self->{call}, @_) if $ref; } } }# dbg('routech', "Got dxchan: " . join(',', (map{ $_->call } @dxchan)) ); 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; return $dxchan;}## track destruction#sub DESTROY{ my $self = shift; my $pkg = ref $self; dbg("$pkg $self->{call} destroyed") if isdbg('routelow');}no strict;## return a list of valid elements#sub fields{ my $pkg = shift; $pkg = ref $pkg if ref $pkg; my $val = "${pkg}::valid"; my @out = keys %$val; push @out, keys %valid; return @out;}## return a prompt for a field#sub field_prompt{ my ($self, $ele) = @_; my $pkg = ref $self; my $val = "${pkg}::valid"; return $val->{$ele} || $valid{$ele};}## generic AUTOLOAD for accessors#sub AUTOLOAD{ 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}}; goto &$AUTOLOAD;}1;