Change start log message to 'metaproxy start'
[metaproxy-moved-to-github.git] / NEWS
1 --- 1.3.34 2012/04/25
2
3 frontend_log: extend logging (when message is given in config).
4
5 --- 1.3.33 2012/04/25
6
7 zoom: Fix check for proxy. Use diagnostic 1074 for proxy failures.
8
9 --- 1.3.32 2012/04/24
10
11 sru_z3950 filter passes through incoming Z39.50 requests again. Was
12 not handled by mistake in Metaproxy versions 1.3.29, 1.3.30 and 1.3.31.
13
14 --- 1.3.31 2012/04/24
15
16 zoom: fixes for retry/proxy failover logic. More logging.
17
18 --- 1.3.30 2012/04/23
19
20 zoom: return addinfo="proxy failure" for proxy failures. This also
21 changes the scheme for dealing with proxies a bit.  zoom now always
22 do proxy check, even if there's no failover. Fortunately, that's not
23 very expensive.
24
25 zoom: Init rejected wo diagnostics maps to Bib-1:1014.
26 Bib-1 1014, "Init/AC: Authentication System error", seems pretty
27 generic. We don't know why the init would fail; IP, user, block IP, etc.
28 sru_z3950 filter maps this to SRU diagnostic 3: "Authentication error".
29
30 zoom: guess if invalid SRU response was an auth failure
31
32 session_shared: disable session retry by default . Can be enabled by
33 restart="true" in resultset section.
34
35 --- 1.3.29 2012/04/18
36
37 zoom: may read cf-proxy's config settings.
38 This reduces manual configuration of the content proxy server host.
39 The ZOOM module will use the old style session.proxyhost if "server"
40 is given (deprecated) and use the new style proxyhost/session if
41 "config_file" is in use.
42
43 frontend_net: remove incoming requests that can not be handled
44 Requests in queue for filter frontend_net are removed if client
45 closes connection for the session and request is not yet handled.
46
47 sru_z3950: serialize requests. This is to ensure that pipelined
48 HTTP requests are handled properly.
49
50 --- 1.3.28 2012/04/04
51
52 New class, wrbuf, that wraps YAZ' WRBUF.
53
54 --- 1.3.27 2012/03/30
55
56 Metaproxy daemon is now running as user "metaproxy". This user is
57 managed by package maintainer scripts. The user information is stored
58 in /etc/metaproxy/metaproxy.user . 
59
60 --- 1.3.26 2012/03/20
61
62 New filter, sort, that allows sorting of XML records via Z39.50
63 retrieval.
64
65 Filter record_transform: USEMarcon support. For example:
66   <retrieval syntax="usmarc">
67      <backend syntax="unimarc" name="F">
68        <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
69      </backend>
70   </retrieval>
71
72 Filter multi: empty route pattern uses route as default.
73   That is
74    <target route="z3950.indexdata.com">z3950.indexdata.com</route>
75   may use the shorter notation
76    <target route="z3950.indexdata.com"/>
77
78 Filter query_rewrite: use config path to locate XSLT.
79
80 Filter frontend_net:  log statistics.
81 If a custom message element in frontend_net configuration it makes
82 the frontend_net filter produce a log entry whenever an operation
83 is completed. The log is always written using yaz_log with the
84 custom message given, the package ID (session ID) , the time
85 the operation has been active (end-to-end) , the threads currently
86 active/total and the size of the request input/output queues.
87
88 query_rewrite: charset conversion of query terms.
89 This is an optional feature. Enabled by element <charset> in
90 configuration with attribute 'from' and 'to' that specifies
91 from/to encodings. The default 'from' encoding is UTF-8.
92
93 Filter record_transform: honor piggyback searches.
94
95 Filter zoom: re-connect when database is reused.
96 Re-connect is necessary if a connection is lost or a timeout occurs.
97 If not, we'll be seeing zero hits, when we shouldn't.
98
99 --- 1.3.25 2012/02/29
100
101 zoom: Change scheme for dealing with content proxy URLs. The module
102 now has its own common XSL transform that is enabled by record_xsl
103 attribute in the configuration. This XSL gets parameter cproxyhost
104 that holds the host for the content proxy session . The genearted-url
105 is created only if urlRecipe is enabled. In previous version default
106 value of urlRecipe was ${md-electronic-url}; it is now empty and
107 disabled by default. Also generated-url no longer includes the content
108 proxy host. Content proxying URLs is supposed to the handle in the record_xsl
109 stylesheet.
110
111 zoom: new setting timeout that specifies timeout for outgoing Z39.50/SRU
112 connections. Default value is 40 (seconds).
113
114 zoom: tune CCL to Z39.50 diagnostics mapping. Throw Bib-1: 108
115 "Malformed query" for syntax errors and related ones; throw
116 Bib-1: 3 "Unsupported search" for everything else. Details from
117 the CCL parser is provided as additional-info.
118
119 multi: new setting hideerrors that makes multi only relay diagnostics
120 to a client if all backends fail.
121
122 --- 1.3.24 2012/02/23
123
124 zoom: empty ccl_map field-mappings disables CCL map.
125
126 zoom: fix Explain search that could return error if session was
127 re-used.
128
129 --- 1.3.23 2012/02/10
130
131 zoom: returns Explain records for database IR-Explain---1. The
132 target profile records are converted to Explain records via XSLT.
133
134 session_shared: make error recovery configurable. Whether a search
135 is restarted on errors or not, is configurable by attribute "restart"
136 in element "resultset" in configuration.
137
138 session_shared: only relay init for first request. session_shared, for
139 each backend class, now only relays first init request (rather than all).
140 The module only needs to save init response info once. This avoids the
141 need to check for session max.
142
143 --- 1.3.22 2012/02/02
144
145 zoom: fix memory leaks.
146
147 session_shared: maximum number of sessons is configurable. Default
148 value is 100. Result-sets for backends without named result sets are
149 only re-used if databases is identical for a search. This is under the
150 assumption that performance may suffer for those backends when
151 changing the database for each search.
152
153 multi: combines diagnostics from all backends. All diagnostics from
154 backends are combined into multiple non-surrogate diagnostics; rather
155 than just one diagnostic from first backend.
156
157 --- 1.3.21 2011/12/27
158
159 zoom: relay realm to cproxy parameter file.
160
161 Configuration: Allow filter collection element inside route. This
162 makes it possible to include multiple filters at once.
163
164 zoom: nocproxy also disables urlRecipe.
165
166 --- 1.3.20 2011/12/21
167
168 zoom: return diagnostic if CQL sortby conv fails.  Diagnostic Bib-1 214
169 "Illegal sort relation" is returned. Gets translated to SRU diagnostic
170 90: "Unsupported direction value".
171
172 zoom: honor database argument nocproxy. This disables creating a content
173 connector session (for non-CF targets, usually) and also relays nocproxy
174 as database argument to a CF target.
175
176 --- 1.3.19 2011/12/16
177
178 zoom: Multiple proxy hosts may be given for proxy rich database 
179 parameter. List is comma separated.
180
181 http_file: decodes URI paths properly. Does not return 404: not found
182 if no prefix are matches. Instead packages are passed on.
183
184 --- 1.3.18 2011/12/08
185
186 zoom: content-{user,password,proxy} are passed on to content proxy
187 system and takes precedence over user,password,proxy .
188
189 sru_z3950: SRU extra argument x-log-enable=1 enables a search response
190 with a log element including log material from children filters. At
191 this point, only the zoom filter uses this log facility. It will
192 eventually be used by other filters as well. In particular it might be
193 useful for this feature to track all filters in used during a search.
194
195 zoom: for x-log-enable=1, APDUs sent by ZOOM C, records as received
196 and queries as they are manipulated are logged.
197
198 zoom:  extend addinfo with native diagnostics. Diagnostics as received
199 by ZOOM C are put into addinfo - including ZOOM, HTTP, SRU and Bib-1
200 diagnostics. This indicates both a backend diagnostic and the original
201 form.
202
203 zoom: default urlRecipe value is ${md-electronic-url}
204
205 zoom: target profile setting sruVersion is recognized.
206
207 --- 1.3.17 2011/11/17
208
209 zoom: log target profile record fetched (AKA Torus).
210
211 --- 1.3.16 2011/11/17
212
213 Change target profile parameter CfSubDb to CfSubDB.
214
215 --- 1.3.15 2011/11/12
216
217 zoom: bug fix: realm was relayed to CF targets by mistake (realm only
218 makes sense to the zoom module itself).
219
220 --- 1.3.14 2011/11/11
221
222 zoom: realm may be given as part of database.
223
224 --- 1.3.13 2011/10/26
225
226 Fix Origin class assigment method; was removd by mistake in 1.3.12.
227
228 --- 1.3.12 2011/10/26
229
230 zoom: database args x-name=value are passed through to backend database.
231
232 SRU filter: user may specify session ID that is passed to log entries
233 that follows. It is specified by using x-session-id in the SRU arguments.
234
235 zoom: fix null pointer reference which would occur for bad url parameter
236 inside "torus" or if url was not given.
237
238 --- 1.3.11 2011/09/09
239 Fix bug in filter session_shared where sessions would not expire
240 properly (session ttl). This in turn could make the target close the
241 connection before expected and session_shared would return diagnostic
242 2: system temporarily available.
243
244 --- 1.3.10 2011/09/09
245
246 zoom: new target profile setting: sortmap_field. If sortmap_field is given
247 the field is mapped to the value for the sortmap. Values not matching
248 sortmap_field are passed verbatim.
249   
250 zoom: new target profile setting: sortStrategy. One of: "z3950", "type7",
251 "cql", "sru11" or "embed". The "embed" chooses type-7 or CQL sortby
252 depending on whether RPN or CQL is actually sent to the target.
253
254 --- 1.3.9 2011/08/25
255
256 zoom: urlRecipe result is stored in <pz:metadata type="generated-url">.
257
258 zoom: For content proxy authentication is stored in param name
259 "auth", instead of "authentication".
260
261 --- 1.3.8 2011/08/22
262
263 zoom: relay schema in SRU mode. Previously recordSchema was not affected
264 by elementSet.
265
266 --- 1.3.6 2011/08/22
267
268 zoom: new target profile element literalTransform that holds XSLT
269 (encoded as string) for target. Only if present and non-zero length it is
270 considered present. This takes precedence over transform.
271
272 Don't rely on trang anymore for Git checkout builds. Configuration in etc
273 will only be properly validated if trang is available. From now on only
274 relax NC files are bundled with the source dist.
275
276 Updates to check for Boost unit test (autoconf stuff). On MacOSX this
277 component was not detected when it should be.
278
279 --- 1.3.5 2011/08/12
280
281 z3950_client: mark non-surrogate diagnostics from backend.
282
283 zoom: a proxy may be specified for HTTP fetch of target profiles.
284
285 --- 1.3.4 2011/08/01
286
287 Honor piggyback. Makes some SRU targets behave that insist on
288 maximumRecords > 0, but also increases performance.
289
290 --- 1.3.3 2011/08/01
291
292 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
293 file was not update for libdir/metaproxy4 in version 1.3.2.
294
295 --- 1.3.2 2011/08/01
296
297 Change location of Metaproxy modules from libdir/metaproxy to
298 libdir/metaproxy4. Directory libdir/metaproxy is also owned by 
299 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
300
301 New facility to dump APDUs from zoom filter. Enabled by 
302 <log apdu="true"/> in the zoom filter configuation.
303
304 zoom filter bug fix: SRU diagnostics received from backend was
305 not properly converted to Bib-1 diagnostics.
306
307 Package metaproxy depends on libmetaproxy4, same version.
308
309 --- 1.3.1 2011/07/28
310
311 zoom: fix a bug WRT passing authentication parameters to backends.
312
313 --- 1.3.0 2011/07/27
314
315 Fixes for windows Makefile.
316
317 --- 1.2.10 2011/07/25 
318
319 Change major version of metaproxy library from 3 to 4. This in turn
320 makes new package names for Debian and RPM.
321
322 --- 1.2.9 2011/06/27
323
324 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
325 transforn mode).
326
327 zoom: configurable element sets for record transforms.
328     
329 zoom: the target profile based transform is specified by element_transform
330 in element torus of of the ZOOM filter configuration ; default value
331 is "pz2". Target profile based retrieval is specified by element_raw
332 in configuration. It will perform same steps, but omit the XSL transform.
333 Default value is "raw".
334
335 zoom: element set is omitted if not set in profile. But only if pz2
336 transform is in effect. Previously the default element set was to "F".
337
338 zoom: For non-CF targets database arguments are parsed. User may supply
339 db,user=myuser&password=mypass for non-CF targets. These values override
340 what's given the authentication from the target profile.
341
342 session_shared: fix reference to freed memory. Would occur if a search
343 response had non-surrogate diagnostics.
344
345 --- 1.2.8 2011/06/22
346
347 Route may be given for each port in frontend_net.
348
349 --- 1.2.7 2011/06/22
350
351 Documentation for zoom filter. Local target profiles may be specified.
352
353 Fixes for zoom filter.
354
355 --- 1.2.6 2011/06/15
356
357 First version with zoom filter.
358
359 --- 1.2.5 2011/05/06
360
361 Filter z3950_client may be configured to always send a close APDU
362 to backend target when connection/session is closed. This will only
363 happen if close APDU is not already sent. Enabled by configuration
364 for z3950_client (force_close).
365
366 Filter virt_db and multi: relay close APDU.
367
368 Filter virt_db and multi: relay init size parameters 
369 preferredMessageSize and maximumRecordSize.
370
371 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
372
373 --- 1.2.4 2011/01/27
374
375 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
376
377 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
378 as determined by configure.
379
380 RPM: Release includes 'indexdata' name. Use indexdata in release name so
381 this package can be distinguished from other vendors.
382
383 --- 1.2.3 2010/10/04
384
385 Fix filter multi: relay idAuthentication parameters.
386
387 --- 1.2.2 2010/09/15
388
389 Add metaproxy-config for returning compiler flags, libraries.
390
391 --- 1.2.1 2010/08/18
392
393 Fix --with-boost=PREFIX .
394
395 --- 1.2.0 2010/07/09
396
397 session_shared: fix use of maintenance thread.
398
399 Introduce 'start' method for filters and routers. It gets called after
400 configure and after fork, but before processing. This changes API -
401 from libmetaproxy2 to libmetaproxy3.
402
403 --- 1.1.7 2010/06/30
404
405 session_shared: ensure backend session is closed if init rejected
406 is received.
407
408 z3950_client: fix NULL ptr reference that could occur if two clients
409 connected concurrently and if max-sockets was in effect.
410
411 --- 1.1.6 2010/06/21
412
413 Fix bug 3497 - Metaproxy unstable while stopping.
414
415 Fix bug 3495 - SEGV in SRU filter.
416
417 --- 1.1.5 2010/06/15
418
419 Filter multi throws diagnostic 'Present Out of Range' when
420 appropriate - rather than returning 0 records.
421
422 Filter virt_db: fix bad result reuse. Could happen if a result
423 was overriden and a backend did not supported named result sets.
424
425 --- 1.1.4 2010/05/11
426
427 Filter log: category access logs diagnostics even if searchStatus
428 or presentStatus is 'success'.
429
430 --- 1.1.3 2010/04/21
431
432 The SRU to Z39.50 filter does repeated Z39.50 present requests
433 to fetch all records. Needed when a Z39.50 server returns partial
434 results (due to message size limits).
435
436 --- 1.1.2 2010/03/18
437
438 Metaproxy now kills all child processes that are spawned by
439 modules (in case of fork, exec).
440
441 --- 1.1.1 2010/01/28
442
443 Debian package now installs /etc/metaproxy/metaproxy.xml which
444 includes all XML files /etc/metaproxy/filters-enabled .
445 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
446
447 --- 1.1.0 2010/01/20
448
449 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
450 development package to facilitate 3rd party Metaproxy modules.
451
452 --- 1.0.23 2010/01/04
453
454 Filter virt_db: Close backend filter session when Init rejected is received
455 from it (in which case it's not really closed yet). This will ensure we don't
456 run out of resources such as FDs in this case.
457
458 sru_z3950 filter: Accept any database (including those not listed).
459
460 --- 1.0.22 2009/12/03
461
462 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
463 later which means YAZ 3.0.47 or later.
464
465 --- 1.0.20 2009/11/19
466
467 For filter virt_db, the database is a glob pattern and the virtual
468 database sections are consulted in the order given.
469
470 --- 1.0.19 2009/07/08
471
472 For filter multi, the target (for routing) may be given as a glob-pattern.
473
474 More documentation for filters virt_db and multi.
475
476 Update schema to allow for no database in sru_z3950 filter.
477
478 --- 1.0.18 2009/06/30
479
480 Added limit filter to put sleep (penalty) for heavy use.
481
482 Filter frontend_net may be configured to limit the number of new connections
483 from same IP to some value (connect-max).
484
485 Fixed the load_balance filter.
486
487 --- 1.0.17 2009/06/16
488
489 Fix path for metaproxy executable for Debian init.d script.
490
491 --- 1.0.16 2009/06/10
492
493 SRU to Z39.50 filter honors x-username and x-password. If only
494 x-username is given that translates to open authentication (Z39.50v2). If
495 both x-username and x-password is present that translates to idPass
496 authentication (Z39.50v3).
497
498 New facility to change current working directory (-w).
499
500 Update to upstream skeleton of init.d script. Should fix bug #2619.
501
502 Filter session_shared now caches records (used to only cache connections
503 and result sets).
504
505 Filter session_shared now invalidates a Z39.50 session if a server
506 returns -1 hits. This facility was also part of yazproxy and gets around
507 a bug in Voyager-based Z39.50 servers.
508
509 --- 1.0.15 2008/11/18
510
511 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
512
513 --- 1.0.14 2008/06/09
514
515 Fixed the value of SRU record schema in searchRetrieve response. It was set
516 to a fixed value of "dc" before.
517
518 Serialize identical SRU requests. This is useful if HTTP client software
519 fires identical requests against metaproxy.
520
521 Allow Z39.50 target to be specified for SRU requests by using SRU extra
522 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
523 avoid static configuration. This facility is handled by the sru_z3950 module
524 and the z3950_client module.
525
526 Allow maximum number of sockets to be used for a Z39.50 client by the
527 use of SRU extra parameter x-max-sockets. This facility is handled by the
528 sru_z3950 module and the z3950_client module.
529
530 --- 1.0.13.1 2008/02/29
531
532 Simplified check for Boost libraries.
533
534 --- 1.0.13 2008/02/29
535
536 First Debian package.
537
538 The sru_z9350 filter now recognizes SRU parameter z-target as being
539 a ZURL of the form host/database . 
540
541 Mergetype may be specified for filter 'multi'.
542
543 --- 1.0.12 2007/09/19
544
545 Fixed problem in Makefile WRT library specifictions. This could produce
546 linker errors (when they should not happen).
547
548 Fixed bug #1341: MetaProxy returning different results. Problem was that
549 fix-up of record database did not normalize the database name.
550
551 Documentation updates for Windows compilation.
552
553 --- 1.0.11 2007/06/14
554
555 Fixed problem with logfile being truncated.
556
557 --- 1.0.10 2007/05/23
558
559 Fixed bug #1136: Access rights not enforced.
560
561 Extension for log module. The log category 'access' logs more details.
562 New category 'user-access' added which is simlar to 'access' but adds
563 the Z39.50 user as for all entries in a session.
564
565 Switched to GPL v2.
566
567 Added support for configurable default/force target/vhost for module Z39.50
568 client module.
569
570 --- 1.0.8 2007/01/25
571
572 Implemented filter, session_shared, which optimizes usage of Z39.50
573 sessions and result sets.
574
575 New filter, record_transform, which converts MARC/XML records.
576
577 New filter, sru_z3950, which converts SRU to Z39.50 packages.
578
579 New filter, load_balance, in development.
580
581 New filter, zeerex_xplain.
582
583 XML framework for config files started.
584
585 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
586 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
587 XML config files are checked against RNG and XML Schema's.
588
589 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of 
590 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
591 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX 
592 explain record to YAZ CQL-to-PQF text config file. 
593
594 --- 1.0.7 2006/11/07
595
596 Added 'timeout' setting for filter frontend_net which specifies the number
597 of seconds a session is idle before it is closed. Default timeout is
598 300 (5 minutes).
599
600 --- 1.0.6 2006/07/07
601
602 Database name in records returned set for virt_db/multi filters.
603
604 Filter session_shared now functional.
605
606 Log filter can be configured to write to a given file using 'filename'
607 element. Also information category can be specified with 'category'. If
608 filename is omitted, the log filter writes to stdout. See etc/config5.xml
609 for example.
610
611 --- 1.0.5 2006/05/16
612
613 Fixed compilation on Windows.
614
615 --- 1.0.4 2006/05/16
616
617 Added documentation for the hidenavailable option for the multi filter.
618
619 --- 1.0.3 2006/05/16
620
621 Fixed bug #573: Hide errors for individual servers. If the element
622 'hideunavailable' is given in the configuration, individual servers
623 being unavailable are hidden (unless all are unavailable). 
624
625 Fixed bug #574: Database names are recognised case-sensitively.
626
627 Fixed bug #567: Fix up database name in Name-Plus-Record.
628
629 Fixed bug #568: Update win/makefile for VS 2005.
630
631 Fixed bug #569: Some options throws unknown exception.
632
633 --- 1.0.2 2006/04/28
634
635 More information about virtual hosts. The 'etc' directory is part of the
636 distribution tar.
637
638 --- 1.0.1 2006/04/27
639
640 Build instructions for Windows. NMake makefile part of distribution tar.
641
642 --- 1.0.0 2006/04/24
643
644 More documentation.
645
646 Filters functional: auth_simple, backend_test, frontend_net, http_file,
647  log, multi, query_rewrite, template, virt_db, z3950_client.
648
649 Filters in development: session_shared.
650
651 Pseudo-filters: template, dl
652
653 --- 0.9 2006/03/27