Changes

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