Release 1.14
[ZOOM-Perl-moved-to-github.git] / Changes
1 $Id: Changes,v 1.51 2006-11-28 17:33:15 mike Exp $
2
3 Revision history for Perl extension Net::Z3950::ZOOM.
4
5 1.14  Tue Nov 28 17:33:07 GMT 2006
6         - Add $record->error() to return non-surrogate diagnostics,
7           and $record->exception() to return the same information
8           wrapped in a ZOOM::Exception object.
9         - Requires YAZ 2.1.40, which provides ZOOM_record_error().
10         - $conn->error_x() now returns the error-code when called in
11           scalar context, rather than the diagnostic set name.
12
13 1.13  Sat Nov  4 16:47:00 GMT 2006
14         - ZOOM::Connection::create() may now take either a single
15           argument, which is a ZOOM::Options object, or any even
16           number of argument (including zero), which are key => value
17           pairs of options to set.
18         - ZOOM::Connection::new(), having been refactored to use
19           create(), can now also take a ZOOM::Options argument.
20         - Documentation now includes information on specifying SRW,
21           SRU-over-GET and SRU-over-POST connections.
22         - ZOOM::ResultSet::record() throws a diagnostic if asked to
23           retrieve records out of range for the result-set.
24         - All tests against indexdata.com are now explicitly against
25           z3950.indexdata.com, as the identity of the former name has
26           recently changed.
27
28 1.12  (NEVER PUBLICLY RELEASED; these changes are included in 1.13)
29         - Include the useful example program samples/zoom/zselect,
30           which is installed as part of "make install".
31         - Add ZOOM_connection_is_idle() and $conn->is_idle().
32         - Require YAZ version 2.1.35, which is the first to provide
33           ZOOM_connection_is_idle().
34         - Fix bug in ZOOM::Connection class code that made the
35           difficult to subclass -- when called as
36           $class->SUPER::new(@_), the constructor blessed the new
37           object into ZOOM::Connection rather than info the subclass.
38
39 1.11  Thu Aug 31 16:47:53 BST 2006
40         - Require YAZ version 2.1.17, which has important ZOOM-C
41           bug-fixes.
42         - Do not use "-Wdeclaration-after-statement" compiler option,
43           since this supported only by GCC (and only recent versions).
44
45 1.10  Thu Jun 15 16:42:47 BST 2006
46         - No functional changes, but use Adam's modified API to
47           ZOOM_query_ccl2rpn().  This incompatible change means that
48           RELEASE 1.09 WILL NOT BUILD against any recent YAZ.
49
50 1.09  Tue Jun 13 17:44:43 2006
51         - Add new function Net::Z3950::ZOOM::query_ccl2rpn(), for
52           client-side CCL compilation.
53         - Add new ZOOM::Query::CCL2RPN class, encapsulating CCL
54           compiler functionality as a Query subclass.  This allows
55           client-side CCL to be used for both search and scan.
56         - Add two new error-codes, CCL_CONFIG and CCL_PARSE,
57           returned by the client-side CCL facilities.
58         - Supply a sample CCL profile file: samples/ccl/default.bib,
59           copied from the same-named file distributed with YAZ.
60         - The test-scripts t/12-query.t and t/22-query.t are extended
61           to also test client-side CCL searching.
62         - The test-scripts t/15-scan.t and t/25-scan.t are extended
63           to also test client-side CCL scanning.
64         - Documentation updated to describe use of CCL.
65         - Add a nice, simple update client: samples/zoom/update.pl
66
67 1.08  Thu May 11 22:40:41 BST 2006
68         - Requires version 2.1.11 of YAZ, not 2.0.11.  This is a
69           bugfix: the old reliance on 2.0.11 was merely a typo.
70
71 1.07  Thu May 11 17:45:37 BST 2006
72         - Makefile.PL checks for at least version 2.1.11 of YAZ, and
73           refuses to build if it's not present.  Thanks to "gregor"
74           (an otherwise anonymous CPAN tester) for notifying me of the
75           previously poor reporting of failure when running against an
76           earlier YAZ.
77         - No changes to functionality or documentation.
78
79 1.06  Wed Apr 19 21:11:52 BST 2006
80         - Avoid mixed statement/declaration in ZOOM.xs.  *sigh*  Why
81           the heck GCC allows this by default I will never understand.
82         - Add (commented out) OPTIMIZE option to Makefile.PL, to turn
83           on -Wdeclaration-after-statement, which makes mixed
84           statement/declaration illegal.
85
86 1.05  Wed Apr 12 13:31:27 BST 2006
87         - Implementation of asynchronous events!  The Net::Z3950::ZOOM
88           interface provides this through the event, last_event() and
89           event_str() functions.  The ZOOM interface provides it
90           through the ZOOM::event() and ZOOM:event_str() functions,
91           and the ZOOM::Connection class's last_event() function.
92         - New sample programs added illustrating both asynchronous
93           interfaces: samples/net-z3950-zoom/zoomtst3.pl and
94           samples/zoom/zoomtst3.pl respectively.  Additional sample
95           programs "async.pl" and "trivial-async.pl" for the ZOOM
96           interface only, the latter being a "shortest possible
97           broadcast search application".
98         - Added documentation on writing asynchronous applications.
99         - Added test-scripts "t/19-events.t" and "t/29-event.t" for
100           events on an asynchronous connection.
101         - Fix ZOOM::Connection::new so that options are handled in
102           accordance with the documentation: applied _before_ the
103           connection is forged, so that "async" and similar options
104           can take effect.
105
106 1.04  Mon Apr  3 14:56:11 BST 2006
107         - The ZOOM-Perl layer now provides access to the underlying
108           ZOOM-C's character-translation functionality, through new
109           optional arguments to ZOOM::Record's render() and raw()
110           methods, and a new underlying get() method.
111
112 1.03  Thu Mar  9 12:55:23 GMT 2006
113         - Allow additional key => value pairs as arguments to the
114           ZOOM::Connectoion constructor; these are added as Connection
115           options before the protocol connection is forged.
116
117 1.02  Thu Mar  9 11:36:55 GMT 2006
118         - Add interface to yaz_version().
119         - Emit big warning at startup time if YAZ version is less than
120           2.0.11 (which is what ZOOM-Perl 1.02 requires) unless the
121           file /tmp/ignore-ZOOM-YAZ-version-mismatch exists.
122         - Fix incorrect ZOOM-package URL in documentation.
123         - Fix typo ("createdb" package) in documentation.
124         - The ZOOM::Connection constructor may now be called with only
125           a single argument (host-string) and does not require a
126           dummy port-number argument.
127
128 1.01  Thu Dec 22 14:13:34 GMT 2005
129         - Place some CODE: chunks in "ZOOM.xs" inside curly brackets
130           so that the declarations they begin with are at the start of
131           the block.  This avoid mixed code/declarations.  (The
132           "correct" solution is to use INIT: clauses in the XS file,
133           but they don't seem to work: the code in them is slapped
134           down right next to the CODE:, so declarations are not
135           acceptable there either.)
136         - Add new function Net::Z3950::ZOOM::connection_scan1(), which
137           uses a query object to indicate the start-term.  This opens
138           the way for using CQL queries for scanning once the
139           underlying ZOOM-C code supports this.
140         - NOTE BACKWARDS-INCOMPATIBLE CHANGE: The ZOOM::Connection
141           method scan() is renamed scan_pqf(), and a new scan() method
142           is introduced which calls the underlying scan1() function.
143           Thus the scan()/scan_pqf() dichotomy is consistent with that
144           between search()/search_pqf().
145         - The tests t/15-scan.t and t/25-scan.t now also test for
146           scanning by CQL query.  To support these tests, a new files
147           is added to the distribution, "samples/cql/pqf.properties"
148         - Remove nonsensical clause about CQL sort-specifications from
149           the documentation.
150         - Add new function Net::Z3950::ZOOM::query_cql2rpn(), for
151           client-side CQL compilation.
152         - Add new ZOOM::Query::CQL2RPN class, encapsulating CQL
153           compiler functionality as a Query subclass.
154         - Add two new error-codes, CQL_PARSE and CQL_TRANSFORM,
155           returned by the client-side CQL facilities.
156         - The test-scripts t/12-query.t and t/22-query.t are extended
157           to also test client-side CQL compilation.
158         - Add all the yaz_log*() functions within the Net::Z3950::ZOOM
159           namespace. 
160         - Add new ZOOM::Log class for logging, providing aliases for
161           the functions in the Net::Z3950::ZOOM layer.
162         - Add diagnostic set to rendering of Exception objects.
163         - Documentation added for CQL compilation and logging.
164
165 1.00  Wed Dec 14 11:18:33 GMT 2005
166         - First distributed version.
167
168 0.01  Fri Oct  7 16:14:20 2005
169         - original version; created by h2xs 1.23 with options
170                 --name=Net::Z3950::ZOOM --compat-version=5.8.0 \
171                 --omit-constant --skip-exporter --skip-ppport \
172                 --autogen-xsubs yaz/zoom.h -lyaz -lxml2
173
174 --
175
176 To be done in future releases:
177         - Complete, test and document "update.pl"
178         - Fix Net::Z3950::ZOOM::record_get() to use a struct datachunk
179           _when_ appropriate, e.g. for "render" but probably not for
180           "database" and "syntax".
181         - Create old-style Net::Z3950 compatibility layer.
182         - Fix memory leaks in callback functions for option sets.
183         - Fix limitation that option-set callback functions must be
184           specified as strings containing package-qualified function
185           names.
186