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