Changes

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