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