Abstract out identifier format, which is now handled by a set of functions in Utils...
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy / Record.pm
index c213f54..7659e4a 100644 (file)
@@ -1,17 +1,16 @@
-# $Id: Record.pm,v 1.15 2006-10-13 13:41:57 sondberg Exp $
+# $Id: Record.pm,v 1.24 2007-04-27 14:04:40 mike Exp $
 
 package ZOOM::IRSpy::Record;
+### I don't think there's any reason for this to be separate from
+#   ZOOM::IRSpy::Connection, now that the correspondence is always 1:1
 
 use 5.008;
 use strict;
 use warnings;
 
-use Exporter 'import';
-our @EXPORT_OK = qw(xml_encode);
-
 use XML::LibXML;
 use XML::LibXML::XPathContext;
-
+use ZOOM::IRSpy::Utils qw(xml_encode isodate);
 
 =head1 NAME
 
@@ -35,6 +34,7 @@ sub new {
        $zeerex = _empty_zeerex_record($target);
     }
 
+    ### Parser should be in the IRSpy object
     my $parser = new XML::LibXML();
     return bless {
        irspy => $irspy,
@@ -48,15 +48,16 @@ sub new {
 sub _empty_zeerex_record {
     my($target) = @_;
 
-    ### Doesn't recognise SRU/SRW URLs
-    my($host, $port, $db) = ZOOM::IRSpy::_parse_target_string($target);
+    my($protocol, $host, $port, $db) =
+       ZOOM::IRSpy::_parse_target_string($target);
 
+    my $xprotocol = xml_encode($protocol);
     my $xhost = xml_encode($host);
     my $xport = xml_encode($port);
     my $xdb = xml_encode($db);
     return <<__EOT__;
 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
- <serverInfo protocol="Z39.50" version="1995">
+ <serverInfo protocol="$xprotocol">
   <host>$xhost</host>
   <port>$xport</port>
   <database>$xdb</database>
@@ -66,22 +67,6 @@ __EOT__
 }
 
 
-# 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/&/&amp;/g;
-    $text =~ s/</&lt;/g;
-    $text =~ s/>/&gt;/g;
-    $text =~ s/['']/&apos;/g;
-    $text =~ s/[""]/&quot;/g;
-    return $text;
-}
-
-
 sub append_entry {
     my $this = shift();
     my($xpath, $frag) = @_;
@@ -90,7 +75,7 @@ sub append_entry {
     my $root = $this->{zeerex}; # XML::LibXML::Element ISA XML::LibXML::Node
     my $xc = XML::LibXML::XPathContext->new($root);
     $xc->registerNs(zeerex => "http://explain.z3950.org/dtd/2.0/");
-    $xc->registerNs(irspy => $ZOOM::IRSpy::irspy_ns);
+    $xc->registerNs(irspy => $ZOOM::IRSpy::Utils::IRSPY_NS);
 
     my @nodes = $xc->findnodes($xpath);
     if (@nodes == 0) {
@@ -112,6 +97,19 @@ sub append_entry {
     $this->_half_decent_appendWellBalancedChunk($nodes[0], $frag);
 }
 
+sub store_result {
+    my ($this, $type, %info) = @_;
+    my $xml = "<irspy:$type";
+
+    foreach my $key (keys %info) {
+        $xml .= " $key=\"" . xml_encode($info{$key}) . "\"";
+    }
+
+    $xml .= ">" . isodate(time()) . "</irspy:$type>\n";
+
+    $this->append_entry('irspy:status', $xml);
+}
+
 
 # *sigh*
 #
@@ -129,7 +127,7 @@ sub append_entry {
 # namespace mapping for that node -- but that only affects pre-parsed
 # trees, and is no use for parsing.  Hence the following pair of lines
 # DOES NOT WORK:
-#      $node->setNamespace($ZOOM::IRSpy::irspy_ns, "irspy", 0);
+#      $node->setNamespace($ZOOM::IRSpy::Utils::IRSPY_NS, "irspy", 0);
 #      $node->appendWellBalancedChunk($frag);
 #
 # Instead I have to go the long way round, hence this method.  I have
@@ -143,7 +141,7 @@ sub _half_decent_appendWellBalancedChunk {
     my($node, $frag) = @_;
 
     if (1) {
-       $frag =~ s,>, xmlns:irspy="$ZOOM::IRSpy::irspy_ns">,;
+       $frag =~ s,>, xmlns:irspy="$ZOOM::IRSpy::Utils::IRSPY_NS">,;
        $node->appendWellBalancedChunk($frag);
        return;
     }