Changes

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