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