3 # This module impliments the abstracted routing for all protocols and
4 # is probably what I SHOULD have done the first time.
8 # This is just a container class which I expect to subclass
10 # Copyright (c) 2001 Dirk Koopman G1TLH
24 use vars qw($VERSION $BRANCH);
26 main::mkver($VERSION = q$Revision$);
28 use vars qw(%list %valid $filterdef);
32 flags => "0,Flags,phex",
33 dxcc => '0,Country Code',
38 aranea => '0, By Aranea,yesno',
42 # tag, sort, field, priv, special parser
44 ['channel_dxcc', 'nc', 1],
45 ['channel_itu', 'ni', 2],
46 ['channel_zone', 'nz', 3],
49 ['call_dxcc', 'nc', 5],
51 ['call_itu', 'ni', 6],
53 ['call_zone', 'nz', 7],
55 ['channel_state', 'ns', 8],
56 ['call_state', 'ns', 9],
57 ['by_state', 'ns', 9],
66 $pkg = ref $pkg if ref $pkg;
68 my $self = bless {call => $call}, $pkg;
69 dbg("create $pkg with $call") if isdbg('routelow');
71 # add in all the dxcc, itu, zone info
72 ($self->{dxcc}, $self->{itu}, $self->{cq}, $self->{state}, $self->{city}) =
73 Prefix::cty_data($call);
81 # get a callsign from a passed reference or a string
88 $thingy = $self unless $thingy;
89 $thingy = $thingy->call if ref $thingy;
90 $thingy = uc $thingy if $thingy;
95 # add and delete a callsign to/from a list
104 confess "Need a ref here" unless ref($c);
106 my $call = $c->{call};
107 unless (grep $_ eq $call, @{$self->{$field}}) {
108 push @{$self->{$field}}, $call;
109 dbg(ref($self) . " adding $call to " . $self->{call} . "->\{$field\}") if isdbg('routelow');
122 confess "Need a ref here" unless ref($c);
123 my $call = $c->{call};
124 if (grep $_ eq $call, @{$self->{$field}}) {
125 $self->{$field} = [ grep {$_ ne $call} @{$self->{$field}} ];
126 dbg(ref($self) . " deleting $call from " . $self->{call} . "->\{$field\}") if isdbg('routelow');
139 my $r = grep $_->{call} eq $call, @{$self->{$field}};
140 dbg(ref($self) . " $call is " . $r?'in':'NOT in' . " $self->{call}\->\{$field\}") if isdbg('routelow');
146 return @{$self->{$_[0]}} == 0;
150 # flag field constructors/enquirers
152 # These can be called in various ways:-
154 # Route::here or $ref->here returns 1 or 0 depending on value of the here flag
155 # Route::here(1) returns 1 (the bit value of the here flag)
156 # $ref->here(1) or $ref->here(0) sets the here flag
158 # these are now redundant really as we are not interested in conferences
159 # and here is back to being '1'.
164 $self->{flags} = shift if @_;
165 return $self->{flags};
168 # conferencing in the ak1a sense is not supported
178 return @{$self->{parent}};
188 my $call = sprintf "%s", $self->{call};
189 return $self->here ? "$call" : "($call)";
195 my $nodes_only = shift;
200 my $call = $self->user_call;
205 $printit = grep $call =~ m|$_|, @_;
209 $line = ' ' x ($level*2) . "$call";
210 $call = ' ' x length $call;
213 if ((DXChannel::get($self->{call}) && $level > 1) || grep $self->{call} eq $_, @$seen) {
218 push @$seen, $self->{call};
221 unless ($nodes_only) {
222 if (@{$self->{users}}) {
224 foreach my $ucall (sort @{$self->{users}}) {
225 my $uref = Route::User::get($ucall);
228 $c = $uref->user_call;
232 if ((length $line) + (length $c) + 1 < 79) {
237 $line = ' ' x ($level*2) . "$call->$c ";
244 push @out, $line if length $line;
247 # deal with more nodes
248 foreach my $ncall (sort @{$self->{nodes}}) {
249 my $nref = Route::Node::get($ncall);
252 my $c = $nref->user_call;
253 # dbg("recursing from $call -> $c") if isdbg('routec');
254 push @out, $nref->config($nodes_only, $level+1, $seen, @_);
256 push @out, ' ' x (($level+1)*2) . "$ncall?" if @_ == 0 || (@_ && grep $ncall =~ m|$_|, @_);
265 my $nodes = Route::Node::count();
266 my $tot = Route::User::count();
267 my $users = scalar DXCommandmode::get_all();
268 my $maxusers = Route::User::max();
269 my $uptime = main::uptime();
271 return " $nodes nodes, $users local / $tot total users Max users $maxusers Uptime $uptime";
281 return Route::Node::get($call) || Route::User::get($call);
284 # find all the possible dxchannels which this object might be on
289 # dbg("Trying node $self->{call}") if isdbg('routech');
291 my $dxchan = DXChannel::get($self->{call});
292 push @dxchan, $dxchan if $dxchan;
294 # it isn't, build up a list of dxchannels and possible ping times
295 # for all the candidates.
297 foreach my $p (@{$self->{parent}}) {
298 # dbg("Trying parent $p") if isdbg('routech');
299 next if $p eq $main::mycall; # the root
300 my $dxchan = DXChannel::get($p);
302 push @dxchan, $dxchan unless grep $dxchan == $_, @dxchan;
304 next if grep $p eq $_, @_;
305 my $ref = Route::Node::get($p);
306 # dbg("Next node $p " . ($ref ? 'Found' : 'NOT Found') if isdbg('routech') );
307 push @dxchan, $ref->alldxchan($self->{call}, @_) if $ref;
311 # dbg('routech', "Got dxchan: " . join(',', (map{ $_->call } @dxchan)) );
319 # ALWAYS return the locally connected channel if present;
320 my $dxchan = DXChannel::get($self->call);
321 return $dxchan if $dxchan;
323 my @dxchan = $self->alldxchan;
324 return undef unless @dxchan;
326 # determine the minimum ping channel
327 my $minping = 99999999;
328 foreach my $dxc (@dxchan) {
329 my $p = $dxc->pingave;
330 if (defined $p && $p < $minping) {
335 $dxchan = shift @dxchan unless $dxchan;
350 dbg("$pkg $self->{call} destroyed") if isdbg('routelow');
355 # return a list of valid elements
361 $pkg = ref $pkg if ref $pkg;
362 my $val = "${pkg}::valid";
363 my @out = keys %$val;
364 push @out, keys %valid;
369 # return a prompt for a field
374 my ($self, $ele) = @_;
376 my $val = "${pkg}::valid";
377 return $val->{$ele} || $valid{$ele};
381 # generic AUTOLOAD for accessors
386 my $name = $AUTOLOAD;
387 return if $name =~ /::DESTROY$/;
390 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
392 # this clever line of code creates a subroutine which takes over from autoload
393 # from OO Perl - Conway
394 *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};