1 # $Id: ZOOM.pm,v 1.14 2005-11-08 11:46:59 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 }
50 # The "Event" package contains constants returned by last_event()
52 sub NONE { Net::Z3950::ZOOM::EVENT_NONE }
53 sub CONNECT { Net::Z3950::ZOOM::EVENT_CONNECT }
54 sub SEND_DATA { Net::Z3950::ZOOM::EVENT_SEND_DATA }
55 sub RECV_DATA { Net::Z3950::ZOOM::EVENT_RECV_DATA }
56 sub TIMEOUT { Net::Z3950::ZOOM::EVENT_TIMEOUT }
57 sub UNKNOWN { Net::Z3950::ZOOM::EVENT_UNKNOWN }
58 sub SEND_APDU { Net::Z3950::ZOOM::EVENT_SEND_APDU }
59 sub RECV_APDU { Net::Z3950::ZOOM::EVENT_RECV_APDU }
60 sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
61 sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
63 # ----------------------------------------------------------------------------
70 # Special cases for error specific to the OO layer
71 if ($code == ZOOM::Error::CREATE_QUERY) {
72 return "can't create query object";
73 } elsif ($code == ZOOM::Error::QUERY_CQL) {
74 return "can't set CQL query";
75 } elsif ($code == ZOOM::Error::QUERY_PQF) {
76 return "can't set prefix query";
77 } elsif ($code == ZOOM::Error::SORTBY) {
78 return "can't set sort-specification";
79 } elsif ($code == ZOOM::Error::CLONE) {
80 return "can't clone record";
83 return Net::Z3950::ZOOM::diag_str($code);
86 ### More of the ZOOM::Exception instantiations should use this
88 my($code, $addinfo) = @_;
90 die new ZOOM::Exception($code, diag_str($code), $addinfo);
93 # ----------------------------------------------------------------------------
95 package ZOOM::Exception;
99 my($code, $message, $addinfo) = @_;
100 ### support diag-set, too
111 return $this->{code};
116 return $this->{message};
121 return $this->{addinfo};
125 # ----------------------------------------------------------------------------
127 package ZOOM::Options;
135 $opts = Net::Z3950::ZOOM::options_create();
137 $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
139 $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
142 die "can't make $class object with more than 2 parents";
153 my $_opts = $this->{_opts};
154 die "{_opts} undefined: has this Options block been destroy()ed?"
162 my($key, $value) = @_;
164 my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
165 Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
173 my($key, $value) = @_;
176 my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
178 Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
179 $value, length($value))
185 # This is a bit stupid, since the scalar values that Perl returns from
186 # option() can be used as a boolean; but it's just possible that some
187 # applications will rely on ZOOM_options_get_bool()'s idiosyncratic
188 # interpretation of what constitutes truth.
192 my($key, $default) = @_;
194 return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
197 # .. and the next two are even more stupid
200 my($key, $default) = @_;
202 return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
207 my($key, $value) = @_;
209 Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
212 # ### Feel guilty. Feel very, very guilty. I've not been able to
213 # get the callback memory-management right in "ZOOM.xs", with
214 # the result that the values of $function and $udata passed into
215 # this function, which are on the stack, have sometimes been
216 # freed by the time they're used by __ZOOM_option_callback(),
217 # with hilarious results. To avoid this, I copy the values into
218 # module-scoped globals, and pass _those_ into the extension
219 # function. To avoid overwriting those globals by subsequent
220 # calls, I keep all the old ones, pushed onto the @_function and
221 # @_udata arrays, which means that THIS FUNCTION LEAKS MEMORY
222 # LIKE IT'S GOING OUT OF FASHION. Not nice. One day, I should
223 # fix this, but for now there's more important fish to fry.
225 my(@_function, @_udata);
228 my($function, $udata) = @_;
230 push @_function, $function;
231 push @_udata, $udata;
232 Net::Z3950::ZOOM::options_set_callback($o1->_opts(),
233 $_function[-1], $_udata[-1]);
239 Net::Z3950::ZOOM::options_destroy($this->_opts());
240 $this->{_opts} = undef;
244 # ----------------------------------------------------------------------------
246 package ZOOM::Connection;
250 my($host, $port) = @_;
252 my $_conn = Net::Z3950::ZOOM::connection_new($host, $port);
253 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
254 $errcode = Net::Z3950::ZOOM::connection_error($_conn, $errmsg, $addinfo);
255 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
268 my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
276 # PRIVATE to this class
280 my $_conn = $this->{_conn};
281 die "{_conn} undefined: has this Connection been destroy()ed?"
290 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
291 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
293 return ($errcode, $errmsg, $addinfo, $diagset);
298 return Net::Z3950::ZOOM::connection_errcode($this->_conn());
303 return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
308 return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
313 my($host, $port) = @_;
315 Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
316 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
317 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
319 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
325 my($key, $value) = @_;
327 my $oldval = Net::Z3950::ZOOM::connection_option_get($this->_conn(), $key);
328 Net::Z3950::ZOOM::connection_option_set($this->_conn(), $key, $value)
336 my($key, $value) = @_;
339 my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
341 Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
342 $value, length($value))
352 my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
354 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
355 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
357 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
359 return _new ZOOM::ResultSet($this, $query, $_rs);
366 my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
367 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
368 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
370 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
372 return _new ZOOM::ResultSet($this, $pqf, $_rs);
379 my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
380 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
381 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
383 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
385 return _new ZOOM::ScanSet($this, $startterm, $_ss);
391 Net::Z3950::ZOOM::connection_destroy($this->_conn());
392 $this->{_conn} = undef;
396 # ----------------------------------------------------------------------------
402 die "You can't create $class objects: it's a virtual base class";
405 # PRIVATE to this class and ZOOM::Connection::search()
409 my $_query = $this->{_query};
410 die "{_query} undefined: has this Query been destroy()ed?"
420 Net::Z3950::ZOOM::query_sortby($this->_query(), $sortby) == 0
421 or ZOOM::_oops(ZOOM::Error::SORTBY, $sortby);
427 Net::Z3950::ZOOM::query_destroy($this->_query());
428 $this->{_query} = undef;
432 package ZOOM::Query::CQL;
433 our @ISA = qw(ZOOM::Query);
439 my $q = Net::Z3950::ZOOM::query_create()
440 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
441 Net::Z3950::ZOOM::query_cql($q, $string) == 0
442 or ZOOM::_oops(ZOOM::Error::QUERY_CQL, $string);
450 package ZOOM::Query::PQF;
451 our @ISA = qw(ZOOM::Query);
457 my $q = Net::Z3950::ZOOM::query_create()
458 or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
459 Net::Z3950::ZOOM::query_prefix($q, $string) == 0
460 or ZOOM::_oops(ZOOM::Error::QUERY_PQF, $string);
468 # ----------------------------------------------------------------------------
470 package ZOOM::ResultSet;
474 die "You can't create $class objects directly";
477 # PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
480 my($conn, $query, $_rs) = @_;
484 query => $query, # This is not currently used, which is
485 # just as well since it could be
486 # either a string (when the RS is
487 # created with search_pqf()) or a
488 # ZOOM::Query object (when it's
489 # created with search())
494 # PRIVATE to this class
498 my $_rs = $this->{_rs};
499 die "{_rs} undefined: has this ResultSet been destroy()ed?"
507 my($key, $value) = @_;
509 my $oldval = Net::Z3950::ZOOM::resultset_option_get($this->_rs(), $key);
510 Net::Z3950::ZOOM::resultset_option_set($this->_rs(), $key, $value)
519 return Net::Z3950::ZOOM::resultset_size($this->_rs());
526 my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
527 ### Check for error -- but how?
528 return undef if !defined $_rec;
530 # For some reason, I have to use the explicit "->" syntax in order
531 # to invoke the ZOOM::Record constructor here, even though I don't
532 # have to do the same for _new ZOOM::ResultSet above. Weird.
533 return ZOOM::Record->_new($this, $which, $_rec);
536 sub record_immediate {
540 my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
542 ### Check for error -- but how?
543 return undef if !defined $_rec;
545 return ZOOM::Record->_new($this, $which, $_rec);
551 Net::Z3950::ZOOM::resultset_cache_reset($this->_rs());
556 my($start, $count, $return_records) = @_;
558 my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
560 return undef if !defined $raw;
562 # We need to package up the returned records in ZOOM::Record objects
564 for my $i (0 .. @$raw-1) {
565 my $_rec = $raw->[$i];
566 if (!defined $_rec) {
569 push @res, ZOOM::Record->_new($this, $start+$i, $_rec);
578 my($sort_type, $sort_spec) = @_;
580 Net::Z3950::ZOOM::resultset_sort($this->_rs(), $sort_type, $sort_spec);
581 ### There's no way to check for success, as this is a void function
587 Net::Z3950::ZOOM::resultset_destroy($this->_rs());
588 $this->{_rs} = undef;
592 # ----------------------------------------------------------------------------
594 package ZOOM::Record;
598 die "You can't create $class objects directly";
601 # PRIVATE to ZOOM::ResultSet::record(),
602 # ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
603 # ZOOM::Record::clone()
607 my($rs, $which, $_rec) = @_;
616 # PRIVATE to this class
620 my $_rec = $this->{_rec};
621 die "{_rec} undefined: has this Record been destroy()ed?"
631 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "render", $len);
632 # I don't think we need '$len' at all. ### Probably the Perl-to-C
633 # glue code should use the value of `len' as well as the opaque
634 # data-pointer returned, to ensure that the SV contains all of the
635 # returned data and does not stop at the first NUL character in
636 # binary data. Carefully check the ZOOM_record_get() documentation.
644 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
645 # See comment about $len in render()
652 my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
653 or ZOOM::_oops(ZOOM::Error::CLONE);
655 # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
656 return _new ZOOM::Record(undef, undef, $raw);
662 Net::Z3950::ZOOM::record_destroy($this->_rec());
663 $this->{_rec} = undef;
667 # ----------------------------------------------------------------------------
669 package ZOOM::ScanSet;
673 die "You can't create $class objects directly";
676 # PRIVATE to ZOOM::Connection::scan(),
679 my($conn, $startterm, $_ss) = @_;
683 startterm => $startterm,
688 # PRIVATE to this class
692 my $_ss = $this->{_ss};
693 die "{_ss} undefined: has this ScanSet been destroy()ed?"
702 return Net::Z3950::ZOOM::scanset_size($this->_ss());
709 my($occ, $len) = (0, 0);
710 my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
712 return undef if !defined $term;
713 die "length of term '$term' differs from returned len=$len"
714 if length($term) != $len;
716 return ($term, $occ);
723 my($occ, $len) = (0, 0);
724 my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
726 return undef if !defined $term;
727 die "length of display term '$term' differs from returned len=$len"
728 if length($term) != $len;
730 return ($term, $occ);
736 Net::Z3950::ZOOM::scanset_destroy($this->_ss());
737 $this->{_ss} = undef;