Changes

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