print debugging informations
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy.pm
index 0ce0317..16625d0 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: IRSpy.pm,v 1.80 2007-03-30 09:50:55 mike Exp $
+# $Id: IRSpy.pm,v 1.90 2008-07-16 11:42:13 mike Exp $
 
 package ZOOM::IRSpy;
 
@@ -16,11 +16,15 @@ use Net::Z3950::ZOOM 1.13;  # For the ZOOM version-check only
 use ZOOM::IRSpy::Node;
 use ZOOM::IRSpy::Connection;
 use ZOOM::IRSpy::Stats;
-use ZOOM::IRSpy::Utils qw(cql_target render_record irspy_xpath_context);
+use ZOOM::IRSpy::Utils qw(cql_target render_record
+                         irspy_xpath_context irspy_make_identifier
+                         irspy_record2identifier);
 
 our @ISA = qw();
-our $VERSION = '0.02';
+our $VERSION = '1.02';
 our $irspy_to_zeerex_xsl = dirname(__FILE__) . '/../../xsl/irspy2zeerex.xsl';
+our $debug = 0;
+our $xslt_max_depth = 250;
 
 
 # Enumeration for callback functions to return
@@ -42,8 +46,8 @@ ZOOM::IRSpy - Perl extension for discovering and analysing IR services
  use ZOOM::IRSpy;
  $spy = new ZOOM::IRSpy("target/string/for/irspy/database");
  $spy->targets(@targets);
- $spy->initialise();
- $res = $spy->check("Main");
+ $spy->initialise("Main");
+ $res = $spy->check();
 
 =head1 DESCRIPTION
 
