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