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