Changes

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