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