Changes

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