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