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