3 sru_z3950: relay surrogate diagnostics.
7 zoom: Honor extraArgs, strip # in zurl.
9 multi: fix SEGV for scan. Reported by Rustam T. Usmanov.
11 zoom: url_recipe allow %{var[reg]} substitutions.
12 It's like ${var[reg]} but does URI component encoding as well.
16 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
17 non-keepalive HTTP sessions.
19 http_file: allow zero size files (bug fix)
21 Fix zoom schema: auth_url is optional
25 zoom: fix un-init memory (could result in SEGV at session close)
27 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
28 and may be used in filters as usual.
30 zoom: authentication via Torus lookup
31 Enabled by new configuration setting: auth_url . If this is defined,
32 the zoom module will contact Torus for auth/IP lookup and that will
33 define realm to be used in session.
37 virt_db: Fix database name - first character we removed by mistake.
38 Bug introduced in 1.3.40.
42 virt_db: Don't use "unix path" as database for Unix sockets.
46 z3950_client: Don't tamper with / in zurl - fixes problems
47 using Unix sockets for backends.
49 session_shared: fix integer overflow problem with hit count.
51 session_shared: avoid long usage of cached queries.
53 zoom: New database argument , torus_url to set URL of Torus
58 Fixes for 'metaproxy reload' for RPM/Debian packages.
60 zoom: Allow rpn2cql conversion to be augmented with a properties file.
61 Element rpn2cql can be specified per-target for the zoom filter.
63 log: New category "line" which is a single-line log message with
64 most important parts of a HTTP/Z39.50 request/response.
68 frontend_net: add facility to report live statistics about response
69 times and current thread usage. The report is an XML document
70 and is triggered for a specific URL path. This is set by <stat-req>
71 in the configuration of frontend_net. By default this report is
72 disabled (same as empty value for <stat-req>).
74 Fix reload problem in init.d script for RPM/Debian.
75 The '/etc/init.d/metaproxy reload' in some cases would stop but not
76 start metaproxy - effectively stopping the service.
78 Don't display start log message when config testing (-t).
80 zoom: avoid CCL message limit of 1K in ZOOM filter.
84 metaproxy init script reacts to reload which does graceful stop +
85 start and is used by logrorate script.
89 Fixes for Windows compilation.
91 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
92 existing sessions running but terminate the monitor process that is
93 used in keepalive mode.
95 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
96 before. Consistent with 'metaproxy stop' message.
98 zoom: document zoom's proxy_timeout
100 z3950_client: fixup addinfo for init response
102 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
103 "Access to specified database denied" is returned, but only if init
104 response from backend does not carry diagnostics already.
106 multi: relays user info for first rejected target. The other-information
107 field for init response for first rejected target is in common init
108 response. This ensures that some backend init diagnostics are returned to
111 --- 1.3.34 2012/04/25
113 frontend_log: extend logging (when message is given in config).
115 --- 1.3.33 2012/04/25
117 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
119 --- 1.3.32 2012/04/24
121 sru_z3950 filter passes through incoming Z39.50 requests again. Was
122 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
124 --- 1.3.31 2012/04/24
126 zoom: fixes for retry/proxy failover logic. More logging.
128 --- 1.3.30 2012/04/23
130 zoom: return addinfo="proxy failure" for proxy failures. This also
131 changes the scheme for dealing with proxies a bit. zoom now always
132 do proxy check, even if there's no failover. Fortunately, that's not
135 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
136 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
137 generic. We don't know why the init would fail; IP, user, block IP, etc.
138 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
140 zoom: guess if invalid SRU response was an auth failure
142 session_shared: disable session retry by default . Can be enabled by
143 restart="true" in resultset section.
145 --- 1.3.29 2012/04/18
147 zoom: may read cf-proxy's config settings.
148 This reduces manual configuration of the content proxy server host.
149 The ZOOM module will use the old style session.proxyhost if "server"
150 is given (deprecated) and use the new style proxyhost/session if
151 "config_file" is in use.
153 frontend_net: remove incoming requests that can not be handled
154 Requests in queue for filter frontend_net are removed if client
155 closes connection for the session and request is not yet handled.
157 sru_z3950: serialize requests. This is to ensure that pipelined
158 HTTP requests are handled properly.
160 --- 1.3.28 2012/04/04
162 New class, wrbuf, that wraps YAZ' WRBUF.
164 --- 1.3.27 2012/03/30
166 Metaproxy daemon is now running as user "metaproxy". This user is
167 managed by package maintainer scripts. The user information is stored
168 in /etc/metaproxy/metaproxy.user .
170 --- 1.3.26 2012/03/20
172 New filter, sort, that allows sorting of XML records via Z39.50
175 Filter record_transform: USEMarcon support. For example:
176 <retrieval syntax="usmarc">
177 <backend syntax="unimarc" name="F">
178 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
182 Filter multi: empty route pattern uses route as default.
184 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
185 may use the shorter notation
186 <target route="z3950.indexdata.com"/>
188 Filter query_rewrite: use config path to locate XSLT.
190 Filter frontend_net: log statistics.
191 If a custom message element in frontend_net configuration it makes
192 the frontend_net filter produce a log entry whenever an operation
193 is completed. The log is always written using yaz_log with the
194 custom message given, the package ID (session ID) , the time
195 the operation has been active (end-to-end) , the threads currently
196 active/total and the size of the request input/output queues.
198 query_rewrite: charset conversion of query terms.
199 This is an optional feature. Enabled by element <charset> in
200 configuration with attribute 'from' and 'to' that specifies
201 from/to encodings. The default 'from' encoding is UTF-8.
203 Filter record_transform: honor piggyback searches.
205 Filter zoom: re-connect when database is reused.
206 Re-connect is necessary if a connection is lost or a timeout occurs.
207 If not, we'll be seeing zero hits, when we shouldn't.
209 --- 1.3.25 2012/02/29
211 zoom: Change scheme for dealing with content proxy URLs. The module
212 now has its own common XSL transform that is enabled by record_xsl
213 attribute in the configuration. This XSL gets parameter cproxyhost
214 that holds the host for the content proxy session . The genearted-url
215 is created only if urlRecipe is enabled. In previous version default
216 value of urlRecipe was ${md-electronic-url}; it is now empty and
217 disabled by default. Also generated-url no longer includes the content
218 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
221 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
222 connections. Default value is 40 (seconds).
224 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
225 "Malformed query" for syntax errors and related ones; throw
226 Bib-1: 3 "Unsupported search" for everything else. Details from
227 the CCL parser is provided as additional-info.
229 multi: new setting hideerrors that makes multi only relay diagnostics
230 to a client if all backends fail.
232 --- 1.3.24 2012/02/23
234 zoom: empty ccl_map field-mappings disables CCL map.
236 zoom: fix Explain search that could return error if session was
239 --- 1.3.23 2012/02/10
241 zoom: returns Explain records for database IR-Explain---1. The
242 target profile records are converted to Explain records via XSLT.
244 session_shared: make error recovery configurable. Whether a search
245 is restarted on errors or not, is configurable by attribute "restart"
246 in element "resultset" in configuration.
248 session_shared: only relay init for first request. session_shared, for
249 each backend class, now only relays first init request (rather than all).
250 The module only needs to save init response info once. This avoids the
251 need to check for session max.
253 --- 1.3.22 2012/02/02
255 zoom: fix memory leaks.
257 session_shared: maximum number of sessons is configurable. Default
258 value is 100. Result-sets for backends without named result sets are
259 only re-used if databases is identical for a search. This is under the
260 assumption that performance may suffer for those backends when
261 changing the database for each search.
263 multi: combines diagnostics from all backends. All diagnostics from
264 backends are combined into multiple non-surrogate diagnostics; rather
265 than just one diagnostic from first backend.
267 --- 1.3.21 2011/12/27
269 zoom: relay realm to cproxy parameter file.
271 Configuration: Allow filter collection element inside route. This
272 makes it possible to include multiple filters at once.
274 zoom: nocproxy also disables urlRecipe.
276 --- 1.3.20 2011/12/21
278 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
279 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
280 90: "Unsupported direction value".
282 zoom: honor database argument nocproxy. This disables creating a content
283 connector session (for non-CF targets, usually) and also relays nocproxy
284 as database argument to a CF target.
286 --- 1.3.19 2011/12/16
288 zoom: Multiple proxy hosts may be given for proxy rich database
289 parameter. List is comma separated.
291 http_file: decodes URI paths properly. Does not return 404: not found
292 if no prefix are matches. Instead packages are passed on.
294 --- 1.3.18 2011/12/08
296 zoom: content-{user,password,proxy} are passed on to content proxy
297 system and takes precedence over user,password,proxy .
299 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
300 with a log element including log material from children filters. At
301 this point, only the zoom filter uses this log facility. It will
302 eventually be used by other filters as well. In particular it might be
303 useful for this feature to track all filters in used during a search.
305 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
306 and queries as they are manipulated are logged.
308 zoom: extend addinfo with native diagnostics. Diagnostics as received
309 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
310 diagnostics. This indicates both a backend diagnostic and the original
313 zoom: default urlRecipe value is ${md-electronic-url}
315 zoom: target profile setting sruVersion is recognized.
317 --- 1.3.17 2011/11/17
319 zoom: log target profile record fetched (AKA Torus).
321 --- 1.3.16 2011/11/17
323 Change target profile parameter CfSubDb to CfSubDB.
325 --- 1.3.15 2011/11/12
327 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
328 makes sense to the zoom module itself).
330 --- 1.3.14 2011/11/11
332 zoom: realm may be given as part of database.
334 --- 1.3.13 2011/10/26
336 Fix Origin class assigment method; was removd by mistake in 1.3.12.
338 --- 1.3.12 2011/10/26
340 zoom: database args x-name=value are passed through to backend database.
342 SRU filter: user may specify session ID that is passed to log entries
343 that follows. It is specified by using x-session-id in the SRU arguments.
345 zoom: fix null pointer reference which would occur for bad url parameter
346 inside "torus" or if url was not given.
348 --- 1.3.11 2011/09/09
349 Fix bug in filter session_shared where sessions would not expire
350 properly (session ttl). This in turn could make the target close the
351 connection before expected and session_shared would return diagnostic
352 2: system temporarily available.
354 --- 1.3.10 2011/09/09
356 zoom: new target profile setting: sortmap_field. If sortmap_field is given
357 the field is mapped to the value for the sortmap. Values not matching
358 sortmap_field are passed verbatim.
360 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
361 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
362 depending on whether RPN or CQL is actually sent to the target.
366 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
368 zoom: For content proxy authentication is stored in param name
369 "auth", instead of "authentication".
373 zoom: relay schema in SRU mode. Previously recordSchema was not affected
378 zoom: new target profile element literalTransform that holds XSLT
379 (encoded as string) for target. Only if present and non-zero length it is
380 considered present. This takes precedence over transform.
382 Don't rely on trang anymore for Git checkout builds. Configuration in etc
383 will only be properly validated if trang is available. From now on only
384 relax NC files are bundled with the source dist.
386 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
387 component was not detected when it should be.
391 z3950_client: mark non-surrogate diagnostics from backend.
393 zoom: a proxy may be specified for HTTP fetch of target profiles.
397 Honor piggyback. Makes some SRU targets behave that insist on
398 maximumRecords > 0, but also increases performance.
402 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
403 file was not update for libdir/metaproxy4 in version 1.3.2.
407 Change location of Metaproxy modules from libdir/metaproxy to
408 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
409 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
411 New facility to dump APDUs from zoom filter. Enabled by
412 <log apdu="true"/> in the zoom filter configuation.
414 zoom filter bug fix: SRU diagnostics received from backend was
415 not properly converted to Bib-1 diagnostics.
417 Package metaproxy depends on libmetaproxy4, same version.
421 zoom: fix a bug WRT passing authentication parameters to backends.
425 Fixes for windows Makefile.
427 --- 1.2.10 2011/07/25
429 Change major version of metaproxy library from 3 to 4. This in turn
430 makes new package names for Debian and RPM.
434 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
437 zoom: configurable element sets for record transforms.
439 zoom: the target profile based transform is specified by element_transform
440 in element torus of of the ZOOM filter configuration ; default value
441 is "pz2". Target profile based retrieval is specified by element_raw
442 in configuration. It will perform same steps, but omit the XSL transform.
443 Default value is "raw".
445 zoom: element set is omitted if not set in profile. But only if pz2
446 transform is in effect. Previously the default element set was to "F".
448 zoom: For non-CF targets database arguments are parsed. User may supply
449 db,user=myuser&password=mypass for non-CF targets. These values override
450 what's given the authentication from the target profile.
452 session_shared: fix reference to freed memory. Would occur if a search
453 response had non-surrogate diagnostics.
457 Route may be given for each port in frontend_net.
461 Documentation for zoom filter. Local target profiles may be specified.
463 Fixes for zoom filter.
467 First version with zoom filter.
471 Filter z3950_client may be configured to always send a close APDU
472 to backend target when connection/session is closed. This will only
473 happen if close APDU is not already sent. Enabled by configuration
474 for z3950_client (force_close).
476 Filter virt_db and multi: relay close APDU.
478 Filter virt_db and multi: relay init size parameters
479 preferredMessageSize and maximumRecordSize.
481 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
485 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
487 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
488 as determined by configure.
490 RPM: Release includes 'indexdata' name. Use indexdata in release name so
491 this package can be distinguished from other vendors.
495 Fix filter multi: relay idAuthentication parameters.
499 Add metaproxy-config for returning compiler flags, libraries.
503 Fix --with-boost=PREFIX .
507 session_shared: fix use of maintenance thread.
509 Introduce 'start' method for filters and routers. It gets called after
510 configure and after fork, but before processing. This changes API -
511 from libmetaproxy2 to libmetaproxy3.
515 session_shared: ensure backend session is closed if init rejected
518 z3950_client: fix NULL ptr reference that could occur if two clients
519 connected concurrently and if max-sockets was in effect.
523 Fix bug 3497 - Metaproxy unstable while stopping.
525 Fix bug 3495 - SEGV in SRU filter.
529 Filter multi throws diagnostic 'Present Out of Range' when
530 appropriate - rather than returning 0 records.
532 Filter virt_db: fix bad result reuse. Could happen if a result
533 was overriden and a backend did not supported named result sets.
537 Filter log: category access logs diagnostics even if searchStatus
538 or presentStatus is 'success'.
542 The SRU to Z39.50 filter does repeated Z39.50 present requests
543 to fetch all records. Needed when a Z39.50 server returns partial
544 results (due to message size limits).
548 Metaproxy now kills all child processes that are spawned by
549 modules (in case of fork, exec).
553 Debian package now installs /etc/metaproxy/metaproxy.xml which
554 includes all XML files /etc/metaproxy/filters-enabled .
555 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
559 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
560 development package to facilitate 3rd party Metaproxy modules.
562 --- 1.0.23 2010/01/04
564 Filter virt_db: Close backend filter session when Init rejected is received
565 from it (in which case it's not really closed yet). This will ensure we don't
566 run out of resources such as FDs in this case.
568 sru_z3950 filter: Accept any database (including those not listed).
570 --- 1.0.22 2009/12/03
572 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
573 later which means YAZ 3.0.47 or later.
575 --- 1.0.20 2009/11/19
577 For filter virt_db, the database is a glob pattern and the virtual
578 database sections are consulted in the order given.
580 --- 1.0.19 2009/07/08
582 For filter multi, the target (for routing) may be given as a glob-pattern.
584 More documentation for filters virt_db and multi.
586 Update schema to allow for no database in sru_z3950 filter.
588 --- 1.0.18 2009/06/30
590 Added limit filter to put sleep (penalty) for heavy use.
592 Filter frontend_net may be configured to limit the number of new connections
593 from same IP to some value (connect-max).
595 Fixed the load_balance filter.
597 --- 1.0.17 2009/06/16
599 Fix path for metaproxy executable for Debian init.d script.
601 --- 1.0.16 2009/06/10
603 SRU to Z39.50 filter honors x-username and x-password. If only
604 x-username is given that translates to open authentication (Z39.50v2). If
605 both x-username and x-password is present that translates to idPass
606 authentication (Z39.50v3).
608 New facility to change current working directory (-w).
610 Update to upstream skeleton of init.d script. Should fix bug #2619.
612 Filter session_shared now caches records (used to only cache connections
615 Filter session_shared now invalidates a Z39.50 session if a server
616 returns -1 hits. This facility was also part of yazproxy and gets around
617 a bug in Voyager-based Z39.50 servers.
619 --- 1.0.15 2008/11/18
621 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
623 --- 1.0.14 2008/06/09
625 Fixed the value of SRU record schema in searchRetrieve response. It was set
626 to a fixed value of "dc" before.
628 Serialize identical SRU requests. This is useful if HTTP client software
629 fires identical requests against metaproxy.
631 Allow Z39.50 target to be specified for SRU requests by using SRU extra
632 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
633 avoid static configuration. This facility is handled by the sru_z3950 module
634 and the z3950_client module.
636 Allow maximum number of sockets to be used for a Z39.50 client by the
637 use of SRU extra parameter x-max-sockets. This facility is handled by the
638 sru_z3950 module and the z3950_client module.
640 --- 1.0.13.1 2008/02/29
642 Simplified check for Boost libraries.
644 --- 1.0.13 2008/02/29
646 First Debian package.
648 The sru_z9350 filter now recognizes SRU parameter z-target as being
649 a ZURL of the form host/database .
651 Mergetype may be specified for filter 'multi'.
653 --- 1.0.12 2007/09/19
655 Fixed problem in Makefile WRT library specifictions. This could produce
656 linker errors (when they should not happen).
658 Fixed bug #1341: MetaProxy returning different results. Problem was that
659 fix-up of record database did not normalize the database name.
661 Documentation updates for Windows compilation.
663 --- 1.0.11 2007/06/14
665 Fixed problem with logfile being truncated.
667 --- 1.0.10 2007/05/23
669 Fixed bug #1136: Access rights not enforced.
671 Extension for log module. The log category 'access' logs more details.
672 New category 'user-access' added which is simlar to 'access' but adds
673 the Z39.50 user as for all entries in a session.
677 Added support for configurable default/force target/vhost for module Z39.50
682 Implemented filter, session_shared, which optimizes usage of Z39.50
683 sessions and result sets.
685 New filter, record_transform, which converts MARC/XML records.
687 New filter, sru_z3950, which converts SRU to Z39.50 packages.
689 New filter, load_balance, in development.
691 New filter, zeerex_xplain.
693 XML framework for config files started.
695 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
696 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
697 XML config files are checked against RNG and XML Schema's.
699 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
700 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
701 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
702 explain record to YAZ CQL-to-PQF text config file.
706 Added 'timeout' setting for filter frontend_net which specifies the number
707 of seconds a session is idle before it is closed. Default timeout is
712 Database name in records returned set for virt_db/multi filters.
714 Filter session_shared now functional.
716 Log filter can be configured to write to a given file using 'filename'
717 element. Also information category can be specified with 'category'. If
718 filename is omitted, the log filter writes to stdout. See etc/config5.xml
723 Fixed compilation on Windows.
727 Added documentation for the hidenavailable option for the multi filter.
731 Fixed bug #573: Hide errors for individual servers. If the element
732 'hideunavailable' is given in the configuration, individual servers
733 being unavailable are hidden (unless all are unavailable).
735 Fixed bug #574: Database names are recognised case-sensitively.
737 Fixed bug #567: Fix up database name in Name-Plus-Record.
739 Fixed bug #568: Update win/makefile for VS 2005.
741 Fixed bug #569: Some options throws unknown exception.
745 More information about virtual hosts. The 'etc' directory is part of the
750 Build instructions for Windows. NMake makefile part of distribution tar.
756 Filters functional: auth_simple, backend_test, frontend_net, http_file,
757 log, multi, query_rewrite, template, virt_db, z3950_client.
759 Filters in development: session_shared.
761 Pseudo-filters: template, dl