X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=lib%2FZOOM.pm;h=faea6b39ddd4706d3cab7dd92d6ae193c4f06541;hb=8909986d78c95958d1f63217050afde991109e0a;hp=0bceec76e5c3cb352353eae0737a5e77796e764b;hpb=94f37eff1870835e623751151d69c9f305b556c6;p=ZOOM-Perl-moved-to-github.git

diff --git a/lib/ZOOM.pm b/lib/ZOOM.pm
index 0bceec7..faea6b3 100644
--- a/lib/ZOOM.pm
+++ b/lib/ZOOM.pm
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pm,v 1.12 2005-11-04 17:08:00 mike Exp $
+# $Id: ZOOM.pm,v 1.21 2005-11-24 15:39:20 mike Exp $
 
 use strict;
 use warnings;
@@ -45,6 +45,9 @@ sub CREATE_QUERY { 20001 }
 sub QUERY_CQL { 20002 }
 sub QUERY_PQF { 20003 }
 sub SORTBY { 20004 }
+sub CLONE { 20005 }
+sub PACKAGE { 20006 }
+sub SCANTERM { 20007 }
 
 # The "Event" package contains constants returned by last_event()
 package ZOOM::Event;
@@ -75,16 +78,21 @@ sub diag_str {
 	return "can't set prefix query";
     } elsif ($code == ZOOM::Error::SORTBY) {
 	return "can't set sort-specification";
+    } elsif ($code == ZOOM::Error::CLONE) {
+	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";
     }
 
     return Net::Z3950::ZOOM::diag_str($code);
 }
 
-### More of the ZOOM::Exception instantiations should use this
 sub _oops {
-    my($code, $addinfo) = @_;
+    my($code, $addinfo, $diagset) = @_;
 
-    die new ZOOM::Exception($code, diag_str($code), $addinfo);
+    die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
 }
 
 # ----------------------------------------------------------------------------
@@ -93,13 +101,13 @@ package ZOOM::Exception;
 
 sub new {
     my $class = shift();
-    my($code, $message, $addinfo) = @_;
-    ### support diag-set, too
+    my($code, $message, $addinfo, $diagset) = @_;
 
     return bless {
 	code => $code,
 	message => $message,
 	addinfo => $addinfo,
+	diagset => $diagset || "ZOOM",
     }, $class;
 }
 
@@ -118,6 +126,20 @@ sub addinfo {
     return $this->{addinfo};
 }
 
+sub diagset {
+    my $this = shift();
+    return $this->{diagset};
+}
+
+sub render {
+    my $this = shift();
+    my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
+    $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
+    return $res;
+}
+
+# This means that untrapped exceptions render nicely.
+use overload '""' => \&render;
 
 # ----------------------------------------------------------------------------
 
@@ -144,6 +166,9 @@ sub new {
     }, $class;
 }
 
+# PRIVATE to this class and ZOOM::Connection::create() and
+# ZOOM::Connection::package()
+#
 sub _opts {
     my $this = shift();
 
@@ -246,16 +271,35 @@ sub new {
     my $class = shift();
     my($host, $port) = @_;
 
-    my $_conn = Net::Z3950::ZOOM::connection_new($host, $port);
-    my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
-    $errcode = Net::Z3950::ZOOM::connection_error($_conn, $errmsg, $addinfo);
-    die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
-
-    return bless {
+    my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
+    my $conn = bless {
 	host => $host,
 	port => $port,
 	_conn => $_conn,
     };
+    $conn->_check();
+    return $conn;
+}
+
+# PRIVATE to this class
+sub _conn {
+    my $this = shift();
+
+    my $_conn = $this->{_conn};
+    die "{_conn} undefined: has this Connection been destroy()ed?"
+	if !defined $_conn;
+
+    return $_conn;
+}
+
+sub _check {
+    my $this = shift();
+
+    my($errcode, $errmsg, $addinfo, $diagset) = (undef, "x", "x", "x");
+    $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
+						    $addinfo, $diagset);
+    die new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset)
+	if $errcode;
 }
 
 sub create {
@@ -270,17 +314,6 @@ sub create {
     };
 }
 
