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