Version 1.3.24
[metaproxy-moved-to-github.git] / NEWS
1 --- 1.3.24 2012/02/23
2
3 zoom: empty ccl_map field-mappings disables CCL map.
4
5 zoom: fix Explain search that could return error if session was
6 re-used.
7
8 --- 1.3.23 2012/02/10
9
10 zoom: returns Explain records for database IR-Explain---1. The
11 target profile records are converted to Explain records via XSLT.
12
13 session_shared: make error recovery configurable. Whether a search
14 is restarted on errors or not, is configurable by attribute "restart"
15 in element "resultset" in configuration.
16
17 session_shared: only relay init for first request. session_shared, for
18 each backend class, now only relays first init request (rather than all).
19 The module only needs to save init response info once. This avoids the
20 need to check for session max.
21
22 --- 1.3.22 2012/02/02
23
24 zoom: fix memory leaks.
25
26 session_shared: maximum number of sessons is configurable. Default
27 value is 100. Result-sets for backends without named result sets are
28 only re-used if databases is identical for a search. This is under the
29 assumption that performance may suffer for those backends when
30 changing the database for each search.
31
32 multi: combines diagnostics from all backends. All diagnostics from
33 backends are combined into multiple non-surrogate diagnostics; rather
34 than just one diagnostic from first backend.
35
36 --- 1.3.21 2011/12/27
37
38 zoom: relay realm to cproxy parameter file.
39
40 Configuration: Allow filter collection element inside route. This
41 makes it possible to include multiple filters at once.
42
43 zoom: nocproxy also disables urlRecipe.
44
45 --- 1.3.20 2011/12/21
46
47 zoom: return diagnostic if CQL sortby conv fails.  Diagnostic Bib-1 214
48 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
49 90: "Unsupported direction value".
50
51 zoom: honor database argument nocproxy. This disables creating a content
52 connector session (for non-CF targets, usually) and also relays nocproxy
53 as database argument to a CF target.
54
55 --- 1.3.19 2011/12/16
56
57 zoom: Multiple proxy hosts may be given for proxy rich database 
58 parameter. List is comma separated.
59
60 http_file: decodes URI paths properly. Does not return 404: not found
61 if no prefix are matches. Instead packages are passed on.
62
63 --- 1.3.18 2011/12/08
64
65 zoom: content-{user,password,proxy} are passed on to content proxy
66 system and takes precedence over user,password,proxy .
67
68 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
69 with a log element including log material from children filters. At
70 this point, only the zoom filter uses this log facility. It will
71 eventually be used by other filters as well. In particular it might be
72 useful for this feature to track all filters in used during a search.
73
74 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
75 and queries as they are manipulated are logged.
76
77 zoom:  extend addinfo with native diagnostics. Diagnostics as received
78 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
79 diagnostics. This indicates both a backend diagnostic and the original
80 form.
81
82 zoom: default urlRecipe value is ${md-electronic-url}
83
84 zoom: target profile setting sruVersion is recognized.
85
86 --- 1.3.17 2011/11/17
87
88 zoom: log target profile record fetched (AKA Torus).
89
90 --- 1.3.16 2011/11/17
91
92 Change target profile parameter CfSubDb to CfSubDB.
93
94 --- 1.3.15 2011/11/12
95
96 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
97 makes sense to the zoom module itself).
98
99 --- 1.3.14 2011/11/11
100
101 zoom: realm may be given as part of database.
102
103 --- 1.3.13 2011/10/26
104
105 Fix Origin class assigment method; was removd by mistake in 1.3.12.
106
107 --- 1.3.12 2011/10/26
108
109 zoom: database args x-name=value are passed through to backend database.
110
111 SRU filter: user may specify session ID that is passed to log entries
112 that follows. It is specified by using x-session-id in the SRU arguments.
113
114 zoom: fix null pointer reference which would occur for bad url parameter
115 inside "torus" or if url was not given.
116
117 --- 1.3.11 2011/09/09
118 Fix bug in filter session_shared where sessions would not expire
119 properly (session ttl). This in turn could make the target close the
120 connection before expected and session_shared would return diagnostic
121 2: system temporarily available.
122
123 --- 1.3.10 2011/09/09
124
125 zoom: new target profile setting: sortmap_field. If sortmap_field is given
126 the field is mapped to the value for the sortmap. Values not matching
127 sortmap_field are passed verbatim.
128   
129 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
130 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
131 depending on whether RPN or CQL is actually sent to the target.
132
133 --- 1.3.9 2011/08/25
134
135 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
136
137 zoom: For content proxy authentication is stored in param name
138 "auth", instead of "authentication".
139
140 --- 1.3.8 2011/08/22
141
142 zoom: relay schema in SRU mode. Previously recordSchema was not affected
143 by elementSet.
144
145 --- 1.3.6 2011/08/22
146
147 zoom: new target profile element literalTransform that holds XSLT
148 (encoded as string) for target. Only if present and non-zero length it is
149 considered present. This takes precedence over transform.
150
151 Don't rely on trang anymore for Git checkout builds. Configuration in etc
152 will only be properly validated if trang is available. From now on only
153 relax NC files are bundled with the source dist.
154
155 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
156 component was not detected when it should be.
157
158 --- 1.3.5 2011/08/12
159
160 z3950_client: mark non-surrogate diagnostics from backend.
161
162 zoom: a proxy may be specified for HTTP fetch of target profiles.
163
164 --- 1.3.4 2011/08/01
165
166 Honor piggyback. Makes some SRU targets behave that insist on
167 maximumRecords > 0, but also increases performance.
168
169 --- 1.3.3 2011/08/01
170
171 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
172 file was not update for libdir/metaproxy4 in version 1.3.2.
173
174 --- 1.3.2 2011/08/01
175
176 Change location of Metaproxy modules from libdir/metaproxy to
177 libdir/metaproxy4. Directory libdir/metaproxy is also owned by 
178 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
179
180 New facility to dump APDUs from zoom filter. Enabled by 
181 <log apdu="true"/> in the zoom filter configuation.
182
183 zoom filter bug fix: SRU diagnostics received from backend was
184 not properly converted to Bib-1 diagnostics.
185
186 Package metaproxy depends on libmetaproxy4, same version.
187
188 --- 1.3.1 2011/07/28
189
190 zoom: fix a bug WRT passing authentication parameters to backends.
191
192 --- 1.3.0 2011/07/27
193
194 Fixes for windows Makefile.
195
196 --- 1.2.10 2011/07/25 
197
198 Change major version of metaproxy library from 3 to 4. This in turn
199 makes new package names for Debian and RPM.
200
201 --- 1.2.9 2011/06/27
202
203 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
204 transforn mode).
205
206 zoom: configurable element sets for record transforms.
207     
208 zoom: the target profile based transform is specified by element_transform
209 in element torus of of the ZOOM filter configuration ; default value
210 is "pz2". Target profile based retrieval is specified by element_raw
211 in configuration. It will perform same steps, but omit the XSL transform.
212 Default value is "raw".
213
214 zoom: element set is omitted if not set in profile. But only if pz2
215 transform is in effect. Previously the default element set was to "F".
216
217 zoom: For non-CF targets database arguments are parsed. User may supply
218 db,user=myuser&password=mypass for non-CF targets. These values override
219 what's given the authentication from the target profile.
220
221 session_shared: fix reference to freed memory. Would occur if a search
222 response had non-surrogate diagnostics.
223
224 --- 1.2.8 2011/06/22
225
226 Route may be given for each port in frontend_net.
227
228 --- 1.2.7 2011/06/22
229
230 Documentation for zoom filter. Local target profiles may be specified.
231
232 Fixes for zoom filter.
233
234 --- 1.2.6 2011/06/15
235
236 First version with zoom filter.
237
238 --- 1.2.5 2011/05/06
239
240 Filter z3950_client may be configured to always send a close APDU
241 to backend target when connection/session is closed. This will only
242 happen if close APDU is not already sent. Enabled by configuration
243 for z3950_client (force_close).
244
245 Filter virt_db and multi: relay close APDU.
246
247 Filter virt_db and multi: relay init size parameters 
248 preferredMessageSize and maximumRecordSize.
249
250 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
251
252 --- 1.2.4 2011/01/27
253
254 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
255
256 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
257 as determined by configure.
258
259 RPM: Release includes 'indexdata' name. Use indexdata in release name so
260 this package can be distinguished from other vendors.
261
262 --- 1.2.3 2010/10/04
263
264 Fix filter multi: relay idAuthentication parameters.
265
266 --- 1.2.2 2010/09/15
267
268 Add metaproxy-config for returning compiler flags, libraries.
269
270 --- 1.2.1 2010/08/18
271
272 Fix --with-boost=PREFIX .
273
274 --- 1.2.0 2010/07/09
275
276 session_shared: fix use of maintenance thread.
277
278 Introduce 'start' method for filters and routers. It gets called after
279 configure and after fork, but before processing. This changes API -
280 from libmetaproxy2 to libmetaproxy3.
281
282 --- 1.1.7 2010/06/30
283
284 session_shared: ensure backend session is closed if init rejected
285 is received.
286
287 z3950_client: fix NULL ptr reference that could occur if two clients
288 connected concurrently and if max-sockets was in effect.
289
290 --- 1.1.6 2010/06/21
291
292 Fix bug 3497 - Metaproxy unstable while stopping.
293
294 Fix bug 3495 - SEGV in SRU filter.
295
296 --- 1.1.5 2010/06/15
297
298 Filter multi throws diagnostic 'Present Out of Range' when
299 appropriate - rather than returning 0 records.
300
301 Filter virt_db: fix bad result reuse. Could happen if a result
302 was overriden and a backend did not supported named result sets.
303
304 --- 1.1.4 2010/05/11
305
306 Filter log: category access logs diagnostics even if searchStatus
307 or presentStatus is 'success'.
308
309 --- 1.1.3 2010/04/21
310
311 The SRU to Z39.50 filter does repeated Z39.50 present requests
312 to fetch all records. Needed when a Z39.50 server returns partial
313 results (due to message size limits).
314
315 --- 1.1.2 2010/03/18
316
317 Metaproxy now kills all child processes that are spawned by
318 modules (in case of fork, exec).
319
320 --- 1.1.1 2010/01/28
321
322 Debian package now installs /etc/metaproxy/metaproxy.xml which
323 includes all XML files /etc/metaproxy/filters-enabled .
324 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
325
326 --- 1.1.0 2010/01/20
327
328 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
329 development package to facilitate 3rd party Metaproxy modules.
330
331 --- 1.0.23 2010/01/04
332
333 Filter virt_db: Close backend filter session when Init rejected is received
334 from it (in which case it's not really closed yet). This will ensure we don't
335 run out of resources such as FDs in this case.
336
337 sru_z3950 filter: Accept any database (including those not listed).
338
339 --- 1.0.22 2009/12/03
340
341 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
342 later which means YAZ 3.0.47 or later.
343
344 --- 1.0.20 2009/11/19
345
346 For filter virt_db, the database is a glob pattern and the virtual
347 database sections are consulted in the order given.
348
349 --- 1.0.19 2009/07/08
350
351 For filter multi, the target (for routing) may be given as a glob-pattern.
352
353 More documentation for filters virt_db and multi.
354
355 Update schema to allow for no database in sru_z3950 filter.
356
357 --- 1.0.18 2009/06/30
358
359 Added limit filter to put sleep (penalty) for heavy use.
360
361 Filter frontend_net may be configured to limit the number of new connections
362 from same IP to some value (connect-max).
363
364 Fixed the load_balance filter.
365
366 --- 1.0.17 2009/06/16
367
368 Fix path for metaproxy executable for Debian init.d script.
369
370 --- 1.0.16 2009/06/10
371
372 SRU to Z39.50 filter honors x-username and x-password. If only
373 x-username is given that translates to open authentication (Z39.50v2). If
374 both x-username and x-password is present that translates to idPass
375 authentication (Z39.50v3).
376
377 New facility to change current working directory (-w).
378
379 Update to upstream skeleton of init.d script. Should fix bug #2619.
380
381 Filter session_shared now caches records (used to only cache connections
382 and result sets).
383
384 Filter session_shared now invalidates a Z39.50 session if a server
385 returns -1 hits. This facility was also part of yazproxy and gets around
386 a bug in Voyager-based Z39.50 servers.
387
388 --- 1.0.15 2008/11/18
389
390 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
391
392 --- 1.0.14 2008/06/09
393
394 Fixed the value of SRU record schema in searchRetrieve response. It was set
395 to a fixed value of "dc" before.
396
397 Serialize identical SRU requests. This is useful if HTTP client software
398 fires identical requests against metaproxy.
399
400 Allow Z39.50 target to be specified for SRU requests by using SRU extra
401 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
402 avoid static configuration. This facility is handled by the sru_z3950 module
403 and the z3950_client module.
404
405 Allow maximum number of sockets to be used for a Z39.50 client by the
406 use of SRU extra parameter x-max-sockets. This facility is handled by the
407 sru_z3950 module and the z3950_client module.
408
409 --- 1.0.13.1 2008/02/29
410
411 Simplified check for Boost libraries.
412
413 --- 1.0.13 2008/02/29
414
415 First Debian package.
416
417 The sru_z9350 filter now recognizes SRU parameter z-target as being
418 a ZURL of the form host/database . 
419
420 Mergetype may be specified for filter 'multi'.
421
422 --- 1.0.12 2007/09/19
423
424 Fixed problem in Makefile WRT library specifictions. This could produce
425 linker errors (when they should not happen).
426
427 Fixed bug #1341: MetaProxy returning different results. Problem was that
428 fix-up of record database did not normalize the database name.
429
430 Documentation updates for Windows compilation.
431
432 --- 1.0.11 2007/06/14
433
434 Fixed problem with logfile being truncated.
435
436 --- 1.0.10 2007/05/23
437
438 Fixed bug #1136: Access rights not enforced.
439
440 Extension for log module. The log category 'access' logs more details.
441 New category 'user-access' added which is simlar to 'access' but adds
442 the Z39.50 user as for all entries in a session.
443
444 Switched to GPL v2.
445
446 Added support for configurable default/force target/vhost for module Z39.50
447 client module.
448
449 --- 1.0.8 2007/01/25
450
451 Implemented filter, session_shared, which optimizes usage of Z39.50
452 sessions and result sets.
453
454 New filter, record_transform, which converts MARC/XML records.
455
456 New filter, sru_z3950, which converts SRU to Z39.50 packages.
457
458 New filter, load_balance, in development.
459
460 New filter, zeerex_xplain.
461
462 XML framework for config files started.
463
464 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
465 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
466 XML config files are checked against RNG and XML Schema's.
467
468 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of 
469 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
470 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX 
471 explain record to YAZ CQL-to-PQF text config file. 
472
473 --- 1.0.7 2006/11/07
474
475 Added 'timeout' setting for filter frontend_net which specifies the number
476 of seconds a session is idle before it is closed. Default timeout is
477 300 (5 minutes).
478
479 --- 1.0.6 2006/07/07
480
481 Database name in records returned set for virt_db/multi filters.
482
483 Filter session_shared now functional.
484
485 Log filter can be configured to write to a given file using 'filename'
486 element. Also information category can be specified with 'category'. If
487 filename is omitted, the log filter writes to stdout. See etc/config5.xml
488 for example.
489
490 --- 1.0.5 2006/05/16
491
492 Fixed compilation on Windows.
493
494 --- 1.0.4 2006/05/16
495
496 Added documentation for the hidenavailable option for the multi filter.
497
498 --- 1.0.3 2006/05/16
499
500 Fixed bug #573: Hide errors for individual servers. If the element
501 'hideunavailable' is given in the configuration, individual servers
502 being unavailable are hidden (unless all are unavailable). 
503
504 Fixed bug #574: Database names are recognised case-sensitively.
505
506 Fixed bug #567: Fix up database name in Name-Plus-Record.
507
508 Fixed bug #568: Update win/makefile for VS 2005.
509
510 Fixed bug #569: Some options throws unknown exception.
511
512 --- 1.0.2 2006/04/28
513
514 More information about virtual hosts. The 'etc' directory is part of the
515 distribution tar.
516
517 --- 1.0.1 2006/04/27
518
519 Build instructions for Windows. NMake makefile part of distribution tar.
520
521 --- 1.0.0 2006/04/24
522
523 More documentation.
524
525 Filters functional: auth_simple, backend_test, frontend_net, http_file,
526  log, multi, query_rewrite, template, virt_db, z3950_client.
527
528 Filters in development: session_shared.
529
530 Pseudo-filters: template, dl
531
532 --- 0.9 2006/03/27