Changes

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