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