More SEE ALSOs
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy.pm
index 2e99673..cf2a91f 100644 (file)
@@ -1,11 +1,11 @@
-# $Id: IRSpy.pm,v 1.1 2006-06-20 12:27:12 mike Exp $
+# $Id: IRSpy.pm,v 1.20 2006-09-26 09:24:45 mike Exp $
 
-package Net::Z3950::IRSpy;
+package ZOOM::IRSpy;
 
 use 5.008;
 use strict;
 use warnings;
-use Net::Z3950::IRSpy::Record;
+use ZOOM::IRSpy::Record;
 use ZOOM::Pod;
 
 our @ISA = qw();
@@ -13,12 +13,12 @@ our $VERSION = '0.02';
 
 =head1 NAME
 
-Net::Z3950::IRSpy - Perl extension for discovering and analysing IR services
+ZOOM::IRSpy - Perl extension for discovering and analysing IR services
 
 =head1 SYNOPSIS
 
- use Net::Z3950::IRSpy;
- $spy = new Net::Z3950::IRSpy("target/string/for/irspy/database");
+ use ZOOM::IRSpy;
+ $spy = new ZOOM::IRSpy("target/string/for/irspy/database");
  print $spy->report_status();
 
 =head1 DESCRIPTION
@@ -29,19 +29,31 @@ protocols.  It is a successor to the ZSpy program.
 
 =cut
 
