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