-# $Id: ZOOM.pm,v 1.34 2006-06-13 16:44:21 mike Exp $
+# $Id: ZOOM.pm,v 1.41 2006-11-03 09:23:06 mike Exp $
use strict;
use warnings;
+use IO::File;
use Net::Z3950::ZOOM;
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 NONE { Net::Z3950::ZOOM::EVENT_NONE }
sub _oops {
my($code, $addinfo, $diagset) = @_;
- die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
+ die new ZOOM::Exception($code, undef, $addinfo, $diagset);
}
# ----------------------------------------------------------------------------
my $class = shift();
my($code, $message, $addinfo, $diagset) = @_;
+ $diagset ||= "ZOOM";
+ if (uc($diagset) eq "ZOOM" || uc($diagset) eq "BIB-1") {
+ $message ||= ZOOM::diag_str($code);
+ } else {
+ # Should fill in messages for other diagsets, too.
+ }
+
return bless {
code => $code,
message => $message,
addinfo => $addinfo,
- diagset => $diagset || "ZOOM",
+ diagset => $diagset,
}, $class;
}
my $class = shift();
my($host, $port, @options) = @_;
- my $_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);
- Net::Z3950::ZOOM::connection_connect($_conn, $host, $port || 0);
- my $conn = bless {
- host => $host,
- port => $port,
- _conn => $_conn,
- };
+ my $conn = $class->create(@options);
+ $conn->{host} = $host;
+ $conn->{port} = $port;
+ Net::Z3950::ZOOM::connection_connect($conn->_conn(), $host, $port || 0);
$conn->_check();
+
return $conn;
}
sub create {
my $class = shift();
- my($options) = @_;
+ my(@options) = @_;
- my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
- return bless {
+ 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 {
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 destroy {
my $this = shift();
}
-# It's distressing how very similar this is to CQL2RPN
+# We have to work around the retarded ZOOM_query_ccl2rpn() API
package ZOOM::Query::CCL2RPN;
our @ISA = qw(ZOOM::Query);
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_ccl2rpn($q, $string, $conn->_conn()) == 0
- or $conn->_check();
+
+ 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,
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)