X-Git-Url: http://git.indexdata.com/?p=irspy-moved-to-github.git;a=blobdiff_plain;f=lib%2FZOOM%2FIRSpy%2FUtils.pm;h=0583662150e0b055de3d304231778708cac7704a;hp=b1d233142ae9304f03d9d0a781f213e00df7e6b4;hb=HEAD;hpb=1d9e1ab49a01c412515e93b36f92a41590d8ab56 diff --git a/lib/ZOOM/IRSpy/Utils.pm b/lib/ZOOM/IRSpy/Utils.pm index b1d2331..0583662 100644 --- a/lib/ZOOM/IRSpy/Utils.pm +++ b/lib/ZOOM/IRSpy/Utils.pm @@ -1,4 +1,3 @@ -# $Id: Utils.pm,v 1.38 2009-04-15 18:16:45 wosch Exp $ package ZOOM::IRSpy::Utils; @@ -10,6 +9,8 @@ use Scalar::Util; use Exporter 'import'; our @EXPORT_OK = qw(utf8param + trimField + utf8paramTrim isodate xml_encode cql_quote @@ -20,7 +21,10 @@ our @EXPORT_OK = qw(utf8param irspy_identifier2target modify_xml_document bib1_access_point - render_record); + render_record + validate_record + calc_reliability_string + calc_reliability_stats); use XML::LibXML; use XML::LibXML::XPathContext; @@ -81,7 +85,6 @@ sub utf8param { return $cooked; } - # Utility functions follow, exported for use of web UI sub utf8param_apache1 { my($r, $key, $value) = @_; @@ -103,6 +106,26 @@ sub isodate { $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 @@ -140,7 +163,7 @@ sub cql_quote { my($term) = @_; $term =~ s/([""\\*?])/\\$1/g; - $term = qq["$term"] if $term =~ /[\s""\/]/; + $term = qq["$term"] if $term =~ /[\s""\/\\]/; return $term; } @@ -157,7 +180,7 @@ sub cql_target { $id = $protocol; } - return "rec.id=" . cql_quote($id); + return "rec.id==" . cql_quote($id); } @@ -261,13 +284,14 @@ sub _irspy_identifier2target { confess "_irspy_identifier2target(): id is undefined" if !defined $id; - my($protocol, $target) = ($id =~ /(.*?):(.*)/); + my($prefix, $protocol, $target) = ($id =~ /([^:]*,)?(.*?):(.*)/); + $prefix ||= ""; if (uc($protocol) eq "Z39.50" || uc($protocol) eq "TCP") { - return "tcp:$target"; + return "${prefix}tcp:$target"; } elsif (uc($protocol) eq "SRU") { - return "sru=get,http:$target"; + return "${prefix}sru=get,http:$target"; } elsif (uc($protocol) eq "SRW") { - return "sru=srw,http:$target"; + return "${prefix}sru=srw,http:$target"; } warn "_irspy_identifier2target($id): unrecognised protocol '$protocol'"; @@ -275,6 +299,11 @@ sub _irspy_identifier2target { } +# 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) = @_; @@ -325,7 +354,7 @@ sub modify_xml_document { } } else { - next if !$value; # No need to create a new empty node + next if !defined $value; # No need to create a new empty node my($ppath, $selector) = $xpath =~ /(.*)\/(.*)/; dom_add_node($xc, $ppath, $selector, $value, @addAfter); #print "New $key ($xpath) = '$value'
\n"; @@ -772,4 +801,86 @@ sub render_record { } +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 $sixtyDaysAgo = time() - 60*24*60*60; + my $iso60DA = isodate($sixtyDaysAgo); + my @allpings = $xc->findnodes("i:status/i:probe"); + + my($nall, $nok) = (0, 0); + foreach my $node (@allpings) { + my $ok = $xc->findvalue('@ok', $node); + my $when = $node->to_literal(); + #warn "$when cmp $iso60DA == ", ($when cmp $iso60DA), "\n"; + next if $when lt $iso60DA; + $nall++; + $nok += !!$ok; + } + + return (0, 0, 0) if $nall == 0; + my $percent = int(100*$nok/$nall + 0.5); + return ($nok, $nall, $percent); +} + +# +# validate_record( record, ( "port" => 1, "database" => 1, "country" => 0, ... )) +# +sub validate_record { + my $rec = shift; + my %args = @_; + + my %required = map { $_ => 1 } qw/port host database protocol/; + my %optional = map { $_ => 1 } qw/country type hosturl contact language/; + my %tests = ( %required, %args ); + + my $xc = irspy_xpath_context($rec); + + my $protocol = $xc->findnodes("e:serverInfo/\@protocol") || ""; + my $port = $xc->findnodes("e:serverInfo/e:port") || ""; + my $host = $xc->findnodes("e:serverInfo/e:host") || ""; + my $dbname = $xc->findnodes("e:serverInfo/e:database") || ""; + + my $id = irspy_make_identifier($protocol, $host, $port, $dbname); + + if ($protocol =~ /\s+$/ || $dbname =~ /\s+$/) { + warn "xxx: $protocol:$host:$port:$dbname: whitespaces\n"; + } + + my @errors = $id; + + if ($tests{'protocol'}) { + push(@errors, 'protocol number is not valid') if $protocol !~ /^(z39\.50|sru|srw|tcp)$/i; + } + + if ($tests{'port'}) { + push(@errors, 'port number is not valid') if $port !~ /^\d+$/; + } + + if ($tests{'host'}) { + push(@errors, 'host name is not valid') if $host !~ /^[0-9a-z]+[0-9a-z\.\-]*\.[0-9a-z]+$/i; + } + + if ($tests{'database'}) { + push(@errors, 'database name is not valid') if $dbname =~ m,/,i; + push(@errors, 'database has trailing spaces') if $dbname =~ /^\s+|\s+$/; + } + + if ($tests{'hosturl'}) { + my $hosturl = $xc->findnodes("i:status/i:hostURL") || ""; + push(@errors, 'This hosturl name is not valid') if $hosturl !~ /^\w+$/i; + } + + return ( !$#errors, \@errors ); +} + 1;