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