New improved route finding algorithm
[spider.git] / perl / Route.pm
index cbc172dd93350215e625cfe680a6ad3e77e88c49..3301099890e23214948639c8aa28c667bc52dbfd 100644 (file)
@@ -1,37 +1,74 @@
-#!/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) = @_;
+       $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);
 
-       dbg('routelow', "create " . (ref($pkg) || $pkg) ." with $call");
-       
-       return bless {call => $call}, (ref $pkg || $pkg);
+       $self->{flags} = here(1);
+
+       return $self;
 }
 
 #
@@ -48,7 +85,7 @@ sub _getcall
        return $thingy;
 }
 
-# 
+#
 # add and delete a callsign to/from a list
 #
 
@@ -56,42 +93,61 @@ sub _addlist
 {
        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('routelow', ref($self) . " adding $call to " . $self->{call} . "->\{$field\}");
+                       dbg(ref($self) . " adding $call to " . $self->{call} . "->\{$field\}") if isdbg('routelow');
+                       push @out, $c;
                }
        }
-       return $self->{$field};
+       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('routelow', ref($self) . " deleting $call from " . $self->{call} . "->\{$field\}");
+                       dbg(ref($self) . " deleting $call from " . $self->{call} . "->\{$field\}") if isdbg('routelow');
+                       push @out, $c;
                }
        }
-       return $self->{$field};
+       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 unless $r;
+       return ($self->{flags} & 2) ? 1 : 0 unless defined $r;
        $self->{flags} = (($self->{flags} & ~2) | ($r ? 2 : 0));
-       return $r;
+       return $r ? 1 : 0;
 }
 
 sub conf
@@ -99,12 +155,18 @@ sub conf
        my $self = shift;
        my $r = shift;
        return $self ? 1 : 0 unless ref $self;
-       return $self->{flags} & 1 unless $r;
+       return ($self->{flags} & 1) ? 1 : 0 unless defined $r;
        $self->{flags} = (($self->{flags} & ~1) | ($r ? 1 : 0));
-       return $r;
+       return $r ? 1 : 0;
+}
+
+sub parents
+{
+       my $self = shift;
+       return @{$self->{parent}};
 }
 
-# 
+#
 # display routines
 #
 
@@ -118,21 +180,39 @@ sub user_call
 sub config
 {
        my $self = shift;
-       my $nodes_only = shift;
+       my $nodes_only = shift || 0;
+       my $width = shift || 79;
        my $level = shift;
+       my $seen = shift;
        my @out;
        my $line;
-       my $call = $self->user_call;
+       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) {
-               $line = ' ' x ($level*2) . "$call";
-               $call = ' ' x length $call; 
+               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 .= '->';
@@ -144,12 +224,12 @@ sub config
                                        } else {
                                                $c = "$ucall?";
                                        }
-                                       if ((length $line) + (length $c) + 1 < 79) {
+                                       if ((length $line) + (length $c) + 1 < $width) {
                                                $line .= $c . ' ';
                                        } else {
                                                $line =~ s/\s+$//;
                                                push @out, $line;
-                                               $line = ' ' x ($level*2) . "$call->";
+                                               $line = ' ' x ($level*2) . "$pcall->$c ";
                                        }
                                }
                        }
@@ -157,26 +237,131 @@ sub config
                $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;
-                       push @out, $nref->config($nodes_only, $level+1, @_);
+                       dbg("recursing from $call -> $c") if isdbg('routec');
+                       my @rout = $nref->config($nodes_only, $width, $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|$_|, @_); 
+                       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 @out;
+
+       dbg("ROUTE: findroutes: $call") if isdbg('findroutes');
+
+       # return immediately if we are directly connected
+       if (my $dxchan = DXChannel::get($call)) {
+               return $dxchan;
+       }
+
+       my $nref = Route::get($call);
+       return () unless $nref;
+
+       # obtain the dxchannels that have seen this thingy
+       my @parent = $nref->isa('Route::User') ? @{$nref->{parent}} : $call;
+       my %cand;
+       foreach my $p (@parent) {
+               my $r = Route::Node::get($p);
+               if ($r) {
+                       my %r = $r->PC92C_dxchan;
+                       while (my ($k, $v) = each %r) {
+                               $cand{$k} = $v if $v > ($cand{$k} || 0);
+                       }
+               }
+       }
+
+       # remove any dxchannels that have gone away
+       while (my ($k, $v) = each %cand) {
+               if (my $dxc = DXChannel::get($k)) {
+                       push @out, [$v, $dxc];
+               }
+       }
+
+       # get a sorted list of dxchannels with the highest hop count first
+       my @nout = map {$_->[1]} sort {$b->[0] <=> $a->[0]} @out;
+       if (isdbg('findroutes')) {
+               if (@out) {
+                       foreach (sort {$b->[0] <=> $a->[0]} @out) {
+                               dbg("ROUTE: findroute $call -> $_->[0] " . $_->[1]->call);
+                       }
+               }
+       }
+
+       return @nout;
+}
+
+# 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;
+
+       # dxchannels are now returned in order of "closeness"
+       return $dxchan[0];
+}
+
+sub delete_interface
+{
+
+}
+
 
 #
 # track destruction
@@ -186,14 +371,14 @@ sub DESTROY
 {
        my $self = shift;
        my $pkg = ref $self;
-       
-       dbg('routelow', "$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
 {
@@ -210,7 +395,7 @@ sub fields
 #
 
 sub field_prompt
-{ 
+{
        my ($self, $ele) = @_;
        my $pkg = ref $self;
     my $val = "${pkg}::valid";
@@ -222,17 +407,18 @@ sub field_prompt
 #
 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;
+
 }
 
 1;