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