Only select those irspy:xxx entries newer than the status/ping date. Still need
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy.pm
index 362e8b0..098946a 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: IRSpy.pm,v 1.28 2006-10-12 15:51:37 mike Exp $
+# $Id: IRSpy.pm,v 1.53 2006-12-11 13:58:17 sondberg Exp $
 
 package ZOOM::IRSpy;
 
@@ -6,15 +6,21 @@ use 5.008;
 use strict;
 use warnings;
 
-use Data::Dumper; # For debugging only
+use Data::Dumper;              # For debugging only
+use File::Basename;
+use XML::LibXSLT;
+use XML::LibXML;
+use XML::LibXML::XPathContext;
 use ZOOM;
 use Net::Z3950::ZOOM 1.13;     # For the ZOOM version-check only
 use ZOOM::IRSpy::Node;
 use ZOOM::IRSpy::Connection;
 use ZOOM::IRSpy::Record;
+use ZOOM::IRSpy::Utils qw(cql_target);
 
 our @ISA = qw();
 our $VERSION = '0.02';
+our $irspy_to_zeerex_xsl = dirname(__FILE__) . '/../../xsl/irspy2zeerex.xsl';
 
 
 # Enumeration for callback functions to return
@@ -23,6 +29,7 @@ sub OK { 29 }                 # No problems, task is still progressing
 sub TASK_DONE { 18 }           # Task is complete, next task should begin
 sub TEST_GOOD { 8 }            # Whole test is complete, and succeeded
 sub TEST_BAD { 31 }            # Whole test is complete, and failed
+sub TEST_SKIPPED { 12 }                # Test couldn't be run
 package ZOOM::IRSpy;
 
 
