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