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