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