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