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