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