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