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