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