Changes

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