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