failReason is no longer OPTIONAL, as advised by OCLC
[yaz-moved-to-github.git] / CHANGELOG
1 Possible compatibility problems with earlier versions marked with '*'.
2
3 --- (IN PROGRESS)
4
5 ZOOM uses smallSetUpperBound=1 instead of 0 for piggyback searches.
6 It apparantely upsets EBSCO Publishing IR Z39.50 Server which
7 returns 'malformed search term' otherwise.
8
9 SortResponse member resultCount now set to NULL in sort handler of
10 frontend server.
11
12 OPAC support ZOOM. ZOOM_record_get returns OPAC info (as XML) if
13 type is "opac".
14
15 Add three new utility functions for translating OIDs between various
16 formats -- symbolic name such as "Usmarc", minus-1-terminated int
17 arrays and dotted strings such as "1.2.840.10003.9.5.1":
18  int *oid_name_to_oid(oid_class oclass, const char *name, int *oid);
19  char *oid_to_dotstring(const int *oid, char *oidbuf);
20  char *oid_name_to_dotstring(oid_class oclass, const char *name, char *oidbuf);
21
22 Reverted modifications for ES Update definition for z_IU0Update 
23 (OID 1.2.840.10003.9.5.1 and 1.2.840.10003.9.5). The definition
24 is back to YAZ 2.0.2.
25
26 String value attributes for CCL parser.
27
28 Support for OCLC's locally registered "OCLC-UserInformation" PDU,
29 which their FirstSearch server returns in Init responses, sometimes
30 carrying useful diagnostic information when Init fails.  This has the
31 OID 1.2.840.10003.10.1000.17.1 and is defined in the file
32 "z39.50/oclcui.asn", where its definition is somewhat different from
33 what OCLC document on their web-site, as required to interoperate with
34 their servers.
35
36 Support for anonymous authentication in yaz-client.  Use the command
37 "auth -".
38
39 * Fix the OID of the Index Data-local "admin" Extended Service from 
40   1.2.840.10003.9.81.1 to 1.2.840.10003.9.1000.81.1.  The omission of
41   the 1000, which indicates a locally-defined OID, was a mistake.
42
43 --- 2.0.3 2003/06/20
44
45 Fix CCL directive @case handling so that it affects string match for
46 both CCL keywords and qualifiers.
47
48 * ESFormat-Update updates. Packages with OID 1.2.840.10003.9.5.1 and
49 1.2.840.10003.9.5 are now handled by the same decoder z_IU0Update .
50 Decoder has been updated with ASN.1 changes as listed in
51 http://lcweb.loc.gov/z3950/agency/defns/updateES.html
52 Note that the "latest" DB Update, OID 1.2.840.10003.9.5.1.1 , handler
53 z_IUUpdate, remains unchanged. 
54
55 ZOOM_record_get may now return a record in a specific character set.
56 For type use "form; charset=from[,to]" where form (render, xml, ..) ,
57 "from" is the character set of record as returned by target. "to" is
58 the character set to be returned. If omitted, "to" is UTF-8.
59
60 YAZ ASN.1 compiler renamed from yaz-comp to yaz-asncomp
61
62 New ODR utility, odr_getelement, which returns name of element for
63 which encoding/decoding failed.
64
65 Fixed ODR so that it returns error code OREQUIRED rather than ONONE
66 in cases where a required element was omitted.
67
68 Bug fix: some MARC8 sequences were not converted.
69
70 New ZOOM option "step" which specifies number of records to be
71 retrieved in one chunk. Used in conjunction with "start" and "count".
72
73 SRW support for yaz-client. Use scheme http: to use it, e.g.
74  http://host:port/db
75
76 yaz-client no longer does (un)intelligent character set conversions
77 by default. Can be enabled with charset and marc_charset commands.
78
79 xmalloc trace fix for 64-bit systems such as DEC alpha. 
80
81 Solaris 2.6 compile fix.
82
83 New function, cql_strerror() translates SRW error codes, as returned
84 by cql_transform_error(), into human-readable English strings.  Used
85 in yaz-client diagnostics when appropriate.
86
87 New CQL2RPN query-type for the command-line yaz-client, parses CQL and
88 converts it into a type-1 query which is sent to the server.  This
89 makes CQL available for use with all Z-servers, as opposed to the tiny
90 minority that can handle CQL queries themselves.
91
92 --- 2.0.2 2003/04/28
93
94 New Debian package layout similar to the Redhat Package layout.
95
96 New ZOOM events ZOOM_EVENT_RECV_{RECORD,SEARCH} for receiving a record
97 and search result respectively.
98
99 --- 2.0.1 2003/04/25
100
101 Redhat package is now several packages: libyaz (runtime libraries),
102 libyaz-devel (development and documentation, and yaz (utility programs).
103 Package spec file by Morten Bøgeskov.
104
105 New member 'schema' in struct bend_fetch_rr which the name of requested
106 schema (SRW/SRU) for record (or NULL if none was given). The fetch
107 handler MAY set this to reflect the schema of the returned record.
108
109 New member 'display_term' in struct scan_entry. GFS now sets member entries
110 and allocates scan entries to be filled by user scan handler. In previous
111 version, entries member was allocated by the scan handler. That still works,
112 but the GFS will ignore member display_term - assuming it was NOT set by
113 the handler. The fact that the GFS now allocates the entries both allows
114 for new members and makes a scan handler easier to write.
115
116 Fix CQL lex buffer overflow.
117
118 SRW/SRU recordPacking. For SRW default recordPacking is string. For
119 SRU default recordPacking is string.
120
121 SRU protocol support for frontend server.
122
123 Fix compile bug for systems that have nl_langinfo but CODESET undefined.
124
125 Added missing PQF transform rules for <= and >= . Thanks to Peter Popovics.
126
127 Added scan for the ZOOM shell (zoomsh).
128
129 --- 2.0 2003/02/23
130
131 * String Identifers for Schemas (Amendment 5).
132 http://lcweb.loc.gov/z3950/agency/amend/am5.html
133 Old definition for schema
134   Odr_oid *schema; /* OPT */
135 New:
136   int which;
137   union {
138      Odr_oid *oid;
139      Z_InternationalString *uri;
140   #define Z_Schema_oid 1
141   #define Z_Schema_uri 2
142   } schema; /* OPT */
143
144 * resultCount parameter to Sort Response (Amendment 1).
145 http://lcweb.loc.gov/z3950/agency/amend/am1.html
146
147 Support for SRW 1.0 over HTTP. This is an optional feature and
148 requires libxml2 to operate. Enable SOAP by specifying --with-xml2
149 for configure.
150
151 Generic frontend server supports HTTP/SOAP/SRW and Z39.50/BER
152 on the same port.  SRW SearchRetrieveRequests are mapped
153 to bend_init,bend_search,bend_fetch,bend_close. 
154
155 Z39.50 Query Type-104 added - to facilitate CQL within Z39.50.
156
157 CQL support. Source is directory 'cql'. CQL is supported in ZOOM
158 (both SRW and Z39.50) and the YAZ client (Z39.50 only).
159
160 ZOOM connections are SRW based if schem http is used for hostname
161 in connect, e.g.  z = ZOOM_connection_new("http://myserver");
162 ZOOM_query may be of type CQL, e.g. ZOOM_query_cql(q, "dc.title=x");
163
164 CCL proximity operators !n, %n converts to PQF @prox 0 n 1 2 k 2
165 and @prox 0 n 0 1 k 2 respectively, meaning: exlusion=false,
166 distance=n, order=true/false, relation=le, prox unit=word. If
167 n is omitted, distance 1 is used.
168
169 Fixed problem with C compiler include path in wrong order.
170
171 For TCP/IP COMSTACK, set recv buffer to an appropriate "large" value
172 on Solaris. Patch from Ko van der Sloot.
173
174 New MARC decode API. All new functions operate on a yaz_marc_t
175 handle. The most important new functions are: yaz_marc_create,
176 yaz_marc_decode_{buf,wrbuf}, yaz_marc_destroy, .. to create handler,
177 decode and destroy respectively. Decoder can produce formats
178 MARC line, simple XML, OAI MARC and MARC XML (LoC). See
179 include/yaz/marcdisp.h.
180
181 YAZ Iconv utility now supports MARC8 decoding (marc8.c). Converts
182 to UTF-8, UCS-32, wchar_t or Latin-1.
183
184 * Prototypes for yaz_iconv_-functions moved to separate header 
185 include/yaz/yaz-iconv.h.
186
187 Make a few private functions 'static' in unix.c. This prevents
188 duplicate unix_close in PHP with YAZ and imap. PHP Bug 20977.
189
190 For ZOOM connection, the options targetImplementation{Id,Name,Version}
191 are set when Init Response is received.
192
193 New function ZOOM_connection_error_x similar to ZOOM_connection_error
194 but returns diagnostic set as well.
195
196 New function yaz_strerror which is a portable wrapper for
197 strerror/strerror_r/GetLastMessage.
198
199 * ZOOM_record_get supports type "xml" in which case MARC XML (from LOC)
200 is returned for MARC. If type is "oai", then OAI MARC is returned.
201
202 Fix creation of lib/yaz-config so it works if srcdir != objdir. Patch
203 from Kang-Jin Lee.
204
205 --- 1.9.2 2002/11/26
206
207 yaz_marc_decode uses OAI MARC as XML format for ISO2709 records.
208
209 Fix bad race conditions on SIGTERM and terminate gracefully in
210 frontend server.
211
212 Move retrieval (data1) module to Zebra since nobody seems to be
213 using it.
214
215 Add GRS-1 render for ZOOM using same format as yaz-client.
216
217 --- 1.9.1 2002/10/05
218
219 Added man pages: yaz-client(1), yaz-ztest(8), yaz(7), zoomsh(1).
220
221 Fix broken ESpec handling in data1 module.
222
223 SGML reader parses comments and makes them part of the data1 tree.
224
225 Added several type casts so that YAZ compiles as C++ code.
226
227 ZOOM didn't handle PDU encoding failures properly.
228
229 Added more Bib-1 diagnostics (approved extensions).
230
231 GNU configure: better check for iconv.
232
233 More portable use of accept, getpeername. Check for socklen_t. Use
234 int/size_t if socklen_t is not defined.
235
236 --- 1.9 2002/09/06
237
238 PQF parser rejects bad queries - including those with extra
239 characters in them. PQF parser used to silently ignore that.
240 Cleaner API for PQF added, which allows you to get detailed
241 error information for bad queries (see yaz/pquery.h).
242
243 Fixed bug in ZOOM_record_get for type "database".
244
245 Implemented mini iconv library supporting conversions between
246 UTF-8, UCS4, UCS4LE and ISO-8859-1. Implemented in util/siconv.c.
247
248 * Removed XML reader (d1_expat.c). It's part of Zebra instead.
249
250 --- 1.8.9 2002/08/20
251
252 Fixed ZOOM C record cache so that preferredRecordSyntax and
253 elementSetName is used to check for already fetched records.
254
255 --- 1.8.8 2002/08/02
256
257 Added three members in bend_initrequest structure to facilitate
258 character set negotiation.
259
260 Fixed a bug in frontend server that could cause indefinite
261 loops under rare conditions. 
262
263 Revised character set utilities (charneg.h) so that encoding
264 UCS-4, UCSA-4, UTF-16 and UTF-8 are encoded non-privately.
265
266 For PQF, directive @term <type> sets term type for Scan/Search.
267 Here <type> is general, string, numeric, null. The term type
268 is inherited - just like @attr.
269
270 New call odr_set_charset that sets character set conversion for
271 international-strings on a ODR stream. Prototype is:
272  int odr_set_charset(ODR o, const char *to, const char *from);
273 The InternationalString is still represented as C string in YAZ 
274 so native strings of type UTF-8, ASCII, etc. will work (UTF-16
275 won't). On the protocol level, you can use any encoding.
276
277 Support for UNIX sockets in ZOOM.
278
279 Solaris recv sometimes returns errno == ENOENT. It is treated as
280 EINPROGRESS. COMSTACK patch by Ko van der Sloot.
281
282 New COMSTACK of type UNIX Socket. Use "unix:/path" as address for
283 both client and server. Code by Morten Bøgeskov.
284
285 --- 1.8.7 2002/05/22
286
287 On Windows ZOOM functions are of type __stdcall rather than __cdecl, so
288 that they can be used directly from Visual Basic. You must recompile
289 your windows APP if you're using ZOOM.
290
291 Character Set and Language Negotiation(3) for ZOOM API and YAZ client.
292 Commands "lang" and "charset" sets language and character set respectively.
293 Options "lang" and "charset" is interpreted by the ZOOM API. Note, these
294 are not part of the official ZOOM spec) All is due to Oleg Kolobov. 
295
296 Attributes from multiple CCL fields may be OR'ed rather than merged
297 using directive "@field or". Fields are still merged by default -
298 equivalent to "@field merge".
299
300 Fixed bug in ZOOM connect that occurred on OpenBSD (maybe others). Patch
301 by Oleg Kolobov.
302
303 Fixed bug in zget for parameter ExtendedServicesResponse.
304
305 Fix OID for ILL.
306
307 --- 1.8.6 2002/03/25
308
309 Added PQF feature: '@attr type=value' may be written as '@type=value'.
310
311 Client displays USR.1:SearchResult-1 (hits per term).
312
313 Additional Search Info for search in Generic Frontend Server.
314
315 Fixed CCL parsing of "field=s".
316
317 WIN32 installer - using the excellent NSIS software from nullsoft.
318
319 Fixed CCL parsing of "field = - <number>".
320
321 Added function yaz_marc_decode that decodes MARC for line mode
322 display or XML (similar to that used by JZKit).
323
324 Fixed BER decoding of OPTIONAL CHOICE. The bug didn't affect the
325 Z39.50. But ISO/ILL was, however.
326
327 Added patch by Rustam T. Usmanov that implements Z39.50 duplicate
328 detection service (Z39.50-1995 Amendment 2) and Language Negotiation (3).
329 See:
330  http://lcweb.loc.gov/z3950/agency/amend/am2.html
331  http://lcweb.loc.gov/z3950/agency/defns/charneg-3.html
332
333 --- 1.8.5 2002/02/03
334
335 New YAZ client features: Command completion and new commands:
336 push_command, set_apdufile, set_marcdump, set_cclfields, register_oid.
337 Code provided by Jacob Poulsen.
338
339 New call oid_trav, that visits all registered OIDs via callback.
340
341 Function ZOOM_record_get now returns const char pointer rather than
342 void pointer. It saves a lot of type casts.
343
344 For YAZ client, command "auth" now allows you to set authentication
345 in IdPass style. It is enabled when three tokens are given - order
346 is user, group and password.
347
348 Fix memory leaks in MARC record handling for ZOOM.
349
350 New option for YAZ client, -k <kilobytes> that sets
351 maximum record size. Similar to -k option for generic frontend
352 server and yaz-ztest.
353
354 More fixes for scan. Non-zero stepSize handled. OID's fixes.
355
356 Prefix query parser reports "fail" when bad attribute set is given.
357
358 Fix in MARC decoder. Proximity logging. Fix for attribute set
359 in scan handler for server. Patches by Shigeru Ishida.
360
361 SSL/COMSTACK updates. cs_rcvconnect completes SSL handshake. ZOOM
362 works with SSL.
363
364 Configure option --with-openssl=<dir> now works when a directory is
365 specified. Patch provided by Morten Bøgeskov.
366
367 New option for YAZ client, -u <auth>, that sets authentication.
368
369 ZOOM fix: error information was sometimes "missing", since error
370 was cleared/reset too when it shouldn't.
371
372 ZOOM_record_get returns ISO2709 buffer when "raw" is given.
373
374 --- 1.8.4 2002/01/04
375
376 Scan for ZOOM API. New object ZOOM_scanset. New functions
377 ZOOM_connection_scan, ZOOM_scanset_size, ZOOM_scanset_term and
378 ZOOM_scanset_destroy.
379
380 New ZOOM function, ZOOM_connection_last_event, that returns type
381 of last event (such as "receive data", "send data", "apdu received",
382 etc.
383
384 New ZOOM option, schema, that specifies schema for retrieval.
385
386 New CCL feature. Qualifiers can be aliases for one or more
387 other qualifiers (if more than one is given, OR is used).
388
389 ZOOM uses named result sets if target supports it.
390
391 Two new YAZ client commands: .  (dot, which sources a script of YAZ
392 client commands), and ! (to execute shell command.). Implemented
393 by Jacob Poulsen.
394
395 Working on Debian packages.
396
397 --- 1.8.3 2001/11/19
398
399 YAZ client enables named result sets only if target supports it.
400
401 *** ZOOM. Prefix for ZOOM definitions changed from Z3950_ to ZOOM_.
402
403 * ZOOM. Removed Z3950_connection_host. Use Z3950_connection_option_get
404 with key="host" to get same result.
405
406 * ZOOM. Added Z3950_record_clone and removed Z3950_resultset_get.
407 Function Z3950_resultset_record(s) returns references to records
408 "owned" by resultset. To become owner use Z3950_record_clone.
409
410 Function z_ext_record handles Extended Services. Thanks to
411 Irina Dijour.
412
413 --- 1.8.2 2001/11/12
414
415 CCL Parser fix: ignore token comma when dealing with and-lists.
416
417 Documentation updates for COMSTACK.
418
419 * ZOOM changes. Query object renamed from Z3950_search to Z3950_query.
420 Changed prototype Z3950_records. For some functions, int parameters
421 were changed to size_t.
422
423 TCP/IP COMSTACK no longer uses getprotobyname to avoid memory leak
424 on some Unices.
425
426 New MARC decode/display function, marc_display_exl, which properly rejects
427 non-ISO2709 records. YAZ client uses it.
428
429 --- 1.8.1 2001/10/29
430
431 Fix bug: local attribute set wasn't set correctly in PQF strings.
432
433 --- 1.8 2001/10/25
434
435 * Old Z39.50 codecs no longer supported. 
436
437 Added ZOOM C binding. See http://zoom.z3950.org/
438
439 Renamed states for COMSTACKs to avoid confusion with events.
440
441 Implemented cs_look and proper cs_rcvconnect.
442
443 Fixed COMSTACK error that occurred on HPUX. Fix by Giannis Kosmas.
444
445 Configure detects POSIX threads on OpenBSD.
446
447 When sort flag 'i' was specified in yaz-client the caseSensitivy flag
448 was set to a wrong value.  Thanks to Robert Sanderson for reporting this.
449
450 When error is returned from present handler, non-surrogate diagnostic
451 is returned in present response (and fetch handler is no longer called).
452
453 * Minor adjustments to pquery parser (PQF). Token characters may be
454 escaped by using backslash (C-style).
455
456 PQF parser allows string attribute values to be specified. For @attr,
457 non-numeric characters after the equal-sign are treated as strings
458 (e.g. @attr 9=title).
459
460 CCL trunction character may be defined (@truncation in file)
461
462 * function zget_ExtendedServicesRequest sets waitAction to
463   waitIfPossible (was wait).
464
465 Added cs_set_blocking to set change blocking mode of a COMSTACK. Thanks
466 to Matthew Carey.
467
468 CCL operator names may be set in field definition files (CCL_bibset).
469 See ccl/bib1 for an example.
470
471 Fixes in ASN.1 compiler for C++ compatibility.
472
473 * Renamed members "and" and "or" in struct Z_Operator to "op_and"
474 and "op_or" to avoid conflict with C++.
475
476 Fixed problem with GNU readline detection on Redhat 7.0.
477
478 Added step-size for Scan backend handler.
479
480 Fixed bug that made the frontend server crash when no attribute
481 set was specified for scan.
482
483 Front-end server automatically switches to original working directory
484 when installed as an NT service. Previously -w had to be specified to
485 make it work.
486
487 Added extended attributes for retrieval module (data1), so that data1
488 records carry d1_readXML/SGML attributes. d1_read also supports
489 null-data rules ( <tag/>)
490
491 On UNIX when POSIX threads are available, a separate library libyazthread
492 is created. Programmers should link with that library and the yaz library
493 when using threads. The reason for the split was that some applications
494 on Linux, such as Apache, doesn't work well when using shared objects that
495 relies on threads.
496
497 Added SSL support for the COMSTACK. You start yaz-client and yaz-ztest
498 (or any frontend server) in SSL mode by specifying ssl: followed by
499 address. Only tested on UNIX.
500
501 Added feature for CCL module. Virtual structure s=al or s=ol generates
502 and-list and or-list respectively instead of phrase search.
503
504 Added some OID's.
505
506 * Added prefix "yaz_" for the functions log_init.., log_file..  and
507 log_mask_str. This was done to avoid name conflicts with other libraries
508 (such as other PHP extensions).
509
510 Added raw OID member for preferred record syntax (request_format_raw)
511 and returned record syntax (output_format_raw) for backend fetch method.
512
513 Config file yaz-config now accepts options so that it returns specific
514 compile settings, etc. Thanks to Morten Bøgeskov <morten@bogeskov.dk>
515
516 Shared library support for UNIX using GNU libtool.
517
518 * Modified backend interface. Request/Response struct's replaced by
519 one read/write C struct. For example bend_fetchrequest and
520 bend_fetchresult have been replaced by single bend_fetch_rr struct.
521 Every handler - even search has to be registered in bend_init
522 handler. This means that the YAZ library no longer refers to
523 external functions and it makes it possible to make the whole
524 thing a single DLL/SO.
525
526 Added Segment handler for backend server.
527
528 Added Zmbol/Zebra administrative functions to YAZ client.
529
530 Threaded frontend server on UNIX (when POSIX Threads are available).
531 Starting the server with option -T enables multi-threading.
532
533 --- 1.6 2000/03/03
534
535 Added configure option --enable-comp/disable-comp to control use
536 of YAZ ASN.1 compiler. Use --disable-comp to use the old *coders
537 located in sub directory asn.
538
539 YAZ ASN.1 compiler renamed to yaz-comp in sub directory. It's installed
540 in ${exec_prefix}/bin along with the other programs yaz-client and
541 yaz-ztest.
542
543 GNU automake used to maintain makefiles.
544
545 Added several OID's.
546
547 Changed retrieval module so that we can load records with no abstract
548 syntax defined. Tagpaths in these records are fully composed of string
549 tags.
550
551 Implemented ISO ILL protocol. Refer to stuff in sub directory ill.
552
553 --- 1.5 1999/12/10
554
555 On UNIX, the generated makefile now supports a proper 'make install'.
556 The prefix can be set via GNU configure to set the install location
557 (default is /usr/local).
558
559 * YAZ programs client and ztest were renamed to yaz-client and
560 yaz-ztest to avoid conflicts when users install YAZ in "standard"
561 locations, such as /usr/bin,/usr/local/bin,etc.
562
563 * YAZ Header files were moved from include to include/yaz. YAZ Header
564 files are referred to as include <yaz/log.h> rather than <log.h>.
565 The YAZ include path (-I ..) is therefore the same as before. Programmers
566 should update their #include statements or use -Ipath/include/yaz
567 instead. The main motivation for doing this change is that YAZ header files
568 can be installed in "standard" locations /usr/include,/usr/local/include 
569 without introducing conflicts, since ALL YAZ header files are stored
570 in subdirectory yaz (under /usr/include for example).
571
572 Compilation of YAZ for WIN32 is now handled by an nmake-style makefile 
573 rather than project/workspace files. We switched because project files
574 are incompatible between Visual C++ 5 and 6. Refer to windows.txt for
575 details.
576
577 Changed name of logging function, logf, to yaz_log, to prevent name
578 clash with some math-log functions. The YAZ header log.h defines logf
579 to yaz_log (#define) so there should be no incompatibilities by this
580 modification.
581
582 Added bend_start/bend_stop handlers for server. These handler are
583 called on start/stop of server. For windows they are called whenever
584 a service is started/stopped.
585
586 * YAZ now auto-generates decoders/encoders for the Z39.50 protocol using
587 a fairly small ASN.1 compiler written in Tcl. The compiler is located
588 in util/yc.tcl. The auto-generated C code structures are, in a few
589 cases, incompatible with the old decoders. There are differences in the
590 following C structures Z_DiagRec, Z_External, Z_SortRequest, Z_SortResponse,
591 Z_AttributesPlusTerm, Z_ProximityOperator, Z_DefaultDiagFormat.
592 The preprocessor variable ASN_COMPILED is defined when the compiled
593 ASN.1 is being used. Encoder/decoder routines as well as the Z39.50
594 protocol ASN.1 is located sub directory <tt>z39.50</tt>. If you
595 wish to use the old encoders/decoders you can specify --disable-yc
596 for configure.
597
598 Assigned OID for old DB Update (VAL_DBUPDATE0). Updated YAZ compiled
599 version so that it supports both new - and old version of DB Update
600
601 * Added 'name' parameter to ODR encoder/decoder routines to facilitate
602 pretty ODR print. Updated whole Z39.50 encoder/decoder to reflect the
603 change. The name parameter can be set to 0 in which no name is specified
604 for the construction. The macros odr_implicit and odr_explicit sets name
605 parameter to zero for the construction involved. New macros
606 odr_implicit_tag and odr_explicit_tag are similar to the others,
607 except that a name parameter is added. For programmers' that don't use
608 ODR they probably only need to change the call to z_APDU and z_External.
609
610 Added access control facility by interfacing the TCP wrapper library.
611 YAZ automatically attempts to find the TCP wrapper Library (-lwrap) and
612 tcpd.h on Unix systems. For the server, option -d<daemon> specifies the
613 name of the daemon and enables the access control as specified in
614 hosts.allow/hosts.deny. Refer to man pages tcpd(8) and hosts_access(5).
615
616 Fixed memory leak in ccl_find_str and ccl_qual_rm. Thanks to Hans van
617 den Dool <H.M.vdnDool@kub.nl>.
618
619 Added reference ID parameter to most functions in server API - refer
620 to backend.h. Thanks to Hans van den Dool <H.M.vdnDool@kub.nl>.
621
622 Changed name of ccl library to libccl.a (was ccl.a).
623
624 Fixed bug in decoder for Explain (Category TargetInfo).
625
626 Added support for GNU readline in client. Thanks to Jacob Poulsen
627 <ja7@dbc.dk>. GNU configure attempts to detect if readline is available.
628
629 * CHANGED DEFINITION OF ES: UPDATE (INCLUDING THE OID) to reflect the
630 new definition from the ZIG. NOTE THIS IF YOU HAVE AN UPDATE
631 IMPLEMENTATION! This change was made to the development version before
632 the ZIG decided to retract the amendment. If any users MUST be
633 compatible with the original Update definition, PLEASE CONTACT US, and
634 we will include a separate definition corresponding to the old Update
635 ES. Note that because of the change to the ASN.1 of the
636 TaskPackageRecordStructure we cannot define a single structure that
637 will support both versions.
638
639 * Added const modifier to buffer parameter for some ODR/BER encoding
640 routines: ber_dectag, ber_declen, odp_more_chunks, completeBER,
641 completeWAIS, odr_dumpBER.
642
643 Fixed bug in client.c which caused a crash when a scanResponse didn't
644 contain positionOfTerm.
645
646 * Fixed inconsistency in the ScanResponse/ListEntries protocol. This
647 * will cause an error in a client if a non-YAZ target sends both a
648 * list of Scan entries and non-surrogate diagnostics.
649
650 Retrieval module enhancements. Tag sets may be typed in the reference
651 to it. From the .abs-file the "tagset" directive takes a third optional
652 integer type for the tag set referenced. From a .tag-file the "include"
653 directive takes a third optional type as well. The old "type" directive
654 in the tag set itself is still recognized but acts as the default type
655 for the tag set.
656
657 Backend interface change. Individual Scan terms returned from bend_scan
658 may also be tagged as Surrogate Diagnostics. Refer to struct scan_entry
659 in include/backend.h.
660
661 Retrieval module enhancements. Multiple tag sets and attribute sets may
662 be specified in abstract syntax specs. Revised the error/warning for
663 logging messages reported by the retrieval module when reading the
664 various spec files.
665
666 Object Identifier system (oid_..) changed. The API is backwards
667 compatible but the oid-routines now allocates new OID's when needed.
668 Raw OID's may be specified in oid_getvalbyname.
669
670 YAZ now uses GNU configure to generate Makefile(s).
671
672 * Minor changes in some of the member names of DeleteResultSetRequest and
673 DeleteResultSetResponse. See include/proto.h.
674
675 * Changed some C definitions regarding EXPLAIN record syntax (prt-exp.h)
676 and added member 'languages' in TargetInfo (which was missing).
677
678 Changed the way attribute sets are handled in the retrieval
679 module. These are now cached, just like the abstract syntaxes
680 (schemas).
681
682 Changed YAZ so that it links with compiled ASN.1.
683
684 Added Explain-schema definitions and mapping routines. The following
685 Explain categories have been implemented: AttributeDetails,
686 AttributeSetInfo, DatabaseInfo, CategoryList and TargetInfo.
687
688 Fixed minor bug in Windows version of Server Library.
689
690 --- 1.4pl2+ 1998/4/17 (Released with Zebra)
691
692 Added Extended Services to server (backend.h). Thanks to Charles Woodfield.
693
694 Added EXTERNAL: UNIverse Resource Report (non-standard).
695
696 Implemened odr_enum and odr_set_of functions to handle ASN.1 types
697 ENUMERATED and SET OF.
698
699 * Added 'const' to some of the char pointer arguments for the
700 functions, data1_read_node, data1_getelementbytagname,
701 data1_insert_taggeddata, data1_getesetbyname, data1_getelementbyname,
702 data1_get_absyn.
703
704 Fixed bug in data1_insert_taggeddata - the last_child member of
705 parent wasn't initialised.
706
707 * Changed data1_read_record and data1_read_node so that the supplied
708 "SGML"-buffer is read-only. In particular the resulting data1 - tree
709 doesn't refer to any parts of the "SGML"-buffer.
710
711 Fixed bug in server library (Windows version of statserv_remove).
712
713 * Changed code so that it compiles as C++. The type definition
714 of Odr_fun which is a member of Odr_arm was changed. The result is,
715 that an explicit typecast is needed for the fun pointer when
716 using Odr_arm - as in:
717     {1, -1, -1, Z_IdAuthentication_idPass, (Odr_fun)z_IdPass},
718
719 Updated TagSet-G and -M definitions (tagsetm.tag and tagsetg.tag).
720
721 Implemented the new structured date and time definition as approved
722 by the ZIG. Added schemaId element to the specificTag in Espec-1
723 (also approved at the last ZIG). Thanks to RVDM.
724
725 Added some Object identifiers (RVDM).
726
727 Changed the Update Extended Service (RVDM).
728
729 Added command "refid" to client which specifies referenceId for
730 the following requests.
731
732 Implemented extended service handling for server. See ztest.c
733 for an example as well as backend.h. New handlers are registerd
734 in the Init handler.
735
736 * Changed interface for sort in server.
737
738 Added new members to statserv_options_block. It allows a server
739 to read options from another source than just the command line. Thanks
740 to Charles Woodfield.
741
742 * Changed definition of Z_Triple in file prt-grs.h - member boolean
743 renamed to zboolean. Some C++ compilers complained about the name.
744
745 Minor changes to gils.abs. Added index 's' (sort) on title
746 and date/time-last-modified.
747
748 --- 1.4pl2 1998/1/30
749
750 Fixed bug in server library regarding inetd mode (-i). This bug
751 was introduced by release 1.4.
752
753 --- 1.4pl1 1998/1/29
754
755 Added sort facility in client and backend server interface.
756
757 Fixed problem with dependencies in Makefile(s).
758
759 Fixed bugs for encoders/decoders of extended services and 
760 SearchInfoReport.
761
762 Implemented sub-tree feature for schemas. Sub-trees are
763 referenced in *.abs-files. See explain.abs for an example
764 of the use of this feature.
765
766 Modified bib1.att; local attributes for ANY didn't include
767 ANY itself (only affects use of the retrieval module).
768
769 Fixed bug in plain SGML reader in function data1_read_node:
770 tags with prefix "var" was incorrectly interpreted as variants.
771
772 Added feature "sub-schemas" to enable references to - and definitions
773 of - group of elements.
774
775 * Removed member parent from type data1_element (in data1.h).
776
777 Implemented function odr_nullval() that returns the value of
778 ODR_NULLVAL.
779
780 * Removed member num_children from data1_node (in data1.h).
781
782 Made NT service interface part of the server library. The
783 function statserv_main uses the NT service when required and
784 calls the statserv_start / statserv_close routines.
785
786 Routine zget_SearchRequest and zget_PresentRequest fills
787 resultSetName/Id member with "default" instead of "Default".
788
789 Fixed memory leak in server. Request queue member wasn't freed.
790
791 Fixed nmem_exit so that memory is freed.
792
793 --- 1.4 1997/10/2
794
795 Revised the CCL parser utility to be thread safe.
796
797 Added function, oid_ent_to_oid, to replace the function 
798 oid_getoidbyent, which is not thread safe.
799
800 * Added nmem_init and nmem_exit to initialize and release
801 NMEM resources. Function nmem_init should be called once in the
802 initial thread before NMEM/ODR is used. statserv.c and client.c
803 have been changed accordingly. The change was necessary to make
804 NMEM thread safe. The NMEM memory pool is shared amongst threads
805 in a process. Unix-based applications will still work fine without
806 calling this.
807
808 Added NT Services interface for the the Z39.50 (statserv) Server. 
809 Refer to the ztest.c source on the usage.
810
811 Windows 95/NT port using MSVC5.0. Project files are included in the
812 distribution.
813
814 * Defined new 'global' handle for the retrieval (data1) system. The
815 new handled, data1_handle, describes the state of the data1 system.
816 This handle is passed as first argument to virtually all
817 data1 related routines. The functions data1_create and data1_destroy
818 creates and destroys a data1 handle respectively.
819
820 Added ODR encode stream member to all backend request structures
821 init, search, scan etc. This stream should be used to allocate all
822 memory used for the response when thread safe operation is needed.
823
824 Changed the comstack utility, cs_addstr, to be thread safe. The
825 returned hostname string returned by the function is now part the
826 COMSTACK instance.
827
828 Added comstack utility, cs_straddr, which replaces the tcpip_strtoaddr
829 function. The cs_straddr takes a COMSTACK handle as argument, so this
830 function must be used after cs_create and before bind/connect.
831 This function is thread safe.
832
833 Moved test server to 'ztest' directory - generic server code still
834 in 'server' directory.
835
836 Made prefix query (pquery.c) utility thread safe.
837
838 Added new function modifier YAZ_EXPORT to 'export' public DLL
839 functions when using windows (see include/yconfig.h).
840
841 Added definitions to the OID database (util/oid.c) (RVDM).
842
843 Added new BIB-1 diagnostic messages to the handler diagbib1_str.
844
845 Added call to ccl_rpn_delete in client program.
846
847 Added ODR argument to ccl_rpn_query and ccl_scan_query to provide
848 release of RPN structure.
849
850 Added support for C++, headers uses extern "C" for public definitions.
851 With input from RVDM.
852
853 In handling of SEQUENCE OF: Counter set to zero when SEQUENCE OF is absent.
854 Thanks to Ronald van der Meer (RVDM).
855
856 Added initializers (zget_ routines) for a number of PDUs. Thanks to RVDM.
857
858 Added support for private extensions to the OID database
859 (oid_setprivateoids()). Thanks to RVDM.
860     
861 Added optional, physical ANY (key replication)
862
863 Fixed null-reference problem in GRS-1 output filter.
864
865 Proximity operator added to Prefix Query Format (PQF).
866
867 In test client command "base" accepts multiple databases.
868
869 Fixed bug in cs_close stack that caused trouble with WINSOCK.
870
871 --- 1.3 1996/10/11
872
873 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
874
875 Smallish bug-fixes in the new encoders/decoders (explain).
876
877 Bug fixed in DeleteRequest.
878
879 Fixed tagging bug of type 101 query in SearchRequest-Query PDU encoder/decoder.
880
881 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
882
883 Added SOIF syntax (using private OID for now) to retrieval module and client.
884
885 Added Update extended service.
886
887 Added SearchResult-1 additional info structure.
888
889 Added optional CCL (ISO8777) interpreter as separate module. Available
890 in linemode client.
891
892 --- 1.2 1996/6/10 (1st anniversary release)
893
894 Added Summary record syntax. Lightly tested.
895
896 Added OPAC record syntax. Untested.
897
898 Added ResourceReport service encoders/decoders. Untested.
899
900 Fixed bug in z_Unit - wrong tagging on unitSystem.
901
902 Fixed bug in the DiagRecs decoder.
903
904 Added options for max PDU size and session timeout to frontend-server.
905
906 Added documentation of query-language parsers and other supporting utilities.
907
908 [frontend-server] Added Attribute set to the bend_scanrequest API.
909
910 [frontend-server] NextResultSetPosition was sometimes set incorrectly when
911 surrogate diagnostics were generated.
912
913 [retrieval] Allow multiple local values for attribute.
914
915 [retrieval] Allow multiple attributes per element in .abs files. index type.
916
917 [retrieval] Added Summary tagset, abstract syntax, and d1-node/ASN filter.
918
919 --- 1.1pl2  1996/4/10
920
921 Minor changes, mostly specific to Zebra's requirements (retrieval)
922
923 --- 1.1  1996/2/20
924
925 Repaired bug in frontend server when running multiple listening
926 endpoints in dynamic mode.
927
928 z_External() now won't break if a known, ASN.1 value comes encapsulated
929 in an octet-string. The value will pass through unmodified in an Odr_oct.
930
931 Added a bit of code to the demo client to decode & display
932 ASN.1-structured records represented in the octet-aligned branch of
933 the EXTERNAL CHOICE. Thanks to CAS for prodding us to finally do this.
934
935 Added z_ext_getentbyref() to the ASN module. Doc updated.
936
937 * Completed the SCAN definition in the ASN module. This may break SCAN
938 code based on older YAZ-versions at compile-time. The fix is easy -
939 look in proto.h.
940
941 * Added 'displayTerm' and OtherInformation to the TermInfo structure
942 under the SCAN definition. Remember to initialize this, server-people.
943
944 Comstack should now support the WAIS protocol in TCP/IP mode. Note
945 that this does not extend to ODR and ASN.
946
947 Comstack allows insertion of established socket (primarily for
948 inetd-operation of servers). Doc updated.
949
950 Front-end server can now start from the inetd in TCP mode. Doc
951 updated.
952
953 --- 1.0pl4 1996/1/24
954
955 Added Sort PDU.
956
957 Fixed small problem in SUTRS-filter. A newline was sometimes inserted before
958 the rank and record number.
959
960 Adjustments to the frontend server.
961
962 Fixed diagnostic BER dumper. It ignored the file argument.
963
964 --- 1.0pl3 1996/1/2
965
966 Various changes to retrieval module.
967
968 Changed the union discriminators of the protocol files from enums to
969 ints paired with #defines.
970
971 *Changed oident.class to oident.oclass to avoid a reserved word in C++
972  compilers.
973
974 *Changed operator in the RPN structure to 'roperator', again to avoid a
975  conflict with C++.
976
977 Fixed problems in Explain decoders/encoders.
978
979 --- 1.0pl2 1995/12/6
980
981 Memory bug in log module fixed.
982
983 --- 1.0pl1 1995/12/5
984
985 Occasional malloc() of 0 bytes fixed in d1_espec.c.
986
987 Bug in Explain DatabaseInfo module fixed.
988
989 Some '\r' snuck into one or two of the ret'l config tables. A curse on Windows.
990
991 --- 1.0 1995/11/28
992
993 The shift to v1.0 signals that we now consider the *core* functionality
994 of YAZ reasonably stable (the core being more or less equivalent to
995 Z39.50-1992). Some of the really nifty v3 stuff is still not heavily
996 tested (Explain not at all - though that will happen soonish).
997
998 Minor changes to code to support Windows port.
999
1000 Various minor changes after we're getting to use GRS-1 & co. more.
1001
1002 Added Espec-1 format.
1003
1004 Added VisibleString field body type to GRS-1. It is illegal acc. to my copy
1005 of the protocol and it cannot be selected when encoding (maps into 'string'
1006 when decoding). Needed to talk to some servers.
1007
1008 Demo client can request simple element set names.
1009
1010 Added Diagnostic Format encoders/decoders.
1011
1012 Added simple Close handling to frontend server (no hooks for resource
1013 reporting yet), and demonstration client.
1014
1015 Added cs_addrstr() command to COMSTACK to retrieve peer hostname/address.
1016
1017 --- 1.0b3 1995/08/24
1018
1019 Fixed bug in the frontend-server. The numberOfRecordsReturned field was
1020 handled incorrectly when records were requested in the searchResponse. This
1021 will only affect you if you use the frontend-server.
1022
1023 Added GRS-1 encoders/decoders to the service-level API. Lightly tested.
1024 Test-client will ask for and print GRS1. Ztest will return dummy records
1025 on request.
1026
1027 Added Explain encoders/decoders to the service-level API. Untested.
1028
1029 Added Extended Services: Item Order encoders and decoders to the Service-
1030 level API. Untested. We could use a recent copy of the pertinent bits
1031 of the ILL protocol to add those bits.
1032
1033 Added diagnostic format 1 encoders/decoders to the service-level API.
1034 Untested.
1035
1036 Moved pretty-printing of structure-wrappers ({..}) from odr_seq.c to
1037 odr_cons.c, which causes a more correct output.
1038
1039 Fixed handling of searchRequest in frontend server. NextResultSetPosition
1040 was always set to 0 when no records were requested in the searchRequest.
1041
1042 * Added better external-handling. This shouldn't harm old code that
1043 *encodes* externals. It can break code that looks for a
1044 'single-ASN1-type' representation, since those types that are known
1045 are now decoded immediately. Look at the SUTRS sample code in
1046 seshigh.c and client.c. Documentation updated.
1047
1048 Handling of structured records in bend_fetchresponse. Length -1 marks
1049 structured record, type is deduced from format field.
1050
1051 --- 1.0b2 1995/06/27
1052 Fairly quick maintenance release to add SUTRS support.
1053
1054 Fixed handling of SUTRS records in the demonstration client.
1055
1056 * Added format field to the bend_fetchrequest and bend_fetchresponce
1057 structures of the backend API (frontend server). When the record is
1058 returned, the value of the format field is mapped to an OID. The
1059 value VAL_SUTRS will also cause a slightly different ASN.1 packaging
1060 of the record. The special value VAL_NONE in the bend_request means
1061 that no specific format was requested by the client. Documentation
1062 updated accordingly. Test server (ztest) will return a fixed dummy
1063 SUTRS record if your client requests SUTRS.
1064
1065 Documentation updated accordingly.
1066
1067 You can now set external libraries and RANLIB support in the top-level
1068 Makefile.
1069
1070 --- 1.0b 1995/06/19
1071 First public release.