Changes

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