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