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