1 New filter, sort, that allows sorting of XML records via Z39.50
4 Filter record_transform: USEMarcon support. For example:
5 <retrieval syntax="usmarc">
6 <backend syntax="unimarc" name="F">
7 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
11 Filter multi: empty route pattern uses route as default.
13 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
14 may use the shorter notation
15 <target route="z3950.indexdata.com"/>
17 Filter query_rewrite: use config path to locate XSLT.
19 Filter frontend_net: log statistics.
20 If a custom message element in frontend_net configuration it makes
21 the frontend_net filter produce a log entry whenever an operation
22 is completed. The log is always written using yaz_log with the
23 custom message given, the package ID (session ID) , the time
24 the operation has been active (end-to-end) , the threads currently
25 active/total and the size of the request input/output queues.
27 query_rewrite: charset conversion of query terms.
28 This is an optional feature. Enabled by element <charset> in
29 configuration with attribute 'from' and 'to' that specifies
30 from/to encodings. The default 'from' encoding is UTF-8.
32 Filter record_transform: honor piggyback searches.
34 Filter zoom: re-connect when database is reused.
35 Re-connect is necessary if a connection is lost or a timeout occurs.
36 If not, we'll be seeing zero hits, when we shouldn't.
40 zoom: Change scheme for dealing with content proxy URLs. The module
41 now has its own common XSL transform that is enabled by record_xsl
42 attribute in the configuration. This XSL gets parameter cproxyhost
43 that holds the host for the content proxy session . The genearted-url
44 is created only if urlRecipe is enabled. In previous version default
45 value of urlRecipe was ${md-electronic-url}; it is now empty and
46 disabled by default. Also generated-url no longer includes the content
47 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
50 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
51 connections. Default value is 40 (seconds).
53 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
54 "Malformed query" for syntax errors and related ones; throw
55 Bib-1: 3 "Unsupported search" for everything else. Details from
56 the CCL parser is provided as additional-info.
58 multi: new setting hideerrors that makes multi only relay diagnostics
59 to a client if all backends fail.
63 zoom: empty ccl_map field-mappings disables CCL map.
65 zoom: fix Explain search that could return error if session was
70 zoom: returns Explain records for database IR-Explain---1. The
71 target profile records are converted to Explain records via XSLT.
73 session_shared: make error recovery configurable. Whether a search
74 is restarted on errors or not, is configurable by attribute "restart"
75 in element "resultset" in configuration.
77 session_shared: only relay init for first request. session_shared, for
78 each backend class, now only relays first init request (rather than all).
79 The module only needs to save init response info once. This avoids the
80 need to check for session max.
84 zoom: fix memory leaks.
86 session_shared: maximum number of sessons is configurable. Default
87 value is 100. Result-sets for backends without named result sets are
88 only re-used if databases is identical for a search. This is under the
89 assumption that performance may suffer for those backends when
90 changing the database for each search.
92 multi: combines diagnostics from all backends. All diagnostics from
93 backends are combined into multiple non-surrogate diagnostics; rather
94 than just one diagnostic from first backend.
98 zoom: relay realm to cproxy parameter file.
100 Configuration: Allow filter collection element inside route. This
101 makes it possible to include multiple filters at once.
103 zoom: nocproxy also disables urlRecipe.
105 --- 1.3.20 2011/12/21
107 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
108 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
109 90: "Unsupported direction value".
111 zoom: honor database argument nocproxy. This disables creating a content
112 connector session (for non-CF targets, usually) and also relays nocproxy
113 as database argument to a CF target.
115 --- 1.3.19 2011/12/16
117 zoom: Multiple proxy hosts may be given for proxy rich database
118 parameter. List is comma separated.
120 http_file: decodes URI paths properly. Does not return 404: not found
121 if no prefix are matches. Instead packages are passed on.
123 --- 1.3.18 2011/12/08
125 zoom: content-{user,password,proxy} are passed on to content proxy
126 system and takes precedence over user,password,proxy .
128 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
129 with a log element including log material from children filters. At
130 this point, only the zoom filter uses this log facility. It will
131 eventually be used by other filters as well. In particular it might be
132 useful for this feature to track all filters in used during a search.
134 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
135 and queries as they are manipulated are logged.
137 zoom: extend addinfo with native diagnostics. Diagnostics as received
138 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
139 diagnostics. This indicates both a backend diagnostic and the original
142 zoom: default urlRecipe value is ${md-electronic-url}
144 zoom: target profile setting sruVersion is recognized.
146 --- 1.3.17 2011/11/17
148 zoom: log target profile record fetched (AKA Torus).
150 --- 1.3.16 2011/11/17
152 Change target profile parameter CfSubDb to CfSubDB.
154 --- 1.3.15 2011/11/12
156 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
157 makes sense to the zoom module itself).
159 --- 1.3.14 2011/11/11
161 zoom: realm may be given as part of database.
163 --- 1.3.13 2011/10/26
165 Fix Origin class assigment method; was removd by mistake in 1.3.12.
167 --- 1.3.12 2011/10/26
169 zoom: database args x-name=value are passed through to backend database.
171 SRU filter: user may specify session ID that is passed to log entries
172 that follows. It is specified by using x-session-id in the SRU arguments.
174 zoom: fix null pointer reference which would occur for bad url parameter
175 inside "torus" or if url was not given.
177 --- 1.3.11 2011/09/09
178 Fix bug in filter session_shared where sessions would not expire
179 properly (session ttl). This in turn could make the target close the
180 connection before expected and session_shared would return diagnostic
181 2: system temporarily available.
183 --- 1.3.10 2011/09/09
185 zoom: new target profile setting: sortmap_field. If sortmap_field is given
186 the field is mapped to the value for the sortmap. Values not matching
187 sortmap_field are passed verbatim.
189 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
190 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
191 depending on whether RPN or CQL is actually sent to the target.
195 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
197 zoom: For content proxy authentication is stored in param name
198 "auth", instead of "authentication".
202 zoom: relay schema in SRU mode. Previously recordSchema was not affected
207 zoom: new target profile element literalTransform that holds XSLT
208 (encoded as string) for target. Only if present and non-zero length it is
209 considered present. This takes precedence over transform.
211 Don't rely on trang anymore for Git checkout builds. Configuration in etc
212 will only be properly validated if trang is available. From now on only
213 relax NC files are bundled with the source dist.
215 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
216 component was not detected when it should be.
220 z3950_client: mark non-surrogate diagnostics from backend.
222 zoom: a proxy may be specified for HTTP fetch of target profiles.
226 Honor piggyback. Makes some SRU targets behave that insist on
227 maximumRecords > 0, but also increases performance.
231 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
232 file was not update for libdir/metaproxy4 in version 1.3.2.
236 Change location of Metaproxy modules from libdir/metaproxy to
237 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
238 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
240 New facility to dump APDUs from zoom filter. Enabled by
241 <log apdu="true"/> in the zoom filter configuation.
243 zoom filter bug fix: SRU diagnostics received from backend was
244 not properly converted to Bib-1 diagnostics.
246 Package metaproxy depends on libmetaproxy4, same version.
250 zoom: fix a bug WRT passing authentication parameters to backends.
254 Fixes for windows Makefile.
256 --- 1.2.10 2011/07/25
258 Change major version of metaproxy library from 3 to 4. This in turn
259 makes new package names for Debian and RPM.
263 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
266 zoom: configurable element sets for record transforms.
268 zoom: the target profile based transform is specified by element_transform
269 in element torus of of the ZOOM filter configuration ; default value
270 is "pz2". Target profile based retrieval is specified by element_raw
271 in configuration. It will perform same steps, but omit the XSL transform.
272 Default value is "raw".
274 zoom: element set is omitted if not set in profile. But only if pz2
275 transform is in effect. Previously the default element set was to "F".
277 zoom: For non-CF targets database arguments are parsed. User may supply
278 db,user=myuser&password=mypass for non-CF targets. These values override
279 what's given the authentication from the target profile.
281 session_shared: fix reference to freed memory. Would occur if a search
282 response had non-surrogate diagnostics.
286 Route may be given for each port in frontend_net.
290 Documentation for zoom filter. Local target profiles may be specified.
292 Fixes for zoom filter.
296 First version with zoom filter.
300 Filter z3950_client may be configured to always send a close APDU
301 to backend target when connection/session is closed. This will only
302 happen if close APDU is not already sent. Enabled by configuration
303 for z3950_client (force_close).
305 Filter virt_db and multi: relay close APDU.
307 Filter virt_db and multi: relay init size parameters
308 preferredMessageSize and maximumRecordSize.
310 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
314 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
316 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
317 as determined by configure.
319 RPM: Release includes 'indexdata' name. Use indexdata in release name so
320 this package can be distinguished from other vendors.
324 Fix filter multi: relay idAuthentication parameters.
328 Add metaproxy-config for returning compiler flags, libraries.
332 Fix --with-boost=PREFIX .
336 session_shared: fix use of maintenance thread.
338 Introduce 'start' method for filters and routers. It gets called after
339 configure and after fork, but before processing. This changes API -
340 from libmetaproxy2 to libmetaproxy3.
344 session_shared: ensure backend session is closed if init rejected
347 z3950_client: fix NULL ptr reference that could occur if two clients
348 connected concurrently and if max-sockets was in effect.
352 Fix bug 3497 - Metaproxy unstable while stopping.
354 Fix bug 3495 - SEGV in SRU filter.
358 Filter multi throws diagnostic 'Present Out of Range' when
359 appropriate - rather than returning 0 records.
361 Filter virt_db: fix bad result reuse. Could happen if a result
362 was overriden and a backend did not supported named result sets.
366 Filter log: category access logs diagnostics even if searchStatus
367 or presentStatus is 'success'.
371 The SRU to Z39.50 filter does repeated Z39.50 present requests
372 to fetch all records. Needed when a Z39.50 server returns partial
373 results (due to message size limits).
377 Metaproxy now kills all child processes that are spawned by
378 modules (in case of fork, exec).
382 Debian package now installs /etc/metaproxy/metaproxy.xml which
383 includes all XML files /etc/metaproxy/filters-enabled .
384 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
388 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
389 development package to facilitate 3rd party Metaproxy modules.
391 --- 1.0.23 2010/01/04
393 Filter virt_db: Close backend filter session when Init rejected is received
394 from it (in which case it's not really closed yet). This will ensure we don't
395 run out of resources such as FDs in this case.
397 sru_z3950 filter: Accept any database (including those not listed).
399 --- 1.0.22 2009/12/03
401 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
402 later which means YAZ 3.0.47 or later.
404 --- 1.0.20 2009/11/19
406 For filter virt_db, the database is a glob pattern and the virtual
407 database sections are consulted in the order given.
409 --- 1.0.19 2009/07/08
411 For filter multi, the target (for routing) may be given as a glob-pattern.
413 More documentation for filters virt_db and multi.
415 Update schema to allow for no database in sru_z3950 filter.
417 --- 1.0.18 2009/06/30
419 Added limit filter to put sleep (penalty) for heavy use.
421 Filter frontend_net may be configured to limit the number of new connections
422 from same IP to some value (connect-max).
424 Fixed the load_balance filter.
426 --- 1.0.17 2009/06/16
428 Fix path for metaproxy executable for Debian init.d script.
430 --- 1.0.16 2009/06/10
432 SRU to Z39.50 filter honors x-username and x-password. If only
433 x-username is given that translates to open authentication (Z39.50v2). If
434 both x-username and x-password is present that translates to idPass
435 authentication (Z39.50v3).
437 New facility to change current working directory (-w).
439 Update to upstream skeleton of init.d script. Should fix bug #2619.
441 Filter session_shared now caches records (used to only cache connections
444 Filter session_shared now invalidates a Z39.50 session if a server
445 returns -1 hits. This facility was also part of yazproxy and gets around
446 a bug in Voyager-based Z39.50 servers.
448 --- 1.0.15 2008/11/18
450 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
452 --- 1.0.14 2008/06/09
454 Fixed the value of SRU record schema in searchRetrieve response. It was set
455 to a fixed value of "dc" before.
457 Serialize identical SRU requests. This is useful if HTTP client software
458 fires identical requests against metaproxy.
460 Allow Z39.50 target to be specified for SRU requests by using SRU extra
461 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
462 avoid static configuration. This facility is handled by the sru_z3950 module
463 and the z3950_client module.
465 Allow maximum number of sockets to be used for a Z39.50 client by the
466 use of SRU extra parameter x-max-sockets. This facility is handled by the
467 sru_z3950 module and the z3950_client module.
469 --- 1.0.13.1 2008/02/29
471 Simplified check for Boost libraries.
473 --- 1.0.13 2008/02/29
475 First Debian package.
477 The sru_z9350 filter now recognizes SRU parameter z-target as being
478 a ZURL of the form host/database .
480 Mergetype may be specified for filter 'multi'.
482 --- 1.0.12 2007/09/19
484 Fixed problem in Makefile WRT library specifictions. This could produce
485 linker errors (when they should not happen).
487 Fixed bug #1341: MetaProxy returning different results. Problem was that
488 fix-up of record database did not normalize the database name.
490 Documentation updates for Windows compilation.
492 --- 1.0.11 2007/06/14
494 Fixed problem with logfile being truncated.
496 --- 1.0.10 2007/05/23
498 Fixed bug #1136: Access rights not enforced.
500 Extension for log module. The log category 'access' logs more details.
501 New category 'user-access' added which is simlar to 'access' but adds
502 the Z39.50 user as for all entries in a session.
506 Added support for configurable default/force target/vhost for module Z39.50
511 Implemented filter, session_shared, which optimizes usage of Z39.50
512 sessions and result sets.
514 New filter, record_transform, which converts MARC/XML records.
516 New filter, sru_z3950, which converts SRU to Z39.50 packages.
518 New filter, load_balance, in development.
520 New filter, zeerex_xplain.
522 XML framework for config files started.
524 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
525 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
526 XML config files are checked against RNG and XML Schema's.
528 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
529 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
530 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
531 explain record to YAZ CQL-to-PQF text config file.
535 Added 'timeout' setting for filter frontend_net which specifies the number
536 of seconds a session is idle before it is closed. Default timeout is
541 Database name in records returned set for virt_db/multi filters.
543 Filter session_shared now functional.
545 Log filter can be configured to write to a given file using 'filename'
546 element. Also information category can be specified with 'category'. If
547 filename is omitted, the log filter writes to stdout. See etc/config5.xml
552 Fixed compilation on Windows.
556 Added documentation for the hidenavailable option for the multi filter.
560 Fixed bug #573: Hide errors for individual servers. If the element
561 'hideunavailable' is given in the configuration, individual servers
562 being unavailable are hidden (unless all are unavailable).
564 Fixed bug #574: Database names are recognised case-sensitively.
566 Fixed bug #567: Fix up database name in Name-Plus-Record.
568 Fixed bug #568: Update win/makefile for VS 2005.
570 Fixed bug #569: Some options throws unknown exception.
574 More information about virtual hosts. The 'etc' directory is part of the
579 Build instructions for Windows. NMake makefile part of distribution tar.
585 Filters functional: auth_simple, backend_test, frontend_net, http_file,
586 log, multi, query_rewrite, template, virt_db, z3950_client.
588 Filters in development: session_shared.
590 Pseudo-filters: template, dl