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