Version 1.8.5
[metaproxy-moved-to-github.git] / NEWS
1 --- 1.8.5 2015/03/17
2
3 sru_z3950: undo Serialize identical SRU GET requests MP-598
4 Now much more elegantly handled by session_shared.
5
6 session_shared: anticipated init and search MP-597
7
8 z3950_client: separate init timeout MP-596
9 Both init-timeout and connect-timeout are configurable by this change.
10 Default is 10 seconds.
11
12 --- 1.8.4 2015/03/16
13
14 zoom: support cf_-params MP-595
15
16 http_client: returns 404 if no destination URI is given
17
18 --- 1.8.3 2015/02/10
19
20 zoom: allow / in user and password db args MP-592
21
22 --- 1.8.2 2015/02/02
23
24 Log rotate no longer reloads configuration - instead Metaproxy just
25 re-opens log files when SIGHUP is received. MP-485
26
27 Debian : init.d metaproxy reload should check configuration MP-591
28
29 Fix Metaproxy stops logging after check config failed MP-590
30
31 --- 1.8.1 2015/01/19
32
33 Fix double free in log filter (with incorrect config) MP-589
34
35 zoom: Add allow_ip feature - fixes MP-588
36 Allow a list of IPs to be given separated by blanks
37 <allow auth_url="http://mkc-admin.indexdata.com/..."
38    allow_ip="127.0.0.1 ::1" .. >
39
40 cql2pqf.txt: Maps dc.subject to Bib-1 21 rather than 47
41
42 zoom: fix CS write-check
43
44 --- 1.8.0 2015/01/08
45
46 zoom: handle contentAuthentication MP-587
47
48 --- 1.7.2 2014/12/16
49
50 Destroy router and filters in parent process MP-584
51
52 Update NMAKE makefile to use Visual Studio 2013 along with Boost 1.57,
53 ICU 54.1, Libxml2 2.9.2, Libxslt 1.1.28.
54
55 --- 1.7.1 2014/12/02
56
57 Use YAZ backtrace facility MP-582
58
59 Fix libmetaproxy-dev depends on libgnutls-dev - MP-580
60 libgnutls-dev is unavailable on jessie.
61
62 Update template filter to avoid Pimpl MP-579
63
64 cgi: POSTed content - part of MP-562
65
66 Fix filter cgi does not relay session close MP-577
67
68 --- 1.7.0 2014/10/28
69
70 Add support for binding outgoing IP for http_client and z3950_client
71 This is enabled by bind_host setting. MP-575
72
73 --- 1.6.0 2014/10/21
74
75 z3950_client: allows negotiation charset to be set MP-574
76
77 cgi: more functional but no support for POSTed content yet (part of MP-564)
78
79 --- 1.5.11 2014/10/20
80
81 http_file: add include of sys/stat.h fixes MP-576
82
83 Fix documentation about SRU client support MP-572
84
85 Initialize Libxml2 - for threaded operation MP-571
86
87 --- 1.5.10 2014/08/26
88
89 On SIGTERM shut down connection+listening sockets MP-568
90 This fixes a problem with 'metaproxy stop' sometimes taking a long time.
91
92 --- 1.5.9 2014/08/15
93
94 zoom: make retry on failure configurable MP-565
95 The default and existing behavior is that backend failures (any
96 diagnostic) makes the module re-search once. The behavior may
97 be changed by db parameter 'retry'. If given value '0' disables
98 retry and '1' enables it. If not given, the Torus record may
99 specify with element retryOnFailure (value '0'/'1').
100
101 --- 1.5.8 2014/08/01
102
103 Fix race condition in SIGTERM handling. Could terminate whole metaproxy
104 instead of just a child process. Extremely rare in real life, hit me with
105 CF stress testing. MP-559.
106
107 --- 1.5.7 2014/07/15
108
109 http_file: passthru option MP-557
110 New facility for http_file to passthru - even if an area is matched. The
111 default behavior (passthru=false) is to return 404: Not found. With
112 passthru=false, next filter is consulted.
113
114 --- 1.5.6 2014/07/14
115
116 Fix ref to freed memory in log filter 1line - MP-556
117
118 echoedSearchRetrieveRequest support MP-555
119
120 --- 1.5.5 2014/06/06
121
122 zoom: allow hostname to be given for ipauth MP-552
123 The Torus setting for that is called auth_hostname.
124
125 --- 1.5.4 2014/06/04
126
127 zoom: IP auth use field "ipRanges" rather than "ip" MP-551
128
129 --- 1.5.3 2014/06/03
130
131 session_shared: close in ~BackendInstance MP-549
132 This fixes a serious issue where some MP would leak sockets.
133
134 session_shared: mutex lock in BackendClass::release_backend MP-550
135 Fixes a SEGV that could occur (in rare cases).
136
137 --- 1.5.2 2014/05/22
138
139 zoom: Do not include ZOOM C's fake surrogate diag recs MP-547
140
141 zoom: fix invalid present response in some cases MP-546
142
143 zoom: Relay Torus HTTP error message
144
145 --- 1.5.1 2014/04/28
146
147 Check for proper limits before using RecordCache functions MP-544
148
149 --- 1.5.0 2014/04/24
150
151 Build packages for Ubuntu Trusty Tahr 14.04 LTS
152
153 sort: crash / invalid_read in filter sort MP-541
154
155 sru_z3950: facet should be stored in additionalSearchInfo MP-533
156
157 doc: fix missing man pages MP-542
158
159 cql_rpn: fix threading problem with CQL to RPN conversion MP-497
160
161 cql_rpn: allow conversion from RPN to CQL (reverse) MP-537
162
163 --- 1.4.8 2014/04/02
164
165 sru_z3950: fix facet response (memory corruption) MP-532
166
167 log: fix crash idPass user is omitted MP-530
168
169 --- 1.4.7 2014/03/25
170
171 query_rewrite: pass-thru non Type-1 queries MP-527
172
173 metaproxy stop (SIGTERM) kills all child processes spanwed by
174 filter (if any) before invoking filter destructors. MP-525
175
176 --- 1.4.6 2014/03/21
177
178 http_file: only supports HTTP GET MP-523
179
180 session_shared: shut down expire thread in destructor
181 This ensures that expire thread is not running after destruction
182 and does bad memory references, etc.
183
184 frontend_net: fix segfault on startup MP-524
185 Would happen if MP was listening on multiple ports and one
186 of the ports was already in use (and MP would exit).
187
188 frontend_net: fix memory leak MP-521
189 This leak would occur if all sessions were in use and the input
190 queue was cleared when a client would close connection (socket).
191
192 frontend_net: fix compilation on Windows (SIGUSR1 does not exist)
193
194 --- 1.4.5 2014/03/14
195
196 http_rewrite: use local skiplist; fixes memory corruption. MP-520
197
198 http_client: x-forwarded-for controls X-Forwarded-For presence
199 If x-forwarded-for setting (boolean) is enabled, http_client will
200 generate an X-Forwarded-For header entry which includes existing
201 X-Forwarded-For (if any) and current peer address (immediate client
202 of Metaproxy). By default x-forwarded-for disabled and X-Forwarded-For
203 will not be generated.
204
205 z3950_client: client_ip controls client-IP presence
206 If client_ip setting (boolean) is enabled, z3950_client will
207 generate a client_ip OID as part of init request which includes
208 previous client_ip (if any) and current peer address (immediate
209 client of Metaproxy). By default client_ip is disabled and client_ip
210 will not be generated.
211
212 HTTP X-Forwarded-For/Z39.50 Client-IP support
213 virt_db, multi: relays Z39.50 client-IP.
214 sru_z3950: converts X-Forwarded-For header to Z39.50 client-IP.
215 zoom: uses Client-IP or origin address (prefer Client-IP).
216 frontend_net: Strips tcp: from peer address (so that it is no longer
217 printed and stripped in zoom filter).
218 z3950_client: builds client-IP list - combining immediate peer address
219 as returned by COMSTACK and existing client-IP list (if avaiable).
220 The Origin only printes first X-Forwarded address.
221
222 --- 1.4.4 2014/02/18
223
224 Log when SIG{TERM,USR1} is received ASAP MP-513
225 Do it in frontend_net event loop rather than in place for metaproxy
226 main, which only exits when all sessions are terminated for SIGUSR1
227 at graceful stop.
228
229 metaproxy-config: quote some RHS values (that might include blanks)
230
231 Fix leak in sru_z3950 filter - when explain is returned MP-511
232
233 Allow stylesheet to be given for sru_z3950 filter MP-510
234 This is based on a patch by Sven Porst and the functionality
235 of the YAZ Generic Frontend Server.
236
237 Allow base attribute in configuration file tags - the attributes are
238 inserted by XInclude usage as mentioned on
239 yazlist: http://lists.indexdata.dk/pipermail/yazlist/2012-Au
240 and noted in a gist: https://gist.github.com/3551094
241
242 Package metaproxy provides virtual package metaproxy6 MP-508
243 This allows module packages to depend on a metaproxy server
244 with version 6 API.
245
246 Filter destructors called upon daemon termination MP-505
247 When metaproxy daemon receives SIGTERM the stop method of each filter
248 is called. The stop method existed before, but did not take any
249 arguements (void).. The frontend_net filter can now distinguish
250 between SIGUSR1 (stop bind, but keep sessions running) and SIGTERM
251 (stop immediately). Note that this changes the API+ABI of Metaproxy
252 filters.
253
254 zoom: sync up with Pazpar2 WRT authentication handling MP-492
255
256 Router: use shared_ptr rather than naked one - to avoid leak if an
257 exception is thrown in configure.
258
259 --- 1.4.3 2013/12/10
260
261 zoom: Add nocproxy=1 for contentConnector sessions MP-501
262
263 Doc: mention proper versions; fix link to Boost win binaries.
264
265 Windows: update for Boost 1.55
266
267 Windows: avoid warning when using boost::split. Done by defining
268 _SCL_SECURE_NO_WARNINGS for Visual Studio.
269
270 Fix LSB conformance for /etc/init.d/metaproxy MP-500
271 Debian: add support for /etc/init.d/metaproxy status
272
273 sort: Add const to Record less than operator in order to compile on
274 OS X Maverick.
275
276 --- 1.4.2 2013/11/15
277
278 session_shared: fix element-set handling in record caching. MP-499
279
280 document http_rewrite. MP-468
281
282 http_write: Honor X-Metaproxy-SkipLink MP-479 . Filter understands and
283 respects the header (which will normally come from the cproxy filter)
284
285 --- 1.4.1 2013/10/31
286
287 RPM: fix dependency for libmetaproxy5-devel MP-496. The libmetaproxy5-devel
288 RPM was unsable in version 1.4.0.
289
290 Remove log message about "backend classes". Appeared in version 1.4.0.
291
292 --- 1.4.0 2013/10/04
293
294 Build RPM/Deb packages with YAZ 5 and yazpp 1.5. Metaproxy still compiles
295 with older version from source, but packages now use YAZ 5 that supports
296 SRU 2.0.
297
298 sru_z3950: Fix SEGV for decoding invalid SRU requests
299 Incorrect reference to union (was explain response rather than
300 search response).
301
302 session_shared: match additionalSearchInfo (includes facets). In
303 layman's terms means that means that facets are properly handled
304 by this filter. Eg a change in requested facets will issue new
305 search and facets from exisiting result set are cached.
306
307 --- 1.3.62 2013/09/11
308
309 http_rewrite: better handling of <script> content in HTML parser. MP-486
310
311 http_rewrite: fix threading issue with regex. MP-482
312
313 bounce: don't use strdup for fixed length content. Error occurred in echo
314 mode only.
315
316 session_shared: expire backend class when no instances left. This
317 means memory clean up, but not really a leak fix.
318
319 virt_db: fix leak for naked ptr.
320
321 cql_rpn: use config relative path for cql2rpn file. MP-481
322
323 Updates for upcoming YAZ 5.
324
325 --- 1.3.61 2013/08/29
326
327 New configuration directories ports.d/routes.d for metaproxy
328 configuration. This allows 3rd party packages to install config
329 for ports and new routes. MP-477
330
331 --- 1.3.60 2013/08/21
332
333 Fix metaproxy-config --libs to return non-mt over mt libs.
334 The -mt versions do not exist as shared objects and cause
335 linker errors for applications linking with Metaproxy.
336 Problem present in versions 1.3.56 - 1.3.59. MP-475
337
338 HTML: clean up char checks. Add ptr to HTML parse spec
339
340 HTML parser stops eating tag when <-char is met  MP-473
341
342 rewrite: do not even compare content types, if we don't have any
343 the regex_match caused a segfault if we had no content-type in the
344 headers. MP-471
345
346 rewrite: within header=... matches only the header value
347 Used to match the whole header line, but we need to use
348 ^$ anchoring for host-relative regexps, and they need to
349 anchor at the ends of the value. MP-470.
350
351 rewrite: Ruleset functional MP-469
352
353 --- 1.3.59 2013/07/12
354
355 session_shared: negotiate init sz parameters.
356 By default, session_shared will honor the paramters given by client.
357 An alternative, but not implemented, algorithm would be to only
358 re-use sessions with same sz parameters. This however, could reduce
359 re-use of sessions a lot. Hence this, simple algorithm instead. The
360 negotiation to a maximum sz values can be enabled by using
361    <init maximum-record-size="sz1" preferred-message-size="sz2"/>
362 in configuration. This will make session_shared send those values
363 to backends and use returned init values in negotaition to
364 client before session_shared.
365
366 session_shared: resolve result-set references.
367 The reference is substitued with the query for old set if database
368 match and query type is Type-1. If not the reference will issue a
369 diagnostic.
370
371 sort filter: relays RecordComposition including elementSet in use for
372 search.
373
374 http_client: better diagnostics
375
376 http_client: disables HTTP redirect handling by default.
377 It can be configured with max-redirects in configuration.
378
379 --- 1.3.58 2013/06/12
380
381 Fix loading of filters cql_rpn and sru_z3950 . Was broken by 1.3.57.
382
383 --- 1.3.57 2013/06/12
384
385 Make RouterChain and RouterXML part of public API (libmetaproxy).
386
387 http_client: honor X-Metaproxy-Proxy as an alternative to
388 the "proxy" configuration. Allows proxy to be set per HTTP request.
389
390 sru_z3950: For SRU requests recognize x-client prefixes as a way
391 to ingest "database parameters".. The suffix of x-client- serves
392 as database argument name. Multiple may be given. For example:
393   http://path/db/?operation=searchRetrieve&x-client-user=a&x-client-password=b
394 is turned into Z39.50 database
395   db,user=a&password=b
396
397 --- 1.3.56 2013/05/27
398
399 New filter present_chunk. This filter allows splitting of present requests into smaller chunks.
400
401 New filter sd_remove, which replaces surrogate diagnostics with
402 SUTRS records. This filter tries to deal with clients that breaks
403 when receiving surrogate diagnostics.
404
405 new filter http_client. Same role as z3950_client, but just for
406 HTTP. Allows Metaproxy to operate as a HTTP proxy.
407
408 New filter http_rewrite1, which serves as purpose on how to rewrite
409 HTTP content with Metaproxy.
410
411 Use libboost-system if available, because newer versions of libboost-threads
412 requires libboost-system.
413
414 Allow frontend_net to serve SSL/HTTPS, because we can specify a server
415 certificate now.
416
417 --- 1.3.55 2013/04/10
418
419 zoom: Torus setting: authenticationMode which may hold values "basic"
420 and "url".
421
422 --- 1.3.54 2013/03/27
423
424 configure: check for Libxslt support in YAZ and rely on definitions
425 from yaz-config, rather than doing own xslt/xml2 checks.
426
427 Allow timestamp format for log lines to be given with option -m
428 for metaproxy. Similar to yaz-ztest/GFS option -m.
429
430 Document log category 'line' for log filter.
431
432 Solr configuration example in etc/config-solr.xml
433
434 multi: do not mess with request package. For scan and search,
435 database-names were modified and the request package was left with
436 dangling pointers that caused a log filter to fail (request package
437 inspected after multi was invoked).
438
439 Documentation: fix id of metaproxy-config ref .
440
441 Documentation: update for USEMARCON support.
442
443 --- 1.3.53 2013/01/31
444
445 record_transform: allow OPACXML to OPAC conversion
446
447 zoom: document content-proxy
448
449 zoom: document db parm content-{user,password}, torus_url. Also
450 <torus auth_url="..> which makes zoom operate in authenticated mode
451 via Torus lookup.
452
453 --- 1.3.52 2012/11/30
454
455 zoom: fix http://-check. SRU search broken in 1.3.51.
456
457 --- 1.3.51 2012/11/15
458
459 zoom: only append http:// for SRU if not already given . Makes it
460 possible to use https-URLs.
461
462 Use yazpp 1.4 or later due to new ABI.
463
464 frontend_net: allow max package size to be specified. Controlled by
465 attribute 'max_recv_bytes' of element 'port'.
466
467 --- 1.3.50 2012/10/29
468
469 For most generated diagnostics by filters, typically temporary
470 system error, augment addinfo message with filter name.
471
472 Add support for CentOS 6 packages.
473
474 sru_z3950: interpret Z39.50 diagnostics part of Init Response.
475
476 Add man page for metaproxy-config.
477
478 --- 1.3.49 2012/10/18
479
480 zoom: new config element passthru. This defines an element set that is
481 passed verbatim to the backend in pz2 mode.
482
483 auth_simple: allow both idPass and open auth. Also fix SEGV that could
484 occur for open auth.
485
486 --- 1.3.48 2012/10/08
487
488 z3950_client: fix string handling for init diagnostics in the case where
489 addinfo was absent.
490
491 query_rewrite: no charset conversion for error queries. Avoid performing
492 charset conversion for query conversion errors. The resulting Type-1
493 query is invalid in this case.
494
495 --- 1.3.47 2012/10/04
496
497 For graceful stop (SIGUSR1), metaproxy will kill children processes.
498
499 Log when metaproxy is invoked in test mode (-t).
500
501 Log PID for each log message.
502
503 multi: combine both NSDs and multiple NSDs into one (diagnostics).
504
505 z3950_client: fixup multiple NSD's too. Like surrogate diagnostics,
506 a (backend=target) is appended for each diagnostic so that can be
507 determined the origin of error.
508
509 multi: hideerrors also in use for present response.
510
511 Solr example in zoom man page.
512
513 Fix typo in query_rewrite config example.
514
515 Log at least first non surrogate diagnostic. Instead of
516 "Z_Records_multipleNSD"
517
518 multi: Fix check for opt Records in present response. A SEGV could occur
519 if a target did not return records and no diagnostics.
520
521 --- 1.3.46 2012/09/24
522
523 Yet another fix for graceful stop.
524
525 --- 1.3.45 2012/09/12
526
527 sru_z3950: relay surrogate diagnostics.
528
529 --- 1.3.44 2012/09/10
530
531 zoom: Honor extraArgs, strip # in zurl.
532
533 multi: fix SEGV for scan. Reported by Rustam T. Usmanov.
534
535 zoom: url_recipe allow %{var[reg]} substitutions.
536 It's like ${var[reg]} but does URI component encoding as well.
537
538 --- 1.3.43 2012/08/22
539
540 RPM/Deb: require yazpp 1.3.2, because it fixes a missing close of
541 non-keepalive HTTP sessions.
542
543 http_file: allow zero size files (bug fix)
544
545 Fix zoom schema: auth_url is optional
546
547 --- 1.3.42 2012/08/20
548
549 zoom: fix un-init memory (could result in SEGV at session close)
550
551 frontend_net: handle X-Forwarded-For. This is stored in package.origin()
552 and may be used in filters as usual.
553
554 zoom: authentication via Torus lookup
555 Enabled by new configuration setting: auth_url . If this is defined,
556 the zoom module will contact Torus for auth/IP lookup and that will
557 define realm to be used in session.
558
559 --- 1.3.41 2012/08/10
560
561 virt_db: Fix database name - first character we removed by mistake.
562 Bug introduced in 1.3.40.
563
564 --- 1.3.40 2012/08/06
565
566 virt_db: Don't use "unix path" as database for Unix sockets.
567
568 --- 1.3.39 2012/08/02
569
570 z3950_client: Don't tamper with / in zurl - fixes problems
571 using Unix sockets for backends.
572
573 session_shared: fix integer overflow problem with hit count.
574
575 session_shared: avoid long usage of cached queries.
576
577 zoom: New database argument , torus_url to set URL of Torus
578 record to be fetched.
579
580 --- 1.3.38 2012/07/04
581
582 Fixes for 'metaproxy reload' for RPM/Debian packages. 
583
584 zoom: Allow rpn2cql conversion to be augmented with a properties file.
585 Element rpn2cql can be specified per-target for the zoom filter.
586
587 log: New category "line" which is a single-line log message with
588 most important parts of a HTTP/Z39.50 request/response.
589
590 --- 1.3.37 2012/06/01
591
592 frontend_net: add facility to report live statistics about response
593 times and current thread usage. The report is an XML document
594 and is triggered for a specific URL path. This is set by <stat-req>
595 in the configuration of frontend_net. By default this report is
596 disabled (same as empty value for <stat-req>).
597
598 Fix reload problem in init.d script for RPM/Debian. 
599 The '/etc/init.d/metaproxy reload' in some cases would stop but not
600 start metaproxy - effectively stopping the service.
601
602 Don't display start log message when config testing (-t).
603
604 zoom: avoid CCL message limit of 1K in ZOOM filter.
605
606 --- 1.3.36 2012/05/10
607
608 metaproxy init script reacts to reload which does graceful stop +
609 start and is used by logrorate script.
610
611 --- 1.3.35 2012/05/09
612
613 Fixes for Windows compilation.
614
615 Metaproxy daemon reacts to SIGUSR1 in which case it will leave
616 existing sessions running but terminate the monitor process that is
617 used in keepalive mode.
618
619 Change start log message to 'metaproxy start'. Was 'Metaproxy start'
620 before. Consistent with 'metaproxy stop' message.
621
622 zoom: document zoom's proxy_timeout
623
624 z3950_client: fixup addinfo for init response
625
626 virt_db: return other diagnostic if init is rejected. Diagnostic 236:
627 "Access to specified database denied" is returned, but only if init
628 response from backend does not carry diagnostics already.
629
630 multi: relays user info for first rejected target. The other-information
631 field for init response for first rejected target is in common init
632 response. This ensures that some backend init diagnostics are returned to
633 the frontend.
634
635 --- 1.3.34 2012/04/25
636
637 frontend_log: extend logging (when message is given in config).
638
639 --- 1.3.33 2012/04/25
640
641 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
642
643 --- 1.3.32 2012/04/24
644
645 sru_z3950 filter passes through incoming Z39.50 requests again. Was
646 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
647
648 --- 1.3.31 2012/04/24
649
650 zoom: fixes for retry/proxy failover logic. More logging.
651
652 --- 1.3.30 2012/04/23
653
654 zoom: return addinfo="proxy failure" for proxy failures. This also
655 changes the scheme for dealing with proxies a bit.  zoom now always
656 do proxy check, even if there's no failover. Fortunately, that's not
657 very expensive.
658
659 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
660 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
661 generic. We don't know why the init would fail; IP, user, block IP, etc.
662 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
663
664 zoom: guess if invalid SRU response was an auth failure
665
666 session_shared: disable session retry by default . Can be enabled by
667 restart="true" in resultset section.
668
669 --- 1.3.29 2012/04/18
670
671 zoom: may read cf-proxy's config settings.
672 This reduces manual configuration of the content proxy server host.
673 The ZOOM module will use the old style session.proxyhost if "server"
674 is given (deprecated) and use the new style proxyhost/session if
675 "config_file" is in use.
676
677 frontend_net: remove incoming requests that can not be handled
678 Requests in queue for filter frontend_net are removed if client
679 closes connection for the session and request is not yet handled.
680
681 sru_z3950: serialize requests. This is to ensure that pipelined
682 HTTP requests are handled properly.
683
684 --- 1.3.28 2012/04/04
685
686 New class, wrbuf, that wraps YAZ' WRBUF.
687
688 --- 1.3.27 2012/03/30
689
690 Metaproxy daemon is now running as user "metaproxy". This user is
691 managed by package maintainer scripts. The user information is stored
692 in /etc/metaproxy/metaproxy.user . 
693
694 --- 1.3.26 2012/03/20
695
696 New filter, sort, that allows sorting of XML records via Z39.50
697 retrieval.
698
699 Filter record_transform: USEMarcon support. For example:
700   <retrieval syntax="usmarc">
701      <backend syntax="unimarc" name="F">
702        <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
703      </backend>
704   </retrieval>
705
706 Filter multi: empty route pattern uses route as default.
707   That is
708    <target route="z3950.indexdata.com">z3950.indexdata.com</route>
709   may use the shorter notation
710    <target route="z3950.indexdata.com"/>
711
712 Filter query_rewrite: use config path to locate XSLT.
713
714 Filter frontend_net:  log statistics.
715 If a custom message element in frontend_net configuration it makes
716 the frontend_net filter produce a log entry whenever an operation
717 is completed. The log is always written using yaz_log with the
718 custom message given, the package ID (session ID) , the time
719 the operation has been active (end-to-end) , the threads currently
720 active/total and the size of the request input/output queues.
721
722 query_rewrite: charset conversion of query terms.
723 This is an optional feature. Enabled by element <charset> in
724 configuration with attribute 'from' and 'to' that specifies
725 from/to encodings. The default 'from' encoding is UTF-8.
726
727 Filter record_transform: honor piggyback searches.
728
729 Filter zoom: re-connect when database is reused.
730 Re-connect is necessary if a connection is lost or a timeout occurs.
731 If not, we'll be seeing zero hits, when we shouldn't.
732
733 --- 1.3.25 2012/02/29
734
735 zoom: Change scheme for dealing with content proxy URLs. The module
736 now has its own common XSL transform that is enabled by record_xsl
737 attribute in the configuration. This XSL gets parameter cproxyhost
738 that holds the host for the content proxy session . The genearted-url
739 is created only if urlRecipe is enabled. In previous version default
740 value of urlRecipe was ${md-electronic-url}; it is now empty and
741 disabled by default. Also generated-url no longer includes the content
742 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
743 stylesheet.
744
745 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
746 connections. Default value is 40 (seconds).
747
748 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
749 "Malformed query" for syntax errors and related ones; throw
750 Bib-1: 3 "Unsupported search" for everything else. Details from
751 the CCL parser is provided as additional-info.
752
753 multi: new setting hideerrors that makes multi only relay diagnostics
754 to a client if all backends fail.
755
756 --- 1.3.24 2012/02/23
757
758 zoom: empty ccl_map field-mappings disables CCL map.
759
760 zoom: fix Explain search that could return error if session was
761 re-used.
762
763 --- 1.3.23 2012/02/10
764
765 zoom: returns Explain records for database IR-Explain---1. The
766 target profile records are converted to Explain records via XSLT.
767
768 session_shared: make error recovery configurable. Whether a search
769 is restarted on errors or not, is configurable by attribute "restart"
770 in element "resultset" in configuration.
771
772 session_shared: only relay init for first request. session_shared, for
773 each backend class, now only relays first init request (rather than all).
774 The module only needs to save init response info once. This avoids the
775 need to check for session max.
776
777 --- 1.3.22 2012/02/02
778
779 zoom: fix memory leaks.
780
781 session_shared: maximum number of sessons is configurable. Default
782 value is 100. Result-sets for backends without named result sets are
783 only re-used if databases is identical for a search. This is under the
784 assumption that performance may suffer for those backends when
785 changing the database for each search.
786
787 multi: combines diagnostics from all backends. All diagnostics from
788 backends are combined into multiple non-surrogate diagnostics; rather
789 than just one diagnostic from first backend.
790
791 --- 1.3.21 2011/12/27
792
793 zoom: relay realm to cproxy parameter file.
794
795 Configuration: Allow filter collection element inside route. This
796 makes it possible to include multiple filters at once.
797
798 zoom: nocproxy also disables urlRecipe.
799
800 --- 1.3.20 2011/12/21
801
802 zoom: return diagnostic if CQL sortby conv fails.  Diagnostic Bib-1 214
803 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
804 90: "Unsupported direction value".
805
806 zoom: honor database argument nocproxy. This disables creating a content
807 connector session (for non-CF targets, usually) and also relays nocproxy
808 as database argument to a CF target.
809
810 --- 1.3.19 2011/12/16
811
812 zoom: Multiple proxy hosts may be given for proxy rich database 
813 parameter. List is comma separated.
814
815 http_file: decodes URI paths properly. Does not return 404: not found
816 if no prefix are matches. Instead packages are passed on.
817
818 --- 1.3.18 2011/12/08
819
820 zoom: content-{user,password,proxy} are passed on to content proxy
821 system and takes precedence over user,password,proxy .
822
823 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
824 with a log element including log material from children filters. At
825 this point, only the zoom filter uses this log facility. It will
826 eventually be used by other filters as well. In particular it might be
827 useful for this feature to track all filters in used during a search.
828
829 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
830 and queries as they are manipulated are logged.
831
832 zoom:  extend addinfo with native diagnostics. Diagnostics as received
833 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
834 diagnostics. This indicates both a backend diagnostic and the original
835 form.
836
837 zoom: default urlRecipe value is ${md-electronic-url}
838
839 zoom: target profile setting sruVersion is recognized.
840
841 --- 1.3.17 2011/11/17
842
843 zoom: log target profile record fetched (AKA Torus).
844
845 --- 1.3.16 2011/11/17
846
847 Change target profile parameter CfSubDb to CfSubDB.
848
849 --- 1.3.15 2011/11/12
850
851 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
852 makes sense to the zoom module itself).
853
854 --- 1.3.14 2011/11/11
855
856 zoom: realm may be given as part of database.
857
858 --- 1.3.13 2011/10/26
859
860 Fix Origin class assigment method; was removd by mistake in 1.3.12.
861
862 --- 1.3.12 2011/10/26
863
864 zoom: database args x-name=value are passed through to backend database.
865
866 SRU filter: user may specify session ID that is passed to log entries
867 that follows. It is specified by using x-session-id in the SRU arguments.
868
869 zoom: fix null pointer reference which would occur for bad url parameter
870 inside "torus" or if url was not given.
871
872 --- 1.3.11 2011/09/09
873 Fix bug in filter session_shared where sessions would not expire
874 properly (session ttl). This in turn could make the target close the
875 connection before expected and session_shared would return diagnostic
876 2: system temporarily available.
877
878 --- 1.3.10 2011/09/09
879
880 zoom: new target profile setting: sortmap_field. If sortmap_field is given
881 the field is mapped to the value for the sortmap. Values not matching
882 sortmap_field are passed verbatim.
883   
884 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
885 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
886 depending on whether RPN or CQL is actually sent to the target.
887
888 --- 1.3.9 2011/08/25
889
890 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
891
892 zoom: For content proxy authentication is stored in param name
893 "auth", instead of "authentication".
894
895 --- 1.3.8 2011/08/22
896
897 zoom: relay schema in SRU mode. Previously recordSchema was not affected
898 by elementSet.
899
900 --- 1.3.6 2011/08/22
901
902 zoom: new target profile element literalTransform that holds XSLT
903 (encoded as string) for target. Only if present and non-zero length it is
904 considered present. This takes precedence over transform.
905
906 Don't rely on trang anymore for Git checkout builds. Configuration in etc
907 will only be properly validated if trang is available. From now on only
908 relax NC files are bundled with the source dist.
909
910 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
911 component was not detected when it should be.
912
913 --- 1.3.5 2011/08/12
914
915 z3950_client: mark non-surrogate diagnostics from backend.
916
917 zoom: a proxy may be specified for HTTP fetch of target profiles.
918
919 --- 1.3.4 2011/08/01
920
921 Honor piggyback. Makes some SRU targets behave that insist on
922 maximumRecords > 0, but also increases performance.
923
924 --- 1.3.3 2011/08/01
925
926 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
927 file was not update for libdir/metaproxy4 in version 1.3.2.
928
929 --- 1.3.2 2011/08/01
930
931 Change location of Metaproxy modules from libdir/metaproxy to
932 libdir/metaproxy4. Directory libdir/metaproxy is also owned by 
933 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
934
935 New facility to dump APDUs from zoom filter. Enabled by 
936 <log apdu="true"/> in the zoom filter configuation.
937
938 zoom filter bug fix: SRU diagnostics received from backend was
939 not properly converted to Bib-1 diagnostics.
940
941 Package metaproxy depends on libmetaproxy4, same version.
942
943 --- 1.3.1 2011/07/28
944
945 zoom: fix a bug WRT passing authentication parameters to backends.
946
947 --- 1.3.0 2011/07/27
948
949 Fixes for windows Makefile.
950
951 --- 1.2.10 2011/07/25 
952
953 Change major version of metaproxy library from 3 to 4. This in turn
954 makes new package names for Debian and RPM.
955
956 --- 1.2.9 2011/06/27
957
958 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
959 transforn mode).
960
961 zoom: configurable element sets for record transforms.
962     
963 zoom: the target profile based transform is specified by element_transform
964 in element torus of of the ZOOM filter configuration ; default value
965 is "pz2". Target profile based retrieval is specified by element_raw
966 in configuration. It will perform same steps, but omit the XSL transform.
967 Default value is "raw".
968
969 zoom: element set is omitted if not set in profile. But only if pz2
970 transform is in effect. Previously the default element set was to "F".
971
972 zoom: For non-CF targets database arguments are parsed. User may supply
973 db,user=myuser&password=mypass for non-CF targets. These values override
974 what's given the authentication from the target profile.
975
976 session_shared: fix reference to freed memory. Would occur if a search
977 response had non-surrogate diagnostics.
978
979 --- 1.2.8 2011/06/22
980
981 Route may be given for each port in frontend_net.
982
983 --- 1.2.7 2011/06/22
984
985 Documentation for zoom filter. Local target profiles may be specified.
986
987 Fixes for zoom filter.
988
989 --- 1.2.6 2011/06/15
990
991 First version with zoom filter.
992
993 --- 1.2.5 2011/05/06
994
995 Filter z3950_client may be configured to always send a close APDU
996 to backend target when connection/session is closed. This will only
997 happen if close APDU is not already sent. Enabled by configuration
998 for z3950_client (force_close).
999
1000 Filter virt_db and multi: relay close APDU.
1001
1002 Filter virt_db and multi: relay init size parameters 
1003 preferredMessageSize and maximumRecordSize.
1004
1005 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
1006
1007 --- 1.2.4 2011/01/27
1008
1009 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
1010
1011 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
1012 as determined by configure.
1013
1014 RPM: Release includes 'indexdata' name. Use indexdata in release name so
1015 this package can be distinguished from other vendors.
1016
1017 --- 1.2.3 2010/10/04
1018
1019 Fix filter multi: relay idAuthentication parameters.
1020
1021 --- 1.2.2 2010/09/15
1022
1023 Add metaproxy-config for returning compiler flags, libraries.
1024
1025 --- 1.2.1 2010/08/18
1026
1027 Fix --with-boost=PREFIX .
1028
1029 --- 1.2.0 2010/07/09
1030
1031 session_shared: fix use of maintenance thread.
1032
1033 Introduce 'start' method for filters and routers. It gets called after
1034 configure and after fork, but before processing. This changes API -
1035 from libmetaproxy2 to libmetaproxy3.
1036
1037 --- 1.1.7 2010/06/30
1038
1039 session_shared: ensure backend session is closed if init rejected
1040 is received.
1041
1042 z3950_client: fix NULL ptr reference that could occur if two clients
1043 connected concurrently and if max-sockets was in effect.
1044
1045 --- 1.1.6 2010/06/21
1046
1047 Fix bug 3497 - Metaproxy unstable while stopping.
1048
1049 Fix bug 3495 - SEGV in SRU filter.
1050
1051 --- 1.1.5 2010/06/15
1052
1053 Filter multi throws diagnostic 'Present Out of Range' when
1054 appropriate - rather than returning 0 records.
1055
1056 Filter virt_db: fix bad result reuse. Could happen if a result
1057 was overriden and a backend did not supported named result sets.
1058
1059 --- 1.1.4 2010/05/11
1060
1061 Filter log: category access logs diagnostics even if searchStatus
1062 or presentStatus is 'success'.
1063
1064 --- 1.1.3 2010/04/21
1065
1066 The SRU to Z39.50 filter does repeated Z39.50 present requests
1067 to fetch all records. Needed when a Z39.50 server returns partial
1068 results (due to message size limits).
1069
1070 --- 1.1.2 2010/03/18
1071
1072 Metaproxy now kills all child processes that are spawned by
1073 modules (in case of fork, exec).
1074
1075 --- 1.1.1 2010/01/28
1076
1077 Debian package now installs /etc/metaproxy/metaproxy.xml which
1078 includes all XML files /etc/metaproxy/filters-enabled .
1079 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
1080
1081 --- 1.1.0 2010/01/20
1082
1083 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
1084 development package to facilitate 3rd party Metaproxy modules.
1085
1086 --- 1.0.23 2010/01/04
1087
1088 Filter virt_db: Close backend filter session when Init rejected is received
1089 from it (in which case it's not really closed yet). This will ensure we don't
1090 run out of resources such as FDs in this case.
1091
1092 sru_z3950 filter: Accept any database (including those not listed).
1093
1094 --- 1.0.22 2009/12/03
1095
1096 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
1097 later which means YAZ 3.0.47 or later.
1098
1099 --- 1.0.20 2009/11/19
1100
1101 For filter virt_db, the database is a glob pattern and the virtual
1102 database sections are consulted in the order given.
1103
1104 --- 1.0.19 2009/07/08
1105
1106 For filter multi, the target (for routing) may be given as a glob-pattern.
1107
1108 More documentation for filters virt_db and multi.
1109
1110 Update schema to allow for no database in sru_z3950 filter.
1111
1112 --- 1.0.18 2009/06/30
1113
1114 Added limit filter to put sleep (penalty) for heavy use.
1115
1116 Filter frontend_net may be configured to limit the number of new connections
1117 from same IP to some value (connect-max).
1118
1119 Fixed the load_balance filter.
1120
1121 --- 1.0.17 2009/06/16
1122
1123 Fix path for metaproxy executable for Debian init.d script.
1124
1125 --- 1.0.16 2009/06/10
1126
1127 SRU to Z39.50 filter honors x-username and x-password. If only
1128 x-username is given that translates to open authentication (Z39.50v2). If
1129 both x-username and x-password is present that translates to idPass
1130 authentication (Z39.50v3).
1131
1132 New facility to change current working directory (-w).
1133
1134 Update to upstream skeleton of init.d script. Should fix bug #2619.
1135
1136 Filter session_shared now caches records (used to only cache connections
1137 and result sets).
1138
1139 Filter session_shared now invalidates a Z39.50 session if a server
1140 returns -1 hits. This facility was also part of yazproxy and gets around
1141 a bug in Voyager-based Z39.50 servers.
1142
1143 --- 1.0.15 2008/11/18
1144
1145 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
1146
1147 --- 1.0.14 2008/06/09
1148
1149 Fixed the value of SRU record schema in searchRetrieve response. It was set
1150 to a fixed value of "dc" before.
1151
1152 Serialize identical SRU requests. This is useful if HTTP client software
1153 fires identical requests against metaproxy.
1154
1155 Allow Z39.50 target to be specified for SRU requests by using SRU extra
1156 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
1157 avoid static configuration. This facility is handled by the sru_z3950 module
1158 and the z3950_client module.
1159
1160 Allow maximum number of sockets to be used for a Z39.50 client by the
1161 use of SRU extra parameter x-max-sockets. This facility is handled by the
1162 sru_z3950 module and the z3950_client module.
1163
1164 --- 1.0.13.1 2008/02/29
1165
1166 Simplified check for Boost libraries.
1167
1168 --- 1.0.13 2008/02/29
1169
1170 First Debian package.
1171
1172 The sru_z9350 filter now recognizes SRU parameter z-target as being
1173 a ZURL of the form host/database . 
1174
1175 Mergetype may be specified for filter 'multi'.
1176
1177 --- 1.0.12 2007/09/19
1178
1179 Fixed problem in Makefile WRT library specifictions. This could produce
1180 linker errors (when they should not happen).
1181
1182 Fixed bug #1341: MetaProxy returning different results. Problem was that
1183 fix-up of record database did not normalize the database name.
1184
1185 Documentation updates for Windows compilation.
1186
1187 --- 1.0.11 2007/06/14
1188
1189 Fixed problem with logfile being truncated.
1190
1191 --- 1.0.10 2007/05/23
1192
1193 Fixed bug #1136: Access rights not enforced.
1194
1195 Extension for log module. The log category 'access' logs more details.
1196 New category 'user-access' added which is simlar to 'access' but adds
1197 the Z39.50 user as for all entries in a session.
1198
1199 Switched to GPL v2.
1200
1201 Added support for configurable default/force target/vhost for module Z39.50
1202 client module.
1203
1204 --- 1.0.8 2007/01/25
1205
1206 Implemented filter, session_shared, which optimizes usage of Z39.50
1207 sessions and result sets.
1208
1209 New filter, record_transform, which converts MARC/XML records.
1210
1211 New filter, sru_z3950, which converts SRU to Z39.50 packages.
1212
1213 New filter, load_balance, in development.
1214
1215 New filter, zeerex_xplain.
1216
1217 XML framework for config files started.
1218
1219 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
1220 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
1221 XML config files are checked against RNG and XML Schema's.
1222
1223 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of 
1224 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
1225 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX 
1226 explain record to YAZ CQL-to-PQF text config file. 
1227
1228 --- 1.0.7 2006/11/07
1229
1230 Added 'timeout' setting for filter frontend_net which specifies the number
1231 of seconds a session is idle before it is closed. Default timeout is
1232 300 (5 minutes).
1233
1234 --- 1.0.6 2006/07/07
1235
1236 Database name in records returned set for virt_db/multi filters.
1237
1238 Filter session_shared now functional.
1239
1240 Log filter can be configured to write to a given file using 'filename'
1241 element. Also information category can be specified with 'category'. If
1242 filename is omitted, the log filter writes to stdout. See etc/config5.xml
1243 for example.
1244
1245 --- 1.0.5 2006/05/16
1246
1247 Fixed compilation on Windows.
1248
1249 --- 1.0.4 2006/05/16
1250
1251 Added documentation for the hidenavailable option for the multi filter.
1252
1253 --- 1.0.3 2006/05/16
1254
1255 Fixed bug #573: Hide errors for individual servers. If the element
1256 'hideunavailable' is given in the configuration, individual servers
1257 being unavailable are hidden (unless all are unavailable). 
1258
1259 Fixed bug #574: Database names are recognised case-sensitively.
1260
1261 Fixed bug #567: Fix up database name in Name-Plus-Record.
1262
1263 Fixed bug #568: Update win/makefile for VS 2005.
1264
1265 Fixed bug #569: Some options throws unknown exception.
1266
1267 --- 1.0.2 2006/04/28
1268
1269 More information about virtual hosts. The 'etc' directory is part of the
1270 distribution tar.
1271
1272 --- 1.0.1 2006/04/27
1273
1274 Build instructions for Windows. NMake makefile part of distribution tar.
1275
1276 --- 1.0.0 2006/04/24
1277
1278 More documentation.
1279
1280 Filters functional: auth_simple, backend_test, frontend_net, http_file,
1281  log, multi, query_rewrite, template, virt_db, z3950_client.
1282
1283 Filters in development: session_shared.
1284
1285 Pseudo-filters: template, dl
1286
1287 --- 0.9 2006/03/27