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