- Fix bug in ZOOM::Connection class code that made the
[ZOOM-Perl-moved-to-github.git] / lib / ZOOM.pm
index 27ad75d..48af46a 100644 (file)
@@ -1,13 +1,13 @@
-# $Id: ZOOM.pm,v 1.26 2006-02-10 16:24:34 mike Exp $
+# $Id: ZOOM.pm,v 1.37 2006-10-10 16:51: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
@@ -42,6 +42,8 @@ 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 }
@@ -52,6 +54,22 @@ 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 NONE { Net::Z3950::ZOOM::EVENT_NONE }
@@ -64,6 +82,7 @@ sub SEND_APDU { Net::Z3950::ZOOM::EVENT_SEND_APDU }
 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 }
 
 # ----------------------------------------------------------------------------
 
@@ -94,10 +113,21 @@ sub diag_str {
     return Net::Z3950::ZOOM::diag_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, $diagset) = @_;
 
-    die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
+    die new ZOOM::Exception($code, undef, $addinfo, $diagset);
 }
 
 # ----------------------------------------------------------------------------
@@ -108,11 +138,18 @@ sub new {
     my $class = shift();
     my($code, $message, $addinfo, $diagset) = @_;
 
+    $diagset ||= "ZOOM";
+    if ($diagset eq "ZOOM") {
+       $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;
 }
 
@@ -275,19 +312,31 @@ package ZOOM::Connection;
 
 sub new {
     my $class = shift();
-    my($host, $port) = @_;
+    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);
+    }
 
-    my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
+    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,
-    };
+    }, $class;
+
     $conn->_check();
     return $conn;
 }
 
-# PRIVATE to this class and to ZOOM::Query::CQL2RPN::new()
+# PRIVATE to this class, to ZOOM::event() and to ZOOM::Query::CQL2RPN::new()
 sub _conn {
     my $this = shift();
 
@@ -310,14 +359,29 @@ sub _check {
 
 sub create {
     my $class = shift();
-    my($options) = @_;
+    my(@options) = @_;
 
-    my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
+    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);
     return bless {
        host => undef,
        port => undef,
        _conn => $_conn,
-    };
+    }, $class;
 }
 
 sub error_x {
@@ -434,6 +498,18 @@ sub 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 destroy {
     my $this = shift();
 
@@ -515,6 +591,43 @@ sub new {
 }
 
 
+# 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);
 
@@ -702,22 +815,27 @@ sub _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;
 }