3 New class, wrbuf, that wraps YAZ' WRBUF.
7 Metaproxy daemon is now running as user "metaproxy". This user is
8 managed by package maintainer scripts. The user information is stored
9 in /etc/metaproxy/metaproxy.user .
13 New filter, sort, that allows sorting of XML records via Z39.50
16 Filter record_transform: USEMarcon support. For example:
17 <retrieval syntax="usmarc">
18 <backend syntax="unimarc" name="F">
19 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
23 Filter multi: empty route pattern uses route as default.
25 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
26 may use the shorter notation
27 <target route="z3950.indexdata.com"/>
29 Filter query_rewrite: use config path to locate XSLT.
31 Filter frontend_net: log statistics.
32 If a custom message element in frontend_net configuration it makes
33 the frontend_net filter produce a log entry whenever an operation
34 is completed. The log is always written using yaz_log with the
35 custom message given, the package ID (session ID) , the time
36 the operation has been active (end-to-end) , the threads currently
37 active/total and the size of the request input/output queues.
39 query_rewrite: charset conversion of query terms.
40 This is an optional feature. Enabled by element <charset> in
41 configuration with attribute 'from' and 'to' that specifies
42 from/to encodings. The default 'from' encoding is UTF-8.
44 Filter record_transform: honor piggyback searches.
46 Filter zoom: re-connect when database is reused.
47 Re-connect is necessary if a connection is lost or a timeout occurs.
48 If not, we'll be seeing zero hits, when we shouldn't.
52 zoom: Change scheme for dealing with content proxy URLs. The module
53 now has its own common XSL transform that is enabled by record_xsl
54 attribute in the configuration. This XSL gets parameter cproxyhost
55 that holds the host for the content proxy session . The genearted-url
56 is created only if urlRecipe is enabled. In previous version default
57 value of urlRecipe was ${md-electronic-url}; it is now empty and
58 disabled by default. Also generated-url no longer includes the content
59 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
62 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
63 connections. Default value is 40 (seconds).
65 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
66 "Malformed query" for syntax errors and related ones; throw
67 Bib-1: 3 "Unsupported search" for everything else. Details from
68 the CCL parser is provided as additional-info.
70 multi: new setting hideerrors that makes multi only relay diagnostics
71 to a client if all backends fail.
75 zoom: empty ccl_map field-mappings disables CCL map.
77 zoom: fix Explain search that could return error if session was
82 zoom: returns Explain records for database IR-Explain---1. The
83 target profile records are converted to Explain records via XSLT.
85 session_shared: make error recovery configurable. Whether a search
86 is restarted on errors or not, is configurable by attribute "restart"
87 in element "resultset" in configuration.
89 session_shared: only relay init for first request. session_shared, for
90 each backend class, now only relays first init request (rather than all).
91 The module only needs to save init response info once. This avoids the
92 need to check for session max.
96 zoom: fix memory leaks.
98 session_shared: maximum number of sessons is configurable. Default
99 value is 100. Result-sets for backends without named result sets are
100 only re-used if databases is identical for a search. This is under the
101 assumption that performance may suffer for those backends when
102 changing the database for each search.
104 multi: combines diagnostics from all backends. All diagnostics from
105 backends are combined into multiple non-surrogate diagnostics; rather
106 than just one diagnostic from first backend.
108 --- 1.3.21 2011/12/27
110 zoom: relay realm to cproxy parameter file.
112 Configuration: Allow filter collection element inside route. This
113 makes it possible to include multiple filters at once.
115 zoom: nocproxy also disables urlRecipe.
117 --- 1.3.20 2011/12/21
119 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
120 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
121 90: "Unsupported direction value".
123 zoom: honor database argument nocproxy. This disables creating a content
124 connector session (for non-CF targets, usually) and also relays nocproxy
125 as database argument to a CF target.
127 --- 1.3.19 2011/12/16
129 zoom: Multiple proxy hosts may be given for proxy rich database
130 parameter. List is comma separated.
132 http_file: decodes URI paths properly. Does not return 404: not found
133 if no prefix are matches. Instead packages are passed on.
135 --- 1.3.18 2011/12/08
137 zoom: content-{user,password,proxy} are passed on to content proxy
138 system and takes precedence over user,password,proxy .
140 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
141 with a log element including log material from children filters. At
142 this point, only the zoom filter uses this log facility. It will
143 eventually be used by other filters as well. In particular it might be
144 useful for this feature to track all filters in used during a search.
146 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
147 and queries as they are manipulated are logged.
149 zoom: extend addinfo with native diagnostics. Diagnostics as received
150 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
151 diagnostics. This indicates both a backend diagnostic and the original
154 zoom: default urlRecipe value is ${md-electronic-url}
156 zoom: target profile setting sruVersion is recognized.
158 --- 1.3.17 2011/11/17
160 zoom: log target profile record fetched (AKA Torus).
162 --- 1.3.16 2011/11/17
164 Change target profile parameter CfSubDb to CfSubDB.
166 --- 1.3.15 2011/11/12
168 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
169 makes sense to the zoom module itself).
171 --- 1.3.14 2011/11/11
173 zoom: realm may be given as part of database.
175 --- 1.3.13 2011/10/26
177 Fix Origin class assigment method; was removd by mistake in 1.3.12.
179 --- 1.3.12 2011/10/26
181 zoom: database args x-name=value are passed through to backend database.
183 SRU filter: user may specify session ID that is passed to log entries
184 that follows. It is specified by using x-session-id in the SRU arguments.
186 zoom: fix null pointer reference which would occur for bad url parameter
187 inside "torus" or if url was not given.
189 --- 1.3.11 2011/09/09
190 Fix bug in filter session_shared where sessions would not expire
191 properly (session ttl). This in turn could make the target close the
192 connection before expected and session_shared would return diagnostic
193 2: system temporarily available.
195 --- 1.3.10 2011/09/09
197 zoom: new target profile setting: sortmap_field. If sortmap_field is given
198 the field is mapped to the value for the sortmap. Values not matching
199 sortmap_field are passed verbatim.
201 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
202 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
203 depending on whether RPN or CQL is actually sent to the target.
207 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
209 zoom: For content proxy authentication is stored in param name
210 "auth", instead of "authentication".
214 zoom: relay schema in SRU mode. Previously recordSchema was not affected
219 zoom: new target profile element literalTransform that holds XSLT
220 (encoded as string) for target. Only if present and non-zero length it is
221 considered present. This takes precedence over transform.
223 Don't rely on trang anymore for Git checkout builds. Configuration in etc
224 will only be properly validated if trang is available. From now on only
225 relax NC files are bundled with the source dist.
227 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
228 component was not detected when it should be.
232 z3950_client: mark non-surrogate diagnostics from backend.
234 zoom: a proxy may be specified for HTTP fetch of target profiles.
238 Honor piggyback. Makes some SRU targets behave that insist on
239 maximumRecords > 0, but also increases performance.
243 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
244 file was not update for libdir/metaproxy4 in version 1.3.2.
248 Change location of Metaproxy modules from libdir/metaproxy to
249 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
250 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
252 New facility to dump APDUs from zoom filter. Enabled by
253 <log apdu="true"/> in the zoom filter configuation.
255 zoom filter bug fix: SRU diagnostics received from backend was
256 not properly converted to Bib-1 diagnostics.
258 Package metaproxy depends on libmetaproxy4, same version.
262 zoom: fix a bug WRT passing authentication parameters to backends.
266 Fixes for windows Makefile.
268 --- 1.2.10 2011/07/25
270 Change major version of metaproxy library from 3 to 4. This in turn
271 makes new package names for Debian and RPM.
275 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
278 zoom: configurable element sets for record transforms.
280 zoom: the target profile based transform is specified by element_transform
281 in element torus of of the ZOOM filter configuration ; default value
282 is "pz2". Target profile based retrieval is specified by element_raw
283 in configuration. It will perform same steps, but omit the XSL transform.
284 Default value is "raw".
286 zoom: element set is omitted if not set in profile. But only if pz2
287 transform is in effect. Previously the default element set was to "F".
289 zoom: For non-CF targets database arguments are parsed. User may supply
290 db,user=myuser&password=mypass for non-CF targets. These values override
291 what's given the authentication from the target profile.
293 session_shared: fix reference to freed memory. Would occur if a search
294 response had non-surrogate diagnostics.
298 Route may be given for each port in frontend_net.
302 Documentation for zoom filter. Local target profiles may be specified.
304 Fixes for zoom filter.
308 First version with zoom filter.
312 Filter z3950_client may be configured to always send a close APDU
313 to backend target when connection/session is closed. This will only
314 happen if close APDU is not already sent. Enabled by configuration
315 for z3950_client (force_close).
317 Filter virt_db and multi: relay close APDU.
319 Filter virt_db and multi: relay init size parameters
320 preferredMessageSize and maximumRecordSize.
322 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
326 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
328 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
329 as determined by configure.
331 RPM: Release includes 'indexdata' name. Use indexdata in release name so
332 this package can be distinguished from other vendors.
336 Fix filter multi: relay idAuthentication parameters.
340 Add metaproxy-config for returning compiler flags, libraries.
344 Fix --with-boost=PREFIX .
348 session_shared: fix use of maintenance thread.
350 Introduce 'start' method for filters and routers. It gets called after
351 configure and after fork, but before processing. This changes API -
352 from libmetaproxy2 to libmetaproxy3.
356 session_shared: ensure backend session is closed if init rejected
359 z3950_client: fix NULL ptr reference that could occur if two clients
360 connected concurrently and if max-sockets was in effect.
364 Fix bug 3497 - Metaproxy unstable while stopping.
366 Fix bug 3495 - SEGV in SRU filter.
370 Filter multi throws diagnostic 'Present Out of Range' when
371 appropriate - rather than returning 0 records.
373 Filter virt_db: fix bad result reuse. Could happen if a result
374 was overriden and a backend did not supported named result sets.
378 Filter log: category access logs diagnostics even if searchStatus
379 or presentStatus is 'success'.
383 The SRU to Z39.50 filter does repeated Z39.50 present requests
384 to fetch all records. Needed when a Z39.50 server returns partial
385 results (due to message size limits).
389 Metaproxy now kills all child processes that are spawned by
390 modules (in case of fork, exec).
394 Debian package now installs /etc/metaproxy/metaproxy.xml which
395 includes all XML files /etc/metaproxy/filters-enabled .
396 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
400 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
401 development package to facilitate 3rd party Metaproxy modules.
403 --- 1.0.23 2010/01/04
405 Filter virt_db: Close backend filter session when Init rejected is received
406 from it (in which case it's not really closed yet). This will ensure we don't
407 run out of resources such as FDs in this case.
409 sru_z3950 filter: Accept any database (including those not listed).
411 --- 1.0.22 2009/12/03
413 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
414 later which means YAZ 3.0.47 or later.
416 --- 1.0.20 2009/11/19
418 For filter virt_db, the database is a glob pattern and the virtual
419 database sections are consulted in the order given.
421 --- 1.0.19 2009/07/08
423 For filter multi, the target (for routing) may be given as a glob-pattern.
425 More documentation for filters virt_db and multi.
427 Update schema to allow for no database in sru_z3950 filter.
429 --- 1.0.18 2009/06/30
431 Added limit filter to put sleep (penalty) for heavy use.
433 Filter frontend_net may be configured to limit the number of new connections
434 from same IP to some value (connect-max).
436 Fixed the load_balance filter.
438 --- 1.0.17 2009/06/16
440 Fix path for metaproxy executable for Debian init.d script.
442 --- 1.0.16 2009/06/10
444 SRU to Z39.50 filter honors x-username and x-password. If only
445 x-username is given that translates to open authentication (Z39.50v2). If
446 both x-username and x-password is present that translates to idPass
447 authentication (Z39.50v3).
449 New facility to change current working directory (-w).
451 Update to upstream skeleton of init.d script. Should fix bug #2619.
453 Filter session_shared now caches records (used to only cache connections
456 Filter session_shared now invalidates a Z39.50 session if a server
457 returns -1 hits. This facility was also part of yazproxy and gets around
458 a bug in Voyager-based Z39.50 servers.
460 --- 1.0.15 2008/11/18
462 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
464 --- 1.0.14 2008/06/09
466 Fixed the value of SRU record schema in searchRetrieve response. It was set
467 to a fixed value of "dc" before.
469 Serialize identical SRU requests. This is useful if HTTP client software
470 fires identical requests against metaproxy.
472 Allow Z39.50 target to be specified for SRU requests by using SRU extra
473 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
474 avoid static configuration. This facility is handled by the sru_z3950 module
475 and the z3950_client module.
477 Allow maximum number of sockets to be used for a Z39.50 client by the
478 use of SRU extra parameter x-max-sockets. This facility is handled by the
479 sru_z3950 module and the z3950_client module.
481 --- 1.0.13.1 2008/02/29
483 Simplified check for Boost libraries.
485 --- 1.0.13 2008/02/29
487 First Debian package.
489 The sru_z9350 filter now recognizes SRU parameter z-target as being
490 a ZURL of the form host/database .
492 Mergetype may be specified for filter 'multi'.
494 --- 1.0.12 2007/09/19
496 Fixed problem in Makefile WRT library specifictions. This could produce
497 linker errors (when they should not happen).
499 Fixed bug #1341: MetaProxy returning different results. Problem was that
500 fix-up of record database did not normalize the database name.
502 Documentation updates for Windows compilation.
504 --- 1.0.11 2007/06/14
506 Fixed problem with logfile being truncated.
508 --- 1.0.10 2007/05/23
510 Fixed bug #1136: Access rights not enforced.
512 Extension for log module. The log category 'access' logs more details.
513 New category 'user-access' added which is simlar to 'access' but adds
514 the Z39.50 user as for all entries in a session.
518 Added support for configurable default/force target/vhost for module Z39.50
523 Implemented filter, session_shared, which optimizes usage of Z39.50
524 sessions and result sets.
526 New filter, record_transform, which converts MARC/XML records.
528 New filter, sru_z3950, which converts SRU to Z39.50 packages.
530 New filter, load_balance, in development.
532 New filter, zeerex_xplain.
534 XML framework for config files started.
536 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
537 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
538 XML config files are checked against RNG and XML Schema's.
540 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
541 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
542 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
543 explain record to YAZ CQL-to-PQF text config file.
547 Added 'timeout' setting for filter frontend_net which specifies the number
548 of seconds a session is idle before it is closed. Default timeout is
553 Database name in records returned set for virt_db/multi filters.
555 Filter session_shared now functional.
557 Log filter can be configured to write to a given file using 'filename'
558 element. Also information category can be specified with 'category'. If
559 filename is omitted, the log filter writes to stdout. See etc/config5.xml
564 Fixed compilation on Windows.
568 Added documentation for the hidenavailable option for the multi filter.
572 Fixed bug #573: Hide errors for individual servers. If the element
573 'hideunavailable' is given in the configuration, individual servers
574 being unavailable are hidden (unless all are unavailable).
576 Fixed bug #574: Database names are recognised case-sensitively.
578 Fixed bug #567: Fix up database name in Name-Plus-Record.
580 Fixed bug #568: Update win/makefile for VS 2005.
582 Fixed bug #569: Some options throws unknown exception.
586 More information about virtual hosts. The 'etc' directory is part of the
591 Build instructions for Windows. NMake makefile part of distribution tar.
597 Filters functional: auth_simple, backend_test, frontend_net, http_file,
598 log, multi, query_rewrite, template, virt_db, z3950_client.
600 Filters in development: session_shared.
602 Pseudo-filters: template, dl