3 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
4 non-keepalive HTTP sessions.
6 http_file: allow zero size files (bug fix)
8 Fix zoom schema: auth_url is optional
12 zoom: fix un-init memory (could result in SEGV at session close)
14 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
15 and may be used in filters as usual.
17 zoom: authentication via Torus lookup
18 Enabled by new configuration setting: auth_url . If this is defined,
19 the zoom module will contact Torus for auth/IP lookup and that will
20 define realm to be used in session.
24 virt_db: Fix database name - first character we removed by mistake.
25 Bug introduced in 1.3.40.
29 virt_db: Don't use "unix path" as database for Unix sockets.
33 z3950_client: Don't tamper with / in zurl - fixes problems
34 using Unix sockets for backends.
36 session_shared: fix integer overflow problem with hit count.
38 session_shared: avoid long usage of cached queries.
40 zoom: New database argument , torus_url to set URL of Torus
45 Fixes for 'metaproxy reload' for RPM/Debian packages.
47 zoom: Allow rpn2cql conversion to be augmented with a properties file.
48 Element rpn2cql can be specified per-target for the zoom filter.
50 log: New category "line" which is a single-line log message with
51 most important parts of a HTTP/Z39.50 request/response.
55 frontend_net: add facility to report live statistics about response
56 times and current thread usage. The report is an XML document
57 and is triggered for a specific URL path. This is set by <stat-req>
58 in the configuration of frontend_net. By default this report is
59 disabled (same as empty value for <stat-req>).
61 Fix reload problem in init.d script for RPM/Debian.
62 The '/etc/init.d/metaproxy reload' in some cases would stop but not
63 start metaproxy - effectively stopping the service.
65 Don't display start log message when config testing (-t).
67 zoom: avoid CCL message limit of 1K in ZOOM filter.
71 metaproxy init script reacts to reload which does graceful stop +
72 start and is used by logrorate script.
76 Fixes for Windows compilation.
78 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
79 existing sessions running but terminate the monitor process that is
80 used in keepalive mode.
82 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
83 before. Consistent with 'metaproxy stop' message.
85 zoom: document zoom's proxy_timeout
87 z3950_client: fixup addinfo for init response
89 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
90 "Access to specified database denied" is returned, but only if init
91 response from backend does not carry diagnostics already.
93 multi: relays user info for first rejected target. The other-information
94 field for init response for first rejected target is in common init
95 response. This ensures that some backend init diagnostics are returned to
100 frontend_log: extend logging (when message is given in config).
102 --- 1.3.33 2012/04/25
104 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
106 --- 1.3.32 2012/04/24
108 sru_z3950 filter passes through incoming Z39.50 requests again. Was
109 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
111 --- 1.3.31 2012/04/24
113 zoom: fixes for retry/proxy failover logic. More logging.
115 --- 1.3.30 2012/04/23
117 zoom: return addinfo="proxy failure" for proxy failures. This also
118 changes the scheme for dealing with proxies a bit. zoom now always
119 do proxy check, even if there's no failover. Fortunately, that's not
122 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
123 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
124 generic. We don't know why the init would fail; IP, user, block IP, etc.
125 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
127 zoom: guess if invalid SRU response was an auth failure
129 session_shared: disable session retry by default . Can be enabled by
130 restart="true" in resultset section.
132 --- 1.3.29 2012/04/18
134 zoom: may read cf-proxy's config settings.
135 This reduces manual configuration of the content proxy server host.
136 The ZOOM module will use the old style session.proxyhost if "server"
137 is given (deprecated) and use the new style proxyhost/session if
138 "config_file" is in use.
140 frontend_net: remove incoming requests that can not be handled
141 Requests in queue for filter frontend_net are removed if client
142 closes connection for the session and request is not yet handled.
144 sru_z3950: serialize requests. This is to ensure that pipelined
145 HTTP requests are handled properly.
147 --- 1.3.28 2012/04/04
149 New class, wrbuf, that wraps YAZ' WRBUF.
151 --- 1.3.27 2012/03/30
153 Metaproxy daemon is now running as user "metaproxy". This user is
154 managed by package maintainer scripts. The user information is stored
155 in /etc/metaproxy/metaproxy.user .
157 --- 1.3.26 2012/03/20
159 New filter, sort, that allows sorting of XML records via Z39.50
162 Filter record_transform: USEMarcon support. For example:
163 <retrieval syntax="usmarc">
164 <backend syntax="unimarc" name="F">
165 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
169 Filter multi: empty route pattern uses route as default.
171 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
172 may use the shorter notation
173 <target route="z3950.indexdata.com"/>
175 Filter query_rewrite: use config path to locate XSLT.
177 Filter frontend_net: log statistics.
178 If a custom message element in frontend_net configuration it makes
179 the frontend_net filter produce a log entry whenever an operation
180 is completed. The log is always written using yaz_log with the
181 custom message given, the package ID (session ID) , the time
182 the operation has been active (end-to-end) , the threads currently
183 active/total and the size of the request input/output queues.
185 query_rewrite: charset conversion of query terms.
186 This is an optional feature. Enabled by element <charset> in
187 configuration with attribute 'from' and 'to' that specifies
188 from/to encodings. The default 'from' encoding is UTF-8.
190 Filter record_transform: honor piggyback searches.
192 Filter zoom: re-connect when database is reused.
193 Re-connect is necessary if a connection is lost or a timeout occurs.
194 If not, we'll be seeing zero hits, when we shouldn't.
196 --- 1.3.25 2012/02/29
198 zoom: Change scheme for dealing with content proxy URLs. The module
199 now has its own common XSL transform that is enabled by record_xsl
200 attribute in the configuration. This XSL gets parameter cproxyhost
201 that holds the host for the content proxy session . The genearted-url
202 is created only if urlRecipe is enabled. In previous version default
203 value of urlRecipe was ${md-electronic-url}; it is now empty and
204 disabled by default. Also generated-url no longer includes the content
205 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
208 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
209 connections. Default value is 40 (seconds).
211 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
212 "Malformed query" for syntax errors and related ones; throw
213 Bib-1: 3 "Unsupported search" for everything else. Details from
214 the CCL parser is provided as additional-info.
216 multi: new setting hideerrors that makes multi only relay diagnostics
217 to a client if all backends fail.
219 --- 1.3.24 2012/02/23
221 zoom: empty ccl_map field-mappings disables CCL map.
223 zoom: fix Explain search that could return error if session was
226 --- 1.3.23 2012/02/10
228 zoom: returns Explain records for database IR-Explain---1. The
229 target profile records are converted to Explain records via XSLT.
231 session_shared: make error recovery configurable. Whether a search
232 is restarted on errors or not, is configurable by attribute "restart"
233 in element "resultset" in configuration.
235 session_shared: only relay init for first request. session_shared, for
236 each backend class, now only relays first init request (rather than all).
237 The module only needs to save init response info once. This avoids the
238 need to check for session max.
240 --- 1.3.22 2012/02/02
242 zoom: fix memory leaks.
244 session_shared: maximum number of sessons is configurable. Default
245 value is 100. Result-sets for backends without named result sets are
246 only re-used if databases is identical for a search. This is under the
247 assumption that performance may suffer for those backends when
248 changing the database for each search.
250 multi: combines diagnostics from all backends. All diagnostics from
251 backends are combined into multiple non-surrogate diagnostics; rather
252 than just one diagnostic from first backend.
254 --- 1.3.21 2011/12/27
256 zoom: relay realm to cproxy parameter file.
258 Configuration: Allow filter collection element inside route. This
259 makes it possible to include multiple filters at once.
261 zoom: nocproxy also disables urlRecipe.
263 --- 1.3.20 2011/12/21
265 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
266 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
267 90: "Unsupported direction value".
269 zoom: honor database argument nocproxy. This disables creating a content
270 connector session (for non-CF targets, usually) and also relays nocproxy
271 as database argument to a CF target.
273 --- 1.3.19 2011/12/16
275 zoom: Multiple proxy hosts may be given for proxy rich database
276 parameter. List is comma separated.
278 http_file: decodes URI paths properly. Does not return 404: not found
279 if no prefix are matches. Instead packages are passed on.
281 --- 1.3.18 2011/12/08
283 zoom: content-{user,password,proxy} are passed on to content proxy
284 system and takes precedence over user,password,proxy .
286 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
287 with a log element including log material from children filters. At
288 this point, only the zoom filter uses this log facility. It will
289 eventually be used by other filters as well. In particular it might be
290 useful for this feature to track all filters in used during a search.
292 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
293 and queries as they are manipulated are logged.
295 zoom: extend addinfo with native diagnostics. Diagnostics as received
296 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
297 diagnostics. This indicates both a backend diagnostic and the original
300 zoom: default urlRecipe value is ${md-electronic-url}
302 zoom: target profile setting sruVersion is recognized.
304 --- 1.3.17 2011/11/17
306 zoom: log target profile record fetched (AKA Torus).
308 --- 1.3.16 2011/11/17
310 Change target profile parameter CfSubDb to CfSubDB.
312 --- 1.3.15 2011/11/12
314 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
315 makes sense to the zoom module itself).
317 --- 1.3.14 2011/11/11
319 zoom: realm may be given as part of database.
321 --- 1.3.13 2011/10/26
323 Fix Origin class assigment method; was removd by mistake in 1.3.12.
325 --- 1.3.12 2011/10/26
327 zoom: database args x-name=value are passed through to backend database.
329 SRU filter: user may specify session ID that is passed to log entries
330 that follows. It is specified by using x-session-id in the SRU arguments.
332 zoom: fix null pointer reference which would occur for bad url parameter
333 inside "torus" or if url was not given.
335 --- 1.3.11 2011/09/09
336 Fix bug in filter session_shared where sessions would not expire
337 properly (session ttl). This in turn could make the target close the
338 connection before expected and session_shared would return diagnostic
339 2: system temporarily available.
341 --- 1.3.10 2011/09/09
343 zoom: new target profile setting: sortmap_field. If sortmap_field is given
344 the field is mapped to the value for the sortmap. Values not matching
345 sortmap_field are passed verbatim.
347 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
348 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
349 depending on whether RPN or CQL is actually sent to the target.
353 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
355 zoom: For content proxy authentication is stored in param name
356 "auth", instead of "authentication".
360 zoom: relay schema in SRU mode. Previously recordSchema was not affected
365 zoom: new target profile element literalTransform that holds XSLT
366 (encoded as string) for target. Only if present and non-zero length it is
367 considered present. This takes precedence over transform.
369 Don't rely on trang anymore for Git checkout builds. Configuration in etc
370 will only be properly validated if trang is available. From now on only
371 relax NC files are bundled with the source dist.
373 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
374 component was not detected when it should be.
378 z3950_client: mark non-surrogate diagnostics from backend.
380 zoom: a proxy may be specified for HTTP fetch of target profiles.
384 Honor piggyback. Makes some SRU targets behave that insist on
385 maximumRecords > 0, but also increases performance.
389 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
390 file was not update for libdir/metaproxy4 in version 1.3.2.
394 Change location of Metaproxy modules from libdir/metaproxy to
395 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
396 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
398 New facility to dump APDUs from zoom filter. Enabled by
399 <log apdu="true"/> in the zoom filter configuation.
401 zoom filter bug fix: SRU diagnostics received from backend was
402 not properly converted to Bib-1 diagnostics.
404 Package metaproxy depends on libmetaproxy4, same version.
408 zoom: fix a bug WRT passing authentication parameters to backends.
412 Fixes for windows Makefile.
414 --- 1.2.10 2011/07/25
416 Change major version of metaproxy library from 3 to 4. This in turn
417 makes new package names for Debian and RPM.
421 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
424 zoom: configurable element sets for record transforms.
426 zoom: the target profile based transform is specified by element_transform
427 in element torus of of the ZOOM filter configuration ; default value
428 is "pz2". Target profile based retrieval is specified by element_raw
429 in configuration. It will perform same steps, but omit the XSL transform.
430 Default value is "raw".
432 zoom: element set is omitted if not set in profile. But only if pz2
433 transform is in effect. Previously the default element set was to "F".
435 zoom: For non-CF targets database arguments are parsed. User may supply
436 db,user=myuser&password=mypass for non-CF targets. These values override
437 what's given the authentication from the target profile.
439 session_shared: fix reference to freed memory. Would occur if a search
440 response had non-surrogate diagnostics.
444 Route may be given for each port in frontend_net.
448 Documentation for zoom filter. Local target profiles may be specified.
450 Fixes for zoom filter.
454 First version with zoom filter.
458 Filter z3950_client may be configured to always send a close APDU
459 to backend target when connection/session is closed. This will only
460 happen if close APDU is not already sent. Enabled by configuration
461 for z3950_client (force_close).
463 Filter virt_db and multi: relay close APDU.
465 Filter virt_db and multi: relay init size parameters
466 preferredMessageSize and maximumRecordSize.
468 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
472 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
474 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
475 as determined by configure.
477 RPM: Release includes 'indexdata' name. Use indexdata in release name so
478 this package can be distinguished from other vendors.
482 Fix filter multi: relay idAuthentication parameters.
486 Add metaproxy-config for returning compiler flags, libraries.
490 Fix --with-boost=PREFIX .
494 session_shared: fix use of maintenance thread.
496 Introduce 'start' method for filters and routers. It gets called after
497 configure and after fork, but before processing. This changes API -
498 from libmetaproxy2 to libmetaproxy3.
502 session_shared: ensure backend session is closed if init rejected
505 z3950_client: fix NULL ptr reference that could occur if two clients
506 connected concurrently and if max-sockets was in effect.
510 Fix bug 3497 - Metaproxy unstable while stopping.
512 Fix bug 3495 - SEGV in SRU filter.
516 Filter multi throws diagnostic 'Present Out of Range' when
517 appropriate - rather than returning 0 records.
519 Filter virt_db: fix bad result reuse. Could happen if a result
520 was overriden and a backend did not supported named result sets.
524 Filter log: category access logs diagnostics even if searchStatus
525 or presentStatus is 'success'.
529 The SRU to Z39.50 filter does repeated Z39.50 present requests
530 to fetch all records. Needed when a Z39.50 server returns partial
531 results (due to message size limits).
535 Metaproxy now kills all child processes that are spawned by
536 modules (in case of fork, exec).
540 Debian package now installs /etc/metaproxy/metaproxy.xml which
541 includes all XML files /etc/metaproxy/filters-enabled .
542 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
546 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
547 development package to facilitate 3rd party Metaproxy modules.
549 --- 1.0.23 2010/01/04
551 Filter virt_db: Close backend filter session when Init rejected is received
552 from it (in which case it's not really closed yet). This will ensure we don't
553 run out of resources such as FDs in this case.
555 sru_z3950 filter: Accept any database (including those not listed).
557 --- 1.0.22 2009/12/03
559 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
560 later which means YAZ 3.0.47 or later.
562 --- 1.0.20 2009/11/19
564 For filter virt_db, the database is a glob pattern and the virtual
565 database sections are consulted in the order given.
567 --- 1.0.19 2009/07/08
569 For filter multi, the target (for routing) may be given as a glob-pattern.
571 More documentation for filters virt_db and multi.
573 Update schema to allow for no database in sru_z3950 filter.
575 --- 1.0.18 2009/06/30
577 Added limit filter to put sleep (penalty) for heavy use.
579 Filter frontend_net may be configured to limit the number of new connections
580 from same IP to some value (connect-max).
582 Fixed the load_balance filter.
584 --- 1.0.17 2009/06/16
586 Fix path for metaproxy executable for Debian init.d script.
588 --- 1.0.16 2009/06/10
590 SRU to Z39.50 filter honors x-username and x-password. If only
591 x-username is given that translates to open authentication (Z39.50v2). If
592 both x-username and x-password is present that translates to idPass
593 authentication (Z39.50v3).
595 New facility to change current working directory (-w).
597 Update to upstream skeleton of init.d script. Should fix bug #2619.
599 Filter session_shared now caches records (used to only cache connections
602 Filter session_shared now invalidates a Z39.50 session if a server
603 returns -1 hits. This facility was also part of yazproxy and gets around
604 a bug in Voyager-based Z39.50 servers.
606 --- 1.0.15 2008/11/18
608 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
610 --- 1.0.14 2008/06/09
612 Fixed the value of SRU record schema in searchRetrieve response. It was set
613 to a fixed value of "dc" before.
615 Serialize identical SRU requests. This is useful if HTTP client software
616 fires identical requests against metaproxy.
618 Allow Z39.50 target to be specified for SRU requests by using SRU extra
619 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
620 avoid static configuration. This facility is handled by the sru_z3950 module
621 and the z3950_client module.
623 Allow maximum number of sockets to be used for a Z39.50 client by the
624 use of SRU extra parameter x-max-sockets. This facility is handled by the
625 sru_z3950 module and the z3950_client module.
627 --- 1.0.13.1 2008/02/29
629 Simplified check for Boost libraries.
631 --- 1.0.13 2008/02/29
633 First Debian package.
635 The sru_z9350 filter now recognizes SRU parameter z-target as being
636 a ZURL of the form host/database .
638 Mergetype may be specified for filter 'multi'.
640 --- 1.0.12 2007/09/19
642 Fixed problem in Makefile WRT library specifictions. This could produce
643 linker errors (when they should not happen).
645 Fixed bug #1341: MetaProxy returning different results. Problem was that
646 fix-up of record database did not normalize the database name.
648 Documentation updates for Windows compilation.
650 --- 1.0.11 2007/06/14
652 Fixed problem with logfile being truncated.
654 --- 1.0.10 2007/05/23
656 Fixed bug #1136: Access rights not enforced.
658 Extension for log module. The log category 'access' logs more details.
659 New category 'user-access' added which is simlar to 'access' but adds
660 the Z39.50 user as for all entries in a session.
664 Added support for configurable default/force target/vhost for module Z39.50
669 Implemented filter, session_shared, which optimizes usage of Z39.50
670 sessions and result sets.
672 New filter, record_transform, which converts MARC/XML records.
674 New filter, sru_z3950, which converts SRU to Z39.50 packages.
676 New filter, load_balance, in development.
678 New filter, zeerex_xplain.
680 XML framework for config files started.
682 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
683 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
684 XML config files are checked against RNG and XML Schema's.
686 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
687 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
688 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
689 explain record to YAZ CQL-to-PQF text config file.
693 Added 'timeout' setting for filter frontend_net which specifies the number
694 of seconds a session is idle before it is closed. Default timeout is
699 Database name in records returned set for virt_db/multi filters.
701 Filter session_shared now functional.
703 Log filter can be configured to write to a given file using 'filename'
704 element. Also information category can be specified with 'category'. If
705 filename is omitted, the log filter writes to stdout. See etc/config5.xml
710 Fixed compilation on Windows.
714 Added documentation for the hidenavailable option for the multi filter.
718 Fixed bug #573: Hide errors for individual servers. If the element
719 'hideunavailable' is given in the configuration, individual servers
720 being unavailable are hidden (unless all are unavailable).
722 Fixed bug #574: Database names are recognised case-sensitively.
724 Fixed bug #567: Fix up database name in Name-Plus-Record.
726 Fixed bug #568: Update win/makefile for VS 2005.
728 Fixed bug #569: Some options throws unknown exception.
732 More information about virtual hosts. The 'etc' directory is part of the
737 Build instructions for Windows. NMake makefile part of distribution tar.
743 Filters functional: auth_simple, backend_test, frontend_net, http_file,
744 log, multi, query_rewrite, template, virt_db, z3950_client.
746 Filters in development: session_shared.
748 Pseudo-filters: template, dl