-# PRIVATE within this class
-sub _conn {
-    my $this = shift();
-
-    my $_conn = $this->{_conn};
-    die "{_conn} undefined: has this Connection been destroy()ed?"
-	if !defined $_conn;
-
-    return $_conn;
-}
-
 sub error_x {
     my $this = shift();
 
@@ -305,15 +338,17 @@ sub addinfo {
     return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
 }
 
+sub diagset {
+    my $this = shift();
+    return Net::Z3950::ZOOM::connection_diagset($this->_conn());
+}
+
 sub connect {
     my $this = shift();
     my($host, $port) = @_;
 
     Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
-    my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
-    $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
-						  $errmsg, $addinfo);
-    die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
+    $this->_check();
     # No return value
 }
 
@@ -348,11 +383,7 @@ sub search {
 
     my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
 						  $query->_query());
-    my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
-    $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
-						  $errmsg, $addinfo);
-    die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
-
+    $this->_check();
     return _new ZOOM::ResultSet($this, $query, $_rs);
 }
 
@@ -361,14 +392,31 @@ sub search_pqf {
     my($pqf) = @_;
 
     my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
-    my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
-    $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
-						  $errmsg, $addinfo);
-    die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
-
+    $this->_check();
     return _new ZOOM::ResultSet($this, $pqf, $_rs);
 }
 
