3 Fixes for 'metaproxy reload' for RPM/Debian packages.
5 zoom: Allow rpn2cql conversion to be augmented with a properties file.
6 Element rpn2cql can be specified per-target for the zoom filter.
8 log: New category "line" which is a single-line log message with
9 most important parts of a HTTP/Z39.50 request/response.
13 frontend_net: add facility to report live statistics about response
14 times and current thread usage. The report is an XML document
15 and is triggered for a specific URL path. This is set by <stat-req>
16 in the configuration of frontend_net. By default this report is
17 disabled (same as empty value for <stat-req>).
19 Fix reload problem in init.d script for RPM/Debian.
20 The '/etc/init.d/metaproxy reload' in some cases would stop but not
21 start metaproxy - effectively stopping the service.
23 Don't display start log message when config testing (-t).
25 zoom: avoid CCL message limit of 1K in ZOOM filter.
29 metaproxy init script reacts to reload which does graceful stop +
30 start and is used by logrorate script.
34 Fixes for Windows compilation.
36 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
37 existing sessions running but terminate the monitor process that is
38 used in keepalive mode.
40 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
41 before. Consistent with 'metaproxy stop' message.
43 zoom: document zoom's proxy_timeout
45 z3950_client: fixup addinfo for init response
47 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
48 "Access to specified database denied" is returned, but only if init
49 response from backend does not carry diagnostics already.
51 multi: relays user info for first rejected target. The other-information
52 field for init response for first rejected target is in common init
53 response. This ensures that some backend init diagnostics are returned to
58 frontend_log: extend logging (when message is given in config).
62 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
66 sru_z3950 filter passes through incoming Z39.50 requests again. Was
67 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
71 zoom: fixes for retry/proxy failover logic. More logging.
75 zoom: return addinfo="proxy failure" for proxy failures. This also
76 changes the scheme for dealing with proxies a bit. zoom now always
77 do proxy check, even if there's no failover. Fortunately, that's not
80 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
81 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
82 generic. We don't know why the init would fail; IP, user, block IP, etc.
83 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
85 zoom: guess if invalid SRU response was an auth failure
87 session_shared: disable session retry by default . Can be enabled by
88 restart="true" in resultset section.
92 zoom: may read cf-proxy's config settings.
93 This reduces manual configuration of the content proxy server host.
94 The ZOOM module will use the old style session.proxyhost if "server"
95 is given (deprecated) and use the new style proxyhost/session if
96 "config_file" is in use.
98 frontend_net: remove incoming requests that can not be handled
99 Requests in queue for filter frontend_net are removed if client
100 closes connection for the session and request is not yet handled.
102 sru_z3950: serialize requests. This is to ensure that pipelined
103 HTTP requests are handled properly.
105 --- 1.3.28 2012/04/04
107 New class, wrbuf, that wraps YAZ' WRBUF.
109 --- 1.3.27 2012/03/30
111 Metaproxy daemon is now running as user "metaproxy". This user is
112 managed by package maintainer scripts. The user information is stored
113 in /etc/metaproxy/metaproxy.user .
115 --- 1.3.26 2012/03/20
117 New filter, sort, that allows sorting of XML records via Z39.50
120 Filter record_transform: USEMarcon support. For example:
121 <retrieval syntax="usmarc">
122 <backend syntax="unimarc" name="F">
123 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
127 Filter multi: empty route pattern uses route as default.
129 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
130 may use the shorter notation
131 <target route="z3950.indexdata.com"/>
133 Filter query_rewrite: use config path to locate XSLT.
135 Filter frontend_net: log statistics.
136 If a custom message element in frontend_net configuration it makes
137 the frontend_net filter produce a log entry whenever an operation
138 is completed. The log is always written using yaz_log with the
139 custom message given, the package ID (session ID) , the time
140 the operation has been active (end-to-end) , the threads currently
141 active/total and the size of the request input/output queues.
143 query_rewrite: charset conversion of query terms.
144 This is an optional feature. Enabled by element <charset> in
145 configuration with attribute 'from' and 'to' that specifies
146 from/to encodings. The default 'from' encoding is UTF-8.
148 Filter record_transform: honor piggyback searches.
150 Filter zoom: re-connect when database is reused.
151 Re-connect is necessary if a connection is lost or a timeout occurs.
152 If not, we'll be seeing zero hits, when we shouldn't.
154 --- 1.3.25 2012/02/29
156 zoom: Change scheme for dealing with content proxy URLs. The module
157 now has its own common XSL transform that is enabled by record_xsl
158 attribute in the configuration. This XSL gets parameter cproxyhost
159 that holds the host for the content proxy session . The genearted-url
160 is created only if urlRecipe is enabled. In previous version default
161 value of urlRecipe was ${md-electronic-url}; it is now empty and
162 disabled by default. Also generated-url no longer includes the content
163 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
166 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
167 connections. Default value is 40 (seconds).
169 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
170 "Malformed query" for syntax errors and related ones; throw
171 Bib-1: 3 "Unsupported search" for everything else. Details from
172 the CCL parser is provided as additional-info.
174 multi: new setting hideerrors that makes multi only relay diagnostics
175 to a client if all backends fail.
177 --- 1.3.24 2012/02/23
179 zoom: empty ccl_map field-mappings disables CCL map.
181 zoom: fix Explain search that could return error if session was
184 --- 1.3.23 2012/02/10
186 zoom: returns Explain records for database IR-Explain---1. The
187 target profile records are converted to Explain records via XSLT.
189 session_shared: make error recovery configurable. Whether a search
190 is restarted on errors or not, is configurable by attribute "restart"
191 in element "resultset" in configuration.
193 session_shared: only relay init for first request. session_shared, for
194 each backend class, now only relays first init request (rather than all).
195 The module only needs to save init response info once. This avoids the
196 need to check for session max.
198 --- 1.3.22 2012/02/02
200 zoom: fix memory leaks.
202 session_shared: maximum number of sessons is configurable. Default
203 value is 100. Result-sets for backends without named result sets are
204 only re-used if databases is identical for a search. This is under the
205 assumption that performance may suffer for those backends when
206 changing the database for each search.
208 multi: combines diagnostics from all backends. All diagnostics from
209 backends are combined into multiple non-surrogate diagnostics; rather
210 than just one diagnostic from first backend.
212 --- 1.3.21 2011/12/27
214 zoom: relay realm to cproxy parameter file.
216 Configuration: Allow filter collection element inside route. This
217 makes it possible to include multiple filters at once.
219 zoom: nocproxy also disables urlRecipe.
221 --- 1.3.20 2011/12/21
223 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
224 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
225 90: "Unsupported direction value".
227 zoom: honor database argument nocproxy. This disables creating a content
228 connector session (for non-CF targets, usually) and also relays nocproxy
229 as database argument to a CF target.
231 --- 1.3.19 2011/12/16
233 zoom: Multiple proxy hosts may be given for proxy rich database
234 parameter. List is comma separated.
236 http_file: decodes URI paths properly. Does not return 404: not found
237 if no prefix are matches. Instead packages are passed on.
239 --- 1.3.18 2011/12/08
241 zoom: content-{user,password,proxy} are passed on to content proxy
242 system and takes precedence over user,password,proxy .
244 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
245 with a log element including log material from children filters. At
246 this point, only the zoom filter uses this log facility. It will
247 eventually be used by other filters as well. In particular it might be
248 useful for this feature to track all filters in used during a search.
250 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
251 and queries as they are manipulated are logged.
253 zoom: extend addinfo with native diagnostics. Diagnostics as received
254 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
255 diagnostics. This indicates both a backend diagnostic and the original
258 zoom: default urlRecipe value is ${md-electronic-url}
260 zoom: target profile setting sruVersion is recognized.
262 --- 1.3.17 2011/11/17
264 zoom: log target profile record fetched (AKA Torus).
266 --- 1.3.16 2011/11/17
268 Change target profile parameter CfSubDb to CfSubDB.
270 --- 1.3.15 2011/11/12
272 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
273 makes sense to the zoom module itself).
275 --- 1.3.14 2011/11/11
277 zoom: realm may be given as part of database.
279 --- 1.3.13 2011/10/26
281 Fix Origin class assigment method; was removd by mistake in 1.3.12.
283 --- 1.3.12 2011/10/26
285 zoom: database args x-name=value are passed through to backend database.
287 SRU filter: user may specify session ID that is passed to log entries
288 that follows. It is specified by using x-session-id in the SRU arguments.
290 zoom: fix null pointer reference which would occur for bad url parameter
291 inside "torus" or if url was not given.
293 --- 1.3.11 2011/09/09
294 Fix bug in filter session_shared where sessions would not expire
295 properly (session ttl). This in turn could make the target close the
296 connection before expected and session_shared would return diagnostic
297 2: system temporarily available.
299 --- 1.3.10 2011/09/09
301 zoom: new target profile setting: sortmap_field. If sortmap_field is given
302 the field is mapped to the value for the sortmap. Values not matching
303 sortmap_field are passed verbatim.
305 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
306 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
307 depending on whether RPN or CQL is actually sent to the target.
311 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
313 zoom: For content proxy authentication is stored in param name
314 "auth", instead of "authentication".
318 zoom: relay schema in SRU mode. Previously recordSchema was not affected
323 zoom: new target profile element literalTransform that holds XSLT
324 (encoded as string) for target. Only if present and non-zero length it is
325 considered present. This takes precedence over transform.
327 Don't rely on trang anymore for Git checkout builds. Configuration in etc
328 will only be properly validated if trang is available. From now on only
329 relax NC files are bundled with the source dist.
331 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
332 component was not detected when it should be.
336 z3950_client: mark non-surrogate diagnostics from backend.
338 zoom: a proxy may be specified for HTTP fetch of target profiles.
342 Honor piggyback. Makes some SRU targets behave that insist on
343 maximumRecords > 0, but also increases performance.
347 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
348 file was not update for libdir/metaproxy4 in version 1.3.2.
352 Change location of Metaproxy modules from libdir/metaproxy to
353 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
354 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
356 New facility to dump APDUs from zoom filter. Enabled by
357 <log apdu="true"/> in the zoom filter configuation.
359 zoom filter bug fix: SRU diagnostics received from backend was
360 not properly converted to Bib-1 diagnostics.
362 Package metaproxy depends on libmetaproxy4, same version.
366 zoom: fix a bug WRT passing authentication parameters to backends.
370 Fixes for windows Makefile.
372 --- 1.2.10 2011/07/25
374 Change major version of metaproxy library from 3 to 4. This in turn
375 makes new package names for Debian and RPM.
379 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
382 zoom: configurable element sets for record transforms.
384 zoom: the target profile based transform is specified by element_transform
385 in element torus of of the ZOOM filter configuration ; default value
386 is "pz2". Target profile based retrieval is specified by element_raw
387 in configuration. It will perform same steps, but omit the XSL transform.
388 Default value is "raw".
390 zoom: element set is omitted if not set in profile. But only if pz2
391 transform is in effect. Previously the default element set was to "F".
393 zoom: For non-CF targets database arguments are parsed. User may supply
394 db,user=myuser&password=mypass for non-CF targets. These values override
395 what's given the authentication from the target profile.
397 session_shared: fix reference to freed memory. Would occur if a search
398 response had non-surrogate diagnostics.
402 Route may be given for each port in frontend_net.
406 Documentation for zoom filter. Local target profiles may be specified.
408 Fixes for zoom filter.
412 First version with zoom filter.
416 Filter z3950_client may be configured to always send a close APDU
417 to backend target when connection/session is closed. This will only
418 happen if close APDU is not already sent. Enabled by configuration
419 for z3950_client (force_close).
421 Filter virt_db and multi: relay close APDU.
423 Filter virt_db and multi: relay init size parameters
424 preferredMessageSize and maximumRecordSize.
426 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
430 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
432 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
433 as determined by configure.
435 RPM: Release includes 'indexdata' name. Use indexdata in release name so
436 this package can be distinguished from other vendors.
440 Fix filter multi: relay idAuthentication parameters.
444 Add metaproxy-config for returning compiler flags, libraries.
448 Fix --with-boost=PREFIX .
452 session_shared: fix use of maintenance thread.
454 Introduce 'start' method for filters and routers. It gets called after
455 configure and after fork, but before processing. This changes API -
456 from libmetaproxy2 to libmetaproxy3.
460 session_shared: ensure backend session is closed if init rejected
463 z3950_client: fix NULL ptr reference that could occur if two clients
464 connected concurrently and if max-sockets was in effect.
468 Fix bug 3497 - Metaproxy unstable while stopping.
470 Fix bug 3495 - SEGV in SRU filter.
474 Filter multi throws diagnostic 'Present Out of Range' when
475 appropriate - rather than returning 0 records.
477 Filter virt_db: fix bad result reuse. Could happen if a result
478 was overriden and a backend did not supported named result sets.
482 Filter log: category access logs diagnostics even if searchStatus
483 or presentStatus is 'success'.
487 The SRU to Z39.50 filter does repeated Z39.50 present requests
488 to fetch all records. Needed when a Z39.50 server returns partial
489 results (due to message size limits).
493 Metaproxy now kills all child processes that are spawned by
494 modules (in case of fork, exec).
498 Debian package now installs /etc/metaproxy/metaproxy.xml which
499 includes all XML files /etc/metaproxy/filters-enabled .
500 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
504 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
505 development package to facilitate 3rd party Metaproxy modules.
507 --- 1.0.23 2010/01/04
509 Filter virt_db: Close backend filter session when Init rejected is received
510 from it (in which case it's not really closed yet). This will ensure we don't
511 run out of resources such as FDs in this case.
513 sru_z3950 filter: Accept any database (including those not listed).
515 --- 1.0.22 2009/12/03
517 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
518 later which means YAZ 3.0.47 or later.
520 --- 1.0.20 2009/11/19
522 For filter virt_db, the database is a glob pattern and the virtual
523 database sections are consulted in the order given.
525 --- 1.0.19 2009/07/08
527 For filter multi, the target (for routing) may be given as a glob-pattern.
529 More documentation for filters virt_db and multi.
531 Update schema to allow for no database in sru_z3950 filter.
533 --- 1.0.18 2009/06/30
535 Added limit filter to put sleep (penalty) for heavy use.
537 Filter frontend_net may be configured to limit the number of new connections
538 from same IP to some value (connect-max).
540 Fixed the load_balance filter.
542 --- 1.0.17 2009/06/16
544 Fix path for metaproxy executable for Debian init.d script.
546 --- 1.0.16 2009/06/10
548 SRU to Z39.50 filter honors x-username and x-password. If only
549 x-username is given that translates to open authentication (Z39.50v2). If
550 both x-username and x-password is present that translates to idPass
551 authentication (Z39.50v3).
553 New facility to change current working directory (-w).
555 Update to upstream skeleton of init.d script. Should fix bug #2619.
557 Filter session_shared now caches records (used to only cache connections
560 Filter session_shared now invalidates a Z39.50 session if a server
561 returns -1 hits. This facility was also part of yazproxy and gets around
562 a bug in Voyager-based Z39.50 servers.
564 --- 1.0.15 2008/11/18
566 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
568 --- 1.0.14 2008/06/09
570 Fixed the value of SRU record schema in searchRetrieve response. It was set
571 to a fixed value of "dc" before.
573 Serialize identical SRU requests. This is useful if HTTP client software
574 fires identical requests against metaproxy.
576 Allow Z39.50 target to be specified for SRU requests by using SRU extra
577 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
578 avoid static configuration. This facility is handled by the sru_z3950 module
579 and the z3950_client module.
581 Allow maximum number of sockets to be used for a Z39.50 client by the
582 use of SRU extra parameter x-max-sockets. This facility is handled by the
583 sru_z3950 module and the z3950_client module.
585 --- 1.0.13.1 2008/02/29
587 Simplified check for Boost libraries.
589 --- 1.0.13 2008/02/29
591 First Debian package.
593 The sru_z9350 filter now recognizes SRU parameter z-target as being
594 a ZURL of the form host/database .
596 Mergetype may be specified for filter 'multi'.
598 --- 1.0.12 2007/09/19
600 Fixed problem in Makefile WRT library specifictions. This could produce
601 linker errors (when they should not happen).
603 Fixed bug #1341: MetaProxy returning different results. Problem was that
604 fix-up of record database did not normalize the database name.
606 Documentation updates for Windows compilation.
608 --- 1.0.11 2007/06/14
610 Fixed problem with logfile being truncated.
612 --- 1.0.10 2007/05/23
614 Fixed bug #1136: Access rights not enforced.
616 Extension for log module. The log category 'access' logs more details.
617 New category 'user-access' added which is simlar to 'access' but adds
618 the Z39.50 user as for all entries in a session.
622 Added support for configurable default/force target/vhost for module Z39.50
627 Implemented filter, session_shared, which optimizes usage of Z39.50
628 sessions and result sets.
630 New filter, record_transform, which converts MARC/XML records.
632 New filter, sru_z3950, which converts SRU to Z39.50 packages.
634 New filter, load_balance, in development.
636 New filter, zeerex_xplain.
638 XML framework for config files started.
640 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
641 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
642 XML config files are checked against RNG and XML Schema's.
644 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
645 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
646 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
647 explain record to YAZ CQL-to-PQF text config file.
651 Added 'timeout' setting for filter frontend_net which specifies the number
652 of seconds a session is idle before it is closed. Default timeout is
657 Database name in records returned set for virt_db/multi filters.
659 Filter session_shared now functional.
661 Log filter can be configured to write to a given file using 'filename'
662 element. Also information category can be specified with 'category'. If
663 filename is omitted, the log filter writes to stdout. See etc/config5.xml
668 Fixed compilation on Windows.
672 Added documentation for the hidenavailable option for the multi filter.
676 Fixed bug #573: Hide errors for individual servers. If the element
677 'hideunavailable' is given in the configuration, individual servers
678 being unavailable are hidden (unless all are unavailable).
680 Fixed bug #574: Database names are recognised case-sensitively.
682 Fixed bug #567: Fix up database name in Name-Plus-Record.
684 Fixed bug #568: Update win/makefile for VS 2005.
686 Fixed bug #569: Some options throws unknown exception.
690 More information about virtual hosts. The 'etc' directory is part of the
695 Build instructions for Windows. NMake makefile part of distribution tar.
701 Filters functional: auth_simple, backend_test, frontend_net, http_file,
702 log, multi, query_rewrite, template, virt_db, z3950_client.
704 Filters in development: session_shared.
706 Pseudo-filters: template, dl