Prepare for git repository
[spider.git] / perl / DXXml.pm
index 1bea12c784d38d9bda02e6cbfe1074aebb1a0312..3bc8427403c2f8164c65e5ad7911e20de38d4052 100644 (file)
@@ -14,24 +14,33 @@ use IsoTime;
 use DXProt;
 use DXDebug;
 use DXLog;
+use DXUtil;
 use DXXml::Ping;
 use DXXml::Dx;
+use DXXml::IM;
+use DXXml::Text;
+use DXXml::Cmd;
 
-use vars qw($VERSION $BRANCH $xs $id);
-$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
-$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
-$main::build += $VERSION;
-$main::branch += $BRANCH;
-
+use vars qw($xs $id $max_old_age $max_future_age $dupeage);
 $xs = undef;                                   # the XML::Simple parser instance
 $id = 0;                                               # the next ID to be used
+$max_old_age = 3600;                   # how old a sentence we will accept
+$max_future_age = 900;                 # how far into the future we will accept
+$dupeage = 12*60*60;                   # duplicates stored half a day 
+
 
 # generate a new XML sentence structure 
 sub new
 {
        my $pkg = shift;
        my $class = ref $pkg || $pkg;
-       return bless{@_}, $class;
+       my $self = bless{}, $class;
+       while (@_) {
+               my $key = shift;
+               my $val = shift;
+               $self->{$key} = $val if defined $val;
+       }
+       return $self; 
 }
 
 #
@@ -41,15 +50,25 @@ sub init
 {
        return unless $main::do_xml;
        
-       eval { require XML::Simple; };
-       unless ($@) {
+       eval { require XML::Simple };
+       eval { require XML::Parser } unless $@;
+       if ($@) {
+               LogDbg('err', "do_xml was set to 1 and the XML routines failed to load ($@)");
+               $main::do_xml = $xs = 0;
+       } else {
+               $XML::Simple::PREFERRED_PARSER = 'XML::Parser';
                import XML::Simple;
-               $DXProt::handle_xml = 1;
-               $xs = new XML::Simple();
+               $xs = new XML::Simple(ContentKey=>'content', ForceArray=>1);
        }
        undef $@;
 }
 
+# is XML avaiable and active
+sub available
+{
+       return $main::do_xml && $xs;
+}
+
 #
 # note that this a function not a method
 #
@@ -58,7 +77,7 @@ sub normal
        my $dxchan = shift;
        my $line = shift;
 
-       unless ($main::do_xml) {
+       unless (available()) {
                dbg("xml not enabled, IGNORED") if isdbg('chanerr');
                return;
        }
@@ -77,21 +96,80 @@ sub normal
                undef $@;
                return;
        }
-       
+
+       # do some basic checks
+       my ($o, $t, $id);
+       unless (exists $xref->{o} && is_callsign($o = $xref->{o})) {
+               dbg("Invalid origin, not a callsign") if isdbg('chanerr');
+               return;
+       }
+       unless (exists $xref->{t} && ($t = IsoTime::unixtime($xref->{t}))) {
+               dbg("Invalid, non-existant or zero time") if isdbg('chanerr');
+               return;
+       }
+       unless ($t > $main::systime - $max_old_age && $t < $main::systime + $max_future_age) {
+               dbg("Too old or too far in the future") if isdbg('chanerr');
+               return;
+       }
+       unless (exists $xref->{id} && ($id = $xref->{id}) >= 0 && $id <= 999) {
+               dbg("Invalid or non-existant id") if isdbg('chanerr');
+               return;
+       }
+
        # mark the handle as accepting xml (but only if they 
        # have at least one right)
        $dxchan->handle_xml(1);
 
-       $xref = bless $xref, $pkg;
-       $xref->{'-xml'} = $line; 
-       $xref->handle_input($dxchan);
+       # now check that we have not seen this before 
+       # this is based on the tuple (o (origin), t (time, normalised to time_t), id)
+       $xref->{'-timet'} = $t;
+       return if DXDupe::check("xml,$o,$t,$id", $dupeage);
+               
+       my $r = bless $xref, $pkg;
+       $r->{'-xml'} = $line; 
+       $r->handle_input($dxchan);
 }
 
 #
 # note that this a function not a method
 #
