1 # $Id: ZOOM.pm,v 1.24 2005-12-21 17:01:41 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 sub CQL_PARSE { Net::Z3950::ZOOM::ERROR_CQL_PARSE }
44 sub CQL_TRANSFORM { Net::Z3950::ZOOM::ERROR_CQL_TRANSFORM }
45 # The following are added specifically for this OO interface
46 sub CREATE_QUERY { 20001 }
47 sub QUERY_CQL { 20002 }
48 sub QUERY_PQF { 20003 }
52 sub SCANTERM { 20007 }
54 # The "Event" package contains constants returned by last_event()
56 sub NONE { Net::Z3950::ZOOM::EVENT_NONE }
57 sub CONNECT { Net::Z3950::ZOOM::EVENT_CONNECT }
58 sub SEND_DATA { Net::Z3950::ZOOM::EVENT_SEND_DATA }
59 sub RECV_DATA { Net::Z3950::ZOOM::EVENT_RECV_DATA }
60 sub TIMEOUT { Net::Z3950::ZOOM::EVENT_TIMEOUT }
61 sub UNKNOWN { Net::Z3950::ZOOM::EVENT_UNKNOWN }
62 sub SEND_APDU { Net::Z3950::ZOOM::EVENT_SEND_APDU }
63 sub RECV_APDU { Net::Z3950::ZOOM::EVENT_RECV_APDU }
64 sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
65 sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
67 # ----------------------------------------------------------------------------
74 # Special cases for error specific to the OO layer
75 if ($code == ZOOM::Error::CREATE_QUERY) {
76 return "can't create query object";
77 } elsif ($code == ZOOM::Error::QUERY_CQL) {
78 return "can't set CQL query";
79 } elsif ($code == ZOOM::Error::QUERY_PQF) {
80 return "can't set prefix query";
81 } elsif ($code == ZOOM::Error::SORTBY) {
82 return "can't set sort-specification";
83 } elsif ($code == ZOOM::Error::CLONE) {
84 return "can't clone record";
85 } elsif ($code == ZOOM::Error::PACKAGE) {
86 return "can't create package";
87 } elsif ($code == ZOOM::Error::SCANTERM) {
88 return "can't retrieve term from scan-set";
91 return Net::Z3950::ZOOM::diag_str($code);
95 my($code, $addinfo, $diagset) = @_;
97 die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
100 # ----------------------------------------------------------------------------
102 package ZOOM::Exception;
106 my($code, $message, $addinfo, $diagset) = @_;
112 diagset => $diagset || "ZOOM",
118 return $this->{code};
123 return $this->{message};
128 return $this->{addinfo};
133 return $this->{diagset};
138 my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
139 $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
140 $res .= " from diag-set '" . $this->diagset() . "'" if $this->diagset();
144 # This means that untrapped exceptions render nicely.
145 use overload '""' => \&render;
147 # ----------------------------------------------------------------------------
149 package ZOOM::Options;
157 $opts = Net::Z3950::ZOOM::options_create();
159 $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
161 $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
164 die "can't make $class object with more than 2 parents";
172 # PRIVATE to this class and ZOOM::Connection::create() and
173 # ZOOM::Connection::package()
178 my $_opts = $this->{_opts};
179 die "{_opts} undefined: has this Options block been destroy()ed?"
187 my($key, $value) = @_;
189 my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
190 Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
198 my($key, $value) = @_;
201 my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
203 Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
204 $value, length($value))
210 # This is a bit stupid, since the scalar values that Perl returns from
211 # option() can be used as a boolean; but it's just possible that some
212 # applications will rely on ZOOM_options_get_bool()'s idiosyncratic
213 # interpretation of what constitutes truth.
217 my($key, $default) = @_;
219 return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
222 # .. and the next two are even more stupid
225 my($key, $default) = @_;
227 return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
232 my($key, $value) = @_;
234 Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
237 # ### Feel guilty. Feel very, very guilty. I've not been able to
238 # get the callback memory-management right in "ZOOM.xs", with
239 # the result that the values of $function and $udata passed into
240 # this function, which are on the stack, have sometimes been
241 # freed by the time they're used by __ZOOM_option_callback(),
242 # with hilarious results. To avoid this, I copy the values into
243 # module-scoped globals, and pass _those_ into the extension
244 # function. To avoid overwriting those globals by subsequent
245 # calls, I keep all the old ones, pushed onto the @_function and
246 # @_udata arrays, which means that THIS FUNCTION LEAKS MEMORY
247 # LIKE IT'S GOING OUT OF FASHION. Not nice. One day, I should
248 # fix this, but for now there's more important fish to fry.
250 my(@_function, @_udata);
253 my($function, $udata) = @_;
255 push @_function, $function;
256 push @_udata, $udata;
257 Net::Z3950::ZOOM::options_set_callback($o1->_opts(),
258 $_function[-1], $_udata[-1]);
264 Net::Z3950::ZOOM::options_destroy($this->_opts());
265 $this->{_opts} = undef;
269 # ----------------------------------------------------------------------------
271 package ZOOM::Connection;
275 my($host, $port) = @_;
277 my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
287 # PRIVATE to this class and to ZOOM::Query::CQL2RPN::new()
291 my $_conn = $this->{_conn};
292 die "{_conn} undefined: has this Connection been destroy()ed?"
301 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "x", "x", "x");
302 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
304 die new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset)
312 my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
323 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
324 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
326 return ($errcode, $errmsg, $addinfo, $diagset);
331 return Net::Z3950::ZOOM::connection_errcode($this->_conn());
336 return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
341 return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
346 return Net::Z3950::ZOOM::connection_diagset($this->_conn());
351 my($host, $port) = @_;
353 Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
360 my($key, $value) = @_;
362 my $oldval = Net::Z3950::ZOOM::connection_option_get($this->_conn(), $key);
363 Net::Z3950::ZOOM::connection_option_set($this->_conn(), $key, $value)
371 my($key, $value) = @_;
374 my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
376 Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
377 $value, length($value))
387 my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
390 return _new ZOOM::ResultSet($this, $query, $_rs);
397 my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
399 return _new ZOOM::ResultSet($this, $pqf, $_rs);
406 my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
408 return _new ZOOM::ScanSet($this, $startterm, $_ss);
415 my $_ss = Net::Z3950::ZOOM::connection_scan1($this->_conn(),
418 return _new ZOOM::ScanSet($this, $query, $_ss);
425 my $_o = defined $options ? $options->_opts() :
426 Net::Z3950::ZOOM::options_create();
427 my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
428 or ZOOM::_oops(ZOOM::Error::PACKAGE);
430 return _new ZOOM::Package($this, $options, $_p);
436 Net::Z3950::ZOOM::connection_destroy($this->_conn());
437 $this->{_conn} = undef;
441 # ----------------------------------------------------------------------------
447 die "You can't create $class objects: it's a virtual base class";
450 # PRIVATE to this class and ZOOM::Connection::search()
454 my $_query = $this->{_query};
455 die "{_query} undefined: has this Query been destroy()ed?"
465 Net::Z3950::ZOOM::query_sortby($this->_query(), $sortby) == 0
466 or ZOOM::_oops(ZOOM::Error::SORTBY, $sortby);
472 Net::Z3950::ZOOM::query_destroy($this->_query());
473 $this->{_query} = undef;
477 package ZOOM::Query::CQL;
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_cql($q, $string) == 0
487 or ZOOM::_oops(ZOOM::Error::QUERY_CQL, $string);
495 package ZOOM::Query::CQL2RPN;
496 our @ISA = qw(ZOOM::Query);
500 my($string, $conn) = @_;
502 my $q = Net::Z3950::ZOOM::query_create()
503 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
504 # check() throws the exception we want; but we only want it on failure!
505 Net::Z3950::ZOOM::query_cql2rpn($q, $string, $conn->_conn()) == 0
514 package ZOOM::Query::PQF;
515 our @ISA = qw(ZOOM::Query);
521 my $q = Net::Z3950::ZOOM::query_create()
522 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
523 Net::Z3950::ZOOM::query_prefix($q, $string) == 0
524 or ZOOM::_oops(ZOOM::Error::QUERY_PQF, $string);
532 # ----------------------------------------------------------------------------
534 package ZOOM::ResultSet;
538 die "You can't create $class objects directly";
541 # PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
544 my($conn, $query, $_rs) = @_;
548 query => $query, # This is not currently used, which is
549 # just as well since it could be
550 # either a string (when the RS is
551 # created with search_pqf()) or a
552 # ZOOM::Query object (when it's
553 # created with search())
558 # PRIVATE to this class
562 my $_rs = $this->{_rs};
563 die "{_rs} undefined: has this ResultSet been destroy()ed?"
571 my($key, $value) = @_;
573 my $oldval = Net::Z3950::ZOOM::resultset_option_get($this->_rs(), $key);
574 Net::Z3950::ZOOM::resultset_option_set($this->_rs(), $key, $value)
583 return Net::Z3950::ZOOM::resultset_size($this->_rs());
590 my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
591 $this->{conn}->_check();
593 # Even if no error has occurred, I think record() might
594 # legitimately return undef if we're running in asynchronous mode
595 # and the record just hasn't been retrieved yet. This goes double
596 # for record_immediate().
597 return undef if !defined $_rec;
599 # For some reason, I have to use the explicit "->" syntax in order
600 # to invoke the ZOOM::Record constructor here, even though I don't
601 # have to do the same for _new ZOOM::ResultSet above. Weird.
602 return ZOOM::Record->_new($this, $which, $_rec);
605 sub record_immediate {
609 my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
611 $this->{conn}->_check();
612 # The record might legitimately not be there yet
613 return undef if !defined $_rec;
615 return ZOOM::Record->_new($this, $which, $_rec);
621 Net::Z3950::ZOOM::resultset_cache_reset($this->_rs());
626 my($start, $count, $return_records) = @_;
628 my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
630 # By design, $raw may be undefined (if $return_records is true)
631 return undef if !defined $raw;
633 # We need to package up the returned records in ZOOM::Record objects
635 for my $i (0 .. @$raw-1) {
636 my $_rec = $raw->[$i];
637 if (!defined $_rec) {
640 push @res, ZOOM::Record->_new($this, $start+$i, $_rec);
649 my($sort_type, $sort_spec) = @_;
651 return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
652 $sort_type, $sort_spec);
658 Net::Z3950::ZOOM::resultset_destroy($this->_rs());
659 $this->{_rs} = undef;
663 # ----------------------------------------------------------------------------
665 package ZOOM::Record;
669 die "You can't create $class objects directly";
672 # PRIVATE to ZOOM::ResultSet::record(),
673 # ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
674 # ZOOM::Record::clone()
678 my($rs, $which, $_rec) = @_;
687 # PRIVATE to this class
691 my $_rec = $this->{_rec};
692 die "{_rec} undefined: has this Record been destroy()ed?"
702 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "render", $len);
703 # I don't think we need '$len' at all. ### Probably the Perl-to-C
704 # glue code should use the value of `len' as well as the opaque
705 # data-pointer returned, to ensure that the SV contains all of the
706 # returned data and does not stop at the first NUL character in
707 # binary data. Carefully check the ZOOM_record_get() documentation.
715 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
716 # See comment about $len in render()
723 my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
724 or ZOOM::_oops(ZOOM::Error::CLONE);
726 # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
727 return _new ZOOM::Record(undef, undef, $raw);
733 Net::Z3950::ZOOM::record_destroy($this->_rec());
734 $this->{_rec} = undef;
738 # ----------------------------------------------------------------------------
740 package ZOOM::ScanSet;
744 die "You can't create $class objects directly";
747 # PRIVATE to ZOOM::Connection::scan(),
750 my($conn, $startterm, $_ss) = @_;
754 startterm => $startterm,# This is not currently used, which is
755 # just as well since it could be
756 # either a string (when the SS is
757 # created with scan()) or a
758 # ZOOM::Query object (when it's
759 # created with scan1())
764 # PRIVATE to this class
768 my $_ss = $this->{_ss};
769 die "{_ss} undefined: has this ScanSet been destroy()ed?"
777 my($key, $value) = @_;
779 my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
780 Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
789 return Net::Z3950::ZOOM::scanset_size($this->_ss());
796 my($occ, $len) = (0, 0);
797 my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
799 or ZOOM::_oops(ZOOM::Error::SCANTERM);
801 die "length of term '$term' differs from returned len=$len"
802 if length($term) != $len;
804 return ($term, $occ);
811 my($occ, $len) = (0, 0);
812 my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
814 or ZOOM::_oops(ZOOM::Error::SCANTERM);
816 die "length of display term '$term' differs from returned len=$len"
817 if length($term) != $len;
819 return ($term, $occ);
825 Net::Z3950::ZOOM::scanset_destroy($this->_ss());
826 $this->{_ss} = undef;
830 # ----------------------------------------------------------------------------
832 package ZOOM::Package;
836 die "You can't create $class objects directly";
839 # PRIVATE to ZOOM::Connection::package(),
842 my($conn, $options, $_p) = @_;
851 # PRIVATE to this class
855 my $_p = $this->{_p};
856 die "{_p} undefined: has this Package been destroy()ed?"
864 my($key, $value) = @_;
866 my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
867 Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
877 Net::Z3950::ZOOM::package_send($this->_p(), $type);
878 $this->{conn}->_check();
884 Net::Z3950::ZOOM::package_destroy($this->_p());
889 # There follows trivial support for YAZ logging. This is wired out
890 # into the Net::Z3950::ZOOM package, and we here provide wrapper
891 # functions -- nothing more than aliases, really -- in the ZOOM::Log
892 # package. There really is no point in inventing an OO interface.
894 # Passing @_ directly to the underlying Net::Z3950::ZOOM::* functions
895 # doesn't work, for reasons that I can't begin to fathom, and that
896 # don't particularly interest me. Unpacking into scalars and passing
897 # those _does_ work, so that's what we do.
901 sub mask_str { my($a) = @_; Net::Z3950::ZOOM::yaz_log_mask_str($a); }
902 sub init { my($a, $b, $c) = @_;
903 Net::Z3950::ZOOM::yaz_log_init($a, $b, $c) }
904 sub init_file { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_file($a) }
905 sub init_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_level($a) }
906 sub init_prefix { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_prefix($a) }
907 sub time_format { my($a) = @_; Net::Z3950::ZOOM::yaz_log_time_format($a) }
908 sub init_max_size { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_max_size($a) }
909 sub log { my($a,$b) = @_; Net::Z3950::ZOOM::yaz_log($a, $b) }