@@ -46,10 +53,11 @@ protocols.  It is a successor to the ZSpy program.
 
 BEGIN {
     ZOOM::Log::mask_str("irspy");
-    ZOOM::Log::mask_str("irspy_test");
     ZOOM::Log::mask_str("irspy_debug");
     ZOOM::Log::mask_str("irspy_event");
     ZOOM::Log::mask_str("irspy_unhandled");
+    ZOOM::Log::mask_str("irspy_test");
+    ZOOM::Log::mask_str("irspy_task");
 }
 
 sub new {
@@ -63,12 +71,23 @@ sub new {
     my $conn = new ZOOM::Connection($dbname, 0, @options)
        or die "$0: can't connection to IRSpy database 'dbname'";
 
+    my $xslt = new XML::LibXSLT;
+
+    $xslt->register_function($ZOOM::IRSpy::Utils::IRSPY_NS, 'strcmp',
+                             \&ZOOM::IRSpy::Utils::xslt_strcmp);
+
+    my $libxml = new XML::LibXML;
+    my $xsl_doc = $libxml->parse_file($irspy_to_zeerex_xsl);
+    my $irspy_to_zeerex_style = $xslt->parse_stylesheet($xsl_doc);
+
     my $this = bless {
        conn => $conn,
        allrecords => 1,        # unless overridden by targets()
        query => undef,         # filled in later
        targets => undef,       # filled in later
        connections => undef,   # filled in later
+        libxml => $libxml,
+        irspy_to_zeerex_style => $irspy_to_zeerex_style,
        tests => [],            # stack of tests currently being executed
     }, $class;
     $this->log("irspy", "starting up with database '$dbname'");
@@ -102,7 +121,7 @@ sub targets {
            $this->log("irspy_debug", "rewriting '$target' to '$newtarget'");
            $target = $newtarget; # This is written through the ref
        }
-       push @qlist, (qq[(host="$host" and port="$port" and path="$db")]);
+       push @qlist, cql_target($host, $port, $db);
     }
 
     $this->{targets} = \@targets;
@@ -223,28 +242,51 @@ sub _render_record {
 }
 
 
-sub _rewrite_records {
+sub _irspy_to_zeerex {
+    my ($this, $conn) = @_;
+    my $irspy_doc = $conn->record()->{zeerex}->ownerDocument;
+    #open FH, '>/tmp/irspy_orig.xml';
+    #print FH $irspy_doc->toString();
+    #close FH;
+    my %params = ();
+    my $result = $this->{irspy_to_zeerex_style}->transform($irspy_doc, %params);
+
+    #open FH, '>/tmp/irspy_transformed.xml';
+    #print FH $result->toString();
+    #close FH;
+
+    return $result->documentElement();
+}
+
+
+sub _rewrite_record {
     my $this = shift();
+    my($conn) = @_;
 
-    # Write modified records back to database
-    foreach my $conn (@{ $this->{connections} }) {
-       my $rec = $conn->record();
-       my $p = $this->{conn}->package();
-       $p->option(action => "specialUpdate");
-       my $xml = $rec->{zeerex}->toString();
-       $p->option(record => $xml);
-       $p->send("update");
-       $p->destroy();
-
-       $p = $this->{conn}->package();
-       $p->send("commit");
-       $p->destroy();
-       if (0) {
-           $xml =~ s/&/&amp/g;
-           $xml =~ s/</&lt;/g;
-           $xml =~ s/>/&gt;/g;
-           print "Updated with xml=<br/>\n<pre>$xml</pre>\n";
-       }
+    $conn->log("irspy", "rewriting XML record");
+    my $rec = $this->_irspy_to_zeerex($conn);
+    _really_rewrite_record($this->{conn}, $rec);
+}
+
+
+sub _really_rewrite_record {
+    my($conn, $rec) = @_;
+
+    my $p = $conn->package();
+    $p->option(action => "specialUpdate");
+    my $xml = $rec->toString();
+    $p->option(record => $xml);
+    $p->send("update");
+    $p->destroy();
+
+    $p = $conn->package();
+    $p->send("commit");
+    $p->destroy();
+    if (0) {
+       $xml =~ s/&/&amp/g;
+       $xml =~ s/</&lt;/g;
+       $xml =~ s/>/&gt;/g;
+       print "Updated $conn with xml=<br/>\n<pre>$xml</pre>\n";
     }
 }
 
@@ -283,7 +325,7 @@ sub check {
 
     $tname = "Main" if !defined $tname;
     $this->{tree} = $this->_gather_tests($tname)
-       or die "No tests defined";
+       or die "No tests defined for '$tname'";
     #$this->{tree}->print(0);
     my $nskipped = 0;
 
@@ -291,19 +333,28 @@ sub check {
 
     while (1) {
        my @copy_conn = @conn;  # avoid alias problems after splice()
+       my $nconn = scalar(@copy_conn);
        foreach my $i0 (0 .. $#copy_conn) {
            my $conn = $copy_conn[$i0];
-           #print "connection $i0 of ", scalar(@copy_conn), " from ", scalar(@conn), " is $conn\n";
+           #print "connection $i0 of $nconn/", scalar(@conn), " is $conn\n";
            if (!$conn->current_task()) {
                if (!$conn->next_task()) {
                    # Out of tasks: we need a new test
                  NEXT_TEST:
                    my $address = $conn->option("current_test_address");
-                   my $nextaddr = defined $address ?
-                       $this->_next_test($address) : "";
+                   my $nextaddr;
+                   if (!defined $address) {
+                       $nextaddr = "";
+                   } else {
+                       $this->log("irspy_test",
+                                  "checking for next test after '$address'");
+                       $nextaddr = $this->_next_test($address);
+                   }
                    if (!defined $nextaddr) {
                        $conn->log("irspy", "has no more tests: removing");
                        splice @conn, $i0, 1;
+                       $this->_rewrite_record($conn);
+                       $conn->option(rewrote_record => 1);
                        next;
                    }
 
@@ -311,7 +362,8 @@ sub check {
                        or die "invalid nextaddr '$nextaddr'";
                    $conn->option(current_test_address => $nextaddr);
                    my $tname = $node->name();
-                   $conn->log("irspy", "starting test '$nextaddr' = $tname");
+                   $conn->log("irspy_test",
+                              "starting test '$nextaddr' = $tname");
                    my $tasks = $conn->tasks();
                    my $oldcount = @$tasks;
                    "ZOOM::IRSpy::Test::$tname"->start($conn);
@@ -320,14 +372,15 @@ sub check {
                        # Prepare to start the first of the newly added tasks
                        $conn->next_task($tasks->[$oldcount]);
                    } else {
-                       $conn->log("irspy", "no tasks added by new test $tname");
+                       $conn->log("irspy_task",
+                                  "no tasks added by new test $tname");
                        goto NEXT_TEST;
                    }
                }
 
                my $task = $conn->next_task();
                die "no next task queued for $conn" if !defined $task;
-               $conn->log("irspy", "starting task $task");
+               $conn->log("irspy_task", "preparing task $task");
                $conn->next_task(0);
                $conn->current_task($task);
                $task->run();
@@ -337,7 +390,8 @@ sub check {
        }
 
        my $i0 = ZOOM::event(\@conn);
-       $this->log("irspy_event", "ZOOM_event(", scalar(@conn), " connections) = $i0");
+       $this->log("irspy_event",
+                  "ZOOM_event(", scalar(@conn), " connections) = $i0");
        last if $i0 == 0 || $i0 == -3; # no events or no connections
        my $conn = $conn[$i0-1];
        my $ev = $conn->last_event();
@@ -385,27 +439,70 @@ sub check {
            my $task = $conn->current_task();
            die "no task for TASK_DONE on $conn" if !$task;
            die "next task already defined for $conn" if $conn->next_task();
-           $conn->log("irspy", "completed task $task");
+           $conn->log("irspy_task", "completed task $task");
            $conn->next_task($task->{next});
            $conn->current_task(0);
 
        } elsif ($res == ZOOM::IRSpy::Status::TEST_GOOD ||
                 $res == ZOOM::IRSpy::Status::TEST_BAD) {
            my $x = ($res == ZOOM::IRSpy::Status::TEST_GOOD) ? "good" : "bad";
-           $conn->log("irspy", "test completed ($x)");
+           $conn->log("irspy_task", "test ended during task $task ($x)");
+           $conn->log("irspy_test", "test completed ($x)");
            $conn->current_task(0);
            $conn->next_task(0);
            if ($res == ZOOM::IRSpy::Status::TEST_BAD) {
-               ### Should skip over remaining sibling tests if TEST_BAD
-               ### Should count the number of skipped siblings
-               $nskipped += 1;
+               my $address = $conn->option('current_test_address');
+               ($address, my $n) = $this->_last_sibling_test($address);
+               if (defined $address) {
+                   $conn->log("irspy_test", "skipped $n tests");
+                   $conn->option(current_test_address => $address);
+                   $nskipped += $n;
+               }
            }
+
+       } elsif ($res == ZOOM::IRSpy::Status::TEST_SKIPPED) {
+           $conn->log("irspy_task", "test skipped during task $task");
+           $conn->current_task(0);
+           $conn->next_task(0);
+           # I think that's all we need to do
+
+       } else {
+           die "unknown callback return-value '$res'";
        }
     }
 
-    $this->log("irspy_event", "no more events: finishing");
+    $this->log("irspy", "exiting main loop");
+    # Sanity checks: none of the following should ever happen
+    foreach my $conn (@{ $this->{connections} }) {
+       my $test = $conn->option("current_test_address");
+       my $next = $this->_next_test($test);
+       if (defined $next) {
+           warn "$conn (in test '$test') has queued test '$next'";
+       }
+       if (my $task = $conn->current_task()) {
+           warn "$conn still has an active task $task";
+       }
+       if (my $task = $conn->next_task()) {
+           warn "$conn still has a queued task $task";
+       }
+       if (!$conn->is_idle()) {
+           warn "$conn still has ZOOM-C level tasks queued: see below";
+       }
+       if (!$conn->option("rewrote_record")) {
+           warn "$conn did not rewrite its ZeeRex record";
+       }
+    }
+
+    # This shouldn't happen emit anything either:
+    @conn = @{ $this->{connections} };
+    while (my $i1 = ZOOM::event(\@conn)) {
+       my $conn = $conn[$i1-1];
+       my $ev = $conn->last_event();
+       my $evstr = ZOOM::event_str($ev);
+       warn "$conn still has ZOOM-C level task queued: $ev ($evstr)"
+           if $ev != ZOOM::Event::ZEND;
+    }
 
-    #$this->_rewrite_records();
     return $nskipped;
 }
 
@@ -418,11 +515,15 @@ sub _gather_tests {
        join(" -> ", @ancestors, $tname))
        if grep { $_ eq $tname } @ancestors;
 
+    my $slashSeperatedTname = $tname;
+    $slashSeperatedTname =~ s/::/\//g;
+    my $fullName = "ZOOM/IRSpy/Test/$slashSeperatedTname.pm";
+
     eval {
-       my $slashSeperatedTname = $tname;
-       $slashSeperatedTname =~ s/::/\//g;
-       require "ZOOM/IRSpy/Test/$slashSeperatedTname.pm";
+       require $fullName;
+       $this->log("irspy", "successfully required '$fullName'");
     }; if ($@) {
+       $this->log("irspy", "couldn't require '$fullName': $@");
        $this->log("warn", "can't load test '$tname': skipping",
                   $@ =~ /^Can.t locate/ ? () : " ($@)");
        return undef;
@@ -439,12 +540,11 @@ sub _gather_tests {
 }
 
 
+# These next three should arguably be Node methods
 sub _next_test {
     my $this = shift();
     my($address, $omit_child) = @_;
 
-    $this->log("irspy", "checking for next test after '$address'");
-
     # Try first child
     if (!$omit_child) {
        my $maybe = $address eq "" ? "0" : "$address:0";
@@ -465,6 +565,38 @@ sub _next_test {
 }
 
 
+sub _last_sibling_test {
+    my $this = shift();
+    my($address) = @_;
+
+    return undef
+       if !defined $this->_next_sibling_test($address);
+
+    my $nskipped = 0;
+    while (1) {
+       my $maybe = $this->_next_sibling_test($address);
+       last if !defined $maybe;
+       $nskipped++;
+       $address = $maybe;
+       $this->log("irspy", "skipping $nskipped tests to '$address'");
+    }
+
+    return ($address, $nskipped);
+}
+
+
+sub _next_sibling_test {
+    my $this = shift();
+    my($address) = @_;
+
+    my @components = split /:/, $address;
+    my $last = pop @components;
+    my $maybe = join(":", @components, $last+1);
+    return $maybe if $this->{tree}->select($maybe);
+    return undef;
+}
+
+
 =head1 SEE ALSO
 
 ZOOM::IRSpy::Record,