Changes

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