3 zoom: return addinfo="proxy failure" for proxy failures. This also
4 changes the scheme for dealing with proxies a bit. zoom now always
5 do proxy check, even if there's no failover. Fortunately, that's not
8 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
9 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
10 generic. We don't know why the init would fail; IP, user, block IP, etc.
11 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
13 zoom: guess if invalid SRU response was an auth failure
15 session_shared: disable session retry by default . Can be enabled by
16 restart="true" in resultset section.
20 zoom: may read cf-proxy's config settings.
21 This reduces manual configuration of the content proxy server host.
22 The ZOOM module will use the old style session.proxyhost if "server"
23 is given (deprecated) and use the new style proxyhost/session if
24 "config_file" is in use.
26 frontend_net: remove incoming requests that can not be handled
27 Requests in queue for filter frontend_net are removed if client
28 closes connection for the session and request is not yet handled.
30 sru_z3950: serialize requests. This is to ensure that pipelined
31 HTTP requests are handled properly.
35 New class, wrbuf, that wraps YAZ' WRBUF.
39 Metaproxy daemon is now running as user "metaproxy". This user is
40 managed by package maintainer scripts. The user information is stored
41 in /etc/metaproxy/metaproxy.user .
45 New filter, sort, that allows sorting of XML records via Z39.50
48 Filter record_transform: USEMarcon support. For example:
49 <retrieval syntax="usmarc">
50 <backend syntax="unimarc" name="F">
51 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
55 Filter multi: empty route pattern uses route as default.
57 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
58 may use the shorter notation
59 <target route="z3950.indexdata.com"/>
61 Filter query_rewrite: use config path to locate XSLT.
63 Filter frontend_net: log statistics.
64 If a custom message element in frontend_net configuration it makes
65 the frontend_net filter produce a log entry whenever an operation
66 is completed. The log is always written using yaz_log with the
67 custom message given, the package ID (session ID) , the time
68 the operation has been active (end-to-end) , the threads currently
69 active/total and the size of the request input/output queues.
71 query_rewrite: charset conversion of query terms.
72 This is an optional feature. Enabled by element <charset> in
73 configuration with attribute 'from' and 'to' that specifies
74 from/to encodings. The default 'from' encoding is UTF-8.
76 Filter record_transform: honor piggyback searches.
78 Filter zoom: re-connect when database is reused.
79 Re-connect is necessary if a connection is lost or a timeout occurs.
80 If not, we'll be seeing zero hits, when we shouldn't.
84 zoom: Change scheme for dealing with content proxy URLs. The module
85 now has its own common XSL transform that is enabled by record_xsl
86 attribute in the configuration. This XSL gets parameter cproxyhost
87 that holds the host for the content proxy session . The genearted-url
88 is created only if urlRecipe is enabled. In previous version default
89 value of urlRecipe was ${md-electronic-url}; it is now empty and
90 disabled by default. Also generated-url no longer includes the content
91 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
94 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
95 connections. Default value is 40 (seconds).
97 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
98 "Malformed query" for syntax errors and related ones; throw
99 Bib-1: 3 "Unsupported search" for everything else. Details from
100 the CCL parser is provided as additional-info.
102 multi: new setting hideerrors that makes multi only relay diagnostics
103 to a client if all backends fail.
105 --- 1.3.24 2012/02/23
107 zoom: empty ccl_map field-mappings disables CCL map.
109 zoom: fix Explain search that could return error if session was
112 --- 1.3.23 2012/02/10
114 zoom: returns Explain records for database IR-Explain---1. The
115 target profile records are converted to Explain records via XSLT.
117 session_shared: make error recovery configurable. Whether a search
118 is restarted on errors or not, is configurable by attribute "restart"
119 in element "resultset" in configuration.
121 session_shared: only relay init for first request. session_shared, for
122 each backend class, now only relays first init request (rather than all).
123 The module only needs to save init response info once. This avoids the
124 need to check for session max.
126 --- 1.3.22 2012/02/02
128 zoom: fix memory leaks.
130 session_shared: maximum number of sessons is configurable. Default
131 value is 100. Result-sets for backends without named result sets are
132 only re-used if databases is identical for a search. This is under the
133 assumption that performance may suffer for those backends when
134 changing the database for each search.
136 multi: combines diagnostics from all backends. All diagnostics from
137 backends are combined into multiple non-surrogate diagnostics; rather
138 than just one diagnostic from first backend.
140 --- 1.3.21 2011/12/27
142 zoom: relay realm to cproxy parameter file.
144 Configuration: Allow filter collection element inside route. This
145 makes it possible to include multiple filters at once.
147 zoom: nocproxy also disables urlRecipe.
149 --- 1.3.20 2011/12/21
151 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
152 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
153 90: "Unsupported direction value".
155 zoom: honor database argument nocproxy. This disables creating a content
156 connector session (for non-CF targets, usually) and also relays nocproxy
157 as database argument to a CF target.
159 --- 1.3.19 2011/12/16
161 zoom: Multiple proxy hosts may be given for proxy rich database
162 parameter. List is comma separated.
164 http_file: decodes URI paths properly. Does not return 404: not found
165 if no prefix are matches. Instead packages are passed on.
167 --- 1.3.18 2011/12/08
169 zoom: content-{user,password,proxy} are passed on to content proxy
170 system and takes precedence over user,password,proxy .
172 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
173 with a log element including log material from children filters. At
174 this point, only the zoom filter uses this log facility. It will
175 eventually be used by other filters as well. In particular it might be
176 useful for this feature to track all filters in used during a search.
178 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
179 and queries as they are manipulated are logged.
181 zoom: extend addinfo with native diagnostics. Diagnostics as received
182 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
183 diagnostics. This indicates both a backend diagnostic and the original
186 zoom: default urlRecipe value is ${md-electronic-url}
188 zoom: target profile setting sruVersion is recognized.
190 --- 1.3.17 2011/11/17
192 zoom: log target profile record fetched (AKA Torus).
194 --- 1.3.16 2011/11/17
196 Change target profile parameter CfSubDb to CfSubDB.
198 --- 1.3.15 2011/11/12
200 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
201 makes sense to the zoom module itself).
203 --- 1.3.14 2011/11/11
205 zoom: realm may be given as part of database.
207 --- 1.3.13 2011/10/26
209 Fix Origin class assigment method; was removd by mistake in 1.3.12.
211 --- 1.3.12 2011/10/26
213 zoom: database args x-name=value are passed through to backend database.
215 SRU filter: user may specify session ID that is passed to log entries
216 that follows. It is specified by using x-session-id in the SRU arguments.
218 zoom: fix null pointer reference which would occur for bad url parameter
219 inside "torus" or if url was not given.
221 --- 1.3.11 2011/09/09
222 Fix bug in filter session_shared where sessions would not expire
223 properly (session ttl). This in turn could make the target close the
224 connection before expected and session_shared would return diagnostic
225 2: system temporarily available.
227 --- 1.3.10 2011/09/09
229 zoom: new target profile setting: sortmap_field. If sortmap_field is given
230 the field is mapped to the value for the sortmap. Values not matching
231 sortmap_field are passed verbatim.
233 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
234 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
235 depending on whether RPN or CQL is actually sent to the target.
239 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
241 zoom: For content proxy authentication is stored in param name
242 "auth", instead of "authentication".
246 zoom: relay schema in SRU mode. Previously recordSchema was not affected
251 zoom: new target profile element literalTransform that holds XSLT
252 (encoded as string) for target. Only if present and non-zero length it is
253 considered present. This takes precedence over transform.
255 Don't rely on trang anymore for Git checkout builds. Configuration in etc
256 will only be properly validated if trang is available. From now on only
257 relax NC files are bundled with the source dist.
259 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
260 component was not detected when it should be.
264 z3950_client: mark non-surrogate diagnostics from backend.
266 zoom: a proxy may be specified for HTTP fetch of target profiles.
270 Honor piggyback. Makes some SRU targets behave that insist on
271 maximumRecords > 0, but also increases performance.
275 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
276 file was not update for libdir/metaproxy4 in version 1.3.2.
280 Change location of Metaproxy modules from libdir/metaproxy to
281 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
282 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
284 New facility to dump APDUs from zoom filter. Enabled by
285 <log apdu="true"/> in the zoom filter configuation.
287 zoom filter bug fix: SRU diagnostics received from backend was
288 not properly converted to Bib-1 diagnostics.
290 Package metaproxy depends on libmetaproxy4, same version.
294 zoom: fix a bug WRT passing authentication parameters to backends.
298 Fixes for windows Makefile.
300 --- 1.2.10 2011/07/25
302 Change major version of metaproxy library from 3 to 4. This in turn
303 makes new package names for Debian and RPM.
307 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
310 zoom: configurable element sets for record transforms.
312 zoom: the target profile based transform is specified by element_transform
313 in element torus of of the ZOOM filter configuration ; default value
314 is "pz2". Target profile based retrieval is specified by element_raw
315 in configuration. It will perform same steps, but omit the XSL transform.
316 Default value is "raw".
318 zoom: element set is omitted if not set in profile. But only if pz2
319 transform is in effect. Previously the default element set was to "F".
321 zoom: For non-CF targets database arguments are parsed. User may supply
322 db,user=myuser&password=mypass for non-CF targets. These values override
323 what's given the authentication from the target profile.
325 session_shared: fix reference to freed memory. Would occur if a search
326 response had non-surrogate diagnostics.
330 Route may be given for each port in frontend_net.
334 Documentation for zoom filter. Local target profiles may be specified.
336 Fixes for zoom filter.
340 First version with zoom filter.
344 Filter z3950_client may be configured to always send a close APDU
345 to backend target when connection/session is closed. This will only
346 happen if close APDU is not already sent. Enabled by configuration
347 for z3950_client (force_close).
349 Filter virt_db and multi: relay close APDU.
351 Filter virt_db and multi: relay init size parameters
352 preferredMessageSize and maximumRecordSize.
354 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
358 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
360 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
361 as determined by configure.
363 RPM: Release includes 'indexdata' name. Use indexdata in release name so
364 this package can be distinguished from other vendors.
368 Fix filter multi: relay idAuthentication parameters.
372 Add metaproxy-config for returning compiler flags, libraries.
376 Fix --with-boost=PREFIX .
380 session_shared: fix use of maintenance thread.
382 Introduce 'start' method for filters and routers. It gets called after
383 configure and after fork, but before processing. This changes API -
384 from libmetaproxy2 to libmetaproxy3.
388 session_shared: ensure backend session is closed if init rejected
391 z3950_client: fix NULL ptr reference that could occur if two clients
392 connected concurrently and if max-sockets was in effect.
396 Fix bug 3497 - Metaproxy unstable while stopping.
398 Fix bug 3495 - SEGV in SRU filter.
402 Filter multi throws diagnostic 'Present Out of Range' when
403 appropriate - rather than returning 0 records.
405 Filter virt_db: fix bad result reuse. Could happen if a result
406 was overriden and a backend did not supported named result sets.
410 Filter log: category access logs diagnostics even if searchStatus
411 or presentStatus is 'success'.
415 The SRU to Z39.50 filter does repeated Z39.50 present requests
416 to fetch all records. Needed when a Z39.50 server returns partial
417 results (due to message size limits).
421 Metaproxy now kills all child processes that are spawned by
422 modules (in case of fork, exec).
426 Debian package now installs /etc/metaproxy/metaproxy.xml which
427 includes all XML files /etc/metaproxy/filters-enabled .
428 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
432 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
433 development package to facilitate 3rd party Metaproxy modules.
435 --- 1.0.23 2010/01/04
437 Filter virt_db: Close backend filter session when Init rejected is received
438 from it (in which case it's not really closed yet). This will ensure we don't
439 run out of resources such as FDs in this case.
441 sru_z3950 filter: Accept any database (including those not listed).
443 --- 1.0.22 2009/12/03
445 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
446 later which means YAZ 3.0.47 or later.
448 --- 1.0.20 2009/11/19
450 For filter virt_db, the database is a glob pattern and the virtual
451 database sections are consulted in the order given.
453 --- 1.0.19 2009/07/08
455 For filter multi, the target (for routing) may be given as a glob-pattern.
457 More documentation for filters virt_db and multi.
459 Update schema to allow for no database in sru_z3950 filter.
461 --- 1.0.18 2009/06/30
463 Added limit filter to put sleep (penalty) for heavy use.
465 Filter frontend_net may be configured to limit the number of new connections
466 from same IP to some value (connect-max).
468 Fixed the load_balance filter.
470 --- 1.0.17 2009/06/16
472 Fix path for metaproxy executable for Debian init.d script.
474 --- 1.0.16 2009/06/10
476 SRU to Z39.50 filter honors x-username and x-password. If only
477 x-username is given that translates to open authentication (Z39.50v2). If
478 both x-username and x-password is present that translates to idPass
479 authentication (Z39.50v3).
481 New facility to change current working directory (-w).
483 Update to upstream skeleton of init.d script. Should fix bug #2619.
485 Filter session_shared now caches records (used to only cache connections
488 Filter session_shared now invalidates a Z39.50 session if a server
489 returns -1 hits. This facility was also part of yazproxy and gets around
490 a bug in Voyager-based Z39.50 servers.
492 --- 1.0.15 2008/11/18
494 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
496 --- 1.0.14 2008/06/09
498 Fixed the value of SRU record schema in searchRetrieve response. It was set
499 to a fixed value of "dc" before.
501 Serialize identical SRU requests. This is useful if HTTP client software
502 fires identical requests against metaproxy.
504 Allow Z39.50 target to be specified for SRU requests by using SRU extra
505 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
506 avoid static configuration. This facility is handled by the sru_z3950 module
507 and the z3950_client module.
509 Allow maximum number of sockets to be used for a Z39.50 client by the
510 use of SRU extra parameter x-max-sockets. This facility is handled by the
511 sru_z3950 module and the z3950_client module.
513 --- 1.0.13.1 2008/02/29
515 Simplified check for Boost libraries.
517 --- 1.0.13 2008/02/29
519 First Debian package.
521 The sru_z9350 filter now recognizes SRU parameter z-target as being
522 a ZURL of the form host/database .
524 Mergetype may be specified for filter 'multi'.
526 --- 1.0.12 2007/09/19
528 Fixed problem in Makefile WRT library specifictions. This could produce
529 linker errors (when they should not happen).
531 Fixed bug #1341: MetaProxy returning different results. Problem was that
532 fix-up of record database did not normalize the database name.
534 Documentation updates for Windows compilation.
536 --- 1.0.11 2007/06/14
538 Fixed problem with logfile being truncated.
540 --- 1.0.10 2007/05/23
542 Fixed bug #1136: Access rights not enforced.
544 Extension for log module. The log category 'access' logs more details.
545 New category 'user-access' added which is simlar to 'access' but adds
546 the Z39.50 user as for all entries in a session.
550 Added support for configurable default/force target/vhost for module Z39.50
555 Implemented filter, session_shared, which optimizes usage of Z39.50
556 sessions and result sets.
558 New filter, record_transform, which converts MARC/XML records.
560 New filter, sru_z3950, which converts SRU to Z39.50 packages.
562 New filter, load_balance, in development.
564 New filter, zeerex_xplain.
566 XML framework for config files started.
568 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
569 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
570 XML config files are checked against RNG and XML Schema's.
572 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
573 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
574 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
575 explain record to YAZ CQL-to-PQF text config file.
579 Added 'timeout' setting for filter frontend_net which specifies the number
580 of seconds a session is idle before it is closed. Default timeout is
585 Database name in records returned set for virt_db/multi filters.
587 Filter session_shared now functional.
589 Log filter can be configured to write to a given file using 'filename'
590 element. Also information category can be specified with 'category'. If
591 filename is omitted, the log filter writes to stdout. See etc/config5.xml
596 Fixed compilation on Windows.
600 Added documentation for the hidenavailable option for the multi filter.
604 Fixed bug #573: Hide errors for individual servers. If the element
605 'hideunavailable' is given in the configuration, individual servers
606 being unavailable are hidden (unless all are unavailable).
608 Fixed bug #574: Database names are recognised case-sensitively.
610 Fixed bug #567: Fix up database name in Name-Plus-Record.
612 Fixed bug #568: Update win/makefile for VS 2005.
614 Fixed bug #569: Some options throws unknown exception.
618 More information about virtual hosts. The 'etc' directory is part of the
623 Build instructions for Windows. NMake makefile part of distribution tar.
629 Filters functional: auth_simple, backend_test, frontend_net, http_file,
630 log, multi, query_rewrite, template, virt_db, z3950_client.
632 Filters in development: session_shared.
634 Pseudo-filters: template, dl