Changes

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