Changes

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