CHANGELOG

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