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