1 # $Id: ZOOM.pm,v 1.32 2006-04-11 16:27:01 mike Exp $
10 # Member naming convention: hash-element names which begin with an
11 # underscore represent underlying ZOOM-C object descriptors; those
12 # which lack them represent Perl's ZOOM objects. (The same convention
13 # is used in naming local variables where appropriate.)
15 # So, for example, the ZOOM::Connection class has an {_conn} element,
16 # which is a pointer to the ZOOM-C Connection object; but the
17 # ZOOM::ResultSet class has a {conn} element, which is a reference to
18 # the Perl-level Connection object by which it was created. (It may
19 # be that we find we have no need for these references, but for now
22 # To get at the underlying ZOOM-C connection object of a result-set
23 # (if you ever needed to do such a thing, which you probably don't)
24 # you'd use $rs->{conn}->_conn().
26 # ----------------------------------------------------------------------------
28 # The "Error" package contains constants returned as error-codes.
30 sub NONE { Net::Z3950::ZOOM::ERROR_NONE }
31 sub CONNECT { Net::Z3950::ZOOM::ERROR_CONNECT }
32 sub MEMORY { Net::Z3950::ZOOM::ERROR_MEMORY }
33 sub ENCODE { Net::Z3950::ZOOM::ERROR_ENCODE }
34 sub DECODE { Net::Z3950::ZOOM::ERROR_DECODE }
35 sub CONNECTION_LOST { Net::Z3950::ZOOM::ERROR_CONNECTION_LOST }
36 sub INIT { Net::Z3950::ZOOM::ERROR_INIT }
37 sub INTERNAL { Net::Z3950::ZOOM::ERROR_INTERNAL }
38 sub TIMEOUT { Net::Z3950::ZOOM::ERROR_TIMEOUT }
39 sub UNSUPPORTED_PROTOCOL { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_PROTOCOL }
40 sub UNSUPPORTED_QUERY { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_QUERY }
41 sub INVALID_QUERY { Net::Z3950::ZOOM::ERROR_INVALID_QUERY }
42 sub CQL_PARSE { Net::Z3950::ZOOM::ERROR_CQL_PARSE }
43 sub CQL_TRANSFORM { Net::Z3950::ZOOM::ERROR_CQL_TRANSFORM }
44 # The following are added specifically for this OO interface
45 sub CREATE_QUERY { 20001 }
46 sub QUERY_CQL { 20002 }
47 sub QUERY_PQF { 20003 }
51 sub SCANTERM { 20007 }
52 sub LOGLEVEL { 20008 }
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 }
66 sub ZEND { Net::Z3950::ZOOM::EVENT_END }
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);
99 return Net::Z3950::ZOOM::event_str(@_);
106 my @_connsref = map { $_->_conn() } @$connsref;
107 return Net::Z3950::ZOOM::event(\@_connsref);
111 my($code, $addinfo, $diagset) = @_;
113 die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
116 # ----------------------------------------------------------------------------
118 package ZOOM::Exception;
122 my($code, $message, $addinfo, $diagset) = @_;
128 diagset => $diagset || "ZOOM",
134 return $this->{code};
139 return $this->{message};
144 return $this->{addinfo};
149 return $this->{diagset};
154 my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
155 $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
156 $res .= " from diag-set '" . $this->diagset() . "'" if $this->diagset();
160 # This means that untrapped exceptions render nicely.
161 use overload '""' => \&render;
163 # ----------------------------------------------------------------------------
165 package ZOOM::Options;
173 $opts = Net::Z3950::ZOOM::options_create();
175 $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
177 $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
180 die "can't make $class object with more than 2 parents";
188 # PRIVATE to this class and ZOOM::Connection::create() and
189 # ZOOM::Connection::package()
194 my $_opts = $this->{_opts};
195 die "{_opts} undefined: has this Options block been destroy()ed?"
203 my($key, $value) = @_;
205 my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
206 Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
214 my($key, $value) = @_;
217 my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
219 Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
220 $value, length($value))
226 # This is a bit stupid, since the scalar values that Perl returns from
227 # option() can be used as a boolean; but it's just possible that some
228 # applications will rely on ZOOM_options_get_bool()'s idiosyncratic
229 # interpretation of what constitutes truth.
233 my($key, $default) = @_;
235 return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
238 # .. and the next two are even more stupid
241 my($key, $default) = @_;
243 return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
248 my($key, $value) = @_;
250 Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
253 # ### Feel guilty. Feel very, very guilty. I've not been able to
254 # get the callback memory-management right in "ZOOM.xs", with
255 # the result that the values of $function and $udata passed into
256 # this function, which are on the stack, have sometimes been
257 # freed by the time they're used by __ZOOM_option_callback(),
258 # with hilarious results. To avoid this, I copy the values into
259 # module-scoped globals, and pass _those_ into the extension
260 # function. To avoid overwriting those globals by subsequent
261 # calls, I keep all the old ones, pushed onto the @_function and
262 # @_udata arrays, which means that THIS FUNCTION LEAKS MEMORY
263 # LIKE IT'S GOING OUT OF FASHION. Not nice. One day, I should
264 # fix this, but for now there's more important fish to fry.
266 my(@_function, @_udata);
269 my($function, $udata) = @_;
271 push @_function, $function;
272 push @_udata, $udata;
273 Net::Z3950::ZOOM::options_set_callback($o1->_opts(),
274 $_function[-1], $_udata[-1]);
280 Net::Z3950::ZOOM::options_destroy($this->_opts());
281 $this->{_opts} = undef;
285 # ----------------------------------------------------------------------------
287 package ZOOM::Connection;
291 my($host, $port, @options) = @_;
293 my $_opts = Net::Z3950::ZOOM::options_create();
294 while (@options >= 2) {
295 my $key = shift(@options);
296 my $val = shift(@options);
297 Net::Z3950::ZOOM::options_set($_opts, $key, $val);
300 die "Odd number of options specified"
303 my $_conn = Net::Z3950::ZOOM::connection_create($_opts);
304 Net::Z3950::ZOOM::connection_connect($_conn, $host, $port);
315 # PRIVATE to this class, to ZOOM::event() and to ZOOM::Query::CQL2RPN::new()
319 my $_conn = $this->{_conn};
320 die "{_conn} undefined: has this Connection been destroy()ed?"
329 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "x", "x", "x");
330 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
332 die new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset)
340 my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
351 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
352 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
354 return ($errcode, $errmsg, $addinfo, $diagset);
359 return Net::Z3950::ZOOM::connection_errcode($this->_conn());
364 return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
369 return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
374 return Net::Z3950::ZOOM::connection_diagset($this->_conn());
379 my($host, $port) = @_;
381 $port = 0 if !defined $port;
382 Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
389 my($key, $value) = @_;
391 my $oldval = Net::Z3950::ZOOM::connection_option_get($this->_conn(), $key);
392 Net::Z3950::ZOOM::connection_option_set($this->_conn(), $key, $value)
400 my($key, $value) = @_;
403 my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
405 Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
406 $value, length($value))
416 my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
419 return _new ZOOM::ResultSet($this, $query, $_rs);
426 my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
428 return _new ZOOM::ResultSet($this, $pqf, $_rs);
435 my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
437 return _new ZOOM::ScanSet($this, $startterm, $_ss);
444 my $_ss = Net::Z3950::ZOOM::connection_scan1($this->_conn(),
447 return _new ZOOM::ScanSet($this, $query, $_ss);
454 my $_o = defined $options ? $options->_opts() :
455 Net::Z3950::ZOOM::options_create();
456 my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
457 or ZOOM::_oops(ZOOM::Error::PACKAGE);
459 return _new ZOOM::Package($this, $options, $_p);
466 return Net::Z3950::ZOOM::connection_last_event($this->_conn());
472 Net::Z3950::ZOOM::connection_destroy($this->_conn());
473 $this->{_conn} = undef;
477 # ----------------------------------------------------------------------------
483 die "You can't create $class objects: it's a virtual base class";
486 # PRIVATE to this class and ZOOM::Connection::search()
490 my $_query = $this->{_query};
491 die "{_query} undefined: has this Query been destroy()ed?"
501 Net::Z3950::ZOOM::query_sortby($this->_query(), $sortby) == 0
502 or ZOOM::_oops(ZOOM::Error::SORTBY, $sortby);
508 Net::Z3950::ZOOM::query_destroy($this->_query());
509 $this->{_query} = undef;
513 package ZOOM::Query::CQL;
514 our @ISA = qw(ZOOM::Query);
520 my $q = Net::Z3950::ZOOM::query_create()
521 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
522 Net::Z3950::ZOOM::query_cql($q, $string) == 0
523 or ZOOM::_oops(ZOOM::Error::QUERY_CQL, $string);
531 package ZOOM::Query::CQL2RPN;
532 our @ISA = qw(ZOOM::Query);
536 my($string, $conn) = @_;
538 my $q = Net::Z3950::ZOOM::query_create()
539 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
540 # check() throws the exception we want; but we only want it on failure!
541 Net::Z3950::ZOOM::query_cql2rpn($q, $string, $conn->_conn()) == 0
550 package ZOOM::Query::PQF;
551 our @ISA = qw(ZOOM::Query);
557 my $q = Net::Z3950::ZOOM::query_create()
558 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
559 Net::Z3950::ZOOM::query_prefix($q, $string) == 0
560 or ZOOM::_oops(ZOOM::Error::QUERY_PQF, $string);
568 # ----------------------------------------------------------------------------
570 package ZOOM::ResultSet;
574 die "You can't create $class objects directly";
577 # PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
580 my($conn, $query, $_rs) = @_;
584 query => $query, # This is not currently used, which is
585 # just as well since it could be
586 # either a string (when the RS is
587 # created with search_pqf()) or a
588 # ZOOM::Query object (when it's
589 # created with search())
594 # PRIVATE to this class
598 my $_rs = $this->{_rs};
599 die "{_rs} undefined: has this ResultSet been destroy()ed?"
607 my($key, $value) = @_;
609 my $oldval = Net::Z3950::ZOOM::resultset_option_get($this->_rs(), $key);
610 Net::Z3950::ZOOM::resultset_option_set($this->_rs(), $key, $value)
619 return Net::Z3950::ZOOM::resultset_size($this->_rs());
626 my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
627 $this->{conn}->_check();
629 # Even if no error has occurred, I think record() might
630 # legitimately return undef if we're running in asynchronous mode
631 # and the record just hasn't been retrieved yet. This goes double
632 # for record_immediate().
633 return undef if !defined $_rec;
635 # For some reason, I have to use the explicit "->" syntax in order
636 # to invoke the ZOOM::Record constructor here, even though I don't
637 # have to do the same for _new ZOOM::ResultSet above. Weird.
638 return ZOOM::Record->_new($this, $which, $_rec);
641 sub record_immediate {
645 my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
647 $this->{conn}->_check();
648 # The record might legitimately not be there yet
649 return undef if !defined $_rec;
651 return ZOOM::Record->_new($this, $which, $_rec);
657 Net::Z3950::ZOOM::resultset_cache_reset($this->_rs());
662 my($start, $count, $return_records) = @_;
664 my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
666 # By design, $raw may be undefined (if $return_records is true)
667 return undef if !defined $raw;
669 # We need to package up the returned records in ZOOM::Record objects
671 for my $i (0 .. @$raw-1) {
672 my $_rec = $raw->[$i];
673 if (!defined $_rec) {
676 push @res, ZOOM::Record->_new($this, $start+$i, $_rec);
685 my($sort_type, $sort_spec) = @_;
687 return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
688 $sort_type, $sort_spec);
694 Net::Z3950::ZOOM::resultset_destroy($this->_rs());
695 $this->{_rs} = undef;
699 # ----------------------------------------------------------------------------
701 package ZOOM::Record;
705 die "You can't create $class objects directly";
708 # PRIVATE to ZOOM::ResultSet::record(),
709 # ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
710 # ZOOM::Record::clone()
714 my($rs, $which, $_rec) = @_;
723 # PRIVATE to this class
727 my $_rec = $this->{_rec};
728 die "{_rec} undefined: has this Record been destroy()ed?"
737 return $this->get("render", @_);
743 return $this->get("raw", @_);
748 my($type, $args) = @_;
750 $type = "$type;$args" if defined $args;
752 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), $type, $len);
753 # I don't think we need '$len' at all. ### Probably the Perl-to-C
754 # glue code should use the value of `len' as well as the opaque
755 # data-pointer returned, to ensure that the SV contains all of the
756 # returned data and does not stop at the first NUL character in
757 # binary data. Carefully check the ZOOM_record_get() documentation.
764 my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
765 or ZOOM::_oops(ZOOM::Error::CLONE);
767 # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
768 return _new ZOOM::Record(undef, undef, $raw);
774 Net::Z3950::ZOOM::record_destroy($this->_rec());
775 $this->{_rec} = undef;
779 # ----------------------------------------------------------------------------
781 package ZOOM::ScanSet;
785 die "You can't create $class objects directly";
788 # PRIVATE to ZOOM::Connection::scan(),
791 my($conn, $startterm, $_ss) = @_;
795 startterm => $startterm,# This is not currently used, which is
796 # just as well since it could be
797 # either a string (when the SS is
798 # created with scan()) or a
799 # ZOOM::Query object (when it's
800 # created with scan1())
805 # PRIVATE to this class
809 my $_ss = $this->{_ss};
810 die "{_ss} undefined: has this ScanSet been destroy()ed?"
818 my($key, $value) = @_;
820 my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
821 Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
830 return Net::Z3950::ZOOM::scanset_size($this->_ss());
837 my($occ, $len) = (0, 0);
838 my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
840 or ZOOM::_oops(ZOOM::Error::SCANTERM);
842 die "length of term '$term' differs from returned len=$len"
843 if length($term) != $len;
845 return ($term, $occ);
852 my($occ, $len) = (0, 0);
853 my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
855 or ZOOM::_oops(ZOOM::Error::SCANTERM);
857 die "length of display term '$term' differs from returned len=$len"
858 if length($term) != $len;
860 return ($term, $occ);
866 Net::Z3950::ZOOM::scanset_destroy($this->_ss());
867 $this->{_ss} = undef;
871 # ----------------------------------------------------------------------------
873 package ZOOM::Package;
877 die "You can't create $class objects directly";
880 # PRIVATE to ZOOM::Connection::package(),
883 my($conn, $options, $_p) = @_;
892 # PRIVATE to this class
896 my $_p = $this->{_p};
897 die "{_p} undefined: has this Package been destroy()ed?"
905 my($key, $value) = @_;
907 my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
908 Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
918 Net::Z3950::ZOOM::package_send($this->_p(), $type);
919 $this->{conn}->_check();
925 Net::Z3950::ZOOM::package_destroy($this->_p());
930 # There follows trivial support for YAZ logging. This is wired out
931 # into the Net::Z3950::ZOOM package, and we here provide wrapper
932 # functions -- nothing more than aliases, really -- in the ZOOM::Log
933 # package. There really is no point in inventing an OO interface.
935 # Passing @_ directly to the underlying Net::Z3950::ZOOM::* functions
936 # doesn't work, for reasons that I can't begin to fathom, and that
937 # don't particularly interest me. Unpacking into scalars and passing
938 # those _does_ work, so that's what we do.
942 sub mask_str { my($a) = @_; Net::Z3950::ZOOM::yaz_log_mask_str($a); }
943 sub module_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_module_level($a); }
944 sub init { my($a, $b, $c) = @_;
945 Net::Z3950::ZOOM::yaz_log_init($a, $b, $c) }
946 sub init_file { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_file($a) }
947 sub init_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_level($a) }
948 sub init_prefix { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_prefix($a) }
949 sub time_format { my($a) = @_; Net::Z3950::ZOOM::yaz_log_time_format($a) }
950 sub init_max_size { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_max_size($a) }
953 my($level, @message) = @_;
955 if ($level !~ /^(0x)?\d+$/) {
956 # Assuming its log-level name, we look it up.
957 my $num = module_level($level);
958 ZOOM::_oops(ZOOM::Error::LOGLEVEL, $level)
963 Net::Z3950::ZOOM::yaz_log($level, join("", @message));