+
+my $last10;
+my $last_hour;
+
 sub process
 {
+       my $t = time;
+       my @dxchan = DXChannel::get_all();
+       my $dxchan;
+
+       foreach $dxchan (@dxchan) {
+               next unless $dxchan->is_node;
+               next unless $dxchan->handle_xml;
+               next if $dxchan == $main::me;
+
+               # send a ping out on this channel
+               if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
+                       if ($dxchan->{nopings} <= 0) {
+                               $dxchan->disconnect;
+                       } else {
+                               DXXml::Ping::add($main::me, $dxchan->call);
+                               $dxchan->{nopings} -= 1;
+                               $dxchan->{lastping} = $t;
+                       }
+               }
+       }
+
+
+       # every ten seconds
+       if (!$last10 || $t - $last10 >= 10) {   
+               $last10 = $t;
+       }
+
+       # every hour
+       if (!$last_hour || $main::systime - 3600 > $last_hour) {
+               $last_hour = $main::systime;
+       }
 
 }
 
@@ -119,10 +197,10 @@ sub toxml
 
        unless (exists $self->{'-xml'}) {
                $self->{o} ||= $main::mycall;
-               $self->{t} ||= IsoTime::dayms();
+               $self->{t} ||= IsoTime::hourminsec();
                $self->{id} ||= nextid();
                
-               my ($name) = ref $self =~ /::(\w+)$/;
+               my ($name) = (ref $self) =~ /::(\w+)$/;
                $self->{'-xml'} = $xs->XMLout($self, RootName =>lc $name, NumericEscape=>1);
        }
        return $self->{'-xml'};
@@ -133,19 +211,25 @@ sub route
        my $self = shift;
        my $fromdxchan = shift;
        my $to = shift;
-       my $via = $to || $self->{'-via'} || $self->{to};
+       my $via = $to;
+       my $dxchan;
+       
+       if (my $u = $self->{u} && $self->{to} eq $main::mycall) {
+               $via ||= $u if ($dxchan = DXChannel::get($u));
+       }
+       $via ||= $self->{'-via'} || $self->{to};
 
        unless ($via) {
-               dbg("XML: no route specified (" . $self->toxml . ")") if isdbg('chanerr');
+               dbg("XML: no route specified (" . dd($self) . ")") if isdbg('chanerr');
                return;
        }
        if (ref $fromdxchan && $via && $fromdxchan->call eq $via) {
-               dbg("XML: Trying to route back to source (" . $self->toxml . ")") if isdbg('chanerr');
+               dbg("XML: Trying to route back to source (" . dd($self) . ")") if isdbg('chanerr');
                return;
        }
 
        # always send it down the local interface if available
-       my $dxchan = DXChannel::get($via);
+       $dxchan ||= DXChannel::get($via);
        if ($dxchan) {
                dbg("route: $via -> $dxchan->{call} direct" ) if isdbg('route');
        } else {
@@ -169,22 +253,27 @@ sub route
        }
 
        if ($fromdxchan->call eq $via) {
-               dbg("XML: Trying to route back to source (" . $self->toxml . ")") if isdbg('chanerr');
+               dbg("XML: Trying to route back to source (" . dd($self) . ")") if isdbg('chanerr');
                return;
        }
 
        if ($dxchan == $main::me) {
-               dbg("XML: Trying to route to me (" . $self->toxml . ")") if isdbg('chanerr');
+               dbg("XML: Trying to route to me (" . dd($self) . ")") if isdbg('chanerr');
                return;
        }
 
+       $self->{o} ||= $main::mycall;
+       $self->{id} ||= nextid();
+       $self->{'-timet'} ||= $main::systime;
+
        if ($dxchan->handle_xml) {
                $dxchan->send($self->toxml);
+       } elsif ($dxchan->is_node) {
+               my $ref = $self->topcxx($dxchan);
+               $dxchan->send($ref);
        } else {
-               $self->{o} ||= $main::mycall;
-               $self->{id} ||= nextid();
-               $self->{'-timet'} ||= $main::systime;
-               $dxchan->send($self->topcxx);
+               my $ref = $self->tocmd($dxchan);
+               $dxchan->send($ref);
        }
 }