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