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