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