Only select those irspy:xxx entries newer than the status/ping date. Still need
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy.pm
index 06b223a..098946a 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: IRSpy.pm,v 1.36 2006-10-25 15:42:47 mike Exp $
+# $Id: IRSpy.pm,v 1.53 2006-12-11 13:58:17 sondberg Exp $
 
 package ZOOM::IRSpy;
 
@@ -6,20 +6,21 @@ use 5.008;
 use strict;
 use warnings;
 
-use Exporter 'import';
-our @EXPORT_OK = qw(xml_encode irspy_xpath_context);
-
 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_ns = 'http://indexdata.com/irspy/1.0';
+our $irspy_to_zeerex_xsl = dirname(__FILE__) . '/../../xsl/irspy2zeerex.xsl';
 
 
 # Enumeration for callback functions to return
@@ -28,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;
 
 
@@ -69,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'");
@@ -108,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;
@@ -229,20 +242,44 @@ sub _render_record {
 }
 
 
+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) = @_;
 
     $conn->log("irspy", "rewriting XML record");
-    my $rec = $conn->record();
-    my $p = $this->{conn}->package();
+    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->{zeerex}->toString();
+    my $xml = $rec->toString();
     $p->option(record => $xml);
     $p->send("update");
     $p->destroy();
 
-    $p = $this->{conn}->package();
+    $p = $conn->package();
     $p->send("commit");
     $p->destroy();
     if (0) {
@@ -288,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;
 
@@ -317,6 +354,7 @@ sub check {
                        $conn->log("irspy", "has no more tests: removing");
                        splice @conn, $i0, 1;
                        $this->_rewrite_record($conn);
+                       $conn->option(rewrote_record => 1);
                        next;
                    }
 
@@ -421,12 +459,50 @@ sub check {
                    $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", "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;
+    }
+
     return $nskipped;
 }
 
@@ -439,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;
@@ -497,8 +577,8 @@ sub _last_sibling_test {
        my $maybe = $this->_next_sibling_test($address);
        last if !defined $maybe;
        $nskipped++;
-       $this->log("irspy", "skipping $nskipped tests to '$address'");
        $address = $maybe;
+       $this->log("irspy", "skipping $nskipped tests to '$address'");
     }
 
     return ($address, $nskipped);
@@ -517,37 +597,6 @@ sub _next_sibling_test {
 }
 
 
-# Utility functions follow, exported for use of web UI
-
-# I can't -- just can't, can't, can't -- believe that this function
-# isn't provided by one of the core XML modules.  But the evidence all
-# says that it's not: among other things, XML::Generator and
-# Template::Plugin both roll their own.  So I will do likewise.  D'oh!
-#
-sub xml_encode {
-    my ($text) = @_;
-    $text =~ s/&/&/g;
-    $text =~ s/</&lt;/g;
-    $text =~ s/>/&gt;/g;
-    $text =~ s/['']/&apos;/g;
-    $text =~ s/[""]/&quot;/g;
-    return $text;
-}
-
-
-sub irspy_xpath_context {
-    my($zoom_record) = @_;
-
-    my $xml = $zoom_record->render();
-    my $parser = new XML::LibXML();
-    my $doc = $parser->parse_string($xml);
-    my $root = $doc->getDocumentElement();
-    my $xc = XML::LibXML::XPathContext->new($root);
-    $xc->registerNs(e => 'http://explain.z3950.org/dtd/2.0/');
-    return $xc;
-}
-
-
 =head1 SEE ALSO
 
 ZOOM::IRSpy::Record,