Changes

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