-# $Id: Utils.pm,v 1.25 2007-03-05 19:41:57 mike Exp $
+# $Id: Utils.pm,v 1.38 2009-04-15 18:16:45 wosch Exp $
package ZOOM::IRSpy::Utils;
use warnings;
use Exporter 'import';
-our @EXPORT_OK = qw(isodate
+our @EXPORT_OK = qw(utf8param
+ isodate
xml_encode
cql_quote
cql_target
irspy_xpath_context
+ irspy_make_identifier
+ irspy_record2identifier
+ irspy_identifier2target
modify_xml_document
bib1_access_point
render_record);
use XML::LibXML;
use XML::LibXML::XPathContext;
+use Encode;
+use Encode qw(is_utf8);
+
our $IRSPY_NS = 'http://indexdata.com/irspy/1.0';
+# Under Apache 2/mod_perl 2, the ubiquitous $r is no longer and
+# Apache::Request object, nor even an Apache2::Request, but an
+# Apache2::RequestReq ... which, astonishingly, doesn't have the
+# param() method. So if we're given one of these things, we need to
+# make an Apache::Request out of, which at least isn't too hard.
+# However *sigh* this may not be a cheap operation, so we keep a cache
+# of already-made Request objects.
+#
+my %_apache2request;
+my %_paramsbyrequest; # Used for Apache2 only
+sub utf8param {
+ my($r, $key, $value) = @_;
+
+ if ($r->isa('Apache2::RequestRec')) {
+ # Running under Apache2
+ if (defined $_apache2request{$r}) {
+ #warn "using existing Apache2::RequestReq for '$r'";
+ $r = $_apache2request{$r};
+ } else {
+ require Apache2::Request;
+ #warn "making new Apache2::RequestReq for '$r'";
+ $r = $_apache2request{$r} = new Apache2::Request($r);
+ }
+ }
+
+ if (!defined $key) {
+ return map { decode_utf8($_) } $r->param();
+ }
+
+ my $raw = undef;
+ $raw = $_paramsbyrequest{$r}->{$key} if $r->isa('Apache2::Request');
+ $raw = $r->param($key) if !defined $raw;
+
+ if (defined $value) {
+ # Argh! Simply writing through to the underlying method
+ # param() won't work in Apache2, where param() is readonly.
+ # So we have to keep a hash of additional values, which we
+ # consult (above) before the actual parameters. Ouch ouch.
+ if ($r->isa('Apache2::Request')) {
+ $_paramsbyrequest{$r}->{$key} = encode_utf8($value);
+ } else {
+ $r->param($key, encode_utf8($value));
+ }
+ }
+
+ return undef if !defined $raw;
+ my $cooked = decode_utf8($raw);
+ warn "converted '$raw' to '", $cooked, "'\n" if $cooked ne $raw;
+ return $cooked;
+}
+
# Utility functions follow, exported for use of web UI
+sub utf8param_apache1 {
+ my($r, $key, $value) = @_;
+ die "utf8param() called with value '$value'" if defined $value;
+
+ my $raw = $r->param($key);
+ return undef if !defined $raw;
+ my $cooked = decode_utf8($raw);
+ warn "converted '$raw' to '", $cooked, "'\n" if $cooked ne $raw;
+ return $cooked;
+}
+
+
sub isodate {
my($time) = @_;
sub cql_quote {
my($term) = @_;
- $term =~ s/([""\\])/\\$1/g;
+ $term =~ s/([""\\*?])/\\$1/g;
$term = qq["$term"] if $term =~ /[\s""\/]/;
return $term;
}
# Makes a CQL query that finds a specified target. Arguments may be
# either an ID alone, or a (host, port, db) triple.
sub cql_target {
- my($host, $port, $db) = @_;
+ my($protocol, $host, $port, $db) = @_;
+
+ my $id;
+ if (defined $host) {
+ $id = irspy_make_identifier($protocol, $host, $port, $db);
+ } else {
+ $id = $protocol;
+ }
- $host .= ":$port/$db" if defined $port;
- return "rec.id=" . cql_quote($host);
+ return "rec.id=" . cql_quote($id);
}
sub irspy_xpath_context {
my($record) = @_;
- my $xml = ref $record ? $record->render() : $record;
- my $parser = new XML::LibXML();
- my $doc = $parser->parse_string($xml);
- my $root = $doc->getDocumentElement();
+ if (ref $record && $record->isa("ZOOM::Record")) {
+ $record = $record->render();
+ }
+
+ my $root;
+ if (ref $record) {
+ $root = $record;
+ } else {
+ my $parser = new XML::LibXML();
+ my $doc = $parser->parse_string($record);
+ $root = $doc->getDocumentElement();
+ }
+
my $xc = XML::LibXML::XPathContext->new($root);
foreach my $prefix (keys %_namespaces) {
$xc->registerNs($prefix, $_namespaces{$prefix});
}
+# Construct an opaque identifier from its components. Although it's
+# trivial, this is needed in so many places that it really needs to be
+# factored out.
+#
+# This is the converse of _parse_target_string() in IRSpy.pm, which
+# should be renamed and moved into this package.
+#
+sub irspy_make_identifier {
+ my($protocol, $host, $port, $dbname) = @_;
+
+ die "irspy_make_identifier(" . join(", ", map { "'$_'" } @_).
+ "): wrong number of arguments" if @_ != 4;
+
+ die "irspy_make_identifier(): protocol undefined" if !defined $protocol;
+ die "irspy_make_identifier(): host undefined" if !defined $host;
+ die "irspy_make_identifier(): port undefined" if !defined $port;
+ die "irspy_make_identifier(): dbname undefined" if !defined $dbname;
+
+ return "$protocol:$host:$port/$dbname";
+}
+
+
+# Returns the opaque identifier of an IRSpy record based on the
+# XPathContext'ed DOM object, as returned by irspy_xpath_context().
+# This is doing the same thing as irspy_make_identifier() but from a
+# record rather than a set of parameters.
+#
+sub irspy_record2identifier {
+ my($xc) = @_;
+
+ ### Must be kept the same as is used in ../../../zebra/*.xsl
+ return $xc->find("concat(e:serverInfo/\@protocol, ':',
+ e:serverInfo/e:host, ':',
+ e:serverInfo/e:port, '/',
+ e:serverInfo/e:database)");
+}
+
+
+# Transforms an IRSpy opqaue identifier, as returned from
+# irspy_make_identifier() or irspy_record2identifier(), into a YAZ
+# target-string suitable for feeding to ZOOM. Before we introduced
+# the protocol element at the start of the identifier string, this was
+# a null transform; now we have to be a bit cleverer.
+#
+sub irspy_identifier2target {
+ my $res = _irspy_identifier2target(@_);
+ #carp "converted ID '@_' to target '$res'";
+ return $res;
+}
+
+sub _irspy_identifier2target {
+ my($id) = @_;
+
+ confess "_irspy_identifier2target(): id is undefined"
+ if !defined $id;
+
+ my($protocol, $target) = ($id =~ /(.*?):(.*)/);
+ if (uc($protocol) eq "Z39.50") {
+ return "tcp:$target";
+ } elsif (uc($protocol) eq "SRU") {
+ return "sru=get,http:$target";
+ } elsif (uc($protocol) eq "SRW") {
+ return "sru=srw,http:$target";
+ }
+
+ warn "_irspy_identifier2target($id): unrecognised protocol '$protocol'";
+ return $target;
+}
+
+
sub modify_xml_document {
my($xc, $fieldsByKey, $data) = @_;
# we'll check whether the element is already
# canonical, to determine whether our change is a
# no-op.
- my $old = "???";
+ my $old = "";
my @children = $node->childNodes();
if (@children == 1) {
my $child = $node->firstChild();
if (ref $child && ref $child eq "XML::LibXML::Text") {
$old = $child->getData();
- next if $value eq $old;
+ #print STDERR "child='$child', old=", _renderchars($old), "\n" if $key eq "title";
}
}
+ next if $value eq $old;
$node->removeChildNodes();
my $child = new XML::LibXML::Text($value);
$node->appendChild($child);
push @changes, $ref;
- #print "Elem $key: '$old' -> '$value' ($xpath)<br/>\n";
+ #print STDERR "Elem $key ($xpath): ", _renderchars($old), " -> '", _renderchars($value), "\n";
} else {
warn "unexpected node type $node";
}
}
+sub _renderchars {
+ my($text) = @_;
+
+ return "'" . $text . "'", " (", join(" ", map {ord($_)} split //, $text), "), is_utf8=" , is_utf8($text);
+}
+
+
sub dom_add_node {
my($xc, $ppath, $selector, $value, @addAfter) = @_;
# This function is made available in xslt using the register_function call
sub xslt_strcmp {
my ($arg1, $arg2) = @_;
- return ($arg1->to_literal()) cmp ($arg2->to_literal());
+ return "$arg1" cmp "$arg2";
}
projects / irspy-moved-to-github.git / blobdiff