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