3 For most generated diagnostics by filters, typically temporary
4 system error, augment addinfo message with filter name.
6 Add support for CentOS 6 packages.
8 sru_z3950: interpret Z39.50 diagnostics part of Init Response.
10 Add man page for metaproxy-config.
14 zoom: new config element passthru. This defines an element set that is
15 passed verbatim to the backend in pz2 mode.
17 auth_simple: allow both idPass and open auth. Also fix SEGV that could
22 z3950_client: fix string handling for init diagnostics in the case where
25 query_rewrite: no charset conversion for error queries. Avoid performing
26 charset conversion for query conversion errors. The resulting Type-1
27 query is invalid in this case.
31 For graceful stop (SIGUSR1), metaproxy will kill children processes.
33 Log when metaproxy is invoked in test mode (-t).
35 Log PID for each log message.
37 multi: combine both NSDs and multiple NSDs into one (diagnostics).
39 z3950_client: fixup multiple NSD's too. Like surrogate diagnostics,
40 a (backend=target) is appended for each diagnostic so that can be
41 determined the origin of error.
43 multi: hideerrors also in use for present response.
45 Solr example in zoom man page.
47 Fix typo in query_rewrite config example.
49 Log at least first non surrogate diagnostic. Instead of
50 "Z_Records_multipleNSD"
52 multi: Fix check for opt Records in present response. A SEGV could occur
53 if a target did not return records and no diagnostics.
57 Yet another fix for graceful stop.
61 sru_z3950: relay surrogate diagnostics.
65 zoom: Honor extraArgs, strip # in zurl.
67 multi: fix SEGV for scan. Reported by Rustam T. Usmanov.
69 zoom: url_recipe allow %{var[reg]} substitutions.
70 It's like ${var[reg]} but does URI component encoding as well.
74 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
75 non-keepalive HTTP sessions.
77 http_file: allow zero size files (bug fix)
79 Fix zoom schema: auth_url is optional
83 zoom: fix un-init memory (could result in SEGV at session close)
85 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
86 and may be used in filters as usual.
88 zoom: authentication via Torus lookup
89 Enabled by new configuration setting: auth_url . If this is defined,
90 the zoom module will contact Torus for auth/IP lookup and that will
91 define realm to be used in session.
95 virt_db: Fix database name - first character we removed by mistake.
96 Bug introduced in 1.3.40.
100 virt_db: Don't use "unix path" as database for Unix sockets.
102 --- 1.3.39 2012/08/02
104 z3950_client: Don't tamper with / in zurl - fixes problems
105 using Unix sockets for backends.
107 session_shared: fix integer overflow problem with hit count.
109 session_shared: avoid long usage of cached queries.
111 zoom: New database argument , torus_url to set URL of Torus
112 record to be fetched.
114 --- 1.3.38 2012/07/04
116 Fixes for 'metaproxy reload' for RPM/Debian packages.
118 zoom: Allow rpn2cql conversion to be augmented with a properties file.
119 Element rpn2cql can be specified per-target for the zoom filter.
121 log: New category "line" which is a single-line log message with
122 most important parts of a HTTP/Z39.50 request/response.
124 --- 1.3.37 2012/06/01
126 frontend_net: add facility to report live statistics about response
127 times and current thread usage. The report is an XML document
128 and is triggered for a specific URL path. This is set by <stat-req>
129 in the configuration of frontend_net. By default this report is
130 disabled (same as empty value for <stat-req>).
132 Fix reload problem in init.d script for RPM/Debian.
133 The '/etc/init.d/metaproxy reload' in some cases would stop but not
134 start metaproxy - effectively stopping the service.
136 Don't display start log message when config testing (-t).
138 zoom: avoid CCL message limit of 1K in ZOOM filter.
140 --- 1.3.36 2012/05/10
142 metaproxy init script reacts to reload which does graceful stop +
143 start and is used by logrorate script.
145 --- 1.3.35 2012/05/09
147 Fixes for Windows compilation.
149 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
150 existing sessions running but terminate the monitor process that is
151 used in keepalive mode.
153 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
154 before. Consistent with 'metaproxy stop' message.
156 zoom: document zoom's proxy_timeout
158 z3950_client: fixup addinfo for init response
160 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
161 "Access to specified database denied" is returned, but only if init
162 response from backend does not carry diagnostics already.
164 multi: relays user info for first rejected target. The other-information
165 field for init response for first rejected target is in common init
166 response. This ensures that some backend init diagnostics are returned to
169 --- 1.3.34 2012/04/25
171 frontend_log: extend logging (when message is given in config).
173 --- 1.3.33 2012/04/25
175 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
177 --- 1.3.32 2012/04/24
179 sru_z3950 filter passes through incoming Z39.50 requests again. Was
180 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
182 --- 1.3.31 2012/04/24
184 zoom: fixes for retry/proxy failover logic. More logging.
186 --- 1.3.30 2012/04/23
188 zoom: return addinfo="proxy failure" for proxy failures. This also
189 changes the scheme for dealing with proxies a bit. zoom now always
190 do proxy check, even if there's no failover. Fortunately, that's not
193 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
194 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
195 generic. We don't know why the init would fail; IP, user, block IP, etc.
196 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
198 zoom: guess if invalid SRU response was an auth failure
200 session_shared: disable session retry by default . Can be enabled by
201 restart="true" in resultset section.
203 --- 1.3.29 2012/04/18
205 zoom: may read cf-proxy's config settings.
206 This reduces manual configuration of the content proxy server host.
207 The ZOOM module will use the old style session.proxyhost if "server"
208 is given (deprecated) and use the new style proxyhost/session if
209 "config_file" is in use.
211 frontend_net: remove incoming requests that can not be handled
212 Requests in queue for filter frontend_net are removed if client
213 closes connection for the session and request is not yet handled.
215 sru_z3950: serialize requests. This is to ensure that pipelined
216 HTTP requests are handled properly.
218 --- 1.3.28 2012/04/04
220 New class, wrbuf, that wraps YAZ' WRBUF.
222 --- 1.3.27 2012/03/30
224 Metaproxy daemon is now running as user "metaproxy". This user is
225 managed by package maintainer scripts. The user information is stored
226 in /etc/metaproxy/metaproxy.user .
228 --- 1.3.26 2012/03/20
230 New filter, sort, that allows sorting of XML records via Z39.50
233 Filter record_transform: USEMarcon support. For example:
234 <retrieval syntax="usmarc">
235 <backend syntax="unimarc" name="F">
236 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
240 Filter multi: empty route pattern uses route as default.
242 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
243 may use the shorter notation
244 <target route="z3950.indexdata.com"/>
246 Filter query_rewrite: use config path to locate XSLT.
248 Filter frontend_net: log statistics.
249 If a custom message element in frontend_net configuration it makes
250 the frontend_net filter produce a log entry whenever an operation
251 is completed. The log is always written using yaz_log with the
252 custom message given, the package ID (session ID) , the time
253 the operation has been active (end-to-end) , the threads currently
254 active/total and the size of the request input/output queues.
256 query_rewrite: charset conversion of query terms.
257 This is an optional feature. Enabled by element <charset> in
258 configuration with attribute 'from' and 'to' that specifies
259 from/to encodings. The default 'from' encoding is UTF-8.
261 Filter record_transform: honor piggyback searches.
263 Filter zoom: re-connect when database is reused.
264 Re-connect is necessary if a connection is lost or a timeout occurs.
265 If not, we'll be seeing zero hits, when we shouldn't.
267 --- 1.3.25 2012/02/29
269 zoom: Change scheme for dealing with content proxy URLs. The module
270 now has its own common XSL transform that is enabled by record_xsl
271 attribute in the configuration. This XSL gets parameter cproxyhost
272 that holds the host for the content proxy session . The genearted-url
273 is created only if urlRecipe is enabled. In previous version default
274 value of urlRecipe was ${md-electronic-url}; it is now empty and
275 disabled by default. Also generated-url no longer includes the content
276 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
279 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
280 connections. Default value is 40 (seconds).
282 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
283 "Malformed query" for syntax errors and related ones; throw
284 Bib-1: 3 "Unsupported search" for everything else. Details from
285 the CCL parser is provided as additional-info.
287 multi: new setting hideerrors that makes multi only relay diagnostics
288 to a client if all backends fail.
290 --- 1.3.24 2012/02/23
292 zoom: empty ccl_map field-mappings disables CCL map.
294 zoom: fix Explain search that could return error if session was
297 --- 1.3.23 2012/02/10
299 zoom: returns Explain records for database IR-Explain---1. The
300 target profile records are converted to Explain records via XSLT.
302 session_shared: make error recovery configurable. Whether a search
303 is restarted on errors or not, is configurable by attribute "restart"
304 in element "resultset" in configuration.
306 session_shared: only relay init for first request. session_shared, for
307 each backend class, now only relays first init request (rather than all).
308 The module only needs to save init response info once. This avoids the
309 need to check for session max.
311 --- 1.3.22 2012/02/02
313 zoom: fix memory leaks.
315 session_shared: maximum number of sessons is configurable. Default
316 value is 100. Result-sets for backends without named result sets are
317 only re-used if databases is identical for a search. This is under the
318 assumption that performance may suffer for those backends when
319 changing the database for each search.
321 multi: combines diagnostics from all backends. All diagnostics from
322 backends are combined into multiple non-surrogate diagnostics; rather
323 than just one diagnostic from first backend.
325 --- 1.3.21 2011/12/27
327 zoom: relay realm to cproxy parameter file.
329 Configuration: Allow filter collection element inside route. This
330 makes it possible to include multiple filters at once.
332 zoom: nocproxy also disables urlRecipe.
334 --- 1.3.20 2011/12/21
336 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
337 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
338 90: "Unsupported direction value".
340 zoom: honor database argument nocproxy. This disables creating a content
341 connector session (for non-CF targets, usually) and also relays nocproxy
342 as database argument to a CF target.
344 --- 1.3.19 2011/12/16
346 zoom: Multiple proxy hosts may be given for proxy rich database
347 parameter. List is comma separated.
349 http_file: decodes URI paths properly. Does not return 404: not found
350 if no prefix are matches. Instead packages are passed on.
352 --- 1.3.18 2011/12/08
354 zoom: content-{user,password,proxy} are passed on to content proxy
355 system and takes precedence over user,password,proxy .
357 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
358 with a log element including log material from children filters. At
359 this point, only the zoom filter uses this log facility. It will
360 eventually be used by other filters as well. In particular it might be
361 useful for this feature to track all filters in used during a search.
363 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
364 and queries as they are manipulated are logged.
366 zoom: extend addinfo with native diagnostics. Diagnostics as received
367 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
368 diagnostics. This indicates both a backend diagnostic and the original
371 zoom: default urlRecipe value is ${md-electronic-url}
373 zoom: target profile setting sruVersion is recognized.
375 --- 1.3.17 2011/11/17
377 zoom: log target profile record fetched (AKA Torus).
379 --- 1.3.16 2011/11/17
381 Change target profile parameter CfSubDb to CfSubDB.
383 --- 1.3.15 2011/11/12
385 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
386 makes sense to the zoom module itself).
388 --- 1.3.14 2011/11/11
390 zoom: realm may be given as part of database.
392 --- 1.3.13 2011/10/26
394 Fix Origin class assigment method; was removd by mistake in 1.3.12.
396 --- 1.3.12 2011/10/26
398 zoom: database args x-name=value are passed through to backend database.
400 SRU filter: user may specify session ID that is passed to log entries
401 that follows. It is specified by using x-session-id in the SRU arguments.
403 zoom: fix null pointer reference which would occur for bad url parameter
404 inside "torus" or if url was not given.
406 --- 1.3.11 2011/09/09
407 Fix bug in filter session_shared where sessions would not expire
408 properly (session ttl). This in turn could make the target close the
409 connection before expected and session_shared would return diagnostic
410 2: system temporarily available.
412 --- 1.3.10 2011/09/09
414 zoom: new target profile setting: sortmap_field. If sortmap_field is given
415 the field is mapped to the value for the sortmap. Values not matching
416 sortmap_field are passed verbatim.
418 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
419 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
420 depending on whether RPN or CQL is actually sent to the target.
424 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
426 zoom: For content proxy authentication is stored in param name
427 "auth", instead of "authentication".
431 zoom: relay schema in SRU mode. Previously recordSchema was not affected
436 zoom: new target profile element literalTransform that holds XSLT
437 (encoded as string) for target. Only if present and non-zero length it is
438 considered present. This takes precedence over transform.
440 Don't rely on trang anymore for Git checkout builds. Configuration in etc
441 will only be properly validated if trang is available. From now on only
442 relax NC files are bundled with the source dist.
444 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
445 component was not detected when it should be.
449 z3950_client: mark non-surrogate diagnostics from backend.
451 zoom: a proxy may be specified for HTTP fetch of target profiles.
455 Honor piggyback. Makes some SRU targets behave that insist on
456 maximumRecords > 0, but also increases performance.
460 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
461 file was not update for libdir/metaproxy4 in version 1.3.2.
465 Change location of Metaproxy modules from libdir/metaproxy to
466 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
467 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
469 New facility to dump APDUs from zoom filter. Enabled by
470 <log apdu="true"/> in the zoom filter configuation.
472 zoom filter bug fix: SRU diagnostics received from backend was
473 not properly converted to Bib-1 diagnostics.
475 Package metaproxy depends on libmetaproxy4, same version.
479 zoom: fix a bug WRT passing authentication parameters to backends.
483 Fixes for windows Makefile.
485 --- 1.2.10 2011/07/25
487 Change major version of metaproxy library from 3 to 4. This in turn
488 makes new package names for Debian and RPM.
492 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
495 zoom: configurable element sets for record transforms.
497 zoom: the target profile based transform is specified by element_transform
498 in element torus of of the ZOOM filter configuration ; default value
499 is "pz2". Target profile based retrieval is specified by element_raw
500 in configuration. It will perform same steps, but omit the XSL transform.
501 Default value is "raw".
503 zoom: element set is omitted if not set in profile. But only if pz2
504 transform is in effect. Previously the default element set was to "F".
506 zoom: For non-CF targets database arguments are parsed. User may supply
507 db,user=myuser&password=mypass for non-CF targets. These values override
508 what's given the authentication from the target profile.
510 session_shared: fix reference to freed memory. Would occur if a search
511 response had non-surrogate diagnostics.
515 Route may be given for each port in frontend_net.
519 Documentation for zoom filter. Local target profiles may be specified.
521 Fixes for zoom filter.
525 First version with zoom filter.
529 Filter z3950_client may be configured to always send a close APDU
530 to backend target when connection/session is closed. This will only
531 happen if close APDU is not already sent. Enabled by configuration
532 for z3950_client (force_close).
534 Filter virt_db and multi: relay close APDU.
536 Filter virt_db and multi: relay init size parameters
537 preferredMessageSize and maximumRecordSize.
539 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
543 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
545 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
546 as determined by configure.
548 RPM: Release includes 'indexdata' name. Use indexdata in release name so
549 this package can be distinguished from other vendors.
553 Fix filter multi: relay idAuthentication parameters.
557 Add metaproxy-config for returning compiler flags, libraries.
561 Fix --with-boost=PREFIX .
565 session_shared: fix use of maintenance thread.
567 Introduce 'start' method for filters and routers. It gets called after
568 configure and after fork, but before processing. This changes API -
569 from libmetaproxy2 to libmetaproxy3.
573 session_shared: ensure backend session is closed if init rejected
576 z3950_client: fix NULL ptr reference that could occur if two clients
577 connected concurrently and if max-sockets was in effect.
581 Fix bug 3497 - Metaproxy unstable while stopping.
583 Fix bug 3495 - SEGV in SRU filter.
587 Filter multi throws diagnostic 'Present Out of Range' when
588 appropriate - rather than returning 0 records.
590 Filter virt_db: fix bad result reuse. Could happen if a result
591 was overriden and a backend did not supported named result sets.
595 Filter log: category access logs diagnostics even if searchStatus
596 or presentStatus is 'success'.
600 The SRU to Z39.50 filter does repeated Z39.50 present requests
601 to fetch all records. Needed when a Z39.50 server returns partial
602 results (due to message size limits).
606 Metaproxy now kills all child processes that are spawned by
607 modules (in case of fork, exec).
611 Debian package now installs /etc/metaproxy/metaproxy.xml which
612 includes all XML files /etc/metaproxy/filters-enabled .
613 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
617 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
618 development package to facilitate 3rd party Metaproxy modules.
620 --- 1.0.23 2010/01/04
622 Filter virt_db: Close backend filter session when Init rejected is received
623 from it (in which case it's not really closed yet). This will ensure we don't
624 run out of resources such as FDs in this case.
626 sru_z3950 filter: Accept any database (including those not listed).
628 --- 1.0.22 2009/12/03
630 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
631 later which means YAZ 3.0.47 or later.
633 --- 1.0.20 2009/11/19
635 For filter virt_db, the database is a glob pattern and the virtual
636 database sections are consulted in the order given.
638 --- 1.0.19 2009/07/08
640 For filter multi, the target (for routing) may be given as a glob-pattern.
642 More documentation for filters virt_db and multi.
644 Update schema to allow for no database in sru_z3950 filter.
646 --- 1.0.18 2009/06/30
648 Added limit filter to put sleep (penalty) for heavy use.
650 Filter frontend_net may be configured to limit the number of new connections
651 from same IP to some value (connect-max).
653 Fixed the load_balance filter.
655 --- 1.0.17 2009/06/16
657 Fix path for metaproxy executable for Debian init.d script.
659 --- 1.0.16 2009/06/10
661 SRU to Z39.50 filter honors x-username and x-password. If only
662 x-username is given that translates to open authentication (Z39.50v2). If
663 both x-username and x-password is present that translates to idPass
664 authentication (Z39.50v3).
666 New facility to change current working directory (-w).
668 Update to upstream skeleton of init.d script. Should fix bug #2619.
670 Filter session_shared now caches records (used to only cache connections
673 Filter session_shared now invalidates a Z39.50 session if a server
674 returns -1 hits. This facility was also part of yazproxy and gets around
675 a bug in Voyager-based Z39.50 servers.
677 --- 1.0.15 2008/11/18
679 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
681 --- 1.0.14 2008/06/09
683 Fixed the value of SRU record schema in searchRetrieve response. It was set
684 to a fixed value of "dc" before.
686 Serialize identical SRU requests. This is useful if HTTP client software
687 fires identical requests against metaproxy.
689 Allow Z39.50 target to be specified for SRU requests by using SRU extra
690 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
691 avoid static configuration. This facility is handled by the sru_z3950 module
692 and the z3950_client module.
694 Allow maximum number of sockets to be used for a Z39.50 client by the
695 use of SRU extra parameter x-max-sockets. This facility is handled by the
696 sru_z3950 module and the z3950_client module.
698 --- 1.0.13.1 2008/02/29
700 Simplified check for Boost libraries.
702 --- 1.0.13 2008/02/29
704 First Debian package.
706 The sru_z9350 filter now recognizes SRU parameter z-target as being
707 a ZURL of the form host/database .
709 Mergetype may be specified for filter 'multi'.
711 --- 1.0.12 2007/09/19
713 Fixed problem in Makefile WRT library specifictions. This could produce
714 linker errors (when they should not happen).
716 Fixed bug #1341: MetaProxy returning different results. Problem was that
717 fix-up of record database did not normalize the database name.
719 Documentation updates for Windows compilation.
721 --- 1.0.11 2007/06/14
723 Fixed problem with logfile being truncated.
725 --- 1.0.10 2007/05/23
727 Fixed bug #1136: Access rights not enforced.
729 Extension for log module. The log category 'access' logs more details.
730 New category 'user-access' added which is simlar to 'access' but adds
731 the Z39.50 user as for all entries in a session.
735 Added support for configurable default/force target/vhost for module Z39.50
740 Implemented filter, session_shared, which optimizes usage of Z39.50
741 sessions and result sets.
743 New filter, record_transform, which converts MARC/XML records.
745 New filter, sru_z3950, which converts SRU to Z39.50 packages.
747 New filter, load_balance, in development.
749 New filter, zeerex_xplain.
751 XML framework for config files started.
753 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
754 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
755 XML config files are checked against RNG and XML Schema's.
757 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
758 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
759 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
760 explain record to YAZ CQL-to-PQF text config file.
764 Added 'timeout' setting for filter frontend_net which specifies the number
765 of seconds a session is idle before it is closed. Default timeout is
770 Database name in records returned set for virt_db/multi filters.
772 Filter session_shared now functional.
774 Log filter can be configured to write to a given file using 'filename'
775 element. Also information category can be specified with 'category'. If
776 filename is omitted, the log filter writes to stdout. See etc/config5.xml
781 Fixed compilation on Windows.
785 Added documentation for the hidenavailable option for the multi filter.
789 Fixed bug #573: Hide errors for individual servers. If the element
790 'hideunavailable' is given in the configuration, individual servers
791 being unavailable are hidden (unless all are unavailable).
793 Fixed bug #574: Database names are recognised case-sensitively.
795 Fixed bug #567: Fix up database name in Name-Plus-Record.
797 Fixed bug #568: Update win/makefile for VS 2005.
799 Fixed bug #569: Some options throws unknown exception.
803 More information about virtual hosts. The 'etc' directory is part of the
808 Build instructions for Windows. NMake makefile part of distribution tar.
814 Filters functional: auth_simple, backend_test, frontend_net, http_file,
815 log, multi, query_rewrite, template, virt_db, z3950_client.
817 Filters in development: session_shared.
819 Pseudo-filters: template, dl