@@ -66,6 +70,7 @@ sub new {
     my $class = shift();
     my($dbname, $user, $password, $activeSetSize) = @_;
 
+
     my @options;
     push @options, (user => $user, password => $password)
        if defined $user;
@@ -75,16 +80,23 @@ sub new {
 
     my $xslt = new XML::LibXSLT;
 
+    # raise the maximum number of nested template calls and variables/params (default 250)
+    warn "raise the maximum number of nested template calls: $xslt_max_depth\n" if $debug;
+    $xslt->max_depth($xslt_max_depth);
+
     $xslt->register_function($ZOOM::IRSpy::Utils::IRSPY_NS, 'strcmp',
                              \&ZOOM::IRSpy::Utils::xslt_strcmp);
 
     my $libxml = new XML::LibXML;
+    warn "use irspy_to_zeerex_xsl xslt sheet: $irspy_to_zeerex_xsl\n" if $debug;
     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,
        query => "cql.allRecords=1", # unless overridden
+       modn => undef,          # Filled in by restrict_modulo()
+       modi => undef,          # Filled in by restrict_modulo()
        targets => undef,       # Filled in later if targets() is
                                # called; used only to keep state from
                                # targets() until initialise() is
@@ -93,6 +105,8 @@ sub new {
        queue => undef,         # Filled in by initialise()
         libxml => $libxml,
         irspy_to_zeerex_style => $irspy_to_zeerex_style,
+       test => undef,          # Filled in by initialise()
+       timeout => undef,       # Filled in by initialise()
        tests => undef,         # Tree of tests to be executed
        activeSetSize => defined $activeSetSize ? $activeSetSize : 10,
     }, $class;
@@ -129,12 +143,13 @@ sub targets {
               join(", ", map { "'$_'" } @targets));
     my @qlist;
     foreach my $target (@targets) {
-       my($host, $port, $db, $newtarget) = _parse_target_string($target);
+       my($protocol, $host, $port, $db, $newtarget) =
+           _parse_target_string($target);
        if ($newtarget ne $target) {
            $this->log("irspy_debug", "rewriting '$target' to '$newtarget'");
            $target = $newtarget; # This is written through the ref
        }
-       push @qlist, cql_target($host, $port, $db);
+       push @qlist, cql_target($protocol, $host, $port, $db);
     }
 
     $this->{targets} = \@targets;
@@ -146,16 +161,25 @@ sub targets {
 sub _parse_target_string {
     my($target) = @_;
 
-    my($host, $port, $db) = ($target =~ /(.*?):(.*?)\/(.*)/);
+    my($protocol, $host, $port, $db) = ($target =~ /(.*?):(.*?):(.*?)\/(.*)/);
     if (!defined $host) {
        $port = 210;
-       ($host, $db) = ($target =~ /(.*?)\/(.*)/);
-       $target = "$host:$port/$db";
+       ($protocol, $host, $db) = ($target =~ /(.*?):(.*?)\/(.*)/);
+       $target = irspy_make_identifier($protocol, $host, $port, $db);
     }
     die "$0: invalid target string '$target'"
        if !defined $host;
 
-    return ($host, $port, $db, $target);
+    return ($protocol, $host, $port, $db, $target);
+}
+
+
+sub restrict_modulo {
+    my $this = shift();
+    my($n, $i) = @_;
+
+    $this->{modn} = $n;
+    $this->{modi} = $i;
 }
 
 
@@ -166,6 +190,16 @@ sub _parse_target_string {
 #
 sub initialise {
     my $this = shift();
+    my($tname) = @_;
+
+    $tname = "Main" if !defined $tname;
+    $this->{test} = $tname;
+    $this->{tree} = $this->_gather_tests($tname)
+       or die "No tests defined for '$tname'";
+    $this->{tree}->resolve();
+    #$this->{tree}->print(0);
+
+    $this->{timeout} = "ZOOM::IRSpy::Test::$tname"->timeout();
 
     my @targets;
     my $targets = $this->{targets};
@@ -186,15 +220,51 @@ sub initialise {
     my $n = $this->{activeSetSize};
     $n = @targets if $n == 0 || $n > @targets;
 
-    my @connections;
-    foreach my $i (1..$n) {
-       push @connections, create ZOOM::IRSpy::Connection($this,
-                                                         shift @targets,
-                                                         async => 1);
+    $this->{queue} = \@targets;
+    $this->{connections} = [];
+    while (@{ $this->{connections} } < $n) {
+       my $conn = $this->_next_connection();
+       last if !defined $conn;
+       push @{ $this->{connections} }, $conn;
     }
+}
 
-    $this->{connections} = \@connections;
-    $this->{queue} = \@targets;
+
+sub _next_connection {
+    my $this = shift();
+
+    my $target;
+    my $n = $this->{modn};
+    my $i = $this->{modi};
+    if (!defined $n) {
+       $target = shift @{ $this->{queue} };
+       return undef if !defined $target;
+    } else {
+       while (1) {
+           $target = shift @{ $this->{queue} };
+           return undef if !defined $target;
+           my $h = _hash($target);
+           my $hmodn = $h % $n;
+           last if $hmodn == $i;
+           #$this->log("irspy", "'$target' hash $h % $n = $hmodn != $i");
+       }
+    }
+
+    die "oops -- target is undefined" if !defined $target;
+    return create ZOOM::IRSpy::Connection($this, $target, async => 1,
+                                         timeout => $this->{timeout});
+}
+
+
+sub _hash {
+    my($target) = @_;
+
+    my $n = 0;
+    foreach my $s (split //, $target) {
+       $n += ord($s);
+    }
+
+    return $n;
 }
 
 
@@ -254,18 +324,10 @@ sub _really_rewrite_record {
     # This is the expression in the ID-making stylesheet
     # ../../zebra/zeerex2id.xsl
     my $xc = irspy_xpath_context($rec);
-    my $id = $xc->find("concat(e:serverInfo/e:host, ':',
-                               e:serverInfo/e:port, '/',
-                               e:serverInfo/e:database)");
+    my $id = irspy_record2identifier($xc);
     if (defined $oldid && $id ne $oldid) {
-       # Delete old record;
        warn "IDs differ (old='$oldid' new='$id')";
-       my $p = $conn->package();
-       $p->option(action => "recordDelete");
-       $p->option(recordIdOpaque => $oldid);
-       $p->option(record => "<dummy/>"); # Work around Zebra bug
-       $p->send("update");
-       $p->destroy();
+       _delete_record($conn, $oldid);
     }
 
     $p = $conn->package();
@@ -280,6 +342,41 @@ sub _really_rewrite_record {
 }
 
 
+sub _delete_record {
+    my($conn, $id) = @_;
+
+    # We can't delete records using recordIdOpaque, since character
+    # sets are handled differently here in extended services from how
+    # they are used in the Alvis filter's record-parsing, and so
+    # non-ASCII characters come out differently in the two contexts.
+    # Instead, we must send a record whose contents indicate the ID of
+    # that which we wish to delete.  There are two ways, both
+    # unsatisfactory: we could either fetch the actual record them
+    # resubmit it in the deletion request (which wastes a search and a
+    # fetch) or we could build a record by hand from the parsed-out
+    # components (which is error-prone and which I am not 100% certain
+    # will work since the other contents of the record will be
+    # different).  The former evil seems to be the lesser.
+
+    warn "$conn deleting record '$id'";
+
+    my $rs = $conn->search(new ZOOM::Query::CQL(cql_target($id)));
+    die "no such ID '$id'" if $rs->size() == 0;
+    my $rec = $rs->record(0);
+    my $xml = $rec->render();
+
+    my $p = $conn->package();
+    $p->option(action => "recordDelete");
+    $p->option(record => $xml);
+    $p->send("update");
+    $p->destroy();
+
+    $p = $conn->package();
+    $p->send("commit");
+    $p->destroy();
+}
+
+
 # The approach: gather declarative information about test hierarchy,
 # then go into a loop.  In the loop, we ensure that each connection is
 # running a test, and within that test a task, until its list of tests
@@ -310,15 +407,12 @@ sub _really_rewrite_record {
 #
 sub check {
     my $this = shift();
-    my($tname) = @_;
 
-    $tname = "Main" if !defined $tname;
-    $this->{tree} = $this->_gather_tests($tname)
-       or die "No tests defined for '$tname'";
-    $this->{tree}->resolve();
-    #$this->{tree}->print(0);
-    my $nskipped = 0;
+    my $topname = $this->{tree}->name();
+    my $timeout = $this->{timeout};
+    $this->log("irspy", "beginnning with test '$topname' (timeout $timeout)");
 
+    my $nskipped = 0;
     my @conn = @{ $this->{connections} };
 
     my $nruns = 0;
@@ -347,14 +441,13 @@ sub check {
                        $conn->log("irspy", "has no more tests: removing");
                        $this->_rewrite_record($conn);
                        $conn->option(rewrote_record => 1);
-                       if (@{ $this->{queue} } == 0) {
-                           # Do not destroy: we need this for later sanity checks
+                       my $newconn = $this->_next_connection();
+                       if (!defined $newconn) {
+                           # Do not destroy: needed for later sanity checks
                            splice @conn, $i0, 1;
                        } else {
                            $conn->destroy();
-                           $conn[$i0] = create
-                               ZOOM::IRSpy::Connection($this,
-                                       shift @{ $this->{queue} }, async => 1);
+                           $conn[$i0] = $newconn;
                            $conn[$i0]->option(current_test_address => "");
                            $conn[$i0]->log("irspy", "entering active pool - ",
                                            scalar(@{ $this->{queue} }),
@@ -586,7 +679,6 @@ sub _gather_tests {
 
     eval {
        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",