[spider.git] / perl / Route / Node.pm

#
# Node routing routines
#
# Copyright (c) 2001 Dirk Koopman G1TLH
#
# $Id$
# 

package Route::Node;

use DXDebug;
use Route;
use Route::User;

use strict;

use vars qw($VERSION $BRANCH);

main::mkver($VERSION = q$Revision$);

use vars qw(%list %valid @ISA $max $filterdef);
@ISA = qw(Route);

%valid = (
                  parent => '0,Parent Calls,parray',
                  nodes => '0,Nodes,parray',
                  users => '0,Users,parray',
                  usercount => '0,User Count',
                  version => '0,Version',
                  build => '0,Build',
                  sw => '0,Software',
                  np => '0,Using New Prot,yesno',
);

$filterdef = $Route::filterdef;
%list = ();
$max = 0;

sub count
{
        my $n = scalar (keys %list);
        $max = $n if $n > $max;
        return $n;
}

sub max
{
        count();
        return $max;
}

#
# this routine handles the possible adding of an entry in the routing
# table. It will only add an entry if it is new. It may have all sorts of
# other side effects which may include fixing up other links.
#
# It will return a node object if (and only if) it is a completely new
# object with that callsign. The upper layers are expected to do something
# sensible with this!
#
# called as $parent->add(call, version, flags) 
#

sub add
{
        my $parent = shift;
        my $call = uc shift;
        confess "Route::add trying to add $call to myself" if $call eq $parent->{call};
        my $version = shift;
        my $here = shift;
        
        my $self = get($call);
        if ($self) {
                $self->_addparent($parent);
                $parent->_addnode($self);
                if ($self->{version} != $version || $self->{flags} != $here) {
                        $self->{version} = $version;
                        $self->{flags} = $here;
                        return $self;
                }
                return undef;
        }
        $self = $parent->new($call, $version, $here);
        $parent->_addnode($self);
        return $self;
}

#
# this routine is the opposite of 'add' above.
#
# It will return an object if (and only if) this 'del' will remove
# this object completely
#

sub del
{
        my $self = shift;
        my $pref = shift;

        # delete parent from this call's parent list
        $pref->_delnode($self);
    $self->_delparent($pref);
        my @nodes;
        my $ncall = $self->{call};
        
        # is this the last connection, I have no parents anymore?
        unless (@{$self->{parent}}) {
                foreach my $rcall (@{$self->{nodes}}) {
                        next if grep $rcall eq $_, @_;
                        my $r = Route::Node::get($rcall);
                        push @nodes, $r->del($self, $ncall, @_) if $r;
                }
                $self->_del_users;
                delete $list{$self->{call}};
                push @nodes, $self;
        }
        return @nodes;
}

sub del_nodes
{
        my $parent = shift;
        my @out;
        foreach my $rcall (@{$parent->{nodes}}) {
                my $r = get($rcall);
                push @out, $r->del($parent, $parent->{call}, @_) if $r;
        }
        return @out;
}

sub _del_users
{
        my $self = shift;
        for (@{$self->{users}}) {
                my $ref = Route::User::get($_);
                $ref->del($self) if $ref;
        }
        $self->{users} = [];
}

# add a user to this node
sub add_user
{
        my $self = shift;
        my $ucall = shift;

        confess "Trying to add NULL User call to routing tables" unless $ucall;

        my $uref = Route::User::get($ucall);
        my @out;
        if ($uref) {
                push @out, $uref->addparent($self);
        } else {
                $uref = Route::User->new($ucall, $self->{call}, @_);
                push @out, $uref;
        }
        $self->_adduser($uref);
        $self->{usercount} = scalar @{$self->{users}};

        return @out;
}

# delete a user from this node
sub del_user
{
        my $self = shift;
        my $ref = shift;
        my @out;
        
        if ($ref) {
                @out = $self->_deluser($ref);
                $ref->del($self);
        } else {
                confess "tried to delete non-existant $ref->{call} from $self->{call}";
        }
        $self->{usercount} = scalar @{$self->{users}};
        return @out;
}

