1 Possible compatibility problems with earlier versions marked with '*'.
3 Fix bug in SRW/SRU diagnostics decoding.
7 Fixed bug in Generic Frontend Server which could drop records exceeding
8 preferred message size. Reported and fixed by Irina Dijour.
10 Fixed calculation of package size for structured records in Generic
11 Frontend Server. Reported and fixed by Irina Dijour.
13 Fixed namespace for SRW/SRU diagnostics.
15 Fixed SEGV in yaz-client that occured for HTTP connection errors.
19 * SRW/SRU 1.1. Since the Namespace has changed for SRW/SRU, it means that
20 this version is incompatible with version 1.0 and older YAZ SRW/SRU
23 CQL changes to reflect recent changes to the specification:
24 * Documentation talks about context sets instead of index sets.
25 * Documentation talks about indexes instead of qualifiers.
26 * The CQL-to-PQF transformer's configuration file now uses
27 "index.set.name = <attributes>" instead of the old form
28 "qualifier.set.name = <attributes>". (Both forms are still
29 understood but the latter is deprecated.)
30 * CQL terms with no explicit index specified are now interpreted as
31 cql.serverChoice instead of srw.serverChoice (which of course
32 behaves exactly the same.)
36 MARC conversion can now generate ISO2709 output in another
37 character set. yaz-marcdump uses this facility if you invoke it
40 Added missing C decl macros for include/yaz/{soap.h,srw.h,cql.h}, so that
41 functions from there can be used from C++.
45 Frontend server now transfers memory from decoded packages to stream
48 NMEM now clears freed blocks with 'Y' (hex 59) to force bad memory
49 references to show up.
51 ZOOM-C now supports standard ZOOM option names as described in v1.4 of
52 the ZOOM Abstract API. The older names for the same options are still
53 also supported for the benefit of old applications.
55 ZOOM-C supports "implementationId" and "implementationVersion" options
56 to go along with "implementationName". These allow the user code to
57 specify identification strings to be sent to servers.
58 Add OID for the new ExtLite attribute set.
60 Add OIDs for NACSIS-CATP, FINMARC2000 and MARC21-fin record-syntaxes,
61 as requested/supplid by Ere Maijala <ere@atp.fi>
63 For generic frontend server, reverse the order of
64 "toolkit-supplied / application-supplied" strings sent as implementationId,
65 Name and Version. Also, remove the spaces around the slash. This brings
66 the GFS in line with the behaviour of ZOOM-C on the client side.
68 Add function ZOOM_scanset_display_term.
70 yaz-client shows scan displayTerm if present.
72 Utility yaz-iconv is now installed by default along with the man page
75 Extend configure check for OpenSSL to use pkg-config where available (such
78 Incorporate patch by Morten Bogeskov which allows a Unix file socket
79 server to specify uid/gid/mask for socket using the format
80 unix:[user=uid,][group=gid,][umask=mask,]file=path
81 If file= is omitted the existing format is assumed, e.g.
83 in which case the mask is 0666 (rw for everybody).
85 Major restructure of YAZ source. All source in libyaz is in src directory.
86 Programs in client (yaz-client), ztest (yaz-ztest), zoom (zoom programs),
87 util (utility programs such as ASN.1 compiler, yaz-marcdump).
89 Added man page for utility yaz-marcdump (used to be called marcdump).
90 yaz-marcdump is installed by 'make install'.
92 Fixed a memory leak in Generic Frontend Server that occurred when decoding
93 of incoming package failed.
95 Fixed a potential DOS attack vulnerability in COMSTACK/ODR.
97 Change prototype of odr_perror: add const to message string.
99 New function yaz_log_reopen which reopens log file (for log rotate, etc.)
101 * Blocking parameter for COMSTACK cs_create is now a bit mask rather
102 than a blocking flag. Bit 0 is set for blocking, reset for non-blocking.
103 Bit 1 is set if cs_addrstr should avoid DNS lookup; reset for full
104 DNS lookup. There should not be any compatibility problems with this
105 assuming that blocking=1 or 0 is used.
107 Fix bad reference in UNIX comstack in function cs_addrstr.
109 Fix for compilation on AIX.
111 The generic front-end server (server/seshigh.c) now supports returning
112 Init diagnostics to the client in User-information-field, in
113 accordance with Z35.90 Implementor Agreement 5 (Returning diagnostics
118 Allow any CQL relation (not just all,any,exact,scr).
120 Fixes for OCLC UI ASN.1 to make it work with SilverPlatter targets
121 that features the same UI.
123 Implemented command update0 in YAZ client which is equivalent to
124 update but uses old of Ext Update ASN.1.
126 Use OID 1.2.840.10003.15.1000.81.1 for privately defined charsets
127 in charset negotiation. Added VAL_ID_CHARSET in oid.h.
128 Previously no OID was used for this info.
130 ZOOM uses smallSetUpperBound=1 instead of 0 for piggyback searches.
131 It apparantely upsets EBSCO Publishing IR Z39.50 Server which
132 returns 'malformed search term' otherwise.
134 SortResponse member resultCount now set to NULL in sort handler of
137 OPAC support ZOOM. ZOOM_record_get returns OPAC info (as XML) if
140 Add three new utility functions for translating OIDs between various
141 formats -- symbolic name such as "Usmarc", minus-1-terminated int
142 arrays and dotted strings such as "1.2.840.10003.9.5.1":
143 int *oid_name_to_oid(oid_class oclass, const char *name, int *oid);
144 char *oid_to_dotstring(const int *oid, char *oidbuf);
145 char *oid_name_to_dotstring(oid_class oclass, const char *name, char *oidbuf);
147 Reverted modifications for ES Update definition for z_IU0Update
148 (OID 1.2.840.10003.9.5.1 and 1.2.840.10003.9.5). The definition
149 is back to YAZ 2.0.2.
151 String value attributes for CCL parser.
153 Support for OCLC's locally registered "OCLC-UserInformation" PDU,
154 which their FirstSearch server returns in Init responses, sometimes
155 carrying useful diagnostic information when Init fails. This has the
156 OID 1.2.840.10003.10.1000.17.1 and is defined in the file
157 "z39.50/oclcui.asn", where its definition is somewhat different from
158 what OCLC document on their web-site, as required to interoperate with
161 Support for anonymous authentication in yaz-client. Use the command
164 * Fix the OID of the Index Data-local "admin" Extended Service from
165 1.2.840.10003.9.81.1 to 1.2.840.10003.9.1000.81.1. The omission of
166 the 1000, which indicates a locally-defined OID, was a mistake.
170 Fix CCL directive @case handling so that it affects string match for
171 both CCL keywords and qualifiers.
173 * ESFormat-Update updates. Packages with OID 1.2.840.10003.9.5.1 and
174 1.2.840.10003.9.5 are now handled by the same decoder z_IU0Update .
175 Decoder has been updated with ASN.1 changes as listed in
176 http://lcweb.loc.gov/z3950/agency/defns/updateES.html
177 Note that the "latest" DB Update, OID 1.2.840.10003.9.5.1.1 , handler
178 z_IUUpdate, remains unchanged.
180 ZOOM_record_get may now return a record in a specific character set.
181 For type use "form; charset=from[,to]" where form (render, xml, ..) ,
182 "from" is the character set of record as returned by target. "to" is
183 the character set to be returned. If omitted, "to" is UTF-8.
185 YAZ ASN.1 compiler renamed from yaz-comp to yaz-asncomp
187 New ODR utility, odr_getelement, which returns name of element for
188 which encoding/decoding failed.
190 Fixed ODR so that it returns error code OREQUIRED rather than ONONE
191 in cases where a required element was omitted.
193 Bug fix: some MARC8 sequences were not converted.
195 New ZOOM option "step" which specifies number of records to be
196 retrieved in one chunk. Used in conjunction with "start" and "count".
198 SRW support for yaz-client. Use scheme http: to use it, e.g.
201 yaz-client no longer does (un)intelligent character set conversions
202 by default. Can be enabled with charset and marc_charset commands.
204 xmalloc trace fix for 64-bit systems such as DEC alpha.
206 Solaris 2.6 compile fix.
208 New function, cql_strerror() translates SRW error codes, as returned
209 by cql_transform_error(), into human-readable English strings. Used
210 in yaz-client diagnostics when appropriate.
212 New CQL2RPN query-type for the command-line yaz-client, parses CQL and
213 converts it into a type-1 query which is sent to the server. This
214 makes CQL available for use with all Z-servers, as opposed to the tiny
215 minority that can handle CQL queries themselves.
219 New Debian package layout similar to the Redhat Package layout.
221 New ZOOM events ZOOM_EVENT_RECV_{RECORD,SEARCH} for receiving a record
222 and search result respectively.
226 Redhat package is now several packages: libyaz (runtime libraries),
227 libyaz-devel (development and documentation, and yaz (utility programs).
228 Package spec file by Morten Bøgeskov.
230 New member 'schema' in struct bend_fetch_rr which the name of requested
231 schema (SRW/SRU) for record (or NULL if none was given). The fetch
232 handler MAY set this to reflect the schema of the returned record.
234 New member 'display_term' in struct scan_entry. GFS now sets member entries
235 and allocates scan entries to be filled by user scan handler. In previous
236 version, entries member was allocated by the scan handler. That still works,
237 but the GFS will ignore member display_term - assuming it was NOT set by
238 the handler. The fact that the GFS now allocates the entries both allows
239 for new members and makes a scan handler easier to write.
241 Fix CQL lex buffer overflow.
243 SRW/SRU recordPacking. For SRW default recordPacking is string. For
244 SRU default recordPacking is string.
246 SRU protocol support for frontend server.
248 Fix compile bug for systems that have nl_langinfo but CODESET undefined.
250 Added missing PQF transform rules for <= and >= . Thanks to Peter Popovics.
252 Added scan for the ZOOM shell (zoomsh).
256 * String Identifers for Schemas (Amendment 5).
257 http://lcweb.loc.gov/z3950/agency/amend/am5.html
258 Old definition for schema
259 Odr_oid *schema; /* OPT */
264 Z_InternationalString *uri;
265 #define Z_Schema_oid 1
266 #define Z_Schema_uri 2
269 * resultCount parameter to Sort Response (Amendment 1).
270 http://lcweb.loc.gov/z3950/agency/amend/am1.html
272 Support for SRW 1.0 over HTTP. This is an optional feature and
273 requires libxml2 to operate. Enable SOAP by specifying --with-xml2
276 Generic frontend server supports HTTP/SOAP/SRW and Z39.50/BER
277 on the same port. SRW SearchRetrieveRequests are mapped
278 to bend_init,bend_search,bend_fetch,bend_close.
280 Z39.50 Query Type-104 added - to facilitate CQL within Z39.50.
282 CQL support. Source is directory 'cql'. CQL is supported in ZOOM
283 (both SRW and Z39.50) and the YAZ client (Z39.50 only).
285 ZOOM connections are SRW based if schem http is used for hostname
286 in connect, e.g. z = ZOOM_connection_new("http://myserver");
287 ZOOM_query may be of type CQL, e.g. ZOOM_query_cql(q, "dc.title=x");
289 CCL proximity operators !n, %n converts to PQF @prox 0 n 1 2 k 2
290 and @prox 0 n 0 1 k 2 respectively, meaning: exlusion=false,
291 distance=n, order=true/false, relation=le, prox unit=word. If
292 n is omitted, distance 1 is used.
294 Fixed problem with C compiler include path in wrong order.
296 For TCP/IP COMSTACK, set recv buffer to an appropriate "large" value
297 on Solaris. Patch from Ko van der Sloot.
299 New MARC decode API. All new functions operate on a yaz_marc_t
300 handle. The most important new functions are: yaz_marc_create,
301 yaz_marc_decode_{buf,wrbuf}, yaz_marc_destroy, .. to create handler,
302 decode and destroy respectively. Decoder can produce formats
303 MARC line, simple XML, OAI MARC and MARC XML (LoC). See
304 include/yaz/marcdisp.h.
306 YAZ Iconv utility now supports MARC8 decoding (marc8.c). Converts
307 to UTF-8, UCS-32, wchar_t or Latin-1.
309 * Prototypes for yaz_iconv_-functions moved to separate header
310 include/yaz/yaz-iconv.h.
312 Make a few private functions 'static' in unix.c. This prevents
313 duplicate unix_close in PHP with YAZ and imap. PHP Bug 20977.
315 For ZOOM connection, the options targetImplementation{Id,Name,Version}
316 are set when Init Response is received.
318 New function ZOOM_connection_error_x similar to ZOOM_connection_error
319 but returns diagnostic set as well.
321 New function yaz_strerror which is a portable wrapper for
322 strerror/strerror_r/GetLastMessage.
324 * ZOOM_record_get supports type "xml" in which case MARC XML (from LOC)
325 is returned for MARC. If type is "oai", then OAI MARC is returned.
327 Fix creation of lib/yaz-config so it works if srcdir != objdir. Patch
332 yaz_marc_decode uses OAI MARC as XML format for ISO2709 records.
334 Fix bad race conditions on SIGTERM and terminate gracefully in
337 Move retrieval (data1) module to Zebra since nobody seems to be
340 Add GRS-1 render for ZOOM using same format as yaz-client.
344 Added man pages: yaz-client(1), yaz-ztest(8), yaz(7), zoomsh(1).
346 Fix broken ESpec handling in data1 module.
348 SGML reader parses comments and makes them part of the data1 tree.
350 Added several type casts so that YAZ compiles as C++ code.
352 ZOOM didn't handle PDU encoding failures properly.
354 Added more Bib-1 diagnostics (approved extensions).
356 GNU configure: better check for iconv.
358 More portable use of accept, getpeername. Check for socklen_t. Use
359 int/size_t if socklen_t is not defined.
363 PQF parser rejects bad queries - including those with extra
364 characters in them. PQF parser used to silently ignore that.
365 Cleaner API for PQF added, which allows you to get detailed
366 error information for bad queries (see yaz/pquery.h).
368 Fixed bug in ZOOM_record_get for type "database".
370 Implemented mini iconv library supporting conversions between
371 UTF-8, UCS4, UCS4LE and ISO-8859-1. Implemented in util/siconv.c.
373 * Removed XML reader (d1_expat.c). It's part of Zebra instead.
377 Fixed ZOOM C record cache so that preferredRecordSyntax and
378 elementSetName is used to check for already fetched records.
382 Added three members in bend_initrequest structure to facilitate
383 character set negotiation.
385 Fixed a bug in frontend server that could cause indefinite
386 loops under rare conditions.
388 Revised character set utilities (charneg.h) so that encoding
389 UCS-4, UCSA-4, UTF-16 and UTF-8 are encoded non-privately.
391 For PQF, directive @term <type> sets term type for Scan/Search.
392 Here <type> is general, string, numeric, null. The term type
393 is inherited - just like @attr.
395 New call odr_set_charset that sets character set conversion for
396 international-strings on a ODR stream. Prototype is:
397 int odr_set_charset(ODR o, const char *to, const char *from);
398 The InternationalString is still represented as C string in YAZ
399 so native strings of type UTF-8, ASCII, etc. will work (UTF-16
400 won't). On the protocol level, you can use any encoding.
402 Support for UNIX sockets in ZOOM.
404 Solaris recv sometimes returns errno == ENOENT. It is treated as
405 EINPROGRESS. COMSTACK patch by Ko van der Sloot.
407 New COMSTACK of type UNIX Socket. Use "unix:/path" as address for
408 both client and server. Code by Morten Bøgeskov.
412 On Windows ZOOM functions are of type __stdcall rather than __cdecl, so
413 that they can be used directly from Visual Basic. You must recompile
414 your windows APP if you're using ZOOM.
416 Character Set and Language Negotiation(3) for ZOOM API and YAZ client.
417 Commands "lang" and "charset" sets language and character set respectively.
418 Options "lang" and "charset" is interpreted by the ZOOM API. Note, these
419 are not part of the official ZOOM spec) All is due to Oleg Kolobov.
421 Attributes from multiple CCL fields may be OR'ed rather than merged
422 using directive "@field or". Fields are still merged by default -
423 equivalent to "@field merge".
425 Fixed bug in ZOOM connect that occurred on OpenBSD (maybe others). Patch
428 Fixed bug in zget for parameter ExtendedServicesResponse.
434 Added PQF feature: '@attr type=value' may be written as '@type=value'.
436 Client displays USR.1:SearchResult-1 (hits per term).
438 Additional Search Info for search in Generic Frontend Server.
440 Fixed CCL parsing of "field=s".
442 WIN32 installer - using the excellent NSIS software from nullsoft.
444 Fixed CCL parsing of "field = - <number>".
446 Added function yaz_marc_decode that decodes MARC for line mode
447 display or XML (similar to that used by JZKit).
449 Fixed BER decoding of OPTIONAL CHOICE. The bug didn't affect the
450 Z39.50. But ISO/ILL was, however.
452 Added patch by Rustam T. Usmanov that implements Z39.50 duplicate
453 detection service (Z39.50-1995 Amendment 2) and Language Negotiation (3).
455 http://lcweb.loc.gov/z3950/agency/amend/am2.html
456 http://lcweb.loc.gov/z3950/agency/defns/charneg-3.html
460 New YAZ client features: Command completion and new commands:
461 push_command, set_apdufile, set_marcdump, set_cclfields, register_oid.
462 Code provided by Jacob Poulsen.
464 New call oid_trav, that visits all registered OIDs via callback.
466 Function ZOOM_record_get now returns const char pointer rather than
467 void pointer. It saves a lot of type casts.
469 For YAZ client, command "auth" now allows you to set authentication
470 in IdPass style. It is enabled when three tokens are given - order
471 is user, group and password.
473 Fix memory leaks in MARC record handling for ZOOM.
475 New option for YAZ client, -k <kilobytes> that sets
476 maximum record size. Similar to -k option for generic frontend
477 server and yaz-ztest.
479 More fixes for scan. Non-zero stepSize handled. OID's fixes.
481 Prefix query parser reports "fail" when bad attribute set is given.
483 Fix in MARC decoder. Proximity logging. Fix for attribute set
484 in scan handler for server. Patches by Shigeru Ishida.
486 SSL/COMSTACK updates. cs_rcvconnect completes SSL handshake. ZOOM
489 Configure option --with-openssl=<dir> now works when a directory is
490 specified. Patch provided by Morten Bøgeskov.
492 New option for YAZ client, -u <auth>, that sets authentication.
494 ZOOM fix: error information was sometimes "missing", since error
495 was cleared/reset too when it shouldn't.
497 ZOOM_record_get returns ISO2709 buffer when "raw" is given.
501 Scan for ZOOM API. New object ZOOM_scanset. New functions
502 ZOOM_connection_scan, ZOOM_scanset_size, ZOOM_scanset_term and
503 ZOOM_scanset_destroy.
505 New ZOOM function, ZOOM_connection_last_event, that returns type
506 of last event (such as "receive data", "send data", "apdu received",
509 New ZOOM option, schema, that specifies schema for retrieval.
511 New CCL feature. Qualifiers can be aliases for one or more
512 other qualifiers (if more than one is given, OR is used).
514 ZOOM uses named result sets if target supports it.
516 Two new YAZ client commands: . (dot, which sources a script of YAZ
517 client commands), and ! (to execute shell command.). Implemented
520 Working on Debian packages.
524 YAZ client enables named result sets only if target supports it.
526 *** ZOOM. Prefix for ZOOM definitions changed from Z3950_ to ZOOM_.
528 * ZOOM. Removed Z3950_connection_host. Use Z3950_connection_option_get
529 with key="host" to get same result.
531 * ZOOM. Added Z3950_record_clone and removed Z3950_resultset_get.
532 Function Z3950_resultset_record(s) returns references to records
533 "owned" by resultset. To become owner use Z3950_record_clone.
535 Function z_ext_record handles Extended Services. Thanks to
540 CCL Parser fix: ignore token comma when dealing with and-lists.
542 Documentation updates for COMSTACK.
544 * ZOOM changes. Query object renamed from Z3950_search to Z3950_query.
545 Changed prototype Z3950_records. For some functions, int parameters
546 were changed to size_t.
548 TCP/IP COMSTACK no longer uses getprotobyname to avoid memory leak
551 New MARC decode/display function, marc_display_exl, which properly rejects
552 non-ISO2709 records. YAZ client uses it.
556 Fix bug: local attribute set wasn't set correctly in PQF strings.
560 * Old Z39.50 codecs no longer supported.
562 Added ZOOM C binding. See http://zoom.z3950.org/
564 Renamed states for COMSTACKs to avoid confusion with events.
566 Implemented cs_look and proper cs_rcvconnect.
568 Fixed COMSTACK error that occurred on HPUX. Fix by Giannis Kosmas.
570 Configure detects POSIX threads on OpenBSD.
572 When sort flag 'i' was specified in yaz-client the caseSensitivy flag
573 was set to a wrong value. Thanks to Robert Sanderson for reporting this.
575 When error is returned from present handler, non-surrogate diagnostic
576 is returned in present response (and fetch handler is no longer called).
578 * Minor adjustments to pquery parser (PQF). Token characters may be
579 escaped by using backslash (C-style).
581 PQF parser allows string attribute values to be specified. For @attr,
582 non-numeric characters after the equal-sign are treated as strings
583 (e.g. @attr 9=title).
585 CCL trunction character may be defined (@truncation in file)
587 * function zget_ExtendedServicesRequest sets waitAction to
588 waitIfPossible (was wait).
590 Added cs_set_blocking to set change blocking mode of a COMSTACK. Thanks
593 CCL operator names may be set in field definition files (CCL_bibset).
594 See ccl/bib1 for an example.
596 Fixes in ASN.1 compiler for C++ compatibility.
598 * Renamed members "and" and "or" in struct Z_Operator to "op_and"
599 and "op_or" to avoid conflict with C++.
601 Fixed problem with GNU readline detection on Redhat 7.0.
603 Added step-size for Scan backend handler.
605 Fixed bug that made the frontend server crash when no attribute
606 set was specified for scan.
608 Front-end server automatically switches to original working directory
609 when installed as an NT service. Previously -w had to be specified to
612 Added extended attributes for retrieval module (data1), so that data1
613 records carry d1_readXML/SGML attributes. d1_read also supports
614 null-data rules ( <tag/>)
616 On UNIX when POSIX threads are available, a separate library libyazthread
617 is created. Programmers should link with that library and the yaz library
618 when using threads. The reason for the split was that some applications
619 on Linux, such as Apache, doesn't work well when using shared objects that
622 Added SSL support for the COMSTACK. You start yaz-client and yaz-ztest
623 (or any frontend server) in SSL mode by specifying ssl: followed by
624 address. Only tested on UNIX.
626 Added feature for CCL module. Virtual structure s=al or s=ol generates
627 and-list and or-list respectively instead of phrase search.
631 * Added prefix "yaz_" for the functions log_init.., log_file.. and
632 log_mask_str. This was done to avoid name conflicts with other libraries
633 (such as other PHP extensions).
635 Added raw OID member for preferred record syntax (request_format_raw)
636 and returned record syntax (output_format_raw) for backend fetch method.
638 Config file yaz-config now accepts options so that it returns specific
639 compile settings, etc. Thanks to Morten Bøgeskov <morten@bogeskov.dk>
641 Shared library support for UNIX using GNU libtool.
643 * Modified backend interface. Request/Response struct's replaced by
644 one read/write C struct. For example bend_fetchrequest and
645 bend_fetchresult have been replaced by single bend_fetch_rr struct.
646 Every handler - even search has to be registered in bend_init
647 handler. This means that the YAZ library no longer refers to
648 external functions and it makes it possible to make the whole
649 thing a single DLL/SO.
651 Added Segment handler for backend server.
653 Added Zmbol/Zebra administrative functions to YAZ client.
655 Threaded frontend server on UNIX (when POSIX Threads are available).
656 Starting the server with option -T enables multi-threading.
660 Added configure option --enable-comp/disable-comp to control use
661 of YAZ ASN.1 compiler. Use --disable-comp to use the old *coders
662 located in sub directory asn.
664 YAZ ASN.1 compiler renamed to yaz-comp in sub directory. It's installed
665 in ${exec_prefix}/bin along with the other programs yaz-client and
668 GNU automake used to maintain makefiles.
672 Changed retrieval module so that we can load records with no abstract
673 syntax defined. Tagpaths in these records are fully composed of string
676 Implemented ISO ILL protocol. Refer to stuff in sub directory ill.
680 On UNIX, the generated makefile now supports a proper 'make install'.
681 The prefix can be set via GNU configure to set the install location
682 (default is /usr/local).
684 * YAZ programs client and ztest were renamed to yaz-client and
685 yaz-ztest to avoid conflicts when users install YAZ in "standard"
686 locations, such as /usr/bin,/usr/local/bin,etc.
688 * YAZ Header files were moved from include to include/yaz. YAZ Header
689 files are referred to as include <yaz/log.h> rather than <log.h>.
690 The YAZ include path (-I ..) is therefore the same as before. Programmers
691 should update their #include statements or use -Ipath/include/yaz
692 instead. The main motivation for doing this change is that YAZ header files
693 can be installed in "standard" locations /usr/include,/usr/local/include
694 without introducing conflicts, since ALL YAZ header files are stored
695 in subdirectory yaz (under /usr/include for example).
697 Compilation of YAZ for WIN32 is now handled by an nmake-style makefile
698 rather than project/workspace files. We switched because project files
699 are incompatible between Visual C++ 5 and 6. Refer to windows.txt for
702 Changed name of logging function, logf, to yaz_log, to prevent name
703 clash with some math-log functions. The YAZ header log.h defines logf
704 to yaz_log (#define) so there should be no incompatibilities by this
707 Added bend_start/bend_stop handlers for server. These handler are
708 called on start/stop of server. For windows they are called whenever
709 a service is started/stopped.
711 * YAZ now auto-generates decoders/encoders for the Z39.50 protocol using
712 a fairly small ASN.1 compiler written in Tcl. The compiler is located
713 in util/yc.tcl. The auto-generated C code structures are, in a few
714 cases, incompatible with the old decoders. There are differences in the
715 following C structures Z_DiagRec, Z_External, Z_SortRequest, Z_SortResponse,
716 Z_AttributesPlusTerm, Z_ProximityOperator, Z_DefaultDiagFormat.
717 The preprocessor variable ASN_COMPILED is defined when the compiled
718 ASN.1 is being used. Encoder/decoder routines as well as the Z39.50
719 protocol ASN.1 is located sub directory <tt>z39.50</tt>. If you
720 wish to use the old encoders/decoders you can specify --disable-yc
723 Assigned OID for old DB Update (VAL_DBUPDATE0). Updated YAZ compiled
724 version so that it supports both new - and old version of DB Update
726 * Added 'name' parameter to ODR encoder/decoder routines to facilitate
727 pretty ODR print. Updated whole Z39.50 encoder/decoder to reflect the
728 change. The name parameter can be set to 0 in which no name is specified
729 for the construction. The macros odr_implicit and odr_explicit sets name
730 parameter to zero for the construction involved. New macros
731 odr_implicit_tag and odr_explicit_tag are similar to the others,
732 except that a name parameter is added. For programmers' that don't use
733 ODR they probably only need to change the call to z_APDU and z_External.
735 Added access control facility by interfacing the TCP wrapper library.
736 YAZ automatically attempts to find the TCP wrapper Library (-lwrap) and
737 tcpd.h on Unix systems. For the server, option -d<daemon> specifies the
738 name of the daemon and enables the access control as specified in
739 hosts.allow/hosts.deny. Refer to man pages tcpd(8) and hosts_access(5).
741 Fixed memory leak in ccl_find_str and ccl_qual_rm. Thanks to Hans van
742 den Dool <H.M.vdnDool@kub.nl>.
744 Added reference ID parameter to most functions in server API - refer
745 to backend.h. Thanks to Hans van den Dool <H.M.vdnDool@kub.nl>.
747 Changed name of ccl library to libccl.a (was ccl.a).
749 Fixed bug in decoder for Explain (Category TargetInfo).
751 Added support for GNU readline in client. Thanks to Jacob Poulsen
752 <ja7@dbc.dk>. GNU configure attempts to detect if readline is available.
754 * CHANGED DEFINITION OF ES: UPDATE (INCLUDING THE OID) to reflect the
755 new definition from the ZIG. NOTE THIS IF YOU HAVE AN UPDATE
756 IMPLEMENTATION! This change was made to the development version before
757 the ZIG decided to retract the amendment. If any users MUST be
758 compatible with the original Update definition, PLEASE CONTACT US, and
759 we will include a separate definition corresponding to the old Update
760 ES. Note that because of the change to the ASN.1 of the
761 TaskPackageRecordStructure we cannot define a single structure that
762 will support both versions.
764 * Added const modifier to buffer parameter for some ODR/BER encoding
765 routines: ber_dectag, ber_declen, odp_more_chunks, completeBER,
766 completeWAIS, odr_dumpBER.
768 Fixed bug in client.c which caused a crash when a scanResponse didn't
769 contain positionOfTerm.
771 * Fixed inconsistency in the ScanResponse/ListEntries protocol. This
772 * will cause an error in a client if a non-YAZ target sends both a
773 * list of Scan entries and non-surrogate diagnostics.
775 Retrieval module enhancements. Tag sets may be typed in the reference
776 to it. From the .abs-file the "tagset" directive takes a third optional
777 integer type for the tag set referenced. From a .tag-file the "include"
778 directive takes a third optional type as well. The old "type" directive
779 in the tag set itself is still recognized but acts as the default type
782 Backend interface change. Individual Scan terms returned from bend_scan
783 may also be tagged as Surrogate Diagnostics. Refer to struct scan_entry
784 in include/backend.h.
786 Retrieval module enhancements. Multiple tag sets and attribute sets may
787 be specified in abstract syntax specs. Revised the error/warning for
788 logging messages reported by the retrieval module when reading the
791 Object Identifier system (oid_..) changed. The API is backwards
792 compatible but the oid-routines now allocates new OID's when needed.
793 Raw OID's may be specified in oid_getvalbyname.
795 YAZ now uses GNU configure to generate Makefile(s).
797 * Minor changes in some of the member names of DeleteResultSetRequest and
798 DeleteResultSetResponse. See include/proto.h.
800 * Changed some C definitions regarding EXPLAIN record syntax (prt-exp.h)
801 and added member 'languages' in TargetInfo (which was missing).
803 Changed the way attribute sets are handled in the retrieval
804 module. These are now cached, just like the abstract syntaxes
807 Changed YAZ so that it links with compiled ASN.1.
809 Added Explain-schema definitions and mapping routines. The following
810 Explain categories have been implemented: AttributeDetails,
811 AttributeSetInfo, DatabaseInfo, CategoryList and TargetInfo.
813 Fixed minor bug in Windows version of Server Library.
815 --- 1.4pl2+ 1998/4/17 (Released with Zebra)
817 Added Extended Services to server (backend.h). Thanks to Charles Woodfield.
819 Added EXTERNAL: UNIverse Resource Report (non-standard).
821 Implemened odr_enum and odr_set_of functions to handle ASN.1 types
822 ENUMERATED and SET OF.
824 * Added 'const' to some of the char pointer arguments for the
825 functions, data1_read_node, data1_getelementbytagname,
826 data1_insert_taggeddata, data1_getesetbyname, data1_getelementbyname,
829 Fixed bug in data1_insert_taggeddata - the last_child member of
830 parent wasn't initialised.
832 * Changed data1_read_record and data1_read_node so that the supplied
833 "SGML"-buffer is read-only. In particular the resulting data1 - tree
834 doesn't refer to any parts of the "SGML"-buffer.
836 Fixed bug in server library (Windows version of statserv_remove).
838 * Changed code so that it compiles as C++. The type definition
839 of Odr_fun which is a member of Odr_arm was changed. The result is,
840 that an explicit typecast is needed for the fun pointer when
841 using Odr_arm - as in:
842 {1, -1, -1, Z_IdAuthentication_idPass, (Odr_fun)z_IdPass},
844 Updated TagSet-G and -M definitions (tagsetm.tag and tagsetg.tag).
846 Implemented the new structured date and time definition as approved
847 by the ZIG. Added schemaId element to the specificTag in Espec-1
848 (also approved at the last ZIG). Thanks to RVDM.
850 Added some Object identifiers (RVDM).
852 Changed the Update Extended Service (RVDM).
854 Added command "refid" to client which specifies referenceId for
855 the following requests.
857 Implemented extended service handling for server. See ztest.c
858 for an example as well as backend.h. New handlers are registerd
861 * Changed interface for sort in server.
863 Added new members to statserv_options_block. It allows a server
864 to read options from another source than just the command line. Thanks
865 to Charles Woodfield.
867 * Changed definition of Z_Triple in file prt-grs.h - member boolean
868 renamed to zboolean. Some C++ compilers complained about the name.
870 Minor changes to gils.abs. Added index 's' (sort) on title
871 and date/time-last-modified.
875 Fixed bug in server library regarding inetd mode (-i). This bug
876 was introduced by release 1.4.
880 Added sort facility in client and backend server interface.
882 Fixed problem with dependencies in Makefile(s).
884 Fixed bugs for encoders/decoders of extended services and
887 Implemented sub-tree feature for schemas. Sub-trees are
888 referenced in *.abs-files. See explain.abs for an example
889 of the use of this feature.
891 Modified bib1.att; local attributes for ANY didn't include
892 ANY itself (only affects use of the retrieval module).
894 Fixed bug in plain SGML reader in function data1_read_node:
895 tags with prefix "var" was incorrectly interpreted as variants.
897 Added feature "sub-schemas" to enable references to - and definitions
898 of - group of elements.
900 * Removed member parent from type data1_element (in data1.h).
902 Implemented function odr_nullval() that returns the value of
905 * Removed member num_children from data1_node (in data1.h).
907 Made NT service interface part of the server library. The
908 function statserv_main uses the NT service when required and
909 calls the statserv_start / statserv_close routines.
911 Routine zget_SearchRequest and zget_PresentRequest fills
912 resultSetName/Id member with "default" instead of "Default".
914 Fixed memory leak in server. Request queue member wasn't freed.
916 Fixed nmem_exit so that memory is freed.
920 Revised the CCL parser utility to be thread safe.
922 Added function, oid_ent_to_oid, to replace the function
923 oid_getoidbyent, which is not thread safe.
925 * Added nmem_init and nmem_exit to initialize and release
926 NMEM resources. Function nmem_init should be called once in the
927 initial thread before NMEM/ODR is used. statserv.c and client.c
928 have been changed accordingly. The change was necessary to make
929 NMEM thread safe. The NMEM memory pool is shared amongst threads
930 in a process. Unix-based applications will still work fine without
933 Added NT Services interface for the the Z39.50 (statserv) Server.
934 Refer to the ztest.c source on the usage.
936 Windows 95/NT port using MSVC5.0. Project files are included in the
939 * Defined new 'global' handle for the retrieval (data1) system. The
940 new handled, data1_handle, describes the state of the data1 system.
941 This handle is passed as first argument to virtually all
942 data1 related routines. The functions data1_create and data1_destroy
943 creates and destroys a data1 handle respectively.
945 Added ODR encode stream member to all backend request structures
946 init, search, scan etc. This stream should be used to allocate all
947 memory used for the response when thread safe operation is needed.
949 Changed the comstack utility, cs_addstr, to be thread safe. The
950 returned hostname string returned by the function is now part the
953 Added comstack utility, cs_straddr, which replaces the tcpip_strtoaddr
954 function. The cs_straddr takes a COMSTACK handle as argument, so this
955 function must be used after cs_create and before bind/connect.
956 This function is thread safe.
958 Moved test server to 'ztest' directory - generic server code still
959 in 'server' directory.
961 Made prefix query (pquery.c) utility thread safe.
963 Added new function modifier YAZ_EXPORT to 'export' public DLL
964 functions when using windows (see include/yconfig.h).
966 Added definitions to the OID database (util/oid.c) (RVDM).
968 Added new BIB-1 diagnostic messages to the handler diagbib1_str.
970 Added call to ccl_rpn_delete in client program.
972 Added ODR argument to ccl_rpn_query and ccl_scan_query to provide
973 release of RPN structure.
975 Added support for C++, headers uses extern "C" for public definitions.
976 With input from RVDM.
978 In handling of SEQUENCE OF: Counter set to zero when SEQUENCE OF is absent.
979 Thanks to Ronald van der Meer (RVDM).
981 Added initializers (zget_ routines) for a number of PDUs. Thanks to RVDM.
983 Added support for private extensions to the OID database
984 (oid_setprivateoids()). Thanks to RVDM.
986 Added optional, physical ANY (key replication)
988 Fixed null-reference problem in GRS-1 output filter.
990 Proximity operator added to Prefix Query Format (PQF).
992 In test client command "base" accepts multiple databases.
994 Fixed bug in cs_close stack that caused trouble with WINSOCK.
998 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
1000 Smallish bug-fixes in the new encoders/decoders (explain).
1002 Bug fixed in DeleteRequest.
1004 Fixed tagging bug of type 101 query in SearchRequest-Query PDU encoder/decoder.
1006 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
1008 Added SOIF syntax (using private OID for now) to retrieval module and client.
1010 Added Update extended service.
1012 Added SearchResult-1 additional info structure.
1014 Added optional CCL (ISO8777) interpreter as separate module. Available
1017 --- 1.2 1996/6/10 (1st anniversary release)
1019 Added Summary record syntax. Lightly tested.
1021 Added OPAC record syntax. Untested.
1023 Added ResourceReport service encoders/decoders. Untested.
1025 Fixed bug in z_Unit - wrong tagging on unitSystem.
1027 Fixed bug in the DiagRecs decoder.
1029 Added options for max PDU size and session timeout to frontend-server.
1031 Added documentation of query-language parsers and other supporting utilities.
1033 [frontend-server] Added Attribute set to the bend_scanrequest API.
1035 [frontend-server] NextResultSetPosition was sometimes set incorrectly when
1036 surrogate diagnostics were generated.
1038 [retrieval] Allow multiple local values for attribute.
1040 [retrieval] Allow multiple attributes per element in .abs files. index type.
1042 [retrieval] Added Summary tagset, abstract syntax, and d1-node/ASN filter.
1044 --- 1.1pl2 1996/4/10
1046 Minor changes, mostly specific to Zebra's requirements (retrieval)
1050 Repaired bug in frontend server when running multiple listening
1051 endpoints in dynamic mode.
1053 z_External() now won't break if a known, ASN.1 value comes encapsulated
1054 in an octet-string. The value will pass through unmodified in an Odr_oct.
1056 Added a bit of code to the demo client to decode & display
1057 ASN.1-structured records represented in the octet-aligned branch of
1058 the EXTERNAL CHOICE. Thanks to CAS for prodding us to finally do this.
1060 Added z_ext_getentbyref() to the ASN module. Doc updated.
1062 * Completed the SCAN definition in the ASN module. This may break SCAN
1063 code based on older YAZ-versions at compile-time. The fix is easy -
1066 * Added 'displayTerm' and OtherInformation to the TermInfo structure
1067 under the SCAN definition. Remember to initialize this, server-people.
1069 Comstack should now support the WAIS protocol in TCP/IP mode. Note
1070 that this does not extend to ODR and ASN.
1072 Comstack allows insertion of established socket (primarily for
1073 inetd-operation of servers). Doc updated.
1075 Front-end server can now start from the inetd in TCP mode. Doc
1078 --- 1.0pl4 1996/1/24
1082 Fixed small problem in SUTRS-filter. A newline was sometimes inserted before
1083 the rank and record number.
1085 Adjustments to the frontend server.
1087 Fixed diagnostic BER dumper. It ignored the file argument.
1091 Various changes to retrieval module.
1093 Changed the union discriminators of the protocol files from enums to
1094 ints paired with #defines.
1096 *Changed oident.class to oident.oclass to avoid a reserved word in C++
1099 *Changed operator in the RPN structure to 'roperator', again to avoid a
1102 Fixed problems in Explain decoders/encoders.
1104 --- 1.0pl2 1995/12/6
1106 Memory bug in log module fixed.
1108 --- 1.0pl1 1995/12/5
1110 Occasional malloc() of 0 bytes fixed in d1_espec.c.
1112 Bug in Explain DatabaseInfo module fixed.
1114 Some '\r' snuck into one or two of the ret'l config tables. A curse on Windows.
1118 The shift to v1.0 signals that we now consider the *core* functionality
1119 of YAZ reasonably stable (the core being more or less equivalent to
1120 Z39.50-1992). Some of the really nifty v3 stuff is still not heavily
1121 tested (Explain not at all - though that will happen soonish).
1123 Minor changes to code to support Windows port.
1125 Various minor changes after we're getting to use GRS-1 & co. more.
1127 Added Espec-1 format.
1129 Added VisibleString field body type to GRS-1. It is illegal acc. to my copy
1130 of the protocol and it cannot be selected when encoding (maps into 'string'
1131 when decoding). Needed to talk to some servers.
1133 Demo client can request simple element set names.
1135 Added Diagnostic Format encoders/decoders.
1137 Added simple Close handling to frontend server (no hooks for resource
1138 reporting yet), and demonstration client.
1140 Added cs_addrstr() command to COMSTACK to retrieve peer hostname/address.
1142 --- 1.0b3 1995/08/24
1144 Fixed bug in the frontend-server. The numberOfRecordsReturned field was
1145 handled incorrectly when records were requested in the searchResponse. This
1146 will only affect you if you use the frontend-server.
1148 Added GRS-1 encoders/decoders to the service-level API. Lightly tested.
1149 Test-client will ask for and print GRS1. Ztest will return dummy records
1152 Added Explain encoders/decoders to the service-level API. Untested.
1154 Added Extended Services: Item Order encoders and decoders to the Service-
1155 level API. Untested. We could use a recent copy of the pertinent bits
1156 of the ILL protocol to add those bits.
1158 Added diagnostic format 1 encoders/decoders to the service-level API.
1161 Moved pretty-printing of structure-wrappers ({..}) from odr_seq.c to
1162 odr_cons.c, which causes a more correct output.
1164 Fixed handling of searchRequest in frontend server. NextResultSetPosition
1165 was always set to 0 when no records were requested in the searchRequest.
1167 * Added better external-handling. This shouldn't harm old code that
1168 *encodes* externals. It can break code that looks for a
1169 'single-ASN1-type' representation, since those types that are known
1170 are now decoded immediately. Look at the SUTRS sample code in
1171 seshigh.c and client.c. Documentation updated.
1173 Handling of structured records in bend_fetchresponse. Length -1 marks
1174 structured record, type is deduced from format field.
1176 --- 1.0b2 1995/06/27
1177 Fairly quick maintenance release to add SUTRS support.
1179 Fixed handling of SUTRS records in the demonstration client.
1181 * Added format field to the bend_fetchrequest and bend_fetchresponce
1182 structures of the backend API (frontend server). When the record is
1183 returned, the value of the format field is mapped to an OID. The
1184 value VAL_SUTRS will also cause a slightly different ASN.1 packaging
1185 of the record. The special value VAL_NONE in the bend_request means
1186 that no specific format was requested by the client. Documentation
1187 updated accordingly. Test server (ztest) will return a fixed dummy
1188 SUTRS record if your client requests SUTRS.
1190 Documentation updated accordingly.
1192 You can now set external libraries and RANLIB support in the top-level
1196 First public release.