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