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