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