-# $Id: ZOOM.pm,v 1.20 2005-11-16 17:26:23 mike Exp $
+# $Id: ZOOM.pm,v 1.31 2006-04-07 12:58:19 mike Exp $
use strict;
use warnings;
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 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 }
# The following are added specifically for this OO interface
sub CREATE_QUERY { 20001 }
sub QUERY_CQL { 20002 }
sub CLONE { 20005 }
sub PACKAGE { 20006 }
sub SCANTERM { 20007 }
+sub LOGLEVEL { 20008 }
# 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 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);
}
+### Undocumented
+sub event_str {
+ return Net::Z3950::ZOOM::event_str(@_);
+}
+
+### Undocumented
+sub event {
+ my($connsref) = @_;
+
+ my @_connsref = map { $_->_conn() } @$connsref;
+ return Net::Z3950::ZOOM::event(\@_connsref);
+}
+
sub _oops {
my($code, $addinfo, $diagset) = @_;
my $this = shift();
my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
$res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
+ $res .= " from diag-set '" . $this->diagset() . "'" if $this->diagset();
return $res;
}
sub new {
my $class = shift();
- my($host, $port) = @_;
+ my($host, $port, @options) = @_;
my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
my $conn = bless {
port => $port,
_conn => $_conn,
};
+
+ while (@options >= 2) {
+ my $key = shift(@options);
+ my $val = shift(@options);
+ $conn->option($key, $val);
+ }
+
+ die "Odd number of options specified"
+ if @options;
+
$conn->_check();
return $conn;
}
-# PRIVATE to this class
+# PRIVATE to this class, to ZOOM::event() and to ZOOM::Query::CQL2RPN::new()
sub _conn {
my $this = shift();
my $this = shift();
my($host, $port) = @_;
+ $port = 0 if !defined $port;
Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
$this->_check();
# No return value
return _new ZOOM::ResultSet($this, $pqf, $_rs);
}
-sub scan {
+sub scan_pqf {
my $this = shift();
my($startterm) = @_;
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) = @_;
return _new ZOOM::Package($this, $options, $_p);
}
+### Undocumented
+sub last_event {
+ my $this = shift();
+
+ return Net::Z3950::ZOOM::connection_last_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;
+}
+
+
package ZOOM::Query::PQF;
our @ISA = qw(ZOOM::Query);
my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
$which);
$this->{conn}->_check();
+ # The record might legitimately not be there yet
return undef if !defined $_rec;
return ZOOM::Record->_new($this, $which, $_rec);
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();
+ return $this->get("raw", @_);
+}
+
+sub get {
+ my $this = shift();
+ my($type, $args) = @_;
+
+ $type = "$type;$args" if defined $args;
my $len = 0;
- my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
- # See comment about $len in render()
+ my $string = Net::Z3950::ZOOM::record_get($this->_rec(), $type, $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 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;
}
}
+# 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));
+}
+
+
1;
projects / ZOOM-Perl-moved-to-github.git / blobdiff