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