3 virt_db: Fix database name - first character we removed by mistake.
4 Bug introduced in 1.3.40.
8 virt_db: Don't use "unix path" as database for Unix sockets.
12 z3950_client: Don't tamper with / in zurl - fixes problems
13 using Unix sockets for backends.
15 session_shared: fix integer overflow problem with hit count.
17 session_shared: avoid long usage of cached queries.
19 zoom: New database argument , torus_url to set URL of Torus
24 Fixes for 'metaproxy reload' for RPM/Debian packages.
26 zoom: Allow rpn2cql conversion to be augmented with a properties file.
27 Element rpn2cql can be specified per-target for the zoom filter.
29 log: New category "line" which is a single-line log message with
30 most important parts of a HTTP/Z39.50 request/response.
34 frontend_net: add facility to report live statistics about response
35 times and current thread usage. The report is an XML document
36 and is triggered for a specific URL path. This is set by <stat-req>
37 in the configuration of frontend_net. By default this report is
38 disabled (same as empty value for <stat-req>).
40 Fix reload problem in init.d script for RPM/Debian.
41 The '/etc/init.d/metaproxy reload' in some cases would stop but not
42 start metaproxy - effectively stopping the service.
44 Don't display start log message when config testing (-t).
46 zoom: avoid CCL message limit of 1K in ZOOM filter.
50 metaproxy init script reacts to reload which does graceful stop +
51 start and is used by logrorate script.
55 Fixes for Windows compilation.
57 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
58 existing sessions running but terminate the monitor process that is
59 used in keepalive mode.
61 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
62 before. Consistent with 'metaproxy stop' message.
64 zoom: document zoom's proxy_timeout
66 z3950_client: fixup addinfo for init response
68 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
69 "Access to specified database denied" is returned, but only if init
70 response from backend does not carry diagnostics already.
72 multi: relays user info for first rejected target. The other-information
73 field for init response for first rejected target is in common init
74 response. This ensures that some backend init diagnostics are returned to
79 frontend_log: extend logging (when message is given in config).
83 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
87 sru_z3950 filter passes through incoming Z39.50 requests again. Was
88 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
92 zoom: fixes for retry/proxy failover logic. More logging.
96 zoom: return addinfo="proxy failure" for proxy failures. This also
97 changes the scheme for dealing with proxies a bit. zoom now always
98 do proxy check, even if there's no failover. Fortunately, that's not
101 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
102 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
103 generic. We don't know why the init would fail; IP, user, block IP, etc.
104 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
106 zoom: guess if invalid SRU response was an auth failure
108 session_shared: disable session retry by default . Can be enabled by
109 restart="true" in resultset section.
111 --- 1.3.29 2012/04/18
113 zoom: may read cf-proxy's config settings.
114 This reduces manual configuration of the content proxy server host.
115 The ZOOM module will use the old style session.proxyhost if "server"
116 is given (deprecated) and use the new style proxyhost/session if
117 "config_file" is in use.
119 frontend_net: remove incoming requests that can not be handled
120 Requests in queue for filter frontend_net are removed if client
121 closes connection for the session and request is not yet handled.
123 sru_z3950: serialize requests. This is to ensure that pipelined
124 HTTP requests are handled properly.
126 --- 1.3.28 2012/04/04
128 New class, wrbuf, that wraps YAZ' WRBUF.
130 --- 1.3.27 2012/03/30
132 Metaproxy daemon is now running as user "metaproxy". This user is
133 managed by package maintainer scripts. The user information is stored
134 in /etc/metaproxy/metaproxy.user .
136 --- 1.3.26 2012/03/20
138 New filter, sort, that allows sorting of XML records via Z39.50
141 Filter record_transform: USEMarcon support. For example:
142 <retrieval syntax="usmarc">
143 <backend syntax="unimarc" name="F">
144 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
148 Filter multi: empty route pattern uses route as default.
150 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
151 may use the shorter notation
152 <target route="z3950.indexdata.com"/>
154 Filter query_rewrite: use config path to locate XSLT.
156 Filter frontend_net: log statistics.
157 If a custom message element in frontend_net configuration it makes
158 the frontend_net filter produce a log entry whenever an operation
159 is completed. The log is always written using yaz_log with the
160 custom message given, the package ID (session ID) , the time
161 the operation has been active (end-to-end) , the threads currently
162 active/total and the size of the request input/output queues.
164 query_rewrite: charset conversion of query terms.
165 This is an optional feature. Enabled by element <charset> in
166 configuration with attribute 'from' and 'to' that specifies
167 from/to encodings. The default 'from' encoding is UTF-8.
169 Filter record_transform: honor piggyback searches.
171 Filter zoom: re-connect when database is reused.
172 Re-connect is necessary if a connection is lost or a timeout occurs.
173 If not, we'll be seeing zero hits, when we shouldn't.
175 --- 1.3.25 2012/02/29
177 zoom: Change scheme for dealing with content proxy URLs. The module
178 now has its own common XSL transform that is enabled by record_xsl
179 attribute in the configuration. This XSL gets parameter cproxyhost
180 that holds the host for the content proxy session . The genearted-url
181 is created only if urlRecipe is enabled. In previous version default
182 value of urlRecipe was ${md-electronic-url}; it is now empty and
183 disabled by default. Also generated-url no longer includes the content
184 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
187 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
188 connections. Default value is 40 (seconds).
190 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
191 "Malformed query" for syntax errors and related ones; throw
192 Bib-1: 3 "Unsupported search" for everything else. Details from
193 the CCL parser is provided as additional-info.
195 multi: new setting hideerrors that makes multi only relay diagnostics
196 to a client if all backends fail.
198 --- 1.3.24 2012/02/23
200 zoom: empty ccl_map field-mappings disables CCL map.
202 zoom: fix Explain search that could return error if session was
205 --- 1.3.23 2012/02/10
207 zoom: returns Explain records for database IR-Explain---1. The
208 target profile records are converted to Explain records via XSLT.
210 session_shared: make error recovery configurable. Whether a search
211 is restarted on errors or not, is configurable by attribute "restart"
212 in element "resultset" in configuration.
214 session_shared: only relay init for first request. session_shared, for
215 each backend class, now only relays first init request (rather than all).
216 The module only needs to save init response info once. This avoids the
217 need to check for session max.
219 --- 1.3.22 2012/02/02
221 zoom: fix memory leaks.
223 session_shared: maximum number of sessons is configurable. Default
224 value is 100. Result-sets for backends without named result sets are
225 only re-used if databases is identical for a search. This is under the
226 assumption that performance may suffer for those backends when
227 changing the database for each search.
229 multi: combines diagnostics from all backends. All diagnostics from
230 backends are combined into multiple non-surrogate diagnostics; rather
231 than just one diagnostic from first backend.
233 --- 1.3.21 2011/12/27
235 zoom: relay realm to cproxy parameter file.
237 Configuration: Allow filter collection element inside route. This
238 makes it possible to include multiple filters at once.
240 zoom: nocproxy also disables urlRecipe.
242 --- 1.3.20 2011/12/21
244 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
245 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
246 90: "Unsupported direction value".
248 zoom: honor database argument nocproxy. This disables creating a content
249 connector session (for non-CF targets, usually) and also relays nocproxy
250 as database argument to a CF target.
252 --- 1.3.19 2011/12/16
254 zoom: Multiple proxy hosts may be given for proxy rich database
255 parameter. List is comma separated.
257 http_file: decodes URI paths properly. Does not return 404: not found
258 if no prefix are matches. Instead packages are passed on.
260 --- 1.3.18 2011/12/08
262 zoom: content-{user,password,proxy} are passed on to content proxy
263 system and takes precedence over user,password,proxy .
265 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
266 with a log element including log material from children filters. At
267 this point, only the zoom filter uses this log facility. It will
268 eventually be used by other filters as well. In particular it might be
269 useful for this feature to track all filters in used during a search.
271 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
272 and queries as they are manipulated are logged.
274 zoom: extend addinfo with native diagnostics. Diagnostics as received
275 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
276 diagnostics. This indicates both a backend diagnostic and the original
279 zoom: default urlRecipe value is ${md-electronic-url}
281 zoom: target profile setting sruVersion is recognized.
283 --- 1.3.17 2011/11/17
285 zoom: log target profile record fetched (AKA Torus).
287 --- 1.3.16 2011/11/17
289 Change target profile parameter CfSubDb to CfSubDB.
291 --- 1.3.15 2011/11/12
293 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
294 makes sense to the zoom module itself).
296 --- 1.3.14 2011/11/11
298 zoom: realm may be given as part of database.
300 --- 1.3.13 2011/10/26
302 Fix Origin class assigment method; was removd by mistake in 1.3.12.
304 --- 1.3.12 2011/10/26
306 zoom: database args x-name=value are passed through to backend database.
308 SRU filter: user may specify session ID that is passed to log entries
309 that follows. It is specified by using x-session-id in the SRU arguments.
311 zoom: fix null pointer reference which would occur for bad url parameter
312 inside "torus" or if url was not given.
314 --- 1.3.11 2011/09/09
315 Fix bug in filter session_shared where sessions would not expire
316 properly (session ttl). This in turn could make the target close the
317 connection before expected and session_shared would return diagnostic
318 2: system temporarily available.
320 --- 1.3.10 2011/09/09
322 zoom: new target profile setting: sortmap_field. If sortmap_field is given
323 the field is mapped to the value for the sortmap. Values not matching
324 sortmap_field are passed verbatim.
326 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
327 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
328 depending on whether RPN or CQL is actually sent to the target.
332 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
334 zoom: For content proxy authentication is stored in param name
335 "auth", instead of "authentication".
339 zoom: relay schema in SRU mode. Previously recordSchema was not affected
344 zoom: new target profile element literalTransform that holds XSLT
345 (encoded as string) for target. Only if present and non-zero length it is
346 considered present. This takes precedence over transform.
348 Don't rely on trang anymore for Git checkout builds. Configuration in etc
349 will only be properly validated if trang is available. From now on only
350 relax NC files are bundled with the source dist.
352 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
353 component was not detected when it should be.
357 z3950_client: mark non-surrogate diagnostics from backend.
359 zoom: a proxy may be specified for HTTP fetch of target profiles.
363 Honor piggyback. Makes some SRU targets behave that insist on
364 maximumRecords > 0, but also increases performance.
368 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
369 file was not update for libdir/metaproxy4 in version 1.3.2.
373 Change location of Metaproxy modules from libdir/metaproxy to
374 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
375 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
377 New facility to dump APDUs from zoom filter. Enabled by
378 <log apdu="true"/> in the zoom filter configuation.
380 zoom filter bug fix: SRU diagnostics received from backend was
381 not properly converted to Bib-1 diagnostics.
383 Package metaproxy depends on libmetaproxy4, same version.
387 zoom: fix a bug WRT passing authentication parameters to backends.
391 Fixes for windows Makefile.
393 --- 1.2.10 2011/07/25
395 Change major version of metaproxy library from 3 to 4. This in turn
396 makes new package names for Debian and RPM.
400 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
403 zoom: configurable element sets for record transforms.
405 zoom: the target profile based transform is specified by element_transform
406 in element torus of of the ZOOM filter configuration ; default value
407 is "pz2". Target profile based retrieval is specified by element_raw
408 in configuration. It will perform same steps, but omit the XSL transform.
409 Default value is "raw".
411 zoom: element set is omitted if not set in profile. But only if pz2
412 transform is in effect. Previously the default element set was to "F".
414 zoom: For non-CF targets database arguments are parsed. User may supply
415 db,user=myuser&password=mypass for non-CF targets. These values override
416 what's given the authentication from the target profile.
418 session_shared: fix reference to freed memory. Would occur if a search
419 response had non-surrogate diagnostics.
423 Route may be given for each port in frontend_net.
427 Documentation for zoom filter. Local target profiles may be specified.
429 Fixes for zoom filter.
433 First version with zoom filter.
437 Filter z3950_client may be configured to always send a close APDU
438 to backend target when connection/session is closed. This will only
439 happen if close APDU is not already sent. Enabled by configuration
440 for z3950_client (force_close).
442 Filter virt_db and multi: relay close APDU.
444 Filter virt_db and multi: relay init size parameters
445 preferredMessageSize and maximumRecordSize.
447 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
451 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
453 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
454 as determined by configure.
456 RPM: Release includes 'indexdata' name. Use indexdata in release name so
457 this package can be distinguished from other vendors.
461 Fix filter multi: relay idAuthentication parameters.
465 Add metaproxy-config for returning compiler flags, libraries.
469 Fix --with-boost=PREFIX .
473 session_shared: fix use of maintenance thread.
475 Introduce 'start' method for filters and routers. It gets called after
476 configure and after fork, but before processing. This changes API -
477 from libmetaproxy2 to libmetaproxy3.
481 session_shared: ensure backend session is closed if init rejected
484 z3950_client: fix NULL ptr reference that could occur if two clients
485 connected concurrently and if max-sockets was in effect.
489 Fix bug 3497 - Metaproxy unstable while stopping.
491 Fix bug 3495 - SEGV in SRU filter.
495 Filter multi throws diagnostic 'Present Out of Range' when
496 appropriate - rather than returning 0 records.
498 Filter virt_db: fix bad result reuse. Could happen if a result
499 was overriden and a backend did not supported named result sets.
503 Filter log: category access logs diagnostics even if searchStatus
504 or presentStatus is 'success'.
508 The SRU to Z39.50 filter does repeated Z39.50 present requests
509 to fetch all records. Needed when a Z39.50 server returns partial
510 results (due to message size limits).
514 Metaproxy now kills all child processes that are spawned by
515 modules (in case of fork, exec).
519 Debian package now installs /etc/metaproxy/metaproxy.xml which
520 includes all XML files /etc/metaproxy/filters-enabled .
521 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
525 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
526 development package to facilitate 3rd party Metaproxy modules.
528 --- 1.0.23 2010/01/04
530 Filter virt_db: Close backend filter session when Init rejected is received
531 from it (in which case it's not really closed yet). This will ensure we don't
532 run out of resources such as FDs in this case.
534 sru_z3950 filter: Accept any database (including those not listed).
536 --- 1.0.22 2009/12/03
538 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
539 later which means YAZ 3.0.47 or later.
541 --- 1.0.20 2009/11/19
543 For filter virt_db, the database is a glob pattern and the virtual
544 database sections are consulted in the order given.
546 --- 1.0.19 2009/07/08
548 For filter multi, the target (for routing) may be given as a glob-pattern.
550 More documentation for filters virt_db and multi.
552 Update schema to allow for no database in sru_z3950 filter.
554 --- 1.0.18 2009/06/30
556 Added limit filter to put sleep (penalty) for heavy use.
558 Filter frontend_net may be configured to limit the number of new connections
559 from same IP to some value (connect-max).
561 Fixed the load_balance filter.
563 --- 1.0.17 2009/06/16
565 Fix path for metaproxy executable for Debian init.d script.
567 --- 1.0.16 2009/06/10
569 SRU to Z39.50 filter honors x-username and x-password. If only
570 x-username is given that translates to open authentication (Z39.50v2). If
571 both x-username and x-password is present that translates to idPass
572 authentication (Z39.50v3).
574 New facility to change current working directory (-w).
576 Update to upstream skeleton of init.d script. Should fix bug #2619.
578 Filter session_shared now caches records (used to only cache connections
581 Filter session_shared now invalidates a Z39.50 session if a server
582 returns -1 hits. This facility was also part of yazproxy and gets around
583 a bug in Voyager-based Z39.50 servers.
585 --- 1.0.15 2008/11/18
587 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
589 --- 1.0.14 2008/06/09
591 Fixed the value of SRU record schema in searchRetrieve response. It was set
592 to a fixed value of "dc" before.
594 Serialize identical SRU requests. This is useful if HTTP client software
595 fires identical requests against metaproxy.
597 Allow Z39.50 target to be specified for SRU requests by using SRU extra
598 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
599 avoid static configuration. This facility is handled by the sru_z3950 module
600 and the z3950_client module.
602 Allow maximum number of sockets to be used for a Z39.50 client by the
603 use of SRU extra parameter x-max-sockets. This facility is handled by the
604 sru_z3950 module and the z3950_client module.
606 --- 1.0.13.1 2008/02/29
608 Simplified check for Boost libraries.
610 --- 1.0.13 2008/02/29
612 First Debian package.
614 The sru_z9350 filter now recognizes SRU parameter z-target as being
615 a ZURL of the form host/database .
617 Mergetype may be specified for filter 'multi'.
619 --- 1.0.12 2007/09/19
621 Fixed problem in Makefile WRT library specifictions. This could produce
622 linker errors (when they should not happen).
624 Fixed bug #1341: MetaProxy returning different results. Problem was that
625 fix-up of record database did not normalize the database name.
627 Documentation updates for Windows compilation.
629 --- 1.0.11 2007/06/14
631 Fixed problem with logfile being truncated.
633 --- 1.0.10 2007/05/23
635 Fixed bug #1136: Access rights not enforced.
637 Extension for log module. The log category 'access' logs more details.
638 New category 'user-access' added which is simlar to 'access' but adds
639 the Z39.50 user as for all entries in a session.
643 Added support for configurable default/force target/vhost for module Z39.50
648 Implemented filter, session_shared, which optimizes usage of Z39.50
649 sessions and result sets.
651 New filter, record_transform, which converts MARC/XML records.
653 New filter, sru_z3950, which converts SRU to Z39.50 packages.
655 New filter, load_balance, in development.
657 New filter, zeerex_xplain.
659 XML framework for config files started.
661 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
662 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
663 XML config files are checked against RNG and XML Schema's.
665 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
666 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
667 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
668 explain record to YAZ CQL-to-PQF text config file.
672 Added 'timeout' setting for filter frontend_net which specifies the number
673 of seconds a session is idle before it is closed. Default timeout is
678 Database name in records returned set for virt_db/multi filters.
680 Filter session_shared now functional.
682 Log filter can be configured to write to a given file using 'filename'
683 element. Also information category can be specified with 'category'. If
684 filename is omitted, the log filter writes to stdout. See etc/config5.xml
689 Fixed compilation on Windows.
693 Added documentation for the hidenavailable option for the multi filter.
697 Fixed bug #573: Hide errors for individual servers. If the element
698 'hideunavailable' is given in the configuration, individual servers
699 being unavailable are hidden (unless all are unavailable).
701 Fixed bug #574: Database names are recognised case-sensitively.
703 Fixed bug #567: Fix up database name in Name-Plus-Record.
705 Fixed bug #568: Update win/makefile for VS 2005.
707 Fixed bug #569: Some options throws unknown exception.
711 More information about virtual hosts. The 'etc' directory is part of the
716 Build instructions for Windows. NMake makefile part of distribution tar.
722 Filters functional: auth_simple, backend_test, frontend_net, http_file,
723 log, multi, query_rewrite, template, virt_db, z3950_client.
725 Filters in development: session_shared.
727 Pseudo-filters: template, dl