3 zoom: only append http:// for SRU if not already given . Makes it
4 possible to use https-URLs.
6 Use yazpp 1.4 or later due to new ABI.
8 frontend_net: allow max package size to be specified. Controlled by
9 attribute 'max_recv_bytes' of element 'port'.
13 For most generated diagnostics by filters, typically temporary
14 system error, augment addinfo message with filter name.
16 Add support for CentOS 6 packages.
18 sru_z3950: interpret Z39.50 diagnostics part of Init Response.
20 Add man page for metaproxy-config.
24 zoom: new config element passthru. This defines an element set that is
25 passed verbatim to the backend in pz2 mode.
27 auth_simple: allow both idPass and open auth. Also fix SEGV that could
32 z3950_client: fix string handling for init diagnostics in the case where
35 query_rewrite: no charset conversion for error queries. Avoid performing
36 charset conversion for query conversion errors. The resulting Type-1
37 query is invalid in this case.
41 For graceful stop (SIGUSR1), metaproxy will kill children processes.
43 Log when metaproxy is invoked in test mode (-t).
45 Log PID for each log message.
47 multi: combine both NSDs and multiple NSDs into one (diagnostics).
49 z3950_client: fixup multiple NSD's too. Like surrogate diagnostics,
50 a (backend=target) is appended for each diagnostic so that can be
51 determined the origin of error.
53 multi: hideerrors also in use for present response.
55 Solr example in zoom man page.
57 Fix typo in query_rewrite config example.
59 Log at least first non surrogate diagnostic. Instead of
60 "Z_Records_multipleNSD"
62 multi: Fix check for opt Records in present response. A SEGV could occur
63 if a target did not return records and no diagnostics.
67 Yet another fix for graceful stop.
71 sru_z3950: relay surrogate diagnostics.
75 zoom: Honor extraArgs, strip # in zurl.
77 multi: fix SEGV for scan. Reported by Rustam T. Usmanov.
79 zoom: url_recipe allow %{var[reg]} substitutions.
80 It's like ${var[reg]} but does URI component encoding as well.
84 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
85 non-keepalive HTTP sessions.
87 http_file: allow zero size files (bug fix)
89 Fix zoom schema: auth_url is optional
93 zoom: fix un-init memory (could result in SEGV at session close)
95 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
96 and may be used in filters as usual.
98 zoom: authentication via Torus lookup
99 Enabled by new configuration setting: auth_url . If this is defined,
100 the zoom module will contact Torus for auth/IP lookup and that will
101 define realm to be used in session.
103 --- 1.3.41 2012/08/10
105 virt_db: Fix database name - first character we removed by mistake.
106 Bug introduced in 1.3.40.
108 --- 1.3.40 2012/08/06
110 virt_db: Don't use "unix path" as database for Unix sockets.
112 --- 1.3.39 2012/08/02
114 z3950_client: Don't tamper with / in zurl - fixes problems
115 using Unix sockets for backends.
117 session_shared: fix integer overflow problem with hit count.
119 session_shared: avoid long usage of cached queries.
121 zoom: New database argument , torus_url to set URL of Torus
122 record to be fetched.
124 --- 1.3.38 2012/07/04
126 Fixes for 'metaproxy reload' for RPM/Debian packages.
128 zoom: Allow rpn2cql conversion to be augmented with a properties file.
129 Element rpn2cql can be specified per-target for the zoom filter.
131 log: New category "line" which is a single-line log message with
132 most important parts of a HTTP/Z39.50 request/response.
134 --- 1.3.37 2012/06/01
136 frontend_net: add facility to report live statistics about response
137 times and current thread usage. The report is an XML document
138 and is triggered for a specific URL path. This is set by <stat-req>
139 in the configuration of frontend_net. By default this report is
140 disabled (same as empty value for <stat-req>).
142 Fix reload problem in init.d script for RPM/Debian.
143 The '/etc/init.d/metaproxy reload' in some cases would stop but not
144 start metaproxy - effectively stopping the service.
146 Don't display start log message when config testing (-t).
148 zoom: avoid CCL message limit of 1K in ZOOM filter.
150 --- 1.3.36 2012/05/10
152 metaproxy init script reacts to reload which does graceful stop +
153 start and is used by logrorate script.
155 --- 1.3.35 2012/05/09
157 Fixes for Windows compilation.
159 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
160 existing sessions running but terminate the monitor process that is
161 used in keepalive mode.
163 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
164 before. Consistent with 'metaproxy stop' message.
166 zoom: document zoom's proxy_timeout
168 z3950_client: fixup addinfo for init response
170 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
171 "Access to specified database denied" is returned, but only if init
172 response from backend does not carry diagnostics already.
174 multi: relays user info for first rejected target. The other-information
175 field for init response for first rejected target is in common init
176 response. This ensures that some backend init diagnostics are returned to
179 --- 1.3.34 2012/04/25
181 frontend_log: extend logging (when message is given in config).
183 --- 1.3.33 2012/04/25
185 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
187 --- 1.3.32 2012/04/24
189 sru_z3950 filter passes through incoming Z39.50 requests again. Was
190 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
192 --- 1.3.31 2012/04/24
194 zoom: fixes for retry/proxy failover logic. More logging.
196 --- 1.3.30 2012/04/23
198 zoom: return addinfo="proxy failure" for proxy failures. This also
199 changes the scheme for dealing with proxies a bit. zoom now always
200 do proxy check, even if there's no failover. Fortunately, that's not
203 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
204 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
205 generic. We don't know why the init would fail; IP, user, block IP, etc.
206 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
208 zoom: guess if invalid SRU response was an auth failure
210 session_shared: disable session retry by default . Can be enabled by
211 restart="true" in resultset section.
213 --- 1.3.29 2012/04/18
215 zoom: may read cf-proxy's config settings.
216 This reduces manual configuration of the content proxy server host.
217 The ZOOM module will use the old style session.proxyhost if "server"
218 is given (deprecated) and use the new style proxyhost/session if
219 "config_file" is in use.
221 frontend_net: remove incoming requests that can not be handled
222 Requests in queue for filter frontend_net are removed if client
223 closes connection for the session and request is not yet handled.
225 sru_z3950: serialize requests. This is to ensure that pipelined
226 HTTP requests are handled properly.
228 --- 1.3.28 2012/04/04
230 New class, wrbuf, that wraps YAZ' WRBUF.
232 --- 1.3.27 2012/03/30
234 Metaproxy daemon is now running as user "metaproxy". This user is
235 managed by package maintainer scripts. The user information is stored
236 in /etc/metaproxy/metaproxy.user .
238 --- 1.3.26 2012/03/20
240 New filter, sort, that allows sorting of XML records via Z39.50
243 Filter record_transform: USEMarcon support. For example:
244 <retrieval syntax="usmarc">
245 <backend syntax="unimarc" name="F">
246 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
250 Filter multi: empty route pattern uses route as default.
252 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
253 may use the shorter notation
254 <target route="z3950.indexdata.com"/>
256 Filter query_rewrite: use config path to locate XSLT.
258 Filter frontend_net: log statistics.
259 If a custom message element in frontend_net configuration it makes
260 the frontend_net filter produce a log entry whenever an operation
261 is completed. The log is always written using yaz_log with the
262 custom message given, the package ID (session ID) , the time
263 the operation has been active (end-to-end) , the threads currently
264 active/total and the size of the request input/output queues.
266 query_rewrite: charset conversion of query terms.
267 This is an optional feature. Enabled by element <charset> in
268 configuration with attribute 'from' and 'to' that specifies
269 from/to encodings. The default 'from' encoding is UTF-8.
271 Filter record_transform: honor piggyback searches.
273 Filter zoom: re-connect when database is reused.
274 Re-connect is necessary if a connection is lost or a timeout occurs.
275 If not, we'll be seeing zero hits, when we shouldn't.
277 --- 1.3.25 2012/02/29
279 zoom: Change scheme for dealing with content proxy URLs. The module
280 now has its own common XSL transform that is enabled by record_xsl
281 attribute in the configuration. This XSL gets parameter cproxyhost
282 that holds the host for the content proxy session . The genearted-url
283 is created only if urlRecipe is enabled. In previous version default
284 value of urlRecipe was ${md-electronic-url}; it is now empty and
285 disabled by default. Also generated-url no longer includes the content
286 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
289 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
290 connections. Default value is 40 (seconds).
292 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
293 "Malformed query" for syntax errors and related ones; throw
294 Bib-1: 3 "Unsupported search" for everything else. Details from
295 the CCL parser is provided as additional-info.
297 multi: new setting hideerrors that makes multi only relay diagnostics
298 to a client if all backends fail.
300 --- 1.3.24 2012/02/23
302 zoom: empty ccl_map field-mappings disables CCL map.
304 zoom: fix Explain search that could return error if session was
307 --- 1.3.23 2012/02/10
309 zoom: returns Explain records for database IR-Explain---1. The
310 target profile records are converted to Explain records via XSLT.
312 session_shared: make error recovery configurable. Whether a search
313 is restarted on errors or not, is configurable by attribute "restart"
314 in element "resultset" in configuration.
316 session_shared: only relay init for first request. session_shared, for
317 each backend class, now only relays first init request (rather than all).
318 The module only needs to save init response info once. This avoids the
319 need to check for session max.
321 --- 1.3.22 2012/02/02
323 zoom: fix memory leaks.
325 session_shared: maximum number of sessons is configurable. Default
326 value is 100. Result-sets for backends without named result sets are
327 only re-used if databases is identical for a search. This is under the
328 assumption that performance may suffer for those backends when
329 changing the database for each search.
331 multi: combines diagnostics from all backends. All diagnostics from
332 backends are combined into multiple non-surrogate diagnostics; rather
333 than just one diagnostic from first backend.
335 --- 1.3.21 2011/12/27
337 zoom: relay realm to cproxy parameter file.
339 Configuration: Allow filter collection element inside route. This
340 makes it possible to include multiple filters at once.
342 zoom: nocproxy also disables urlRecipe.
344 --- 1.3.20 2011/12/21
346 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
347 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
348 90: "Unsupported direction value".
350 zoom: honor database argument nocproxy. This disables creating a content
351 connector session (for non-CF targets, usually) and also relays nocproxy
352 as database argument to a CF target.
354 --- 1.3.19 2011/12/16
356 zoom: Multiple proxy hosts may be given for proxy rich database
357 parameter. List is comma separated.
359 http_file: decodes URI paths properly. Does not return 404: not found
360 if no prefix are matches. Instead packages are passed on.
362 --- 1.3.18 2011/12/08
364 zoom: content-{user,password,proxy} are passed on to content proxy
365 system and takes precedence over user,password,proxy .
367 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
368 with a log element including log material from children filters. At
369 this point, only the zoom filter uses this log facility. It will
370 eventually be used by other filters as well. In particular it might be
371 useful for this feature to track all filters in used during a search.
373 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
374 and queries as they are manipulated are logged.
376 zoom: extend addinfo with native diagnostics. Diagnostics as received
377 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
378 diagnostics. This indicates both a backend diagnostic and the original
381 zoom: default urlRecipe value is ${md-electronic-url}
383 zoom: target profile setting sruVersion is recognized.
385 --- 1.3.17 2011/11/17
387 zoom: log target profile record fetched (AKA Torus).
389 --- 1.3.16 2011/11/17
391 Change target profile parameter CfSubDb to CfSubDB.
393 --- 1.3.15 2011/11/12
395 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
396 makes sense to the zoom module itself).
398 --- 1.3.14 2011/11/11
400 zoom: realm may be given as part of database.
402 --- 1.3.13 2011/10/26
404 Fix Origin class assigment method; was removd by mistake in 1.3.12.
406 --- 1.3.12 2011/10/26
408 zoom: database args x-name=value are passed through to backend database.
410 SRU filter: user may specify session ID that is passed to log entries
411 that follows. It is specified by using x-session-id in the SRU arguments.
413 zoom: fix null pointer reference which would occur for bad url parameter
414 inside "torus" or if url was not given.
416 --- 1.3.11 2011/09/09
417 Fix bug in filter session_shared where sessions would not expire
418 properly (session ttl). This in turn could make the target close the
419 connection before expected and session_shared would return diagnostic
420 2: system temporarily available.
422 --- 1.3.10 2011/09/09
424 zoom: new target profile setting: sortmap_field. If sortmap_field is given
425 the field is mapped to the value for the sortmap. Values not matching
426 sortmap_field are passed verbatim.
428 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
429 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
430 depending on whether RPN or CQL is actually sent to the target.
434 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
436 zoom: For content proxy authentication is stored in param name
437 "auth", instead of "authentication".
441 zoom: relay schema in SRU mode. Previously recordSchema was not affected
446 zoom: new target profile element literalTransform that holds XSLT
447 (encoded as string) for target. Only if present and non-zero length it is
448 considered present. This takes precedence over transform.
450 Don't rely on trang anymore for Git checkout builds. Configuration in etc
451 will only be properly validated if trang is available. From now on only
452 relax NC files are bundled with the source dist.
454 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
455 component was not detected when it should be.
459 z3950_client: mark non-surrogate diagnostics from backend.
461 zoom: a proxy may be specified for HTTP fetch of target profiles.
465 Honor piggyback. Makes some SRU targets behave that insist on
466 maximumRecords > 0, but also increases performance.
470 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
471 file was not update for libdir/metaproxy4 in version 1.3.2.
475 Change location of Metaproxy modules from libdir/metaproxy to
476 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
477 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
479 New facility to dump APDUs from zoom filter. Enabled by
480 <log apdu="true"/> in the zoom filter configuation.
482 zoom filter bug fix: SRU diagnostics received from backend was
483 not properly converted to Bib-1 diagnostics.
485 Package metaproxy depends on libmetaproxy4, same version.
489 zoom: fix a bug WRT passing authentication parameters to backends.
493 Fixes for windows Makefile.
495 --- 1.2.10 2011/07/25
497 Change major version of metaproxy library from 3 to 4. This in turn
498 makes new package names for Debian and RPM.
502 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
505 zoom: configurable element sets for record transforms.
507 zoom: the target profile based transform is specified by element_transform
508 in element torus of of the ZOOM filter configuration ; default value
509 is "pz2". Target profile based retrieval is specified by element_raw
510 in configuration. It will perform same steps, but omit the XSL transform.
511 Default value is "raw".
513 zoom: element set is omitted if not set in profile. But only if pz2
514 transform is in effect. Previously the default element set was to "F".
516 zoom: For non-CF targets database arguments are parsed. User may supply
517 db,user=myuser&password=mypass for non-CF targets. These values override
518 what's given the authentication from the target profile.
520 session_shared: fix reference to freed memory. Would occur if a search
521 response had non-surrogate diagnostics.
525 Route may be given for each port in frontend_net.
529 Documentation for zoom filter. Local target profiles may be specified.
531 Fixes for zoom filter.
535 First version with zoom filter.
539 Filter z3950_client may be configured to always send a close APDU
540 to backend target when connection/session is closed. This will only
541 happen if close APDU is not already sent. Enabled by configuration
542 for z3950_client (force_close).
544 Filter virt_db and multi: relay close APDU.
546 Filter virt_db and multi: relay init size parameters
547 preferredMessageSize and maximumRecordSize.
549 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
553 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
555 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
556 as determined by configure.
558 RPM: Release includes 'indexdata' name. Use indexdata in release name so
559 this package can be distinguished from other vendors.
563 Fix filter multi: relay idAuthentication parameters.
567 Add metaproxy-config for returning compiler flags, libraries.
571 Fix --with-boost=PREFIX .
575 session_shared: fix use of maintenance thread.
577 Introduce 'start' method for filters and routers. It gets called after
578 configure and after fork, but before processing. This changes API -
579 from libmetaproxy2 to libmetaproxy3.
583 session_shared: ensure backend session is closed if init rejected
586 z3950_client: fix NULL ptr reference that could occur if two clients
587 connected concurrently and if max-sockets was in effect.
591 Fix bug 3497 - Metaproxy unstable while stopping.
593 Fix bug 3495 - SEGV in SRU filter.
597 Filter multi throws diagnostic 'Present Out of Range' when
598 appropriate - rather than returning 0 records.
600 Filter virt_db: fix bad result reuse. Could happen if a result
601 was overriden and a backend did not supported named result sets.
605 Filter log: category access logs diagnostics even if searchStatus
606 or presentStatus is 'success'.
610 The SRU to Z39.50 filter does repeated Z39.50 present requests
611 to fetch all records. Needed when a Z39.50 server returns partial
612 results (due to message size limits).
616 Metaproxy now kills all child processes that are spawned by
617 modules (in case of fork, exec).
621 Debian package now installs /etc/metaproxy/metaproxy.xml which
622 includes all XML files /etc/metaproxy/filters-enabled .
623 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
627 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
628 development package to facilitate 3rd party Metaproxy modules.
630 --- 1.0.23 2010/01/04
632 Filter virt_db: Close backend filter session when Init rejected is received
633 from it (in which case it's not really closed yet). This will ensure we don't
634 run out of resources such as FDs in this case.
636 sru_z3950 filter: Accept any database (including those not listed).
638 --- 1.0.22 2009/12/03
640 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
641 later which means YAZ 3.0.47 or later.
643 --- 1.0.20 2009/11/19
645 For filter virt_db, the database is a glob pattern and the virtual
646 database sections are consulted in the order given.
648 --- 1.0.19 2009/07/08
650 For filter multi, the target (for routing) may be given as a glob-pattern.
652 More documentation for filters virt_db and multi.
654 Update schema to allow for no database in sru_z3950 filter.
656 --- 1.0.18 2009/06/30
658 Added limit filter to put sleep (penalty) for heavy use.
660 Filter frontend_net may be configured to limit the number of new connections
661 from same IP to some value (connect-max).
663 Fixed the load_balance filter.
665 --- 1.0.17 2009/06/16
667 Fix path for metaproxy executable for Debian init.d script.
669 --- 1.0.16 2009/06/10
671 SRU to Z39.50 filter honors x-username and x-password. If only
672 x-username is given that translates to open authentication (Z39.50v2). If
673 both x-username and x-password is present that translates to idPass
674 authentication (Z39.50v3).
676 New facility to change current working directory (-w).
678 Update to upstream skeleton of init.d script. Should fix bug #2619.
680 Filter session_shared now caches records (used to only cache connections
683 Filter session_shared now invalidates a Z39.50 session if a server
684 returns -1 hits. This facility was also part of yazproxy and gets around
685 a bug in Voyager-based Z39.50 servers.
687 --- 1.0.15 2008/11/18
689 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
691 --- 1.0.14 2008/06/09
693 Fixed the value of SRU record schema in searchRetrieve response. It was set
694 to a fixed value of "dc" before.
696 Serialize identical SRU requests. This is useful if HTTP client software
697 fires identical requests against metaproxy.
699 Allow Z39.50 target to be specified for SRU requests by using SRU extra
700 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
701 avoid static configuration. This facility is handled by the sru_z3950 module
702 and the z3950_client module.
704 Allow maximum number of sockets to be used for a Z39.50 client by the
705 use of SRU extra parameter x-max-sockets. This facility is handled by the
706 sru_z3950 module and the z3950_client module.
708 --- 1.0.13.1 2008/02/29
710 Simplified check for Boost libraries.
712 --- 1.0.13 2008/02/29
714 First Debian package.
716 The sru_z9350 filter now recognizes SRU parameter z-target as being
717 a ZURL of the form host/database .
719 Mergetype may be specified for filter 'multi'.
721 --- 1.0.12 2007/09/19
723 Fixed problem in Makefile WRT library specifictions. This could produce
724 linker errors (when they should not happen).
726 Fixed bug #1341: MetaProxy returning different results. Problem was that
727 fix-up of record database did not normalize the database name.
729 Documentation updates for Windows compilation.
731 --- 1.0.11 2007/06/14
733 Fixed problem with logfile being truncated.
735 --- 1.0.10 2007/05/23
737 Fixed bug #1136: Access rights not enforced.
739 Extension for log module. The log category 'access' logs more details.
740 New category 'user-access' added which is simlar to 'access' but adds
741 the Z39.50 user as for all entries in a session.
745 Added support for configurable default/force target/vhost for module Z39.50
750 Implemented filter, session_shared, which optimizes usage of Z39.50
751 sessions and result sets.
753 New filter, record_transform, which converts MARC/XML records.
755 New filter, sru_z3950, which converts SRU to Z39.50 packages.
757 New filter, load_balance, in development.
759 New filter, zeerex_xplain.
761 XML framework for config files started.
763 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
764 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
765 XML config files are checked against RNG and XML Schema's.
767 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
768 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
769 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
770 explain record to YAZ CQL-to-PQF text config file.
774 Added 'timeout' setting for filter frontend_net which specifies the number
775 of seconds a session is idle before it is closed. Default timeout is
780 Database name in records returned set for virt_db/multi filters.
782 Filter session_shared now functional.
784 Log filter can be configured to write to a given file using 'filename'
785 element. Also information category can be specified with 'category'. If
786 filename is omitted, the log filter writes to stdout. See etc/config5.xml
791 Fixed compilation on Windows.
795 Added documentation for the hidenavailable option for the multi filter.
799 Fixed bug #573: Hide errors for individual servers. If the element
800 'hideunavailable' is given in the configuration, individual servers
801 being unavailable are hidden (unless all are unavailable).
803 Fixed bug #574: Database names are recognised case-sensitively.
805 Fixed bug #567: Fix up database name in Name-Plus-Record.
807 Fixed bug #568: Update win/makefile for VS 2005.
809 Fixed bug #569: Some options throws unknown exception.
813 More information about virtual hosts. The 'etc' directory is part of the
818 Build instructions for Windows. NMake makefile part of distribution tar.
824 Filters functional: auth_simple, backend_test, frontend_net, http_file,
825 log, multi, query_rewrite, template, virt_db, z3950_client.
827 Filters in development: session_shared.
829 Pseudo-filters: template, dl