Merge branch 'master' of ssh://git.indexdata.com:222/home/git/pub/irspy
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy.pm
index 7c99f09..0dc97c2 100644 (file)
@@ -1,5 +1,3 @@
-# $Id: IRSpy.pm,v 1.70 2007-02-26 22:20:08 mike Exp $
-
 package ZOOM::IRSpy;
 
 use 5.008;
@@ -15,13 +13,18 @@ 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::Stats;
-use ZOOM::IRSpy::Utils qw(cql_target);
+use ZOOM::IRSpy::Utils qw(cql_target render_record
+                         irspy_xpath_context irspy_make_identifier
+                         irspy_record2identifier calc_reliability_stats
+                         modify_xml_document);
 
 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;
+our $max_timeout_errors = 3;
 
 
 # Enumeration for callback functions to return
@@ -43,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
 
@@ -61,43 +64,89 @@ BEGIN {
     ZOOM::Log::mask_str("irspy_unhandled");
     ZOOM::Log::mask_str("irspy_test");
     ZOOM::Log::mask_str("irspy_task");
+    ZOOM::Log::mask_str("irspy_data");
 }
 
 sub new {
     my $class = shift();
-    my($dbname, $user, $password) = @_;
+    my($dbname, $user, $password, $activeSetSize) = @_;
+
 
     my @options;
     push @options, (user => $user, password => $password)
        if defined $user;
 
     my $conn = new ZOOM::Connection($dbname, 0, @options)
-       or die "$0: can't connection to IRSpy database 'dbname'";
+       or die "$0: can't connect to IRSpy database 'dbname'";
 
     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,
-       allrecords => 1,        # unless overridden by targets()
-       query => undef,         # filled in later
-       targets => undef,       # filled in later
-       connections => undef,   # filled in later
+       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
+                               # called.
+       connections => undef,   # Filled in by initialise()
+       queue => undef,         # Filled in by initialise()
         libxml => $libxml,
         irspy_to_zeerex_style => $irspy_to_zeerex_style,
-       tests => [],            # stack of tests currently being executed
+       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,
+       rules => [],            # Can be filled by apply_rules()
+       vars => {},             # Will contain name, id, version, etc.
+                               # May be written into by tests (mostly
+                               # Ping, which gets the Init response)
+                               # and read by tests for rules.
     }, $class;
     $this->log("irspy", "starting up with database '$dbname'");
 
     return $this;
 }
 
+# Read from and write to the set of vars
+sub var {
+    my $this = shift();
+    my($key, $newval) = @_;
+
+    if (defined $newval) {
+       $this->{vars}->{$key} = $newval;
+       #warn "$this: set '$key'='$newval'";
+    } else {
+       my $oldval = $this->{vars}->{$key};
+       $oldval = "" if !defined $oldval;
+       #warn "$this: got '$key'='$oldval'";
+       return $oldval;
+    }
+}
+
+# wrapper to read the IRSpy database name from environment variable / apache config
+sub connect_to_registry {
+    my %args = @_;
+
+    # XXX: we could also handle here: user, password, elementSetName
+
+    my $database = $ENV{IRSpyDbName} || "localhost:8018/IR-Explain---1";
+
+    return $database;
+}
 
 sub log {
     my $this = shift();
@@ -105,6 +154,14 @@ sub log {
 }
 
 
+sub find_targets {
+    my $this = shift();
+    my($query) = @_;
+
+    $this->{query} = $query;
+}
+
+
 # Explicitly nominate a set of targets to check, overriding the
 # default which is to re-check everything in the database.  Each
 # target already in the database results in the existing record being
@@ -116,15 +173,15 @@ sub targets {
 
     $this->log("irspy", "setting explicit list of targets ",
               join(", ", map { "'$_'" } @targets));
-    $this->{allrecords} = 0;
     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;
@@ -132,138 +189,148 @@ sub targets {
 }
 
 
-sub find_targets {
-    my $this = shift();
-    my($query) = @_;
-
-    $this->{allrecords} = 0;    
-    $this->{query} = $query;
-}
-
-
 # Also used by ZOOM::IRSpy::Record
 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);
 }
 
 
