Add two exportable utility functions:

[irspy-moved-to-github.git] / lib / ZOOM / IRSpy.pm

diff --git a/lib/ZOOM/IRSpy.pm b/lib/ZOOM/IRSpy.pm
index aad702c..e3c4be4 100644 (file)
--- a/lib/ZOOM/IRSpy.pm
+++ b/lib/ZOOM/IRSpy.pm
@@ -1,4 +1,4 @@
-# $Id: IRSpy.pm,v 1.31 2006-10-13 15:17:25 mike Exp $
+# $Id: IRSpy.pm,v 1.35 2006-10-20 14:49:11 mike Exp $
 
 package ZOOM::IRSpy;
 
@@ -6,7 +6,11 @@ use 5.008;
 use strict;
 use warnings;
 
-use Data::Dumper; # For debugging only
+use Exporter 'import';
+our @EXPORT_OK = qw(xml_encode irspy_xpath_context);
+
+use Data::Dumper;              # For debugging only
+use XML::LibXML::XPathContext;
 use ZOOM;
 use Net::Z3950::ZOOM 1.13;     # For the ZOOM version-check only
 use ZOOM::IRSpy::Node;
@@ -338,7 +342,7 @@ sub check {
 
                my $task = $conn->next_task();
                die "no next task queued for $conn" if !defined $task;
-               $conn->log("irspy_task", "starting task $task");
+               $conn->log("irspy_task", "preparing task $task");
                $conn->next_task(0);
                $conn->current_task($task);
                $task->run();
@@ -404,13 +408,18 @@ sub check {
        } 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_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;
+               }
            }
        }
     }
@@ -449,6 +458,7 @@ sub _gather_tests {
 }
 
 
+# These next three should arguably be Node methods
 sub _next_test {
     my $this = shift();
     my($address, $omit_child) = @_;
@@ -473,6 +483,69 @@ 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++;
+       $this->log("irspy", "skipping $nskipped tests to '$address'");
+       $address = $maybe;
+    }
+
+    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;
+}
+
+
+# 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,