Changes

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