1 # $Id: IRSpy.pm,v 1.90 2008-07-16 11:42:13 mike Exp $
9 use Data::Dumper; # For debugging only
13 use XML::LibXML::XPathContext;
15 use Net::Z3950::ZOOM 1.13; # For the ZOOM version-check only
16 use ZOOM::IRSpy::Node;
17 use ZOOM::IRSpy::Connection;
18 use ZOOM::IRSpy::Stats;
19 use ZOOM::IRSpy::Utils qw(cql_target render_record
20 irspy_xpath_context irspy_make_identifier
21 irspy_record2identifier);
24 our $VERSION = '1.01';
25 our $irspy_to_zeerex_xsl = dirname(__FILE__) . '/../../xsl/irspy2zeerex.xsl';
28 # Enumeration for callback functions to return
29 package ZOOM::IRSpy::Status;
30 sub OK { 29 } # No problems, task is still progressing
31 sub TASK_DONE { 18 } # Task is complete, next task should begin
32 sub TEST_GOOD { 8 } # Whole test is complete, and succeeded
33 sub TEST_BAD { 31 } # Whole test is complete, and failed
34 sub TEST_SKIPPED { 12 } # Test couldn't be run
40 ZOOM::IRSpy - Perl extension for discovering and analysing IR services
45 $spy = new ZOOM::IRSpy("target/string/for/irspy/database");
46 $spy->targets(@targets);
47 $spy->initialise("Main");
52 This module exists to implement the IRspy program, which discovers,
53 analyses and monitors IR servers implementing the Z39.50 and SRU/W
54 protocols. It is a successor to the ZSpy program.
59 ZOOM::Log::mask_str("irspy");
60 ZOOM::Log::mask_str("irspy_debug");
61 ZOOM::Log::mask_str("irspy_event");
62 ZOOM::Log::mask_str("irspy_unhandled");
63 ZOOM::Log::mask_str("irspy_test");
64 ZOOM::Log::mask_str("irspy_task");
69 my($dbname, $user, $password, $activeSetSize) = @_;
72 push @options, (user => $user, password => $password)
75 my $conn = new ZOOM::Connection($dbname, 0, @options)
76 or die "$0: can't connection to IRSpy database 'dbname'";
78 my $xslt = new XML::LibXSLT;
80 $xslt->register_function($ZOOM::IRSpy::Utils::IRSPY_NS, 'strcmp',
81 \&ZOOM::IRSpy::Utils::xslt_strcmp);
83 my $libxml = new XML::LibXML;
84 my $xsl_doc = $libxml->parse_file($irspy_to_zeerex_xsl);
85 my $irspy_to_zeerex_style = $xslt->parse_stylesheet($xsl_doc);
89 query => "cql.allRecords=1", # unless overridden
90 modn => undef, # Filled in by restrict_modulo()
91 modi => undef, # Filled in by restrict_modulo()
92 targets => undef, # Filled in later if targets() is
93 # called; used only to keep state from
94 # targets() until initialise() is
96 connections => undef, # Filled in by initialise()
97 queue => undef, # Filled in by initialise()
99 irspy_to_zeerex_style => $irspy_to_zeerex_style,
100 test => undef, # Filled in by initialise()
101 timeout => undef, # Filled in by initialise()
102 tests => undef, # Tree of tests to be executed
103 activeSetSize => defined $activeSetSize ? $activeSetSize : 10,
105 $this->log("irspy", "starting up with database '$dbname'");
121 $this->{query} = $query;
125 # Explicitly nominate a set of targets to check, overriding the
126 # default which is to re-check everything in the database. Each
127 # target already in the database results in the existing record being
128 # updated; each new target causes a new record to be added.
134 $this->log("irspy", "setting explicit list of targets ",
135 join(", ", map { "'$_'" } @targets));
137 foreach my $target (@targets) {
138 my($protocol, $host, $port, $db, $newtarget) =
139 _parse_target_string($target);
140 if ($newtarget ne $target) {
141 $this->log("irspy_debug", "rewriting '$target' to '$newtarget'");
142 $target = $newtarget; # This is written through the ref
144 push @qlist, cql_target($protocol, $host, $port, $db);
147 $this->{targets} = \@targets;
148 $this->{query} = join(" or ", @qlist);
152 # Also used by ZOOM::IRSpy::Record
153 sub _parse_target_string {
156 my($protocol, $host, $port, $db) = ($target =~ /(.*?):(.*?):(.*?)\/(.*)/);
157 if (!defined $host) {
159 ($protocol, $host, $db) = ($target =~ /(.*?):(.*?)\/(.*)/);
160 $target = irspy_make_identifier($protocol, $host, $port, $db);
162 die "$0: invalid target string '$target'"
165 return ($protocol, $host, $port, $db, $target);
169 sub restrict_modulo {
178 # Records must be fetched for all records satisfying $this->{query} If
179 # $this->{targets} is already set (i.e. a specific list of targets to
180 # check was specified by a call to targets()), then new, empty records
181 # will be made for any targets that are not already in the database.
187 $tname = "Main" if !defined $tname;
188 $this->{test} = $tname;
189 $this->{tree} = $this->_gather_tests($tname)
190 or die "No tests defined for '$tname'";
191 $this->{tree}->resolve();
192 #$this->{tree}->print(0);
194 $this->{timeout} = "ZOOM::IRSpy::Test::$tname"->timeout();
197 my $targets = $this->{targets};
198 if (defined $targets) {
199 @targets = @$targets;
200 delete $this->{targets};
202 my $rs = $this->{conn}->search(new ZOOM::Query::CQL($this->{query}));
203 $this->log("irspy", "'", $this->{query}, "' found ",
204 $rs->size(), " target records");
205 delete $this->{query};
207 foreach my $i (1 .. $rs->size()) {
208 push @targets, render_record($rs, $i-1, "id");
212 my $n = $this->{activeSetSize};
213 $n = @targets if $n == 0 || $n > @targets;
215 $this->{queue} = \@targets;
216 $this->{connections} = [];
217 while (@{ $this->{connections} } < $n) {
218 my $conn = $this->_next_connection();
219 last if !defined $conn;
220 push @{ $this->{connections} }, $conn;
225 sub _next_connection {
229 my $n = $this->{modn};
230 my $i = $this->{modi};
232 $target = shift @{ $this->{queue} };
233 return undef if !defined $target;
236 $target = shift @{ $this->{queue} };
237 return undef if !defined $target;
238 my $h = _hash($target);
240 last if $hmodn == $i;
241 #$this->log("irspy", "'$target' hash $h % $n = $hmodn != $i");
245 die "oops -- target is undefined" if !defined $target;
246 return create ZOOM::IRSpy::Connection($this, $target, async => 1,
247 timeout => $this->{timeout});
255 foreach my $s (split //, $target) {
263 sub _irspy_to_zeerex {
267 my $save_xml = $ENV{IRSPY_SAVE_XML};
268 my $irspy_doc = $conn->record()->{zeerex}->ownerDocument;
271 unlink('/tmp/irspy_orig.xml');
272 open FH, '>/tmp/irspy_orig.xml'
273 or die "can't write irspy_orig.xml: $!";
274 print FH $irspy_doc->toString();
278 my $result = $this->{irspy_to_zeerex_style}->transform($irspy_doc, %params);
280 unlink('/tmp/irspy_transformed.xml');
281 open FH, '>/tmp/irspy_transformed.xml'
282 or die "can't write irspy_transformed.xml: $!";
283 print FH $result->toString();
287 return $result->documentElement();
291 sub _rewrite_record {
295 $conn->log("irspy", "rewriting XML record");
296 my $rec = $this->_irspy_to_zeerex($conn);
298 # Since IRSpy can run for a long time between writes back to the
299 # database, it's quite possible for the server to have closed the
300 # connection as idle. So re-establish it if necessary.
301 $this->{conn}->connect($conn->option("host"));
303 _really_rewrite_record($this->{conn}, $rec);
304 $conn->log("irspy", "rewrote XML record");
308 sub _really_rewrite_record {
309 my($conn, $rec, $oldid) = @_;
311 my $p = $conn->package();
312 $p->option(action => "specialUpdate");
313 my $xml = $rec->toString();
314 $p->option(record => $xml);
318 # This is the expression in the ID-making stylesheet
319 # ../../zebra/zeerex2id.xsl
320 my $xc = irspy_xpath_context($rec);
321 my $id = irspy_record2identifier($xc);
322 if (defined $oldid && $id ne $oldid) {
323 warn "IDs differ (old='$oldid' new='$id')";
324 _delete_record($conn, $oldid);
327 $p = $conn->package();
334 print "Updated $conn with xml=<br/>\n<pre>$xml</pre>\n";
342 # We can't delete records using recordIdOpaque, since character
343 # sets are handled differently here in extended services from how
344 # they are used in the Alvis filter's record-parsing, and so
345 # non-ASCII characters come out differently in the two contexts.
346 # Instead, we must send a record whose contents indicate the ID of
347 # that which we wish to delete. There are two ways, both
348 # unsatisfactory: we could either fetch the actual record them
349 # resubmit it in the deletion request (which wastes a search and a
350 # fetch) or we could build a record by hand from the parsed-out
351 # components (which is error-prone and which I am not 100% certain
352 # will work since the other contents of the record will be
353 # different). The former evil seems to be the lesser.
355 warn "$conn deleting record '$id'";
357 my $rs = $conn->search(new ZOOM::Query::CQL(cql_target($id)));
358 die "no such ID '$id'" if $rs->size() == 0;
359 my $rec = $rs->record(0);
360 my $xml = $rec->render();
362 my $p = $conn->package();
363 $p->option(action => "recordDelete");
364 $p->option(record => $xml);
368 $p = $conn->package();
374 # The approach: gather declarative information about test hierarchy,
375 # then go into a loop. In the loop, we ensure that each connection is
376 # running a test, and within that test a task, until its list of tests
377 # is exhausted. No individual test ever calls wait(): tests just queue
378 # up tasks and return immediately. When the tasks are run (one at a
379 # time on each connection) they generate events, and it is these that
380 # are harvested by ZOOM::event(). Since each connection knows what
381 # task it is running, it can invoke the appropriate callbacks.
382 # Callbacks return a ZOOM::IRSpy::Status value which tells the main
383 # loop how to continue.
386 # While a connection is running a task, its current_task()
387 # points at the task structure. When it finishes its task,
388 # next_task() is pointed at the next task to execute (if there
389 # is one), and its current_task() is set to zero. When the next
390 # task is executed, the connection's next_task() is set to zero
391 # and its current_task() pointed to the task structure.
392 # current_task() and next_task() are both zero only when there
393 # are no more queued tasks, which is when a new test is
396 # Each connection's current test is stored in its
397 # "current_test_address" option. The next test to execute is
398 # calculated by walking the declarative tree of tests. This
399 # option begins empty; the "next test" after this is of course
405 my $topname = $this->{tree}->name();
406 my $timeout = $this->{timeout};
407 $this->log("irspy", "beginnning with test '$topname' (timeout $timeout)");
410 my @conn = @{ $this->{connections} };
413 ROUND_AND_ROUND_WE_GO:
415 my @copy_conn = @conn; # avoid alias problems after splice()
416 my $nconn = scalar(@copy_conn);
417 foreach my $i0 (0 .. $#copy_conn) {
418 my $conn = $copy_conn[$i0];
419 #print "connection $i0 of $nconn/", scalar(@conn), " is $conn\n";
420 next if !defined $conn;
421 if (!$conn->current_task()) {
422 if (!$conn->next_task()) {
423 # Out of tasks: we need a new test
425 my $address = $conn->option("current_test_address");
427 if (!defined $address) {
430 $conn->log("irspy_test",
431 "checking for next test after '$address'");
432 $nextaddr = $this->_next_test($address);
434 if (!defined $nextaddr) {
435 $conn->log("irspy", "has no more tests: removing");
436 $this->_rewrite_record($conn);
437 $conn->option(rewrote_record => 1);
438 my $newconn = $this->_next_connection();
439 if (!defined $newconn) {
440 # Do not destroy: needed for later sanity checks
441 splice @conn, $i0, 1;
444 $conn[$i0] = $newconn;
445 $conn[$i0]->option(current_test_address => "");
446 $conn[$i0]->log("irspy", "entering active pool - ",
447 scalar(@{ $this->{queue} }),
448 " targets remain in queue");
453 my $node = $this->{tree}->select($nextaddr)
454 or die "invalid nextaddr '$nextaddr'";
455 $conn->option(current_test_address => $nextaddr);
456 my $tname = $node->name();
457 $conn->log("irspy_test",
458 "starting test '$nextaddr' = $tname");
459 my $tasks = $conn->tasks();
460 my $oldcount = @$tasks;
461 "ZOOM::IRSpy::Test::$tname"->start($conn);
462 $tasks = $conn->tasks();
463 if (@$tasks > $oldcount) {
464 # Prepare to start the first of the newly added tasks
465 $conn->next_task($tasks->[$oldcount]);
467 $conn->log("irspy_task",
468 "no tasks added by new test $tname");
473 my $task = $conn->next_task();
474 die "no next task queued for $conn" if !defined $task;
475 $conn->log("irspy_task", "preparing task $task");
477 $conn->current_task($task);
483 my $i0 = ZOOM::event(\@conn);
484 $this->log("irspy_event",
485 "ZOOM_event(", scalar(@conn), " connections) = $i0");
488 0 => "no events remain",
489 -1 => "ZOOM::event() argument not a reference",
490 -2 => "ZOOM::event() reference not an array",
491 -3 => "no connections remain",
492 -4 => "too many connections for ZOOM::event()",
494 my $message = $messages{$i0} || "ZOOM::event() returned $i0";
495 $this->log("irspy", $message);
499 my $conn = $conn[$i0-1];
500 my $ev = $conn->last_event();
501 my $evstr = ZOOM::event_str($ev);
502 $conn->log("irspy_event", "event $ev ($evstr)");
503 goto NEXT_EVENT if $ev != ZOOM::Event::ZEND;
505 my $task = $conn->current_task();
506 die "$conn has no current task for event $ev ($evstr)" if !$task;
509 eval { $conn->check() };
510 if ($@ && ref $@ && $@->isa("ZOOM::Exception")) {
511 my $sub = $task->{cb}->{exception};
512 die $@ if !defined $sub;
513 $res = &$sub($conn, $task, $task->udata(), $@);
515 die "Unexpected non-ZOOM exception: " . ref($@) . " ($@)";
517 my $sub = $task->{cb}->{$ev};
519 $conn->log("irspy_unhandled", "event $ev ($evstr)");
523 $res = &$sub($conn, $task, $task->udata(), $ev);
526 if ($res == ZOOM::IRSpy::Status::OK) {
527 # Nothing to do -- life continues
529 } elsif ($res == ZOOM::IRSpy::Status::TASK_DONE) {
530 my $task = $conn->current_task();
531 die "no task for TASK_DONE on $conn" if !$task;
532 die "next task already defined for $conn" if $conn->next_task();
533 $conn->log("irspy_task", "completed task $task");
534 $conn->next_task($task->{next});
535 $conn->current_task(0);
537 } elsif ($res == ZOOM::IRSpy::Status::TEST_GOOD ||
538 $res == ZOOM::IRSpy::Status::TEST_BAD) {
539 my $x = ($res == ZOOM::IRSpy::Status::TEST_GOOD) ? "good" : "bad";
540 $conn->log("irspy_task", "test ended during task $task ($x)");
541 $conn->log("irspy_test", "test completed ($x)");
542 $conn->current_task(0);
544 if ($res == ZOOM::IRSpy::Status::TEST_BAD) {
545 my $address = $conn->option('current_test_address');
546 $conn->log("irspy", "top-level test failed!")
548 my $node = $this->{tree}->select($address);
550 while (defined $node->next() &&
551 length($node->next()->address()) >= length($address)) {
552 $conn->log("irspy_debug", "skipping from '",
553 $node->address(), "' to '",
554 $node->next()->address(), "'");
555 $node = $node->next();
559 $conn->option(current_test_address => $node->address());
560 $conn->log("irspy_test", "skipped $skipcount tests");
561 $nskipped += $skipcount;
564 } elsif ($res == ZOOM::IRSpy::Status::TEST_SKIPPED) {
565 $conn->log("irspy_test", "test skipped during task $task");
566 $conn->current_task(0);
571 die "unknown callback return-value '$res'";
575 $this->log("irspy", "exiting main loop");
577 # Sanity checks: none of the following should ever happen
579 $this->log("irspy", "performing end-of-run sanity-checks");
580 foreach my $conn (@conn) {
581 my $test = $conn->option("current_test_address");
582 my $next = $this->_next_test($test);
585 "$conn (in test '$test') has queued test '$next'");
588 if (my $task = $conn->current_task()) {
589 $this->log("irspy", "$conn still has an active task $task");
592 if (my $task = $conn->next_task()) {
593 $this->log("irspy", "$conn still has a queued task $task");
596 if (!$conn->is_idle()) {
598 "$conn still has ZOOM-C level tasks queued: see below");
601 my $ev = $conn->peek_event();
602 if ($ev != 0 && $ev != ZOOM::Event::ZEND) {
603 my $evstr = ZOOM::event_str($ev);
604 $this->log("irspy", "$conn has event $ev ($evstr) waiting");
607 if (!$conn->option("rewrote_record")) {
608 $this->log("irspy", "$conn did not rewrite its ZeeRex record");
613 # This really shouldn't be necessary, and in practice it rarely
614 # helps, but it's belt and braces. (For now, we don't do this
615 # hence the zero in the $nruns check).
618 $this->log("irspy", "back into main loop, ${nruns}th time");
619 goto ROUND_AND_ROUND_WE_GO;
621 $this->log("irspy", "bailing after $nruns main-loop runs");
625 # This shouldn't happen emit anything either:
626 while ((my $i1 = ZOOM::event(\@conn)) > 0) {
627 my $conn = $conn[$i1-1];
628 my $ev = $conn->last_event();
629 my $evstr = ZOOM::event_str($ev);
631 "$conn still has ZOOM-C level task queued: $ev ($evstr)")
632 if $ev != ZOOM::Event::ZEND;
639 # Exactly equivalent to ZOOM::event() except that it is tolerant to
640 # undefined values in the array being passed in.
642 sub __UNUSED_tolerant_ZOOM_event {
646 foreach my $i (0 .. @$connref-1) {
647 my $conn = $connref->[$i];
654 my $res = ZOOM::event(\@conn);
655 return $res if $res <= 0;
656 my $res2 = $map[$res-1] + 1;
657 print STDERR "*** tolerant_ZOOM_event() returns $res->$res2\n";
664 my($tname, @ancestors) = @_;
666 die("$0: test-hierarchy loop detected: " .
667 join(" -> ", @ancestors, $tname))
668 if grep { $_ eq $tname } @ancestors;
670 my $slashSeperatedTname = $tname;
671 $slashSeperatedTname =~ s/::/\//g;
672 my $fullName = "ZOOM/IRSpy/Test/$slashSeperatedTname.pm";
677 $this->log("irspy", "couldn't require '$fullName': $@");
678 $this->log("warn", "can't load test '$tname': skipping",
679 $@ =~ /^Can.t locate/ ? () : " ($@)");
683 $this->log("irspy", "adding test '$tname'");
685 foreach my $subtname ("ZOOM::IRSpy::Test::$tname"->subtests($this)) {
686 my $subtest = $this->_gather_tests($subtname, @ancestors, $tname);
687 push @subnodes, $subtest if defined $subtest;
690 return new ZOOM::IRSpy::Node($tname, @subnodes);
694 # These next three should arguably be Node methods
697 my($address, $omit_child) = @_;
701 my $maybe = $address eq "" ? "0" : "$address:0";
702 return $maybe if $this->{tree}->select($maybe);
705 # The top-level node has no successor or parent
706 return undef if $address eq "";
708 # Try next sibling child
709 my @components = split /:/, $address;
710 my $last = pop @components;
711 my $maybe = join(":", @components, $last+1);
712 return $maybe if $this->{tree}->select($maybe);
714 # This node is exhausted: try the parent's successor
715 return $this->_next_test(join(":", @components), 1)
719 sub _last_sibling_test {
724 if !defined $this->_next_sibling_test($address);
728 my $maybe = $this->_next_sibling_test($address);
729 last if !defined $maybe;
732 $this->log("irspy", "skipping $nskipped tests to '$address'");
735 return ($address, $nskipped);
739 sub _next_sibling_test {
743 my @components = split /:/, $address;
744 my $last = pop @components;
745 my $maybe = join(":", @components, $last+1);
746 return $maybe if $this->{tree}->select($maybe);
756 ZOOM::IRSpy::Maintenance.
758 The ZOOM-Perl module,
759 http://search.cpan.org/~mirk/Net-Z3950-ZOOM/
762 http://indexdata.com/zebra/
766 Mike Taylor, E<lt>mike@indexdata.comE<gt>
768 =head1 COPYRIGHT AND LICENSE
770 Copyright (C) 2006 by Index Data ApS.
772 This library is free software; you can redistribute it and/or modify
773 it under the same terms as Perl itself, either Perl version 5.8.7 or,
774 at your option, any later version of Perl 5 you may have available.