3 Destroy router and filters in parent process MP-584
5 Update NMAKE makefile to use Visual Studio 2013 along with Boost 1.57,
6 ICU 54.1, Libxml2 2.9.2, Libxslt 1.1.28.
10 Use YAZ backtrace facility MP-582
12 Fix libmetaproxy-dev depends on libgnutls-dev - MP-580
13 libgnutls-dev is unavailable on jessie.
15 Update template filter to avoid Pimpl MP-579
17 cgi: POSTed content - part of MP-562
19 Fix filter cgi does not relay session close MP-577
23 Add support for binding outgoing IP for http_client and z3950_client
24 This is enabled by bind_host setting. MP-575
28 z3950_client: allows negotiation charset to be set MP-574
30 cgi: more functional but no support for POSTed content yet (part of MP-564)
34 http_file: add include of sys/stat.h fixes MP-576
36 Fix documentation about SRU client support MP-572
38 Initialize Libxml2 - for threaded operation MP-571
42 On SIGTERM shut down connection+listening sockets MP-568
43 This fixes a problem with 'metaproxy stop' sometimes taking a long time.
47 zoom: make retry on failure configurable MP-565
48 The default and existing behavior is that backend failures (any
49 diagnostic) makes the module re-search once. The behavior may
50 be changed by db parameter 'retry'. If given value '0' disables
51 retry and '1' enables it. If not given, the Torus record may
52 specify with element retryOnFailure (value '0'/'1').
56 Fix race condition in SIGTERM handling. Could terminate whole metaproxy
57 instead of just a child process. Extremely rare in real life, hit me with
58 CF stress testing. MP-559.
62 http_file: passthru option MP-557
63 New facility for http_file to passthru - even if an area is matched. The
64 default behavior (passthru=false) is to return 404: Not found. With
65 passthru=false, next filter is consulted.
69 Fix ref to freed memory in log filter 1line - MP-556
71 echoedSearchRetrieveRequest support MP-555
75 zoom: allow hostname to be given for ipauth MP-552
76 The Torus setting for that is called auth_hostname.
80 zoom: IP auth use field "ipRanges" rather than "ip" MP-551
84 session_shared: close in ~BackendInstance MP-549
85 This fixes a serious issue where some MP would leak sockets.
87 session_shared: mutex lock in BackendClass::release_backend MP-550
88 Fixes a SEGV that could occur (in rare cases).
92 zoom: Do not include ZOOM C's fake surrogate diag recs MP-547
94 zoom: fix invalid present response in some cases MP-546
96 zoom: Relay Torus HTTP error message
100 Check for proper limits before using RecordCache functions MP-544
104 Build packages for Ubuntu Trusty Tahr 14.04 LTS
106 sort: crash / invalid_read in filter sort MP-541
108 sru_z3950: facet should be stored in additionalSearchInfo MP-533
110 doc: fix missing man pages MP-542
112 cql_rpn: fix threading problem with CQL to RPN conversion MP-497
114 cql_rpn: allow conversion from RPN to CQL (reverse) MP-537
118 sru_z3950: fix facet response (memory corruption) MP-532
120 log: fix crash idPass user is omitted MP-530
124 query_rewrite: pass-thru non Type-1 queries MP-527
126 metaproxy stop (SIGTERM) kills all child processes spanwed by
127 filter (if any) before invoking filter destructors. MP-525
131 http_file: only supports HTTP GET MP-523
133 session_shared: shut down expire thread in destructor
134 This ensures that expire thread is not running after destruction
135 and does bad memory references, etc.
137 frontend_net: fix segfault on startup MP-524
138 Would happen if MP was listening on multiple ports and one
139 of the ports was already in use (and MP would exit).
141 frontend_net: fix memory leak MP-521
142 This leak would occur if all sessions were in use and the input
143 queue was cleared when a client would close connection (socket).
145 frontend_net: fix compilation on Windows (SIGUSR1 does not exist)
149 http_rewrite: use local skiplist; fixes memory corruption. MP-520
151 http_client: x-forwarded-for controls X-Forwarded-For presence
152 If x-forwarded-for setting (boolean) is enabled, http_client will
153 generate an X-Forwarded-For header entry which includes existing
154 X-Forwarded-For (if any) and current peer address (immediate client
155 of Metaproxy). By default x-forwarded-for disabled and X-Forwarded-For
156 will not be generated.
158 z3950_client: client_ip controls client-IP presence
159 If client_ip setting (boolean) is enabled, z3950_client will
160 generate a client_ip OID as part of init request which includes
161 previous client_ip (if any) and current peer address (immediate
162 client of Metaproxy). By default client_ip is disabled and client_ip
163 will not be generated.
165 HTTP X-Forwarded-For/Z39.50 Client-IP support
166 virt_db, multi: relays Z39.50 client-IP.
167 sru_z3950: converts X-Forwarded-For header to Z39.50 client-IP.
168 zoom: uses Client-IP or origin address (prefer Client-IP).
169 frontend_net: Strips tcp: from peer address (so that it is no longer
170 printed and stripped in zoom filter).
171 z3950_client: builds client-IP list - combining immediate peer address
172 as returned by COMSTACK and existing client-IP list (if avaiable).
173 The Origin only printes first X-Forwarded address.
177 Log when SIG{TERM,USR1} is received ASAP MP-513
178 Do it in frontend_net event loop rather than in place for metaproxy
179 main, which only exits when all sessions are terminated for SIGUSR1
182 metaproxy-config: quote some RHS values (that might include blanks)
184 Fix leak in sru_z3950 filter - when explain is returned MP-511
186 Allow stylesheet to be given for sru_z3950 filter MP-510
187 This is based on a patch by Sven Porst and the functionality
188 of the YAZ Generic Frontend Server.
190 Allow base attribute in configuration file tags - the attributes are
191 inserted by XInclude usage as mentioned on
192 yazlist: http://lists.indexdata.dk/pipermail/yazlist/2012-Au
193 and noted in a gist: https://gist.github.com/3551094
195 Package metaproxy provides virtual package metaproxy6 MP-508
196 This allows module packages to depend on a metaproxy server
199 Filter destructors called upon daemon termination MP-505
200 When metaproxy daemon receives SIGTERM the stop method of each filter
201 is called. The stop method existed before, but did not take any
202 arguements (void).. The frontend_net filter can now distinguish
203 between SIGUSR1 (stop bind, but keep sessions running) and SIGTERM
204 (stop immediately). Note that this changes the API+ABI of Metaproxy
207 zoom: sync up with Pazpar2 WRT authentication handling MP-492
209 Router: use shared_ptr rather than naked one - to avoid leak if an
210 exception is thrown in configure.
214 zoom: Add nocproxy=1 for contentConnector sessions MP-501
216 Doc: mention proper versions; fix link to Boost win binaries.
218 Windows: update for Boost 1.55
220 Windows: avoid warning when using boost::split. Done by defining
221 _SCL_SECURE_NO_WARNINGS for Visual Studio.
223 Fix LSB conformance for /etc/init.d/metaproxy MP-500
224 Debian: add support for /etc/init.d/metaproxy status
226 sort: Add const to Record less than operator in order to compile on
231 session_shared: fix element-set handling in record caching. MP-499
233 document http_rewrite. MP-468
235 http_write: Honor X-Metaproxy-SkipLink MP-479 . Filter understands and
236 respects the header (which will normally come from the cproxy filter)
240 RPM: fix dependency for libmetaproxy5-devel MP-496. The libmetaproxy5-devel
241 RPM was unsable in version 1.4.0.
243 Remove log message about "backend classes". Appeared in version 1.4.0.
247 Build RPM/Deb packages with YAZ 5 and yazpp 1.5. Metaproxy still compiles
248 with older version from source, but packages now use YAZ 5 that supports
251 sru_z3950: Fix SEGV for decoding invalid SRU requests
252 Incorrect reference to union (was explain response rather than
255 session_shared: match additionalSearchInfo (includes facets). In
256 layman's terms means that means that facets are properly handled
257 by this filter. Eg a change in requested facets will issue new
258 search and facets from exisiting result set are cached.
260 --- 1.3.62 2013/09/11
262 http_rewrite: better handling of <script> content in HTML parser. MP-486
264 http_rewrite: fix threading issue with regex. MP-482
266 bounce: don't use strdup for fixed length content. Error occurred in echo
269 session_shared: expire backend class when no instances left. This
270 means memory clean up, but not really a leak fix.
272 virt_db: fix leak for naked ptr.
274 cql_rpn: use config relative path for cql2rpn file. MP-481
276 Updates for upcoming YAZ 5.
278 --- 1.3.61 2013/08/29
280 New configuration directories ports.d/routes.d for metaproxy
281 configuration. This allows 3rd party packages to install config
282 for ports and new routes. MP-477
284 --- 1.3.60 2013/08/21
286 Fix metaproxy-config --libs to return non-mt over mt libs.
287 The -mt versions do not exist as shared objects and cause
288 linker errors for applications linking with Metaproxy.
289 Problem present in versions 1.3.56 - 1.3.59. MP-475
291 HTML: clean up char checks. Add ptr to HTML parse spec
293 HTML parser stops eating tag when <-char is met MP-473
295 rewrite: do not even compare content types, if we don't have any
296 the regex_match caused a segfault if we had no content-type in the
299 rewrite: within header=... matches only the header value
300 Used to match the whole header line, but we need to use
301 ^$ anchoring for host-relative regexps, and they need to
302 anchor at the ends of the value. MP-470.
304 rewrite: Ruleset functional MP-469
306 --- 1.3.59 2013/07/12
308 session_shared: negotiate init sz parameters.
309 By default, session_shared will honor the paramters given by client.
310 An alternative, but not implemented, algorithm would be to only
311 re-use sessions with same sz parameters. This however, could reduce
312 re-use of sessions a lot. Hence this, simple algorithm instead. The
313 negotiation to a maximum sz values can be enabled by using
314 <init maximum-record-size="sz1" preferred-message-size="sz2"/>
315 in configuration. This will make session_shared send those values
316 to backends and use returned init values in negotaition to
317 client before session_shared.
319 session_shared: resolve result-set references.
320 The reference is substitued with the query for old set if database
321 match and query type is Type-1. If not the reference will issue a
324 sort filter: relays RecordComposition including elementSet in use for
327 http_client: better diagnostics
329 http_client: disables HTTP redirect handling by default.
330 It can be configured with max-redirects in configuration.
332 --- 1.3.58 2013/06/12
334 Fix loading of filters cql_rpn and sru_z3950 . Was broken by 1.3.57.
336 --- 1.3.57 2013/06/12
338 Make RouterChain and RouterXML part of public API (libmetaproxy).
340 http_client: honor X-Metaproxy-Proxy as an alternative to
341 the "proxy" configuration. Allows proxy to be set per HTTP request.
343 sru_z3950: For SRU requests recognize x-client prefixes as a way
344 to ingest "database parameters".. The suffix of x-client- serves
345 as database argument name. Multiple may be given. For example:
346 http://path/db/?operation=searchRetrieve&x-client-user=a&x-client-password=b
347 is turned into Z39.50 database
350 --- 1.3.56 2013/05/27
352 New filter present_chunk. This filter allows splitting of present requests into smaller chunks.
354 New filter sd_remove, which replaces surrogate diagnostics with
355 SUTRS records. This filter tries to deal with clients that breaks
356 when receiving surrogate diagnostics.
358 new filter http_client. Same role as z3950_client, but just for
359 HTTP. Allows Metaproxy to operate as a HTTP proxy.
361 New filter http_rewrite1, which serves as purpose on how to rewrite
362 HTTP content with Metaproxy.
364 Use libboost-system if available, because newer versions of libboost-threads
365 requires libboost-system.
367 Allow frontend_net to serve SSL/HTTPS, because we can specify a server
370 --- 1.3.55 2013/04/10
372 zoom: Torus setting: authenticationMode which may hold values "basic"
375 --- 1.3.54 2013/03/27
377 configure: check for Libxslt support in YAZ and rely on definitions
378 from yaz-config, rather than doing own xslt/xml2 checks.
380 Allow timestamp format for log lines to be given with option -m
381 for metaproxy. Similar to yaz-ztest/GFS option -m.
383 Document log category 'line' for log filter.
385 Solr configuration example in etc/config-solr.xml
387 multi: do not mess with request package. For scan and search,
388 database-names were modified and the request package was left with
389 dangling pointers that caused a log filter to fail (request package
390 inspected after multi was invoked).
392 Documentation: fix id of metaproxy-config ref .
394 Documentation: update for USEMARCON support.
396 --- 1.3.53 2013/01/31
398 record_transform: allow OPACXML to OPAC conversion
400 zoom: document content-proxy
402 zoom: document db parm content-{user,password}, torus_url. Also
403 <torus auth_url="..> which makes zoom operate in authenticated mode
406 --- 1.3.52 2012/11/30
408 zoom: fix http://-check. SRU search broken in 1.3.51.
410 --- 1.3.51 2012/11/15
412 zoom: only append http:// for SRU if not already given . Makes it
413 possible to use https-URLs.
415 Use yazpp 1.4 or later due to new ABI.
417 frontend_net: allow max package size to be specified. Controlled by
418 attribute 'max_recv_bytes' of element 'port'.
420 --- 1.3.50 2012/10/29
422 For most generated diagnostics by filters, typically temporary
423 system error, augment addinfo message with filter name.
425 Add support for CentOS 6 packages.
427 sru_z3950: interpret Z39.50 diagnostics part of Init Response.
429 Add man page for metaproxy-config.
431 --- 1.3.49 2012/10/18
433 zoom: new config element passthru. This defines an element set that is
434 passed verbatim to the backend in pz2 mode.
436 auth_simple: allow both idPass and open auth. Also fix SEGV that could
439 --- 1.3.48 2012/10/08
441 z3950_client: fix string handling for init diagnostics in the case where
444 query_rewrite: no charset conversion for error queries. Avoid performing
445 charset conversion for query conversion errors. The resulting Type-1
446 query is invalid in this case.
448 --- 1.3.47 2012/10/04
450 For graceful stop (SIGUSR1), metaproxy will kill children processes.
452 Log when metaproxy is invoked in test mode (-t).
454 Log PID for each log message.
456 multi: combine both NSDs and multiple NSDs into one (diagnostics).
458 z3950_client: fixup multiple NSD's too. Like surrogate diagnostics,
459 a (backend=target) is appended for each diagnostic so that can be
460 determined the origin of error.
462 multi: hideerrors also in use for present response.
464 Solr example in zoom man page.
466 Fix typo in query_rewrite config example.
468 Log at least first non surrogate diagnostic. Instead of
469 "Z_Records_multipleNSD"
471 multi: Fix check for opt Records in present response. A SEGV could occur
472 if a target did not return records and no diagnostics.
474 --- 1.3.46 2012/09/24
476 Yet another fix for graceful stop.
478 --- 1.3.45 2012/09/12
480 sru_z3950: relay surrogate diagnostics.
482 --- 1.3.44 2012/09/10
484 zoom: Honor extraArgs, strip # in zurl.
486 multi: fix SEGV for scan. Reported by Rustam T. Usmanov.
488 zoom: url_recipe allow %{var[reg]} substitutions.
489 It's like ${var[reg]} but does URI component encoding as well.
491 --- 1.3.43 2012/08/22
493 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
494 non-keepalive HTTP sessions.
496 http_file: allow zero size files (bug fix)
498 Fix zoom schema: auth_url is optional
500 --- 1.3.42 2012/08/20
502 zoom: fix un-init memory (could result in SEGV at session close)
504 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
505 and may be used in filters as usual.
507 zoom: authentication via Torus lookup
508 Enabled by new configuration setting: auth_url . If this is defined,
509 the zoom module will contact Torus for auth/IP lookup and that will
510 define realm to be used in session.
512 --- 1.3.41 2012/08/10
514 virt_db: Fix database name - first character we removed by mistake.
515 Bug introduced in 1.3.40.
517 --- 1.3.40 2012/08/06
519 virt_db: Don't use "unix path" as database for Unix sockets.
521 --- 1.3.39 2012/08/02
523 z3950_client: Don't tamper with / in zurl - fixes problems
524 using Unix sockets for backends.
526 session_shared: fix integer overflow problem with hit count.
528 session_shared: avoid long usage of cached queries.
530 zoom: New database argument , torus_url to set URL of Torus
531 record to be fetched.
533 --- 1.3.38 2012/07/04
535 Fixes for 'metaproxy reload' for RPM/Debian packages.
537 zoom: Allow rpn2cql conversion to be augmented with a properties file.
538 Element rpn2cql can be specified per-target for the zoom filter.
540 log: New category "line" which is a single-line log message with
541 most important parts of a HTTP/Z39.50 request/response.
543 --- 1.3.37 2012/06/01
545 frontend_net: add facility to report live statistics about response
546 times and current thread usage. The report is an XML document
547 and is triggered for a specific URL path. This is set by <stat-req>
548 in the configuration of frontend_net. By default this report is
549 disabled (same as empty value for <stat-req>).
551 Fix reload problem in init.d script for RPM/Debian.
552 The '/etc/init.d/metaproxy reload' in some cases would stop but not
553 start metaproxy - effectively stopping the service.
555 Don't display start log message when config testing (-t).
557 zoom: avoid CCL message limit of 1K in ZOOM filter.
559 --- 1.3.36 2012/05/10
561 metaproxy init script reacts to reload which does graceful stop +
562 start and is used by logrorate script.
564 --- 1.3.35 2012/05/09
566 Fixes for Windows compilation.
568 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
569 existing sessions running but terminate the monitor process that is
570 used in keepalive mode.
572 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
573 before. Consistent with 'metaproxy stop' message.
575 zoom: document zoom's proxy_timeout
577 z3950_client: fixup addinfo for init response
579 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
580 "Access to specified database denied" is returned, but only if init
581 response from backend does not carry diagnostics already.
583 multi: relays user info for first rejected target. The other-information
584 field for init response for first rejected target is in common init
585 response. This ensures that some backend init diagnostics are returned to
588 --- 1.3.34 2012/04/25
590 frontend_log: extend logging (when message is given in config).
592 --- 1.3.33 2012/04/25
594 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
596 --- 1.3.32 2012/04/24
598 sru_z3950 filter passes through incoming Z39.50 requests again. Was
599 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
601 --- 1.3.31 2012/04/24
603 zoom: fixes for retry/proxy failover logic. More logging.
605 --- 1.3.30 2012/04/23
607 zoom: return addinfo="proxy failure" for proxy failures. This also
608 changes the scheme for dealing with proxies a bit. zoom now always
609 do proxy check, even if there's no failover. Fortunately, that's not
612 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
613 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
614 generic. We don't know why the init would fail; IP, user, block IP, etc.
615 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
617 zoom: guess if invalid SRU response was an auth failure
619 session_shared: disable session retry by default . Can be enabled by
620 restart="true" in resultset section.
622 --- 1.3.29 2012/04/18
624 zoom: may read cf-proxy's config settings.
625 This reduces manual configuration of the content proxy server host.
626 The ZOOM module will use the old style session.proxyhost if "server"
627 is given (deprecated) and use the new style proxyhost/session if
628 "config_file" is in use.
630 frontend_net: remove incoming requests that can not be handled
631 Requests in queue for filter frontend_net are removed if client
632 closes connection for the session and request is not yet handled.
634 sru_z3950: serialize requests. This is to ensure that pipelined
635 HTTP requests are handled properly.
637 --- 1.3.28 2012/04/04
639 New class, wrbuf, that wraps YAZ' WRBUF.
641 --- 1.3.27 2012/03/30
643 Metaproxy daemon is now running as user "metaproxy". This user is
644 managed by package maintainer scripts. The user information is stored
645 in /etc/metaproxy/metaproxy.user .
647 --- 1.3.26 2012/03/20
649 New filter, sort, that allows sorting of XML records via Z39.50
652 Filter record_transform: USEMarcon support. For example:
653 <retrieval syntax="usmarc">
654 <backend syntax="unimarc" name="F">
655 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
659 Filter multi: empty route pattern uses route as default.
661 <target route="z3950.indexdata.com">z3950.indexdata.com</route>
662 may use the shorter notation
663 <target route="z3950.indexdata.com"/>
665 Filter query_rewrite: use config path to locate XSLT.
667 Filter frontend_net: log statistics.
668 If a custom message element in frontend_net configuration it makes
669 the frontend_net filter produce a log entry whenever an operation
670 is completed. The log is always written using yaz_log with the
671 custom message given, the package ID (session ID) , the time
672 the operation has been active (end-to-end) , the threads currently
673 active/total and the size of the request input/output queues.
675 query_rewrite: charset conversion of query terms.
676 This is an optional feature. Enabled by element <charset> in
677 configuration with attribute 'from' and 'to' that specifies
678 from/to encodings. The default 'from' encoding is UTF-8.
680 Filter record_transform: honor piggyback searches.
682 Filter zoom: re-connect when database is reused.
683 Re-connect is necessary if a connection is lost or a timeout occurs.
684 If not, we'll be seeing zero hits, when we shouldn't.
686 --- 1.3.25 2012/02/29
688 zoom: Change scheme for dealing with content proxy URLs. The module
689 now has its own common XSL transform that is enabled by record_xsl
690 attribute in the configuration. This XSL gets parameter cproxyhost
691 that holds the host for the content proxy session . The genearted-url
692 is created only if urlRecipe is enabled. In previous version default
693 value of urlRecipe was ${md-electronic-url}; it is now empty and
694 disabled by default. Also generated-url no longer includes the content
695 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
698 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
699 connections. Default value is 40 (seconds).
701 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
702 "Malformed query" for syntax errors and related ones; throw
703 Bib-1: 3 "Unsupported search" for everything else. Details from
704 the CCL parser is provided as additional-info.
706 multi: new setting hideerrors that makes multi only relay diagnostics
707 to a client if all backends fail.
709 --- 1.3.24 2012/02/23
711 zoom: empty ccl_map field-mappings disables CCL map.
713 zoom: fix Explain search that could return error if session was
716 --- 1.3.23 2012/02/10
718 zoom: returns Explain records for database IR-Explain---1. The
719 target profile records are converted to Explain records via XSLT.
721 session_shared: make error recovery configurable. Whether a search
722 is restarted on errors or not, is configurable by attribute "restart"
723 in element "resultset" in configuration.
725 session_shared: only relay init for first request. session_shared, for
726 each backend class, now only relays first init request (rather than all).
727 The module only needs to save init response info once. This avoids the
728 need to check for session max.
730 --- 1.3.22 2012/02/02
732 zoom: fix memory leaks.
734 session_shared: maximum number of sessons is configurable. Default
735 value is 100. Result-sets for backends without named result sets are
736 only re-used if databases is identical for a search. This is under the
737 assumption that performance may suffer for those backends when
738 changing the database for each search.
740 multi: combines diagnostics from all backends. All diagnostics from
741 backends are combined into multiple non-surrogate diagnostics; rather
742 than just one diagnostic from first backend.
744 --- 1.3.21 2011/12/27
746 zoom: relay realm to cproxy parameter file.
748 Configuration: Allow filter collection element inside route. This
749 makes it possible to include multiple filters at once.
751 zoom: nocproxy also disables urlRecipe.
753 --- 1.3.20 2011/12/21
755 zoom: return diagnostic if CQL sortby conv fails. Diagnostic Bib-1 214
756 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
757 90: "Unsupported direction value".
759 zoom: honor database argument nocproxy. This disables creating a content
760 connector session (for non-CF targets, usually) and also relays nocproxy
761 as database argument to a CF target.
763 --- 1.3.19 2011/12/16
765 zoom: Multiple proxy hosts may be given for proxy rich database
766 parameter. List is comma separated.
768 http_file: decodes URI paths properly. Does not return 404: not found
769 if no prefix are matches. Instead packages are passed on.
771 --- 1.3.18 2011/12/08
773 zoom: content-{user,password,proxy} are passed on to content proxy
774 system and takes precedence over user,password,proxy .
776 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
777 with a log element including log material from children filters. At
778 this point, only the zoom filter uses this log facility. It will
779 eventually be used by other filters as well. In particular it might be
780 useful for this feature to track all filters in used during a search.
782 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
783 and queries as they are manipulated are logged.
785 zoom: extend addinfo with native diagnostics. Diagnostics as received
786 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
787 diagnostics. This indicates both a backend diagnostic and the original
790 zoom: default urlRecipe value is ${md-electronic-url}
792 zoom: target profile setting sruVersion is recognized.
794 --- 1.3.17 2011/11/17
796 zoom: log target profile record fetched (AKA Torus).
798 --- 1.3.16 2011/11/17
800 Change target profile parameter CfSubDb to CfSubDB.
802 --- 1.3.15 2011/11/12
804 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
805 makes sense to the zoom module itself).
807 --- 1.3.14 2011/11/11
809 zoom: realm may be given as part of database.
811 --- 1.3.13 2011/10/26
813 Fix Origin class assigment method; was removd by mistake in 1.3.12.
815 --- 1.3.12 2011/10/26
817 zoom: database args x-name=value are passed through to backend database.
819 SRU filter: user may specify session ID that is passed to log entries
820 that follows. It is specified by using x-session-id in the SRU arguments.
822 zoom: fix null pointer reference which would occur for bad url parameter
823 inside "torus" or if url was not given.
825 --- 1.3.11 2011/09/09
826 Fix bug in filter session_shared where sessions would not expire
827 properly (session ttl). This in turn could make the target close the
828 connection before expected and session_shared would return diagnostic
829 2: system temporarily available.
831 --- 1.3.10 2011/09/09
833 zoom: new target profile setting: sortmap_field. If sortmap_field is given
834 the field is mapped to the value for the sortmap. Values not matching
835 sortmap_field are passed verbatim.
837 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
838 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
839 depending on whether RPN or CQL is actually sent to the target.
843 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
845 zoom: For content proxy authentication is stored in param name
846 "auth", instead of "authentication".
850 zoom: relay schema in SRU mode. Previously recordSchema was not affected
855 zoom: new target profile element literalTransform that holds XSLT
856 (encoded as string) for target. Only if present and non-zero length it is
857 considered present. This takes precedence over transform.
859 Don't rely on trang anymore for Git checkout builds. Configuration in etc
860 will only be properly validated if trang is available. From now on only
861 relax NC files are bundled with the source dist.
863 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
864 component was not detected when it should be.
868 z3950_client: mark non-surrogate diagnostics from backend.
870 zoom: a proxy may be specified for HTTP fetch of target profiles.
874 Honor piggyback. Makes some SRU targets behave that insist on
875 maximumRecords > 0, but also increases performance.
879 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
880 file was not update for libdir/metaproxy4 in version 1.3.2.
884 Change location of Metaproxy modules from libdir/metaproxy to
885 libdir/metaproxy4. Directory libdir/metaproxy is also owned by
886 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
888 New facility to dump APDUs from zoom filter. Enabled by
889 <log apdu="true"/> in the zoom filter configuation.
891 zoom filter bug fix: SRU diagnostics received from backend was
892 not properly converted to Bib-1 diagnostics.
894 Package metaproxy depends on libmetaproxy4, same version.
898 zoom: fix a bug WRT passing authentication parameters to backends.
902 Fixes for windows Makefile.
904 --- 1.2.10 2011/07/25
906 Change major version of metaproxy library from 3 to 4. This in turn
907 makes new package names for Debian and RPM.
911 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
914 zoom: configurable element sets for record transforms.
916 zoom: the target profile based transform is specified by element_transform
917 in element torus of of the ZOOM filter configuration ; default value
918 is "pz2". Target profile based retrieval is specified by element_raw
919 in configuration. It will perform same steps, but omit the XSL transform.
920 Default value is "raw".
922 zoom: element set is omitted if not set in profile. But only if pz2
923 transform is in effect. Previously the default element set was to "F".
925 zoom: For non-CF targets database arguments are parsed. User may supply
926 db,user=myuser&password=mypass for non-CF targets. These values override
927 what's given the authentication from the target profile.
929 session_shared: fix reference to freed memory. Would occur if a search
930 response had non-surrogate diagnostics.
934 Route may be given for each port in frontend_net.
938 Documentation for zoom filter. Local target profiles may be specified.
940 Fixes for zoom filter.
944 First version with zoom filter.
948 Filter z3950_client may be configured to always send a close APDU
949 to backend target when connection/session is closed. This will only
950 happen if close APDU is not already sent. Enabled by configuration
951 for z3950_client (force_close).
953 Filter virt_db and multi: relay close APDU.
955 Filter virt_db and multi: relay init size parameters
956 preferredMessageSize and maximumRecordSize.
958 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
962 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
964 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
965 as determined by configure.
967 RPM: Release includes 'indexdata' name. Use indexdata in release name so
968 this package can be distinguished from other vendors.
972 Fix filter multi: relay idAuthentication parameters.
976 Add metaproxy-config for returning compiler flags, libraries.
980 Fix --with-boost=PREFIX .
984 session_shared: fix use of maintenance thread.
986 Introduce 'start' method for filters and routers. It gets called after
987 configure and after fork, but before processing. This changes API -
988 from libmetaproxy2 to libmetaproxy3.
992 session_shared: ensure backend session is closed if init rejected
995 z3950_client: fix NULL ptr reference that could occur if two clients
996 connected concurrently and if max-sockets was in effect.
1000 Fix bug 3497 - Metaproxy unstable while stopping.
1002 Fix bug 3495 - SEGV in SRU filter.
1004 --- 1.1.5 2010/06/15
1006 Filter multi throws diagnostic 'Present Out of Range' when
1007 appropriate - rather than returning 0 records.
1009 Filter virt_db: fix bad result reuse. Could happen if a result
1010 was overriden and a backend did not supported named result sets.
1012 --- 1.1.4 2010/05/11
1014 Filter log: category access logs diagnostics even if searchStatus
1015 or presentStatus is 'success'.
1017 --- 1.1.3 2010/04/21
1019 The SRU to Z39.50 filter does repeated Z39.50 present requests
1020 to fetch all records. Needed when a Z39.50 server returns partial
1021 results (due to message size limits).
1023 --- 1.1.2 2010/03/18
1025 Metaproxy now kills all child processes that are spawned by
1026 modules (in case of fork, exec).
1028 --- 1.1.1 2010/01/28
1030 Debian package now installs /etc/metaproxy/metaproxy.xml which
1031 includes all XML files /etc/metaproxy/filters-enabled .
1032 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
1034 --- 1.1.0 2010/01/20
1036 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
1037 development package to facilitate 3rd party Metaproxy modules.
1039 --- 1.0.23 2010/01/04
1041 Filter virt_db: Close backend filter session when Init rejected is received
1042 from it (in which case it's not really closed yet). This will ensure we don't
1043 run out of resources such as FDs in this case.
1045 sru_z3950 filter: Accept any database (including those not listed).
1047 --- 1.0.22 2009/12/03
1049 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
1050 later which means YAZ 3.0.47 or later.
1052 --- 1.0.20 2009/11/19
1054 For filter virt_db, the database is a glob pattern and the virtual
1055 database sections are consulted in the order given.
1057 --- 1.0.19 2009/07/08
1059 For filter multi, the target (for routing) may be given as a glob-pattern.
1061 More documentation for filters virt_db and multi.
1063 Update schema to allow for no database in sru_z3950 filter.
1065 --- 1.0.18 2009/06/30
1067 Added limit filter to put sleep (penalty) for heavy use.
1069 Filter frontend_net may be configured to limit the number of new connections
1070 from same IP to some value (connect-max).
1072 Fixed the load_balance filter.
1074 --- 1.0.17 2009/06/16
1076 Fix path for metaproxy executable for Debian init.d script.
1078 --- 1.0.16 2009/06/10
1080 SRU to Z39.50 filter honors x-username and x-password. If only
1081 x-username is given that translates to open authentication (Z39.50v2). If
1082 both x-username and x-password is present that translates to idPass
1083 authentication (Z39.50v3).
1085 New facility to change current working directory (-w).
1087 Update to upstream skeleton of init.d script. Should fix bug #2619.
1089 Filter session_shared now caches records (used to only cache connections
1092 Filter session_shared now invalidates a Z39.50 session if a server
1093 returns -1 hits. This facility was also part of yazproxy and gets around
1094 a bug in Voyager-based Z39.50 servers.
1096 --- 1.0.15 2008/11/18
1098 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
1100 --- 1.0.14 2008/06/09
1102 Fixed the value of SRU record schema in searchRetrieve response. It was set
1103 to a fixed value of "dc" before.
1105 Serialize identical SRU requests. This is useful if HTTP client software
1106 fires identical requests against metaproxy.
1108 Allow Z39.50 target to be specified for SRU requests by using SRU extra
1109 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
1110 avoid static configuration. This facility is handled by the sru_z3950 module
1111 and the z3950_client module.
1113 Allow maximum number of sockets to be used for a Z39.50 client by the
1114 use of SRU extra parameter x-max-sockets. This facility is handled by the
1115 sru_z3950 module and the z3950_client module.
1117 --- 1.0.13.1 2008/02/29
1119 Simplified check for Boost libraries.
1121 --- 1.0.13 2008/02/29
1123 First Debian package.
1125 The sru_z9350 filter now recognizes SRU parameter z-target as being
1126 a ZURL of the form host/database .
1128 Mergetype may be specified for filter 'multi'.
1130 --- 1.0.12 2007/09/19
1132 Fixed problem in Makefile WRT library specifictions. This could produce
1133 linker errors (when they should not happen).
1135 Fixed bug #1341: MetaProxy returning different results. Problem was that
1136 fix-up of record database did not normalize the database name.
1138 Documentation updates for Windows compilation.
1140 --- 1.0.11 2007/06/14
1142 Fixed problem with logfile being truncated.
1144 --- 1.0.10 2007/05/23
1146 Fixed bug #1136: Access rights not enforced.
1148 Extension for log module. The log category 'access' logs more details.
1149 New category 'user-access' added which is simlar to 'access' but adds
1150 the Z39.50 user as for all entries in a session.
1154 Added support for configurable default/force target/vhost for module Z39.50
1157 --- 1.0.8 2007/01/25
1159 Implemented filter, session_shared, which optimizes usage of Z39.50
1160 sessions and result sets.
1162 New filter, record_transform, which converts MARC/XML records.
1164 New filter, sru_z3950, which converts SRU to Z39.50 packages.
1166 New filter, load_balance, in development.
1168 New filter, zeerex_xplain.
1170 XML framework for config files started.
1172 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
1173 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
1174 XML config files are checked against RNG and XML Schema's.
1176 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of
1177 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
1178 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX
1179 explain record to YAZ CQL-to-PQF text config file.
1181 --- 1.0.7 2006/11/07
1183 Added 'timeout' setting for filter frontend_net which specifies the number
1184 of seconds a session is idle before it is closed. Default timeout is
1187 --- 1.0.6 2006/07/07
1189 Database name in records returned set for virt_db/multi filters.
1191 Filter session_shared now functional.
1193 Log filter can be configured to write to a given file using 'filename'
1194 element. Also information category can be specified with 'category'. If
1195 filename is omitted, the log filter writes to stdout. See etc/config5.xml
1198 --- 1.0.5 2006/05/16
1200 Fixed compilation on Windows.
1202 --- 1.0.4 2006/05/16
1204 Added documentation for the hidenavailable option for the multi filter.
1206 --- 1.0.3 2006/05/16
1208 Fixed bug #573: Hide errors for individual servers. If the element
1209 'hideunavailable' is given in the configuration, individual servers
1210 being unavailable are hidden (unless all are unavailable).
1212 Fixed bug #574: Database names are recognised case-sensitively.
1214 Fixed bug #567: Fix up database name in Name-Plus-Record.
1216 Fixed bug #568: Update win/makefile for VS 2005.
1218 Fixed bug #569: Some options throws unknown exception.
1220 --- 1.0.2 2006/04/28
1222 More information about virtual hosts. The 'etc' directory is part of the
1225 --- 1.0.1 2006/04/27
1227 Build instructions for Windows. NMake makefile part of distribution tar.
1229 --- 1.0.0 2006/04/24
1233 Filters functional: auth_simple, backend_test, frontend_net, http_file,
1234 log, multi, query_rewrite, template, virt_db, z3950_client.
1236 Filters in development: session_shared.
1238 Pseudo-filters: template, dl