-# There are two cases.
-#
-# 1. A specific set of targets is nominated on the command line.
-#      - Records must be fetched for those targets that are in the DB
-#      - New, empty records must be made for those that are not.
-#      - Updated records written to the DB may or may not be new.
-#
-# 2. All records in the database are to be checked.
-#      - Records must be fetched for all targets in the DB
-#      - Updated records written to the DB may not be new.
-#
-# That's all -- what could be simpler?
+sub restrict_modulo {
+    my $this = shift();
+    my($n, $i) = @_;
+
+    $this->{modn} = $n;
+    $this->{modi} = $i;
+}
+
+
+sub apply_rules {
+    my $this = shift();
+    my($fileName) = @_;
+
+    my $f = new IO::File("<$fileName")
+       or die "$0: can't open rules file '$fileName': $!";
+
+    while (my $line = <$f>) {
+       chomp $line;
+       $line =~ s/#.*//;
+       $line =~ s/\s+$//;
+       next if !$line;
+       my(@fields) = split /\s+/, $line;
+       my($name, $op, $val, $rule, @params) = @fields;
+       #warn "parsed name='$name', op='$op', val='$val', rule='$rule', params='@params'\n";
+       push @{ $this->{rules} }, [ @fields ];
+    }
+    $f->close();
+}
+
+# Records must be fetched for all records satisfying $this->{query} If
+# $this->{targets} is already set (i.e. a specific list of targets to
+# check was specified by a call to targets()), then new, empty records
+# will be made for any targets that are not already in the database.
 #
 sub initialise {
     my $this = shift();
+    my($tname) = @_;
 
-    my %target2record;
-    if ($this->{allrecords}) {
-       # We need to check on every target in the database, which
-       # means we need to do a "find all".  According to the BIB-1
-       # semantics document at
-       #       http://www.loc.gov/z3950/agency/bib1.html
-       # the query
-       #       @attr 2=103 @attr 1=1035 x
-       # should find all records, but it seems that Zebra doesn't
-       # support this.  Furthermore, when using the "alvis" filter
-       # (as we do for IRSpy) it doesn't support the use of any BIB-1
-       # access point -- not even 1035 "everywhere" -- so instead we
-       # hack together a search that we know will find all records.
-       $this->{query} = "port=?*";
-    } elsif ($this->{targets}) {
-       # Prepopulate the target map with nulls so that after we fill
-       # in what we can from the database query, we know which target
-       # IDs we need new records for.
-       foreach my $target (@{ $this->{targets} }) {
-           $target2record{lc($target)} = undef;
+    $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};
+    if (defined $targets) {
+       @targets = @$targets;
+       delete $this->{targets};
+    } else {
+       my $rs = $this->{conn}->search(new ZOOM::Query::CQL($this->{query}));
+       $this->log("irspy", "'", $this->{query}, "' found ",
+                  $rs->size(), " target records");
+       delete $this->{query};
+
+       foreach my $i (1 .. $rs->size()) {
+           push @targets, render_record($rs, $i-1, "id");
        }
     }
 
-    $this->log("irspy_debug", "query '", $this->{query}, "'");
-    my $rs = $this->{conn}->search(new ZOOM::Query::CQL($this->{query}));
-    $this->log("irspy", "'", $this->{query}, "' found ",
-              $rs->size(), " target records");
-    delete $this->{query};     # No longer needed at all
-    my $gatherTargets = !$this->{targets};
-    foreach my $i (1 .. $rs->size()) {
-       my $target = _render_record($rs, $i-1, "id");
-       my $zeerex = _render_record($rs, $i-1, "zeerex");
-       #print STDERR "making '$target' record with '$zeerex'\n";
-       $target2record{lc($target)} =
-           new ZOOM::IRSpy::Record($this, $target, $zeerex);
-       push @{ $this->{targets} }, $target
-           if $gatherTargets;
-    }
+    my $n = $this->{activeSetSize};
+    $n = @targets if $n == 0 || $n > @targets;
 
-    # Make records for targets not previously in the database
-    foreach my $target (keys %target2record) {
-       my $record = $target2record{$target};
-       if (!defined $record) {
-           $this->log("irspy_debug", "made new record for '$target'");
-           $target2record{$target} = new ZOOM::IRSpy::Record($this, $target);
-       } else {
-           $this->log("irspy_debug", "using existing record for '$target'");
-       }
+    $this->{queue} = \@targets;
+    $this->{connections} = [];
+    while (@{ $this->{connections} } < $n) {
+       my $conn = $this->_next_connection();
+       last if !defined $conn;
+       push @{ $this->{connections} }, $conn;
     }
+}
+
+
+sub _next_connection {
+    my $this = shift();
 
-    my @connections;
-    foreach my $target (@{ $this->{targets} }) {
-       my $conn = create ZOOM::IRSpy::Connection($this, async => 1);
-       $conn->option(host => $target);
-       my $record = delete $target2record{lc($target)};
-       $conn->record($record);
-       push @connections, $conn;
+    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("remaining target2record = { " .
-       join(", ", map { "$_ ->'" . $target2record{$_}. "'" }
-            sort keys %target2record) . " }")
-       if %target2record;
 
-    $this->{connections} = \@connections;
-    delete $this->{targets};   # The information is now in {connections}
+    die "oops -- target is undefined" if !defined $target;
+    return create ZOOM::IRSpy::Connection($this, $target, async => 1,
+                                         timeout => $this->{timeout});
 }
 
 
-sub _render_record {
-    my($rs, $which, $elementSetName) = @_;
+sub _hash {
+    my($target) = @_;
 
-    # There is a slight race condition here on the element-set name,
-    # but it shouldn't be a problem as this is (currently) only called
-    # from parts of the program that run single-threaded.
-    my $old = $rs->option(elementSetName => $elementSetName);
-    my $rec = $rs->record($which);
-    $rs->option(elementSetName => $old);
+    my $n = 0;
+    foreach my $s (split //, $target) {
+       $n += ord($s);
+    }
 
-    return $rec->render();
+    return $n;
 }
 
 
 sub _irspy_to_zeerex {
     my $this = shift();
-    my($conn, $save_xml) = @_;
+    my($conn) = @_;
+
+    my $save_xml = $ENV{IRSPY_SAVE_XML};
     my $irspy_doc = $conn->record()->{zeerex}->ownerDocument;
 
     if ($save_xml) {
        unlink('/tmp/irspy_orig.xml');
-       open FH, '>/tmp/irspy_orig.xml';
+       open FH, '>/tmp/irspy_orig.xml'
+           or die "can't write irspy_orig.xml: $!";
        print FH $irspy_doc->toString();
        close FH;
     }
@@ -271,7 +338,8 @@ sub _irspy_to_zeerex {
     my $result = $this->{irspy_to_zeerex_style}->transform($irspy_doc, %params);
     if ($save_xml) {
        unlink('/tmp/irspy_transformed.xml');
-       open FH, '>/tmp/irspy_transformed.xml';
+       open FH, '>/tmp/irspy_transformed.xml'
+           or die "can't write irspy_transformed.xml: $!";
        print FH $result->toString();
        close FH;
     }
@@ -280,18 +348,46 @@ sub _irspy_to_zeerex {
 }
 
 
-sub _rewrite_record {
+sub _rewrite_irspy_record {
     my $this = shift();
     my($conn) = @_;
 
     $conn->log("irspy", "rewriting XML record");
-    my $rec = $this->_irspy_to_zeerex($conn, $ENV{IRSPY_SAVE_XML});
-    _really_rewrite_record($this->{conn}, $rec);
+    my $rec = $this->_irspy_to_zeerex($conn);
+
+    # Since IRSpy can run for a long time between writes back to the
+    # database, it's quite possible for the server to have closed the
+    # connection as idle.  So re-establish it if necessary.
+    $this->{conn}->connect($conn->option("host"));
+
+    _rewrite_zeerex_record($this->{conn}, $rec);
+    $conn->log("irspy", "rewrote XML record");
 }
 
 
-sub _really_rewrite_record {
-    my($conn, $rec) = @_;
+my $_specialFields = {
+    reliability => [ reliability => 0,
+                    "Calculated reliability of server",
+                    "e:serverInfo/e:reliability" ],
+    udb => [ udb => 0,
+            "Access Name (Unique DB)",
+            "e:databaseInfo/i:udb" ],
+};
+
+sub _rewrite_zeerex_record {
+    my($conn, $rec, $oldid) = @_;
+
+    # Add reliability score
+    my $xc = irspy_xpath_context($rec);
+    my($nok, $nall, $percent) = calc_reliability_stats($xc);
+    modify_xml_document($xc, $_specialFields, { reliability => $percent });
+
+    my $xpath = $_specialFields->{udb}->[3];
+    my $value = $xc->findvalue($xpath);
+    if (!defined $oldid && (!defined $value || $value eq '')) {
+       # New record with no explicit UDB: generate a UDB for it.
+       modify_xml_document($xc, $_specialFields, { udb => _next_udb() });
+    }
 
     my $p = $conn->package();
     $p->option(action => "specialUpdate");
@@ -300,6 +396,14 @@ sub _really_rewrite_record {
     $p->send("update");
     $p->destroy();
 
+    # This is the expression in the ID-making stylesheet
+    # ../../zebra/zeerex2id.xsl
+    my $id = irspy_record2identifier($xc);
+    if (defined $oldid && $id ne $oldid) {
+       warn "IDs differ (old='$oldid' new='$id')";
+       _delete_record($conn, $oldid);
+    }
+
     $p = $conn->package();
     $p->send("commit");
     $p->destroy();
@@ -312,6 +416,54 @@ sub _really_rewrite_record {
 }
 
 
+sub _next_udb {
+    use IndexData::Utils::PersistentCounter;
+
+    my $file = $ENV{IRSPY_COUNTER_FILE}
+       or die "no IRSPY_COUNTER_FILE in environment";
+    my $counter = new IndexData::Utils::PersistentCounter($file)
+       or die "can't open counter file '$file': $!";
+    my $val = $counter->next()
+       or die "can't get counter value from '$file': $!";
+    return "irspy-$val";
+}
+
+
+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
@@ -342,14 +494,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}->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;
@@ -357,9 +507,12 @@ 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 $nconn/", scalar(@conn), " is $conn\n";
+           next if !defined $conn;
+
            if (!$conn->current_task()) {
                if (!$conn->next_task()) {
                    # Out of tasks: we need a new test
@@ -369,16 +522,32 @@ sub check {
                    if (!defined $address) {
                        $nextaddr = "";
                    } else {
-                       $this->log("irspy_test",
+                       $conn->log("irspy_test",
                                   "checking for next test after '$address'");
                        $nextaddr = $this->_next_test($address);
                    }
+
+                    if (ZOOM::IRSpy::Test::zoom_error_timeout_check($conn)) {
+                       $conn->log("irspy", "Got to many timeouts, stop testing");
+                       undef $nextaddr;
+                    }
+
                    if (!defined $nextaddr) {
                        $conn->log("irspy", "has no more tests: removing");
-                       ### Does this go wrong if two connections are exhausted?
-                       splice @conn, $i0, 1;
-                       $this->_rewrite_record($conn);
+                       $this->_rewrite_irspy_record($conn);
                        $conn->option(rewrote_record => 1);
+                       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] = $newconn;
+                           $conn[$i0]->option(current_test_address => "");
+                           $conn[$i0]->log("irspy", "entering active pool - ",
+                                           scalar(@{ $this->{queue} }),
+                                           " targets remain in queue");
+                       }
                        next;
                    }
 
@@ -386,6 +555,13 @@ sub check {
                        or die "invalid nextaddr '$nextaddr'";
                    $conn->option(current_test_address => $nextaddr);
                    my $tname = $node->name();
+                   if ($this->should_skip_test($tname)) {
+                       $conn->log("irspy_test",
+                           "skipping test '$nextaddr' = $tname due to rule");
+                       $nskipped += 1;
+                       goto NEXT_TEST;
+                   }
+
                    $conn->log("irspy_test",
                               "starting test '$nextaddr' = $tname");
                    my $tasks = $conn->tasks();
@@ -404,6 +580,13 @@ sub check {
 
                my $task = $conn->next_task();
                die "no next task queued for $conn" if !defined $task;
+
+               # do not run the next task if we got too many timeouts
+                if (ZOOM::IRSpy::Test::zoom_error_timeout_check($conn)) {
+                    $conn->log("irspy_task", "Got too many timeouts for this target, do not start a new task");
+                    next;
+                }
+
                $conn->log("irspy_task", "preparing task $task");
                $conn->next_task(0);
                $conn->current_task($task);
@@ -475,12 +658,22 @@ sub check {
            $conn->next_task(0);
            if ($res == ZOOM::IRSpy::Status::TEST_BAD) {
                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;
+               $conn->log("irspy", "top-level test failed!")
+                   if $address eq "";
+               my $node = $this->{tree}->select($address);
+               my $skipcount = 0;
+               while (defined $node->next() &&
+                      length($node->next()->address()) >= length($address)) {
+                   $conn->log("irspy_test", "skipping from '",
+                              $node->address(), "' to '",
+                              $node->next()->address(), "' (", $node->next()->name(), ")");
+                   $node = $node->next();
+                   $skipcount++;
                }
+
+               $conn->option(current_test_address => $node->address());
+               $conn->log("irspy_test", "skipped $skipcount tests");
+               $nskipped += $skipcount;
            }
 
        } elsif ($res == ZOOM::IRSpy::Status::TEST_SKIPPED) {
@@ -495,9 +688,10 @@ sub check {
     }
 
     $this->log("irspy", "exiting main loop");
+
     # Sanity checks: none of the following should ever happen
     my $finished = 1;
-    @conn = @{ $this->{connections} };
+    $this->log("irspy", "performing end-of-run sanity-checks");
     foreach my $conn (@conn) {
        my $test = $conn->option("current_test_address");
        my $next = $this->_next_test($test);
@@ -557,6 +751,53 @@ sub check {
 }
 
 
+### This could of course call a much more general looping evaluator
+sub should_skip_test {
+    my $this = shift();
+    my($tname) = @_;
+
+    foreach my $rule (@{ $this->{rules} }) {
+       my($name, $op, $val, $rule, @params) = @$rule;
+       #warn "using name='$name', op='$op', val='$val', rule='$rule', params='@params'\n";
+       if ($op eq "~" &&
+           $rule eq "skip" &&
+           $params[0] eq $tname) {
+           my $re = $val;
+           $re =~ s/^\/(.*)\/$/$1/;
+           if ($this->var($name) =~ $re) {
+               #warn "$name '", $this->var($name), "' matches /$re/ -- skipping '$tname'";
+               return 1;
+           }
+       }
+    }
+
+    return 0;
+}
+
+
+# Exactly equivalent to ZOOM::event() except that it is tolerant to
+# undefined values in the array being passed in.
+#
+sub __UNUSED_tolerant_ZOOM_event {
+    my($connref) = @_;
+
+    my(@conn, @map);
+    foreach my $i (0 .. @$connref-1) {
+       my $conn = $connref->[$i];
+       if (defined $conn) {
+           push @conn, $conn;
+           push @map, $i;
+       }
+    }
+
+    my $res = ZOOM::event(\@conn);
+    return $res if $res <= 0;
+    my $res2 = $map[$res-1] + 1;
+    print STDERR "*** tolerant_ZOOM_event() returns $res->$res2\n";
+    return $res2;
+}
+
+
 sub _gather_tests {
     my $this = shift();
     my($tname, @ancestors) = @_;
@@ -571,7 +812,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",
@@ -605,7 +845,10 @@ sub _next_test {
     return undef if $address eq "";
 
     # Try next sibling child
-    my @components = split /:/, $address;
+    # The use of a regexp in split() is to avoid confusing Emacs's
+    # Perl mode; the third colon is to avoid looking like a POSIX
+    # named character class ... *sigh*
+    my @components = split /[:::]/, $address;
     my $last = pop @components;
     my $maybe = join(":", @components, $last+1);
     return $maybe if $this->{tree}->select($maybe);
@@ -616,6 +859,7 @@ sub _next_test {
 
 
 sub _last_sibling_test {
+    die "_last_sibling_test() called -- I thought that never happened?";
     my $this = shift();
     my($address) = @_;
 
@@ -636,10 +880,11 @@ sub _last_sibling_test {
 
 
 sub _next_sibling_test {
+    die "_next_sibling_test() called -- I thought that never happened?";
     my $this = shift();
     my($address) = @_;
 
-    my @components = split /:/, $address;
+    my @components = split /[:::]/, $address;
     my $last = pop @components;
     my $maybe = join(":", @components, $last+1);
     return $maybe if $this->{tree}->select($maybe);