1 zoom: may read cf-proxy's config settings.
2 This reduces manual configuration of the content proxy server host.
3 The ZOOM module will use the old style session.proxyhost if "server"
4 is given (deprecated) and use the new style proxyhost/session if
5 "config_file" is in use.
7 frontend_net: remove incoming requests that can not be handled
8 Requests in queue for filter frontend_net are removed if client
9 closes connection for the session and request is not yet handled.
11 sru_z3950: serialize requests. This is to ensure that pipelined
12 HTTP requests are handled properly.
16 New class, wrbuf, that wraps YAZ' WRBUF.
20 Metaproxy daemon is now running as user "metaproxy". This user is
21 managed by package maintainer scripts. The user information is stored
22 in /etc/metaproxy/metaproxy.user .
26 New filter, sort, that allows sorting of XML records via Z39.50
29 Filter record_transform: USEMarcon support. For example:
30 <retrieval syntax="usmarc">
31 <backend syntax="unimarc" name="F">
32 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
36 Filter multi: empty route pattern uses route as default.
38 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
39 may use the shorter notation
40 <target route="z3950.indexdata.com"/>
42 Filter query_rewrite: use config path to locate XSLT.
44 Filter frontend_net: log statistics.
45 If a custom message element in frontend_net configuration it makes
46 the frontend_net filter produce a log entry whenever an operation
47 is completed. The log is always written using yaz_log with the
48 custom message given, the package ID (session ID) , the time
49 the operation has been active (end-to-end) , the threads currently
50 active/total and the size of the request input/output queues.
52 query_rewrite: charset conversion of query terms.
53 This is an optional feature. Enabled by element <charset> in
54 configuration with attribute 'from' and 'to' that specifies
55 from/to encodings. The default 'from' encoding is UTF-8.
57 Filter record_transform: honor piggyback searches.
59 Filter zoom: re-connect when database is reused.
60 Re-connect is necessary if a connection is lost or a timeout occurs.
61 If not, we'll be seeing zero hits, when we shouldn't.
65 zoom: Change scheme for dealing with content proxy URLs. The module
66 now has its own common XSL transform that is enabled by record_xsl
67 attribute in the configuration. This XSL gets parameter cproxyhost
68 that holds the host for the content proxy session . The genearted-url
69 is created only if urlRecipe is enabled. In previous version default
70 value of urlRecipe was ${md-electronic-url}; it is now empty and
71 disabled by default. Also generated-url no longer includes the content
72 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
75 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
76 connections. Default value is 40 (seconds).
78 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
79 "Malformed query" for syntax errors and related ones; throw
80 Bib-1: 3 "Unsupported search" for everything else. Details from
81 the CCL parser is provided as additional-info.
83 multi: new setting hideerrors that makes multi only relay diagnostics
84 to a client if all backends fail.
88 zoom: empty ccl_map field-mappings disables CCL map.
90 zoom: fix Explain search that could return error if session was
95 zoom: returns Explain records for database IR-Explain---1. The
96 target profile records are converted to Explain records via XSLT.
98 session_shared: make error recovery configurable. Whether a search
99 is restarted on errors or not, is configurable by attribute "restart"
100 in element "resultset" in configuration.
102 session_shared: only relay init for first request. session_shared, for
103 each backend class, now only relays first init request (rather than all).
104 The module only needs to save init response info once. This avoids the
105 need to check for session max.
107 --- 1.3.22 2012/02/02
109 zoom: fix memory leaks.
111 session_shared: maximum number of sessons is configurable. Default
112 value is 100. Result-sets for backends without named result sets are
113 only re-used if databases is identical for a search. This is under the
114 assumption that performance may suffer for those backends when
115 changing the database for each search.
117 multi: combines diagnostics from all backends. All diagnostics from
118 backends are combined into multiple non-surrogate diagnostics; rather
119 than just one diagnostic from first backend.
121 --- 1.3.21 2011/12/27
123 zoom: relay realm to cproxy parameter file.
125 Configuration: Allow filter collection element inside route. This
126 makes it possible to include multiple filters at once.
128 zoom: nocproxy also disables urlRecipe.
130 --- 1.3.20 2011/12/21
132 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
133 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
134 90: "Unsupported direction value".
136 zoom: honor database argument nocproxy. This disables creating a content
137 connector session (for non-CF targets, usually) and also relays nocproxy
138 as database argument to a CF target.
140 --- 1.3.19 2011/12/16
142 zoom: Multiple proxy hosts may be given for proxy rich database
143 parameter. List is comma separated.
145 http_file: decodes URI paths properly. Does not return 404: not found
146 if no prefix are matches. Instead packages are passed on.
148 --- 1.3.18 2011/12/08
150 zoom: content-{user,password,proxy} are passed on to content proxy
151 system and takes precedence over user,password,proxy .
153 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
154 with a log element including log material from children filters. At
155 this point, only the zoom filter uses this log facility. It will
156 eventually be used by other filters as well. In particular it might be
157 useful for this feature to track all filters in used during a search.
159 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
160 and queries as they are manipulated are logged.
162 zoom: extend addinfo with native diagnostics. Diagnostics as received
163 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
164 diagnostics. This indicates both a backend diagnostic and the original
167 zoom: default urlRecipe value is ${md-electronic-url}
169 zoom: target profile setting sruVersion is recognized.
171 --- 1.3.17 2011/11/17
173 zoom: log target profile record fetched (AKA Torus).
175 --- 1.3.16 2011/11/17
177 Change target profile parameter CfSubDb to CfSubDB.
179 --- 1.3.15 2011/11/12
181 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
182 makes sense to the zoom module itself).
184 --- 1.3.14 2011/11/11
186 zoom: realm may be given as part of database.
188 --- 1.3.13 2011/10/26
190 Fix Origin class assigment method; was removd by mistake in 1.3.12.
192 --- 1.3.12 2011/10/26
194 zoom: database args x-name=value are passed through to backend database.
196 SRU filter: user may specify session ID that is passed to log entries
197 that follows. It is specified by using x-session-id in the SRU arguments.
199 zoom: fix null pointer reference which would occur for bad url parameter
200 inside "torus" or if url was not given.
202 --- 1.3.11 2011/09/09
203 Fix bug in filter session_shared where sessions would not expire
204 properly (session ttl). This in turn could make the target close the
205 connection before expected and session_shared would return diagnostic
206 2: system temporarily available.
208 --- 1.3.10 2011/09/09
210 zoom: new target profile setting: sortmap_field. If sortmap_field is given
211 the field is mapped to the value for the sortmap. Values not matching
212 sortmap_field are passed verbatim.
214 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
215 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
216 depending on whether RPN or CQL is actually sent to the target.
220 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
222 zoom: For content proxy authentication is stored in param name
223 "auth", instead of "authentication".
227 zoom: relay schema in SRU mode. Previously recordSchema was not affected
232 zoom: new target profile element literalTransform that holds XSLT
233 (encoded as string) for target. Only if present and non-zero length it is
234 considered present. This takes precedence over transform.
236 Don't rely on trang anymore for Git checkout builds. Configuration in etc
237 will only be properly validated if trang is available. From now on only
238 relax NC files are bundled with the source dist.
240 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
241 component was not detected when it should be.
245 z3950_client: mark non-surrogate diagnostics from backend.
247 zoom: a proxy may be specified for HTTP fetch of target profiles.
251 Honor piggyback. Makes some SRU targets behave that insist on
252 maximumRecords > 0, but also increases performance.
256 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
257 file was not update for libdir/metaproxy4 in version 1.3.2.
261 Change location of Metaproxy modules from libdir/metaproxy to
262 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
263 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
265 New facility to dump APDUs from zoom filter. Enabled by
266 <log apdu="true"/> in the zoom filter configuation.
268 zoom filter bug fix: SRU diagnostics received from backend was
269 not properly converted to Bib-1 diagnostics.
271 Package metaproxy depends on libmetaproxy4, same version.
275 zoom: fix a bug WRT passing authentication parameters to backends.
279 Fixes for windows Makefile.
281 --- 1.2.10 2011/07/25
283 Change major version of metaproxy library from 3 to 4. This in turn
284 makes new package names for Debian and RPM.
288 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
291 zoom: configurable element sets for record transforms.
293 zoom: the target profile based transform is specified by element_transform
294 in element torus of of the ZOOM filter configuration ; default value
295 is "pz2". Target profile based retrieval is specified by element_raw
296 in configuration. It will perform same steps, but omit the XSL transform.
297 Default value is "raw".
299 zoom: element set is omitted if not set in profile. But only if pz2
300 transform is in effect. Previously the default element set was to "F".
302 zoom: For non-CF targets database arguments are parsed. User may supply
303 db,user=myuser&password=mypass for non-CF targets. These values override
304 what's given the authentication from the target profile.
306 session_shared: fix reference to freed memory. Would occur if a search
307 response had non-surrogate diagnostics.
311 Route may be given for each port in frontend_net.
315 Documentation for zoom filter. Local target profiles may be specified.
317 Fixes for zoom filter.
321 First version with zoom filter.
325 Filter z3950_client may be configured to always send a close APDU
326 to backend target when connection/session is closed. This will only
327 happen if close APDU is not already sent. Enabled by configuration
328 for z3950_client (force_close).
330 Filter virt_db and multi: relay close APDU.
332 Filter virt_db and multi: relay init size parameters
333 preferredMessageSize and maximumRecordSize.
335 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
339 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
341 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
342 as determined by configure.
344 RPM: Release includes 'indexdata' name. Use indexdata in release name so
345 this package can be distinguished from other vendors.
349 Fix filter multi: relay idAuthentication parameters.
353 Add metaproxy-config for returning compiler flags, libraries.
357 Fix --with-boost=PREFIX .
361 session_shared: fix use of maintenance thread.
363 Introduce 'start' method for filters and routers. It gets called after
364 configure and after fork, but before processing. This changes API -
365 from libmetaproxy2 to libmetaproxy3.
369 session_shared: ensure backend session is closed if init rejected
372 z3950_client: fix NULL ptr reference that could occur if two clients
373 connected concurrently and if max-sockets was in effect.
377 Fix bug 3497 - Metaproxy unstable while stopping.
379 Fix bug 3495 - SEGV in SRU filter.
383 Filter multi throws diagnostic 'Present Out of Range' when
384 appropriate - rather than returning 0 records.
386 Filter virt_db: fix bad result reuse. Could happen if a result
387 was overriden and a backend did not supported named result sets.
391 Filter log: category access logs diagnostics even if searchStatus
392 or presentStatus is 'success'.
396 The SRU to Z39.50 filter does repeated Z39.50 present requests
397 to fetch all records. Needed when a Z39.50 server returns partial
398 results (due to message size limits).
402 Metaproxy now kills all child processes that are spawned by
403 modules (in case of fork, exec).
407 Debian package now installs /etc/metaproxy/metaproxy.xml which
408 includes all XML files /etc/metaproxy/filters-enabled .
409 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
413 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
414 development package to facilitate 3rd party Metaproxy modules.
416 --- 1.0.23 2010/01/04
418 Filter virt_db: Close backend filter session when Init rejected is received
419 from it (in which case it's not really closed yet). This will ensure we don't
420 run out of resources such as FDs in this case.
422 sru_z3950 filter: Accept any database (including those not listed).
424 --- 1.0.22 2009/12/03
426 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
427 later which means YAZ 3.0.47 or later.
429 --- 1.0.20 2009/11/19
431 For filter virt_db, the database is a glob pattern and the virtual
432 database sections are consulted in the order given.
434 --- 1.0.19 2009/07/08
436 For filter multi, the target (for routing) may be given as a glob-pattern.
438 More documentation for filters virt_db and multi.
440 Update schema to allow for no database in sru_z3950 filter.
442 --- 1.0.18 2009/06/30
444 Added limit filter to put sleep (penalty) for heavy use.
446 Filter frontend_net may be configured to limit the number of new connections
447 from same IP to some value (connect-max).
449 Fixed the load_balance filter.
451 --- 1.0.17 2009/06/16
453 Fix path for metaproxy executable for Debian init.d script.
455 --- 1.0.16 2009/06/10
457 SRU to Z39.50 filter honors x-username and x-password. If only
458 x-username is given that translates to open authentication (Z39.50v2). If
459 both x-username and x-password is present that translates to idPass
460 authentication (Z39.50v3).
462 New facility to change current working directory (-w).
464 Update to upstream skeleton of init.d script. Should fix bug #2619.
466 Filter session_shared now caches records (used to only cache connections
469 Filter session_shared now invalidates a Z39.50 session if a server
470 returns -1 hits. This facility was also part of yazproxy and gets around
471 a bug in Voyager-based Z39.50 servers.
473 --- 1.0.15 2008/11/18
475 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
477 --- 1.0.14 2008/06/09
479 Fixed the value of SRU record schema in searchRetrieve response. It was set
480 to a fixed value of "dc" before.
482 Serialize identical SRU requests. This is useful if HTTP client software
483 fires identical requests against metaproxy.
485 Allow Z39.50 target to be specified for SRU requests by using SRU extra
486 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
487 avoid static configuration. This facility is handled by the sru_z3950 module
488 and the z3950_client module.
490 Allow maximum number of sockets to be used for a Z39.50 client by the
491 use of SRU extra parameter x-max-sockets. This facility is handled by the
492 sru_z3950 module and the z3950_client module.
494 --- 1.0.13.1 2008/02/29
496 Simplified check for Boost libraries.
498 --- 1.0.13 2008/02/29
500 First Debian package.
502 The sru_z9350 filter now recognizes SRU parameter z-target as being
503 a ZURL of the form host/database .
505 Mergetype may be specified for filter 'multi'.
507 --- 1.0.12 2007/09/19
509 Fixed problem in Makefile WRT library specifictions. This could produce
510 linker errors (when they should not happen).
512 Fixed bug #1341: MetaProxy returning different results. Problem was that
513 fix-up of record database did not normalize the database name.
515 Documentation updates for Windows compilation.
517 --- 1.0.11 2007/06/14
519 Fixed problem with logfile being truncated.
521 --- 1.0.10 2007/05/23
523 Fixed bug #1136: Access rights not enforced.
525 Extension for log module. The log category 'access' logs more details.
526 New category 'user-access' added which is simlar to 'access' but adds
527 the Z39.50 user as for all entries in a session.
531 Added support for configurable default/force target/vhost for module Z39.50
536 Implemented filter, session_shared, which optimizes usage of Z39.50
537 sessions and result sets.
539 New filter, record_transform, which converts MARC/XML records.
541 New filter, sru_z3950, which converts SRU to Z39.50 packages.
543 New filter, load_balance, in development.
545 New filter, zeerex_xplain.
547 XML framework for config files started.
549 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
550 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
551 XML config files are checked against RNG and XML Schema's.
553 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
554 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
555 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
556 explain record to YAZ CQL-to-PQF text config file.
560 Added 'timeout' setting for filter frontend_net which specifies the number
561 of seconds a session is idle before it is closed. Default timeout is
566 Database name in records returned set for virt_db/multi filters.
568 Filter session_shared now functional.
570 Log filter can be configured to write to a given file using 'filename'
571 element. Also information category can be specified with 'category'. If
572 filename is omitted, the log filter writes to stdout. See etc/config5.xml
577 Fixed compilation on Windows.
581 Added documentation for the hidenavailable option for the multi filter.
585 Fixed bug #573: Hide errors for individual servers. If the element
586 'hideunavailable' is given in the configuration, individual servers
587 being unavailable are hidden (unless all are unavailable).
589 Fixed bug #574: Database names are recognised case-sensitively.
591 Fixed bug #567: Fix up database name in Name-Plus-Record.
593 Fixed bug #568: Update win/makefile for VS 2005.
595 Fixed bug #569: Some options throws unknown exception.
599 More information about virtual hosts. The 'etc' directory is part of the
604 Build instructions for Windows. NMake makefile part of distribution tar.
610 Filters functional: auth_simple, backend_test, frontend_net, http_file,
611 log, multi, query_rewrite, template, virt_db, z3950_client.
613 Filters in development: session_shared.
615 Pseudo-filters: template, dl