1 # $Id: Record.pm,v 1.25 2007-05-04 12:09:24 mike Exp $
3 package ZOOM::IRSpy::Record;
4 ### I don't think there's any reason for this to be separate from
5 # ZOOM::IRSpy::Connection, now that the correspondence is always 1:1
12 use XML::LibXML::XPathContext;
13 use ZOOM::IRSpy::Utils qw(xml_encode isodate irspy_xpath_context);
17 ZOOM::IRSpy::Record - record describing a target for IRSpy
31 my($irspy, $target, $zeerex) = @_;
33 if (!defined $zeerex) {
34 $zeerex = _empty_zeerex_record($target);
37 ### Parser should be in the IRSpy object
38 my $parser = new XML::LibXML();
43 zeerex => $parser->parse_string($zeerex)->documentElement(),
48 sub _empty_zeerex_record {
51 my($protocol, $host, $port, $db) =
52 ZOOM::IRSpy::_parse_target_string($target);
54 my $xprotocol = xml_encode($protocol);
55 my $xhost = xml_encode($host);
56 my $xport = xml_encode($port);
57 my $xdb = xml_encode($db);
59 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
60 <serverInfo protocol="$xprotocol">
63 <database>$xdb</database>
72 my($xpath, $frag) = @_;
74 #print STDERR "this=$this, xpath='$xpath', frag='$frag'\n";
75 my $xc = $this->xpath_context();
76 $xc->registerNs(zeerex => "http://explain.z3950.org/dtd/2.0/");
77 $xc->registerNs(irspy => $ZOOM::IRSpy::Utils::IRSPY_NS);
79 my @nodes = $xc->findnodes($xpath);
81 # Make the node that we're inserting into, if possible. A
82 # fully general version would work its way through each
83 # component of the XPath, but for now we just treat it as a
84 # single chunk to go inside the top-level node.
85 $this->_half_decent_appendWellBalancedChunk($xc, "<$xpath></$xpath>");
86 @nodes = $xc->findnodes($xpath);
87 die("still no matches for '$xpath' after creating: can't append")
91 $this->{irspy}->log("warn",
92 scalar(@nodes), " matches for '$xpath': using first")
95 $this->_half_decent_appendWellBalancedChunk($nodes[0], $frag);
101 return irspy_xpath_context($this->{zeerex});
105 my ($this, $type, %info) = @_;
106 my $xml = "<irspy:$type";
108 foreach my $key (keys %info) {
109 $xml .= " $key=\"" . xml_encode($info{$key}) . "\"";
112 $xml .= ">" . isodate(time()) . "</irspy:$type>\n";
114 $this->append_entry('irspy:status', $xml);
120 # _Clearly_ the right way to append a well-balanced chunk of XML to
121 # a node's children is to call appendWellBalancedChunk() from the
122 # XML::LibXML::Element class. However, this fails in the common case
123 # where the ZeeRex record we're working with doesn't declare the
124 # "irspy" namespace that the inserted fragments use.
126 # To my utter astonishment it seems that XML::LibXML (as of version
127 # 1.58, 31st March 2004) doesn't provide ANY way to register a
128 # namespace for parsing, which makes the parse_balanced_chunk()
129 # function that appendWellBalancedChunk() uses effectively useless.
130 # It _is_ possible to use setNamespace() on a node, to register a new
131 # namespace mapping for that node -- but that only affects pre-parsed
132 # trees, and is no use for parsing. Hence the following pair of lines
134 # $node->setNamespace($ZOOM::IRSpy::Utils::IRSPY_NS, "irspy", 0);
135 # $node->appendWellBalancedChunk($frag);
137 # Instead I have to go the long way round, hence this method. I have
138 # two candidate re-implementations, of which the former is marginally
139 # less loathsome, but does require that the excess namespace
140 # declarations be factored out later -- as least, if you want neat
143 sub _half_decent_appendWellBalancedChunk {
145 my($node, $frag) = @_;
148 $frag =~ s,>, xmlns:irspy="$ZOOM::IRSpy::Utils::IRSPY_NS">,;
149 $node->appendWellBalancedChunk($frag);
153 # Instead -- and to call this brain-damaged would be an insult
154 # to all those fine people out there with actual brain damage
155 # -- I have to "parse" the XML fragment myself and insert the
156 # resulting hand-build DOM tree. Someone shoot me now.
157 my($open, $content, $close) = $frag =~ /^<(.*?)>(.*)<\/(.*?)>$/;
158 die "can't 'parse' XML fragment '$frag'"
160 my($tag, $attrs) = $open =~ /(.*?)\s(.*)/;
161 $tag = $open if !defined $tag;
162 die "mismatched XML start/end <$open>...<$close>"
164 print STDERR "tag='$tag', attrs=[$attrs], content='$content'\n";
165 die "## no code yet to make DOM node";
175 Mike Taylor, E<lt>mike@indexdata.comE<gt>
177 =head1 COPYRIGHT AND LICENSE
179 Copyright (C) 2006 by Index Data ApS.
181 This library is free software; you can redistribute it and/or modify
182 it under the same terms as Perl itself, either Perl version 5.8.7 or,
183 at your option, any later version of Perl 5 you may have available.