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