3 z3950_client: Don't tamper with / in zurl - fixes problems
4 using Unix sockets for backends.
6 session_shared: fix integer overflow problem with hit count.
8 session_shared: avoid long usage of cached queries.
10 zoom: New database argument , torus_url to set URL of Torus
15 Fixes for 'metaproxy reload' for RPM/Debian packages.
17 zoom: Allow rpn2cql conversion to be augmented with a properties file.
18 Element rpn2cql can be specified per-target for the zoom filter.
20 log: New category "line" which is a single-line log message with
21 most important parts of a HTTP/Z39.50 request/response.
25 frontend_net: add facility to report live statistics about response
26 times and current thread usage. The report is an XML document
27 and is triggered for a specific URL path. This is set by <stat-req>
28 in the configuration of frontend_net. By default this report is
29 disabled (same as empty value for <stat-req>).
31 Fix reload problem in init.d script for RPM/Debian.
32 The '/etc/init.d/metaproxy reload' in some cases would stop but not
33 start metaproxy - effectively stopping the service.
35 Don't display start log message when config testing (-t).
37 zoom: avoid CCL message limit of 1K in ZOOM filter.
41 metaproxy init script reacts to reload which does graceful stop +
42 start and is used by logrorate script.
46 Fixes for Windows compilation.
48 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
49 existing sessions running but terminate the monitor process that is
50 used in keepalive mode.
52 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
53 before. Consistent with 'metaproxy stop' message.
55 zoom: document zoom's proxy_timeout
57 z3950_client: fixup addinfo for init response
59 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
60 "Access to specified database denied" is returned, but only if init
61 response from backend does not carry diagnostics already.
63 multi: relays user info for first rejected target. The other-information
64 field for init response for first rejected target is in common init
65 response. This ensures that some backend init diagnostics are returned to
70 frontend_log: extend logging (when message is given in config).
74 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
78 sru_z3950 filter passes through incoming Z39.50 requests again. Was
79 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
83 zoom: fixes for retry/proxy failover logic. More logging.
87 zoom: return addinfo="proxy failure" for proxy failures. This also
88 changes the scheme for dealing with proxies a bit. zoom now always
89 do proxy check, even if there's no failover. Fortunately, that's not
92 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
93 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
94 generic. We don't know why the init would fail; IP, user, block IP, etc.
95 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
97 zoom: guess if invalid SRU response was an auth failure
99 session_shared: disable session retry by default . Can be enabled by
100 restart="true" in resultset section.
102 --- 1.3.29 2012/04/18
104 zoom: may read cf-proxy's config settings.
105 This reduces manual configuration of the content proxy server host.
106 The ZOOM module will use the old style session.proxyhost if "server"
107 is given (deprecated) and use the new style proxyhost/session if
108 "config_file" is in use.
110 frontend_net: remove incoming requests that can not be handled
111 Requests in queue for filter frontend_net are removed if client
112 closes connection for the session and request is not yet handled.
114 sru_z3950: serialize requests. This is to ensure that pipelined
115 HTTP requests are handled properly.
117 --- 1.3.28 2012/04/04
119 New class, wrbuf, that wraps YAZ' WRBUF.
121 --- 1.3.27 2012/03/30
123 Metaproxy daemon is now running as user "metaproxy". This user is
124 managed by package maintainer scripts. The user information is stored
125 in /etc/metaproxy/metaproxy.user .
127 --- 1.3.26 2012/03/20
129 New filter, sort, that allows sorting of XML records via Z39.50
132 Filter record_transform: USEMarcon support. For example:
133 <retrieval syntax="usmarc">
134 <backend syntax="unimarc" name="F">
135 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
139 Filter multi: empty route pattern uses route as default.
141 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
142 may use the shorter notation
143 <target route="z3950.indexdata.com"/>
145 Filter query_rewrite: use config path to locate XSLT.
147 Filter frontend_net: log statistics.
148 If a custom message element in frontend_net configuration it makes
149 the frontend_net filter produce a log entry whenever an operation
150 is completed. The log is always written using yaz_log with the
151 custom message given, the package ID (session ID) , the time
152 the operation has been active (end-to-end) , the threads currently
153 active/total and the size of the request input/output queues.
155 query_rewrite: charset conversion of query terms.
156 This is an optional feature. Enabled by element <charset> in
157 configuration with attribute 'from' and 'to' that specifies
158 from/to encodings. The default 'from' encoding is UTF-8.
160 Filter record_transform: honor piggyback searches.
162 Filter zoom: re-connect when database is reused.
163 Re-connect is necessary if a connection is lost or a timeout occurs.
164 If not, we'll be seeing zero hits, when we shouldn't.
166 --- 1.3.25 2012/02/29
168 zoom: Change scheme for dealing with content proxy URLs. The module
169 now has its own common XSL transform that is enabled by record_xsl
170 attribute in the configuration. This XSL gets parameter cproxyhost
171 that holds the host for the content proxy session . The genearted-url
172 is created only if urlRecipe is enabled. In previous version default
173 value of urlRecipe was ${md-electronic-url}; it is now empty and
174 disabled by default. Also generated-url no longer includes the content
175 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
178 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
179 connections. Default value is 40 (seconds).
181 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
182 "Malformed query" for syntax errors and related ones; throw
183 Bib-1: 3 "Unsupported search" for everything else. Details from
184 the CCL parser is provided as additional-info.
186 multi: new setting hideerrors that makes multi only relay diagnostics
187 to a client if all backends fail.
189 --- 1.3.24 2012/02/23
191 zoom: empty ccl_map field-mappings disables CCL map.
193 zoom: fix Explain search that could return error if session was
196 --- 1.3.23 2012/02/10
198 zoom: returns Explain records for database IR-Explain---1. The
199 target profile records are converted to Explain records via XSLT.
201 session_shared: make error recovery configurable. Whether a search
202 is restarted on errors or not, is configurable by attribute "restart"
203 in element "resultset" in configuration.
205 session_shared: only relay init for first request. session_shared, for
206 each backend class, now only relays first init request (rather than all).
207 The module only needs to save init response info once. This avoids the
208 need to check for session max.
210 --- 1.3.22 2012/02/02
212 zoom: fix memory leaks.
214 session_shared: maximum number of sessons is configurable. Default
215 value is 100. Result-sets for backends without named result sets are
216 only re-used if databases is identical for a search. This is under the
217 assumption that performance may suffer for those backends when
218 changing the database for each search.
220 multi: combines diagnostics from all backends. All diagnostics from
221 backends are combined into multiple non-surrogate diagnostics; rather
222 than just one diagnostic from first backend.
224 --- 1.3.21 2011/12/27
226 zoom: relay realm to cproxy parameter file.
228 Configuration: Allow filter collection element inside route. This
229 makes it possible to include multiple filters at once.
231 zoom: nocproxy also disables urlRecipe.
233 --- 1.3.20 2011/12/21
235 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
236 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
237 90: "Unsupported direction value".
239 zoom: honor database argument nocproxy. This disables creating a content
240 connector session (for non-CF targets, usually) and also relays nocproxy
241 as database argument to a CF target.
243 --- 1.3.19 2011/12/16
245 zoom: Multiple proxy hosts may be given for proxy rich database
246 parameter. List is comma separated.
248 http_file: decodes URI paths properly. Does not return 404: not found
249 if no prefix are matches. Instead packages are passed on.
251 --- 1.3.18 2011/12/08
253 zoom: content-{user,password,proxy} are passed on to content proxy
254 system and takes precedence over user,password,proxy .
256 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
257 with a log element including log material from children filters. At
258 this point, only the zoom filter uses this log facility. It will
259 eventually be used by other filters as well. In particular it might be
260 useful for this feature to track all filters in used during a search.
262 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
263 and queries as they are manipulated are logged.
265 zoom: extend addinfo with native diagnostics. Diagnostics as received
266 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
267 diagnostics. This indicates both a backend diagnostic and the original
270 zoom: default urlRecipe value is ${md-electronic-url}
272 zoom: target profile setting sruVersion is recognized.
274 --- 1.3.17 2011/11/17
276 zoom: log target profile record fetched (AKA Torus).
278 --- 1.3.16 2011/11/17
280 Change target profile parameter CfSubDb to CfSubDB.
282 --- 1.3.15 2011/11/12
284 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
285 makes sense to the zoom module itself).
287 --- 1.3.14 2011/11/11
289 zoom: realm may be given as part of database.
291 --- 1.3.13 2011/10/26
293 Fix Origin class assigment method; was removd by mistake in 1.3.12.
295 --- 1.3.12 2011/10/26
297 zoom: database args x-name=value are passed through to backend database.
299 SRU filter: user may specify session ID that is passed to log entries
300 that follows. It is specified by using x-session-id in the SRU arguments.
302 zoom: fix null pointer reference which would occur for bad url parameter
303 inside "torus" or if url was not given.
305 --- 1.3.11 2011/09/09
306 Fix bug in filter session_shared where sessions would not expire
307 properly (session ttl). This in turn could make the target close the
308 connection before expected and session_shared would return diagnostic
309 2: system temporarily available.
311 --- 1.3.10 2011/09/09
313 zoom: new target profile setting: sortmap_field. If sortmap_field is given
314 the field is mapped to the value for the sortmap. Values not matching
315 sortmap_field are passed verbatim.
317 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
318 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
319 depending on whether RPN or CQL is actually sent to the target.
323 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
325 zoom: For content proxy authentication is stored in param name
326 "auth", instead of "authentication".
330 zoom: relay schema in SRU mode. Previously recordSchema was not affected
335 zoom: new target profile element literalTransform that holds XSLT
336 (encoded as string) for target. Only if present and non-zero length it is
337 considered present. This takes precedence over transform.
339 Don't rely on trang anymore for Git checkout builds. Configuration in etc
340 will only be properly validated if trang is available. From now on only
341 relax NC files are bundled with the source dist.
343 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
344 component was not detected when it should be.
348 z3950_client: mark non-surrogate diagnostics from backend.
350 zoom: a proxy may be specified for HTTP fetch of target profiles.
354 Honor piggyback. Makes some SRU targets behave that insist on
355 maximumRecords > 0, but also increases performance.
359 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
360 file was not update for libdir/metaproxy4 in version 1.3.2.
364 Change location of Metaproxy modules from libdir/metaproxy to
365 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
366 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
368 New facility to dump APDUs from zoom filter. Enabled by
369 <log apdu="true"/> in the zoom filter configuation.
371 zoom filter bug fix: SRU diagnostics received from backend was
372 not properly converted to Bib-1 diagnostics.
374 Package metaproxy depends on libmetaproxy4, same version.
378 zoom: fix a bug WRT passing authentication parameters to backends.
382 Fixes for windows Makefile.
384 --- 1.2.10 2011/07/25
386 Change major version of metaproxy library from 3 to 4. This in turn
387 makes new package names for Debian and RPM.
391 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
394 zoom: configurable element sets for record transforms.
396 zoom: the target profile based transform is specified by element_transform
397 in element torus of of the ZOOM filter configuration ; default value
398 is "pz2". Target profile based retrieval is specified by element_raw
399 in configuration. It will perform same steps, but omit the XSL transform.
400 Default value is "raw".
402 zoom: element set is omitted if not set in profile. But only if pz2
403 transform is in effect. Previously the default element set was to "F".
405 zoom: For non-CF targets database arguments are parsed. User may supply
406 db,user=myuser&password=mypass for non-CF targets. These values override
407 what's given the authentication from the target profile.
409 session_shared: fix reference to freed memory. Would occur if a search
410 response had non-surrogate diagnostics.
414 Route may be given for each port in frontend_net.
418 Documentation for zoom filter. Local target profiles may be specified.
420 Fixes for zoom filter.
424 First version with zoom filter.
428 Filter z3950_client may be configured to always send a close APDU
429 to backend target when connection/session is closed. This will only
430 happen if close APDU is not already sent. Enabled by configuration
431 for z3950_client (force_close).
433 Filter virt_db and multi: relay close APDU.
435 Filter virt_db and multi: relay init size parameters
436 preferredMessageSize and maximumRecordSize.
438 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
442 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
444 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
445 as determined by configure.
447 RPM: Release includes 'indexdata' name. Use indexdata in release name so
448 this package can be distinguished from other vendors.
452 Fix filter multi: relay idAuthentication parameters.
456 Add metaproxy-config for returning compiler flags, libraries.
460 Fix --with-boost=PREFIX .
464 session_shared: fix use of maintenance thread.
466 Introduce 'start' method for filters and routers. It gets called after
467 configure and after fork, but before processing. This changes API -
468 from libmetaproxy2 to libmetaproxy3.
472 session_shared: ensure backend session is closed if init rejected
475 z3950_client: fix NULL ptr reference that could occur if two clients
476 connected concurrently and if max-sockets was in effect.
480 Fix bug 3497 - Metaproxy unstable while stopping.
482 Fix bug 3495 - SEGV in SRU filter.
486 Filter multi throws diagnostic 'Present Out of Range' when
487 appropriate - rather than returning 0 records.
489 Filter virt_db: fix bad result reuse. Could happen if a result
490 was overriden and a backend did not supported named result sets.
494 Filter log: category access logs diagnostics even if searchStatus
495 or presentStatus is 'success'.
499 The SRU to Z39.50 filter does repeated Z39.50 present requests
500 to fetch all records. Needed when a Z39.50 server returns partial
501 results (due to message size limits).
505 Metaproxy now kills all child processes that are spawned by
506 modules (in case of fork, exec).
510 Debian package now installs /etc/metaproxy/metaproxy.xml which
511 includes all XML files /etc/metaproxy/filters-enabled .
512 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
516 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
517 development package to facilitate 3rd party Metaproxy modules.
519 --- 1.0.23 2010/01/04
521 Filter virt_db: Close backend filter session when Init rejected is received
522 from it (in which case it's not really closed yet). This will ensure we don't
523 run out of resources such as FDs in this case.
525 sru_z3950 filter: Accept any database (including those not listed).
527 --- 1.0.22 2009/12/03
529 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
530 later which means YAZ 3.0.47 or later.
532 --- 1.0.20 2009/11/19
534 For filter virt_db, the database is a glob pattern and the virtual
535 database sections are consulted in the order given.
537 --- 1.0.19 2009/07/08
539 For filter multi, the target (for routing) may be given as a glob-pattern.
541 More documentation for filters virt_db and multi.
543 Update schema to allow for no database in sru_z3950 filter.
545 --- 1.0.18 2009/06/30
547 Added limit filter to put sleep (penalty) for heavy use.
549 Filter frontend_net may be configured to limit the number of new connections
550 from same IP to some value (connect-max).
552 Fixed the load_balance filter.
554 --- 1.0.17 2009/06/16
556 Fix path for metaproxy executable for Debian init.d script.
558 --- 1.0.16 2009/06/10
560 SRU to Z39.50 filter honors x-username and x-password. If only
561 x-username is given that translates to open authentication (Z39.50v2). If
562 both x-username and x-password is present that translates to idPass
563 authentication (Z39.50v3).
565 New facility to change current working directory (-w).
567 Update to upstream skeleton of init.d script. Should fix bug #2619.
569 Filter session_shared now caches records (used to only cache connections
572 Filter session_shared now invalidates a Z39.50 session if a server
573 returns -1 hits. This facility was also part of yazproxy and gets around
574 a bug in Voyager-based Z39.50 servers.
576 --- 1.0.15 2008/11/18
578 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
580 --- 1.0.14 2008/06/09
582 Fixed the value of SRU record schema in searchRetrieve response. It was set
583 to a fixed value of "dc" before.
585 Serialize identical SRU requests. This is useful if HTTP client software
586 fires identical requests against metaproxy.
588 Allow Z39.50 target to be specified for SRU requests by using SRU extra
589 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
590 avoid static configuration. This facility is handled by the sru_z3950 module
591 and the z3950_client module.
593 Allow maximum number of sockets to be used for a Z39.50 client by the
594 use of SRU extra parameter x-max-sockets. This facility is handled by the
595 sru_z3950 module and the z3950_client module.
597 --- 1.0.13.1 2008/02/29
599 Simplified check for Boost libraries.
601 --- 1.0.13 2008/02/29
603 First Debian package.
605 The sru_z9350 filter now recognizes SRU parameter z-target as being
606 a ZURL of the form host/database .
608 Mergetype may be specified for filter 'multi'.
610 --- 1.0.12 2007/09/19
612 Fixed problem in Makefile WRT library specifictions. This could produce
613 linker errors (when they should not happen).
615 Fixed bug #1341: MetaProxy returning different results. Problem was that
616 fix-up of record database did not normalize the database name.
618 Documentation updates for Windows compilation.
620 --- 1.0.11 2007/06/14
622 Fixed problem with logfile being truncated.
624 --- 1.0.10 2007/05/23
626 Fixed bug #1136: Access rights not enforced.
628 Extension for log module. The log category 'access' logs more details.
629 New category 'user-access' added which is simlar to 'access' but adds
630 the Z39.50 user as for all entries in a session.
634 Added support for configurable default/force target/vhost for module Z39.50
639 Implemented filter, session_shared, which optimizes usage of Z39.50
640 sessions and result sets.
642 New filter, record_transform, which converts MARC/XML records.
644 New filter, sru_z3950, which converts SRU to Z39.50 packages.
646 New filter, load_balance, in development.
648 New filter, zeerex_xplain.
650 XML framework for config files started.
652 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
653 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
654 XML config files are checked against RNG and XML Schema's.
656 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
657 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
658 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
659 explain record to YAZ CQL-to-PQF text config file.
663 Added 'timeout' setting for filter frontend_net which specifies the number
664 of seconds a session is idle before it is closed. Default timeout is
669 Database name in records returned set for virt_db/multi filters.
671 Filter session_shared now functional.
673 Log filter can be configured to write to a given file using 'filename'
674 element. Also information category can be specified with 'category'. If
675 filename is omitted, the log filter writes to stdout. See etc/config5.xml
680 Fixed compilation on Windows.
684 Added documentation for the hidenavailable option for the multi filter.
688 Fixed bug #573: Hide errors for individual servers. If the element
689 'hideunavailable' is given in the configuration, individual servers
690 being unavailable are hidden (unless all are unavailable).
692 Fixed bug #574: Database names are recognised case-sensitively.
694 Fixed bug #567: Fix up database name in Name-Plus-Record.
696 Fixed bug #568: Update win/makefile for VS 2005.
698 Fixed bug #569: Some options throws unknown exception.
702 More information about virtual hosts. The 'etc' directory is part of the
707 Build instructions for Windows. NMake makefile part of distribution tar.
713 Filters functional: auth_simple, backend_test, frontend_net, http_file,
714 log, multi, query_rewrite, template, virt_db, z3950_client.
716 Filters in development: session_shared.
718 Pseudo-filters: template, dl