2 metaproxy init script reacts to reload which does graceful stop +
3 start and is used by logrorate script.
7 Fixes for Windows compilation.
9 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
10 existing sessions running but terminate the monitor process that is
11 used in keepalive mode.
13 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
14 before. Consistent with 'metaproxy stop' message.
16 zoom: document zoom's proxy_timeout
18 z3950_client: fixup addinfo for init response
20 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
21 "Access to specified database denied" is returned, but only if init
22 response from backend does not carry diagnostics already.
24 multi: relays user info for first rejected target. The other-information
25 field for init response for first rejected target is in common init
26 response. This ensures that some backend init diagnostics are returned to
31 frontend_log: extend logging (when message is given in config).
35 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
39 sru_z3950 filter passes through incoming Z39.50 requests again. Was
40 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
44 zoom: fixes for retry/proxy failover logic. More logging.
48 zoom: return addinfo="proxy failure" for proxy failures. This also
49 changes the scheme for dealing with proxies a bit. zoom now always
50 do proxy check, even if there's no failover. Fortunately, that's not
53 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
54 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
55 generic. We don't know why the init would fail; IP, user, block IP, etc.
56 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
58 zoom: guess if invalid SRU response was an auth failure
60 session_shared: disable session retry by default . Can be enabled by
61 restart="true" in resultset section.
65 zoom: may read cf-proxy's config settings.
66 This reduces manual configuration of the content proxy server host.
67 The ZOOM module will use the old style session.proxyhost if "server"
68 is given (deprecated) and use the new style proxyhost/session if
69 "config_file" is in use.
71 frontend_net: remove incoming requests that can not be handled
72 Requests in queue for filter frontend_net are removed if client
73 closes connection for the session and request is not yet handled.
75 sru_z3950: serialize requests. This is to ensure that pipelined
76 HTTP requests are handled properly.
80 New class, wrbuf, that wraps YAZ' WRBUF.
84 Metaproxy daemon is now running as user "metaproxy". This user is
85 managed by package maintainer scripts. The user information is stored
86 in /etc/metaproxy/metaproxy.user .
90 New filter, sort, that allows sorting of XML records via Z39.50
93 Filter record_transform: USEMarcon support. For example:
94 <retrieval syntax="usmarc">
95 <backend syntax="unimarc" name="F">
96 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
100 Filter multi: empty route pattern uses route as default.
102 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
103 may use the shorter notation
104 <target route="z3950.indexdata.com"/>
106 Filter query_rewrite: use config path to locate XSLT.
108 Filter frontend_net: log statistics.
109 If a custom message element in frontend_net configuration it makes
110 the frontend_net filter produce a log entry whenever an operation
111 is completed. The log is always written using yaz_log with the
112 custom message given, the package ID (session ID) , the time
113 the operation has been active (end-to-end) , the threads currently
114 active/total and the size of the request input/output queues.
116 query_rewrite: charset conversion of query terms.
117 This is an optional feature. Enabled by element <charset> in
118 configuration with attribute 'from' and 'to' that specifies
119 from/to encodings. The default 'from' encoding is UTF-8.
121 Filter record_transform: honor piggyback searches.
123 Filter zoom: re-connect when database is reused.
124 Re-connect is necessary if a connection is lost or a timeout occurs.
125 If not, we'll be seeing zero hits, when we shouldn't.
127 --- 1.3.25 2012/02/29
129 zoom: Change scheme for dealing with content proxy URLs. The module
130 now has its own common XSL transform that is enabled by record_xsl
131 attribute in the configuration. This XSL gets parameter cproxyhost
132 that holds the host for the content proxy session . The genearted-url
133 is created only if urlRecipe is enabled. In previous version default
134 value of urlRecipe was ${md-electronic-url}; it is now empty and
135 disabled by default. Also generated-url no longer includes the content
136 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
139 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
140 connections. Default value is 40 (seconds).
142 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
143 "Malformed query" for syntax errors and related ones; throw
144 Bib-1: 3 "Unsupported search" for everything else. Details from
145 the CCL parser is provided as additional-info.
147 multi: new setting hideerrors that makes multi only relay diagnostics
148 to a client if all backends fail.
150 --- 1.3.24 2012/02/23
152 zoom: empty ccl_map field-mappings disables CCL map.
154 zoom: fix Explain search that could return error if session was
157 --- 1.3.23 2012/02/10
159 zoom: returns Explain records for database IR-Explain---1. The
160 target profile records are converted to Explain records via XSLT.
162 session_shared: make error recovery configurable. Whether a search
163 is restarted on errors or not, is configurable by attribute "restart"
164 in element "resultset" in configuration.
166 session_shared: only relay init for first request. session_shared, for
167 each backend class, now only relays first init request (rather than all).
168 The module only needs to save init response info once. This avoids the
169 need to check for session max.
171 --- 1.3.22 2012/02/02
173 zoom: fix memory leaks.
175 session_shared: maximum number of sessons is configurable. Default
176 value is 100. Result-sets for backends without named result sets are
177 only re-used if databases is identical for a search. This is under the
178 assumption that performance may suffer for those backends when
179 changing the database for each search.
181 multi: combines diagnostics from all backends. All diagnostics from
182 backends are combined into multiple non-surrogate diagnostics; rather
183 than just one diagnostic from first backend.
185 --- 1.3.21 2011/12/27
187 zoom: relay realm to cproxy parameter file.
189 Configuration: Allow filter collection element inside route. This
190 makes it possible to include multiple filters at once.
192 zoom: nocproxy also disables urlRecipe.
194 --- 1.3.20 2011/12/21
196 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
197 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
198 90: "Unsupported direction value".
200 zoom: honor database argument nocproxy. This disables creating a content
201 connector session (for non-CF targets, usually) and also relays nocproxy
202 as database argument to a CF target.
204 --- 1.3.19 2011/12/16
206 zoom: Multiple proxy hosts may be given for proxy rich database
207 parameter. List is comma separated.
209 http_file: decodes URI paths properly. Does not return 404: not found
210 if no prefix are matches. Instead packages are passed on.
212 --- 1.3.18 2011/12/08
214 zoom: content-{user,password,proxy} are passed on to content proxy
215 system and takes precedence over user,password,proxy .
217 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
218 with a log element including log material from children filters. At
219 this point, only the zoom filter uses this log facility. It will
220 eventually be used by other filters as well. In particular it might be
221 useful for this feature to track all filters in used during a search.
223 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
224 and queries as they are manipulated are logged.
226 zoom: extend addinfo with native diagnostics. Diagnostics as received
227 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
228 diagnostics. This indicates both a backend diagnostic and the original
231 zoom: default urlRecipe value is ${md-electronic-url}
233 zoom: target profile setting sruVersion is recognized.
235 --- 1.3.17 2011/11/17
237 zoom: log target profile record fetched (AKA Torus).
239 --- 1.3.16 2011/11/17
241 Change target profile parameter CfSubDb to CfSubDB.
243 --- 1.3.15 2011/11/12
245 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
246 makes sense to the zoom module itself).
248 --- 1.3.14 2011/11/11
250 zoom: realm may be given as part of database.
252 --- 1.3.13 2011/10/26
254 Fix Origin class assigment method; was removd by mistake in 1.3.12.
256 --- 1.3.12 2011/10/26
258 zoom: database args x-name=value are passed through to backend database.
260 SRU filter: user may specify session ID that is passed to log entries
261 that follows. It is specified by using x-session-id in the SRU arguments.
263 zoom: fix null pointer reference which would occur for bad url parameter
264 inside "torus" or if url was not given.
266 --- 1.3.11 2011/09/09
267 Fix bug in filter session_shared where sessions would not expire
268 properly (session ttl). This in turn could make the target close the
269 connection before expected and session_shared would return diagnostic
270 2: system temporarily available.
272 --- 1.3.10 2011/09/09
274 zoom: new target profile setting: sortmap_field. If sortmap_field is given
275 the field is mapped to the value for the sortmap. Values not matching
276 sortmap_field are passed verbatim.
278 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
279 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
280 depending on whether RPN or CQL is actually sent to the target.
284 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
286 zoom: For content proxy authentication is stored in param name
287 "auth", instead of "authentication".
291 zoom: relay schema in SRU mode. Previously recordSchema was not affected
296 zoom: new target profile element literalTransform that holds XSLT
297 (encoded as string) for target. Only if present and non-zero length it is
298 considered present. This takes precedence over transform.
300 Don't rely on trang anymore for Git checkout builds. Configuration in etc
301 will only be properly validated if trang is available. From now on only
302 relax NC files are bundled with the source dist.
304 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
305 component was not detected when it should be.
309 z3950_client: mark non-surrogate diagnostics from backend.
311 zoom: a proxy may be specified for HTTP fetch of target profiles.
315 Honor piggyback. Makes some SRU targets behave that insist on
316 maximumRecords > 0, but also increases performance.
320 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
321 file was not update for libdir/metaproxy4 in version 1.3.2.
325 Change location of Metaproxy modules from libdir/metaproxy to
326 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
327 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
329 New facility to dump APDUs from zoom filter. Enabled by
330 <log apdu="true"/> in the zoom filter configuation.
332 zoom filter bug fix: SRU diagnostics received from backend was
333 not properly converted to Bib-1 diagnostics.
335 Package metaproxy depends on libmetaproxy4, same version.
339 zoom: fix a bug WRT passing authentication parameters to backends.
343 Fixes for windows Makefile.
345 --- 1.2.10 2011/07/25
347 Change major version of metaproxy library from 3 to 4. This in turn
348 makes new package names for Debian and RPM.
352 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
355 zoom: configurable element sets for record transforms.
357 zoom: the target profile based transform is specified by element_transform
358 in element torus of of the ZOOM filter configuration ; default value
359 is "pz2". Target profile based retrieval is specified by element_raw
360 in configuration. It will perform same steps, but omit the XSL transform.
361 Default value is "raw".
363 zoom: element set is omitted if not set in profile. But only if pz2
364 transform is in effect. Previously the default element set was to "F".
366 zoom: For non-CF targets database arguments are parsed. User may supply
367 db,user=myuser&password=mypass for non-CF targets. These values override
368 what's given the authentication from the target profile.
370 session_shared: fix reference to freed memory. Would occur if a search
371 response had non-surrogate diagnostics.
375 Route may be given for each port in frontend_net.
379 Documentation for zoom filter. Local target profiles may be specified.
381 Fixes for zoom filter.
385 First version with zoom filter.
389 Filter z3950_client may be configured to always send a close APDU
390 to backend target when connection/session is closed. This will only
391 happen if close APDU is not already sent. Enabled by configuration
392 for z3950_client (force_close).
394 Filter virt_db and multi: relay close APDU.
396 Filter virt_db and multi: relay init size parameters
397 preferredMessageSize and maximumRecordSize.
399 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
403 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
405 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
406 as determined by configure.
408 RPM: Release includes 'indexdata' name. Use indexdata in release name so
409 this package can be distinguished from other vendors.
413 Fix filter multi: relay idAuthentication parameters.
417 Add metaproxy-config for returning compiler flags, libraries.
421 Fix --with-boost=PREFIX .
425 session_shared: fix use of maintenance thread.
427 Introduce 'start' method for filters and routers. It gets called after
428 configure and after fork, but before processing. This changes API -
429 from libmetaproxy2 to libmetaproxy3.
433 session_shared: ensure backend session is closed if init rejected
436 z3950_client: fix NULL ptr reference that could occur if two clients
437 connected concurrently and if max-sockets was in effect.
441 Fix bug 3497 - Metaproxy unstable while stopping.
443 Fix bug 3495 - SEGV in SRU filter.
447 Filter multi throws diagnostic 'Present Out of Range' when
448 appropriate - rather than returning 0 records.
450 Filter virt_db: fix bad result reuse. Could happen if a result
451 was overriden and a backend did not supported named result sets.
455 Filter log: category access logs diagnostics even if searchStatus
456 or presentStatus is 'success'.
460 The SRU to Z39.50 filter does repeated Z39.50 present requests
461 to fetch all records. Needed when a Z39.50 server returns partial
462 results (due to message size limits).
466 Metaproxy now kills all child processes that are spawned by
467 modules (in case of fork, exec).
471 Debian package now installs /etc/metaproxy/metaproxy.xml which
472 includes all XML files /etc/metaproxy/filters-enabled .
473 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
477 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
478 development package to facilitate 3rd party Metaproxy modules.
480 --- 1.0.23 2010/01/04
482 Filter virt_db: Close backend filter session when Init rejected is received
483 from it (in which case it's not really closed yet). This will ensure we don't
484 run out of resources such as FDs in this case.
486 sru_z3950 filter: Accept any database (including those not listed).
488 --- 1.0.22 2009/12/03
490 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
491 later which means YAZ 3.0.47 or later.
493 --- 1.0.20 2009/11/19
495 For filter virt_db, the database is a glob pattern and the virtual
496 database sections are consulted in the order given.
498 --- 1.0.19 2009/07/08
500 For filter multi, the target (for routing) may be given as a glob-pattern.
502 More documentation for filters virt_db and multi.
504 Update schema to allow for no database in sru_z3950 filter.
506 --- 1.0.18 2009/06/30
508 Added limit filter to put sleep (penalty) for heavy use.
510 Filter frontend_net may be configured to limit the number of new connections
511 from same IP to some value (connect-max).
513 Fixed the load_balance filter.
515 --- 1.0.17 2009/06/16
517 Fix path for metaproxy executable for Debian init.d script.
519 --- 1.0.16 2009/06/10
521 SRU to Z39.50 filter honors x-username and x-password. If only
522 x-username is given that translates to open authentication (Z39.50v2). If
523 both x-username and x-password is present that translates to idPass
524 authentication (Z39.50v3).
526 New facility to change current working directory (-w).
528 Update to upstream skeleton of init.d script. Should fix bug #2619.
530 Filter session_shared now caches records (used to only cache connections
533 Filter session_shared now invalidates a Z39.50 session if a server
534 returns -1 hits. This facility was also part of yazproxy and gets around
535 a bug in Voyager-based Z39.50 servers.
537 --- 1.0.15 2008/11/18
539 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
541 --- 1.0.14 2008/06/09
543 Fixed the value of SRU record schema in searchRetrieve response. It was set
544 to a fixed value of "dc" before.
546 Serialize identical SRU requests. This is useful if HTTP client software
547 fires identical requests against metaproxy.
549 Allow Z39.50 target to be specified for SRU requests by using SRU extra
550 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
551 avoid static configuration. This facility is handled by the sru_z3950 module
552 and the z3950_client module.
554 Allow maximum number of sockets to be used for a Z39.50 client by the
555 use of SRU extra parameter x-max-sockets. This facility is handled by the
556 sru_z3950 module and the z3950_client module.
558 --- 1.0.13.1 2008/02/29
560 Simplified check for Boost libraries.
562 --- 1.0.13 2008/02/29
564 First Debian package.
566 The sru_z9350 filter now recognizes SRU parameter z-target as being
567 a ZURL of the form host/database .
569 Mergetype may be specified for filter 'multi'.
571 --- 1.0.12 2007/09/19
573 Fixed problem in Makefile WRT library specifictions. This could produce
574 linker errors (when they should not happen).
576 Fixed bug #1341: MetaProxy returning different results. Problem was that
577 fix-up of record database did not normalize the database name.
579 Documentation updates for Windows compilation.
581 --- 1.0.11 2007/06/14
583 Fixed problem with logfile being truncated.
585 --- 1.0.10 2007/05/23
587 Fixed bug #1136: Access rights not enforced.
589 Extension for log module. The log category 'access' logs more details.
590 New category 'user-access' added which is simlar to 'access' but adds
591 the Z39.50 user as for all entries in a session.
595 Added support for configurable default/force target/vhost for module Z39.50
600 Implemented filter, session_shared, which optimizes usage of Z39.50
601 sessions and result sets.
603 New filter, record_transform, which converts MARC/XML records.
605 New filter, sru_z3950, which converts SRU to Z39.50 packages.
607 New filter, load_balance, in development.
609 New filter, zeerex_xplain.
611 XML framework for config files started.
613 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
614 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
615 XML config files are checked against RNG and XML Schema's.
617 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
618 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
619 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
620 explain record to YAZ CQL-to-PQF text config file.
624 Added 'timeout' setting for filter frontend_net which specifies the number
625 of seconds a session is idle before it is closed. Default timeout is
630 Database name in records returned set for virt_db/multi filters.
632 Filter session_shared now functional.
634 Log filter can be configured to write to a given file using 'filename'
635 element. Also information category can be specified with 'category'. If
636 filename is omitted, the log filter writes to stdout. See etc/config5.xml
641 Fixed compilation on Windows.
645 Added documentation for the hidenavailable option for the multi filter.
649 Fixed bug #573: Hide errors for individual servers. If the element
650 'hideunavailable' is given in the configuration, individual servers
651 being unavailable are hidden (unless all are unavailable).
653 Fixed bug #574: Database names are recognised case-sensitively.
655 Fixed bug #567: Fix up database name in Name-Plus-Record.
657 Fixed bug #568: Update win/makefile for VS 2005.
659 Fixed bug #569: Some options throws unknown exception.
663 More information about virtual hosts. The 'etc' directory is part of the
668 Build instructions for Windows. NMake makefile part of distribution tar.
674 Filters functional: auth_simple, backend_test, frontend_net, http_file,
675 log, multi, query_rewrite, template, virt_db, z3950_client.
677 Filters in development: session_shared.
679 Pseudo-filters: template, dl