1 # $Id: ZOOM.pm,v 1.18 2005-11-16 14:49:30 mike Exp $
11 # Member naming convention: hash-element names which begin with an
12 # underscore represent underlying ZOOM-C object descriptors; those
13 # which lack them represent Perl's ZOOM objects. (The same convention
14 # is used in naming local variables where appropriate.)
16 # So, for example, the ZOOM::Connection class has an {_conn} element,
17 # which is a pointer to the ZOOM-C Connection object; but the
18 # ZOOM::ResultSet class has a {conn} element, which is a reference to
19 # the Perl-level Connection object by which it was created. (It may
20 # be that we find we have no need for these references, but for now
23 # To get at the underlying ZOOM-C connection object of a result-set
24 # (if you ever needed to do such a thing, which you probably don't)
25 # you'd use $rs->{conn}->_conn().
27 # ----------------------------------------------------------------------------
29 # The "Error" package contains constants returned as error-codes.
31 sub NONE { Net::Z3950::ZOOM::ERROR_NONE }
32 sub CONNECT { Net::Z3950::ZOOM::ERROR_CONNECT }
33 sub MEMORY { Net::Z3950::ZOOM::ERROR_MEMORY }
34 sub ENCODE { Net::Z3950::ZOOM::ERROR_ENCODE }
35 sub DECODE { Net::Z3950::ZOOM::ERROR_DECODE }
36 sub CONNECTION_LOST { Net::Z3950::ZOOM::ERROR_CONNECTION_LOST }
37 sub INIT { Net::Z3950::ZOOM::ERROR_INIT }
38 sub INTERNAL { Net::Z3950::ZOOM::ERROR_INTERNAL }
39 sub TIMEOUT { Net::Z3950::ZOOM::ERROR_TIMEOUT }
40 sub UNSUPPORTED_PROTOCOL { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_PROTOCOL }
41 sub UNSUPPORTED_QUERY { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_QUERY }
42 sub INVALID_QUERY { Net::Z3950::ZOOM::ERROR_INVALID_QUERY }
43 # The following are added specifically for this OO interface
44 sub CREATE_QUERY { 20001 }
45 sub QUERY_CQL { 20002 }
46 sub QUERY_PQF { 20003 }
51 # The "Event" package contains constants returned by last_event()
53 sub NONE { Net::Z3950::ZOOM::EVENT_NONE }
54 sub CONNECT { Net::Z3950::ZOOM::EVENT_CONNECT }
55 sub SEND_DATA { Net::Z3950::ZOOM::EVENT_SEND_DATA }
56 sub RECV_DATA { Net::Z3950::ZOOM::EVENT_RECV_DATA }
57 sub TIMEOUT { Net::Z3950::ZOOM::EVENT_TIMEOUT }
58 sub UNKNOWN { Net::Z3950::ZOOM::EVENT_UNKNOWN }
59 sub SEND_APDU { Net::Z3950::ZOOM::EVENT_SEND_APDU }
60 sub RECV_APDU { Net::Z3950::ZOOM::EVENT_RECV_APDU }
61 sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
62 sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
64 # ----------------------------------------------------------------------------
71 # Special cases for error specific to the OO layer
72 if ($code == ZOOM::Error::CREATE_QUERY) {
73 return "can't create query object";
74 } elsif ($code == ZOOM::Error::QUERY_CQL) {
75 return "can't set CQL query";
76 } elsif ($code == ZOOM::Error::QUERY_PQF) {
77 return "can't set prefix query";
78 } elsif ($code == ZOOM::Error::SORTBY) {
79 return "can't set sort-specification";
80 } elsif ($code == ZOOM::Error::CLONE) {
81 return "can't clone record";
82 } elsif ($code == ZOOM::Error::PACKAGE) {
83 return "can't create package";
86 return Net::Z3950::ZOOM::diag_str($code);
89 ### More of the ZOOM::Exception instantiations should use this
91 my($code, $addinfo) = @_;
93 die new ZOOM::Exception($code, diag_str($code), $addinfo);
96 # ----------------------------------------------------------------------------
98 package ZOOM::Exception;
102 my($code, $message, $addinfo) = @_;
103 ### support diag-set, too
114 return $this->{code};
119 return $this->{message};
124 return $this->{addinfo};
129 my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
130 $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
134 # This means that untrapped exceptions render nicely.
135 use overload '""' => \&render;
137 # ----------------------------------------------------------------------------
139 package ZOOM::Options;
147 $opts = Net::Z3950::ZOOM::options_create();
149 $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
151 $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
154 die "can't make $class object with more than 2 parents";
162 # PRIVATE to this class and ZOOM::Connection::create() and
163 # ZOOM::Connection::package()
168 my $_opts = $this->{_opts};
169 die "{_opts} undefined: has this Options block been destroy()ed?"
177 my($key, $value) = @_;
179 my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
180 Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
188 my($key, $value) = @_;
191 my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
193 Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
194 $value, length($value))
200 # This is a bit stupid, since the scalar values that Perl returns from
201 # option() can be used as a boolean; but it's just possible that some
202 # applications will rely on ZOOM_options_get_bool()'s idiosyncratic
203 # interpretation of what constitutes truth.
207 my($key, $default) = @_;
209 return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
212 # .. and the next two are even more stupid
215 my($key, $default) = @_;
217 return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
222 my($key, $value) = @_;
224 Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
227 # ### Feel guilty. Feel very, very guilty. I've not been able to
228 # get the callback memory-management right in "ZOOM.xs", with
229 # the result that the values of $function and $udata passed into
230 # this function, which are on the stack, have sometimes been
231 # freed by the time they're used by __ZOOM_option_callback(),
232 # with hilarious results. To avoid this, I copy the values into
233 # module-scoped globals, and pass _those_ into the extension
234 # function. To avoid overwriting those globals by subsequent
235 # calls, I keep all the old ones, pushed onto the @_function and
236 # @_udata arrays, which means that THIS FUNCTION LEAKS MEMORY
237 # LIKE IT'S GOING OUT OF FASHION. Not nice. One day, I should
238 # fix this, but for now there's more important fish to fry.
240 my(@_function, @_udata);
243 my($function, $udata) = @_;
245 push @_function, $function;
246 push @_udata, $udata;
247 Net::Z3950::ZOOM::options_set_callback($o1->_opts(),
248 $_function[-1], $_udata[-1]);
254 Net::Z3950::ZOOM::options_destroy($this->_opts());
255 $this->{_opts} = undef;
259 # ----------------------------------------------------------------------------
261 package ZOOM::Connection;
265 my($host, $port) = @_;
267 my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
268 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
269 $errcode = Net::Z3950::ZOOM::connection_error($_conn, $errmsg, $addinfo);
270 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
283 my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
291 # PRIVATE to this class
295 my $_conn = $this->{_conn};
296 die "{_conn} undefined: has this Connection been destroy()ed?"
305 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
306 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
308 return ($errcode, $errmsg, $addinfo, $diagset);
313 return Net::Z3950::ZOOM::connection_errcode($this->_conn());
318 return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
323 return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
328 my($host, $port) = @_;
330 Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
331 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
332 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
334 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
340 my($key, $value) = @_;
342 my $oldval = Net::Z3950::ZOOM::connection_option_get($this->_conn(), $key);
343 Net::Z3950::ZOOM::connection_option_set($this->_conn(), $key, $value)
351 my($key, $value) = @_;
354 my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
356 Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
357 $value, length($value))
367 my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
369 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
370 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
372 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
374 return _new ZOOM::ResultSet($this, $query, $_rs);
381 my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
382 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
383 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
385 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
387 return _new ZOOM::ResultSet($this, $pqf, $_rs);
394 my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
395 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
396 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
398 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
400 return _new ZOOM::ScanSet($this, $startterm, $_ss);
407 my $_o = defined $options ? $options->_opts() :
408 Net::Z3950::ZOOM::options_create();
409 my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
410 or ZOOM::_oops(ZOOM::Error::PACKAGE);
412 return _new ZOOM::Package($this, $options, $_p);
418 Net::Z3950::ZOOM::connection_destroy($this->_conn());
419 $this->{_conn} = undef;
423 # ----------------------------------------------------------------------------
429 die "You can't create $class objects: it's a virtual base class";
432 # PRIVATE to this class and ZOOM::Connection::search()
436 my $_query = $this->{_query};
437 die "{_query} undefined: has this Query been destroy()ed?"
447 Net::Z3950::ZOOM::query_sortby($this->_query(), $sortby) == 0
448 or ZOOM::_oops(ZOOM::Error::SORTBY, $sortby);
454 Net::Z3950::ZOOM::query_destroy($this->_query());
455 $this->{_query} = undef;
459 package ZOOM::Query::CQL;
460 our @ISA = qw(ZOOM::Query);
466 my $q = Net::Z3950::ZOOM::query_create()
467 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
468 Net::Z3950::ZOOM::query_cql($q, $string) == 0
469 or ZOOM::_oops(ZOOM::Error::QUERY_CQL, $string);
477 package ZOOM::Query::PQF;
478 our @ISA = qw(ZOOM::Query);
484 my $q = Net::Z3950::ZOOM::query_create()
485 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
486 Net::Z3950::ZOOM::query_prefix($q, $string) == 0
487 or ZOOM::_oops(ZOOM::Error::QUERY_PQF, $string);
495 # ----------------------------------------------------------------------------
497 package ZOOM::ResultSet;
501 die "You can't create $class objects directly";
504 # PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
507 my($conn, $query, $_rs) = @_;
511 query => $query, # This is not currently used, which is
512 # just as well since it could be
513 # either a string (when the RS is
514 # created with search_pqf()) or a
515 # ZOOM::Query object (when it's
516 # created with search())
521 # PRIVATE to this class
525 my $_rs = $this->{_rs};
526 die "{_rs} undefined: has this ResultSet been destroy()ed?"
534 my($key, $value) = @_;
536 my $oldval = Net::Z3950::ZOOM::resultset_option_get($this->_rs(), $key);
537 Net::Z3950::ZOOM::resultset_option_set($this->_rs(), $key, $value)
546 return Net::Z3950::ZOOM::resultset_size($this->_rs());
553 my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
554 ### Check for error -- but how?
555 return undef if !defined $_rec;
557 # For some reason, I have to use the explicit "->" syntax in order
558 # to invoke the ZOOM::Record constructor here, even though I don't
559 # have to do the same for _new ZOOM::ResultSet above. Weird.
560 return ZOOM::Record->_new($this, $which, $_rec);
563 sub record_immediate {
567 my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
569 ### Check for error -- but how?
570 return undef if !defined $_rec;
572 return ZOOM::Record->_new($this, $which, $_rec);
578 Net::Z3950::ZOOM::resultset_cache_reset($this->_rs());
583 my($start, $count, $return_records) = @_;
585 my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
587 ### Why don't we throw an exception if $raw is undefined?
588 return undef if !defined $raw;
590 # We need to package up the returned records in ZOOM::Record objects
592 for my $i (0 .. @$raw-1) {
593 my $_rec = $raw->[$i];
594 if (!defined $_rec) {
597 push @res, ZOOM::Record->_new($this, $start+$i, $_rec);
606 my($sort_type, $sort_spec) = @_;
608 return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
609 $sort_type, $sort_spec);
615 Net::Z3950::ZOOM::resultset_destroy($this->_rs());
616 $this->{_rs} = undef;
620 # ----------------------------------------------------------------------------
622 package ZOOM::Record;
626 die "You can't create $class objects directly";
629 # PRIVATE to ZOOM::ResultSet::record(),
630 # ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
631 # ZOOM::Record::clone()
635 my($rs, $which, $_rec) = @_;
644 # PRIVATE to this class
648 my $_rec = $this->{_rec};
649 die "{_rec} undefined: has this Record been destroy()ed?"
659 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "render", $len);
660 # I don't think we need '$len' at all. ### Probably the Perl-to-C
661 # glue code should use the value of `len' as well as the opaque
662 # data-pointer returned, to ensure that the SV contains all of the
663 # returned data and does not stop at the first NUL character in
664 # binary data. Carefully check the ZOOM_record_get() documentation.
672 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
673 # See comment about $len in render()
680 my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
681 or ZOOM::_oops(ZOOM::Error::CLONE);
683 # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
684 return _new ZOOM::Record(undef, undef, $raw);
690 Net::Z3950::ZOOM::record_destroy($this->_rec());
691 $this->{_rec} = undef;
695 # ----------------------------------------------------------------------------
697 package ZOOM::ScanSet;
701 die "You can't create $class objects directly";
704 # PRIVATE to ZOOM::Connection::scan(),
707 my($conn, $startterm, $_ss) = @_;
711 startterm => $startterm,
716 # PRIVATE to this class
720 my $_ss = $this->{_ss};
721 die "{_ss} undefined: has this ScanSet been destroy()ed?"
729 my($key, $value) = @_;
731 my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
732 Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
741 return Net::Z3950::ZOOM::scanset_size($this->_ss());
748 my($occ, $len) = (0, 0);
749 my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
752 return undef if !defined $term;
753 die "length of term '$term' differs from returned len=$len"
754 if length($term) != $len;
756 return ($term, $occ);
763 my($occ, $len) = (0, 0);
764 my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
767 return undef if !defined $term;
768 die "length of display term '$term' differs from returned len=$len"
769 if length($term) != $len;
771 return ($term, $occ);
777 Net::Z3950::ZOOM::scanset_destroy($this->_ss());
778 $this->{_ss} = undef;
782 # ----------------------------------------------------------------------------
784 package ZOOM::Package;
788 die "You can't create $class objects directly";
791 # PRIVATE to ZOOM::Connection::package(),
794 my($conn, $options, $_p) = @_;
803 # PRIVATE to this class
807 my $_p = $this->{_p};
808 die "{_p} undefined: has this Package been destroy()ed?"
816 my($key, $value) = @_;
818 my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
819 Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
829 Net::Z3950::ZOOM::package_send($this->_p(), $type);
830 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
831 $errcode = Net::Z3950::ZOOM::connection_error($this->{conn}->_conn(),
833 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
839 Net::Z3950::ZOOM::package_destroy($this->_p());