3 Fixes for Windows compilation.
5 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
6 existing sessions running but terminate the monitor process that is
7 used in keepalive mode.
9 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
10 before. Consistent with 'metaproxy stop' message.
12 zoom: document zoom's proxy_timeout
14 z3950_client: fixup addinfo for init response
16 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
17 "Access to specified database denied" is returned, but only if init
18 response from backend does not carry diagnostics already.
20 multi: relays user info for first rejected target. The other-information
21 field for init response for first rejected target is in common init
22 response. This ensures that some backend init diagnostics are returned to
27 frontend_log: extend logging (when message is given in config).
31 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
35 sru_z3950 filter passes through incoming Z39.50 requests again. Was
36 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
40 zoom: fixes for retry/proxy failover logic. More logging.
44 zoom: return addinfo="proxy failure" for proxy failures. This also
45 changes the scheme for dealing with proxies a bit. zoom now always
46 do proxy check, even if there's no failover. Fortunately, that's not
49 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
50 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
51 generic. We don't know why the init would fail; IP, user, block IP, etc.
52 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
54 zoom: guess if invalid SRU response was an auth failure
56 session_shared: disable session retry by default . Can be enabled by
57 restart="true" in resultset section.
61 zoom: may read cf-proxy's config settings.
62 This reduces manual configuration of the content proxy server host.
63 The ZOOM module will use the old style session.proxyhost if "server"
64 is given (deprecated) and use the new style proxyhost/session if
65 "config_file" is in use.
67 frontend_net: remove incoming requests that can not be handled
68 Requests in queue for filter frontend_net are removed if client
69 closes connection for the session and request is not yet handled.
71 sru_z3950: serialize requests. This is to ensure that pipelined
72 HTTP requests are handled properly.
76 New class, wrbuf, that wraps YAZ' WRBUF.
80 Metaproxy daemon is now running as user "metaproxy". This user is
81 managed by package maintainer scripts. The user information is stored
82 in /etc/metaproxy/metaproxy.user .
86 New filter, sort, that allows sorting of XML records via Z39.50
89 Filter record_transform: USEMarcon support. For example:
90 <retrieval syntax="usmarc">
91 <backend syntax="unimarc" name="F">
92 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
96 Filter multi: empty route pattern uses route as default.
98 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
99 may use the shorter notation
100 <target route="z3950.indexdata.com"/>
102 Filter query_rewrite: use config path to locate XSLT.
104 Filter frontend_net: log statistics.
105 If a custom message element in frontend_net configuration it makes
106 the frontend_net filter produce a log entry whenever an operation
107 is completed. The log is always written using yaz_log with the
108 custom message given, the package ID (session ID) , the time
109 the operation has been active (end-to-end) , the threads currently
110 active/total and the size of the request input/output queues.
112 query_rewrite: charset conversion of query terms.
113 This is an optional feature. Enabled by element <charset> in
114 configuration with attribute 'from' and 'to' that specifies
115 from/to encodings. The default 'from' encoding is UTF-8.
117 Filter record_transform: honor piggyback searches.
119 Filter zoom: re-connect when database is reused.
120 Re-connect is necessary if a connection is lost or a timeout occurs.
121 If not, we'll be seeing zero hits, when we shouldn't.
123 --- 1.3.25 2012/02/29
125 zoom: Change scheme for dealing with content proxy URLs. The module
126 now has its own common XSL transform that is enabled by record_xsl
127 attribute in the configuration. This XSL gets parameter cproxyhost
128 that holds the host for the content proxy session . The genearted-url
129 is created only if urlRecipe is enabled. In previous version default
130 value of urlRecipe was ${md-electronic-url}; it is now empty and
131 disabled by default. Also generated-url no longer includes the content
132 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
135 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
136 connections. Default value is 40 (seconds).
138 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
139 "Malformed query" for syntax errors and related ones; throw
140 Bib-1: 3 "Unsupported search" for everything else. Details from
141 the CCL parser is provided as additional-info.
143 multi: new setting hideerrors that makes multi only relay diagnostics
144 to a client if all backends fail.
146 --- 1.3.24 2012/02/23
148 zoom: empty ccl_map field-mappings disables CCL map.
150 zoom: fix Explain search that could return error if session was
153 --- 1.3.23 2012/02/10
155 zoom: returns Explain records for database IR-Explain---1. The
156 target profile records are converted to Explain records via XSLT.
158 session_shared: make error recovery configurable. Whether a search
159 is restarted on errors or not, is configurable by attribute "restart"
160 in element "resultset" in configuration.
162 session_shared: only relay init for first request. session_shared, for
163 each backend class, now only relays first init request (rather than all).
164 The module only needs to save init response info once. This avoids the
165 need to check for session max.
167 --- 1.3.22 2012/02/02
169 zoom: fix memory leaks.
171 session_shared: maximum number of sessons is configurable. Default
172 value is 100. Result-sets for backends without named result sets are
173 only re-used if databases is identical for a search. This is under the
174 assumption that performance may suffer for those backends when
175 changing the database for each search.
177 multi: combines diagnostics from all backends. All diagnostics from
178 backends are combined into multiple non-surrogate diagnostics; rather
179 than just one diagnostic from first backend.
181 --- 1.3.21 2011/12/27
183 zoom: relay realm to cproxy parameter file.
185 Configuration: Allow filter collection element inside route. This
186 makes it possible to include multiple filters at once.
188 zoom: nocproxy also disables urlRecipe.
190 --- 1.3.20 2011/12/21
192 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
193 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
194 90: "Unsupported direction value".
196 zoom: honor database argument nocproxy. This disables creating a content
197 connector session (for non-CF targets, usually) and also relays nocproxy
198 as database argument to a CF target.
200 --- 1.3.19 2011/12/16
202 zoom: Multiple proxy hosts may be given for proxy rich database
203 parameter. List is comma separated.
205 http_file: decodes URI paths properly. Does not return 404: not found
206 if no prefix are matches. Instead packages are passed on.
208 --- 1.3.18 2011/12/08
210 zoom: content-{user,password,proxy} are passed on to content proxy
211 system and takes precedence over user,password,proxy .
213 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
214 with a log element including log material from children filters. At
215 this point, only the zoom filter uses this log facility. It will
216 eventually be used by other filters as well. In particular it might be
217 useful for this feature to track all filters in used during a search.
219 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
220 and queries as they are manipulated are logged.
222 zoom: extend addinfo with native diagnostics. Diagnostics as received
223 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
224 diagnostics. This indicates both a backend diagnostic and the original
227 zoom: default urlRecipe value is ${md-electronic-url}
229 zoom: target profile setting sruVersion is recognized.
231 --- 1.3.17 2011/11/17
233 zoom: log target profile record fetched (AKA Torus).
235 --- 1.3.16 2011/11/17
237 Change target profile parameter CfSubDb to CfSubDB.
239 --- 1.3.15 2011/11/12
241 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
242 makes sense to the zoom module itself).
244 --- 1.3.14 2011/11/11
246 zoom: realm may be given as part of database.
248 --- 1.3.13 2011/10/26
250 Fix Origin class assigment method; was removd by mistake in 1.3.12.
252 --- 1.3.12 2011/10/26
254 zoom: database args x-name=value are passed through to backend database.
256 SRU filter: user may specify session ID that is passed to log entries
257 that follows. It is specified by using x-session-id in the SRU arguments.
259 zoom: fix null pointer reference which would occur for bad url parameter
260 inside "torus" or if url was not given.
262 --- 1.3.11 2011/09/09
263 Fix bug in filter session_shared where sessions would not expire
264 properly (session ttl). This in turn could make the target close the
265 connection before expected and session_shared would return diagnostic
266 2: system temporarily available.
268 --- 1.3.10 2011/09/09
270 zoom: new target profile setting: sortmap_field. If sortmap_field is given
271 the field is mapped to the value for the sortmap. Values not matching
272 sortmap_field are passed verbatim.
274 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
275 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
276 depending on whether RPN or CQL is actually sent to the target.
280 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
282 zoom: For content proxy authentication is stored in param name
283 "auth", instead of "authentication".
287 zoom: relay schema in SRU mode. Previously recordSchema was not affected
292 zoom: new target profile element literalTransform that holds XSLT
293 (encoded as string) for target. Only if present and non-zero length it is
294 considered present. This takes precedence over transform.
296 Don't rely on trang anymore for Git checkout builds. Configuration in etc
297 will only be properly validated if trang is available. From now on only
298 relax NC files are bundled with the source dist.
300 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
301 component was not detected when it should be.
305 z3950_client: mark non-surrogate diagnostics from backend.
307 zoom: a proxy may be specified for HTTP fetch of target profiles.
311 Honor piggyback. Makes some SRU targets behave that insist on
312 maximumRecords > 0, but also increases performance.
316 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
317 file was not update for libdir/metaproxy4 in version 1.3.2.
321 Change location of Metaproxy modules from libdir/metaproxy to
322 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
323 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
325 New facility to dump APDUs from zoom filter. Enabled by
326 <log apdu="true"/> in the zoom filter configuation.
328 zoom filter bug fix: SRU diagnostics received from backend was
329 not properly converted to Bib-1 diagnostics.
331 Package metaproxy depends on libmetaproxy4, same version.
335 zoom: fix a bug WRT passing authentication parameters to backends.
339 Fixes for windows Makefile.
341 --- 1.2.10 2011/07/25
343 Change major version of metaproxy library from 3 to 4. This in turn
344 makes new package names for Debian and RPM.
348 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
351 zoom: configurable element sets for record transforms.
353 zoom: the target profile based transform is specified by element_transform
354 in element torus of of the ZOOM filter configuration ; default value
355 is "pz2". Target profile based retrieval is specified by element_raw
356 in configuration. It will perform same steps, but omit the XSL transform.
357 Default value is "raw".
359 zoom: element set is omitted if not set in profile. But only if pz2
360 transform is in effect. Previously the default element set was to "F".
362 zoom: For non-CF targets database arguments are parsed. User may supply
363 db,user=myuser&password=mypass for non-CF targets. These values override
364 what's given the authentication from the target profile.
366 session_shared: fix reference to freed memory. Would occur if a search
367 response had non-surrogate diagnostics.
371 Route may be given for each port in frontend_net.
375 Documentation for zoom filter. Local target profiles may be specified.
377 Fixes for zoom filter.
381 First version with zoom filter.
385 Filter z3950_client may be configured to always send a close APDU
386 to backend target when connection/session is closed. This will only
387 happen if close APDU is not already sent. Enabled by configuration
388 for z3950_client (force_close).
390 Filter virt_db and multi: relay close APDU.
392 Filter virt_db and multi: relay init size parameters
393 preferredMessageSize and maximumRecordSize.
395 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
399 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
401 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
402 as determined by configure.
404 RPM: Release includes 'indexdata' name. Use indexdata in release name so
405 this package can be distinguished from other vendors.
409 Fix filter multi: relay idAuthentication parameters.
413 Add metaproxy-config for returning compiler flags, libraries.
417 Fix --with-boost=PREFIX .
421 session_shared: fix use of maintenance thread.
423 Introduce 'start' method for filters and routers. It gets called after
424 configure and after fork, but before processing. This changes API -
425 from libmetaproxy2 to libmetaproxy3.
429 session_shared: ensure backend session is closed if init rejected
432 z3950_client: fix NULL ptr reference that could occur if two clients
433 connected concurrently and if max-sockets was in effect.
437 Fix bug 3497 - Metaproxy unstable while stopping.
439 Fix bug 3495 - SEGV in SRU filter.
443 Filter multi throws diagnostic 'Present Out of Range' when
444 appropriate - rather than returning 0 records.
446 Filter virt_db: fix bad result reuse. Could happen if a result
447 was overriden and a backend did not supported named result sets.
451 Filter log: category access logs diagnostics even if searchStatus
452 or presentStatus is 'success'.
456 The SRU to Z39.50 filter does repeated Z39.50 present requests
457 to fetch all records. Needed when a Z39.50 server returns partial
458 results (due to message size limits).
462 Metaproxy now kills all child processes that are spawned by
463 modules (in case of fork, exec).
467 Debian package now installs /etc/metaproxy/metaproxy.xml which
468 includes all XML files /etc/metaproxy/filters-enabled .
469 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
473 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
474 development package to facilitate 3rd party Metaproxy modules.
476 --- 1.0.23 2010/01/04
478 Filter virt_db: Close backend filter session when Init rejected is received
479 from it (in which case it's not really closed yet). This will ensure we don't
480 run out of resources such as FDs in this case.
482 sru_z3950 filter: Accept any database (including those not listed).
484 --- 1.0.22 2009/12/03
486 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
487 later which means YAZ 3.0.47 or later.
489 --- 1.0.20 2009/11/19
491 For filter virt_db, the database is a glob pattern and the virtual
492 database sections are consulted in the order given.
494 --- 1.0.19 2009/07/08
496 For filter multi, the target (for routing) may be given as a glob-pattern.
498 More documentation for filters virt_db and multi.
500 Update schema to allow for no database in sru_z3950 filter.
502 --- 1.0.18 2009/06/30
504 Added limit filter to put sleep (penalty) for heavy use.
506 Filter frontend_net may be configured to limit the number of new connections
507 from same IP to some value (connect-max).
509 Fixed the load_balance filter.
511 --- 1.0.17 2009/06/16
513 Fix path for metaproxy executable for Debian init.d script.
515 --- 1.0.16 2009/06/10
517 SRU to Z39.50 filter honors x-username and x-password. If only
518 x-username is given that translates to open authentication (Z39.50v2). If
519 both x-username and x-password is present that translates to idPass
520 authentication (Z39.50v3).
522 New facility to change current working directory (-w).
524 Update to upstream skeleton of init.d script. Should fix bug #2619.
526 Filter session_shared now caches records (used to only cache connections
529 Filter session_shared now invalidates a Z39.50 session if a server
530 returns -1 hits. This facility was also part of yazproxy and gets around
531 a bug in Voyager-based Z39.50 servers.
533 --- 1.0.15 2008/11/18
535 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
537 --- 1.0.14 2008/06/09
539 Fixed the value of SRU record schema in searchRetrieve response. It was set
540 to a fixed value of "dc" before.
542 Serialize identical SRU requests. This is useful if HTTP client software
543 fires identical requests against metaproxy.
545 Allow Z39.50 target to be specified for SRU requests by using SRU extra
546 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
547 avoid static configuration. This facility is handled by the sru_z3950 module
548 and the z3950_client module.
550 Allow maximum number of sockets to be used for a Z39.50 client by the
551 use of SRU extra parameter x-max-sockets. This facility is handled by the
552 sru_z3950 module and the z3950_client module.
554 --- 1.0.13.1 2008/02/29
556 Simplified check for Boost libraries.
558 --- 1.0.13 2008/02/29
560 First Debian package.
562 The sru_z9350 filter now recognizes SRU parameter z-target as being
563 a ZURL of the form host/database .
565 Mergetype may be specified for filter 'multi'.
567 --- 1.0.12 2007/09/19
569 Fixed problem in Makefile WRT library specifictions. This could produce
570 linker errors (when they should not happen).
572 Fixed bug #1341: MetaProxy returning different results. Problem was that
573 fix-up of record database did not normalize the database name.
575 Documentation updates for Windows compilation.
577 --- 1.0.11 2007/06/14
579 Fixed problem with logfile being truncated.
581 --- 1.0.10 2007/05/23
583 Fixed bug #1136: Access rights not enforced.
585 Extension for log module. The log category 'access' logs more details.
586 New category 'user-access' added which is simlar to 'access' but adds
587 the Z39.50 user as for all entries in a session.
591 Added support for configurable default/force target/vhost for module Z39.50
596 Implemented filter, session_shared, which optimizes usage of Z39.50
597 sessions and result sets.
599 New filter, record_transform, which converts MARC/XML records.
601 New filter, sru_z3950, which converts SRU to Z39.50 packages.
603 New filter, load_balance, in development.
605 New filter, zeerex_xplain.
607 XML framework for config files started.
609 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
610 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
611 XML config files are checked against RNG and XML Schema's.
613 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
614 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
615 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
616 explain record to YAZ CQL-to-PQF text config file.
620 Added 'timeout' setting for filter frontend_net which specifies the number
621 of seconds a session is idle before it is closed. Default timeout is
626 Database name in records returned set for virt_db/multi filters.
628 Filter session_shared now functional.
630 Log filter can be configured to write to a given file using 'filename'
631 element. Also information category can be specified with 'category'. If
632 filename is omitted, the log filter writes to stdout. See etc/config5.xml
637 Fixed compilation on Windows.
641 Added documentation for the hidenavailable option for the multi filter.
645 Fixed bug #573: Hide errors for individual servers. If the element
646 'hideunavailable' is given in the configuration, individual servers
647 being unavailable are hidden (unless all are unavailable).
649 Fixed bug #574: Database names are recognised case-sensitively.
651 Fixed bug #567: Fix up database name in Name-Plus-Record.
653 Fixed bug #568: Update win/makefile for VS 2005.
655 Fixed bug #569: Some options throws unknown exception.
659 More information about virtual hosts. The 'etc' directory is part of the
664 Build instructions for Windows. NMake makefile part of distribution tar.
670 Filters functional: auth_simple, backend_test, frontend_net, http_file,
671 log, multi, query_rewrite, template, virt_db, z3950_client.
673 Filters in development: session_shared.
675 Pseudo-filters: template, dl