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