3 frontend_net: add facility to report live statistics about response
4 times and current thread usage. The report is an XML document
5 and is triggered for a specific URL path. This is set by <stat-req>
6 in the configuration of frontend_net. By default this report is
7 disabled (same as empty value for <stat-req>).
9 Fix reload problem in init.d script for RPM/Debian.
10 The '/etc/init.d/metaproxy reload' in some cases would stop but not
11 start metaproxy - effectively stopping the service.
13 Don't display start log message when config testing (-t).
15 zoom: avoid CCL message limit of 1K in ZOOM filter.
19 metaproxy init script reacts to reload which does graceful stop +
20 start and is used by logrorate script.
24 Fixes for Windows compilation.
26 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
27 existing sessions running but terminate the monitor process that is
28 used in keepalive mode.
30 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
31 before. Consistent with 'metaproxy stop' message.
33 zoom: document zoom's proxy_timeout
35 z3950_client: fixup addinfo for init response
37 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
38 "Access to specified database denied" is returned, but only if init
39 response from backend does not carry diagnostics already.
41 multi: relays user info for first rejected target. The other-information
42 field for init response for first rejected target is in common init
43 response. This ensures that some backend init diagnostics are returned to
48 frontend_log: extend logging (when message is given in config).
52 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
56 sru_z3950 filter passes through incoming Z39.50 requests again. Was
57 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
61 zoom: fixes for retry/proxy failover logic. More logging.
65 zoom: return addinfo="proxy failure" for proxy failures. This also
66 changes the scheme for dealing with proxies a bit. zoom now always
67 do proxy check, even if there's no failover. Fortunately, that's not
70 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
71 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
72 generic. We don't know why the init would fail; IP, user, block IP, etc.
73 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
75 zoom: guess if invalid SRU response was an auth failure
77 session_shared: disable session retry by default . Can be enabled by
78 restart="true" in resultset section.
82 zoom: may read cf-proxy's config settings.
83 This reduces manual configuration of the content proxy server host.
84 The ZOOM module will use the old style session.proxyhost if "server"
85 is given (deprecated) and use the new style proxyhost/session if
86 "config_file" is in use.
88 frontend_net: remove incoming requests that can not be handled
89 Requests in queue for filter frontend_net are removed if client
90 closes connection for the session and request is not yet handled.
92 sru_z3950: serialize requests. This is to ensure that pipelined
93 HTTP requests are handled properly.
97 New class, wrbuf, that wraps YAZ' WRBUF.
101 Metaproxy daemon is now running as user "metaproxy". This user is
102 managed by package maintainer scripts. The user information is stored
103 in /etc/metaproxy/metaproxy.user .
105 --- 1.3.26 2012/03/20
107 New filter, sort, that allows sorting of XML records via Z39.50
110 Filter record_transform: USEMarcon support. For example:
111 <retrieval syntax="usmarc">
112 <backend syntax="unimarc" name="F">
113 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
117 Filter multi: empty route pattern uses route as default.
119 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
120 may use the shorter notation
121 <target route="z3950.indexdata.com"/>
123 Filter query_rewrite: use config path to locate XSLT.
125 Filter frontend_net: log statistics.
126 If a custom message element in frontend_net configuration it makes
127 the frontend_net filter produce a log entry whenever an operation
128 is completed. The log is always written using yaz_log with the
129 custom message given, the package ID (session ID) , the time
130 the operation has been active (end-to-end) , the threads currently
131 active/total and the size of the request input/output queues.
133 query_rewrite: charset conversion of query terms.
134 This is an optional feature. Enabled by element <charset> in
135 configuration with attribute 'from' and 'to' that specifies
136 from/to encodings. The default 'from' encoding is UTF-8.
138 Filter record_transform: honor piggyback searches.
140 Filter zoom: re-connect when database is reused.
141 Re-connect is necessary if a connection is lost or a timeout occurs.
142 If not, we'll be seeing zero hits, when we shouldn't.
144 --- 1.3.25 2012/02/29
146 zoom: Change scheme for dealing with content proxy URLs. The module
147 now has its own common XSL transform that is enabled by record_xsl
148 attribute in the configuration. This XSL gets parameter cproxyhost
149 that holds the host for the content proxy session . The genearted-url
150 is created only if urlRecipe is enabled. In previous version default
151 value of urlRecipe was ${md-electronic-url}; it is now empty and
152 disabled by default. Also generated-url no longer includes the content
153 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
156 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
157 connections. Default value is 40 (seconds).
159 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
160 "Malformed query" for syntax errors and related ones; throw
161 Bib-1: 3 "Unsupported search" for everything else. Details from
162 the CCL parser is provided as additional-info.
164 multi: new setting hideerrors that makes multi only relay diagnostics
165 to a client if all backends fail.
167 --- 1.3.24 2012/02/23
169 zoom: empty ccl_map field-mappings disables CCL map.
171 zoom: fix Explain search that could return error if session was
174 --- 1.3.23 2012/02/10
176 zoom: returns Explain records for database IR-Explain---1. The
177 target profile records are converted to Explain records via XSLT.
179 session_shared: make error recovery configurable. Whether a search
180 is restarted on errors or not, is configurable by attribute "restart"
181 in element "resultset" in configuration.
183 session_shared: only relay init for first request. session_shared, for
184 each backend class, now only relays first init request (rather than all).
185 The module only needs to save init response info once. This avoids the
186 need to check for session max.
188 --- 1.3.22 2012/02/02
190 zoom: fix memory leaks.
192 session_shared: maximum number of sessons is configurable. Default
193 value is 100. Result-sets for backends without named result sets are
194 only re-used if databases is identical for a search. This is under the
195 assumption that performance may suffer for those backends when
196 changing the database for each search.
198 multi: combines diagnostics from all backends. All diagnostics from
199 backends are combined into multiple non-surrogate diagnostics; rather
200 than just one diagnostic from first backend.
202 --- 1.3.21 2011/12/27
204 zoom: relay realm to cproxy parameter file.
206 Configuration: Allow filter collection element inside route. This
207 makes it possible to include multiple filters at once.
209 zoom: nocproxy also disables urlRecipe.
211 --- 1.3.20 2011/12/21
213 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
214 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
215 90: "Unsupported direction value".
217 zoom: honor database argument nocproxy. This disables creating a content
218 connector session (for non-CF targets, usually) and also relays nocproxy
219 as database argument to a CF target.
221 --- 1.3.19 2011/12/16
223 zoom: Multiple proxy hosts may be given for proxy rich database
224 parameter. List is comma separated.
226 http_file: decodes URI paths properly. Does not return 404: not found
227 if no prefix are matches. Instead packages are passed on.
229 --- 1.3.18 2011/12/08
231 zoom: content-{user,password,proxy} are passed on to content proxy
232 system and takes precedence over user,password,proxy .
234 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
235 with a log element including log material from children filters. At
236 this point, only the zoom filter uses this log facility. It will
237 eventually be used by other filters as well. In particular it might be
238 useful for this feature to track all filters in used during a search.
240 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
241 and queries as they are manipulated are logged.
243 zoom: extend addinfo with native diagnostics. Diagnostics as received
244 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
245 diagnostics. This indicates both a backend diagnostic and the original
248 zoom: default urlRecipe value is ${md-electronic-url}
250 zoom: target profile setting sruVersion is recognized.
252 --- 1.3.17 2011/11/17
254 zoom: log target profile record fetched (AKA Torus).
256 --- 1.3.16 2011/11/17
258 Change target profile parameter CfSubDb to CfSubDB.
260 --- 1.3.15 2011/11/12
262 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
263 makes sense to the zoom module itself).
265 --- 1.3.14 2011/11/11
267 zoom: realm may be given as part of database.
269 --- 1.3.13 2011/10/26
271 Fix Origin class assigment method; was removd by mistake in 1.3.12.
273 --- 1.3.12 2011/10/26
275 zoom: database args x-name=value are passed through to backend database.
277 SRU filter: user may specify session ID that is passed to log entries
278 that follows. It is specified by using x-session-id in the SRU arguments.
280 zoom: fix null pointer reference which would occur for bad url parameter
281 inside "torus" or if url was not given.
283 --- 1.3.11 2011/09/09
284 Fix bug in filter session_shared where sessions would not expire
285 properly (session ttl). This in turn could make the target close the
286 connection before expected and session_shared would return diagnostic
287 2: system temporarily available.
289 --- 1.3.10 2011/09/09
291 zoom: new target profile setting: sortmap_field. If sortmap_field is given
292 the field is mapped to the value for the sortmap. Values not matching
293 sortmap_field are passed verbatim.
295 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
296 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
297 depending on whether RPN or CQL is actually sent to the target.
301 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
303 zoom: For content proxy authentication is stored in param name
304 "auth", instead of "authentication".
308 zoom: relay schema in SRU mode. Previously recordSchema was not affected
313 zoom: new target profile element literalTransform that holds XSLT
314 (encoded as string) for target. Only if present and non-zero length it is
315 considered present. This takes precedence over transform.
317 Don't rely on trang anymore for Git checkout builds. Configuration in etc
318 will only be properly validated if trang is available. From now on only
319 relax NC files are bundled with the source dist.
321 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
322 component was not detected when it should be.
326 z3950_client: mark non-surrogate diagnostics from backend.
328 zoom: a proxy may be specified for HTTP fetch of target profiles.
332 Honor piggyback. Makes some SRU targets behave that insist on
333 maximumRecords > 0, but also increases performance.
337 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
338 file was not update for libdir/metaproxy4 in version 1.3.2.
342 Change location of Metaproxy modules from libdir/metaproxy to
343 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
344 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
346 New facility to dump APDUs from zoom filter. Enabled by
347 <log apdu="true"/> in the zoom filter configuation.
349 zoom filter bug fix: SRU diagnostics received from backend was
350 not properly converted to Bib-1 diagnostics.
352 Package metaproxy depends on libmetaproxy4, same version.
356 zoom: fix a bug WRT passing authentication parameters to backends.
360 Fixes for windows Makefile.
362 --- 1.2.10 2011/07/25
364 Change major version of metaproxy library from 3 to 4. This in turn
365 makes new package names for Debian and RPM.
369 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
372 zoom: configurable element sets for record transforms.
374 zoom: the target profile based transform is specified by element_transform
375 in element torus of of the ZOOM filter configuration ; default value
376 is "pz2". Target profile based retrieval is specified by element_raw
377 in configuration. It will perform same steps, but omit the XSL transform.
378 Default value is "raw".
380 zoom: element set is omitted if not set in profile. But only if pz2
381 transform is in effect. Previously the default element set was to "F".
383 zoom: For non-CF targets database arguments are parsed. User may supply
384 db,user=myuser&password=mypass for non-CF targets. These values override
385 what's given the authentication from the target profile.
387 session_shared: fix reference to freed memory. Would occur if a search
388 response had non-surrogate diagnostics.
392 Route may be given for each port in frontend_net.
396 Documentation for zoom filter. Local target profiles may be specified.
398 Fixes for zoom filter.
402 First version with zoom filter.
406 Filter z3950_client may be configured to always send a close APDU
407 to backend target when connection/session is closed. This will only
408 happen if close APDU is not already sent. Enabled by configuration
409 for z3950_client (force_close).
411 Filter virt_db and multi: relay close APDU.
413 Filter virt_db and multi: relay init size parameters
414 preferredMessageSize and maximumRecordSize.
416 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
420 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
422 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
423 as determined by configure.
425 RPM: Release includes 'indexdata' name. Use indexdata in release name so
426 this package can be distinguished from other vendors.
430 Fix filter multi: relay idAuthentication parameters.
434 Add metaproxy-config for returning compiler flags, libraries.
438 Fix --with-boost=PREFIX .
442 session_shared: fix use of maintenance thread.
444 Introduce 'start' method for filters and routers. It gets called after
445 configure and after fork, but before processing. This changes API -
446 from libmetaproxy2 to libmetaproxy3.
450 session_shared: ensure backend session is closed if init rejected
453 z3950_client: fix NULL ptr reference that could occur if two clients
454 connected concurrently and if max-sockets was in effect.
458 Fix bug 3497 - Metaproxy unstable while stopping.
460 Fix bug 3495 - SEGV in SRU filter.
464 Filter multi throws diagnostic 'Present Out of Range' when
465 appropriate - rather than returning 0 records.
467 Filter virt_db: fix bad result reuse. Could happen if a result
468 was overriden and a backend did not supported named result sets.
472 Filter log: category access logs diagnostics even if searchStatus
473 or presentStatus is 'success'.
477 The SRU to Z39.50 filter does repeated Z39.50 present requests
478 to fetch all records. Needed when a Z39.50 server returns partial
479 results (due to message size limits).
483 Metaproxy now kills all child processes that are spawned by
484 modules (in case of fork, exec).
488 Debian package now installs /etc/metaproxy/metaproxy.xml which
489 includes all XML files /etc/metaproxy/filters-enabled .
490 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
494 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
495 development package to facilitate 3rd party Metaproxy modules.
497 --- 1.0.23 2010/01/04
499 Filter virt_db: Close backend filter session when Init rejected is received
500 from it (in which case it's not really closed yet). This will ensure we don't
501 run out of resources such as FDs in this case.
503 sru_z3950 filter: Accept any database (including those not listed).
505 --- 1.0.22 2009/12/03
507 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
508 later which means YAZ 3.0.47 or later.
510 --- 1.0.20 2009/11/19
512 For filter virt_db, the database is a glob pattern and the virtual
513 database sections are consulted in the order given.
515 --- 1.0.19 2009/07/08
517 For filter multi, the target (for routing) may be given as a glob-pattern.
519 More documentation for filters virt_db and multi.
521 Update schema to allow for no database in sru_z3950 filter.
523 --- 1.0.18 2009/06/30
525 Added limit filter to put sleep (penalty) for heavy use.
527 Filter frontend_net may be configured to limit the number of new connections
528 from same IP to some value (connect-max).
530 Fixed the load_balance filter.
532 --- 1.0.17 2009/06/16
534 Fix path for metaproxy executable for Debian init.d script.
536 --- 1.0.16 2009/06/10
538 SRU to Z39.50 filter honors x-username and x-password. If only
539 x-username is given that translates to open authentication (Z39.50v2). If
540 both x-username and x-password is present that translates to idPass
541 authentication (Z39.50v3).
543 New facility to change current working directory (-w).
545 Update to upstream skeleton of init.d script. Should fix bug #2619.
547 Filter session_shared now caches records (used to only cache connections
550 Filter session_shared now invalidates a Z39.50 session if a server
551 returns -1 hits. This facility was also part of yazproxy and gets around
552 a bug in Voyager-based Z39.50 servers.
554 --- 1.0.15 2008/11/18
556 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
558 --- 1.0.14 2008/06/09
560 Fixed the value of SRU record schema in searchRetrieve response. It was set
561 to a fixed value of "dc" before.
563 Serialize identical SRU requests. This is useful if HTTP client software
564 fires identical requests against metaproxy.
566 Allow Z39.50 target to be specified for SRU requests by using SRU extra
567 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
568 avoid static configuration. This facility is handled by the sru_z3950 module
569 and the z3950_client module.
571 Allow maximum number of sockets to be used for a Z39.50 client by the
572 use of SRU extra parameter x-max-sockets. This facility is handled by the
573 sru_z3950 module and the z3950_client module.
575 --- 1.0.13.1 2008/02/29
577 Simplified check for Boost libraries.
579 --- 1.0.13 2008/02/29
581 First Debian package.
583 The sru_z9350 filter now recognizes SRU parameter z-target as being
584 a ZURL of the form host/database .
586 Mergetype may be specified for filter 'multi'.
588 --- 1.0.12 2007/09/19
590 Fixed problem in Makefile WRT library specifictions. This could produce
591 linker errors (when they should not happen).
593 Fixed bug #1341: MetaProxy returning different results. Problem was that
594 fix-up of record database did not normalize the database name.
596 Documentation updates for Windows compilation.
598 --- 1.0.11 2007/06/14
600 Fixed problem with logfile being truncated.
602 --- 1.0.10 2007/05/23
604 Fixed bug #1136: Access rights not enforced.
606 Extension for log module. The log category 'access' logs more details.
607 New category 'user-access' added which is simlar to 'access' but adds
608 the Z39.50 user as for all entries in a session.
612 Added support for configurable default/force target/vhost for module Z39.50
617 Implemented filter, session_shared, which optimizes usage of Z39.50
618 sessions and result sets.
620 New filter, record_transform, which converts MARC/XML records.
622 New filter, sru_z3950, which converts SRU to Z39.50 packages.
624 New filter, load_balance, in development.
626 New filter, zeerex_xplain.
628 XML framework for config files started.
630 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
631 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
632 XML config files are checked against RNG and XML Schema's.
634 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
635 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
636 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
637 explain record to YAZ CQL-to-PQF text config file.
641 Added 'timeout' setting for filter frontend_net which specifies the number
642 of seconds a session is idle before it is closed. Default timeout is
647 Database name in records returned set for virt_db/multi filters.
649 Filter session_shared now functional.
651 Log filter can be configured to write to a given file using 'filename'
652 element. Also information category can be specified with 'category'. If
653 filename is omitted, the log filter writes to stdout. See etc/config5.xml
658 Fixed compilation on Windows.
662 Added documentation for the hidenavailable option for the multi filter.
666 Fixed bug #573: Hide errors for individual servers. If the element
667 'hideunavailable' is given in the configuration, individual servers
668 being unavailable are hidden (unless all are unavailable).
670 Fixed bug #574: Database names are recognised case-sensitively.
672 Fixed bug #567: Fix up database name in Name-Plus-Record.
674 Fixed bug #568: Update win/makefile for VS 2005.
676 Fixed bug #569: Some options throws unknown exception.
680 More information about virtual hosts. The 'etc' directory is part of the
685 Build instructions for Windows. NMake makefile part of distribution tar.
691 Filters functional: auth_simple, backend_test, frontend_net, http_file,
692 log, multi, query_rewrite, template, virt_db, z3950_client.
694 Filters in development: session_shared.
696 Pseudo-filters: template, dl