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