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