X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;ds=sidebyside;f=lib%2FZOOM.pm;h=e4b28016cd88251bad87daeb4ee9d0cbad5aeddf;hb=bc71325f3d0bbe522c276929d2b0abdbd0595cba;hp=5f87d1ee0966df023d3a5a320b5b062d2512ae57;hpb=b81ecf91be67f569ec7a4dbdd65101f65c47a954;p=ZOOM-Perl-moved-to-github.git diff --git a/lib/ZOOM.pm b/lib/ZOOM.pm index 5f87d1e..e4b2801 100644 --- a/lib/ZOOM.pm +++ b/lib/ZOOM.pm @@ -1,4 +1,4 @@ -# $Id: ZOOM.pm,v 1.19 2005-11-16 16:48:11 mike Exp $ +# $Id: ZOOM.pm,v 1.25 2005-12-22 12:48:15 mike Exp $ use strict; use warnings; @@ -40,6 +40,8 @@ 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 } # The following are added specifically for this OO interface sub CREATE_QUERY { 20001 } sub QUERY_CQL { 20002 } @@ -47,6 +49,8 @@ sub QUERY_PQF { 20003 } sub SORTBY { 20004 } sub CLONE { 20005 } sub PACKAGE { 20006 } +sub SCANTERM { 20007 } +sub LOGLEVEL { 20008 } # The "Event" package contains constants returned by last_event() package ZOOM::Event; @@ -81,6 +85,10 @@ sub diag_str { 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); @@ -132,6 +140,7 @@ sub render { 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; } @@ -278,7 +287,7 @@ sub new { return $conn; } -# PRIVATE to this class +# PRIVATE to this class and to ZOOM::Query::CQL2RPN::new() sub _conn { my $this = shift(); @@ -393,7 +402,7 @@ sub search_pqf { return _new ZOOM::ResultSet($this, $pqf, $_rs); } -sub scan { +sub scan_pqf { my $this = shift(); my($startterm) = @_; @@ -402,6 +411,16 @@ sub scan { 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) = @_; @@ -476,6 +495,25 @@ sub new { } +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); @@ -553,7 +591,12 @@ sub record { 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 @@ -568,7 +611,8 @@ sub record_immediate { 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); @@ -586,7 +630,7 @@ sub records { my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count, $return_records); - ### Why don't we throw an exception if $raw is undefined? + # 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 @@ -710,7 +754,12 @@ sub _new { 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; } @@ -749,9 +798,9 @@ sub term { my($occ, $len) = (0, 0); my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which, - $occ, $len); - ### Throw exception? - 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; @@ -764,9 +813,9 @@ sub display_term { my($occ, $len) = (0, 0); my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which, - $occ, $len); - ### Throw exception? - 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; @@ -840,4 +889,41 @@ sub destroy { } +# 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;