1 # $Id: ZOOM.pm,v 1.27 2006-03-09 12:57:19 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 }
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";
89 } elsif ($code == ZOOM::Error::LOGLEVEL) {
90 return "unregistered log-level";
93 return Net::Z3950::ZOOM::diag_str($code);
97 my($code, $addinfo, $diagset) = @_;
99 die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
102 # ----------------------------------------------------------------------------
104 package ZOOM::Exception;
108 my($code, $message, $addinfo, $diagset) = @_;
114 diagset => $diagset || "ZOOM",
120 return $this->{code};
125 return $this->{message};
130 return $this->{addinfo};
135 return $this->{diagset};
140 my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
141 $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
142 $res .= " from diag-set '" . $this->diagset() . "'" if $this->diagset();
146 # This means that untrapped exceptions render nicely.
147 use overload '""' => \&render;
149 # ----------------------------------------------------------------------------
151 package ZOOM::Options;
159 $opts = Net::Z3950::ZOOM::options_create();
161 $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
163 $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
166 die "can't make $class object with more than 2 parents";
174 # PRIVATE to this class and ZOOM::Connection::create() and
175 # ZOOM::Connection::package()
180 my $_opts = $this->{_opts};
181 die "{_opts} undefined: has this Options block been destroy()ed?"
189 my($key, $value) = @_;
191 my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
192 Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
200 my($key, $value) = @_;
203 my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
205 Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
206 $value, length($value))
212 # This is a bit stupid, since the scalar values that Perl returns from
213 # option() can be used as a boolean; but it's just possible that some
214 # applications will rely on ZOOM_options_get_bool()'s idiosyncratic
215 # interpretation of what constitutes truth.
219 my($key, $default) = @_;
221 return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
224 # .. and the next two are even more stupid
227 my($key, $default) = @_;
229 return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
234 my($key, $value) = @_;
236 Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
239 # ### Feel guilty. Feel very, very guilty. I've not been able to
240 # get the callback memory-management right in "ZOOM.xs", with
241 # the result that the values of $function and $udata passed into
242 # this function, which are on the stack, have sometimes been
243 # freed by the time they're used by __ZOOM_option_callback(),
244 # with hilarious results. To avoid this, I copy the values into
245 # module-scoped globals, and pass _those_ into the extension
246 # function. To avoid overwriting those globals by subsequent
247 # calls, I keep all the old ones, pushed onto the @_function and
248 # @_udata arrays, which means that THIS FUNCTION LEAKS MEMORY
249 # LIKE IT'S GOING OUT OF FASHION. Not nice. One day, I should
250 # fix this, but for now there's more important fish to fry.
252 my(@_function, @_udata);
255 my($function, $udata) = @_;
257 push @_function, $function;
258 push @_udata, $udata;
259 Net::Z3950::ZOOM::options_set_callback($o1->_opts(),
260 $_function[-1], $_udata[-1]);
266 Net::Z3950::ZOOM::options_destroy($this->_opts());
267 $this->{_opts} = undef;
271 # ----------------------------------------------------------------------------
273 package ZOOM::Connection;
277 my($host, $port, @options) = @_;
279 my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
286 while (@options >= 2) {
287 my $key = shift(@options);
288 my $val = shift(@options);
289 $conn->option($key, $val);
292 die "Odd number of options specified"
299 # PRIVATE to this class and to ZOOM::Query::CQL2RPN::new()
303 my $_conn = $this->{_conn};
304 die "{_conn} undefined: has this Connection been destroy()ed?"
313 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "x", "x", "x");
314 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
316 die new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset)
324 my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
335 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
336 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
338 return ($errcode, $errmsg, $addinfo, $diagset);
343 return Net::Z3950::ZOOM::connection_errcode($this->_conn());
348 return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
353 return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
358 return Net::Z3950::ZOOM::connection_diagset($this->_conn());
363 my($host, $port) = @_;
365 $port = 0 if !defined $port;
366 Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
373 my($key, $value) = @_;
375 my $oldval = Net::Z3950::ZOOM::connection_option_get($this->_conn(), $key);
376 Net::Z3950::ZOOM::connection_option_set($this->_conn(), $key, $value)
384 my($key, $value) = @_;
387 my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
389 Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
390 $value, length($value))
400 my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
403 return _new ZOOM::ResultSet($this, $query, $_rs);
410 my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
412 return _new ZOOM::ResultSet($this, $pqf, $_rs);
419 my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
421 return _new ZOOM::ScanSet($this, $startterm, $_ss);
428 my $_ss = Net::Z3950::ZOOM::connection_scan1($this->_conn(),
431 return _new ZOOM::ScanSet($this, $query, $_ss);
438 my $_o = defined $options ? $options->_opts() :
439 Net::Z3950::ZOOM::options_create();
440 my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
441 or ZOOM::_oops(ZOOM::Error::PACKAGE);
443 return _new ZOOM::Package($this, $options, $_p);
449 Net::Z3950::ZOOM::connection_destroy($this->_conn());
450 $this->{_conn} = undef;
454 # ----------------------------------------------------------------------------
460 die "You can't create $class objects: it's a virtual base class";
463 # PRIVATE to this class and ZOOM::Connection::search()
467 my $_query = $this->{_query};
468 die "{_query} undefined: has this Query been destroy()ed?"
478 Net::Z3950::ZOOM::query_sortby($this->_query(), $sortby) == 0
479 or ZOOM::_oops(ZOOM::Error::SORTBY, $sortby);
485 Net::Z3950::ZOOM::query_destroy($this->_query());
486 $this->{_query} = undef;
490 package ZOOM::Query::CQL;
491 our @ISA = qw(ZOOM::Query);
497 my $q = Net::Z3950::ZOOM::query_create()
498 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
499 Net::Z3950::ZOOM::query_cql($q, $string) == 0
500 or ZOOM::_oops(ZOOM::Error::QUERY_CQL, $string);
508 package ZOOM::Query::CQL2RPN;
509 our @ISA = qw(ZOOM::Query);
513 my($string, $conn) = @_;
515 my $q = Net::Z3950::ZOOM::query_create()
516 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
517 # check() throws the exception we want; but we only want it on failure!
518 Net::Z3950::ZOOM::query_cql2rpn($q, $string, $conn->_conn()) == 0
527 package ZOOM::Query::PQF;
528 our @ISA = qw(ZOOM::Query);
534 my $q = Net::Z3950::ZOOM::query_create()
535 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
536 Net::Z3950::ZOOM::query_prefix($q, $string) == 0
537 or ZOOM::_oops(ZOOM::Error::QUERY_PQF, $string);
545 # ----------------------------------------------------------------------------
547 package ZOOM::ResultSet;
551 die "You can't create $class objects directly";
554 # PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
557 my($conn, $query, $_rs) = @_;
561 query => $query, # This is not currently used, which is
562 # just as well since it could be
563 # either a string (when the RS is
564 # created with search_pqf()) or a
565 # ZOOM::Query object (when it's
566 # created with search())
571 # PRIVATE to this class
575 my $_rs = $this->{_rs};
576 die "{_rs} undefined: has this ResultSet been destroy()ed?"
584 my($key, $value) = @_;
586 my $oldval = Net::Z3950::ZOOM::resultset_option_get($this->_rs(), $key);
587 Net::Z3950::ZOOM::resultset_option_set($this->_rs(), $key, $value)
596 return Net::Z3950::ZOOM::resultset_size($this->_rs());
603 my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
604 $this->{conn}->_check();
606 # Even if no error has occurred, I think record() might
607 # legitimately return undef if we're running in asynchronous mode
608 # and the record just hasn't been retrieved yet. This goes double
609 # for record_immediate().
610 return undef if !defined $_rec;
612 # For some reason, I have to use the explicit "->" syntax in order
613 # to invoke the ZOOM::Record constructor here, even though I don't
614 # have to do the same for _new ZOOM::ResultSet above. Weird.
615 return ZOOM::Record->_new($this, $which, $_rec);
618 sub record_immediate {
622 my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
624 $this->{conn}->_check();
625 # The record might legitimately not be there yet
626 return undef if !defined $_rec;
628 return ZOOM::Record->_new($this, $which, $_rec);
634 Net::Z3950::ZOOM::resultset_cache_reset($this->_rs());
639 my($start, $count, $return_records) = @_;
641 my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
643 # By design, $raw may be undefined (if $return_records is true)
644 return undef if !defined $raw;
646 # We need to package up the returned records in ZOOM::Record objects
648 for my $i (0 .. @$raw-1) {
649 my $_rec = $raw->[$i];
650 if (!defined $_rec) {
653 push @res, ZOOM::Record->_new($this, $start+$i, $_rec);
662 my($sort_type, $sort_spec) = @_;
664 return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
665 $sort_type, $sort_spec);
671 Net::Z3950::ZOOM::resultset_destroy($this->_rs());
672 $this->{_rs} = undef;
676 # ----------------------------------------------------------------------------
678 package ZOOM::Record;
682 die "You can't create $class objects directly";
685 # PRIVATE to ZOOM::ResultSet::record(),
686 # ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
687 # ZOOM::Record::clone()
691 my($rs, $which, $_rec) = @_;
700 # PRIVATE to this class
704 my $_rec = $this->{_rec};
705 die "{_rec} undefined: has this Record been destroy()ed?"
715 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "render", $len);
716 # I don't think we need '$len' at all. ### Probably the Perl-to-C
717 # glue code should use the value of `len' as well as the opaque
718 # data-pointer returned, to ensure that the SV contains all of the
719 # returned data and does not stop at the first NUL character in
720 # binary data. Carefully check the ZOOM_record_get() documentation.
728 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
729 # See comment about $len in render()
736 my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
737 or ZOOM::_oops(ZOOM::Error::CLONE);
739 # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
740 return _new ZOOM::Record(undef, undef, $raw);
746 Net::Z3950::ZOOM::record_destroy($this->_rec());
747 $this->{_rec} = undef;
751 # ----------------------------------------------------------------------------
753 package ZOOM::ScanSet;
757 die "You can't create $class objects directly";
760 # PRIVATE to ZOOM::Connection::scan(),
763 my($conn, $startterm, $_ss) = @_;
767 startterm => $startterm,# This is not currently used, which is
768 # just as well since it could be
769 # either a string (when the SS is
770 # created with scan()) or a
771 # ZOOM::Query object (when it's
772 # created with scan1())
777 # PRIVATE to this class
781 my $_ss = $this->{_ss};
782 die "{_ss} undefined: has this ScanSet been destroy()ed?"
790 my($key, $value) = @_;
792 my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
793 Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
802 return Net::Z3950::ZOOM::scanset_size($this->_ss());
809 my($occ, $len) = (0, 0);
810 my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
812 or ZOOM::_oops(ZOOM::Error::SCANTERM);
814 die "length of term '$term' differs from returned len=$len"
815 if length($term) != $len;
817 return ($term, $occ);
824 my($occ, $len) = (0, 0);
825 my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
827 or ZOOM::_oops(ZOOM::Error::SCANTERM);
829 die "length of display term '$term' differs from returned len=$len"
830 if length($term) != $len;
832 return ($term, $occ);
838 Net::Z3950::ZOOM::scanset_destroy($this->_ss());
839 $this->{_ss} = undef;
843 # ----------------------------------------------------------------------------
845 package ZOOM::Package;
849 die "You can't create $class objects directly";
852 # PRIVATE to ZOOM::Connection::package(),
855 my($conn, $options, $_p) = @_;
864 # PRIVATE to this class
868 my $_p = $this->{_p};
869 die "{_p} undefined: has this Package been destroy()ed?"
877 my($key, $value) = @_;
879 my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
880 Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
890 Net::Z3950::ZOOM::package_send($this->_p(), $type);
891 $this->{conn}->_check();
897 Net::Z3950::ZOOM::package_destroy($this->_p());
902 # There follows trivial support for YAZ logging. This is wired out
903 # into the Net::Z3950::ZOOM package, and we here provide wrapper
904 # functions -- nothing more than aliases, really -- in the ZOOM::Log
905 # package. There really is no point in inventing an OO interface.
907 # Passing @_ directly to the underlying Net::Z3950::ZOOM::* functions
908 # doesn't work, for reasons that I can't begin to fathom, and that
909 # don't particularly interest me. Unpacking into scalars and passing
910 # those _does_ work, so that's what we do.
914 sub mask_str { my($a) = @_; Net::Z3950::ZOOM::yaz_log_mask_str($a); }
915 sub module_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_module_level($a); }
916 sub init { my($a, $b, $c) = @_;
917 Net::Z3950::ZOOM::yaz_log_init($a, $b, $c) }
918 sub init_file { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_file($a) }
919 sub init_level { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_level($a) }
920 sub init_prefix { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_prefix($a) }
921 sub time_format { my($a) = @_; Net::Z3950::ZOOM::yaz_log_time_format($a) }
922 sub init_max_size { my($a) = @_; Net::Z3950::ZOOM::yaz_log_init_max_size($a) }
925 my($level, @message) = @_;
927 if ($level !~ /^(0x)?\d+$/) {
928 # Assuming its log-level name, we look it up.
929 my $num = module_level($level);
930 ZOOM::_oops(ZOOM::Error::LOGLEVEL, $level)
935 Net::Z3950::ZOOM::yaz_log($level, join("", @message));