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