+sub scan {
+    my $this = shift();
+    my($startterm) = @_;
+
+    my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
+    $this->_check();
+    return _new ZOOM::ScanSet($this, $startterm, $_ss);
+}
+
+sub package {
+    my $this = shift();
+    my($options) = @_;
+
+    my $_o = defined $options ? $options->_opts() :
+	Net::Z3950::ZOOM::options_create();
+    my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
+	or ZOOM::_oops(ZOOM::Error::PACKAGE);
+
+    return _new ZOOM::Package($this, $options, $_p);
+}
+
 sub destroy {
     my $this = shift();
 
@@ -386,6 +434,7 @@ sub new {
     die "You can't create $class objects: it's a virtual base class";
 }
 
+# PRIVATE to this class and ZOOM::Connection::search()
 sub _query {
     my $this = shift();
 
@@ -457,7 +506,7 @@ sub new {
     die "You can't create $class objects directly";
 }
 
-# PRIVATE to ZOOM::Connection::search()
+# PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
 sub _new {
     my $class = shift();
     my($conn, $query, $_rs) = @_;
@@ -474,7 +523,7 @@ sub _new {
     }, $class;
 }
 
-# PRIVATE within this class
+# PRIVATE to this class
 sub _rs {
     my $this = shift();
 
@@ -507,7 +556,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
@@ -522,7 +576,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);
@@ -540,6 +595,7 @@ sub records {
 
     my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
 						  $return_records);
+    # 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
@@ -560,8 +616,8 @@ sub sort {
     my $this = shift();
     my($sort_type, $sort_spec) = @_;
 
-    Net::Z3950::ZOOM::resultset_sort($this->_rs(), $sort_type, $sort_spec);
-    ### There's no way to check for success, as this is a void function
+    return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
+					     $sort_type, $sort_spec);
 }
 
 sub destroy {
@@ -581,7 +637,10 @@ sub new {
     die "You can't create $class objects directly";
 }
 
-# PRIVATE to ZOOM::ResultSet::record()
+# PRIVATE to ZOOM::ResultSet::record(),
+# ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
+# ZOOM::Record::clone()
+#
 sub _new {
     my $class = shift();
     my($rs, $which, $_rec) = @_;
@@ -593,11 +652,15 @@ sub _new {
     }, $class;
 }
 
-# PRIVATE within this class
+# PRIVATE to this class
 sub _rec {
     my $this = shift();
 
-    return $this->{_rec};
+    my $_rec = $this->{_rec};
+    die "{_rec} undefined: has this Record been destroy()ed?"
+	if !defined $_rec;
+
+    return $_rec;
 }
 
 sub render {
@@ -622,5 +685,168 @@ sub raw {
     return $string;
 }
 
+sub clone {
+    my $this = shift();
+
+    my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
+	or ZOOM::_oops(ZOOM::Error::CLONE);
+
+    # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
+    return _new ZOOM::Record(undef, undef, $raw);
+}
+
+sub destroy {
+    my $this = shift();
+
+    Net::Z3950::ZOOM::record_destroy($this->_rec());
+    $this->{_rec} = undef;
+}
+
+
+# ----------------------------------------------------------------------------
+
+package ZOOM::ScanSet;
+
+sub new {
+    my $class = shift();
+    die "You can't create $class objects directly";
+}
+
+# PRIVATE to ZOOM::Connection::scan(),
+sub _new {
+    my $class = shift();
+    my($conn, $startterm, $_ss) = @_;
+
+    return bless {
+	conn => $conn,
+	startterm => $startterm,
+	_ss => $_ss,
+    }, $class;
+}
+
+# PRIVATE to this class
+sub _ss {
+    my $this = shift();
+
+    my $_ss = $this->{_ss};
+    die "{_ss} undefined: has this ScanSet been destroy()ed?"
+	if !defined $_ss;
+
+    return $_ss;
+}
+
+sub option {
+    my $this = shift();
+    my($key, $value) = @_;
+
+    my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
+    Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
+	if defined $value;
+
+    return $oldval;
+}
+
+sub size {
+    my $this = shift();
+
+    return Net::Z3950::ZOOM::scanset_size($this->_ss());
+}
+
+sub term {
+    my $this = shift();
+    my($which) = @_;
+
+    my($occ, $len) = (0, 0);
+    my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
+					      $occ, $len)
+	or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
+    die "length of term '$term' differs from returned len=$len"
+	if length($term) != $len;
+
+    return ($term, $occ);
+}
+
+sub display_term {
+    my $this = shift();
+    my($which) = @_;
+
+    my($occ, $len) = (0, 0);
+    my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
+						      $occ, $len)
+	or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
+    die "length of display term '$term' differs from returned len=$len"
+	if length($term) != $len;
+
+    return ($term, $occ);
+}
+
+sub destroy {
+    my $this = shift();
+
+    Net::Z3950::ZOOM::scanset_destroy($this->_ss());
+    $this->{_ss} = undef;
+}
+
+
+# ----------------------------------------------------------------------------
+
+package ZOOM::Package;
+
+sub new {
+    my $class = shift();
+    die "You can't create $class objects directly";
+}
+
+# PRIVATE to ZOOM::Connection::package(),
+sub _new {
+    my $class = shift();
+    my($conn, $options, $_p) = @_;
+
+    return bless {
+	conn => $conn,
+	options => $options,
+	_p => $_p,
+    }, $class;
+}
+
+# PRIVATE to this class
+sub _p {
+    my $this = shift();
+
+    my $_p = $this->{_p};
+    die "{_p} undefined: has this Package been destroy()ed?"
+	if !defined $_p;
+
+    return $_p;
+}
+
+sub option {
+    my $this = shift();
+    my($key, $value) = @_;
+
+    my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
+    Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
+	if defined $value;
+
+    return $oldval;
+}
+
+sub send {
+    my $this = shift();
+    my($type) = @_;
+
+    Net::Z3950::ZOOM::package_send($this->_p(), $type);
+    $this->{conn}->_check();
+}
+
+sub destroy {
+    my $this = shift();
+
+    Net::Z3950::ZOOM::package_destroy($this->_p());
+    $this->{_p} = undef;
+}
+
 
 1;