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