Minor.
[yaz-moved-to-github.git] / CHANGELOG
1 Possible compatibility problems with earlier versions marked with '*'.
2
3 For ILL, fixed tagging problem for member requester-CHECKED-IN in
4 type Requester-Optional-Messages-Type.
5
6 Added several OID's.
7
8 Changed retrieval module so that we can load records with no abstract
9 syntax defined. Tagpaths in these records are fully composed of string tags.
10
11 Implemented ISO ILL protocol. Refer to stuff in sub directory ill.
12
13 --- 1.5 1999/12/10
14
15 On UNIX, the generated makefile now supports a proper 'make install'.
16 The prefix can be set via GNU configure to set the install location
17 (default is /usr/local).
18
19 * YAZ programs client and ztest were renamed to yaz-client and
20 yaz-ztest to avoid conflicts when users install YAZ in "standard"
21 locations, such as /usr/bin,/usr/local/bin,etc.
22
23 * YAZ Header files were moved from include to include/yaz. YAZ Header
24 files are referred to as include <yaz/log.h> rather than <log.h>.
25 The YAZ include path (-I ..) is therefore the same as before. Programmers
26 should update their #include statements or use -Ipath/include/yaz
27 instead. The main motivation for doing this change is that YAZ header files
28 can be installed in "standard" locations /usr/include,/usr/local/include 
29 without introducing conflicts, since ALL YAZ header files are stored
30 in subdirectory yaz (under /usr/include for example).
31
32 Compilation of YAZ for WIN32 is now handled by an nmake-style makefile 
33 rather than project/workspace files. We switched because project files
34 are incompatible between Visual C++ 5 and 6. Refer to windows.txt for
35 details.
36
37 Changed name of logging function, logf, to yaz_log, to prevent name
38 clash with some math-log functions. The YAZ header log.h defines logf
39 to yaz_log (#define) so there should be no incompatibilities by this
40 modification.
41
42 Added bend_start/bend_stop handlers for server. These handler are
43 called on start/stop of server. For windows they are called whenever
44 a service is started/stopped.
45
46 * YAZ now auto-generates decoders/encoders for the Z39.50 protocol using
47 a fairly small ASN.1 compiler written in Tcl. The compiler is located
48 in util/yc.tcl. The auto-generated C code structures are, in a few
49 cases, incompatible with the old decoders. There are differences in the
50 following C structures Z_DiagRec, Z_External, Z_SortRequest, Z_SortResponse,
51 Z_AttributesPlusTerm, Z_ProximityOperator, Z_DefaultDiagFormat.
52 The preprocessor variable ASN_COMPILED is defined when the compiled
53 ASN.1 is being used. Encoder/decoder routines as well as the Z39.50
54 protocol ASN.1 is located sub directory <tt>z39.50</tt>. If you
55 wish to use the old encoders/decoders you can specify --disable-yc
56 for configure.
57
58 Assigned OID for old DB Update (VAL_DBUPDATE0). Updated YAZ compiled
59 version so that it supports both new - and old version of DB Update
60
61 * Added 'name' parameter to ODR encoder/decoder routines to facilitate
62 pretty ODR print. Updated whole Z39.50 encoder/decoder to reflect the
63 change. The name parameter can be set to 0 in which no name is specified
64 for the construction. The macros odr_implicit and odr_explicit sets name
65 parameter to zero for the construction involved. New macros
66 odr_implicit_tag and odr_explicit_tag are similar to the others,
67 except that a name parameter is added. For programmers' that don't use
68 ODR they probably only need to change the call to z_APDU and z_External.
69
70 Added access control facility by interfacing the TCP wrapper library.
71 YAZ automatically attempts to find the TCP wrapper Library (-lwrap) and
72 tcpd.h on Unix systems. For the server, option -d<daemon> specifies the
73 name of the daemon and enables the access control as specified in
74 hosts.allow/hosts.deny. Refer to man pages tcpd(8) and hosts_access(5).
75
76 Fixed memory leak in ccl_find_str and ccl_qual_rm. Thanks to Hans van
77 den Dool <H.M.vdnDool@kub.nl>.
78
79 Added reference ID parameter to most functions in server API - refer
80 to backend.h. Thanks to Hans van den Dool <H.M.vdnDool@kub.nl>.
81
82 Changed name of ccl library to libccl.a (was ccl.a).
83
84 Fixed bug in decoder for Explain (Category TargetInfo).
85
86 Added support for GNU readline in client. Thanks to Jacob Poulsen
87 <ja7@dbc.dk>. GNU configure attempts to detect if readline is available.
88
89 * CHANGED DEFINITION OF ES: UPDATE (INCLUDING THE OID) to reflect the
90 new definition from the ZIG. NOTE THIS IF YOU HAVE AN UPDATE
91 IMPLEMENTATION! This change was made to the development version before
92 the ZIG decided to retract the amendment. If any users MUST be
93 compatible with the original Update definition, PLEASE CONTACT US, and
94 we will include a separate definition corresponding to the old Update
95 ES. Note that because of the change to the ASN.1 of the
96 TaskPackageRecordStructure we cannot define a single structure that
97 will support both versions.
98
99 * Added const modifier to buffer parameter for some ODR/BER encoding
100 routines: ber_dectag, ber_declen, odp_more_chunks, completeBER,
101 completeWAIS, odr_dumpBER.
102
103 Fixed bug in client.c which caused a crash when a scanResponse didn't
104 contain positionOfTerm.
105
106 * Fixed inconsistency in the ScanResponse/ListEntries protocol. This
107 * will cause an error in a client if a non-YAZ target sends both a
108 * list of Scan entries and non-surrogate diagnostics.
109
110 Retrieval module enhancements. Tag sets may be typed in the reference
111 to it. From the .abs-file the "tagset" directive takes a third optional
112 integer type for the tag set referenced. From a .tag-file the "include"
113 directive takes a third optional type as well. The old "type" directive
114 in the tag set itself is still recognized but acts as the default type
115 for the tag set.
116
117 Backend interface change. Individual Scan terms returned from bend_scan
118 may also be tagged as Surrogate Diagnostics. Refer to struct scan_entry
119 in include/backend.h.
120
121 Retrieval module enhancements. Multiple tag sets and attribute sets may
122 be specified in abstract syntax specs. Revised the error/warning for
123 logging messages reported by the retrieval module when reading the
124 various spec files.
125
126 Object Identifier system (oid_..) changed. The API is backwards
127 compatible but the oid-routines now allocates new OID's when needed.
128 Raw OID's may be specified in oid_getvalbyname.
129
130 YAZ now uses GNU configure to generate Makefile(s).
131
132 * Minor changes in some of the member names of DeleteResultSetRequest and
133 DeleteResultSetResponse. See include/proto.h.
134
135 * Changed some C definitions regarding EXPLAIN record syntax (prt-exp.h)
136 and added member 'languages' in TargetInfo (which was missing).
137
138 Changed the way attribute sets are handled in the retrieval
139 module. These are now cached, just like the abstract syntaxes
140 (schemas).
141
142 Changed YAZ so that it links with compiled ASN.1.
143
144 Added Explain-schema definitions and mapping routines. The following
145 Explain categories have been implemented: AttributeDetails,
146 AttributeSetInfo, DatabaseInfo, CategoryList and TargetInfo.
147
148 Fixed minor bug in Windows version of Server Library.
149
150 --- 1.4pl2+ 1998/4/17 (Released with Zebra)
151
152 Added Extended Services to server (backend.h). Thanks to Charles Woodfield.
153
154 Added EXTERNAL: UNIverse Resource Report (non-standard).
155
156 Implemened odr_enum and odr_set_of functions to handle ASN.1 types
157 ENUMERATED and SET OF.
158
159 * Added 'const' to some of the char pointer arguments for the
160 functions, data1_read_node, data1_getelementbytagname,
161 data1_insert_taggeddata, data1_getesetbyname, data1_getelementbyname,
162 data1_get_absyn.
163
164 Fixed bug in data1_insert_taggeddata - the last_child member of
165 parent wasn't initialised.
166
167 * Changed data1_read_record and data1_read_node so that the supplied
168 "SGML"-buffer is read-only. In particular the resulting data1 - tree
169 doesn't refer to any parts of the "SGML"-buffer.
170
171 Fixed bug in server library (Windows version of statserv_remove).
172
173 * Changed code so that it compiles as C++. The type definition
174 of Odr_fun which is a member of Odr_arm was changed. The result is,
175 that an explicit typecast is needed for the fun pointer when
176 using Odr_arm - as in:
177     {1, -1, -1, Z_IdAuthentication_idPass, (Odr_fun)z_IdPass},
178
179 Updated TagSet-G and -M definitions (tagsetm.tag and tagsetg.tag).
180
181 Implemented the new structured date and time definition as approved
182 by the ZIG. Added schemaId element to the specificTag in Espec-1
183 (also approved at the last ZIG). Thanks to RVDM.
184
185 Added some Object identifiers (RVDM).
186
187 Changed the Update Extended Service (RVDM).
188
189 Added command "refid" to client which specifies referenceId for
190 the following requests.
191
192 Implemented extended service handling for server. See ztest.c
193 for an example as well as backend.h. New handlers are registerd
194 in the Init handler.
195
196 * Changed interface for sort in server.
197
198 Added new members to statserv_options_block. It allows a server
199 to read options from another source than just the command line. Thanks
200 to Charles Woodfield.
201
202 * Changed definition of Z_Triple in file prt-grs.h - member boolean
203 renamed to zboolean. Some C++ compilers complained about the name.
204
205 Minor changes to gils.abs. Added index 's' (sort) on title
206 and date/time-last-modified.
207
208 --- 1.4pl2 1998/1/30
209
210 Fixed bug in server library regarding inetd mode (-i). This bug
211 was introduced by release 1.4.
212
213 --- 1.4pl1 1998/1/29
214
215 Added sort facility in client and backend server interface.
216
217 Fixed problem with dependencies in Makefile(s).
218
219 Fixed bugs for encoders/decoders of extended services and 
220 SearchInfoReport.
221
222 Implemented sub-tree feature for schemas. Sub-trees are
223 referenced in *.abs-files. See explain.abs for an example
224 of the use of this feature.
225
226 Modified bib1.att; local attributes for ANY didn't include
227 ANY itself (only affects use of the retrieval module).
228
229 Fixed bug in plain SGML reader in function data1_read_node:
230 tags with prefix "var" was incorrectly interpreted as variants.
231
232 Added feature "sub-schemas" to enable references to - and definitions
233 of - group of elements.
234
235 * Removed member parent from type data1_element (in data1.h).
236
237 Implemented function odr_nullval() that returns the value of
238 ODR_NULLVAL.
239
240 * Removed member num_children from data1_node (in data1.h).
241
242 Made NT service interface part of the server library. The
243 function statserv_main uses the NT service when required and
244 calls the statserv_start / statserv_close routines.
245
246 Routine zget_SearchRequest and zget_PresentRequest fills
247 resultSetName/Id member with "default" instead of "Default".
248
249 Fixed memory leak in server. Request queue member wasn't freed.
250
251 Fixed nmem_exit so that memory is freed.
252
253 --- 1.4 1997/10/2
254
255 Revised the CCL parser utility to be thread safe.
256
257 Added function, oid_ent_to_oid, to replace the function 
258 oid_getoidbyent, which is not thread safe.
259
260 * Added nmem_init and nmem_exit to initialize and release
261 NMEM resources. Function nmem_init should be called once in the
262 initial thread before NMEM/ODR is used. statserv.c and client.c
263 have been changed accordingly. The change was necessary to make
264 NMEM thread safe. The NMEM memory pool is shared amongst threads
265 in a process. Unix-based applications will still work fine without
266 calling this.
267
268 Added NT Services interface for the the Z39.50 (statserv) Server. 
269 Refer to the ztest.c source on the usage.
270
271 Windows 95/NT port using MSVC5.0. Project files are included in the
272 distribution.
273
274 * Defined new 'global' handle for the retrieval (data1) system. The
275 new handled, data1_handle, describes the state of the data1 system.
276 This handle is passed as first argument to virtually all
277 data1 related routines. The functions data1_create and data1_destroy
278 creates and destroys a data1 handle respectively.
279
280 Added ODR encode stream member to all backend request structures
281 init, search, scan etc. This stream should be used to allocate all
282 memory used for the response when thread safe operation is needed.
283
284 Changed the comstack utility, cs_addstr, to be thread safe. The
285 returned hostname string returned by the function is now part the
286 COMSTACK instance.
287
288 Added comstack utility, cs_straddr, which replaces the tcpip_strtoaddr
289 function. The cs_straddr takes a COMSTACK handle as argument, so this
290 function must be used after cs_create and before bind/connect.
291 This function is thread safe.
292
293 Moved test server to 'ztest' directory - generic server code still
294 in 'server' directory.
295
296 Made prefix query (pquery.c) utility thread safe.
297
298 Added new function modifier YAZ_EXPORT to 'export' public DLL
299 functions when using windows (see include/yconfig.h).
300
301 Added definitions to the OID database (util/oid.c) (RVDM).
302
303 Added new BIB-1 diagnostic messages to the handler diagbib1_str.
304
305 Added call to ccl_rpn_delete in client program.
306
307 Added ODR argument to ccl_rpn_query and ccl_scan_query to provide
308 release of RPN structure.
309
310 Added support for C++, headers uses extern "C" for public definitions.
311 With input from RVDM.
312
313 In handling of SEQUENCE OF: Counter set to zero when SEQUENCE OF is absent.
314 Thanks to Ronald van der Meer (RVDM).
315
316 Added initializers (zget_ routines) for a number of PDUs. Thanks to RVDM.
317
318 Added support for private extensions to the OID database
319 (oid_setprivateoids()). Thanks to RVDM.
320     
321 Added optional, physical ANY (key replication)
322
323 Fixed null-reference problem in GRS-1 output filter.
324
325 Proximity operator added to Prefix Query Format (PQF).
326
327 In test client command "base" accepts multiple databases.
328
329 Fixed bug in cs_close stack that caused trouble with WINSOCK.
330
331 --- 1.3 1996/10/11
332
333 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
334
335 Smallish bug-fixes in the new encoders/decoders (explain).
336
337 Bug fixed in DeleteRequest.
338
339 Fixed tagging bug of type 101 query in SearchRequest-Query PDU encoder/decoder.
340
341 Fixed tagging bug in ResourceReportResponse PDU encoder/decode.
342
343 Added SOIF syntax (using private OID for now) to retrieval module and client.
344
345 Added Update extended service.
346
347 Added SearchResult-1 additional info structure.
348
349 Added optional CCL (ISO8777) interpreter as separate module. Available
350 in linemode client.
351
352 --- 1.2 1996/6/10 (1st anniversary release)
353
354 Added Summary record syntax. Lightly tested.
355
356 Added OPAC record syntax. Untested.
357
358 Added ResourceReport service encoders/decoders. Untested.
359
360 Fixed bug in z_Unit - wrong tagging on unitSystem.
361
362 Fixed bug in the DiagRecs decoder.
363
364 Added options for max PDU size and session timeout to frontend-server.
365
366 Added documentation of query-language parsers and other supporting utilities.
367
368 [frontend-server] Added Attribute set to the bend_scanrequest API.
369
370 [frontend-server] NextResultSetPosition was sometimes set incorrectly when
371 surrogate diagnostics were generated.
372
373 [retrieval] Allow multiple local values for attribute.
374
375 [retrieval] Allow multiple attributes per element in .abs files. index type.
376
377 [retrieval] Added Summary tagset, abstract syntax, and d1-node/ASN filter.
378
379 --- 1.1pl2  1996/4/10
380
381 Minor changes, mostly specific to Zebra's requirements (retrieval)
382
383 --- 1.1  1996/2/20
384
385 Repaired bug in frontend server when running multiple listening
386 endpoints in dynamic mode.
387
388 z_External() now won't break if a known, ASN.1 value comes encapsulated
389 in an octet-string. The value will pass through unmodified in an Odr_oct.
390
391 Added a bit of code to the demo client to decode & display
392 ASN.1-structured records represented in the octet-aligned branch of
393 the EXTERNAL CHOICE. Thanks to CAS for prodding us to finally do this.
394
395 Added z_ext_getentbyref() to the ASN module. Doc updated.
396
397 * Completed the SCAN definition in the ASN module. This may break SCAN
398 code based on older YAZ-versions at compile-time. The fix is easy -
399 look in proto.h.
400
401 * Added 'displayTerm' and OtherInformation to the TermInfo structure
402 under the SCAN definition. Remember to initialize this, server-people.
403
404 Comstack should now support the WAIS protocol in TCP/IP mode. Note
405 that this does not extend to ODR and ASN.
406
407 Comstack allows insertion of established socket (primarily for
408 inetd-operation of servers). Doc updated.
409
410 Front-end server can now start from the inetd in TCP mode. Doc
411 updated.
412
413 --- 1.0pl4 1996/1/24
414
415 Added Sort PDU.
416
417 Fixed small problem in SUTRS-filter. A newline was sometimes inserted before
418 the rank and record number.
419
420 Adjustments to the frontend server.
421
422 Fixed diagnostic BER dumper. It ignored the file argument.
423
424 --- 1.0pl3 1996/1/2
425
426 Various changes to retrieval module.
427
428 Changed the union discriminators of the protocol files from enums to
429 ints paired with #defines.
430
431 *Changed oident.class to oident.oclass to avoid a reserved word in C++
432  compilers.
433
434 *Changed operator in the RPN structure to 'roperator', again to avoid a
435  conflict with C++.
436
437 Fixed problems in Explain decoders/encoders.
438
439 --- 1.0pl2 1995/12/6
440
441 Memory bug in log module fixed.
442
443 --- 1.0pl1 1995/12/5
444
445 Occasional malloc() of 0 bytes fixed in d1_espec.c.
446
447 Bug in Explain DatabaseInfo module fixed.
448
449 Some '\r' snuck into one or two of the ret'l config tables. A curse on Windows.
450
451 --- 1.0 1995/11/28
452
453 The shift to v1.0 signals that we now consider the *core* functionality
454 of YAZ reasonably stable (the core being more or less equivalent to
455 Z39.50-1992). Some of the really nifty v3 stuff is still not heavily
456 tested (Explain not at all - though that will happen soonish).
457
458 Minor changes to code to support Windows port.
459
460 Various minor changes after we're getting to use GRS-1 & co. more.
461
462 Added Espec-1 format.
463
464 Added VisibleString field body type to GRS-1. It is illegal acc. to my copy
465 of the protocol and it cannot be selected when encoding (maps into 'string'
466 when decoding). Needed to talk to some servers.
467
468 Demo client can request simple element set names.
469
470 Added Diagnostic Format encoders/decoders.
471
472 Added simple Close handling to frontend server (no hooks for resource
473 reporting yet), and demonstration client.
474
475 Added cs_addrstr() command to COMSTACK to retrieve peer hostname/address.
476
477 --- 1.0b3 1995/08/24
478
479 Fixed bug in the frontend-server. The numberOfRecordsReturned field was
480 handled incorrectly when records were requested in the searchResponse. This
481 will only affect you if you use the frontend-server.
482
483 Added GRS-1 encoders/decoders to the service-level API. Lightly tested.
484 Test-client will ask for and print GRS1. Ztest will return dummy records
485 on request.
486
487 Added Explain encoders/decoders to the service-level API. Untested.
488
489 Added Extended Services: Item Order encoders and decoders to the Service-
490 level API. Untested. We could use a recent copy of the pertinent bits
491 of the ILL protocol to add those bits.
492
493 Added diagnostic format 1 encoders/decoders to the service-level API.
494 Untested.
495
496 Moved pretty-printing of structure-wrappers ({..}) from odr_seq.c to
497 odr_cons.c, which causes a more correct output.
498
499 Fixed handling of searchRequest in frontend server. NextResultSetPosition
500 was always set to 0 when no records were requested in the searchRequest.
501
502 * Added better external-handling. This shouldn't harm old code that
503 *encodes* externals. It can break code that looks for a
504 'single-ASN1-type' representation, since those types that are known
505 are now decoded immediately. Look at the SUTRS sample code in
506 seshigh.c and client.c. Documentation updated.
507
508 Handling of structured records in bend_fetchresponse. Length -1 marks
509 structured record, type is deduced from format field.
510
511 --- 1.0b2 1995/06/27
512 Fairly quick maintenance release to add SUTRS support.
513
514 Fixed handling of SUTRS records in the demonstration client.
515
516 * Added format field to the bend_fetchrequest and bend_fetchresponce
517 structures of the backend API (frontend server). When the record is
518 returned, the value of the format field is mapped to an OID. The
519 value VAL_SUTRS will also cause a slightly different ASN.1 packaging
520 of the record. The special value VAL_NONE in the bend_request means
521 that no specific format was requested by the client. Documentation
522 updated accordingly. Test server (ztest) will return a fixed dummy
523 SUTRS record if your client requests SUTRS.
524
525 Documentation updated accordingly.
526
527 You can now set external libraries and RANLIB support in the top-level
528 Makefile.
529
530 --- 1.0b 1995/06/19
531 First public release.