3 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
7 sru_z3950 filter passes through incoming Z39.50 requests again. Was
8 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
12 zoom: fixes for retry/proxy failover logic. More logging.
16 zoom: return addinfo="proxy failure" for proxy failures. This also
17 changes the scheme for dealing with proxies a bit. zoom now always
18 do proxy check, even if there's no failover. Fortunately, that's not
21 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
22 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
23 generic. We don't know why the init would fail; IP, user, block IP, etc.
24 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
26 zoom: guess if invalid SRU response was an auth failure
28 session_shared: disable session retry by default . Can be enabled by
29 restart="true" in resultset section.
33 zoom: may read cf-proxy's config settings.
34 This reduces manual configuration of the content proxy server host.
35 The ZOOM module will use the old style session.proxyhost if "server"
36 is given (deprecated) and use the new style proxyhost/session if
37 "config_file" is in use.
39 frontend_net: remove incoming requests that can not be handled
40 Requests in queue for filter frontend_net are removed if client
41 closes connection for the session and request is not yet handled.
43 sru_z3950: serialize requests. This is to ensure that pipelined
44 HTTP requests are handled properly.
48 New class, wrbuf, that wraps YAZ' WRBUF.
52 Metaproxy daemon is now running as user "metaproxy". This user is
53 managed by package maintainer scripts. The user information is stored
54 in /etc/metaproxy/metaproxy.user .
58 New filter, sort, that allows sorting of XML records via Z39.50
61 Filter record_transform: USEMarcon support. For example:
62 <retrieval syntax="usmarc">
63 <backend syntax="unimarc" name="F">
64 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
68 Filter multi: empty route pattern uses route as default.
70 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
71 may use the shorter notation
72 <target route="z3950.indexdata.com"/>
74 Filter query_rewrite: use config path to locate XSLT.
76 Filter frontend_net: log statistics.
77 If a custom message element in frontend_net configuration it makes
78 the frontend_net filter produce a log entry whenever an operation
79 is completed. The log is always written using yaz_log with the
80 custom message given, the package ID (session ID) , the time
81 the operation has been active (end-to-end) , the threads currently
82 active/total and the size of the request input/output queues.
84 query_rewrite: charset conversion of query terms.
85 This is an optional feature. Enabled by element <charset> in
86 configuration with attribute 'from' and 'to' that specifies
87 from/to encodings. The default 'from' encoding is UTF-8.
89 Filter record_transform: honor piggyback searches.
91 Filter zoom: re-connect when database is reused.
92 Re-connect is necessary if a connection is lost or a timeout occurs.
93 If not, we'll be seeing zero hits, when we shouldn't.
97 zoom: Change scheme for dealing with content proxy URLs. The module
98 now has its own common XSL transform that is enabled by record_xsl
99 attribute in the configuration. This XSL gets parameter cproxyhost
100 that holds the host for the content proxy session . The genearted-url
101 is created only if urlRecipe is enabled. In previous version default
102 value of urlRecipe was ${md-electronic-url}; it is now empty and
103 disabled by default. Also generated-url no longer includes the content
104 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
107 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
108 connections. Default value is 40 (seconds).
110 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
111 "Malformed query" for syntax errors and related ones; throw
112 Bib-1: 3 "Unsupported search" for everything else. Details from
113 the CCL parser is provided as additional-info.
115 multi: new setting hideerrors that makes multi only relay diagnostics
116 to a client if all backends fail.
118 --- 1.3.24 2012/02/23
120 zoom: empty ccl_map field-mappings disables CCL map.
122 zoom: fix Explain search that could return error if session was
125 --- 1.3.23 2012/02/10
127 zoom: returns Explain records for database IR-Explain---1. The
128 target profile records are converted to Explain records via XSLT.
130 session_shared: make error recovery configurable. Whether a search
131 is restarted on errors or not, is configurable by attribute "restart"
132 in element "resultset" in configuration.
134 session_shared: only relay init for first request. session_shared, for
135 each backend class, now only relays first init request (rather than all).
136 The module only needs to save init response info once. This avoids the
137 need to check for session max.
139 --- 1.3.22 2012/02/02
141 zoom: fix memory leaks.
143 session_shared: maximum number of sessons is configurable. Default
144 value is 100. Result-sets for backends without named result sets are
145 only re-used if databases is identical for a search. This is under the
146 assumption that performance may suffer for those backends when
147 changing the database for each search.
149 multi: combines diagnostics from all backends. All diagnostics from
150 backends are combined into multiple non-surrogate diagnostics; rather
151 than just one diagnostic from first backend.
153 --- 1.3.21 2011/12/27
155 zoom: relay realm to cproxy parameter file.
157 Configuration: Allow filter collection element inside route. This
158 makes it possible to include multiple filters at once.
160 zoom: nocproxy also disables urlRecipe.
162 --- 1.3.20 2011/12/21
164 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
165 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
166 90: "Unsupported direction value".
168 zoom: honor database argument nocproxy. This disables creating a content
169 connector session (for non-CF targets, usually) and also relays nocproxy
170 as database argument to a CF target.
172 --- 1.3.19 2011/12/16
174 zoom: Multiple proxy hosts may be given for proxy rich database
175 parameter. List is comma separated.
177 http_file: decodes URI paths properly. Does not return 404: not found
178 if no prefix are matches. Instead packages are passed on.
180 --- 1.3.18 2011/12/08
182 zoom: content-{user,password,proxy} are passed on to content proxy
183 system and takes precedence over user,password,proxy .
185 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
186 with a log element including log material from children filters. At
187 this point, only the zoom filter uses this log facility. It will
188 eventually be used by other filters as well. In particular it might be
189 useful for this feature to track all filters in used during a search.
191 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
192 and queries as they are manipulated are logged.
194 zoom: extend addinfo with native diagnostics. Diagnostics as received
195 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
196 diagnostics. This indicates both a backend diagnostic and the original
199 zoom: default urlRecipe value is ${md-electronic-url}
201 zoom: target profile setting sruVersion is recognized.
203 --- 1.3.17 2011/11/17
205 zoom: log target profile record fetched (AKA Torus).
207 --- 1.3.16 2011/11/17
209 Change target profile parameter CfSubDb to CfSubDB.
211 --- 1.3.15 2011/11/12
213 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
214 makes sense to the zoom module itself).
216 --- 1.3.14 2011/11/11
218 zoom: realm may be given as part of database.
220 --- 1.3.13 2011/10/26
222 Fix Origin class assigment method; was removd by mistake in 1.3.12.
224 --- 1.3.12 2011/10/26
226 zoom: database args x-name=value are passed through to backend database.
228 SRU filter: user may specify session ID that is passed to log entries
229 that follows. It is specified by using x-session-id in the SRU arguments.
231 zoom: fix null pointer reference which would occur for bad url parameter
232 inside "torus" or if url was not given.
234 --- 1.3.11 2011/09/09
235 Fix bug in filter session_shared where sessions would not expire
236 properly (session ttl). This in turn could make the target close the
237 connection before expected and session_shared would return diagnostic
238 2: system temporarily available.
240 --- 1.3.10 2011/09/09
242 zoom: new target profile setting: sortmap_field. If sortmap_field is given
243 the field is mapped to the value for the sortmap. Values not matching
244 sortmap_field are passed verbatim.
246 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
247 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
248 depending on whether RPN or CQL is actually sent to the target.
252 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
254 zoom: For content proxy authentication is stored in param name
255 "auth", instead of "authentication".
259 zoom: relay schema in SRU mode. Previously recordSchema was not affected
264 zoom: new target profile element literalTransform that holds XSLT
265 (encoded as string) for target. Only if present and non-zero length it is
266 considered present. This takes precedence over transform.
268 Don't rely on trang anymore for Git checkout builds. Configuration in etc
269 will only be properly validated if trang is available. From now on only
270 relax NC files are bundled with the source dist.
272 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
273 component was not detected when it should be.
277 z3950_client: mark non-surrogate diagnostics from backend.
279 zoom: a proxy may be specified for HTTP fetch of target profiles.
283 Honor piggyback. Makes some SRU targets behave that insist on
284 maximumRecords > 0, but also increases performance.
288 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
289 file was not update for libdir/metaproxy4 in version 1.3.2.
293 Change location of Metaproxy modules from libdir/metaproxy to
294 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
295 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
297 New facility to dump APDUs from zoom filter. Enabled by
298 <log apdu="true"/> in the zoom filter configuation.
300 zoom filter bug fix: SRU diagnostics received from backend was
301 not properly converted to Bib-1 diagnostics.
303 Package metaproxy depends on libmetaproxy4, same version.
307 zoom: fix a bug WRT passing authentication parameters to backends.
311 Fixes for windows Makefile.
313 --- 1.2.10 2011/07/25
315 Change major version of metaproxy library from 3 to 4. This in turn
316 makes new package names for Debian and RPM.
320 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
323 zoom: configurable element sets for record transforms.
325 zoom: the target profile based transform is specified by element_transform
326 in element torus of of the ZOOM filter configuration ; default value
327 is "pz2". Target profile based retrieval is specified by element_raw
328 in configuration. It will perform same steps, but omit the XSL transform.
329 Default value is "raw".
331 zoom: element set is omitted if not set in profile. But only if pz2
332 transform is in effect. Previously the default element set was to "F".
334 zoom: For non-CF targets database arguments are parsed. User may supply
335 db,user=myuser&password=mypass for non-CF targets. These values override
336 what's given the authentication from the target profile.
338 session_shared: fix reference to freed memory. Would occur if a search
339 response had non-surrogate diagnostics.
343 Route may be given for each port in frontend_net.
347 Documentation for zoom filter. Local target profiles may be specified.
349 Fixes for zoom filter.
353 First version with zoom filter.
357 Filter z3950_client may be configured to always send a close APDU
358 to backend target when connection/session is closed. This will only
359 happen if close APDU is not already sent. Enabled by configuration
360 for z3950_client (force_close).
362 Filter virt_db and multi: relay close APDU.
364 Filter virt_db and multi: relay init size parameters
365 preferredMessageSize and maximumRecordSize.
367 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
371 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
373 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
374 as determined by configure.
376 RPM: Release includes 'indexdata' name. Use indexdata in release name so
377 this package can be distinguished from other vendors.
381 Fix filter multi: relay idAuthentication parameters.
385 Add metaproxy-config for returning compiler flags, libraries.
389 Fix --with-boost=PREFIX .
393 session_shared: fix use of maintenance thread.
395 Introduce 'start' method for filters and routers. It gets called after
396 configure and after fork, but before processing. This changes API -
397 from libmetaproxy2 to libmetaproxy3.
401 session_shared: ensure backend session is closed if init rejected
404 z3950_client: fix NULL ptr reference that could occur if two clients
405 connected concurrently and if max-sockets was in effect.
409 Fix bug 3497 - Metaproxy unstable while stopping.
411 Fix bug 3495 - SEGV in SRU filter.
415 Filter multi throws diagnostic 'Present Out of Range' when
416 appropriate - rather than returning 0 records.
418 Filter virt_db: fix bad result reuse. Could happen if a result
419 was overriden and a backend did not supported named result sets.
423 Filter log: category access logs diagnostics even if searchStatus
424 or presentStatus is 'success'.
428 The SRU to Z39.50 filter does repeated Z39.50 present requests
429 to fetch all records. Needed when a Z39.50 server returns partial
430 results (due to message size limits).
434 Metaproxy now kills all child processes that are spawned by
435 modules (in case of fork, exec).
439 Debian package now installs /etc/metaproxy/metaproxy.xml which
440 includes all XML files /etc/metaproxy/filters-enabled .
441 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
445 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
446 development package to facilitate 3rd party Metaproxy modules.
448 --- 1.0.23 2010/01/04
450 Filter virt_db: Close backend filter session when Init rejected is received
451 from it (in which case it's not really closed yet). This will ensure we don't
452 run out of resources such as FDs in this case.
454 sru_z3950 filter: Accept any database (including those not listed).
456 --- 1.0.22 2009/12/03
458 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
459 later which means YAZ 3.0.47 or later.
461 --- 1.0.20 2009/11/19
463 For filter virt_db, the database is a glob pattern and the virtual
464 database sections are consulted in the order given.
466 --- 1.0.19 2009/07/08
468 For filter multi, the target (for routing) may be given as a glob-pattern.
470 More documentation for filters virt_db and multi.
472 Update schema to allow for no database in sru_z3950 filter.
474 --- 1.0.18 2009/06/30
476 Added limit filter to put sleep (penalty) for heavy use.
478 Filter frontend_net may be configured to limit the number of new connections
479 from same IP to some value (connect-max).
481 Fixed the load_balance filter.
483 --- 1.0.17 2009/06/16
485 Fix path for metaproxy executable for Debian init.d script.
487 --- 1.0.16 2009/06/10
489 SRU to Z39.50 filter honors x-username and x-password. If only
490 x-username is given that translates to open authentication (Z39.50v2). If
491 both x-username and x-password is present that translates to idPass
492 authentication (Z39.50v3).
494 New facility to change current working directory (-w).
496 Update to upstream skeleton of init.d script. Should fix bug #2619.
498 Filter session_shared now caches records (used to only cache connections
501 Filter session_shared now invalidates a Z39.50 session if a server
502 returns -1 hits. This facility was also part of yazproxy and gets around
503 a bug in Voyager-based Z39.50 servers.
505 --- 1.0.15 2008/11/18
507 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
509 --- 1.0.14 2008/06/09
511 Fixed the value of SRU record schema in searchRetrieve response. It was set
512 to a fixed value of "dc" before.
514 Serialize identical SRU requests. This is useful if HTTP client software
515 fires identical requests against metaproxy.
517 Allow Z39.50 target to be specified for SRU requests by using SRU extra
518 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
519 avoid static configuration. This facility is handled by the sru_z3950 module
520 and the z3950_client module.
522 Allow maximum number of sockets to be used for a Z39.50 client by the
523 use of SRU extra parameter x-max-sockets. This facility is handled by the
524 sru_z3950 module and the z3950_client module.
526 --- 1.0.13.1 2008/02/29
528 Simplified check for Boost libraries.
530 --- 1.0.13 2008/02/29
532 First Debian package.
534 The sru_z9350 filter now recognizes SRU parameter z-target as being
535 a ZURL of the form host/database .
537 Mergetype may be specified for filter 'multi'.
539 --- 1.0.12 2007/09/19
541 Fixed problem in Makefile WRT library specifictions. This could produce
542 linker errors (when they should not happen).
544 Fixed bug #1341: MetaProxy returning different results. Problem was that
545 fix-up of record database did not normalize the database name.
547 Documentation updates for Windows compilation.
549 --- 1.0.11 2007/06/14
551 Fixed problem with logfile being truncated.
553 --- 1.0.10 2007/05/23
555 Fixed bug #1136: Access rights not enforced.
557 Extension for log module. The log category 'access' logs more details.
558 New category 'user-access' added which is simlar to 'access' but adds
559 the Z39.50 user as for all entries in a session.
563 Added support for configurable default/force target/vhost for module Z39.50
568 Implemented filter, session_shared, which optimizes usage of Z39.50
569 sessions and result sets.
571 New filter, record_transform, which converts MARC/XML records.
573 New filter, sru_z3950, which converts SRU to Z39.50 packages.
575 New filter, load_balance, in development.
577 New filter, zeerex_xplain.
579 XML framework for config files started.
581 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
582 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
583 XML config files are checked against RNG and XML Schema's.
585 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
586 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
587 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
588 explain record to YAZ CQL-to-PQF text config file.
592 Added 'timeout' setting for filter frontend_net which specifies the number
593 of seconds a session is idle before it is closed. Default timeout is
598 Database name in records returned set for virt_db/multi filters.
600 Filter session_shared now functional.
602 Log filter can be configured to write to a given file using 'filename'
603 element. Also information category can be specified with 'category'. If
604 filename is omitted, the log filter writes to stdout. See etc/config5.xml
609 Fixed compilation on Windows.
613 Added documentation for the hidenavailable option for the multi filter.
617 Fixed bug #573: Hide errors for individual servers. If the element
618 'hideunavailable' is given in the configuration, individual servers
619 being unavailable are hidden (unless all are unavailable).
621 Fixed bug #574: Database names are recognised case-sensitively.
623 Fixed bug #567: Fix up database name in Name-Plus-Record.
625 Fixed bug #568: Update win/makefile for VS 2005.
627 Fixed bug #569: Some options throws unknown exception.
631 More information about virtual hosts. The 'etc' directory is part of the
636 Build instructions for Windows. NMake makefile part of distribution tar.
642 Filters functional: auth_simple, backend_test, frontend_net, http_file,
643 log, multi, query_rewrite, template, virt_db, z3950_client.
645 Filters in development: session_shared.
647 Pseudo-filters: template, dl