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