3 zoom: Honor extraArgs, strip # in zurl.
5 multi: fix SEGV for scan. Reported by Rustam T. Usmanov.
7 zoom: url_recipe allow %{var[reg]} substitutions.
8 It's like ${var[reg]} but does URI component encoding as well.
12 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
13 non-keepalive HTTP sessions.
15 http_file: allow zero size files (bug fix)
17 Fix zoom schema: auth_url is optional
21 zoom: fix un-init memory (could result in SEGV at session close)
23 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
24 and may be used in filters as usual.
26 zoom: authentication via Torus lookup
27 Enabled by new configuration setting: auth_url . If this is defined,
28 the zoom module will contact Torus for auth/IP lookup and that will
29 define realm to be used in session.
33 virt_db: Fix database name - first character we removed by mistake.
34 Bug introduced in 1.3.40.
38 virt_db: Don't use "unix path" as database for Unix sockets.
42 z3950_client: Don't tamper with / in zurl - fixes problems
43 using Unix sockets for backends.
45 session_shared: fix integer overflow problem with hit count.
47 session_shared: avoid long usage of cached queries.
49 zoom: New database argument , torus_url to set URL of Torus
54 Fixes for 'metaproxy reload' for RPM/Debian packages.
56 zoom: Allow rpn2cql conversion to be augmented with a properties file.
57 Element rpn2cql can be specified per-target for the zoom filter.
59 log: New category "line" which is a single-line log message with
60 most important parts of a HTTP/Z39.50 request/response.
64 frontend_net: add facility to report live statistics about response
65 times and current thread usage. The report is an XML document
66 and is triggered for a specific URL path. This is set by <stat-req>
67 in the configuration of frontend_net. By default this report is
68 disabled (same as empty value for <stat-req>).
70 Fix reload problem in init.d script for RPM/Debian.
71 The '/etc/init.d/metaproxy reload' in some cases would stop but not
72 start metaproxy - effectively stopping the service.
74 Don't display start log message when config testing (-t).
76 zoom: avoid CCL message limit of 1K in ZOOM filter.
80 metaproxy init script reacts to reload which does graceful stop +
81 start and is used by logrorate script.
85 Fixes for Windows compilation.
87 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
88 existing sessions running but terminate the monitor process that is
89 used in keepalive mode.
91 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
92 before. Consistent with 'metaproxy stop' message.
94 zoom: document zoom's proxy_timeout
96 z3950_client: fixup addinfo for init response
98 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
99 "Access to specified database denied" is returned, but only if init
100 response from backend does not carry diagnostics already.
102 multi: relays user info for first rejected target. The other-information
103 field for init response for first rejected target is in common init
104 response. This ensures that some backend init diagnostics are returned to
107 --- 1.3.34 2012/04/25
109 frontend_log: extend logging (when message is given in config).
111 --- 1.3.33 2012/04/25
113 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
115 --- 1.3.32 2012/04/24
117 sru_z3950 filter passes through incoming Z39.50 requests again. Was
118 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
120 --- 1.3.31 2012/04/24
122 zoom: fixes for retry/proxy failover logic. More logging.
124 --- 1.3.30 2012/04/23
126 zoom: return addinfo="proxy failure" for proxy failures. This also
127 changes the scheme for dealing with proxies a bit. zoom now always
128 do proxy check, even if there's no failover. Fortunately, that's not
131 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
132 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
133 generic. We don't know why the init would fail; IP, user, block IP, etc.
134 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
136 zoom: guess if invalid SRU response was an auth failure
138 session_shared: disable session retry by default . Can be enabled by
139 restart="true" in resultset section.
141 --- 1.3.29 2012/04/18
143 zoom: may read cf-proxy's config settings.
144 This reduces manual configuration of the content proxy server host.
145 The ZOOM module will use the old style session.proxyhost if "server"
146 is given (deprecated) and use the new style proxyhost/session if
147 "config_file" is in use.
149 frontend_net: remove incoming requests that can not be handled
150 Requests in queue for filter frontend_net are removed if client
151 closes connection for the session and request is not yet handled.
153 sru_z3950: serialize requests. This is to ensure that pipelined
154 HTTP requests are handled properly.
156 --- 1.3.28 2012/04/04
158 New class, wrbuf, that wraps YAZ' WRBUF.
160 --- 1.3.27 2012/03/30
162 Metaproxy daemon is now running as user "metaproxy". This user is
163 managed by package maintainer scripts. The user information is stored
164 in /etc/metaproxy/metaproxy.user .
166 --- 1.3.26 2012/03/20
168 New filter, sort, that allows sorting of XML records via Z39.50
171 Filter record_transform: USEMarcon support. For example:
172 <retrieval syntax="usmarc">
173 <backend syntax="unimarc" name="F">
174 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
178 Filter multi: empty route pattern uses route as default.
180 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
181 may use the shorter notation
182 <target route="z3950.indexdata.com"/>
184 Filter query_rewrite: use config path to locate XSLT.
186 Filter frontend_net: log statistics.
187 If a custom message element in frontend_net configuration it makes
188 the frontend_net filter produce a log entry whenever an operation
189 is completed. The log is always written using yaz_log with the
190 custom message given, the package ID (session ID) , the time
191 the operation has been active (end-to-end) , the threads currently
192 active/total and the size of the request input/output queues.
194 query_rewrite: charset conversion of query terms.
195 This is an optional feature. Enabled by element <charset> in
196 configuration with attribute 'from' and 'to' that specifies
197 from/to encodings. The default 'from' encoding is UTF-8.
199 Filter record_transform: honor piggyback searches.
201 Filter zoom: re-connect when database is reused.
202 Re-connect is necessary if a connection is lost or a timeout occurs.
203 If not, we'll be seeing zero hits, when we shouldn't.
205 --- 1.3.25 2012/02/29
207 zoom: Change scheme for dealing with content proxy URLs. The module
208 now has its own common XSL transform that is enabled by record_xsl
209 attribute in the configuration. This XSL gets parameter cproxyhost
210 that holds the host for the content proxy session . The genearted-url
211 is created only if urlRecipe is enabled. In previous version default
212 value of urlRecipe was ${md-electronic-url}; it is now empty and
213 disabled by default. Also generated-url no longer includes the content
214 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
217 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
218 connections. Default value is 40 (seconds).
220 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
221 "Malformed query" for syntax errors and related ones; throw
222 Bib-1: 3 "Unsupported search" for everything else. Details from
223 the CCL parser is provided as additional-info.
225 multi: new setting hideerrors that makes multi only relay diagnostics
226 to a client if all backends fail.
228 --- 1.3.24 2012/02/23
230 zoom: empty ccl_map field-mappings disables CCL map.
232 zoom: fix Explain search that could return error if session was
235 --- 1.3.23 2012/02/10
237 zoom: returns Explain records for database IR-Explain---1. The
238 target profile records are converted to Explain records via XSLT.
240 session_shared: make error recovery configurable. Whether a search
241 is restarted on errors or not, is configurable by attribute "restart"
242 in element "resultset" in configuration.
244 session_shared: only relay init for first request. session_shared, for
245 each backend class, now only relays first init request (rather than all).
246 The module only needs to save init response info once. This avoids the
247 need to check for session max.
249 --- 1.3.22 2012/02/02
251 zoom: fix memory leaks.
253 session_shared: maximum number of sessons is configurable. Default
254 value is 100. Result-sets for backends without named result sets are
255 only re-used if databases is identical for a search. This is under the
256 assumption that performance may suffer for those backends when
257 changing the database for each search.
259 multi: combines diagnostics from all backends. All diagnostics from
260 backends are combined into multiple non-surrogate diagnostics; rather
261 than just one diagnostic from first backend.
263 --- 1.3.21 2011/12/27
265 zoom: relay realm to cproxy parameter file.
267 Configuration: Allow filter collection element inside route. This
268 makes it possible to include multiple filters at once.
270 zoom: nocproxy also disables urlRecipe.
272 --- 1.3.20 2011/12/21
274 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
275 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
276 90: "Unsupported direction value".
278 zoom: honor database argument nocproxy. This disables creating a content
279 connector session (for non-CF targets, usually) and also relays nocproxy
280 as database argument to a CF target.
282 --- 1.3.19 2011/12/16
284 zoom: Multiple proxy hosts may be given for proxy rich database
285 parameter. List is comma separated.
287 http_file: decodes URI paths properly. Does not return 404: not found
288 if no prefix are matches. Instead packages are passed on.
290 --- 1.3.18 2011/12/08
292 zoom: content-{user,password,proxy} are passed on to content proxy
293 system and takes precedence over user,password,proxy .
295 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
296 with a log element including log material from children filters. At
297 this point, only the zoom filter uses this log facility. It will
298 eventually be used by other filters as well. In particular it might be
299 useful for this feature to track all filters in used during a search.
301 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
302 and queries as they are manipulated are logged.
304 zoom: extend addinfo with native diagnostics. Diagnostics as received
305 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
306 diagnostics. This indicates both a backend diagnostic and the original
309 zoom: default urlRecipe value is ${md-electronic-url}
311 zoom: target profile setting sruVersion is recognized.
313 --- 1.3.17 2011/11/17
315 zoom: log target profile record fetched (AKA Torus).
317 --- 1.3.16 2011/11/17
319 Change target profile parameter CfSubDb to CfSubDB.
321 --- 1.3.15 2011/11/12
323 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
324 makes sense to the zoom module itself).
326 --- 1.3.14 2011/11/11
328 zoom: realm may be given as part of database.
330 --- 1.3.13 2011/10/26
332 Fix Origin class assigment method; was removd by mistake in 1.3.12.
334 --- 1.3.12 2011/10/26
336 zoom: database args x-name=value are passed through to backend database.
338 SRU filter: user may specify session ID that is passed to log entries
339 that follows. It is specified by using x-session-id in the SRU arguments.
341 zoom: fix null pointer reference which would occur for bad url parameter
342 inside "torus" or if url was not given.
344 --- 1.3.11 2011/09/09
345 Fix bug in filter session_shared where sessions would not expire
346 properly (session ttl). This in turn could make the target close the
347 connection before expected and session_shared would return diagnostic
348 2: system temporarily available.
350 --- 1.3.10 2011/09/09
352 zoom: new target profile setting: sortmap_field. If sortmap_field is given
353 the field is mapped to the value for the sortmap. Values not matching
354 sortmap_field are passed verbatim.
356 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
357 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
358 depending on whether RPN or CQL is actually sent to the target.
362 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
364 zoom: For content proxy authentication is stored in param name
365 "auth", instead of "authentication".
369 zoom: relay schema in SRU mode. Previously recordSchema was not affected
374 zoom: new target profile element literalTransform that holds XSLT
375 (encoded as string) for target. Only if present and non-zero length it is
376 considered present. This takes precedence over transform.
378 Don't rely on trang anymore for Git checkout builds. Configuration in etc
379 will only be properly validated if trang is available. From now on only
380 relax NC files are bundled with the source dist.
382 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
383 component was not detected when it should be.
387 z3950_client: mark non-surrogate diagnostics from backend.
389 zoom: a proxy may be specified for HTTP fetch of target profiles.
393 Honor piggyback. Makes some SRU targets behave that insist on
394 maximumRecords > 0, but also increases performance.
398 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
399 file was not update for libdir/metaproxy4 in version 1.3.2.
403 Change location of Metaproxy modules from libdir/metaproxy to
404 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
405 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
407 New facility to dump APDUs from zoom filter. Enabled by
408 <log apdu="true"/> in the zoom filter configuation.
410 zoom filter bug fix: SRU diagnostics received from backend was
411 not properly converted to Bib-1 diagnostics.
413 Package metaproxy depends on libmetaproxy4, same version.
417 zoom: fix a bug WRT passing authentication parameters to backends.
421 Fixes for windows Makefile.
423 --- 1.2.10 2011/07/25
425 Change major version of metaproxy library from 3 to 4. This in turn
426 makes new package names for Debian and RPM.
430 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
433 zoom: configurable element sets for record transforms.
435 zoom: the target profile based transform is specified by element_transform
436 in element torus of of the ZOOM filter configuration ; default value
437 is "pz2". Target profile based retrieval is specified by element_raw
438 in configuration. It will perform same steps, but omit the XSL transform.
439 Default value is "raw".
441 zoom: element set is omitted if not set in profile. But only if pz2
442 transform is in effect. Previously the default element set was to "F".
444 zoom: For non-CF targets database arguments are parsed. User may supply
445 db,user=myuser&password=mypass for non-CF targets. These values override
446 what's given the authentication from the target profile.
448 session_shared: fix reference to freed memory. Would occur if a search
449 response had non-surrogate diagnostics.
453 Route may be given for each port in frontend_net.
457 Documentation for zoom filter. Local target profiles may be specified.
459 Fixes for zoom filter.
463 First version with zoom filter.
467 Filter z3950_client may be configured to always send a close APDU
468 to backend target when connection/session is closed. This will only
469 happen if close APDU is not already sent. Enabled by configuration
470 for z3950_client (force_close).
472 Filter virt_db and multi: relay close APDU.
474 Filter virt_db and multi: relay init size parameters
475 preferredMessageSize and maximumRecordSize.
477 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
481 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
483 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
484 as determined by configure.
486 RPM: Release includes 'indexdata' name. Use indexdata in release name so
487 this package can be distinguished from other vendors.
491 Fix filter multi: relay idAuthentication parameters.
495 Add metaproxy-config for returning compiler flags, libraries.
499 Fix --with-boost=PREFIX .
503 session_shared: fix use of maintenance thread.
505 Introduce 'start' method for filters and routers. It gets called after
506 configure and after fork, but before processing. This changes API -
507 from libmetaproxy2 to libmetaproxy3.
511 session_shared: ensure backend session is closed if init rejected
514 z3950_client: fix NULL ptr reference that could occur if two clients
515 connected concurrently and if max-sockets was in effect.
519 Fix bug 3497 - Metaproxy unstable while stopping.
521 Fix bug 3495 - SEGV in SRU filter.
525 Filter multi throws diagnostic 'Present Out of Range' when
526 appropriate - rather than returning 0 records.
528 Filter virt_db: fix bad result reuse. Could happen if a result
529 was overriden and a backend did not supported named result sets.
533 Filter log: category access logs diagnostics even if searchStatus
534 or presentStatus is 'success'.
538 The SRU to Z39.50 filter does repeated Z39.50 present requests
539 to fetch all records. Needed when a Z39.50 server returns partial
540 results (due to message size limits).
544 Metaproxy now kills all child processes that are spawned by
545 modules (in case of fork, exec).
549 Debian package now installs /etc/metaproxy/metaproxy.xml which
550 includes all XML files /etc/metaproxy/filters-enabled .
551 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
555 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
556 development package to facilitate 3rd party Metaproxy modules.
558 --- 1.0.23 2010/01/04
560 Filter virt_db: Close backend filter session when Init rejected is received
561 from it (in which case it's not really closed yet). This will ensure we don't
562 run out of resources such as FDs in this case.
564 sru_z3950 filter: Accept any database (including those not listed).
566 --- 1.0.22 2009/12/03
568 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
569 later which means YAZ 3.0.47 or later.
571 --- 1.0.20 2009/11/19
573 For filter virt_db, the database is a glob pattern and the virtual
574 database sections are consulted in the order given.
576 --- 1.0.19 2009/07/08
578 For filter multi, the target (for routing) may be given as a glob-pattern.
580 More documentation for filters virt_db and multi.
582 Update schema to allow for no database in sru_z3950 filter.
584 --- 1.0.18 2009/06/30
586 Added limit filter to put sleep (penalty) for heavy use.
588 Filter frontend_net may be configured to limit the number of new connections
589 from same IP to some value (connect-max).
591 Fixed the load_balance filter.
593 --- 1.0.17 2009/06/16
595 Fix path for metaproxy executable for Debian init.d script.
597 --- 1.0.16 2009/06/10
599 SRU to Z39.50 filter honors x-username and x-password. If only
600 x-username is given that translates to open authentication (Z39.50v2). If
601 both x-username and x-password is present that translates to idPass
602 authentication (Z39.50v3).
604 New facility to change current working directory (-w).
606 Update to upstream skeleton of init.d script. Should fix bug #2619.
608 Filter session_shared now caches records (used to only cache connections
611 Filter session_shared now invalidates a Z39.50 session if a server
612 returns -1 hits. This facility was also part of yazproxy and gets around
613 a bug in Voyager-based Z39.50 servers.
615 --- 1.0.15 2008/11/18
617 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
619 --- 1.0.14 2008/06/09
621 Fixed the value of SRU record schema in searchRetrieve response. It was set
622 to a fixed value of "dc" before.
624 Serialize identical SRU requests. This is useful if HTTP client software
625 fires identical requests against metaproxy.
627 Allow Z39.50 target to be specified for SRU requests by using SRU extra
628 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
629 avoid static configuration. This facility is handled by the sru_z3950 module
630 and the z3950_client module.
632 Allow maximum number of sockets to be used for a Z39.50 client by the
633 use of SRU extra parameter x-max-sockets. This facility is handled by the
634 sru_z3950 module and the z3950_client module.
636 --- 1.0.13.1 2008/02/29
638 Simplified check for Boost libraries.
640 --- 1.0.13 2008/02/29
642 First Debian package.
644 The sru_z9350 filter now recognizes SRU parameter z-target as being
645 a ZURL of the form host/database .
647 Mergetype may be specified for filter 'multi'.
649 --- 1.0.12 2007/09/19
651 Fixed problem in Makefile WRT library specifictions. This could produce
652 linker errors (when they should not happen).
654 Fixed bug #1341: MetaProxy returning different results. Problem was that
655 fix-up of record database did not normalize the database name.
657 Documentation updates for Windows compilation.
659 --- 1.0.11 2007/06/14
661 Fixed problem with logfile being truncated.
663 --- 1.0.10 2007/05/23
665 Fixed bug #1136: Access rights not enforced.
667 Extension for log module. The log category 'access' logs more details.
668 New category 'user-access' added which is simlar to 'access' but adds
669 the Z39.50 user as for all entries in a session.
673 Added support for configurable default/force target/vhost for module Z39.50
678 Implemented filter, session_shared, which optimizes usage of Z39.50
679 sessions and result sets.
681 New filter, record_transform, which converts MARC/XML records.
683 New filter, sru_z3950, which converts SRU to Z39.50 packages.
685 New filter, load_balance, in development.
687 New filter, zeerex_xplain.
689 XML framework for config files started.
691 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
692 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
693 XML config files are checked against RNG and XML Schema's.
695 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
696 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
697 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
698 explain record to YAZ CQL-to-PQF text config file.
702 Added 'timeout' setting for filter frontend_net which specifies the number
703 of seconds a session is idle before it is closed. Default timeout is
708 Database name in records returned set for virt_db/multi filters.
710 Filter session_shared now functional.
712 Log filter can be configured to write to a given file using 'filename'
713 element. Also information category can be specified with 'category'. If
714 filename is omitted, the log filter writes to stdout. See etc/config5.xml
719 Fixed compilation on Windows.
723 Added documentation for the hidenavailable option for the multi filter.
727 Fixed bug #573: Hide errors for individual servers. If the element
728 'hideunavailable' is given in the configuration, individual servers
729 being unavailable are hidden (unless all are unavailable).
731 Fixed bug #574: Database names are recognised case-sensitively.
733 Fixed bug #567: Fix up database name in Name-Plus-Record.
735 Fixed bug #568: Update win/makefile for VS 2005.
737 Fixed bug #569: Some options throws unknown exception.
741 More information about virtual hosts. The 'etc' directory is part of the
746 Build instructions for Windows. NMake makefile part of distribution tar.
752 Filters functional: auth_simple, backend_test, frontend_net, http_file,
753 log, multi, query_rewrite, template, virt_db, z3950_client.
755 Filters in development: session_shared.
757 Pseudo-filters: template, dl