-BEGIN { ZOOM::Log::mask_str("irspy") }
+BEGIN {
+    ZOOM::Log::mask_str("irspy");
+    ZOOM::Log::mask_str("irspy_test");
+    ZOOM::Log::mask_str("irspy_debug");
+}
 
 sub new {
     my $class = shift();
-    my($dbname) = @_;
+    my($dbname, $user, $password) = @_;
+
+    my @options;
+    push @options, (user => $user, password => $password)
+       if defined $user;
 
-    my $conn = new ZOOM::Connection($dbname)
+    my $conn = new ZOOM::Connection($dbname, 0, @options)
        or die "$0: can't connection to IRSpy database 'dbname'";
 
     my $this = bless {
        conn => $conn,
        allrecords => 1,        # unless overridden by targets()
-       # query and targets will be filled in later
+       query => undef,         # filled in later
+       targets => undef,       # filled in later
+       target2record => undef, # filled in later
+       pod => undef,           # filled in later
+       tests => [],            # stack of tests currently being executed
     }, $class;
     $this->log("irspy", "starting up with database '$dbname'");
 
@@ -62,22 +74,18 @@ sub log {
 #
 sub targets {
     my $this = shift();
-    my($targetList) = @_;
+    my(@targets) = @_;
 
-    $this->log("irspy", "setting explicit list of targets '$targetList'");
+    $this->log("irspy", "setting explicit list of targets ",
+              join(", ", map { "'$_'" } @targets));
     $this->{allrecords} = 0;
-    my @targets = split /\s+/, $targetList;
     my @qlist;
     foreach my $target (@targets) {
-       my($host, $port, $db) = ($target =~ /(.*?):(.*?)\/(.*)/);
-       if (!defined $host) {
-           $port = 210;
-           ($host, $db) = ($target =~ /(.*?)\/(.*)/);
-           $this->log("irspy", "rewrote '$target' to '$host:$port/$db'");
-           $target = "$host:$port/$db";
+       my($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
        }
-       die "invalid target string '$target'"
-           if !defined $host;
        push @qlist,
            (qq[(host = "$host" and port = "$port" and path="$db")]);
     }
@@ -87,6 +95,23 @@ sub targets {
 }
 
 
+# Also used by ZOOM::IRSpy::Record
+sub _parse_target_string {
+    my($target) = @_;
+
+    my($host, $port, $db) = ($target =~ /(.*?):(.*?)\/(.*)/);
+    if (!defined $host) {
+       $port = 210;
+       ($host, $db) = ($target =~ /(.*?)\/(.*)/);
+       $target = "$host:$port/$db";
+    }
+    die "$0: invalid target string '$target'"
+       if !defined $host;
+
+    return ($host, $port, $db, $target);
+}
+
+
 # There are two cases.
 #
 # 1. A specific set of targets is nominated on the command line.
@@ -127,29 +152,32 @@ sub initialise {
     }
 
     my $rs = $this->{conn}->search(new ZOOM::Query::CQL($this->{query}));
+    #print "size='", $rs->size(), "'\n";
     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 Net::Z3950::IRSpy::Record($target, $zeerex);
+           new ZOOM::IRSpy::Record($this, $target, $zeerex);
+       push @{ $this->{targets} }, $target
+           if $this->{allrecords};
     }
 
     foreach my $target (keys %target2record) {
        my $record = $target2record{$target};
        if (!defined $record) {
-           $this->log("irspy", "new record for '$target'");
-           $target2record{$target} = new Net::Z3950::IRSpy::Record($target);
+           $this->log("irspy_debug", "made new record for '$target'");
+           #print STDERR "making '$target' record without zeerex\n";
+           $target2record{$target} = new ZOOM::IRSpy::Record($this, $target);
        } else {
-           $this->log("irspy", "existing record for '$target' $record");
+           $this->log("irspy_debug", "using existing record for '$target'");
        }
     }
-}
-
-
-sub check {
-    my $this = shift();
 
-    $this->{pod} = new ZOOM::Pod(@{ $this->{targets} })
+    $this->{target2record} = \%target2record;
+    $this->{pod} = new ZOOM::Pod(@{ $this->{targets} });
+    delete $this->{targets};   # The information is now in the Pod.
+    delete $this->{query};     # Not needed at all
 }
 
 
@@ -167,73 +195,103 @@ sub _render_record {
 }
 
 
-#my $pod = new ZOOM::Pod(@ARGV);
-#$pod->option(elementSetName => "b");
-#$pod->callback(ZOOM::Event::RECV_SEARCH, \&completed_search);
-#$pod->callback(ZOOM::Event::RECV_RECORD, \&got_record);
-##$pod->callback(exception => \&exception_thrown);
-#$pod->search_pqf("the");
-#my $err = $pod->wait();
-#die "$pod->wait() failed with error $err" if $err;
+# Returns:
+#      0 all tests successfully run
+#      1 some tests skipped
 #
-#sub completed_search {
-#    my($conn, $state, $rs, $event) = @_;
-#    print $conn->option("host"), ": found ", $rs->size(), " records\n";
-#    $state->{next_to_fetch} = 0;
-#    $state->{next_to_show} = 0;
-#    request_records($conn, $rs, $state, 2);
-#    return 0;
-#}
-#
-#sub got_record {
-#    my($conn, $state, $rs, $event) = @_;
-#
-#    {
-#      # Sanity-checking assertions.  These should be impossible
-#      my $ns = $state->{next_to_show};
-#      my $nf = $state->{next_to_fetch};
-#      if ($ns > $nf) {
-#          die "next_to_show > next_to_fetch ($ns > $nf)";
-#      } elsif ($ns == $nf) {
-#          die "next_to_show == next_to_fetch ($ns)";
-#      }
-#    }
-#
-#    my $i = $state->{next_to_show}++;
-#    my $rec = $rs->record($i);
-#    print $conn->option("host"), ": record $i is ", render_record($rec), "\n";
-#    request_records($conn, $rs, $state, 3)
-#      if $i == $state->{next_to_fetch}-1;
-#
-#    return 0;
-#}
-#
-#sub exception_thrown {
-#    my($conn, $state, $rs, $exception) = @_;
-#    print "Uh-oh!  $exception\n";
-#    return 0;
-#}
-#
-#sub request_records {
-#    my($conn, $rs, $state, $count) = @_;
-#
-#    my $i = $state->{next_to_fetch};
-#    ZOOM::Log::log("irspy", "requesting $count records from $i");
-#    $rs->records($i, $count, 0);
-#    $state->{next_to_fetch} += $count;
-#}
-#
-#sub render_record {
-#    my($rec) = @_;
-#
-#    return "undefined" if !defined $rec;
-#    return "'" . $rec->render() . "'";
-#}
+sub check {
+    my $this = shift();
+
+    my $res = $this->_run_test("Main");
+    foreach my $target (sort keys %{ $this->{target2record} }) {
+       my $rec = $this->{target2record}->{$target};
+       # Write record back to database
+       my $p = $this->{conn}->package();
+       $p->option(action => "specialUpdate");
+       my $xml = $rec->{zeerex}->toString();
+       $p->option(record => $xml);
+       $p->send("update");
+       $p->destroy();
+
+       $p = $this->{conn}->package();
+       $p->send("commit");
+       $p->destroy();
+       if (0) {
+           $xml =~ s/&/&amp/g;
+           $xml =~ s/</&lt;/g;
+           $xml =~ s/>/&gt;/g;
+           print "Updated with xml=<br/>\n<pre>$xml</pre>\n";
+       }
+    }
+
+    return $res;
+}
+
+
+sub _run_test {
+    my $this = shift();
+    my($tname) = @_;
+
+    die("$0: test-hierarchy loop detected: " .
+       join(" -> ", @{ $this->{tests} }, $tname))
+       if grep { $_ eq $tname } @{ $this->{tests} };
+
+    eval {
+       my $slashSeperatedTname = $tname;
+       $slashSeperatedTname =~ s/::/\//g;
+       require "ZOOM/IRSpy/Test/$slashSeperatedTname.pm";
+    }; if ($@) {
+       $this->log("warn", "can't load test '$tname': skipping",
+                  $@ =~ /^Can.t locate/ ? () : " ($@)");
+       return 1;
+    }
+
+    $this->log("irspy", "running test '$tname'");
+    push @{ $this->{tests} }, $tname;
+    my $test = "ZOOM::IRSpy::Test::$tname"->new($this);
+    my $res =$test->run();
+    pop @{ $this->{tests} };
+    return $res;
+}
+
+
+# Access methods for the use of Test modules
+sub pod {
+    my $this = shift();
+    return $this->{pod};
+}
+
+sub record {
+    my $this = shift();
+    my($target) = @_;
+
+    if (ref($target) && $target->isa("ZOOM::Connection")) {
+       # Can be called with a Connection instead of a target-name
+       my $conn = $target;
+       $target = $conn->option("host");
+    }
+
+    return $this->{target2record}->{lc($target)};
+}
+
+
+# Utility method, really nothing to do with IRSpy
+sub isodate {
+    my $this = shift();
+    my($time) = @_;
+
+    my($sec, $min, $hour, $mday, $mon, $year) = localtime($time);
+    return sprintf("%04d-%02d-%02dT%02d:%02d:%02d",
+                  $year+1900, $mon+1, $mday, $hour, $min, $sec);
+}
 
 
 =head1 SEE ALSO
 
-Net::Z3950::IRSpy::Record
+ZOOM::IRSpy::Record,
+ZOOM::IRSpy::Web,
+ZOOM::IRSpy::Test,
+ZOOM::IRSpy::Maintenance.
 
 The ZOOM-Perl module,
 http://search.cpan.org/~mirk/Net-Z3950-ZOOM/