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