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