Changes

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