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