-# $Id: Utils.pm,v 1.30 2007-05-02 13:52:54 mike Exp $
package ZOOM::IRSpy::Utils;
use strict;
use warnings;
+use Scalar::Util;
+
use Exporter 'import';
-our @EXPORT_OK = qw(isodate
+our @EXPORT_OK = qw(utf8param
+ trimField
+ utf8paramTrim
+ isodate
xml_encode
cql_quote
cql_target
irspy_identifier2target
modify_xml_document
bib1_access_point
- render_record);
+ render_record
+ calc_reliability_string
+ calc_reliability_stats);
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) = @_;
$year+1900, $mon+1, $mday, $hour, $min, $sec);
}
+# strips whitespaces at start and ends of a field
+sub trimField {
+ my $field = shift;
+
+ $field =~ s/^\s+//;
+ $field =~ s/\s+$//;
+
+ return $field;
+}
+
+# utf8param() with trim
+sub utf8paramTrim {
+ my $result = utf8param(@_);
+
+ if (defined $result) {
+ $result = trimField($result);
+ }
+
+ return $result;
+}
# 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
sub cql_quote {
my($term) = @_;
- $term =~ s/([""\\])/\\$1/g;
+ $term =~ s/([""\\*?])/\\$1/g;
$term = qq["$term"] if $term =~ /[\s""\/]/;
return $term;
}
sub _irspy_identifier2target {
my($id) = @_;
+ confess "_irspy_identifier2target(): id is undefined"
+ if !defined $id;
+
my($protocol, $target) = ($id =~ /(.*?):(.*)/);
- if (uc($protocol) eq "Z39.50") {
+ if (uc($protocol) eq "Z39.50" || uc($protocol) eq "TCP") {
return "tcp:$target";
} elsif (uc($protocol) eq "SRU") {
return "sru=get,http:$target";
return "sru=srw,http:$target";
}
- warn "unrecognised protocol '$protocol' in ID $id";
+ warn "_irspy_identifier2target($id): unrecognised protocol '$protocol'";
return $target;
}
+# Modifies the XML document for which $xc is an XPath context by
+# inserting or replacing the values specified in the hash %$data. The
+# keys are fieldnames, which are looked up in the register
+# $fieldsByKey to determine, among other things, what their XPath is.
+
sub modify_xml_document {
my($xc, $fieldsByKey, $data) = @_;
my $child = $node->firstChild();
if (ref $child && ref $child eq "XML::LibXML::Text") {
$old = $child->getData();
+ #print STDERR "child='$child', old=", _renderchars($old), "\n" if $key eq "title";
}
}
next if $value eq $old;
my $child = new XML::LibXML::Text($value);
$node->appendChild($child);
push @changes, $ref;
- print STDERR "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";
}
}
+sub calc_reliability_string {
+ my($xc) = @_;
+
+ my($nok, $nall, $percent) = calc_reliability_stats($xc);
+ return "[untested]" if $nall == 0;
+ return "$nok/$nall = " . $percent . "%";
+}
+
+
+sub calc_reliability_stats {
+ my($xc) = @_;
+
+ my @allpings = $xc->findnodes("i:status/i:probe");
+ my $nall = @allpings;
+ return (0, 0, 0) if $nall == 0;
+ my @okpings = $xc->findnodes('i:status/i:probe[@ok = "1"]');
+ my $nok = @okpings;
+ my $percent = int(100*$nok/$nall);
+ return ($nok, $nall, $percent);
+}
+
+
1;
projects / irspy-moved-to-github.git / blobdiff