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