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