3 Fix hang or memory violation if show occurred before a search. (not that
4 it makes much sense to perform a show before a search).
8 pz2.js: Element_parseChildNodes concatenates all Text/CDATA nodes, instead
13 New pz:metadata attribute, empty="empty-value" for Pazpar2's
14 internal representation. With this attribute, Pazpar2 treates an empty
15 pz:metadata type as having the value for "empty" - if empty.
17 New setting, pz:extendrecs, which triggers extended fetch of records
18 for a database beyond pz:maxrecs for a show command.
20 Fix warning that was falsely issued for "missing limitmap".
22 Log message for Pazpart start/stop changed. Now using same style as
23 Metaproxy, ie Pazpar2 start SHA1 / Pazpar2 stop .
27 Fix hang of 2nd command=show with esn/syntax given.
31 New merge attribute type: 'first', which takes all metadata fields
32 from first target that returns the particular field.
36 Extend info command with hostname and YAZ SHA1
37 Indent results for both command stat and info.
39 Allow limit on merged content. The new configuration metadata
40 element, limitcluster, configures that a metadata element (name) be used
41 as limit name for search. Applies to the whole service (ie all targets),
42 unlike pz:limitmap which is configured per-target (database).
44 New feature: limitmap local:* matches against all metadata fields.
46 Allow repeated list in limitmap spec . Separated by comma. For
47 example: value="local:title,rpn:@attr 1=4".
49 New element <message> in bytarget response. Holds diagnostic message
50 of code (say 'Unsupported Use Attribute' for Bib-1 114).
52 Improved logging for record ingestion failures.
54 Avoid using struct icu_chain in non-YAZ_HAVE_ICU mode. In the rare case,
55 when YAZ is compiled without ICU support.
59 Requires YAZ-4.2.40 to support native solr support.
61 Fix and improve logic handling whether or not to re-do search on sort
62 order changes. A sort order with change in ascending/descending only
63 whould not trigger a new search, which is required for targets with
64 native sorting capabilities. Each client is now checked if instructions
65 (sortmap) exist for native sorting and only client that does requires
66 it is researched. Other clients is just re-ingesting the records,
67 they already have. The resultset is now cleared if any researching
70 Connection sharing between session has broken since version 1.6.8 with
71 introduction of logic that would minimize searching if pazpar2 could
72 detect this based on same query and limits and partly sort order.
73 This could lead to segementations violations.
75 Added a chapter in the manaul about relevance ranking.
79 Rank tweak: follow=number will increase mult by number if two terms
80 occur next to each other; number-1 if they are one term apart , .. 0
81 if they are number a part (all in order). Default is 0 (following
84 Rank tweak: lead=k will divide mult by 1 + log2(1+k*l) where k is
85 value given by lead and l is length from beginning of field where
86 term occurs (l=0 for first term, l=1 for second term, ..). Default
89 Rank tweak: length=strategy. length="linear" if mult is to be divided
90 by length (existing, default behavior), length="log" if mult is to be
91 divided by log2(1+length), length="none" if mult is not to be affected
96 Rank algorithm details may be printed as part of show response in
97 element <relevance_info>.. This is only printed if <rank debug="yes"/>
100 Record as returned by show/record command have a minimal indentation
101 which makes things human-readable.
103 New configuration of default sorting criteria (sort-default) in
104 service definition. If no criteria is defined it will be as before
107 Search command now supports sort parameter just as the show command.
108 If no parameter is give, it will use the service sort-default value.
110 --- 1.6.19 2012/09/18
112 Rank algorithm skips strings that gets normalized to empty string.
113 For example, & and ! could map to the empty string. The weight for
114 those terms is now 0 (as if they were not part of the query).
116 Rank algorithm does not use CCL from limitmap; only from the query
117 parameter (user query).
121 --- 1.6.18 2012/09/17
123 Rank algorithm configurable by 'rank' element inside service. So far
124 only, attribute 'cluster' is recognized. If cluster="yes", multiple
125 records inside a cluster boosts higher than single records. This
126 is default behavior and existing behavior. cluster="no" takes the
127 average score of each record in a cluster.
129 --- 1.6.17 2012/09/05
131 Fix bad re-use of connections (connections with changing proxy should not
134 --- 1.6.16 2012/08/22
136 Fix a bug introduce in 1.6.15 around the position sorting. It resetted the
137 resultset and sorting when the sort order is position. However this will be done on
138 every client poll, which will make pazpar2 continuing reset and fetching.
139 It should only be done on FIRST request where the sort order change.
141 Fix an issue on suggestion option: Also disable suggestions on empty string.
143 Clean up in turbo marc stylesheet.
145 Remove the hardcoded size of termlists.
147 --- 1.6.15 2012/06/27
149 New facility: ccldirective may be given in service definition. Allows
150 CCL parsing to be customized a bit, such as defining names of operators
153 New facility: raw record by checksum, rather than offset. The record
154 command optionally takes checksum which identifies certain record from
157 New facility: per field ranking. Rank may be given as M [F N] where
158 M is default rank and N is rank for CCL terms from field F.
160 --- 1.6.14 2012/06/04
162 Fix for IE7/8 in pz.js
164 Applied patch from Giannis Kosmas on keepAlive, which also adds keepAlive to init response.
166 Lower log level some places.
168 Remove some invalid test results.
170 --- 1.6.13 2012/05/23
172 Introducing a version=2 parameter for show, termlist and bytarget commands.
173 This enables pazpar2 to return approximation on hit and count count when
174 doing record filtering using the limit parameter on search and a
175 limitmap with a value of "local:"
177 Setting pz:xslt may embed local XSLT as an alternative to referring
179 Value is not CDATA but XML nodes embedded, so escaping is not necessary
180 but a root element *must* be present. For example:
181 <settings target="target="z3950.indexdata.com/marc">
190 Metadata field rank may given by XML internal document (pz:xslt
191 result). If rank is not given, the rank from service description is
194 Metadata field can now configured a default limitmap and facetmap.
195 Setting limitmap to "local:" would work for all kind of targets, but would
196 prob. not be the optimal solution. But at least better than the default behavior
197 of pazpar2 where no filtering is done.
199 A service definition can now also contains <set/> that defines service-wide
200 settings. These will override server-wide sets and will be overridded by
203 New setting, pz:present_chunk, that specifies number of records to fetch
204 at a time. Zero will disable chunkation; will fetch max_records at once.
206 --- 1.6.12 2012/03/14
208 Revert the format change in termlist response, that could break
209 some clients / UIs since they were expecting an (empty) element
210 if no facet values was found.
212 --- 1.6.11 2012/03/07
214 Revert the behavior of returning errors when unable to block
215 on termlist, bytarget and search, when unable to block due to
216 other block. The client will now receive a regular response,
217 but it will be logged in the server. A parameter (report) is
218 added to change behavior to return error response or WARNING
219 status message. Consider this "API" as private, as it is mostly
220 untested and could be changed in future releases.
222 Fix spell error in pz2.js fix in 1.6.10.
224 New Marc2TurboMarc.xsl (contribution from Sven Porst).
225 Can solve the missing marc21.xsl updates in some cases.
227 tmarc.xsl: Simplify the 6xx to subject-long and fix 1-based
228 substring (contribtion from Sven Porst)
230 marc21.xsl: fix 1-based substring call
232 tmarc.xsl and marc21.xsl: use 856$a as last option for electronic-text.
234 Add test_termlist_block to test suite
236 --- 1.6.10 2012/02/23
238 Fix SEGV for invalid PQFs and SRU/SOLR targets
239 Also refactor a bit the code that converts from PQF to SRU/SOLR queries.
241 Fix pz2.js: "null object" due to change in in bytarget result XML.
243 Fixes in tmarc.xsl: Subject-long shorten for extra commas only.
244 Added this normalization to the other subject-long fields (d6xx),
245 where it was missing.
247 Fixes in marc21.xsl: Updated with most of the new tmarc.xsl.
248 Still differences around medium and holdings. marc21.xsl is not
249 longer active used by Index Data, and should be considered unsupported.
250 Use tmarc.xsl instead.
254 Fix SEGV that could occur for failed connections.
258 Fix bug for command sort that could return no results for active clients
259 (from previous search). This bug was present in 1.6.6-1.6.7.
261 Fix bug in results that could include results that should have been
262 filtered out. This bug was present in 1.6.6-1.6.7.
266 Fix bug introduced in 1.6.6 where a connection re-use could stall
269 Local filtering may now specify a local metadata field, eg.
270 pz:limitmap:somefield[t]=local:otherfield
274 For search, when limit and or filtering is in place and search
275 is identical to previous search, the result set is re-used and the
276 target is not searched.
278 Limits may work perform local filtering as well, by using "local:"
283 Updated bytarget command to contain a suggestions element with misspelled
284 words and suggestions to these. pz2.js has been updated to deliver this
285 onwards as well. Only target that currently delivers this is the solr
286 client in YAZ 4.2.18.
290 New service definition element, xslt, that allows an embedded stylesheet
291 to be defined. This can be referred to from pz:xslt as an alternative to
294 New pz:sortmap:field setting for specifying hints on how to make
295 a target natively sort on a field. This is used for command=show in
296 conjunction with sort.
298 New pz:url setting for specifying the actual URL for a target. When
299 this is used the target ID is not used as URL anymore and the target ID
300 may be almost any string (not including []).
302 command=termlist without name parameter returns all termlists/facets.
303 Previously if name parameter was omitted, only "subject" was returned.
307 Make termlist sorting stable. Terms with same frequency are now sorted by
308 their display name. This makes a pretty display and improves our
309 regression test because qsort is not a stable sort.
311 New sort parameter value 'position'. The 'position' sorts merged records
312 by their original position from the remote target. This is primarily useful
313 for debugging and may be used for targets that already perform some kind
314 of relevance ranking. Note that sort by default is decreasing; so to get
315 records in their original order sort=position:1 must be used.
319 tmarc.xsl: yet another 773$g fix. Was broken in 1.6.1 as well.
321 Facility to change working directory for pazpar2 daemon. Option -wdir
322 sets working directory to dir. This facility is useful if core dumps
323 must be saved. In this case, the current working directory must be
324 writable by the running user, such as "nobody".
328 New configuration element <icu_chain> for <server>/<service> which
329 allows a named ICU rule (chain) to be defined. The names relevance,
330 sort, mergekey and facet are used for those operations. The definition
331 <icu_chain id="sort" locale="en"> .. </icu_chain>
333 <sort> <icu_chain locale="en> ... </icu_chain> </sort>
334 And so on.. for relevance, mergekey and facet as well. The latter
335 style is deprecated. The facet terms are normalized by the facet
336 rule by default. This may be changed on a metadata field basis by
337 defining the new attribute 'facetrule' for the metadata element.
339 <icu_chain id="myrule" locale="en"> ... </icu_chain>
340 <metadata name="author" termlist="yes" facetrule="myrule"/>
342 Preserve rorder for merged metadata. Fixes issue as reported by Sven
343 Porst: http://lists.indexdata.dk/pipermail/yazlist/2011-July/003230.html
345 tmarc.xsl: set journal-subpart to 773$ only.
349 Modify the behavior for the limit parameter (first defined in 1.5.7).
350 Mapping of limit searches are now defined by the new configuration item
351 pz:limitmap. Fix a dead-lock problem with the limit parameter.
353 Extend tmarc.xsl to extract 773$g data (OpenURL).
357 ICU default maps remove backquote (`).
359 Command 'search' takes limit parameter (optional). The limit parameter
360 allows a search to be limited one or more facets and the corresponding
361 values. This is for server side filtering.
363 Configure tweak: Use -lm for log(3) if needed
367 Fix a problem with skiparticle sortkey that could be completely
368 ignored (and reduced to "").
370 Fix dependency problem in pazpar2 RPM package (did not require
371 libyaz4 as it should).
375 Fix memory leak that occurred for command=termlist&name=xtargets .
377 Pazpar2 may save HTTP requests. Enabled by option -R.
381 Experimental support for DTIC DADS target. New dads-pz2.xsl.
383 Support for query_syntax (overrides the default for SRU | Z39.50)
385 Support for extraArgs (ZOOM "extraArgs" option) for targets
387 New commands: status-server and status-session
391 Fix for threaded runs: Client now have a copy of the database URL,
392 which can used after the database has been release from the client.
393 This makes the logging in the connection idle timeout of the client nicer (no NOURL) and should be thread-safe.
395 tmarc.xsl: Add journal-title-abbrev and full text.
397 cf.xsl: new fields: isbn, issn, journaltitle, volume, issue
399 Fix for cmd=record before search.
401 Session Logging clean up.
403 Fix wrong termlist factor when maxrecs is different from 100.
407 Fix missing pz:termlist_term_factor in settings.c messed up pz:preferred.
408 Term factor is default enabled but can be diseabled by
409 pz:termlist_term_factor=0
413 Add scaling of facet count. Currently always enabled, needs fixing.
414 Allow user-defined info for target suffix. This has no meaning in
415 Pazpar2 except to distinguish targets from each other. The suffix
416 data begins with #. For example z3950.indexdata.com/gils#Mydata
418 Added exact-match recordfilter; format name=value
422 SOLR support. Pazpar2 may operate as web service client for SOLR.
426 Fix for show command and block=1 (dead lock). Bug was introduced in
431 New RPM packages: pazpar2, pazpar2-js, pazpar2-doc. These have been
432 tested on CentOS 5.5 only.
436 Fix problem with result sets being removed from a client session
437 if the connection for it was resused by another session. Bug #3489.
439 New iphone UI for Pazpar2 (www/iphone).
443 Fixes for threaded operation.
445 New stylesheets for TurboMARC: tmarc.xsl and opac_turbomarc.xsl.
447 New example services in etc/services in source. In the Debian packages
448 these are located in /etc/pazpar2/services-available
450 Threaded mode operational on Windows. Requires Windows 7 or Windows
453 Default value of setting pz:max_connections is 0 which means that there
454 is no limit on number of connections.
458 Pazpar2 may operate in threaded mode. Enabled by element threads in
459 the configuration. See pazpar2_conf for details.
461 New setting setting: pz:max_connections. Setting pz:max_connections is
462 a limit of number of sockets to a host. When this limit is reached,
463 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
464 The client will be marked Client_Error when it can not be searched
465 (other clients in a session may work). If pz:max_connections is not set
466 for a target, a value of 30 will be used. Note: the pz:max_connections
467 will only work in threaded mode.
469 pz2.js: JSON support for show.
471 Debian package: Enable default service, default.xml, before starting
472 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
476 Debian version depends on on libyaz4. Note that Pazpar2 will still
477 compile from source with YAZ 3.
479 Split services into separate files. The example configuration file
480 pazpar2.cfg.dist now includes a default service default.xml (part of
481 etc). And default.xml includes settings/edu.xml. The default.xml file,
482 not to be confused with settings/defaults.xml, is a template for jsdemo
483 and other services. The Debian package installs /etc/pazpar2/server.xml
484 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
485 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
486 The default.xml (from etc) is installed in /etc/pazpar2/services-available
487 and a symlink to it is created from services-enabled. The default.xml
488 service is unnamed and, thus, will be used by jsdemo and test1.
490 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
491 new setting pz:negotiation_charset specifies character set for Z39.50 Init.
495 Support for additional fields in cf.xsl and pazpar2.conf.dist:
496 publisher, available, due, location (=locallocation), callno
497 (=callnumber), thumburl and score.
499 Describe pz:xslt and the auto setting.
501 Move mergekey definition away from the normalization stylesheets and
502 define a mergekey common for all target types in pazpar2.cfg.
504 Code update: Use the Odr_int type for hit counts. This is part of
505 YAZ 3.0.47 and later and so configure checks for that.
509 Metadata attribute 'skiparticle' also works for ICU based
510 normalization. (was only working for the non-ICU/ASCII before).
512 Command bytarget with argument settings=1 will show settings per
513 target.. This is to be able to verify correct settings and be able to
514 test that they are correct. The database settings array size is now
515 also stored.. Problems with database settings array is that if not
516 careful it will be too small (smaller than dictionary per-service
519 Make record list sorting stable by comparing mergekey for records if
520 relevance/title or other sorting criteria all match. This is merely to
521 ensure that our regressions tests works (reproducible output).
523 Relevance calculation changes: use a different denominator (length) for
524 per-field relevance scoring.. Instead of length of all ranked fields we
525 now use length of individual fields (as if they were individual "free"
526 text fields). This will ensure that documents with a long field with no
527 match (say description) will not "hurt" a title match.
529 Diagnostic member was not set on connection error. Fixed
533 Command search takes two optional parameters, startecs and maxrecs,
534 that specifies the start offset (0, 1, ...) and maximum number of records
535 to fetch for each target.
537 XSLTs + MARC maps are cached within a session so we don't re-parse
538 them over and over again. Even for a session with a single search
539 there's much to be gained because many targets use the same
542 The metadata attribute 'mergekey' now takes one of three values 'no',
543 'required', 'optional' . And the resulting mergekey from metadata
544 is now ordered in the same way as metadata in the service definition.
545 Older Pazpar2 version use the order in which metadata appeared in a
548 The search argument 'filter' now offers a new operator ~ which does a
549 substring match. The = operator works as before: string match for
550 anything but pz:id, or target match for pz:id.
552 New setting pz:recordfilter. The value of this setting takes the
553 form name[~value]. This setting makes Pazpar2 ignore all retrieved
554 records that do not have the metadata element name with value substring
557 Pazpar2 allows YAZ log level to be set (option -v).
561 For WS responses Pazpar2 creates XML header. Exception: raw record.
563 Setting XML files are now stored in etc/settings instead of etc. This
564 reflects the layout with the Debian package layout.
566 Settings may be posted for command=settings. The POSTed settings must
567 have root element 'settings' like regular setting files. In order to be
568 recognized, the POST request must use Content-Type=text/xml.
570 A service may be posted for command=init. This service will be used
571 during the session. The service may have its own target settings,
572 ICU config, timeout, etc. In order to be recognized, the POST request
573 must use Content-Type=text/xml.
575 Timeout values may be given per-service. That's element 'timeout'
576 which takes three attribute values (a subset may be given): 'session',
577 'z3950_operation', 'z3950_session'. Option -T is no longer supported
578 - used to specify session timeout.
580 Option -t tests the Pazpar2 configuration and returns exit code
581 (0=success, non-zero=failure). In previous version of Pazpar2, -t
582 specified local settings.
584 In version 1.2.0 the configuration file - after include processing -
585 was dumped to stdout. Now, the configuration is only dumped to the
586 yaz log file if option -d is given.
590 Configuration may now have multiple server areas. This means that a
591 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
592 yet supported - on a server basis. Configuration may also have multiple
593 services .. That is repeating service elements inside a server. Each
594 has an attribute 'id' which serves as service ID. This ID in turn may
595 be used in a Pazpar2 session, by specifying parameter service=ID for
596 command init. There can be at most one unnamed service inside a server
597 which can be referred to by not specifying an service ID for command
598 init (backwards compatible). In order to partition multiple servers and
599 services a new include directive has been added. This takes an attribute
600 'src' which specifies one or more sub-files. For example to include
601 service files, one might use:
602 <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
603 It is the intention that that completely makes the settings directive
606 Fix problem where the record command would wait forever if there were
607 no targets to wait for (activeclients == 0).
611 One result set is created per session (last search) rather than for
612 each connection which happen to be shared (bug #3009).
614 marc21 stylesheets changed for efficiency.
618 Session timeout may be specified on the command-line as option -T.
620 Pazpar2 may now be operated in a no-merged mode for records.. All records
621 will be considered unique. This mode is enabled if no mergekey is
622 generated by the normalization stylesheet (pz:xslt).
624 Pazpar2 caches original records from each target and the 'record' command
625 with offset returns the original record if 'syntax' and 'esn' are NOT
626 specified. This speeds up retrieval of original records but also means
627 that Pazpar2 uses more memory. The cached records will be freed when the
628 session terminates or a new search is executed.
630 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
631 library part of YAZ is used.
633 Added SRU client support.
635 Automatically computes pz:nativesyntax if not provided. Works for XML and
638 --- 1.0.13 2008/11/24
640 Command bytarget returns name of target (if defined).
642 --- 1.0.12 2008/11/04
644 Fixed bug #2021.. location now holds all brief elements.
646 --- 1.0.11 2008/10/15
648 Fixed check for application/x-www-form-urlencoded parameters.
650 --- 1.0.10 2008/10/14
652 Fixes for IE in pz2.js.
654 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
658 Changed the JS library pz2.js to use POST for long URL (+ params).
660 Added installation instructions for Windows. Note: NT services is
661 NOT available until we make a new release of YAZ.
663 Preserve order of repeated metadata fields (they were reversed before).
665 More MARC21 information extracted for metadata.
669 Fixed bug #1162: HTML entities are not escaped properly.
671 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
675 Marc21 stylesheet updated to reflect multiple full text fields
679 Fixed bug in pz2.js WRT DOMElement attributes on IE.
681 Fixed bug 2100: Database wildcards not working
685 Added support for retrieval of records in binary.
687 Fixed bug 1794: Pazpar2 does not return valid XML.
689 Deal with ICU not returning sortkey (resulted in SEGV before).
693 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
694 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
696 Improved diagnostics when Pazpar2 HTTP decoding fails.
698 Pazpar2 requests may be POSTed as using Content-Type
699 application/x-www-form-urlencoded.
701 Pazpar2 honors LF in HTTP headers.
703 Handle targets that handle negative hit counts (should not happen, but it
708 ICU is used for tokenization and normalization of the following: mergekey,
709 sorting, relevance terms.
711 Debian package now enables ICU tokenization and normalization by default.
715 Exposed user setting values (i.e. non-pz: names) to the record systems in two
716 ways: Either as parameters to the normalization stylesheets (which would allow the
717 programmer to postprocess or use the values in any way) or after the normalization
718 step, in which case values are made part of the normalized record (and available for
719 sorting, termlists, display, or other interface-related use.
721 Implemented sorting by year.
723 Option -d dumps records to the current log file instead of stderr.
725 Fixes for compilation on cygwin.
727 Z39.50 client code uses pz:elements. pz:elements was recognized in
728 earlier Pazpar2 versions but it was not used for anything.
730 icu_chain_test is using fgets instead of getline - fixes compilation
733 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
734 query conversions fail (rather than _any_). This means targets that do
735 not support some fields are ignored in a search.
739 Improved handling of socket timeout for Z39.50 connections.
741 Misc documentation updates and spell fixes.
743 Debian package pazpar2 creates log rotate entry.
745 Debian package pazpar2-apache2 reloads Apache2.
747 jsdemo included in distribution. It illustrates the use of the js/pz2.js
752 First public release.