Changes

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