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