1 $Id: Changes,v 1.79 2008-06-09 13:53:22 mike Exp $
3 Revision history for Perl extension Net::Z3950::ZOOM.
5 1.23 Mon Jun 9 14:53:15 BST 2008
6 - Net::Z3950::ZOOM::record_get() now patches around the
7 problem of naughty servers that refuse to return anything
8 for an OPAC record when there is no non-bibliographic part,
9 by falling back on requesting an XML record in such cases.
11 1.22 Tue May 27 14:00:12 BST 2008
12 - Fix Net::Z3950::ZOOM::record_get() to use a struct datachunk
13 _when_ appropriate, e.g. for "render" not for "database" and
15 - Remove the unused $len reference parameter from record_get()
16 and $record->get(): this is now used in the underlying C
17 layer to make Perl strings of the right length, and is of no
18 value higher up the stack.
19 - Fix a bug in ZOOM::ResultSet::records(): requests including
20 the last record in the set were incorrectly declined.
21 - Better Debian packaging: use "make debian" to create new
22 "debian/output" directory containing .deb package file,
24 - Clear up a few warnings in ZOOM.xs
25 - Minor documentation improvements.
27 1.21 Mon Oct 29 12:07:25 GMT 2007
28 - In the "typemap" file's handling of opaquechar*, use STRLEN
29 type for _unused_len in instead of unsigned: this prevents a
30 (possibly serious) warning on some 64-bit architectures,
31 although applications that do not use the option_binary()
32 methods will be safe with the previous release.
33 - Add explicit "#include <yaz/log.h>" to ZOOM.xs in the hope
34 of preventing undeclared-function warnings that some users
35 have reported but which I have been unable to reproduce.
37 1.20 Fri Sep 21 17:51:55 BST 2007
38 - Add new sample program, samples/zoom/zoomscan.pl
39 - samples/zoom/zoomtst1.pl now accepts arbitrary options at
40 the end of the command-line, so that (for example) you can
41 specify a non-USMARC record syntax.
42 - Add new functions Net::Z3950::ZOOM::diag_srw_str() and
43 ZOOM::diag_srw_str() to map SRW diagnostic codes into
44 human-readable messages.
45 - ZOOM::Exception() constructor uses diag_srw_str() to fill in
46 the error message, if it is undefined, for SRW errors.
47 - The render() method of ZOOM::Exception(), and therefore the
48 overloaded stringifying operator, deals with exceptions that
50 - Corrected the scan parts of the test-suite that use CQL so
51 that they explicitly perform client-side CQL compilation and
52 send the resulting Type-1 query. Previously, these tests
53 were (accidentally) requesting that CQL be sent as-is to the
54 server, but this mistake was being masked by an error in
55 older versions of ZOOM-C that compiled client-side anyway!
57 1.19 Mon Jul 9 14:09:31 BST 2007
58 - Add $conn->exception() method.
59 - Set version number for Net::Z3950 to 0.99 -- less than the
60 1.0 version number that will be used when it successfully
61 emulates the old Net::Z3950 module, but superseding the last
62 release, 0.51, of that module.
63 - Include samples/zoom/zdump.pl in distribution.
64 - Add "irspy" namespace to samples/zoom/zselect
66 1.18 Mon Feb 26 14:57:48 GMT 2007
67 - When a connection is in asynchronous mode, failing
68 operations (search, scan, etc.) no longer throw exceptions.
69 This is because the event-loop in asychronous applications
70 needs to check for errors anyway, in case the server has
71 returned high-level diagnostics such as "unsupported use
72 attribute". So this check within the event-loop is now the
73 only place where error-checking need be done.
74 - Add new public ZOOM::Connection() function, check(), which
75 throws an exception if an error is pending (even if the
76 connection is asynchronous).
77 - New YAZ logging level, "zoom_check", notes when errors are
78 detected and either left unreported (asynchronous
79 connections) or thrown as exception (synchronous).
81 1.17 Thu Feb 22 20:38:45 GMT 2007
82 - Change Net::Z3950::ZOOM::event() to allocate its array of
83 connection pointers dynamically, so there is no longer an
84 arbitrary limit of 100.
85 - New connection-level option "_check_debug" emits messages on
86 standard error when checking a connection find an error that
87 is about to result in throwing an exception. There is no
88 reason for you ever to use this, though -- pretend you don't
91 1.16 Tue Jan 16 11:18:34 GMT 2007
92 - Require version 2.1.41 or better of YAZ, so that Init
93 Response options are available using
94 $conn->option("init_opt_sort") etc.
95 - Include samples/zoom/zhello.pl to exercise these options.
96 - Add ZOOM_connection_peek_event() and $conn->peek_event().
97 - Require YAZ version 2.1.45, which is the first to provide
98 ZOOM_connection_peek_event().
100 1.15 Fri Dec 1 14:17:49 GMT 2006
101 - ZOOM::Error::INIT is renamed to ZOOM::Error::ZINIT, since
102 INIT is a reserved word in Perl. In version 1.14 and
103 earlier, "require ZOOM" would fail, saying "Too late to run
104 INIT block", and "use ZOOM" would result in
105 ZOOM::Error::INIT having a value equal to its name (why?!)
106 rather than, as intended, Net::Z3950::ZOOM::ERROR_INIT.
107 - Belatedly added documentation for $rec->error() and
110 1.14 Tue Nov 28 17:33:07 GMT 2006
111 - Add $record->error() to return non-surrogate diagnostics,
112 and $record->exception() to return the same information
113 wrapped in a ZOOM::Exception object.
114 - Requires YAZ 2.1.40, which provides ZOOM_record_error().
115 - $conn->error_x() now returns the error-code when called in
116 scalar context, rather than the diagnostic set name.
118 1.13 Sat Nov 4 16:47:00 GMT 2006
119 - ZOOM::Connection::create() may now take either a single
120 argument, which is a ZOOM::Options object, or any even
121 number of argument (including zero), which are key => value
122 pairs of options to set.
123 - ZOOM::Connection::new(), having been refactored to use
124 create(), can now also take a ZOOM::Options argument.
125 - Documentation now includes information on specifying SRW,
126 SRU-over-GET and SRU-over-POST connections.
127 - ZOOM::ResultSet::record() throws a diagnostic if asked to
128 retrieve records out of range for the result-set.
129 - All tests against indexdata.com are now explicitly against
130 z3950.indexdata.com, as the identity of the former name has
133 1.12 (NEVER PUBLICLY RELEASED; these changes are included in 1.13)
134 - Include the useful example program samples/zoom/zselect,
135 which is installed as part of "make install".
136 - Add ZOOM_connection_is_idle() and $conn->is_idle().
137 - Require YAZ version 2.1.35, which is the first to provide
138 ZOOM_connection_is_idle().
139 - Fix bug in ZOOM::Connection class code that made the
140 difficult to subclass -- when called as
141 $class->SUPER::new(@_), the constructor blessed the new
142 object into ZOOM::Connection rather than info the subclass.
144 1.11 Thu Aug 31 16:47:53 BST 2006
145 - Require YAZ version 2.1.17, which has important ZOOM-C
147 - Do not use "-Wdeclaration-after-statement" compiler option,
148 since this supported only by GCC (and only recent versions).
150 1.10 Thu Jun 15 16:42:47 BST 2006
151 - No functional changes, but use Adam's modified API to
152 ZOOM_query_ccl2rpn(). This incompatible change means that
153 RELEASE 1.09 WILL NOT BUILD against any recent YAZ.
155 1.09 Tue Jun 13 17:44:43 2006
156 - Add new function Net::Z3950::ZOOM::query_ccl2rpn(), for
157 client-side CCL compilation.
158 - Add new ZOOM::Query::CCL2RPN class, encapsulating CCL
159 compiler functionality as a Query subclass. This allows
160 client-side CCL to be used for both search and scan.
161 - Add two new error-codes, CCL_CONFIG and CCL_PARSE,
162 returned by the client-side CCL facilities.
163 - Supply a sample CCL profile file: samples/ccl/default.bib,
164 copied from the same-named file distributed with YAZ.
165 - The test-scripts t/12-query.t and t/22-query.t are extended
166 to also test client-side CCL searching.
167 - The test-scripts t/15-scan.t and t/25-scan.t are extended
168 to also test client-side CCL scanning.
169 - Documentation updated to describe use of CCL.
170 - Add a nice, simple update client: samples/zoom/update.pl
172 1.08 Thu May 11 22:40:41 BST 2006
173 - Requires version 2.1.11 of YAZ, not 2.0.11. This is a
174 bugfix: the old reliance on 2.0.11 was merely a typo.
176 1.07 Thu May 11 17:45:37 BST 2006
177 - Makefile.PL checks for at least version 2.1.11 of YAZ, and
178 refuses to build if it's not present. Thanks to "gregor"
179 (an otherwise anonymous CPAN tester) for notifying me of the
180 previously poor reporting of failure when running against an
182 - No changes to functionality or documentation.
184 1.06 Wed Apr 19 21:11:52 BST 2006
185 - Avoid mixed statement/declaration in ZOOM.xs. *sigh* Why
186 the heck GCC allows this by default I will never understand.
187 - Add (commented out) OPTIMIZE option to Makefile.PL, to turn
188 on -Wdeclaration-after-statement, which makes mixed
189 statement/declaration illegal.
191 1.05 Wed Apr 12 13:31:27 BST 2006
192 - Implementation of asynchronous events! The Net::Z3950::ZOOM
193 interface provides this through the event, last_event() and
194 event_str() functions. The ZOOM interface provides it
195 through the ZOOM::event() and ZOOM:event_str() functions,
196 and the ZOOM::Connection class's last_event() function.
197 - New sample programs added illustrating both asynchronous
198 interfaces: samples/net-z3950-zoom/zoomtst3.pl and
199 samples/zoom/zoomtst3.pl respectively. Additional sample
200 programs "async.pl" and "trivial-async.pl" for the ZOOM
201 interface only, the latter being a "shortest possible
202 broadcast search application".
203 - Added documentation on writing asynchronous applications.
204 - Added test-scripts "t/19-events.t" and "t/29-event.t" for
205 events on an asynchronous connection.
206 - Fix ZOOM::Connection::new so that options are handled in
207 accordance with the documentation: applied _before_ the
208 connection is forged, so that "async" and similar options
211 1.04 Mon Apr 3 14:56:11 BST 2006
212 - The ZOOM-Perl layer now provides access to the underlying
213 ZOOM-C's character-translation functionality, through new
214 optional arguments to ZOOM::Record's render() and raw()
215 methods, and a new underlying get() method.
217 1.03 Thu Mar 9 12:55:23 GMT 2006
218 - Allow additional key => value pairs as arguments to the
219 ZOOM::Connectoion constructor; these are added as Connection
220 options before the protocol connection is forged.
222 1.02 Thu Mar 9 11:36:55 GMT 2006
223 - Add interface to yaz_version().
224 - Emit big warning at startup time if YAZ version is less than
225 2.0.11 (which is what ZOOM-Perl 1.02 requires) unless the
226 file /tmp/ignore-ZOOM-YAZ-version-mismatch exists.
227 - Fix incorrect ZOOM-package URL in documentation.
228 - Fix typo ("createdb" package) in documentation.
229 - The ZOOM::Connection constructor may now be called with only
230 a single argument (host-string) and does not require a
231 dummy port-number argument.
233 1.01 Thu Dec 22 14:13:34 GMT 2005
234 - Place some CODE: chunks in "ZOOM.xs" inside curly brackets
235 so that the declarations they begin with are at the start of
236 the block. This avoid mixed code/declarations. (The
237 "correct" solution is to use INIT: clauses in the XS file,
238 but they don't seem to work: the code in them is slapped
239 down right next to the CODE:, so declarations are not
240 acceptable there either.)
241 - Add new function Net::Z3950::ZOOM::connection_scan1(), which
242 uses a query object to indicate the start-term. This opens
243 the way for using CQL queries for scanning once the
244 underlying ZOOM-C code supports this.
245 - NOTE BACKWARDS-INCOMPATIBLE CHANGE: The ZOOM::Connection
246 method scan() is renamed scan_pqf(), and a new scan() method
247 is introduced which calls the underlying scan1() function.
248 Thus the scan()/scan_pqf() dichotomy is consistent with that
249 between search()/search_pqf().
250 - The tests t/15-scan.t and t/25-scan.t now also test for
251 scanning by CQL query. To support these tests, a new files
252 is added to the distribution, "samples/cql/pqf.properties"
253 - Remove nonsensical clause about CQL sort-specifications from
255 - Add new function Net::Z3950::ZOOM::query_cql2rpn(), for
256 client-side CQL compilation.
257 - Add new ZOOM::Query::CQL2RPN class, encapsulating CQL
258 compiler functionality as a Query subclass.
259 - Add two new error-codes, CQL_PARSE and CQL_TRANSFORM,
260 returned by the client-side CQL facilities.
261 - The test-scripts t/12-query.t and t/22-query.t are extended
262 to also test client-side CQL compilation.
263 - Add all the yaz_log*() functions within the Net::Z3950::ZOOM
265 - Add new ZOOM::Log class for logging, providing aliases for
266 the functions in the Net::Z3950::ZOOM layer.
267 - Add diagnostic set to rendering of Exception objects.
268 - Documentation added for CQL compilation and logging.
270 1.00 Wed Dec 14 11:18:33 GMT 2005
271 - First distributed version.
273 0.01 Fri Oct 7 16:14:20 2005
274 - original version; created by h2xs 1.23 with options
275 --name=Net::Z3950::ZOOM --compat-version=5.8.0 \
276 --omit-constant --skip-exporter --skip-ppport \
277 --autogen-xsubs yaz/zoom.h -lyaz -lxml2
281 To be done in future releases:
282 - Complete, test and document "update.pl"
283 - Create old-style Net::Z3950 compatibility layer.
284 - Fix memory leaks in callback functions for option sets.
285 - Fix limitation that option-set callback functions must be
286 specified as strings containing package-qualified function