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