1 # $Id: ZOOM.pm,v 1.26 2006-02-10 16:24:34 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 }
53 sub LOGLEVEL { 20008 }
55 # The "Event" package contains constants returned by last_event()
57 sub NONE { Net::Z3950::ZOOM::EVENT_NONE }
58 sub CONNECT { Net::Z3950::ZOOM::EVENT_CONNECT }
59 sub SEND_DATA { Net::Z3950::ZOOM::EVENT_SEND_DATA }
60 sub RECV_DATA { Net::Z3950::ZOOM::EVENT_RECV_DATA }
61 sub TIMEOUT { Net::Z3950::ZOOM::EVENT_TIMEOUT }
62 sub UNKNOWN { Net::Z3950::ZOOM::EVENT_UNKNOWN }
63 sub SEND_APDU { Net::Z3950::ZOOM::EVENT_SEND_APDU }
64 sub RECV_APDU { Net::Z3950::ZOOM::EVENT_RECV_APDU }
65 sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
66 sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
68 # ----------------------------------------------------------------------------
75 # Special cases for error specific to the OO layer
76 if ($code == ZOOM::Error::CREATE_QUERY) {
77 return "can't create query object";
78 } elsif ($code == ZOOM::Error::QUERY_CQL) {
79 return "can't set CQL query";
80 } elsif ($code == ZOOM::Error::QUERY_PQF) {
81 return "can't set prefix query";
82 } elsif ($code == ZOOM::Error::SORTBY) {
83 return "can't set sort-specification";
84 } elsif ($code == ZOOM::Error::CLONE) {
85 return "can't clone record";
86 } elsif ($code == ZOOM::Error::PACKAGE) {
87 return "can't create package";
88 } elsif ($code == ZOOM::Error::SCANTERM) {
89 return "can't retrieve term from scan-set";
90 } elsif ($code == ZOOM::Error::LOGLEVEL) {
91 return "unregistered log-level";
94 return Net::Z3950::ZOOM::diag_str($code);
98 my($code, $addinfo, $diagset) = @_;
100 die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
103 # ----------------------------------------------------------------------------
105 package ZOOM::Exception;
109 my($code, $message, $addinfo, $diagset) = @_;
115 diagset => $diagset || "ZOOM",
121 return $this->{code};
126 return $this->{message};
131 return $this->{addinfo};
136 return $this->{diagset};
141 my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
142 $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
143 $res .= " from diag-set '" . $this->diagset() . "'" if $this->diagset();
147 # This means that untrapped exceptions render nicely.
148 use overload '""' => \&render;
150 # ----------------------------------------------------------------------------
152 package ZOOM::Options;
160 $opts = Net::Z3950::ZOOM::options_create();
162 $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
164 $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
167 die "can't make $class object with more than 2 parents";
175 # PRIVATE to this class and ZOOM::Connection::create() and
176 # ZOOM::Connection::package()
181 my $_opts = $this->{_opts};
182 die "{_opts} undefined: has this Options block been destroy()ed?"
190 my($key, $value) = @_;
192 my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
193 Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
201 my($key, $value) = @_;
204 my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
206 Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
207 $value, length($value))
213 # This is a bit stupid, since the scalar values that Perl returns from
214 # option() can be used as a boolean; but it's just possible that some
215 # applications will rely on ZOOM_options_get_bool()'s idiosyncratic
216 # interpretation of what constitutes truth.
220 my($key, $default) = @_;
222 return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
225 # .. and the next two are even more stupid
228 my($key, $default) = @_;
230 return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
235 my($key, $value) = @_;
237 Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
240 # ### Feel guilty. Feel very, very guilty. I've not been able to
241 # get the callback memory-management right in "ZOOM.xs", with
242 # the result that the values of $function and $udata passed into
243 # this function, which are on the stack, have sometimes been
244 # freed by the time they're used by __ZOOM_option_callback(),
245 # with hilarious results. To avoid this, I copy the values into
246 # module-scoped globals, and pass _those_ into the extension
247 # function. To avoid overwriting those globals by subsequent
248 # calls, I keep all the old ones, pushed onto the @_function and
249 # @_udata arrays, which means that THIS FUNCTION LEAKS MEMORY
250 # LIKE IT'S GOING OUT OF FASHION. Not nice. One day, I should
251 # fix this, but for now there's more important fish to fry.
253 my(@_function, @_udata);
256 my($function, $udata) = @_;
258 push @_function, $function;
259 push @_udata, $udata;
260 Net::Z3950::ZOOM::options_set_callback($o1->_opts(),
261 $_function[-1], $_udata[-1]);
267 Net::Z3950::ZOOM::options_destroy($this->_opts());
268 $this->{_opts} = undef;
272 # ----------------------------------------------------------------------------
274 package ZOOM::Connection;
278 my($host, $port) = @_;
280 my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
290 # PRIVATE to this class and to ZOOM::Query::CQL2RPN::new()
294 my $_conn = $this->{_conn};
295 die "{_conn} undefined: has this Connection been destroy()ed?"
304 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "x", "x", "x");
305 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
307 die new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset)
315 my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
326 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
327 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
329 return ($errcode, $errmsg, $addinfo, $diagset);
334 return Net::Z3950::ZOOM::connection_errcode($this->_conn());
339 return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
344 return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
349 return Net::Z3950::ZOOM::connection_diagset($this->_conn());
354 my($host, $port) = @_;
356 $port = 0 if !defined $port;
357 Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
364 my($key, $value) = @_;
366 my $oldval = Net::Z3950::ZOOM::connection_option_get($this->_conn(), $key);
367 Net::Z3950::ZOOM::connection_option_set($this->_conn(), $key, $value)
375 my($key, $value) = @_;
378 my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
380 Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
381 $value, length($value))
391 my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
394 return _new ZOOM::ResultSet($this, $query, $_rs);
401 my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
403 return _new ZOOM::ResultSet($this, $pqf, $_rs);
410 my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
412 return _new ZOOM::ScanSet($this, $startterm, $_ss);
419 my $_ss = Net::Z3950::ZOOM::connection_scan1($this->_conn(),
422 return _new ZOOM::ScanSet($this, $query, $_ss);
429 my $_o = defined $options ? $options->_opts() :
430 Net::Z3950::ZOOM::options_create();
431 my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
432 or ZOOM::_oops(ZOOM::Error::PACKAGE);
434 return _new ZOOM::Package($this, $options, $_p);
440 Net::Z3950::ZOOM::connection_destroy($this->_conn());
441 $this->{_conn} = undef;
445 # ----------------------------------------------------------------------------
451 die "You can't create $class objects: it's a virtual base class";
454 # PRIVATE to this class and ZOOM::Connection::search()
458 my $_query = $this->{_query};
459 die "{_query} undefined: has this Query been destroy()ed?"
469 Net::Z3950::ZOOM::query_sortby($this->_query(), $sortby) == 0
470 or ZOOM::_oops(ZOOM::Error::SORTBY, $sortby);
476 Net::Z3950::ZOOM::query_destroy($this->_query());
477 $this->{_query} = undef;
481 package ZOOM::Query::CQL;
482 our @ISA = qw(ZOOM::Query);
488 my $q = Net::Z3950::ZOOM::query_create()
489 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
490 Net::Z3950::ZOOM::query_cql($q, $string) == 0
491 or ZOOM::_oops(ZOOM::Error::QUERY_CQL, $string);
499 package ZOOM::Query::CQL2RPN;
500 our @ISA = qw(ZOOM::Query);
504 my($string, $conn) = @_;
506 my $q = Net::Z3950::ZOOM::query_create()
507 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
508 # check() throws the exception we want; but we only want it on failure!
509 Net::Z3950::ZOOM::query_cql2rpn($q, $string, $conn->_conn()) == 0
518 package ZOOM::Query::PQF;
519 our @ISA = qw(ZOOM::Query);
525 my $q = Net::Z3950::ZOOM::query_create()
526 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
527 Net::Z3950::ZOOM::query_prefix($q, $string) == 0
528 or ZOOM::_oops(ZOOM::Error::QUERY_PQF, $string);
536 # ----------------------------------------------------------------------------
538 package ZOOM::ResultSet;
542 die "You can't create $class objects directly";
545 # PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
548 my($conn, $query, $_rs) = @_;
552 query => $query, # This is not currently used, which is
553 # just as well since it could be
554 # either a string (when the RS is
555 # created with search_pqf()) or a
556 # ZOOM::Query object (when it's
557 # created with search())
562 # PRIVATE to this class
566 my $_rs = $this->{_rs};
567 die "{_rs} undefined: has this ResultSet been destroy()ed?"
575 my($key, $value) = @_;
577 my $oldval = Net::Z3950::ZOOM::resultset_option_get($this->_rs(), $key);
578 Net::Z3950::ZOOM::resultset_option_set($this->_rs(), $key, $value)
587 return Net::Z3950::ZOOM::resultset_size($this->_rs());
594 my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
595 $this->{conn}->_check();
597 # Even if no error has occurred, I think record() might
598 # legitimately return undef if we're running in asynchronous mode
599 # and the record just hasn't been retrieved yet. This goes double
600 # for record_immediate().
601 return undef if !defined $_rec;
603 # For some reason, I have to use the explicit "->" syntax in order
604 # to invoke the ZOOM::Record constructor here, even though I don't
605 # have to do the same for _new ZOOM::ResultSet above. Weird.
606 return ZOOM::Record->_new($this, $which, $_rec);
609 sub record_immediate {
613 my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
615 $this->{conn}->_check();
616 # The record might legitimately not be there yet
617 return undef if !defined $_rec;
619 return ZOOM::Record->_new($this, $which, $_rec);
625 Net::Z3950::ZOOM::resultset_cache_reset($this->_rs());
630 my($start, $count, $return_records) = @_;
632 my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
634 # By design, $raw may be undefined (if $return_records is true)
635 return undef if !defined $raw;
637 # We need to package up the returned records in ZOOM::Record objects
639 for my $i (0 .. @$raw-1) {
640 my $_rec = $raw->[$i];
641 if (!defined $_rec) {
644 push @res, ZOOM::Record->_new($this, $start+$i, $_rec);
653 my($sort_type, $sort_spec) = @_;
655 return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
656 $sort_type, $sort_spec);
662 Net::Z3950::ZOOM::resultset_destroy($this->_rs());
663 $this->{_rs} = undef;
667 # ----------------------------------------------------------------------------
669 package ZOOM::Record;
673 die "You can't create $class objects directly";
676 # PRIVATE to ZOOM::ResultSet::record(),
677 # ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
678 # ZOOM::Record::clone()
682 my($rs, $which, $_rec) = @_;
691 # PRIVATE to this class
695 my $_rec = $this->{_rec};
696 die "{_rec} undefined: has this Record been destroy()ed?"
706 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "render", $len);
707 # I don't think we need '$len' at all. ### Probably the Perl-to-C
708 # glue code should use the value of `len' as well as the opaque
709 # data-pointer returned, to ensure that the SV contains all of the
710 # returned data and does not stop at the first NUL character in
711 # binary data. Carefully check the ZOOM_record_get() documentation.
719 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
720 # See comment about $len in render()
727 my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
728 or ZOOM::_oops(ZOOM::Error::CLONE);
730 # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
731 return _new ZOOM::Record(undef, undef, $raw);
737 Net::Z3950::ZOOM::record_destroy($this->_rec());
738 $this->{_rec} = undef;
742 # ----------------------------------------------------------------------------
744 package ZOOM::ScanSet;
748 die "You can't create $class objects directly";
751 # PRIVATE to ZOOM::Connection::scan(),
754 my($conn, $startterm, $_ss) = @_;
758 startterm => $startterm,# This is not currently used, which is
759 # just as well since it could be
760 # either a string (when the SS is
761 # created with scan()) or a
762 # ZOOM::Query object (when it's
763 # created with scan1())
768 # PRIVATE to this class
772 my $_ss = $this->{_ss};
773 die "{_ss} undefined: has this ScanSet been destroy()ed?"
781 my($key, $value) = @_;
783 my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
784 Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
793 return Net::Z3950::ZOOM::scanset_size($this->_ss());
800 my($occ, $len) = (0, 0);
801 my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
803 or ZOOM::_oops(ZOOM::Error::SCANTERM);
805 die "length of term '$term' differs from returned len=$len"
806 if length($term) != $len;
808 return ($term, $occ);
815 my($occ, $len) = (0, 0);
816 my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
818 or ZOOM::_oops(ZOOM::Error::SCANTERM);
820 die "length of display term '$term' differs from returned len=$len"
821 if length($term) != $len;
823 return ($term, $occ);
829 Net::Z3950::ZOOM::scanset_destroy($this->_ss());
830 $this->{_ss} = undef;
834 # ----------------------------------------------------------------------------
836 package ZOOM::Package;
840 die "You can't create $class objects directly";
843 # PRIVATE to ZOOM::Connection::package(),
846 my($conn, $options, $_p) = @_;
855 # PRIVATE to this class
859 my $_p = $this->{_p};
860 die "{_p} undefined: has this Package been destroy()ed?"
868 my($key, $value) = @_;
870 my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
871 Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
881 Net::Z3950::ZOOM::package_send($this->_p(), $type);
882 $this->{conn}->_check();
888 Net::Z3950::ZOOM::package_destroy($this->_p());
893 # There follows trivial support for YAZ logging. This is wired out
894 # into the Net::Z3950::ZOOM package, and we here provide wrapper
895 # functions -- nothing more than aliases, really -- in the ZOOM::Log
896 # package. There really is no point in inventing an OO interface.
898 # Passing @_ directly to the underlying Net::Z3950::ZOOM::* functions
899 # doesn't work, for reasons that I can't begin to fathom, and that
900 # don't particularly interest me. Unpacking into scalars and passing
901 # those _does_ work, so that's what we do.
905 sub mask_str { my($a) = @_; Net::Z3950::ZOOM::yaz_log_mask_str($a); }
906 sub module_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_module_level($a); }
907 sub init { my($a, $b, $c) = @_;
908 Net::Z3950::ZOOM::yaz_log_init($a, $b, $c) }
909 sub init_file { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_file($a) }
910 sub init_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_level($a) }
911 sub init_prefix { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_prefix($a) }
912 sub time_format { my($a) = @_; Net::Z3950::ZOOM::yaz_log_time_format($a) }
913 sub init_max_size { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_max_size($a) }
916 my($level, @message) = @_;
918 if ($level !~ /^(0x)?\d+$/) {
919 # Assuming its log-level name, we look it up.
920 my $num = module_level($level);
921 ZOOM::_oops(ZOOM::Error::LOGLEVEL, $level)
926 Net::Z3950::ZOOM::yaz_log($level, join("", @message));