3 metaproxy init script reacts to reload which does graceful stop +
4 start and is used by logrorate script.
8 Fixes for Windows compilation.
10 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
11 existing sessions running but terminate the monitor process that is
12 used in keepalive mode.
14 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
15 before. Consistent with 'metaproxy stop' message.
17 zoom: document zoom's proxy_timeout
19 z3950_client: fixup addinfo for init response
21 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
22 "Access to specified database denied" is returned, but only if init
23 response from backend does not carry diagnostics already.
25 multi: relays user info for first rejected target. The other-information
26 field for init response for first rejected target is in common init
27 response. This ensures that some backend init diagnostics are returned to
32 frontend_log: extend logging (when message is given in config).
36 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
40 sru_z3950 filter passes through incoming Z39.50 requests again. Was
41 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
45 zoom: fixes for retry/proxy failover logic. More logging.
49 zoom: return addinfo="proxy failure" for proxy failures. This also
50 changes the scheme for dealing with proxies a bit. zoom now always
51 do proxy check, even if there's no failover. Fortunately, that's not
54 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
55 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
56 generic. We don't know why the init would fail; IP, user, block IP, etc.
57 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
59 zoom: guess if invalid SRU response was an auth failure
61 session_shared: disable session retry by default . Can be enabled by
62 restart="true" in resultset section.
66 zoom: may read cf-proxy's config settings.
67 This reduces manual configuration of the content proxy server host.
68 The ZOOM module will use the old style session.proxyhost if "server"
69 is given (deprecated) and use the new style proxyhost/session if
70 "config_file" is in use.
72 frontend_net: remove incoming requests that can not be handled
73 Requests in queue for filter frontend_net are removed if client
74 closes connection for the session and request is not yet handled.
76 sru_z3950: serialize requests. This is to ensure that pipelined
77 HTTP requests are handled properly.
81 New class, wrbuf, that wraps YAZ' WRBUF.
85 Metaproxy daemon is now running as user "metaproxy". This user is
86 managed by package maintainer scripts. The user information is stored
87 in /etc/metaproxy/metaproxy.user .
91 New filter, sort, that allows sorting of XML records via Z39.50
94 Filter record_transform: USEMarcon support. For example:
95 <retrieval syntax="usmarc">
96 <backend syntax="unimarc" name="F">
97 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
101 Filter multi: empty route pattern uses route as default.
103 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
104 may use the shorter notation
105 <target route="z3950.indexdata.com"/>
107 Filter query_rewrite: use config path to locate XSLT.
109 Filter frontend_net: log statistics.
110 If a custom message element in frontend_net configuration it makes
111 the frontend_net filter produce a log entry whenever an operation
112 is completed. The log is always written using yaz_log with the
113 custom message given, the package ID (session ID) , the time
114 the operation has been active (end-to-end) , the threads currently
115 active/total and the size of the request input/output queues.
117 query_rewrite: charset conversion of query terms.
118 This is an optional feature. Enabled by element <charset> in
119 configuration with attribute 'from' and 'to' that specifies
120 from/to encodings. The default 'from' encoding is UTF-8.
122 Filter record_transform: honor piggyback searches.
124 Filter zoom: re-connect when database is reused.
125 Re-connect is necessary if a connection is lost or a timeout occurs.
126 If not, we'll be seeing zero hits, when we shouldn't.
128 --- 1.3.25 2012/02/29
130 zoom: Change scheme for dealing with content proxy URLs. The module
131 now has its own common XSL transform that is enabled by record_xsl
132 attribute in the configuration. This XSL gets parameter cproxyhost
133 that holds the host for the content proxy session . The genearted-url
134 is created only if urlRecipe is enabled. In previous version default
135 value of urlRecipe was ${md-electronic-url}; it is now empty and
136 disabled by default. Also generated-url no longer includes the content
137 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
140 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
141 connections. Default value is 40 (seconds).
143 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
144 "Malformed query" for syntax errors and related ones; throw
145 Bib-1: 3 "Unsupported search" for everything else. Details from
146 the CCL parser is provided as additional-info.
148 multi: new setting hideerrors that makes multi only relay diagnostics
149 to a client if all backends fail.
151 --- 1.3.24 2012/02/23
153 zoom: empty ccl_map field-mappings disables CCL map.
155 zoom: fix Explain search that could return error if session was
158 --- 1.3.23 2012/02/10
160 zoom: returns Explain records for database IR-Explain---1. The
161 target profile records are converted to Explain records via XSLT.
163 session_shared: make error recovery configurable. Whether a search
164 is restarted on errors or not, is configurable by attribute "restart"
165 in element "resultset" in configuration.
167 session_shared: only relay init for first request. session_shared, for
168 each backend class, now only relays first init request (rather than all).
169 The module only needs to save init response info once. This avoids the
170 need to check for session max.
172 --- 1.3.22 2012/02/02
174 zoom: fix memory leaks.
176 session_shared: maximum number of sessons is configurable. Default
177 value is 100. Result-sets for backends without named result sets are
178 only re-used if databases is identical for a search. This is under the
179 assumption that performance may suffer for those backends when
180 changing the database for each search.
182 multi: combines diagnostics from all backends. All diagnostics from
183 backends are combined into multiple non-surrogate diagnostics; rather
184 than just one diagnostic from first backend.
186 --- 1.3.21 2011/12/27
188 zoom: relay realm to cproxy parameter file.
190 Configuration: Allow filter collection element inside route. This
191 makes it possible to include multiple filters at once.
193 zoom: nocproxy also disables urlRecipe.
195 --- 1.3.20 2011/12/21
197 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
198 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
199 90: "Unsupported direction value".
201 zoom: honor database argument nocproxy. This disables creating a content
202 connector session (for non-CF targets, usually) and also relays nocproxy
203 as database argument to a CF target.
205 --- 1.3.19 2011/12/16
207 zoom: Multiple proxy hosts may be given for proxy rich database
208 parameter. List is comma separated.
210 http_file: decodes URI paths properly. Does not return 404: not found
211 if no prefix are matches. Instead packages are passed on.
213 --- 1.3.18 2011/12/08
215 zoom: content-{user,password,proxy} are passed on to content proxy
216 system and takes precedence over user,password,proxy .
218 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
219 with a log element including log material from children filters. At
220 this point, only the zoom filter uses this log facility. It will
221 eventually be used by other filters as well. In particular it might be
222 useful for this feature to track all filters in used during a search.
224 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
225 and queries as they are manipulated are logged.
227 zoom: extend addinfo with native diagnostics. Diagnostics as received
228 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
229 diagnostics. This indicates both a backend diagnostic and the original
232 zoom: default urlRecipe value is ${md-electronic-url}
234 zoom: target profile setting sruVersion is recognized.
236 --- 1.3.17 2011/11/17
238 zoom: log target profile record fetched (AKA Torus).
240 --- 1.3.16 2011/11/17
242 Change target profile parameter CfSubDb to CfSubDB.
244 --- 1.3.15 2011/11/12
246 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
247 makes sense to the zoom module itself).
249 --- 1.3.14 2011/11/11
251 zoom: realm may be given as part of database.
253 --- 1.3.13 2011/10/26
255 Fix Origin class assigment method; was removd by mistake in 1.3.12.
257 --- 1.3.12 2011/10/26
259 zoom: database args x-name=value are passed through to backend database.
261 SRU filter: user may specify session ID that is passed to log entries
262 that follows. It is specified by using x-session-id in the SRU arguments.
264 zoom: fix null pointer reference which would occur for bad url parameter
265 inside "torus" or if url was not given.
267 --- 1.3.11 2011/09/09
268 Fix bug in filter session_shared where sessions would not expire
269 properly (session ttl). This in turn could make the target close the
270 connection before expected and session_shared would return diagnostic
271 2: system temporarily available.
273 --- 1.3.10 2011/09/09
275 zoom: new target profile setting: sortmap_field. If sortmap_field is given
276 the field is mapped to the value for the sortmap. Values not matching
277 sortmap_field are passed verbatim.
279 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
280 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
281 depending on whether RPN or CQL is actually sent to the target.
285 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
287 zoom: For content proxy authentication is stored in param name
288 "auth", instead of "authentication".
292 zoom: relay schema in SRU mode. Previously recordSchema was not affected
297 zoom: new target profile element literalTransform that holds XSLT
298 (encoded as string) for target. Only if present and non-zero length it is
299 considered present. This takes precedence over transform.
301 Don't rely on trang anymore for Git checkout builds. Configuration in etc
302 will only be properly validated if trang is available. From now on only
303 relax NC files are bundled with the source dist.
305 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
306 component was not detected when it should be.
310 z3950_client: mark non-surrogate diagnostics from backend.
312 zoom: a proxy may be specified for HTTP fetch of target profiles.
316 Honor piggyback. Makes some SRU targets behave that insist on
317 maximumRecords > 0, but also increases performance.
321 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
322 file was not update for libdir/metaproxy4 in version 1.3.2.
326 Change location of Metaproxy modules from libdir/metaproxy to
327 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
328 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
330 New facility to dump APDUs from zoom filter. Enabled by
331 <log apdu="true"/> in the zoom filter configuation.
333 zoom filter bug fix: SRU diagnostics received from backend was
334 not properly converted to Bib-1 diagnostics.
336 Package metaproxy depends on libmetaproxy4, same version.
340 zoom: fix a bug WRT passing authentication parameters to backends.
344 Fixes for windows Makefile.
346 --- 1.2.10 2011/07/25
348 Change major version of metaproxy library from 3 to 4. This in turn
349 makes new package names for Debian and RPM.
353 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
356 zoom: configurable element sets for record transforms.
358 zoom: the target profile based transform is specified by element_transform
359 in element torus of of the ZOOM filter configuration ; default value
360 is "pz2". Target profile based retrieval is specified by element_raw
361 in configuration. It will perform same steps, but omit the XSL transform.
362 Default value is "raw".
364 zoom: element set is omitted if not set in profile. But only if pz2
365 transform is in effect. Previously the default element set was to "F".
367 zoom: For non-CF targets database arguments are parsed. User may supply
368 db,user=myuser&password=mypass for non-CF targets. These values override
369 what's given the authentication from the target profile.
371 session_shared: fix reference to freed memory. Would occur if a search
372 response had non-surrogate diagnostics.
376 Route may be given for each port in frontend_net.
380 Documentation for zoom filter. Local target profiles may be specified.
382 Fixes for zoom filter.
386 First version with zoom filter.
390 Filter z3950_client may be configured to always send a close APDU
391 to backend target when connection/session is closed. This will only
392 happen if close APDU is not already sent. Enabled by configuration
393 for z3950_client (force_close).
395 Filter virt_db and multi: relay close APDU.
397 Filter virt_db and multi: relay init size parameters
398 preferredMessageSize and maximumRecordSize.
400 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
404 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
406 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
407 as determined by configure.
409 RPM: Release includes 'indexdata' name. Use indexdata in release name so
410 this package can be distinguished from other vendors.
414 Fix filter multi: relay idAuthentication parameters.
418 Add metaproxy-config for returning compiler flags, libraries.
422 Fix --with-boost=PREFIX .
426 session_shared: fix use of maintenance thread.
428 Introduce 'start' method for filters and routers. It gets called after
429 configure and after fork, but before processing. This changes API -
430 from libmetaproxy2 to libmetaproxy3.
434 session_shared: ensure backend session is closed if init rejected
437 z3950_client: fix NULL ptr reference that could occur if two clients
438 connected concurrently and if max-sockets was in effect.
442 Fix bug 3497 - Metaproxy unstable while stopping.
444 Fix bug 3495 - SEGV in SRU filter.
448 Filter multi throws diagnostic 'Present Out of Range' when
449 appropriate - rather than returning 0 records.
451 Filter virt_db: fix bad result reuse. Could happen if a result
452 was overriden and a backend did not supported named result sets.
456 Filter log: category access logs diagnostics even if searchStatus
457 or presentStatus is 'success'.
461 The SRU to Z39.50 filter does repeated Z39.50 present requests
462 to fetch all records. Needed when a Z39.50 server returns partial
463 results (due to message size limits).
467 Metaproxy now kills all child processes that are spawned by
468 modules (in case of fork, exec).
472 Debian package now installs /etc/metaproxy/metaproxy.xml which
473 includes all XML files /etc/metaproxy/filters-enabled .
474 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
478 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
479 development package to facilitate 3rd party Metaproxy modules.
481 --- 1.0.23 2010/01/04
483 Filter virt_db: Close backend filter session when Init rejected is received
484 from it (in which case it's not really closed yet). This will ensure we don't
485 run out of resources such as FDs in this case.
487 sru_z3950 filter: Accept any database (including those not listed).
489 --- 1.0.22 2009/12/03
491 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
492 later which means YAZ 3.0.47 or later.
494 --- 1.0.20 2009/11/19
496 For filter virt_db, the database is a glob pattern and the virtual
497 database sections are consulted in the order given.
499 --- 1.0.19 2009/07/08
501 For filter multi, the target (for routing) may be given as a glob-pattern.
503 More documentation for filters virt_db and multi.
505 Update schema to allow for no database in sru_z3950 filter.
507 --- 1.0.18 2009/06/30
509 Added limit filter to put sleep (penalty) for heavy use.
511 Filter frontend_net may be configured to limit the number of new connections
512 from same IP to some value (connect-max).
514 Fixed the load_balance filter.
516 --- 1.0.17 2009/06/16
518 Fix path for metaproxy executable for Debian init.d script.
520 --- 1.0.16 2009/06/10
522 SRU to Z39.50 filter honors x-username and x-password. If only
523 x-username is given that translates to open authentication (Z39.50v2). If
524 both x-username and x-password is present that translates to idPass
525 authentication (Z39.50v3).
527 New facility to change current working directory (-w).
529 Update to upstream skeleton of init.d script. Should fix bug #2619.
531 Filter session_shared now caches records (used to only cache connections
534 Filter session_shared now invalidates a Z39.50 session if a server
535 returns -1 hits. This facility was also part of yazproxy and gets around
536 a bug in Voyager-based Z39.50 servers.
538 --- 1.0.15 2008/11/18
540 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
542 --- 1.0.14 2008/06/09
544 Fixed the value of SRU record schema in searchRetrieve response. It was set
545 to a fixed value of "dc" before.
547 Serialize identical SRU requests. This is useful if HTTP client software
548 fires identical requests against metaproxy.
550 Allow Z39.50 target to be specified for SRU requests by using SRU extra
551 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
552 avoid static configuration. This facility is handled by the sru_z3950 module
553 and the z3950_client module.
555 Allow maximum number of sockets to be used for a Z39.50 client by the
556 use of SRU extra parameter x-max-sockets. This facility is handled by the
557 sru_z3950 module and the z3950_client module.
559 --- 1.0.13.1 2008/02/29
561 Simplified check for Boost libraries.
563 --- 1.0.13 2008/02/29
565 First Debian package.
567 The sru_z9350 filter now recognizes SRU parameter z-target as being
568 a ZURL of the form host/database .
570 Mergetype may be specified for filter 'multi'.
572 --- 1.0.12 2007/09/19
574 Fixed problem in Makefile WRT library specifictions. This could produce
575 linker errors (when they should not happen).
577 Fixed bug #1341: MetaProxy returning different results. Problem was that
578 fix-up of record database did not normalize the database name.
580 Documentation updates for Windows compilation.
582 --- 1.0.11 2007/06/14
584 Fixed problem with logfile being truncated.
586 --- 1.0.10 2007/05/23
588 Fixed bug #1136: Access rights not enforced.
590 Extension for log module. The log category 'access' logs more details.
591 New category 'user-access' added which is simlar to 'access' but adds
592 the Z39.50 user as for all entries in a session.
596 Added support for configurable default/force target/vhost for module Z39.50
601 Implemented filter, session_shared, which optimizes usage of Z39.50
602 sessions and result sets.
604 New filter, record_transform, which converts MARC/XML records.
606 New filter, sru_z3950, which converts SRU to Z39.50 packages.
608 New filter, load_balance, in development.
610 New filter, zeerex_xplain.
612 XML framework for config files started.
614 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
615 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
616 XML config files are checked against RNG and XML Schema's.
618 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
619 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
620 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
621 explain record to YAZ CQL-to-PQF text config file.
625 Added 'timeout' setting for filter frontend_net which specifies the number
626 of seconds a session is idle before it is closed. Default timeout is
631 Database name in records returned set for virt_db/multi filters.
633 Filter session_shared now functional.
635 Log filter can be configured to write to a given file using 'filename'
636 element. Also information category can be specified with 'category'. If
637 filename is omitted, the log filter writes to stdout. See etc/config5.xml
642 Fixed compilation on Windows.
646 Added documentation for the hidenavailable option for the multi filter.
650 Fixed bug #573: Hide errors for individual servers. If the element
651 'hideunavailable' is given in the configuration, individual servers
652 being unavailable are hidden (unless all are unavailable).
654 Fixed bug #574: Database names are recognised case-sensitively.
656 Fixed bug #567: Fix up database name in Name-Plus-Record.
658 Fixed bug #568: Update win/makefile for VS 2005.
660 Fixed bug #569: Some options throws unknown exception.
664 More information about virtual hosts. The 'etc' directory is part of the
669 Build instructions for Windows. NMake makefile part of distribution tar.
675 Filters functional: auth_simple, backend_test, frontend_net, http_file,
676 log, multi, query_rewrite, template, virt_db, z3950_client.
678 Filters in development: session_shared.
680 Pseudo-filters: template, dl