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