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
25 use vars qw(%list %valid $filterdef);
29 flags => "0,Flags,phex",
30 dxcc => '0,Country Code',
38 # tag, sort, field, priv, special parser
40 ['channel_dxcc', 'nc', 1],
41 ['channel_itu', 'ni', 2],
42 ['channel_zone', 'nz', 3],
45 ['call_dxcc', 'nc', 5],
47 ['call_itu', 'ni', 6],
49 ['call_zone', 'nz', 7],
51 ['channel_state', 'ns', 8],
52 ['call_state', 'ns', 9],
53 ['by_state', 'ns', 9],
59 my ($pkg, $call) = @_;
60 $pkg = ref $pkg if ref $pkg;
62 my $self = bless {call => $call}, $pkg;
63 dbg("create $pkg with $call") if isdbg('routelow');
65 # add in all the dxcc, itu, zone info
66 ($self->{dxcc}, $self->{itu}, $self->{cq}, $self->{state}, $self->{city}) =
67 Prefix::cty_data($call);
69 $self->{flags} = here(1);
75 # get a callsign from a passed reference or a string
82 $thingy = $self unless $thingy;
83 $thingy = $thingy->call if ref $thingy;
84 $thingy = uc $thingy if $thingy;
89 # add and delete a callsign to/from a list
98 confess "Need a ref here" unless ref($c);
100 my $call = $c->{call};
101 unless (grep $_ eq $call, @{$self->{$field}}) {
102 push @{$self->{$field}}, $call;
103 dbg(ref($self) . " adding $call to " . $self->{call} . "->\{$field\}") if isdbg('routelow');
116 confess "Need a ref here" unless ref($c);
117 my $call = $c->{call};
118 if (grep $_ eq $call, @{$self->{$field}}) {
119 $self->{$field} = [ grep {$_ ne $call} @{$self->{$field}} ];
120 dbg(ref($self) . " deleting $call from " . $self->{call} . "->\{$field\}") if isdbg('routelow');
130 return @{$self->{$_[0]}} == 0;
134 # flag field constructors/enquirers
136 # These can be called in various ways:-
138 # Route::here or $ref->here returns 1 or 0 depending on value of the here flag
139 # Route::here(1) returns 2 (the bit value of the here flag)
140 # $ref->here(1) or $ref->here(0) sets the here flag
147 return $self ? 2 : 0 unless ref $self;
148 return ($self->{flags} & 2) ? 1 : 0 unless defined $r;
149 $self->{flags} = (($self->{flags} & ~2) | ($r ? 2 : 0));
157 return $self ? 1 : 0 unless ref $self;
158 return ($self->{flags} & 1) ? 1 : 0 unless defined $r;
159 $self->{flags} = (($self->{flags} & ~1) | ($r ? 1 : 0));
166 return @{$self->{parent}};
176 my $call = sprintf "%s", $self->{call};
177 return $self->here ? "$call" : "($call)";
183 my $nodes_only = shift || 0;
188 my $call = $self->{call};
191 dbg("config: $call nodes: $nodes_only level: $level calls: " . join(',', @_)) if isdbg('routec');
195 $printit = grep $call =~ m|$_|, @_;
199 my $pcall = $self->user_call;
200 $pcall .= ":" . $self->obscount if isdbg('obscount');
203 $line = ' ' x ($level*2) . "$pcall";
204 $pcall = ' ' x length $pcall;
207 if ((DXChannel::get($call) && $level > 1) || $seen->{$call}) {
215 unless ($nodes_only) {
216 if (@{$self->{users}}) {
218 foreach my $ucall (sort @{$self->{users}}) {
219 my $uref = Route::User::get($ucall);
222 $c = $uref->user_call;
226 if ((length $line) + (length $c) + 1 < 79) {
231 $line = ' ' x ($level*2) . "$pcall->$c ";
238 push @out, $line if length $line;
241 if ((DXChannel::get($call) && $level > 1) || $seen->{$call}) {
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 my @rout = $nref->config($nodes_only, $level+1, $seen, @_);
256 push @out, ' ' x ($level*2) . $self->user_call unless grep /^\s+$call/, @out;
260 push @out, ' ' x (($level+1)*2) . "$ncall?" if @_ == 0 || (@_ && grep $ncall =~ m|$_|, @_);
269 my $nodes = Route::Node::count();
270 my $tot = Route::User::count();
271 my $users = scalar DXCommandmode::get_all();
272 my $maxusers = Route::User::max();
273 my $uptime = main::uptime();
275 return " $nodes nodes, $users local / $tot total users Max users $maxusers Uptime $uptime";
285 return Route::Node::get($call) || Route::User::get($call);
291 my $level = shift || 0;
292 my $seen = shift || {};
295 dbg("findroutes: $call level: $level calls: " . join(',', @_)) if isdbg('routec');
298 return () if $seen->{$call};
299 if (my $dxchan = DXChannel::get($call)) {
301 push @out, $level ? [$level, $dxchan] : $dxchan;
305 # deal with more nodes
306 my $nref = Route::get($call);
307 foreach my $ncall (@{$nref->{parent}}) {
308 unless ($seen->{$ncall}) {
309 dbg("recursing from $call -> $ncall") if isdbg('routec');
310 my @rout = findroutes($ncall, $level+1, $seen);
315 return $level == 0 ? map {$_->[1]} sort {$a->[0] <=> $b->[0]} @out : @out;
318 # find all the possible dxchannels which this object might be on
323 # dbg("Trying node $self->{call}") if isdbg('routech');
325 my $dxchan = DXChannel::get($self->{call});
326 push @dxchan, $dxchan if $dxchan;
328 # it isn't, build up a list of dxchannels and possible ping times
329 # for all the candidates.
331 foreach my $p (@{$self->{parent}}) {
332 # dbg("Trying parent $p") if isdbg('routech');
333 next if $p eq $main::mycall; # the root
334 my $dxchan = DXChannel::get($p);
336 push @dxchan, $dxchan unless grep $dxchan == $_, @dxchan;
338 next if grep $p eq $_, @_;
339 my $ref = Route::Node::get($p);
340 # dbg("Next node $p " . ($ref ? 'Found' : 'NOT Found') if isdbg('routech') );
341 push @dxchan, $ref->alldxchan($self->{call}, @_) if $ref;
345 # dbg('routech', "Got dxchan: " . join(',', (map{ $_->call } @dxchan)) );
353 # ALWAYS return the locally connected channel if present;
354 my $dxchan = DXChannel::get($self->call);
355 return $dxchan if $dxchan;
357 my @dxchan = $self->alldxchan;
358 return undef unless @dxchan;
360 # determine the minimum ping channel
361 my $minping = 99999999;
362 foreach my $dxc (@dxchan) {
363 my $p = $dxc->pingave;
364 if (defined $p && $p < $minping) {
369 $dxchan = shift @dxchan unless $dxchan;
384 dbg("$pkg $self->{call} destroyed") if isdbg('routelow');
389 # return a list of valid elements
395 $pkg = ref $pkg if ref $pkg;
396 my $val = "${pkg}::valid";
397 my @out = keys %$val;
398 push @out, keys %valid;
403 # return a prompt for a field
408 my ($self, $ele) = @_;
410 my $val = "${pkg}::valid";
411 return $val->{$ele} || $valid{$ele};
415 # generic AUTOLOAD for accessors
420 my $name = $AUTOLOAD;
421 return if $name =~ /::DESTROY$/;
424 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
426 # this clever line of code creates a subroutine which takes over from autoload
427 # from OO Perl - Conway
428 *{$AUTOLOAD} = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};