2 package ZOOM::IRSpy::Record;
3 ### I don't think there's any reason for this to be separate from
4 # 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(),
44 zoom_error => { TIMEOUT => 0 },
47 #Scalar::Util::weaken($this->{irspy});
48 #Scalar::Util::weaken($this->{parser});
53 sub zoom_error { return shift->{'zoom_error'} }
55 sub _empty_zeerex_record {
58 my($protocol, $host, $port, $db) =
59 ZOOM::IRSpy::_parse_target_string($target);
61 my $xprotocol = xml_encode($protocol);
62 my $xhost = xml_encode($host);
63 my $xport = xml_encode($port);
64 my $xdb = xml_encode($db);
66 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
67 <serverInfo protocol="$xprotocol">
70 <database>$xdb</database>
79 my($xpath, $frag) = @_;
81 #print STDERR "this=$this, xpath='$xpath', frag='$frag'\n";
82 my $xc = $this->xpath_context();
83 $xc->registerNs(zeerex => "http://explain.z3950.org/dtd/2.0/");
84 $xc->registerNs(irspy => $ZOOM::IRSpy::Utils::IRSPY_NS);
86 my @nodes = $xc->findnodes($xpath);
88 # Make the node that we're inserting into, if possible. A
89 # fully general version would work its way through each
90 # component of the XPath, but for now we just treat it as a
91 # single chunk to go inside the top-level node.
92 $this->_half_decent_appendWellBalancedChunk($xc->getContextNode(),
94 @nodes = $xc->findnodes($xpath);
95 die("still no matches for '$xpath' after creating: can't append")
99 $this->{irspy}->log("warn",
100 scalar(@nodes), " matches for '$xpath': using first")
103 $this->_half_decent_appendWellBalancedChunk($nodes[0], $frag);
109 return irspy_xpath_context($this->{zeerex});
113 my ($this, $type, %info) = @_;
114 my $xml = "<irspy:$type";
116 foreach my $key (keys %info) {
117 $xml .= " $key=\"" . xml_encode($info{$key}) . "\"";
120 $xml .= ">" . isodate(time()) . "</irspy:$type>";
122 $this->{irspy}->log("irspy_data", $xml);
123 $this->append_entry('irspy:status', $xml . "\n");
129 # _Clearly_ the right way to append a well-balanced chunk of XML to
130 # a node's children is to call appendWellBalancedChunk() from the
131 # XML::LibXML::Element class. However, this fails in the common case
132 # where the ZeeRex record we're working with doesn't declare the
133 # "irspy" namespace that the inserted fragments use.
135 # To my utter astonishment it seems that XML::LibXML (as of version
136 # 1.58, 31st March 2004) doesn't provide ANY way to register a
137 # namespace for parsing, which makes the parse_balanced_chunk()
138 # function that appendWellBalancedChunk() uses effectively useless.
139 # It _is_ possible to use setNamespace() on a node, to register a new
140 # namespace mapping for that node -- but that only affects pre-parsed
141 # trees, and is no use for parsing. Hence the following pair of lines
143 # $node->setNamespace($ZOOM::IRSpy::Utils::IRSPY_NS, "irspy", 0);
144 # $node->appendWellBalancedChunk($frag);
146 # Instead I have to go the long way round, hence this method. I have
147 # two candidate re-implementations, of which the former is marginally
148 # less loathsome, but does require that the excess namespace
149 # declarations be factored out later -- as least, if you want neat
152 sub _half_decent_appendWellBalancedChunk {
154 my($node, $frag) = @_;
157 $frag =~ s,>, xmlns:irspy="$ZOOM::IRSpy::Utils::IRSPY_NS">,;
159 $node->appendWellBalancedChunk($frag);
161 print STDERR "died while trying to appendWellBalancedChunk(), probably due to bad XML:\n$frag";
167 # Instead -- and to call this brain-damaged would be an insult
168 # to all those fine people out there with actual brain damage
169 # -- I have to "parse" the XML fragment myself and insert the
170 # resulting hand-build DOM tree. Someone shoot me now.
171 my($open, $content, $close) = $frag =~ /^<(.*?)>(.*)<\/(.*?)>$/;
172 die "can't 'parse' XML fragment '$frag'"
174 my($tag, $attrs) = $open =~ /(.*?)\s(.*)/;
175 $tag = $open if !defined $tag;
176 die "mismatched XML start/end <$open>...<$close>"
178 print STDERR "tag='$tag', attrs=[$attrs], content='$content'\n";
179 die "## no code yet to make DOM node";
189 Mike Taylor, E<lt>mike@indexdata.comE<gt>
191 =head1 COPYRIGHT AND LICENSE
193 Copyright (C) 2006 by Index Data ApS.
195 This library is free software; you can redistribute it and/or modify
196 it under the same terms as Perl itself, either Perl version 5.8.7 or,
197 at your option, any later version of Perl 5 you may have available.