-# $Id: IRSpy.pm,v 1.32 2006-10-17 15:46:30 mike Exp $
+# $Id: IRSpy.pm,v 1.42 2006-10-27 15:36:04 mike Exp $
package ZOOM::IRSpy;
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 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;
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
my $conn = new ZOOM::Connection($dbname, 0, @options)
or die "$0: can't connection to IRSpy database 'dbname'";
+ my $xslt = new XML::LibXSLT;
+ 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'");
}
+sub _irspy_to_zeerex {
+ my ($this, $conn) = @_;
+ my $irspy_doc = $conn->record()->{zeerex}->ownerDocument;
+ my %params = ();
+ my $result = $this->{irspy_to_zeerex_style}->transform($irspy_doc, %params);
+
+ 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) {
$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;
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();
$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;
+ }
}
+ } else {
+ die "unknown callback return-value '$res'";
}
}
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";
+ ### This next line shouldn't be necessary, as we should
+ # already be running in an environment where the test
+ # modules are available -- otherwise, how did _this_ module
+ # get loaded? But it seems that for reasons I don't
+ # understand we do sometimes (not always!) need this when
+ # running under Apache.
+ use lib '/usr/local/src/cvs/irspy/lib';
+ 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;
}
+# These next three should arguably be Node methods
sub _next_test {
my $this = shift();
my($address, $omit_child) = @_;
}
+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/</</g;
+ $text =~ s/>/>/g;
+ $text =~ s/['']/'/g;
+ $text =~ s/[""]/"/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/');
+ $xc->registerNs(i => $irspy_ns);
+ return $xc;
+}
+
+
=head1 SEE ALSO
ZOOM::IRSpy::Record,
projects / irspy-moved-to-github.git / blobdiff