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