3 For graceful stop (SIGUSR1), metaproxy will kill children processes.
5 Log when metaproxy is invoked in test mode (-t).
7 Log PID for each log message.
9 multi: combine both NSDs and multiple NSDs into one (diagnostics).
11 z3950_client: fixup multiple NSD's too. Like surrogate diagnostics,
12 a (backend=target) is appended for each diagnostic so that can be
13 determined the origin of error.
15 multi: hideerrors also in use for present response.
17 Solr example in zoom man page.
19 Fix typo in query_rewrite config example.
21 Log at least first non surrogate diagnostic. Instead of
22 "Z_Records_multipleNSD"
24 multi: Fix check for opt Records in present response. A SEGV could occur
25 if a target did not return records and no diagnostics.
29 Yet another fix for graceful stop.
33 sru_z3950: relay surrogate diagnostics.
37 zoom: Honor extraArgs, strip # in zurl.
39 multi: fix SEGV for scan. Reported by Rustam T. Usmanov.
41 zoom: url_recipe allow %{var[reg]} substitutions.
42 It's like ${var[reg]} but does URI component encoding as well.
46 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
47 non-keepalive HTTP sessions.
49 http_file: allow zero size files (bug fix)
51 Fix zoom schema: auth_url is optional
55 zoom: fix un-init memory (could result in SEGV at session close)
57 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
58 and may be used in filters as usual.
60 zoom: authentication via Torus lookup
61 Enabled by new configuration setting: auth_url . If this is defined,
62 the zoom module will contact Torus for auth/IP lookup and that will
63 define realm to be used in session.
67 virt_db: Fix database name - first character we removed by mistake.
68 Bug introduced in 1.3.40.
72 virt_db: Don't use "unix path" as database for Unix sockets.
76 z3950_client: Don't tamper with / in zurl - fixes problems
77 using Unix sockets for backends.
79 session_shared: fix integer overflow problem with hit count.
81 session_shared: avoid long usage of cached queries.
83 zoom: New database argument , torus_url to set URL of Torus
88 Fixes for 'metaproxy reload' for RPM/Debian packages.
90 zoom: Allow rpn2cql conversion to be augmented with a properties file.
91 Element rpn2cql can be specified per-target for the zoom filter.
93 log: New category "line" which is a single-line log message with
94 most important parts of a HTTP/Z39.50 request/response.
98 frontend_net: add facility to report live statistics about response
99 times and current thread usage. The report is an XML document
100 and is triggered for a specific URL path. This is set by <stat-req>
101 in the configuration of frontend_net. By default this report is
102 disabled (same as empty value for <stat-req>).
104 Fix reload problem in init.d script for RPM/Debian.
105 The '/etc/init.d/metaproxy reload' in some cases would stop but not
106 start metaproxy - effectively stopping the service.
108 Don't display start log message when config testing (-t).
110 zoom: avoid CCL message limit of 1K in ZOOM filter.
112 --- 1.3.36 2012/05/10
114 metaproxy init script reacts to reload which does graceful stop +
115 start and is used by logrorate script.
117 --- 1.3.35 2012/05/09
119 Fixes for Windows compilation.
121 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
122 existing sessions running but terminate the monitor process that is
123 used in keepalive mode.
125 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
126 before. Consistent with 'metaproxy stop' message.
128 zoom: document zoom's proxy_timeout
130 z3950_client: fixup addinfo for init response
132 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
133 "Access to specified database denied" is returned, but only if init
134 response from backend does not carry diagnostics already.
136 multi: relays user info for first rejected target. The other-information
137 field for init response for first rejected target is in common init
138 response. This ensures that some backend init diagnostics are returned to
141 --- 1.3.34 2012/04/25
143 frontend_log: extend logging (when message is given in config).
145 --- 1.3.33 2012/04/25
147 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
149 --- 1.3.32 2012/04/24
151 sru_z3950 filter passes through incoming Z39.50 requests again. Was
152 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
154 --- 1.3.31 2012/04/24
156 zoom: fixes for retry/proxy failover logic. More logging.
158 --- 1.3.30 2012/04/23
160 zoom: return addinfo="proxy failure" for proxy failures. This also
161 changes the scheme for dealing with proxies a bit. zoom now always
162 do proxy check, even if there's no failover. Fortunately, that's not
165 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
166 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
167 generic. We don't know why the init would fail; IP, user, block IP, etc.
168 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
170 zoom: guess if invalid SRU response was an auth failure
172 session_shared: disable session retry by default . Can be enabled by
173 restart="true" in resultset section.
175 --- 1.3.29 2012/04/18
177 zoom: may read cf-proxy's config settings.
178 This reduces manual configuration of the content proxy server host.
179 The ZOOM module will use the old style session.proxyhost if "server"
180 is given (deprecated) and use the new style proxyhost/session if
181 "config_file" is in use.
183 frontend_net: remove incoming requests that can not be handled
184 Requests in queue for filter frontend_net are removed if client
185 closes connection for the session and request is not yet handled.
187 sru_z3950: serialize requests. This is to ensure that pipelined
188 HTTP requests are handled properly.
190 --- 1.3.28 2012/04/04
192 New class, wrbuf, that wraps YAZ' WRBUF.
194 --- 1.3.27 2012/03/30
196 Metaproxy daemon is now running as user "metaproxy". This user is
197 managed by package maintainer scripts. The user information is stored
198 in /etc/metaproxy/metaproxy.user .
200 --- 1.3.26 2012/03/20
202 New filter, sort, that allows sorting of XML records via Z39.50
205 Filter record_transform: USEMarcon support. For example:
206 <retrieval syntax="usmarc">
207 <backend syntax="unimarc" name="F">
208 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
212 Filter multi: empty route pattern uses route as default.
214 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
215 may use the shorter notation
216 <target route="z3950.indexdata.com"/>
218 Filter query_rewrite: use config path to locate XSLT.
220 Filter frontend_net: log statistics.
221 If a custom message element in frontend_net configuration it makes
222 the frontend_net filter produce a log entry whenever an operation
223 is completed. The log is always written using yaz_log with the
224 custom message given, the package ID (session ID) , the time
225 the operation has been active (end-to-end) , the threads currently
226 active/total and the size of the request input/output queues.
228 query_rewrite: charset conversion of query terms.
229 This is an optional feature. Enabled by element <charset> in
230 configuration with attribute 'from' and 'to' that specifies
231 from/to encodings. The default 'from' encoding is UTF-8.
233 Filter record_transform: honor piggyback searches.
235 Filter zoom: re-connect when database is reused.
236 Re-connect is necessary if a connection is lost or a timeout occurs.
237 If not, we'll be seeing zero hits, when we shouldn't.
239 --- 1.3.25 2012/02/29
241 zoom: Change scheme for dealing with content proxy URLs. The module
242 now has its own common XSL transform that is enabled by record_xsl
243 attribute in the configuration. This XSL gets parameter cproxyhost
244 that holds the host for the content proxy session . The genearted-url
245 is created only if urlRecipe is enabled. In previous version default
246 value of urlRecipe was ${md-electronic-url}; it is now empty and
247 disabled by default. Also generated-url no longer includes the content
248 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
251 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
252 connections. Default value is 40 (seconds).
254 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
255 "Malformed query" for syntax errors and related ones; throw
256 Bib-1: 3 "Unsupported search" for everything else. Details from
257 the CCL parser is provided as additional-info.
259 multi: new setting hideerrors that makes multi only relay diagnostics
260 to a client if all backends fail.
262 --- 1.3.24 2012/02/23
264 zoom: empty ccl_map field-mappings disables CCL map.
266 zoom: fix Explain search that could return error if session was
269 --- 1.3.23 2012/02/10
271 zoom: returns Explain records for database IR-Explain---1. The
272 target profile records are converted to Explain records via XSLT.
274 session_shared: make error recovery configurable. Whether a search
275 is restarted on errors or not, is configurable by attribute "restart"
276 in element "resultset" in configuration.
278 session_shared: only relay init for first request. session_shared, for
279 each backend class, now only relays first init request (rather than all).
280 The module only needs to save init response info once. This avoids the
281 need to check for session max.
283 --- 1.3.22 2012/02/02
285 zoom: fix memory leaks.
287 session_shared: maximum number of sessons is configurable. Default
288 value is 100. Result-sets for backends without named result sets are
289 only re-used if databases is identical for a search. This is under the
290 assumption that performance may suffer for those backends when
291 changing the database for each search.
293 multi: combines diagnostics from all backends. All diagnostics from
294 backends are combined into multiple non-surrogate diagnostics; rather
295 than just one diagnostic from first backend.
297 --- 1.3.21 2011/12/27
299 zoom: relay realm to cproxy parameter file.
301 Configuration: Allow filter collection element inside route. This
302 makes it possible to include multiple filters at once.
304 zoom: nocproxy also disables urlRecipe.
306 --- 1.3.20 2011/12/21
308 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
309 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
310 90: "Unsupported direction value".
312 zoom: honor database argument nocproxy. This disables creating a content
313 connector session (for non-CF targets, usually) and also relays nocproxy
314 as database argument to a CF target.
316 --- 1.3.19 2011/12/16
318 zoom: Multiple proxy hosts may be given for proxy rich database
319 parameter. List is comma separated.
321 http_file: decodes URI paths properly. Does not return 404: not found
322 if no prefix are matches. Instead packages are passed on.
324 --- 1.3.18 2011/12/08
326 zoom: content-{user,password,proxy} are passed on to content proxy
327 system and takes precedence over user,password,proxy .
329 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
330 with a log element including log material from children filters. At
331 this point, only the zoom filter uses this log facility. It will
332 eventually be used by other filters as well. In particular it might be
333 useful for this feature to track all filters in used during a search.
335 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
336 and queries as they are manipulated are logged.
338 zoom: extend addinfo with native diagnostics. Diagnostics as received
339 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
340 diagnostics. This indicates both a backend diagnostic and the original
343 zoom: default urlRecipe value is ${md-electronic-url}
345 zoom: target profile setting sruVersion is recognized.
347 --- 1.3.17 2011/11/17
349 zoom: log target profile record fetched (AKA Torus).
351 --- 1.3.16 2011/11/17
353 Change target profile parameter CfSubDb to CfSubDB.
355 --- 1.3.15 2011/11/12
357 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
358 makes sense to the zoom module itself).
360 --- 1.3.14 2011/11/11
362 zoom: realm may be given as part of database.
364 --- 1.3.13 2011/10/26
366 Fix Origin class assigment method; was removd by mistake in 1.3.12.
368 --- 1.3.12 2011/10/26
370 zoom: database args x-name=value are passed through to backend database.
372 SRU filter: user may specify session ID that is passed to log entries
373 that follows. It is specified by using x-session-id in the SRU arguments.
375 zoom: fix null pointer reference which would occur for bad url parameter
376 inside "torus" or if url was not given.
378 --- 1.3.11 2011/09/09
379 Fix bug in filter session_shared where sessions would not expire
380 properly (session ttl). This in turn could make the target close the
381 connection before expected and session_shared would return diagnostic
382 2: system temporarily available.
384 --- 1.3.10 2011/09/09
386 zoom: new target profile setting: sortmap_field. If sortmap_field is given
387 the field is mapped to the value for the sortmap. Values not matching
388 sortmap_field are passed verbatim.
390 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
391 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
392 depending on whether RPN or CQL is actually sent to the target.
396 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
398 zoom: For content proxy authentication is stored in param name
399 "auth", instead of "authentication".
403 zoom: relay schema in SRU mode. Previously recordSchema was not affected
408 zoom: new target profile element literalTransform that holds XSLT
409 (encoded as string) for target. Only if present and non-zero length it is
410 considered present. This takes precedence over transform.
412 Don't rely on trang anymore for Git checkout builds. Configuration in etc
413 will only be properly validated if trang is available. From now on only
414 relax NC files are bundled with the source dist.
416 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
417 component was not detected when it should be.
421 z3950_client: mark non-surrogate diagnostics from backend.
423 zoom: a proxy may be specified for HTTP fetch of target profiles.
427 Honor piggyback. Makes some SRU targets behave that insist on
428 maximumRecords > 0, but also increases performance.
432 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
433 file was not update for libdir/metaproxy4 in version 1.3.2.
437 Change location of Metaproxy modules from libdir/metaproxy to
438 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
439 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
441 New facility to dump APDUs from zoom filter. Enabled by
442 <log apdu="true"/> in the zoom filter configuation.
444 zoom filter bug fix: SRU diagnostics received from backend was
445 not properly converted to Bib-1 diagnostics.
447 Package metaproxy depends on libmetaproxy4, same version.
451 zoom: fix a bug WRT passing authentication parameters to backends.
455 Fixes for windows Makefile.
457 --- 1.2.10 2011/07/25
459 Change major version of metaproxy library from 3 to 4. This in turn
460 makes new package names for Debian and RPM.
464 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
467 zoom: configurable element sets for record transforms.
469 zoom: the target profile based transform is specified by element_transform
470 in element torus of of the ZOOM filter configuration ; default value
471 is "pz2". Target profile based retrieval is specified by element_raw
472 in configuration. It will perform same steps, but omit the XSL transform.
473 Default value is "raw".
475 zoom: element set is omitted if not set in profile. But only if pz2
476 transform is in effect. Previously the default element set was to "F".
478 zoom: For non-CF targets database arguments are parsed. User may supply
479 db,user=myuser&password=mypass for non-CF targets. These values override
480 what's given the authentication from the target profile.
482 session_shared: fix reference to freed memory. Would occur if a search
483 response had non-surrogate diagnostics.
487 Route may be given for each port in frontend_net.
491 Documentation for zoom filter. Local target profiles may be specified.
493 Fixes for zoom filter.
497 First version with zoom filter.
501 Filter z3950_client may be configured to always send a close APDU
502 to backend target when connection/session is closed. This will only
503 happen if close APDU is not already sent. Enabled by configuration
504 for z3950_client (force_close).
506 Filter virt_db and multi: relay close APDU.
508 Filter virt_db and multi: relay init size parameters
509 preferredMessageSize and maximumRecordSize.
511 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
515 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
517 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
518 as determined by configure.
520 RPM: Release includes 'indexdata' name. Use indexdata in release name so
521 this package can be distinguished from other vendors.
525 Fix filter multi: relay idAuthentication parameters.
529 Add metaproxy-config for returning compiler flags, libraries.
533 Fix --with-boost=PREFIX .
537 session_shared: fix use of maintenance thread.
539 Introduce 'start' method for filters and routers. It gets called after
540 configure and after fork, but before processing. This changes API -
541 from libmetaproxy2 to libmetaproxy3.
545 session_shared: ensure backend session is closed if init rejected
548 z3950_client: fix NULL ptr reference that could occur if two clients
549 connected concurrently and if max-sockets was in effect.
553 Fix bug 3497 - Metaproxy unstable while stopping.
555 Fix bug 3495 - SEGV in SRU filter.
559 Filter multi throws diagnostic 'Present Out of Range' when
560 appropriate - rather than returning 0 records.
562 Filter virt_db: fix bad result reuse. Could happen if a result
563 was overriden and a backend did not supported named result sets.
567 Filter log: category access logs diagnostics even if searchStatus
568 or presentStatus is 'success'.
572 The SRU to Z39.50 filter does repeated Z39.50 present requests
573 to fetch all records. Needed when a Z39.50 server returns partial
574 results (due to message size limits).
578 Metaproxy now kills all child processes that are spawned by
579 modules (in case of fork, exec).
583 Debian package now installs /etc/metaproxy/metaproxy.xml which
584 includes all XML files /etc/metaproxy/filters-enabled .
585 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
589 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
590 development package to facilitate 3rd party Metaproxy modules.
592 --- 1.0.23 2010/01/04
594 Filter virt_db: Close backend filter session when Init rejected is received
595 from it (in which case it's not really closed yet). This will ensure we don't
596 run out of resources such as FDs in this case.
598 sru_z3950 filter: Accept any database (including those not listed).
600 --- 1.0.22 2009/12/03
602 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
603 later which means YAZ 3.0.47 or later.
605 --- 1.0.20 2009/11/19
607 For filter virt_db, the database is a glob pattern and the virtual
608 database sections are consulted in the order given.
610 --- 1.0.19 2009/07/08
612 For filter multi, the target (for routing) may be given as a glob-pattern.
614 More documentation for filters virt_db and multi.
616 Update schema to allow for no database in sru_z3950 filter.
618 --- 1.0.18 2009/06/30
620 Added limit filter to put sleep (penalty) for heavy use.
622 Filter frontend_net may be configured to limit the number of new connections
623 from same IP to some value (connect-max).
625 Fixed the load_balance filter.
627 --- 1.0.17 2009/06/16
629 Fix path for metaproxy executable for Debian init.d script.
631 --- 1.0.16 2009/06/10
633 SRU to Z39.50 filter honors x-username and x-password. If only
634 x-username is given that translates to open authentication (Z39.50v2). If
635 both x-username and x-password is present that translates to idPass
636 authentication (Z39.50v3).
638 New facility to change current working directory (-w).
640 Update to upstream skeleton of init.d script. Should fix bug #2619.
642 Filter session_shared now caches records (used to only cache connections
645 Filter session_shared now invalidates a Z39.50 session if a server
646 returns -1 hits. This facility was also part of yazproxy and gets around
647 a bug in Voyager-based Z39.50 servers.
649 --- 1.0.15 2008/11/18
651 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
653 --- 1.0.14 2008/06/09
655 Fixed the value of SRU record schema in searchRetrieve response. It was set
656 to a fixed value of "dc" before.
658 Serialize identical SRU requests. This is useful if HTTP client software
659 fires identical requests against metaproxy.
661 Allow Z39.50 target to be specified for SRU requests by using SRU extra
662 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
663 avoid static configuration. This facility is handled by the sru_z3950 module
664 and the z3950_client module.
666 Allow maximum number of sockets to be used for a Z39.50 client by the
667 use of SRU extra parameter x-max-sockets. This facility is handled by the
668 sru_z3950 module and the z3950_client module.
670 --- 1.0.13.1 2008/02/29
672 Simplified check for Boost libraries.
674 --- 1.0.13 2008/02/29
676 First Debian package.
678 The sru_z9350 filter now recognizes SRU parameter z-target as being
679 a ZURL of the form host/database .
681 Mergetype may be specified for filter 'multi'.
683 --- 1.0.12 2007/09/19
685 Fixed problem in Makefile WRT library specifictions. This could produce
686 linker errors (when they should not happen).
688 Fixed bug #1341: MetaProxy returning different results. Problem was that
689 fix-up of record database did not normalize the database name.
691 Documentation updates for Windows compilation.
693 --- 1.0.11 2007/06/14
695 Fixed problem with logfile being truncated.
697 --- 1.0.10 2007/05/23
699 Fixed bug #1136: Access rights not enforced.
701 Extension for log module. The log category 'access' logs more details.
702 New category 'user-access' added which is simlar to 'access' but adds
703 the Z39.50 user as for all entries in a session.
707 Added support for configurable default/force target/vhost for module Z39.50
712 Implemented filter, session_shared, which optimizes usage of Z39.50
713 sessions and result sets.
715 New filter, record_transform, which converts MARC/XML records.
717 New filter, sru_z3950, which converts SRU to Z39.50 packages.
719 New filter, load_balance, in development.
721 New filter, zeerex_xplain.
723 XML framework for config files started.
725 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
726 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
727 XML config files are checked against RNG and XML Schema's.
729 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
730 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
731 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
732 explain record to YAZ CQL-to-PQF text config file.
736 Added 'timeout' setting for filter frontend_net which specifies the number
737 of seconds a session is idle before it is closed. Default timeout is
742 Database name in records returned set for virt_db/multi filters.
744 Filter session_shared now functional.
746 Log filter can be configured to write to a given file using 'filename'
747 element. Also information category can be specified with 'category'. If
748 filename is omitted, the log filter writes to stdout. See etc/config5.xml
753 Fixed compilation on Windows.
757 Added documentation for the hidenavailable option for the multi filter.
761 Fixed bug #573: Hide errors for individual servers. If the element
762 'hideunavailable' is given in the configuration, individual servers
763 being unavailable are hidden (unless all are unavailable).
765 Fixed bug #574: Database names are recognised case-sensitively.
767 Fixed bug #567: Fix up database name in Name-Plus-Record.
769 Fixed bug #568: Update win/makefile for VS 2005.
771 Fixed bug #569: Some options throws unknown exception.
775 More information about virtual hosts. The 'etc' directory is part of the
780 Build instructions for Windows. NMake makefile part of distribution tar.
786 Filters functional: auth_simple, backend_test, frontend_net, http_file,
787 log, multi, query_rewrite, template, virt_db, z3950_client.
789 Filters in development: session_shared.
791 Pseudo-filters: template, dl