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