Release 1.03 (connection constructor allows additional option arguments)

[ZOOM-Perl-moved-to-github.git] / lib / ZOOM.pm

diff --git a/lib/ZOOM.pm b/lib/ZOOM.pm
index eff867d..60007af 100644 (file)
--- a/lib/ZOOM.pm
+++ b/lib/ZOOM.pm
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pm,v 1.23 2005-12-19 17:46:09 mike Exp $
+# $Id: ZOOM.pm,v 1.27 2006-03-09 12:57:19 mike Exp $
 
 use strict;
 use warnings;
@@ -7,7 +7,6 @@ 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
@@ -40,6 +39,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 }
@@ -48,6 +49,7 @@ 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;
@@ -84,6 +86,8 @@ sub diag_str {
        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);
@@ -135,6 +139,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;
 }
 
@@ -269,7 +274,7 @@ package ZOOM::Connection;
 
 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 {
@@ -277,11 +282,21 @@ sub new {
        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 and to ZOOM::Query::CQL2RPN::new()
 sub _conn {
     my $this = shift();
 
@@ -347,6 +362,7 @@ sub connect {
     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
@@ -489,6 +505,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);
 
@@ -864,4 +899,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;