1 Possible compatibility problems with earlier versions marked with '*'.
5 YAZ client enables named result sets only if target supports it.
7 *** ZOOM. Prefix for ZOOM definitions changed from Z3950_ to ZOOM_.
9 * ZOOM. Removed Z3950_connection_host. Use Z3950_connection_option_get
10 with key="host" to get same result.
12 * ZOOM. Added Z3950_record_clone and removed Z3950_resultset_get.
13 Function Z3950_resultset_record(s) returns references to records
14 "owned" by resultset. To become owner use Z3950_record_clone.
16 Function z_ext_record handles Extended Services. Thanks to
21 CCL Parser fix: ignore token comma when dealing with and-lists.
23 Documentation updates for COMSTACK.
25 * ZOOM changes. Query object renamed from Z3950_search to Z3950_query.
26 Changed prototype Z3950_records. For some functions, int parameters
27 were changed to size_t.
29 TCP/IP COMSTACK no longer uses getprotobyname to avoid memory leak
32 New MARC decode/display function, marc_display_exl, which properly rejects
33 non-ISO2709 records. YAZ client uses it.
37 Fix bug: local attribute set wasn't set correctly in PQF strings.
41 * Old Z39.50 codecs no longer supported.
43 Added ZOOM C binding. See http://zoom.z3950.org/
45 Renamed states for COMSTACKs to avoid confusion with events.
47 Implemented cs_look and proper cs_rcvconnect.
49 Fixed COMSTACK error that occurred on HPUX. Fix by Giannis Kosmas.
51 Configure detects POSIX threads on OpenBSD.
53 When sort flag 'i' was specified in yaz-client the caseSensitivy flag
54 was set to a wrong value. Thanks to Robert Sanderson for reporting this.
56 When error is returned from present handler, non-surrogate diagnostic
57 is returned in present response (and fetch handler is no longer called).
59 * Minor adjustments to pquery parser (PQF). Token characters may be
60 escaped by using backslash (C-style).
62 PQF parser allows string attribute values to be specified. For @attr,
63 non-numeric characters after the equal-sign are treated as strings
66 CCL trunction character may be defined (@truncation in file)
68 * function zget_ExtendedServicesRequest sets waitAction to
69 waitIfPossible (was wait).
71 Added cs_set_blocking to set change blocking mode of a COMSTACK. Thanks
74 CCL operator names may be set in field definition files (CCL_bibset).
75 See ccl/bib1 for an example.
77 Fixes in ASN.1 compiler for C++ compatibility.
79 * Renamed members "and" and "or" in struct Z_Operator to "op_and"
80 and "op_or" to avoid conflict with C++.
82 Fixed problem with GNU readline detection on Redhat 7.0.
84 Added step-size for Scan backend handler.
86 Fixed bug that made the frontend server crash when no attribute
87 set was specified for scan.
89 Front-end server automatically switches to original working directory
90 when installed as an NT service. Previously -w had to be specified to
93 Added extended attributes for retrieval module (data1), so that data1
94 records carry d1_readXML/SGML attributes. d1_read also supports
95 null-data rules ( <tag/>)
97 On UNIX when POSIX threads are available, a separate library libyazthread
98 is created. Programmers should link with that library and the yaz library
99 when using threads. The reason for the split was that some applications
100 on Linux, such as Apache, doesn't work well when using shared objects that
103 Added SSL support for the COMSTACK. You start yaz-client and yaz-ztest
104 (or any frontend server) in SSL mode by specifying ssl: followed by
105 address. Only tested on UNIX.
107 Added feature for CCL module. Virtual structure s=al or s=ol generates
108 and-list and or-list respectively instead of phrase search.
112 * Added prefix "yaz_" for the functions log_init.., log_file.. and
113 log_mask_str. This was done to avoid name conflicts with other libraries
114 (such as other PHP extensions).
116 Added raw OID member for preferred record syntax (request_format_raw)
117 and returned record syntax (output_format_raw) for backend fetch method.
119 Config file yaz-config now accepts options so that it returns specific
120 compile settings, etc. Thanks to Morten Bøgeskov <morten@bogeskov.dk>
122 Shared library support for UNIX using GNU libtool.
124 * Modified backend interface. Request/Response struct's replaced by
125 one read/write C struct. For example bend_fetchrequest and
126 bend_fetchresult have been replaced by single bend_fetch_rr struct.
127 Every handler - even search has to be registered in bend_init
128 handler. This means that the YAZ library no longer refers to
129 external functions and it makes it possible to make the whole
130 thing a single DLL/SO.
132 Added Segment handler for backend server.
134 Added Zmbol/Zebra administrative functions to YAZ client.
136 Threaded frontend server on UNIX (when POSIX Threads are available).
137 Starting the server with option -T enables multi-threading.
141 Added configure option --enable-comp/disable-comp to control use
142 of YAZ ASN.1 compiler. Use --disable-comp to use the old *coders
143 located in sub directory asn.
145 YAZ ASN.1 compiler renamed to yaz-comp in sub directory. It's installed
146 in ${exec_prefix}/bin along with the other programs yaz-client and
149 GNU automake used to maintain makefiles.
153 Changed retrieval module so that we can load records with no abstract
154 syntax defined. Tagpaths in these records are fully composed of string
157 Implemented ISO ILL protocol. Refer to stuff in sub directory ill.
161 On UNIX, the generated makefile now supports a proper 'make install'.
162 The prefix can be set via GNU configure to set the install location
163 (default is /usr/local).
165 * YAZ programs client and ztest were renamed to yaz-client and
166 yaz-ztest to avoid conflicts when users install YAZ in "standard"
167 locations, such as /usr/bin,/usr/local/bin,etc.
169 * YAZ Header files were moved from include to include/yaz. YAZ Header
170 files are referred to as include <yaz/log.h> rather than <log.h>.
171 The YAZ include path (-I ..) is therefore the same as before. Programmers
172 should update their #include statements or use -Ipath/include/yaz
173 instead. The main motivation for doing this change is that YAZ header files
174 can be installed in "standard" locations /usr/include,/usr/local/include
175 without introducing conflicts, since ALL YAZ header files are stored
176 in subdirectory yaz (under /usr/include for example).
178 Compilation of YAZ for WIN32 is now handled by an nmake-style makefile
179 rather than project/workspace files. We switched because project files
180 are incompatible between Visual C++ 5 and 6. Refer to windows.txt for
183 Changed name of logging function, logf, to yaz_log, to prevent name
184 clash with some math-log functions. The YAZ header log.h defines logf
185 to yaz_log (#define) so there should be no incompatibilities by this
188 Added bend_start/bend_stop handlers for server. These handler are
189 called on start/stop of server. For windows they are called whenever
190 a service is started/stopped.
192 * YAZ now auto-generates decoders/encoders for the Z39.50 protocol using
193 a fairly small ASN.1 compiler written in Tcl. The compiler is located
194 in util/yc.tcl. The auto-generated C code structures are, in a few
195 cases, incompatible with the old decoders. There are differences in the
196 following C structures Z_DiagRec, Z_External, Z_SortRequest, Z_SortResponse,
197 Z_AttributesPlusTerm, Z_ProximityOperator, Z_DefaultDiagFormat.
198 The preprocessor variable ASN_COMPILED is defined when the compiled
199 ASN.1 is being used. Encoder/decoder routines as well as the Z39.50
200 protocol ASN.1 is located sub directory <tt>z39.50</tt>. If you
201 wish to use the old encoders/decoders you can specify --disable-yc
204 Assigned OID for old DB Update (VAL_DBUPDATE0). Updated YAZ compiled
205 version so that it supports both new - and old version of DB Update
207 * Added 'name' parameter to ODR encoder/decoder routines to facilitate
208 pretty ODR print. Updated whole Z39.50 encoder/decoder to reflect the
209 change. The name parameter can be set to 0 in which no name is specified
210 for the construction. The macros odr_implicit and odr_explicit sets name
211 parameter to zero for the construction involved. New macros
212 odr_implicit_tag and odr_explicit_tag are similar to the others,
213 except that a name parameter is added. For programmers' that don't use
214 ODR they probably only need to change the call to z_APDU and z_External.
216 Added access control facility by interfacing the TCP wrapper library.
217 YAZ automatically attempts to find the TCP wrapper Library (-lwrap) and
218 tcpd.h on Unix systems. For the server, option -d<daemon> specifies the
219 name of the daemon and enables the access control as specified in
220 hosts.allow/hosts.deny. Refer to man pages tcpd(8) and hosts_access(5).
222 Fixed memory leak in ccl_find_str and ccl_qual_rm. Thanks to Hans van
223 den Dool <H.M.vdnDool@kub.nl>.
225 Added reference ID parameter to most functions in server API - refer
226 to backend.h. Thanks to Hans van den Dool <H.M.vdnDool@kub.nl>.
228 Changed name of ccl library to libccl.a (was ccl.a).
230 Fixed bug in decoder for Explain (Category TargetInfo).
232 Added support for GNU readline in client. Thanks to Jacob Poulsen
233 <ja7@dbc.dk>. GNU configure attempts to detect if readline is available.
235 * CHANGED DEFINITION OF ES: UPDATE (INCLUDING THE OID) to reflect the
236 new definition from the ZIG. NOTE THIS IF YOU HAVE AN UPDATE
237 IMPLEMENTATION! This change was made to the development version before
238 the ZIG decided to retract the amendment. If any users MUST be
239 compatible with the original Update definition, PLEASE CONTACT US, and
240 we will include a separate definition corresponding to the old Update
241 ES. Note that because of the change to the ASN.1 of the
242 TaskPackageRecordStructure we cannot define a single structure that
243 will support both versions.
245 * Added const modifier to buffer parameter for some ODR/BER encoding
246 routines: ber_dectag, ber_declen, odp_more_chunks, completeBER,
247 completeWAIS, odr_dumpBER.
249 Fixed bug in client.c which caused a crash when a scanResponse didn't
250 contain positionOfTerm.
252 * Fixed inconsistency in the ScanResponse/ListEntries protocol. This
253 * will cause an error in a client if a non-YAZ target sends both a
254 * list of Scan entries and non-surrogate diagnostics.
256 Retrieval module enhancements. Tag sets may be typed in the reference
257 to it. From the .abs-file the "tagset" directive takes a third optional
258 integer type for the tag set referenced. From a .tag-file the "include"
259 directive takes a third optional type as well. The old "type" directive
260 in the tag set itself is still recognized but acts as the default type
263 Backend interface change. Individual Scan terms returned from bend_scan
264 may also be tagged as Surrogate Diagnostics. Refer to struct scan_entry
265 in include/backend.h.
267 Retrieval module enhancements. Multiple tag sets and attribute sets may
268 be specified in abstract syntax specs. Revised the error/warning for
269 logging messages reported by the retrieval module when reading the
272 Object Identifier system (oid_..) changed. The API is backwards
273 compatible but the oid-routines now allocates new OID's when needed.
274 Raw OID's may be specified in oid_getvalbyname.
276 YAZ now uses GNU configure to generate Makefile(s).
278 * Minor changes in some of the member names of DeleteResultSetRequest and
279 DeleteResultSetResponse. See include/proto.h.
281 * Changed some C definitions regarding EXPLAIN record syntax (prt-exp.h)
282 and added member 'languages' in TargetInfo (which was missing).
284 Changed the way attribute sets are handled in the retrieval
285 module. These are now cached, just like the abstract syntaxes
288 Changed YAZ so that it links with compiled ASN.1.
290 Added Explain-schema definitions and mapping routines. The following
291 Explain categories have been implemented: AttributeDetails,
292 AttributeSetInfo, DatabaseInfo, CategoryList and TargetInfo.
294 Fixed minor bug in Windows version of Server Library.
296 --- 1.4pl2+ 1998/4/17 (Released with Zebra)
298 Added Extended Services to server (backend.h). Thanks to Charles Woodfield.
300 Added EXTERNAL: UNIverse Resource Report (non-standard).
302 Implemened odr_enum and odr_set_of functions to handle ASN.1 types
303 ENUMERATED and SET OF.
305 * Added 'const' to some of the char pointer arguments for the
306 functions, data1_read_node, data1_getelementbytagname,
307 data1_insert_taggeddata, data1_getesetbyname, data1_getelementbyname,
310 Fixed bug in data1_insert_taggeddata - the last_child member of
311 parent wasn't initialised.
313 * Changed data1_read_record and data1_read_node so that the supplied
314 "SGML"-buffer is read-only. In particular the resulting data1 - tree
315 doesn't refer to any parts of the "SGML"-buffer.
317 Fixed bug in server library (Windows version of statserv_remove).
319 * Changed code so that it compiles as C++. The type definition
320 of Odr_fun which is a member of Odr_arm was changed. The result is,
321 that an explicit typecast is needed for the fun pointer when
322 using Odr_arm - as in:
323 {1, -1, -1, Z_IdAuthentication_idPass, (Odr_fun)z_IdPass},
325 Updated TagSet-G and -M definitions (tagsetm.tag and tagsetg.tag).
327 Implemented the new structured date and time definition as approved
328 by the ZIG. Added schemaId element to the specificTag in Espec-1
329 (also approved at the last ZIG). Thanks to RVDM.
331 Added some Object identifiers (RVDM).
333 Changed the Update Extended Service (RVDM).
335 Added command "refid" to client which specifies referenceId for
336 the following requests.
338 Implemented extended service handling for server. See ztest.c
339 for an example as well as backend.h. New handlers are registerd
342 * Changed interface for sort in server.
344 Added new members to statserv_options_block. It allows a server
345 to read options from another source than just the command line. Thanks
346 to Charles Woodfield.
348 * Changed definition of Z_Triple in file prt-grs.h - member boolean
349 renamed to zboolean. Some C++ compilers complained about the name.
351 Minor changes to gils.abs. Added index 's' (sort) on title
352 and date/time-last-modified.
356 Fixed bug in server library regarding inetd mode (-i). This bug
357 was introduced by release 1.4.
361 Added sort facility in client and backend server interface.
363 Fixed problem with dependencies in Makefile(s).
365 Fixed bugs for encoders/decoders of extended services and
368 Implemented sub-tree feature for schemas. Sub-trees are
369 referenced in *.abs-files. See explain.abs for an example
370 of the use of this feature.
372 Modified bib1.att; local attributes for ANY didn't include
373 ANY itself (only affects use of the retrieval module).
375 Fixed bug in plain SGML reader in function data1_read_node:
376 tags with prefix "var" was incorrectly interpreted as variants.
378 Added feature "sub-schemas" to enable references to - and definitions
379 of - group of elements.
381 * Removed member parent from type data1_element (in data1.h).
383 Implemented function odr_nullval() that returns the value of
386 * Removed member num_children from data1_node (in data1.h).
388 Made NT service interface part of the server library. The
389 function statserv_main uses the NT service when required and
390 calls the statserv_start / statserv_close routines.
392 Routine zget_SearchRequest and zget_PresentRequest fills
393 resultSetName/Id member with "default" instead of "Default".
395 Fixed memory leak in server. Request queue member wasn't freed.
397 Fixed nmem_exit so that memory is freed.
401 Revised the CCL parser utility to be thread safe.
403 Added function, oid_ent_to_oid, to replace the function
404 oid_getoidbyent, which is not thread safe.
406 * Added nmem_init and nmem_exit to initialize and release
407 NMEM resources. Function nmem_init should be called once in the
408 initial thread before NMEM/ODR is used. statserv.c and client.c
409 have been changed accordingly. The change was necessary to make
410 NMEM thread safe. The NMEM memory pool is shared amongst threads
411 in a process. Unix-based applications will still work fine without
414 Added NT Services interface for the the Z39.50 (statserv) Server.
415 Refer to the ztest.c source on the usage.
417 Windows 95/NT port using MSVC5.0. Project files are included in the
420 * Defined new 'global' handle for the retrieval (data1) system. The
421 new handled, data1_handle, describes the state of the data1 system.
422 This handle is passed as first argument to virtually all
423 data1 related routines. The functions data1_create and data1_destroy
424 creates and destroys a data1 handle respectively.
426 Added ODR encode stream member to all backend request structures
427 init, search, scan etc. This stream should be used to allocate all
428 memory used for the response when thread safe operation is needed.
430 Changed the comstack utility, cs_addstr, to be thread safe. The
431 returned hostname string returned by the function is now part the
434 Added comstack utility, cs_straddr, which replaces the tcpip_strtoaddr
435 function. The cs_straddr takes a COMSTACK handle as argument, so this
436 function must be used after cs_create and before bind/connect.
437 This function is thread safe.
439 Moved test server to 'ztest' directory - generic server code still
440 in 'server' directory.
442 Made prefix query (pquery.c) utility thread safe.
444 Added new function modifier YAZ_EXPORT to 'export' public DLL
445 functions when using windows (see include/yconfig.h).
447 Added definitions to the OID database (util/oid.c) (RVDM).
449 Added new BIB-1 diagnostic messages to the handler diagbib1_str.
451 Added call to ccl_rpn_delete in client program.
453 Added ODR argument to ccl_rpn_query and ccl_scan_query to provide
454 release of RPN structure.
456 Added support for C++, headers uses extern "C" for public definitions.
457 With input from RVDM.
459 In handling of SEQUENCE OF: Counter set to zero when SEQUENCE OF is absent.
460 Thanks to Ronald van der Meer (RVDM).
462 Added initializers (zget_ routines) for a number of PDUs. Thanks to RVDM.
464 Added support for private extensions to the OID database
465 (oid_setprivateoids()). Thanks to RVDM.
467 Added optional, physical ANY (key replication)
469 Fixed null-reference problem in GRS-1 output filter.
471 Proximity operator added to Prefix Query Format (PQF).
473 In test client command "base" accepts multiple databases.
475 Fixed bug in cs_close stack that caused trouble with WINSOCK.
479 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
481 Smallish bug-fixes in the new encoders/decoders (explain).
483 Bug fixed in DeleteRequest.
485 Fixed tagging bug of type 101 query in SearchRequest-Query PDU encoder/decoder.
487 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
489 Added SOIF syntax (using private OID for now) to retrieval module and client.
491 Added Update extended service.
493 Added SearchResult-1 additional info structure.
495 Added optional CCL (ISO8777) interpreter as separate module. Available
498 --- 1.2 1996/6/10 (1st anniversary release)
500 Added Summary record syntax. Lightly tested.
502 Added OPAC record syntax. Untested.
504 Added ResourceReport service encoders/decoders. Untested.
506 Fixed bug in z_Unit - wrong tagging on unitSystem.
508 Fixed bug in the DiagRecs decoder.
510 Added options for max PDU size and session timeout to frontend-server.
512 Added documentation of query-language parsers and other supporting utilities.
514 [frontend-server] Added Attribute set to the bend_scanrequest API.
516 [frontend-server] NextResultSetPosition was sometimes set incorrectly when
517 surrogate diagnostics were generated.
519 [retrieval] Allow multiple local values for attribute.
521 [retrieval] Allow multiple attributes per element in .abs files. index type.
523 [retrieval] Added Summary tagset, abstract syntax, and d1-node/ASN filter.
527 Minor changes, mostly specific to Zebra's requirements (retrieval)
531 Repaired bug in frontend server when running multiple listening
532 endpoints in dynamic mode.
534 z_External() now won't break if a known, ASN.1 value comes encapsulated
535 in an octet-string. The value will pass through unmodified in an Odr_oct.
537 Added a bit of code to the demo client to decode & display
538 ASN.1-structured records represented in the octet-aligned branch of
539 the EXTERNAL CHOICE. Thanks to CAS for prodding us to finally do this.
541 Added z_ext_getentbyref() to the ASN module. Doc updated.
543 * Completed the SCAN definition in the ASN module. This may break SCAN
544 code based on older YAZ-versions at compile-time. The fix is easy -
547 * Added 'displayTerm' and OtherInformation to the TermInfo structure
548 under the SCAN definition. Remember to initialize this, server-people.
550 Comstack should now support the WAIS protocol in TCP/IP mode. Note
551 that this does not extend to ODR and ASN.
553 Comstack allows insertion of established socket (primarily for
554 inetd-operation of servers). Doc updated.
556 Front-end server can now start from the inetd in TCP mode. Doc
563 Fixed small problem in SUTRS-filter. A newline was sometimes inserted before
564 the rank and record number.
566 Adjustments to the frontend server.
568 Fixed diagnostic BER dumper. It ignored the file argument.
572 Various changes to retrieval module.
574 Changed the union discriminators of the protocol files from enums to
575 ints paired with #defines.
577 *Changed oident.class to oident.oclass to avoid a reserved word in C++
580 *Changed operator in the RPN structure to 'roperator', again to avoid a
583 Fixed problems in Explain decoders/encoders.
587 Memory bug in log module fixed.
591 Occasional malloc() of 0 bytes fixed in d1_espec.c.
593 Bug in Explain DatabaseInfo module fixed.
595 Some '\r' snuck into one or two of the ret'l config tables. A curse on Windows.
599 The shift to v1.0 signals that we now consider the *core* functionality
600 of YAZ reasonably stable (the core being more or less equivalent to
601 Z39.50-1992). Some of the really nifty v3 stuff is still not heavily
602 tested (Explain not at all - though that will happen soonish).
604 Minor changes to code to support Windows port.
606 Various minor changes after we're getting to use GRS-1 & co. more.
608 Added Espec-1 format.
610 Added VisibleString field body type to GRS-1. It is illegal acc. to my copy
611 of the protocol and it cannot be selected when encoding (maps into 'string'
612 when decoding). Needed to talk to some servers.
614 Demo client can request simple element set names.
616 Added Diagnostic Format encoders/decoders.
618 Added simple Close handling to frontend server (no hooks for resource
619 reporting yet), and demonstration client.
621 Added cs_addrstr() command to COMSTACK to retrieve peer hostname/address.
625 Fixed bug in the frontend-server. The numberOfRecordsReturned field was
626 handled incorrectly when records were requested in the searchResponse. This
627 will only affect you if you use the frontend-server.
629 Added GRS-1 encoders/decoders to the service-level API. Lightly tested.
630 Test-client will ask for and print GRS1. Ztest will return dummy records
633 Added Explain encoders/decoders to the service-level API. Untested.
635 Added Extended Services: Item Order encoders and decoders to the Service-
636 level API. Untested. We could use a recent copy of the pertinent bits
637 of the ILL protocol to add those bits.
639 Added diagnostic format 1 encoders/decoders to the service-level API.
642 Moved pretty-printing of structure-wrappers ({..}) from odr_seq.c to
643 odr_cons.c, which causes a more correct output.
645 Fixed handling of searchRequest in frontend server. NextResultSetPosition
646 was always set to 0 when no records were requested in the searchRequest.
648 * Added better external-handling. This shouldn't harm old code that
649 *encodes* externals. It can break code that looks for a
650 'single-ASN1-type' representation, since those types that are known
651 are now decoded immediately. Look at the SUTRS sample code in
652 seshigh.c and client.c. Documentation updated.
654 Handling of structured records in bend_fetchresponse. Length -1 marks
655 structured record, type is deduced from format field.
658 Fairly quick maintenance release to add SUTRS support.
660 Fixed handling of SUTRS records in the demonstration client.
662 * Added format field to the bend_fetchrequest and bend_fetchresponce
663 structures of the backend API (frontend server). When the record is
664 returned, the value of the format field is mapped to an OID. The
665 value VAL_SUTRS will also cause a slightly different ASN.1 packaging
666 of the record. The special value VAL_NONE in the bend_request means
667 that no specific format was requested by the client. Documentation
668 updated accordingly. Test server (ztest) will return a fixed dummy
669 SUTRS record if your client requests SUTRS.
671 Documentation updated accordingly.
673 You can now set external libraries and RANLIB support in the top-level
677 First public release.