Changes

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