2 Fixes for windows compilation.
4 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
5 existing sessions running but terminate the monitor process that is
6 used in keepalive mode.
8 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
9 before. Consistent with 'metaproxy stop' message.
11 zoom: document zoom's proxy_timeout
13 z3950_client: fixup addinfo for init response
15 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
16 "Access to specified database denied" is returned, but only if init
17 response from backend does not carry diagnostics already.
19 multi: relays user info for first rejected target. The other-information
20 field for init response for first rejected target is in common init
21 response. This ensures that some backend init diagnostics are returned to
26 frontend_log: extend logging (when message is given in config).
30 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
34 sru_z3950 filter passes through incoming Z39.50 requests again. Was
35 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
39 zoom: fixes for retry/proxy failover logic. More logging.
43 zoom: return addinfo="proxy failure" for proxy failures. This also
44 changes the scheme for dealing with proxies a bit. zoom now always
45 do proxy check, even if there's no failover. Fortunately, that's not
48 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
49 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
50 generic. We don't know why the init would fail; IP, user, block IP, etc.
51 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
53 zoom: guess if invalid SRU response was an auth failure
55 session_shared: disable session retry by default . Can be enabled by
56 restart="true" in resultset section.
60 zoom: may read cf-proxy's config settings.
61 This reduces manual configuration of the content proxy server host.
62 The ZOOM module will use the old style session.proxyhost if "server"
63 is given (deprecated) and use the new style proxyhost/session if
64 "config_file" is in use.
66 frontend_net: remove incoming requests that can not be handled
67 Requests in queue for filter frontend_net are removed if client
68 closes connection for the session and request is not yet handled.
70 sru_z3950: serialize requests. This is to ensure that pipelined
71 HTTP requests are handled properly.
75 New class, wrbuf, that wraps YAZ' WRBUF.
79 Metaproxy daemon is now running as user "metaproxy". This user is
80 managed by package maintainer scripts. The user information is stored
81 in /etc/metaproxy/metaproxy.user .
85 New filter, sort, that allows sorting of XML records via Z39.50
88 Filter record_transform: USEMarcon support. For example:
89 <retrieval syntax="usmarc">
90 <backend syntax="unimarc" name="F">
91 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
95 Filter multi: empty route pattern uses route as default.
97 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
98 may use the shorter notation
99 <target route="z3950.indexdata.com"/>
101 Filter query_rewrite: use config path to locate XSLT.
103 Filter frontend_net: log statistics.
104 If a custom message element in frontend_net configuration it makes
105 the frontend_net filter produce a log entry whenever an operation
106 is completed. The log is always written using yaz_log with the
107 custom message given, the package ID (session ID) , the time
108 the operation has been active (end-to-end) , the threads currently
109 active/total and the size of the request input/output queues.
111 query_rewrite: charset conversion of query terms.
112 This is an optional feature. Enabled by element <charset> in
113 configuration with attribute 'from' and 'to' that specifies
114 from/to encodings. The default 'from' encoding is UTF-8.
116 Filter record_transform: honor piggyback searches.
118 Filter zoom: re-connect when database is reused.
119 Re-connect is necessary if a connection is lost or a timeout occurs.
120 If not, we'll be seeing zero hits, when we shouldn't.
122 --- 1.3.25 2012/02/29
124 zoom: Change scheme for dealing with content proxy URLs. The module
125 now has its own common XSL transform that is enabled by record_xsl
126 attribute in the configuration. This XSL gets parameter cproxyhost
127 that holds the host for the content proxy session . The genearted-url
128 is created only if urlRecipe is enabled. In previous version default
129 value of urlRecipe was ${md-electronic-url}; it is now empty and
130 disabled by default. Also generated-url no longer includes the content
131 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
134 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
135 connections. Default value is 40 (seconds).
137 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
138 "Malformed query" for syntax errors and related ones; throw
139 Bib-1: 3 "Unsupported search" for everything else. Details from
140 the CCL parser is provided as additional-info.
142 multi: new setting hideerrors that makes multi only relay diagnostics
143 to a client if all backends fail.
145 --- 1.3.24 2012/02/23
147 zoom: empty ccl_map field-mappings disables CCL map.
149 zoom: fix Explain search that could return error if session was
152 --- 1.3.23 2012/02/10
154 zoom: returns Explain records for database IR-Explain---1. The
155 target profile records are converted to Explain records via XSLT.
157 session_shared: make error recovery configurable. Whether a search
158 is restarted on errors or not, is configurable by attribute "restart"
159 in element "resultset" in configuration.
161 session_shared: only relay init for first request. session_shared, for
162 each backend class, now only relays first init request (rather than all).
163 The module only needs to save init response info once. This avoids the
164 need to check for session max.
166 --- 1.3.22 2012/02/02
168 zoom: fix memory leaks.
170 session_shared: maximum number of sessons is configurable. Default
171 value is 100. Result-sets for backends without named result sets are
172 only re-used if databases is identical for a search. This is under the
173 assumption that performance may suffer for those backends when
174 changing the database for each search.
176 multi: combines diagnostics from all backends. All diagnostics from
177 backends are combined into multiple non-surrogate diagnostics; rather
178 than just one diagnostic from first backend.
180 --- 1.3.21 2011/12/27
182 zoom: relay realm to cproxy parameter file.
184 Configuration: Allow filter collection element inside route. This
185 makes it possible to include multiple filters at once.
187 zoom: nocproxy also disables urlRecipe.
189 --- 1.3.20 2011/12/21
191 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
192 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
193 90: "Unsupported direction value".
195 zoom: honor database argument nocproxy. This disables creating a content
196 connector session (for non-CF targets, usually) and also relays nocproxy
197 as database argument to a CF target.
199 --- 1.3.19 2011/12/16
201 zoom: Multiple proxy hosts may be given for proxy rich database
202 parameter. List is comma separated.
204 http_file: decodes URI paths properly. Does not return 404: not found
205 if no prefix are matches. Instead packages are passed on.
207 --- 1.3.18 2011/12/08
209 zoom: content-{user,password,proxy} are passed on to content proxy
210 system and takes precedence over user,password,proxy .
212 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
213 with a log element including log material from children filters. At
214 this point, only the zoom filter uses this log facility. It will
215 eventually be used by other filters as well. In particular it might be
216 useful for this feature to track all filters in used during a search.
218 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
219 and queries as they are manipulated are logged.
221 zoom: extend addinfo with native diagnostics. Diagnostics as received
222 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
223 diagnostics. This indicates both a backend diagnostic and the original
226 zoom: default urlRecipe value is ${md-electronic-url}
228 zoom: target profile setting sruVersion is recognized.
230 --- 1.3.17 2011/11/17
232 zoom: log target profile record fetched (AKA Torus).
234 --- 1.3.16 2011/11/17
236 Change target profile parameter CfSubDb to CfSubDB.
238 --- 1.3.15 2011/11/12
240 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
241 makes sense to the zoom module itself).
243 --- 1.3.14 2011/11/11
245 zoom: realm may be given as part of database.
247 --- 1.3.13 2011/10/26
249 Fix Origin class assigment method; was removd by mistake in 1.3.12.
251 --- 1.3.12 2011/10/26
253 zoom: database args x-name=value are passed through to backend database.
255 SRU filter: user may specify session ID that is passed to log entries
256 that follows. It is specified by using x-session-id in the SRU arguments.
258 zoom: fix null pointer reference which would occur for bad url parameter
259 inside "torus" or if url was not given.
261 --- 1.3.11 2011/09/09
262 Fix bug in filter session_shared where sessions would not expire
263 properly (session ttl). This in turn could make the target close the
264 connection before expected and session_shared would return diagnostic
265 2: system temporarily available.
267 --- 1.3.10 2011/09/09
269 zoom: new target profile setting: sortmap_field. If sortmap_field is given
270 the field is mapped to the value for the sortmap. Values not matching
271 sortmap_field are passed verbatim.
273 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
274 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
275 depending on whether RPN or CQL is actually sent to the target.
279 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
281 zoom: For content proxy authentication is stored in param name
282 "auth", instead of "authentication".
286 zoom: relay schema in SRU mode. Previously recordSchema was not affected
291 zoom: new target profile element literalTransform that holds XSLT
292 (encoded as string) for target. Only if present and non-zero length it is
293 considered present. This takes precedence over transform.
295 Don't rely on trang anymore for Git checkout builds. Configuration in etc
296 will only be properly validated if trang is available. From now on only
297 relax NC files are bundled with the source dist.
299 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
300 component was not detected when it should be.
304 z3950_client: mark non-surrogate diagnostics from backend.
306 zoom: a proxy may be specified for HTTP fetch of target profiles.
310 Honor piggyback. Makes some SRU targets behave that insist on
311 maximumRecords > 0, but also increases performance.
315 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
316 file was not update for libdir/metaproxy4 in version 1.3.2.
320 Change location of Metaproxy modules from libdir/metaproxy to
321 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
322 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
324 New facility to dump APDUs from zoom filter. Enabled by
325 <log apdu="true"/> in the zoom filter configuation.
327 zoom filter bug fix: SRU diagnostics received from backend was
328 not properly converted to Bib-1 diagnostics.
330 Package metaproxy depends on libmetaproxy4, same version.
334 zoom: fix a bug WRT passing authentication parameters to backends.
338 Fixes for windows Makefile.
340 --- 1.2.10 2011/07/25
342 Change major version of metaproxy library from 3 to 4. This in turn
343 makes new package names for Debian and RPM.
347 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
350 zoom: configurable element sets for record transforms.
352 zoom: the target profile based transform is specified by element_transform
353 in element torus of of the ZOOM filter configuration ; default value
354 is "pz2". Target profile based retrieval is specified by element_raw
355 in configuration. It will perform same steps, but omit the XSL transform.
356 Default value is "raw".
358 zoom: element set is omitted if not set in profile. But only if pz2
359 transform is in effect. Previously the default element set was to "F".
361 zoom: For non-CF targets database arguments are parsed. User may supply
362 db,user=myuser&password=mypass for non-CF targets. These values override
363 what's given the authentication from the target profile.
365 session_shared: fix reference to freed memory. Would occur if a search
366 response had non-surrogate diagnostics.
370 Route may be given for each port in frontend_net.
374 Documentation for zoom filter. Local target profiles may be specified.
376 Fixes for zoom filter.
380 First version with zoom filter.
384 Filter z3950_client may be configured to always send a close APDU
385 to backend target when connection/session is closed. This will only
386 happen if close APDU is not already sent. Enabled by configuration
387 for z3950_client (force_close).
389 Filter virt_db and multi: relay close APDU.
391 Filter virt_db and multi: relay init size parameters
392 preferredMessageSize and maximumRecordSize.
394 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
398 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
400 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
401 as determined by configure.
403 RPM: Release includes 'indexdata' name. Use indexdata in release name so
404 this package can be distinguished from other vendors.
408 Fix filter multi: relay idAuthentication parameters.
412 Add metaproxy-config for returning compiler flags, libraries.
416 Fix --with-boost=PREFIX .
420 session_shared: fix use of maintenance thread.
422 Introduce 'start' method for filters and routers. It gets called after
423 configure and after fork, but before processing. This changes API -
424 from libmetaproxy2 to libmetaproxy3.
428 session_shared: ensure backend session is closed if init rejected
431 z3950_client: fix NULL ptr reference that could occur if two clients
432 connected concurrently and if max-sockets was in effect.
436 Fix bug 3497 - Metaproxy unstable while stopping.
438 Fix bug 3495 - SEGV in SRU filter.
442 Filter multi throws diagnostic 'Present Out of Range' when
443 appropriate - rather than returning 0 records.
445 Filter virt_db: fix bad result reuse. Could happen if a result
446 was overriden and a backend did not supported named result sets.
450 Filter log: category access logs diagnostics even if searchStatus
451 or presentStatus is 'success'.
455 The SRU to Z39.50 filter does repeated Z39.50 present requests
456 to fetch all records. Needed when a Z39.50 server returns partial
457 results (due to message size limits).
461 Metaproxy now kills all child processes that are spawned by
462 modules (in case of fork, exec).
466 Debian package now installs /etc/metaproxy/metaproxy.xml which
467 includes all XML files /etc/metaproxy/filters-enabled .
468 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
472 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
473 development package to facilitate 3rd party Metaproxy modules.
475 --- 1.0.23 2010/01/04
477 Filter virt_db: Close backend filter session when Init rejected is received
478 from it (in which case it's not really closed yet). This will ensure we don't
479 run out of resources such as FDs in this case.
481 sru_z3950 filter: Accept any database (including those not listed).
483 --- 1.0.22 2009/12/03
485 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
486 later which means YAZ 3.0.47 or later.
488 --- 1.0.20 2009/11/19
490 For filter virt_db, the database is a glob pattern and the virtual
491 database sections are consulted in the order given.
493 --- 1.0.19 2009/07/08
495 For filter multi, the target (for routing) may be given as a glob-pattern.
497 More documentation for filters virt_db and multi.
499 Update schema to allow for no database in sru_z3950 filter.
501 --- 1.0.18 2009/06/30
503 Added limit filter to put sleep (penalty) for heavy use.
505 Filter frontend_net may be configured to limit the number of new connections
506 from same IP to some value (connect-max).
508 Fixed the load_balance filter.
510 --- 1.0.17 2009/06/16
512 Fix path for metaproxy executable for Debian init.d script.
514 --- 1.0.16 2009/06/10
516 SRU to Z39.50 filter honors x-username and x-password. If only
517 x-username is given that translates to open authentication (Z39.50v2). If
518 both x-username and x-password is present that translates to idPass
519 authentication (Z39.50v3).
521 New facility to change current working directory (-w).
523 Update to upstream skeleton of init.d script. Should fix bug #2619.
525 Filter session_shared now caches records (used to only cache connections
528 Filter session_shared now invalidates a Z39.50 session if a server
529 returns -1 hits. This facility was also part of yazproxy and gets around
530 a bug in Voyager-based Z39.50 servers.
532 --- 1.0.15 2008/11/18
534 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
536 --- 1.0.14 2008/06/09
538 Fixed the value of SRU record schema in searchRetrieve response. It was set
539 to a fixed value of "dc" before.
541 Serialize identical SRU requests. This is useful if HTTP client software
542 fires identical requests against metaproxy.
544 Allow Z39.50 target to be specified for SRU requests by using SRU extra
545 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
546 avoid static configuration. This facility is handled by the sru_z3950 module
547 and the z3950_client module.
549 Allow maximum number of sockets to be used for a Z39.50 client by the
550 use of SRU extra parameter x-max-sockets. This facility is handled by the
551 sru_z3950 module and the z3950_client module.
553 --- 1.0.13.1 2008/02/29
555 Simplified check for Boost libraries.
557 --- 1.0.13 2008/02/29
559 First Debian package.
561 The sru_z9350 filter now recognizes SRU parameter z-target as being
562 a ZURL of the form host/database .
564 Mergetype may be specified for filter 'multi'.
566 --- 1.0.12 2007/09/19
568 Fixed problem in Makefile WRT library specifictions. This could produce
569 linker errors (when they should not happen).
571 Fixed bug #1341: MetaProxy returning different results. Problem was that
572 fix-up of record database did not normalize the database name.
574 Documentation updates for Windows compilation.
576 --- 1.0.11 2007/06/14
578 Fixed problem with logfile being truncated.
580 --- 1.0.10 2007/05/23
582 Fixed bug #1136: Access rights not enforced.
584 Extension for log module. The log category 'access' logs more details.
585 New category 'user-access' added which is simlar to 'access' but adds
586 the Z39.50 user as for all entries in a session.
590 Added support for configurable default/force target/vhost for module Z39.50
595 Implemented filter, session_shared, which optimizes usage of Z39.50
596 sessions and result sets.
598 New filter, record_transform, which converts MARC/XML records.
600 New filter, sru_z3950, which converts SRU to Z39.50 packages.
602 New filter, load_balance, in development.
604 New filter, zeerex_xplain.
606 XML framework for config files started.
608 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
609 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
610 XML config files are checked against RNG and XML Schema's.
612 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
613 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
614 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
615 explain record to YAZ CQL-to-PQF text config file.
619 Added 'timeout' setting for filter frontend_net which specifies the number
620 of seconds a session is idle before it is closed. Default timeout is
625 Database name in records returned set for virt_db/multi filters.
627 Filter session_shared now functional.
629 Log filter can be configured to write to a given file using 'filename'
630 element. Also information category can be specified with 'category'. If
631 filename is omitted, the log filter writes to stdout. See etc/config5.xml
636 Fixed compilation on Windows.
640 Added documentation for the hidenavailable option for the multi filter.
644 Fixed bug #573: Hide errors for individual servers. If the element
645 'hideunavailable' is given in the configuration, individual servers
646 being unavailable are hidden (unless all are unavailable).
648 Fixed bug #574: Database names are recognised case-sensitively.
650 Fixed bug #567: Fix up database name in Name-Plus-Record.
652 Fixed bug #568: Update win/makefile for VS 2005.
654 Fixed bug #569: Some options throws unknown exception.
658 More information about virtual hosts. The 'etc' directory is part of the
663 Build instructions for Windows. NMake makefile part of distribution tar.
669 Filters functional: auth_simple, backend_test, frontend_net, http_file,
670 log, multi, query_rewrite, template, virt_db, z3950_client.
672 Filters in development: session_shared.
674 Pseudo-filters: template, dl