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