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