-# $Id: ZOOM.pm,v 1.14 2005-11-08 11:46:59 mike Exp $
-
use strict;
use warnings;
+use IO::File;
use Net::Z3950::ZOOM;
package ZOOM;
-
# Member naming convention: hash-element names which begin with an
# underscore represent underlying ZOOM-C object descriptors; those
# which lack them represent Perl's ZOOM objects. (The same convention
sub ENCODE { Net::Z3950::ZOOM::ERROR_ENCODE }
sub DECODE { Net::Z3950::ZOOM::ERROR_DECODE }
sub CONNECTION_LOST { Net::Z3950::ZOOM::ERROR_CONNECTION_LOST }
-sub INIT { Net::Z3950::ZOOM::ERROR_INIT }
+sub ZINIT { Net::Z3950::ZOOM::ERROR_INIT }
sub INTERNAL { Net::Z3950::ZOOM::ERROR_INTERNAL }
sub TIMEOUT { Net::Z3950::ZOOM::ERROR_TIMEOUT }
sub UNSUPPORTED_PROTOCOL { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_PROTOCOL }
sub UNSUPPORTED_QUERY { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_QUERY }
sub INVALID_QUERY { Net::Z3950::ZOOM::ERROR_INVALID_QUERY }
+sub CQL_PARSE { Net::Z3950::ZOOM::ERROR_CQL_PARSE }
+sub CQL_TRANSFORM { Net::Z3950::ZOOM::ERROR_CQL_TRANSFORM }
+sub CCL_CONFIG { Net::Z3950::ZOOM::ERROR_CCL_CONFIG }
+sub CCL_PARSE { Net::Z3950::ZOOM::ERROR_CCL_PARSE }
# The following are added specifically for this OO interface
sub CREATE_QUERY { 20001 }
sub QUERY_CQL { 20002 }
sub QUERY_PQF { 20003 }
sub SORTBY { 20004 }
sub CLONE { 20005 }
+sub PACKAGE { 20006 }
+sub SCANTERM { 20007 }
+sub LOGLEVEL { 20008 }
+
+# Separate space for CCL errors. Great.
+package ZOOM::CCL::Error;
+sub OK { Net::Z3950::ZOOM::CCL_ERR_OK }
+sub TERM_EXPECTED { Net::Z3950::ZOOM::CCL_ERR_TERM_EXPECTED }
+sub RP_EXPECTED { Net::Z3950::ZOOM::CCL_ERR_RP_EXPECTED }
+sub SETNAME_EXPECTED { Net::Z3950::ZOOM::CCL_ERR_SETNAME_EXPECTED }
+sub OP_EXPECTED { Net::Z3950::ZOOM::CCL_ERR_OP_EXPECTED }
+sub BAD_RP { Net::Z3950::ZOOM::CCL_ERR_BAD_RP }
+sub UNKNOWN_QUAL { Net::Z3950::ZOOM::CCL_ERR_UNKNOWN_QUAL }
+sub DOUBLE_QUAL { Net::Z3950::ZOOM::CCL_ERR_DOUBLE_QUAL }
+sub EQ_EXPECTED { Net::Z3950::ZOOM::CCL_ERR_EQ_EXPECTED }
+sub BAD_RELATION { Net::Z3950::ZOOM::CCL_ERR_BAD_RELATION }
+sub TRUNC_NOT_LEFT { Net::Z3950::ZOOM::CCL_ERR_TRUNC_NOT_LEFT }
+sub TRUNC_NOT_BOTH { Net::Z3950::ZOOM::CCL_ERR_TRUNC_NOT_BOTH }
+sub TRUNC_NOT_RIGHT { Net::Z3950::ZOOM::CCL_ERR_TRUNC_NOT_RIGHT }
# The "Event" package contains constants returned by last_event()
package ZOOM::Event;
sub RECV_APDU { Net::Z3950::ZOOM::EVENT_RECV_APDU }
sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
+sub ZEND { Net::Z3950::ZOOM::EVENT_END }
# ----------------------------------------------------------------------------
return "can't set sort-specification";
} elsif ($code == ZOOM::Error::CLONE) {
return "can't clone record";
+ } elsif ($code == ZOOM::Error::PACKAGE) {
+ return "can't create package";
+ } elsif ($code == ZOOM::Error::SCANTERM) {
+ return "can't retrieve term from scan-set";
+ } elsif ($code == ZOOM::Error::LOGLEVEL) {
+ return "unregistered log-level";
}
return Net::Z3950::ZOOM::diag_str($code);
}
-### More of the ZOOM::Exception instantiations should use this
+sub diag_srw_str {
+ my($code) = @_;
+
+ return Net::Z3950::ZOOM::diag_srw_str($code);
+}
+
+sub event_str {
+ return Net::Z3950::ZOOM::event_str(@_);
+}
+
+sub event {
+ my($connsref) = @_;
+
+ my @_connsref = map { $_->_conn() } @$connsref;
+ return Net::Z3950::ZOOM::event(\@_connsref);
+}
+
sub _oops {
- my($code, $addinfo) = @_;
+ my($code, $addinfo, $diagset) = @_;
- die new ZOOM::Exception($code, diag_str($code), $addinfo);
+ die new ZOOM::Exception($code, undef, $addinfo, $diagset);
}
# ----------------------------------------------------------------------------
sub new {
my $class = shift();
- my($code, $message, $addinfo) = @_;
- ### support diag-set, too
+ my($code, $message, $addinfo, $diagset) = @_;
+
+ $diagset ||= "ZOOM";
+ if (uc($diagset) eq "ZOOM" || uc($diagset) eq "BIB-1") {
+ $message ||= ZOOM::diag_str($code);
+ } elsif (lc($diagset) eq "info:srw/diagnostic/1") {
+ $message ||= ZOOM::diag_srw_str($code);
+ } else {
+ # Should fill in messages for any other known diagsets.
+ $message ||= "(unknown error)";
+ }
return bless {
code => $code,
message => $message,
addinfo => $addinfo,
+ diagset => $diagset,
}, $class;
}
return $this->{addinfo};
}
+sub diagset {
+ my $this = shift();
+ return $this->{diagset};
+}
+
+sub render {
+ my $this = shift();
+
+ my $res = "ZOOM error " . $this->code();
+ $res .= ' "' . $this->message() . '"' if $this->message();
+ $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
+ $res .= " from diag-set '" . $this->diagset() . "'" if $this->diagset();
+ return $res;
+}
+
+# This means that untrapped exceptions render nicely.
+use overload '""' => \&render;
# ----------------------------------------------------------------------------
}, $class;
}
+# PRIVATE to this class and ZOOM::Connection::create() and
+# ZOOM::Connection::package()
+#
sub _opts {
my $this = shift();
sub new {
my $class = shift();
- my($host, $port) = @_;
-
- my $_conn = Net::Z3950::ZOOM::connection_new($host, $port);
- my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
- $errcode = Net::Z3950::ZOOM::connection_error($_conn, $errmsg, $addinfo);
- die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
+ my($host, $port, @options) = @_;
- return bless {
- host => $host,
- port => $port,
- _conn => $_conn,
- };
-}
+ my $conn = $class->create(@options);
+ $conn->{host} = $host;
+ $conn->{port} = $port;
-sub create {
- my $class = shift();
- my($options) = @_;
+ Net::Z3950::ZOOM::connection_connect($conn->_conn(), $host, $port || 0);
+ $conn->_check();
- my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
- return bless {
- host => undef,
- port => undef,
- _conn => $_conn,
- };
+ return $conn;
}
-# PRIVATE to this class
+# PRIVATE to this class, to ZOOM::event() and to ZOOM::Query::CQL2RPN::new()
sub _conn {
my $this = shift();
return $_conn;
}
+sub _check {
+ my $this = shift();
+ my($always_die_on_error) = @_;
+
+ my($errcode, $errmsg, $addinfo, $diagset) = (undef, "x", "x", "x");
+ $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
+ $addinfo, $diagset);
+ if ($errcode) {
+ my $exception = new ZOOM::Exception($errcode, $errmsg, $addinfo,
+ $diagset);
+ if (!$this->option("async") || $always_die_on_error) {
+ ZOOM::Log::log("zoom_check", "throwing error $exception");
+ die $exception;
+ } else {
+ ZOOM::Log::log("zoom_check", "not reporting error $exception");
+ }
+ }
+}
+
+# This wrapper for _check() is called only from outside the ZOOM
+# module, and therefore only in situations where an asynchronous
+# application is actively asking for an exception to be thrown if an
+# error has been detected. So it passed always_die_on_error=1 to the
+# underlying _check() method.
+#
+sub check {
+ my $this = shift();
+ return $this->_check(1);
+}
+
+sub create {
+ my $class = shift();
+ my(@options) = @_;
+
+ my $_opts;
+ if (@_ == 1) {
+ $_opts = $_[0]->_opts();
+ } else {
+ $_opts = Net::Z3950::ZOOM::options_create();
+ while (@options >= 2) {
+ my $key = shift(@options);
+ my $val = shift(@options);
+ Net::Z3950::ZOOM::options_set($_opts, $key, $val);
+ }
+
+ die "Odd number of options specified"
+ if @options;
+ }
+
+ my $_conn = Net::Z3950::ZOOM::connection_create($_opts);
+ my $conn = bless {
+ host => undef,
+ port => undef,
+ _conn => $_conn,
+ }, $class;
+ return $conn;
+}
+
sub error_x {
my $this = shift();
my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
$errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
$addinfo, $diagset);
- return ($errcode, $errmsg, $addinfo, $diagset);
+ return wantarray() ? ($errcode, $errmsg, $addinfo, $diagset) : $errcode;
+}
+
+sub exception {
+ my $this = shift();
+
+ my($errcode, $errmsg, $addinfo, $diagset) = $this->error_x();
+ return undef if $errcode == 0;
+ return new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset);
}
sub errcode {
return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
}
+sub diagset {
+ my $this = shift();
+ return Net::Z3950::ZOOM::connection_diagset($this->_conn());
+}
+
sub connect {
my $this = shift();
my($host, $port) = @_;
+ $port = 0 if !defined $port;
Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
- my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
- $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
- $errmsg, $addinfo);
- die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
+ $this->_check();
# No return value
}
my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
$query->_query());
- my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
- $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
- $errmsg, $addinfo);
- die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
-
+ $this->_check();
return _new ZOOM::ResultSet($this, $query, $_rs);
}
my($pqf) = @_;
my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
- my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
- $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
- $errmsg, $addinfo);
- die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
-
+ $this->_check();
return _new ZOOM::ResultSet($this, $pqf, $_rs);
}
-sub scan {
+sub scan_pqf {
my $this = shift();
my($startterm) = @_;
my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
- my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
- $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
- $errmsg, $addinfo);
- die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
-
+ $this->_check();
return _new ZOOM::ScanSet($this, $startterm, $_ss);
}
+sub scan {
+ my $this = shift();
+ my($query) = @_;
+
+ my $_ss = Net::Z3950::ZOOM::connection_scan1($this->_conn(),
+ $query->_query());
+ $this->_check();
+ return _new ZOOM::ScanSet($this, $query, $_ss);
+}
+
+sub package {
+ my $this = shift();
+ my($options) = @_;
+
+ my $_o = defined $options ? $options->_opts() :
+ Net::Z3950::ZOOM::options_create();
+ my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
+ or ZOOM::_oops(ZOOM::Error::PACKAGE);
+
+ return _new ZOOM::Package($this, $options, $_p);
+}
+
+sub last_event {
+ my $this = shift();
+
+ return Net::Z3950::ZOOM::connection_last_event($this->_conn());
+}
+
+sub is_idle {
+ my $this = shift();
+
+ return Net::Z3950::ZOOM::connection_is_idle($this->_conn());
+}
+
+sub peek_event {
+ my $this = shift();
+
+ return Net::Z3950::ZOOM::connection_peek_event($this->_conn());
+}
+
sub destroy {
my $this = shift();
}
+package ZOOM::Query::CQL2RPN;
+our @ISA = qw(ZOOM::Query);
+
+sub new {
+ my $class = shift();
+ my($string, $conn) = @_;
+
+ my $q = Net::Z3950::ZOOM::query_create()
+ or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
+ # check() throws the exception we want; but we only want it on failure!
+ Net::Z3950::ZOOM::query_cql2rpn($q, $string, $conn->_conn()) == 0
+ or $conn->_check();
+
+ return bless {
+ _query => $q,
+ }, $class;
+}
+
+
+# We have to work around the retarded ZOOM_query_ccl2rpn() API
+package ZOOM::Query::CCL2RPN;
+our @ISA = qw(ZOOM::Query);
+
+sub new {
+ my $class = shift();
+ my($string, $conn) = @_;
+
+ my $q = Net::Z3950::ZOOM::query_create()
+ or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
+
+ my $config = $conn->option("cclqual");
+ if (!defined $config) {
+ my $cclfile = $conn->option("cclfile")
+ or ZOOM::_oops(ZOOM::Error::CCL_CONFIG,
+ "no 'cclqual' or 'cclfile' specified");
+ my $fh = new IO::File("<$cclfile")
+ or ZOOM::_oops(ZOOM::Error::CCL_CONFIG,
+ "can't open cclfile '$cclfile': $!");
+ $config = join("", <$fh>);
+ $fh->close();
+ }
+
+ my($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0, "", 0);
+ if (Net::Z3950::ZOOM::query_ccl2rpn($q, $string, $config,
+ $ccl_errcode, $ccl_errstr,
+ $ccl_errpos) < 0) {
+ # We have no use for $ccl_errcode or $ccl_errpos
+ ZOOM::_oops(ZOOM::Error::CCL_PARSE, $ccl_errstr);
+ }
+
+ return bless {
+ _query => $q,
+ }, $class;
+}
+
+
package ZOOM::Query::PQF;
our @ISA = qw(ZOOM::Query);
my($which) = @_;
my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
- ### Check for error -- but how?
+ $this->{conn}->_check();
+
+ # Even if no error has occurred, I think record() might
+ # legitimately return undef if we're running in asynchronous mode
+ # and the record just hasn't been retrieved yet. This goes double
+ # for record_immediate().
return undef if !defined $_rec;
# For some reason, I have to use the explicit "->" syntax in order
my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
$which);
- ### Check for error -- but how?
+ $this->{conn}->_check();
+ # The record might legitimately not be there yet
return undef if !defined $_rec;
return ZOOM::Record->_new($this, $which, $_rec);
my $this = shift();
my($start, $count, $return_records) = @_;
+ # If the request is out of range, ZOOM-C will currently (as of YAZ
+ # 2.1.38) no-op: it understandably refuses to build and send a
+ # known-bad APDU, but it doesn't set a diagnostic as it ought. So
+ # for now, we do it here. It would be more polite to stash the
+ # error-code in the ZOOM-C connection object for subsequent
+ # discovery (which is what ZOOM-C will presumably do itself when
+ # it's fixed) but since there is no API that allows us to do that,
+ # we just have to throw the exception right now. That's probably
+ # OK for synchronous applications, but not really for
+ # multiplexers.
+ my $size = $this->size();
+ if ($start + $count-1 >= $size) {
+ # BIB-1 diagnostic 13 is "Present request out-of-range"
+ ZOOM::_oops(13, undef, "BIB-1");
+ }
+
my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
$return_records);
+ # By design, $raw may be undefined (if $return_records is true)
return undef if !defined $raw;
# We need to package up the returned records in ZOOM::Record objects
my $this = shift();
my($sort_type, $sort_spec) = @_;
- Net::Z3950::ZOOM::resultset_sort($this->_rs(), $sort_type, $sort_spec);
- ### There's no way to check for success, as this is a void function
+ return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
+ $sort_type, $sort_spec);
}
sub destroy {
return $_rec;
}
+sub error {
+ my $this = shift();
+
+ my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
+ $errcode = Net::Z3950::ZOOM::record_error($this->_rec(), $errmsg,
+ $addinfo, $diagset);
+
+ return wantarray() ? ($errcode, $errmsg, $addinfo, $diagset) : $errcode;
+}
+
+sub exception {
+ my $this = shift();
+
+ my($errcode, $errmsg, $addinfo, $diagset) = $this->error();
+ return undef if $errcode == 0;
+ return new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset);
+}
+
+
sub render {
my $this = shift();
- my $len = 0;
- my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "render", $len);
- # I don't think we need '$len' at all. ### Probably the Perl-to-C
- # glue code should use the value of `len' as well as the opaque
- # data-pointer returned, to ensure that the SV contains all of the
- # returned data and does not stop at the first NUL character in
- # binary data. Carefully check the ZOOM_record_get() documentation.
- return $string;
+ return $this->get("render", @_);
}
sub raw {
my $this = shift();
- my $len = 0;
- my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
- # See comment about $len in render()
- return $string;
+ return $this->get("raw", @_);
+}
+
+sub get {
+ my $this = shift();
+ my($type, $args) = @_;
+
+ $type = "$type;$args" if defined $args;
+ return Net::Z3950::ZOOM::record_get($this->_rec(), $type);
}
sub clone {
return bless {
conn => $conn,
- startterm => $startterm,
+ startterm => $startterm,# This is not currently used, which is
+ # just as well since it could be
+ # either a string (when the SS is
+ # created with scan()) or a
+ # ZOOM::Query object (when it's
+ # created with scan1())
_ss => $_ss,
}, $class;
}
return $_ss;
}
+sub option {
+ my $this = shift();
+ my($key, $value) = @_;
+
+ my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
+ Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
+ if defined $value;
+
+ return $oldval;
+}
+
sub size {
my $this = shift();
my($occ, $len) = (0, 0);
my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
- $occ, $len);
- return undef if !defined $term;
+ $occ, $len)
+ or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
die "length of term '$term' differs from returned len=$len"
if length($term) != $len;
my($occ, $len) = (0, 0);
my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
- $occ, $len);
- return undef if !defined $term;
+ $occ, $len)
+ or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
die "length of display term '$term' differs from returned len=$len"
if length($term) != $len;
}
+# ----------------------------------------------------------------------------
+
+package ZOOM::Package;
+
+sub new {
+ my $class = shift();
+ die "You can't create $class objects directly";
+}
+
+# PRIVATE to ZOOM::Connection::package(),
+sub _new {
+ my $class = shift();
+ my($conn, $options, $_p) = @_;
+
+ return bless {
+ conn => $conn,
+ options => $options,
+ _p => $_p,
+ }, $class;
+}
+
+# PRIVATE to this class
+sub _p {
+ my $this = shift();
+
+ my $_p = $this->{_p};
+ die "{_p} undefined: has this Package been destroy()ed?"
+ if !defined $_p;
+
+ return $_p;
+}
+
+sub option {
+ my $this = shift();
+ my($key, $value) = @_;
+
+ my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
+ Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
+ if defined $value;
+
+ return $oldval;
+}
+
+sub send {
+ my $this = shift();
+ my($type) = @_;
+
+ Net::Z3950::ZOOM::package_send($this->_p(), $type);
+ $this->{conn}->_check();
+}
+
+sub destroy {
+ my $this = shift();
+
+ Net::Z3950::ZOOM::package_destroy($this->_p());
+ $this->{_p} = undef;
+}
+
+
+# There follows trivial support for YAZ logging. This is wired out
+# into the Net::Z3950::ZOOM package, and we here provide wrapper
+# functions -- nothing more than aliases, really -- in the ZOOM::Log
+# package. There really is no point in inventing an OO interface.
+#
+# Passing @_ directly to the underlying Net::Z3950::ZOOM::* functions
+# doesn't work, for reasons that I can't begin to fathom, and that
+# don't particularly interest me. Unpacking into scalars and passing
+# those _does_ work, so that's what we do.
+
+package ZOOM::Log;
+
+sub mask_str { my($a) = @_; Net::Z3950::ZOOM::yaz_log_mask_str($a); }
+sub module_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_module_level($a); }
+sub init { my($a, $b, $c) = @_;
+ Net::Z3950::ZOOM::yaz_log_init($a, $b, $c) }
+sub init_file { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_file($a) }
+sub init_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_level($a) }
+sub init_prefix { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_prefix($a) }
+sub time_format { my($a) = @_; Net::Z3950::ZOOM::yaz_log_time_format($a) }
+sub init_max_size { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_max_size($a) }
+
+sub log {
+ my($level, @message) = @_;
+
+ if ($level !~ /^(0x)?\d+$/) {
+ # Assuming its log-level name, we look it up.
+ my $num = module_level($level);
+ ZOOM::_oops(ZOOM::Error::LOGLEVEL, $level)
+ if $num == 0;
+ $level = $num;
+ }
+
+ Net::Z3950::ZOOM::yaz_log($level, join("", @message));
+}
+
+BEGIN { ZOOM::Log::mask_str("zoom_check"); }
+
1;