zoom doc: describe log, proxy
[metaproxy-moved-to-github.git] / NEWS
1 --- 1.3.4 2011/08/01
2
3 Honor piggyback. Makes some SRU targets behave that insist on
4 maximumRecords > 0, but also increases performance.
5
6 --- 1.3.3 2011/08/01
7
8 Fix dlpath in installed metaproxy.xml for RPM/Deb package. The
9 file was not update for libdir/metaproxy4 in version 1.3.2.
10
11 --- 1.3.2 2011/08/01
12
13 Change location of Metaproxy modules from libdir/metaproxy to
14 libdir/metaproxy4. Directory libdir/metaproxy is also owned by 
15 libmetaproxy3 and, thus, should not be used by libmetaproxy4.
16
17 New facility to dump APDUs from zoom filter. Enabled by 
18 <log apdu="true"/> in the zoom filter configuation.
19
20 zoom filter bug fix: SRU diagnostics received from backend was
21 not properly converted to Bib-1 diagnostics.
22
23 Package metaproxy depends on libmetaproxy4, same version.
24
25 --- 1.3.1 2011/07/28
26
27 zoom: fix a bug WRT passing authentication parameters to backends.
28
29 --- 1.3.0 2011/07/27
30
31 Fixes for windows Makefile.
32
33 --- 1.2.10 2011/07/25 
34
35 Change major version of metaproxy library from 3 to 4. This in turn
36 makes new package names for Debian and RPM.
37
38 --- 1.2.9 2011/06/27
39
40 zoom: enable marc-8 encoding by default for usmarc and opac (in pz2
41 transforn mode).
42
43 zoom: configurable element sets for record transforms.
44     
45 zoom: the target profile based transform is specified by element_transform
46 in element torus of of the ZOOM filter configuration ; default value
47 is "pz2". Target profile based retrieval is specified by element_raw
48 in configuration. It will perform same steps, but omit the XSL transform.
49 Default value is "raw".
50
51 zoom: element set is omitted if not set in profile. But only if pz2
52 transform is in effect. Previously the default element set was to "F".
53
54 zoom: For non-CF targets database arguments are parsed. User may supply
55 db,user=myuser&password=mypass for non-CF targets. These values override
56 what's given the authentication from the target profile.
57
58 session_shared: fix reference to freed memory. Would occur if a search
59 response had non-surrogate diagnostics.
60
61 --- 1.2.8 2011/06/22
62
63 Route may be given for each port in frontend_net.
64
65 --- 1.2.7 2011/06/22
66
67 Documentation for zoom filter. Local target profiles may be specified.
68
69 Fixes for zoom filter.
70
71 --- 1.2.6 2011/06/15
72
73 First version with zoom filter.
74
75 --- 1.2.5 2011/05/06
76
77 Filter z3950_client may be configured to always send a close APDU
78 to backend target when connection/session is closed. This will only
79 happen if close APDU is not already sent. Enabled by configuration
80 for z3950_client (force_close).
81
82 Filter virt_db and multi: relay close APDU.
83
84 Filter virt_db and multi: relay init size parameters 
85 preferredMessageSize and maximumRecordSize.
86
87 Filter sru_z3950: increase init sz parameters from 1MB to 10 MB.
88
89 --- 1.2.4 2011/01/27
90
91 RPM package for Metaproxy works for both SLES11 and Centos 5.5.
92
93 metaproxy-config: exec_prefix, libdir, includedir. Use these variables
94 as determined by configure.
95
96 RPM: Release includes 'indexdata' name. Use indexdata in release name so
97 this package can be distinguished from other vendors.
98
99 --- 1.2.3 2010/10/04
100
101 Fix filter multi: relay idAuthentication parameters.
102
103 --- 1.2.2 2010/09/15
104
105 Add metaproxy-config for returning compiler flags, libraries.
106
107 --- 1.2.1 2010/08/18
108
109 Fix --with-boost=PREFIX .
110
111 --- 1.2.0 2010/07/09
112
113 session_shared: fix use of maintenance thread.
114
115 Introduce 'start' method for filters and routers. It gets called after
116 configure and after fork, but before processing. This changes API -
117 from libmetaproxy2 to libmetaproxy3.
118
119 --- 1.1.7 2010/06/30
120
121 session_shared: ensure backend session is closed if init rejected
122 is received.
123
124 z3950_client: fix NULL ptr reference that could occur if two clients
125 connected concurrently and if max-sockets was in effect.
126
127 --- 1.1.6 2010/06/21
128
129 Fix bug 3497 - Metaproxy unstable while stopping.
130
131 Fix bug 3495 - SEGV in SRU filter.
132
133 --- 1.1.5 2010/06/15
134
135 Filter multi throws diagnostic 'Present Out of Range' when
136 appropriate - rather than returning 0 records.
137
138 Filter virt_db: fix bad result reuse. Could happen if a result
139 was overriden and a backend did not supported named result sets.
140
141 --- 1.1.4 2010/05/11
142
143 Filter log: category access logs diagnostics even if searchStatus
144 or presentStatus is 'success'.
145
146 --- 1.1.3 2010/04/21
147
148 The SRU to Z39.50 filter does repeated Z39.50 present requests
149 to fetch all records. Needed when a Z39.50 server returns partial
150 results (due to message size limits).
151
152 --- 1.1.2 2010/03/18
153
154 Metaproxy now kills all child processes that are spawned by
155 modules (in case of fork, exec).
156
157 --- 1.1.1 2010/01/28
158
159 Debian package now installs /etc/metaproxy/metaproxy.xml which
160 includes all XML files /etc/metaproxy/filters-enabled .
161 The include facility uses YAZ' yaz_xml_include_simple (YAZ 4.0.1).
162
163 --- 1.1.0 2010/01/20
164
165 Package based on YAZ version 4 and YAZ++ 1.2.0. It now includes a
166 development package to facilitate 3rd party Metaproxy modules.
167
168 --- 1.0.23 2010/01/04
169
170 Filter virt_db: Close backend filter session when Init rejected is received
171 from it (in which case it's not really closed yet). This will ensure we don't
172 run out of resources such as FDs in this case.
173
174 sru_z3950 filter: Accept any database (including those not listed).
175
176 --- 1.0.22 2009/12/03
177
178 Prepare for 64-bit YAZ. yazproxy will still work with YAZ++ 1.1.4 or
179 later which means YAZ 3.0.47 or later.
180
181 --- 1.0.20 2009/11/19
182
183 For filter virt_db, the database is a glob pattern and the virtual
184 database sections are consulted in the order given.
185
186 --- 1.0.19 2009/07/08
187
188 For filter multi, the target (for routing) may be given as a glob-pattern.
189
190 More documentation for filters virt_db and multi.
191
192 Update schema to allow for no database in sru_z3950 filter.
193
194 --- 1.0.18 2009/06/30
195
196 Added limit filter to put sleep (penalty) for heavy use.
197
198 Filter frontend_net may be configured to limit the number of new connections
199 from same IP to some value (connect-max).
200
201 Fixed the load_balance filter.
202
203 --- 1.0.17 2009/06/16
204
205 Fix path for metaproxy executable for Debian init.d script.
206
207 --- 1.0.16 2009/06/10
208
209 SRU to Z39.50 filter honors x-username and x-password. If only
210 x-username is given that translates to open authentication (Z39.50v2). If
211 both x-username and x-password is present that translates to idPass
212 authentication (Z39.50v3).
213
214 New facility to change current working directory (-w).
215
216 Update to upstream skeleton of init.d script. Should fix bug #2619.
217
218 Filter session_shared now caches records (used to only cache connections
219 and result sets).
220
221 Filter session_shared now invalidates a Z39.50 session if a server
222 returns -1 hits. This facility was also part of yazproxy and gets around
223 a bug in Voyager-based Z39.50 servers.
224
225 --- 1.0.15 2008/11/18
226
227 Fixed reference counting bug in Z39.50 client module (could cause SEGV).
228
229 --- 1.0.14 2008/06/09
230
231 Fixed the value of SRU record schema in searchRetrieve response. It was set
232 to a fixed value of "dc" before.
233
234 Serialize identical SRU requests. This is useful if HTTP client software
235 fires identical requests against metaproxy.
236
237 Allow Z39.50 target to be specified for SRU requests by using SRU extra
238 parameter x-target. Allows SRU to contact arbitrary Z39.50 targets and
239 avoid static configuration. This facility is handled by the sru_z3950 module
240 and the z3950_client module.
241
242 Allow maximum number of sockets to be used for a Z39.50 client by the
243 use of SRU extra parameter x-max-sockets. This facility is handled by the
244 sru_z3950 module and the z3950_client module.
245
246 --- 1.0.13.1 2008/02/29
247
248 Simplified check for Boost libraries.
249
250 --- 1.0.13 2008/02/29
251
252 First Debian package.
253
254 The sru_z9350 filter now recognizes SRU parameter z-target as being
255 a ZURL of the form host/database . 
256
257 Mergetype may be specified for filter 'multi'.
258
259 --- 1.0.12 2007/09/19
260
261 Fixed problem in Makefile WRT library specifictions. This could produce
262 linker errors (when they should not happen).
263
264 Fixed bug #1341: MetaProxy returning different results. Problem was that
265 fix-up of record database did not normalize the database name.
266
267 Documentation updates for Windows compilation.
268
269 --- 1.0.11 2007/06/14
270
271 Fixed problem with logfile being truncated.
272
273 --- 1.0.10 2007/05/23
274
275 Fixed bug #1136: Access rights not enforced.
276
277 Extension for log module. The log category 'access' logs more details.
278 New category 'user-access' added which is simlar to 'access' but adds
279 the Z39.50 user as for all entries in a session.
280
281 Switched to GPL v2.
282
283 Added support for configurable default/force target/vhost for module Z39.50
284 client module.
285
286 --- 1.0.8 2007/01/25
287
288 Implemented filter, session_shared, which optimizes usage of Z39.50
289 sessions and result sets.
290
291 New filter, record_transform, which converts MARC/XML records.
292
293 New filter, sru_z3950, which converts SRU to Z39.50 packages.
294
295 New filter, load_balance, in development.
296
297 New filter, zeerex_xplain.
298
299 XML framework for config files started.
300
301 Master RelaxNG Compact schema's are found in xml/schema/*.rnc,
302 RelaxNG XML schemas and XML Schema's are generated from RNC syntax.
303 XML config files are checked against RNG and XML Schema's.
304
305 XSLT transformation framework added in xml/xslt/*.xsl, consisting mainly of 
306 LOC Marc21 stylesheets found at http://www.loc.gov/marcxml/xslt.
307 Added stylesheet explain2cqlpqftxt.xsl which transforms a standard SRU ZeeReX 
308 explain record to YAZ CQL-to-PQF text config file. 
309
310 --- 1.0.7 2006/11/07
311
312 Added 'timeout' setting for filter frontend_net which specifies the number
313 of seconds a session is idle before it is closed. Default timeout is
314 300 (5 minutes).
315
316 --- 1.0.6 2006/07/07
317
318 Database name in records returned set for virt_db/multi filters.
319
320 Filter session_shared now functional.
321
322 Log filter can be configured to write to a given file using 'filename'
323 element. Also information category can be specified with 'category'. If
324 filename is omitted, the log filter writes to stdout. See etc/config5.xml
325 for example.
326
327 --- 1.0.5 2006/05/16
328
329 Fixed compilation on Windows.
330
331 --- 1.0.4 2006/05/16
332
333 Added documentation for the hidenavailable option for the multi filter.
334
335 --- 1.0.3 2006/05/16
336
337 Fixed bug #573: Hide errors for individual servers. If the element
338 'hideunavailable' is given in the configuration, individual servers
339 being unavailable are hidden (unless all are unavailable). 
340
341 Fixed bug #574: Database names are recognised case-sensitively.
342
343 Fixed bug #567: Fix up database name in Name-Plus-Record.
344
345 Fixed bug #568: Update win/makefile for VS 2005.
346
347 Fixed bug #569: Some options throws unknown exception.
348
349 --- 1.0.2 2006/04/28
350
351 More information about virtual hosts. The 'etc' directory is part of the
352 distribution tar.
353
354 --- 1.0.1 2006/04/27
355
356 Build instructions for Windows. NMake makefile part of distribution tar.
357
358 --- 1.0.0 2006/04/24
359
360 More documentation.
361
362 Filters functional: auth_simple, backend_test, frontend_net, http_file,
363  log, multi, query_rewrite, template, virt_db, z3950_client.
364
365 Filters in development: session_shared.
366
367 Pseudo-filters: template, dl
368
369 --- 0.9 2006/03/27