sub usercount
{
        my $self = shift;
        if (@_ && @{$self->{users}} == 0) {
                $self->{usercount} = shift;
        }
        return $self->{usercount};
}

sub users
{
        my $self = shift;
        return @{$self->{users}};
}

sub nodes
{
        my $self = shift;
        return @{$self->{nodes}};
}

sub parents
{
        my $self = shift;
        return @{$self->{parent}};
}

sub has_user
{
        my $self = shift;
        return $self->_haslist('users', shift);
}

sub has_node
{
        my $self = shift;
        return $self->_haslist('nodes', shift);
}

sub has_parent
{
        my $self = shift;
        return $self->_haslist('parent', shift);
}


sub rnodes
{
        my $self = shift;
        my @out;
        foreach my $call (@{$self->{nodes}}) {
                next if grep $call eq $_, @_;
                push @out, $call;
                my $r = get($call);
                push @out, $r->rnodes($call, @_) if $r;
        }
        return @out;
}

# return the differences in nodes between what we currently have and
# the list proffered. Returns two refs one to a list of nodes to remove and  
# the other a list of nodes to add
# 
# input is a list of callsigns (not refs)
sub diff_nodes
{
        my $self = shift;
        my $in = ref $_[0] ? shift : \@_;
        my %del = map {($_, 1)} nodes($self);
        my %in = map {($_, 1)} @$in;
        
        # remove all the calls that are in both lists
        for (@$in) {
                delete $in{$_} if delete $del{$_};
        }
        return ([keys %del], [keys %in]);
}

# same as above but for users
sub diff_users
{
        my $self = shift;
        my $in = ref $_[0] ? shift : \@_;
        my %del = map {($_, 1)} users($self);
        my %in = map {($_, 1)} @$in;
        
        # remove all the calls that are in both lists
        for (@$in) {
                delete $in{$_} if delete $del{$_};
        }
        return ([keys %del], [keys %in]);
}

sub new
{
        my $pkg = shift;
        my $call = uc shift;
        
        confess "already have $call in $pkg" if $list{$call};
        
        my $self = $pkg->SUPER::new($call);
        $self->{parent} = ref $pkg ? [ $pkg->{call} ] : [ ];
        $self->{version} = 0 || shift;
        $self->{flags} = 0 || shift;
        $self->{users} = [];
        $self->{nodes} = [];
        $self->{lid} = 0;
        
        $list{$call} = $self;
        
        return $self;
}

sub get
{
        my $call = shift;
        $call = shift if ref $call;
        my $ref = $list{uc $call};
        dbg("Failed to get Node $call" ) if !$ref && isdbg('routerr');
        return $ref;
}

sub get_all
{
        return values %list;
}

sub newid
{
        my $self = shift;
        my $id = shift;
        
        return 0 if $id == $self->{lid};
        if ($id > $self->{lid}) {
                $self->{lid} = $id;
                return 1;
        } elsif ($self->{lid} - $id > 500) {
                $self->{id} = $id;
                return 1;
        }
        return 0;
}

sub _addparent
{
        my $self = shift;
    return $self->_addlist('parent', @_);
}

sub _delparent
{
        my $self = shift;
    return $self->_dellist('parent', @_);
}


sub _addnode
{
        my $self = shift;
    return $self->_addlist('nodes', @_);
}

sub _delnode
{
        my $self = shift;
    return $self->_dellist('nodes', @_);
}


sub _adduser
{
        my $self = shift;
    return $self->_addlist('users', @_);
}

sub _deluser
{
        my $self = shift;
    return $self->_dellist('users', @_);
}

#
# generic AUTOLOAD for accessors
#

sub AUTOLOAD
{
        no strict;
        my $name = $AUTOLOAD;
        return if $name =~ /::DESTROY$/;
        $name =~ s/^.*:://o;
  
        confess "Non-existant field '$AUTOLOAD'" unless $valid{$name} || $Route::valid{$name};

        # this clever line of code creates a subroutine which takes over from autoload
        # from OO Perl - Conway
        *$AUTOLOAD = sub {$_[0]->{$name} = $_[1] if @_ > 1; return $_[0]->{$name}};
        goto &$AUTOLOAD;
}

1;