Changes

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