Changes

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