* Thu Aug 27 2020 email@example.com
- Update to 1.4.17:
* Database::get_average_length(): Add this as an alias for Database::get_avlen().
In git master we've added this as a preferred new name - adding it to 1.4.x too
will make it easier for users to update to using this.
* Database::get_spelling_suggestion(): Optimise edit distance initialisation
loop to significantly reduce the cost of a typical edit distance calculation.
* Fix query expansion on sharded databases. The mechanism for passing in which
shard a TermList is from wasn't hooked up and as a result we'd always think
it's from the first shard, meaning the statistics would be wrong and that our
suggested terms may not have been as good as they should be in this
* Enquire::get_eset(): Use string::compare() to avoid 1/3 of the string compares
* Update doxygen HTML headers and footers to resolve issues with some
interactive features of the API docs not working. Reported by Enrico Zini.
* Stop specifying obsolete doxygen settings PERL_PATH and MSCGEN_PATH.
* Clarify API docs for MSet::get_termfreq() to make it clear that this
considers all documents in the database, not only those that matched the
searched (it would sometimes be useful to be able to report the number of
occurrences of a term in the matched documents, but it's not something we
currently keep track of). Reported by Tadeusz So?nierz and Peter Salomonsen.
* Sat Aug 15 2020 firstname.lastname@example.org
- update to 1.4.16:
* MSet::snippet(): The snippet now includes trailing punctuation which carries
meaning or gives useful context. See
https://github.com/xapian/xapian/pull/180, reported by Robert Stepanek.
* MSet::snippet(): Fix segfault generating snippet from default-constructed
MSet. This probably isn't something you'd typically do, but it shouldn't
crash. Found during extended testing of #803 (which only affected git
master) which was reported by Robert Stepanek.
* Remove trailing full stop from exception messages. We conventionally don't
include one, but a few cases didn't follow that convention.
* Replace direct use of ftime() which gives deprecation warnings with recent
mingw. Reported by srinivasyadav22.
* Fix segfault in rare cases in the query optimiser. We keep a pointer to the
most recent posting list to use as a hint for opening the next posting list,
but the existing mechanism to take ownership of this hint had a flaw. We now
invalidate the hint in situations where it might be indirectly deleted which
is safe, but somewhat conservative.
* Improve the optimisation of an always-matching OP_VALUE_GE to also take
effect when the value slot's lower bound is equal to the limit of the
OP_VALUE_GE. Patch from boda sadalla.
* Report the correct errno value if commit() fails. We were potentially
reporting ENOENT from an unlink() call cleaning up a temporary file prior to
throwing the exception instead.
* Fix missing menus in API documentation. Newer doxygen generates .js files
which we also need to distribute and install. Reported by sec^nd on #xapian.
* Note OP_FILTER ignored subquery bug fixed in 1.4.15 as present in 1.4.14 and
* Use our own autoconf cache variable namespace (xo_cv_ prefix instead of
ac_cv_) to avoid colliding with standard autoconf macro use if config.site or
a shared config.cache is used. The former case caused a build failure for
the OpenBSD port with 1.4.15, reported by Lucas R.
* Use clock_gettime() and nanosleep() under modern mingw as these allow higher
precision than what we previously used.
* Wed Apr 29 2020 email@example.com
- Update to version 1.4.15:
* Database::check(): Fix checking of replication changesets.
This reverts a change incorrectly made in 1.3.7.
* Database::locked(): Return false instead of true for a closed inmemory DB.
* Database::commit(): If commit() failed with an exception while trying to add
pending changes (e.g. InvalidArgumentError due to a long term containing zero
bytes) then a subsequent commit() on the same object would throw the same
exception. Now we clear the pending changes in this situation (like we
already did for failure at other stages in the commit). This bug remains
unfixed for the chert backend as it's harder to fix there and the effort to
fix it and extra risk of breakage don't seem justified for a backend we
recommend people migrate away from.
* QueryParser::parse_query(): Optimise parsing of multi-word synonyms.
+ Testsuite fixes.
* Hoist positional check above OP_FILTER.
* Handle OP_FILTER with more than two subqueries correctly. Previously we'd
only check the first two subqueries in some situations.
+ remote backend:
* For a remote WritableDatabase, the client now keeps track of whether there
are pending changes, and if there aren't then we now do nothing for commit()
or cancel() calls. In particular this saves a message exchange when the
WritableDatabase destructor is called when changes have already been
committed with an explicit call to commit() (which is what we recommend
doing, since with an explicit call to commit() you get to see any exception
which gets thrown).
* When closing a remote prog WritableDatabase, previously an exception could
leave the remote connection open with the remote server running, and we'd
then wait for the specified timeout before closing the connection. Now we
close the connection before letting the exception propagate.
* Don't swallow exceptions from Database::close() on a remote database. If
we aren't in a transaction and so try to commit() and that fails then
previously the caller would have no indication of the failure.
* Fix handling the reported term weight when remote shards are searched.
Fixes 5 XFAILs in the testsuite.
* Add missing space to mismatching protocol versions error message.
+ build system:
* Fix to build when configured with --disable-backend-remote, broken by changes
in 1.4.14. Fixes #797, reported by ????? ????????.
* The clang and icc compilers both define __GNUC__, which led our ABI mismatch
message to report them as "g++" with a bogus version (the version of GCC that
these compilers advertise themselves as, which for clang is always 4.2.0) -
now we report clang++ or icc along with the actual version of that compiler.
+ updated documentation.
* Wed Jan 15 2020 firstname.lastname@example.org
- Update to 1.4.14:
+ Xapian::QueryParser: Handle "" inside a quoted phrase better. In a quoted
boolean term, "" is treated as an escaped ", so handle it in a compatible way
for quoted phrases. Previously we'd drop out of the phrase and start a new
phrase. Fixes #630, reported by Austin Clements.
+ Xapian::Stem: The constructor which takes a stemmer name now takes an
optional second bool parameter - if this is true, then an unknown stemmer
name falls back to using the "none" stemmer instead of throwing an exception.
This allows simply constructing a stemmer from an ISO language code without
having to worry about whether there's a stemmer for that language, and
without having to handle an exception if there isn't.
+ Xapian::Stem: Fix a bug with handling 4-byte UTF-8 sequences which
potentially affects most of the stemmers. None of the stemmers work in
languages where 4-byte UTF-8 sequences are part of the alphabet, but this
bug could result in invalid UTF-8 sequences in terms generated from text
containing high Unicode codepoints such as emoji, which can cause issues (for
example, in some language bindings). Fix synced from Snowball git post
+ Xapian::Stem: Add a new is_none() method which tests if this is a "none"
+ Xapian::Weight: The total length of all documents is now made available to
Xapian::Weight subclasses, and this is now used by DLHWeight, DPHWeight and
LMWeight. To maintain ABI compatibility, internally this still fetches the
average length and the number of documents, multiplies them, then rounds the
result, but in the next release series this will be handled directly.
+ Xapian::Database::locked() on an inmemory database used to always return
false, but an inmemory Database is always actually a WritableDatabase
underneath, so now we always report true in this case because it's really
always report being locked for writing.
* Fix failing multi_glass_remoteprog_glass tests on x86. When the tests are
run under valgrind, remote servers should be run using the runsrv wrapper
script, but this wasn't happening for remote servers in multi-databases - now
it is. Also, previously runsrv only used valgrind for the remote for an x86
build that didn't use SSE, but it seems there are x87 instructions in libc
that are affected by valgrind not providing excess precision, so do this for
x86 builds which use SSE too. Together these changes fix failures of
topercent2, xor2, tradweight1 under backend multi_glass_remoteprog_glass on
* Fix C++ One-Definition Rule (ODR) violation in testsuite code. Two different
source files linked into apitest were each defining a different `struct
test`. Wrap each in an anonymous namespace to localise it to the file it is
defined and used in. This was probably harmless in practice, unless trying
to build with Link-Time Optimisation or similar (which is how it was
* Test all language codes in stemlangs1. The testsuite hardcodes a list of
supported language codes which hadn't been updated since 2008.
* Improve DateRangeProcessor test coverage.
* Handle pruning under a positional check. This used to be impossible, but
since 1.4.13 it can happen as we now hoist AND_NOT to just below where we
hoist the positional checks. The code on master already handles pruning here
so this bug is specific to the RELEASE/1.4 branch.
* When searching with collapsing over multiple shards, at least some of which
are remote, uncollapsed_upper_bound could be too low and
uncollapsed_lower_bound too high. This was causing assertion failures in
testcases msize1 and msize2 under test harness backends
multi_glass_remoteprog_glass and multi_remoteprog_glass.
* Internally we no longer calculate a bogus total_term_count as the sum of
total_length * doc_count for all shards. Instead we just use the sum of
total_length, which gives the total number of term occurrences. This change
should improve the estimated collection_freq values for synonyms.
* Several places where we might divide zero by zero in a database where wdf was
always zero have been fixed.
+ build system:
* configure: Stop using AC_FUNC_MEMCMP. The autoconf manual marks it as
"obsolescent", and it seems clear that nobody's relying on it as we're
missing the "'AC_LIBOBJ' replacement for 'memcmp'" which it would try to
use if needed.
* HACKING: Replace release docs with pointer to the developer guide where they
are now maintained.
* Eliminate 2 uses of atoi(). These are potentially problematic in a
multithreaded application if setlocale() is called by another thread at the
* Don't check __GNUC__ in visibility.h as the configure probe before defining
XAPIAN_ENABLE_VISIBILITY checks that the visibility attributes work. This
probably makes no difference in practice, as all compilers we're aware of
which support symbol visibility also define __GNUC__.
* Document Sun C++ requires --disable-shared.
- Update to 1.4.13:
* Fix write one past end of std::vector on certain QueryParser parser errors.
This is undefined behaviour, but the write was always into reserved space, so
in practice we'd actually get away with it (it was noticed because it
triggers an error when running under ubsan and using libc++).
* MSet::get_matches_estimated(): Improve rounding of result - a bug meant we
would almost always round down.
* Optimise test for UTF-8 continuation character. Performing a signed char
comparison shaves an instruction or two on most architectures.
* Database::get_revision(): Return revision 0 for a Database with no shards
rather that throwing InvalidOperationError.
* DPHWeight: Avoid dividing by 0 when searching a sharded database when one
shard is empty. The result wasn't used in this case, but it's still
undefined behaviour. Detected by UBSan.
* The "singlefile" test harness backend manager now creates databases by
compacting the corresponding underlying backend database (creating it first
if need be) rather than always creating a temporary database to compact.
* Enable compaction testcases for multi and singlefile test harness backends.
* Add generated database support for remoteprog and remotetcp test harness
* Add test harness support for running testcases using a multi database
comprised of one local and one remote shard, or two remote shards.
* Check if removing existing multi stub failed. Previously if removing an
existing stub failed, the test harness would create a temporary new stub and
then try to rename it over the old one, which will always fail on Microsoft
* Wait for xapian-tcpsrv processes to finish before moving on to the next
testcase under __WIN32__ like we already do on POSIX platforms.
* Optimise OP_AND_NOT better. We now combine its left argument with other
connected and-like subqueries, and gather up and hoist the negated subqueries
and apply them together above the combined and-like subqueries, just below
any positional filters.
* Optimise OP_AND_MAYBE better. We now combine its left argument with other
connected and-like subqueries, and gather up and hoist the optional
subqueries and apply them together above the combined and-like subqueries and
any hoisted positional filters.
* Treat all BoolWeight queries as scaled by 0 - we can optimise better if we
know the query is unweighted.
+ glass backend:
* Allow zlib compression to reduce size by one byte. We were specifying an
output buffer size one byte smaller than the input, but it appears zlib won't
use the final byte in the buffer, so we actually need to pass the input size
as the output buffer size.
* Only try to compress Btree item values > 18 bytes, which saves CPU time
without sacrificing any significant size savings.
+ remote backend:
* Fix match stats when searching with collapsing over multiple shards and at
least some shards are remote.
* Ignore orphaned remote protocol replies which can happen when searching with
a remote shard if an exception is thrown by another shard.
* Wait for xapian-progsrv child to exit when a remote Database or
WritableDatabase object is closed under __WIN32__ like we already do for
* Correct documentation of initial messages in replication protocol.
* quest: Report bounds and estimate of number of matches.
* xapian-delve: Improve output when database revision information is not
available. We now specially handle the cases of a DB with multiple shards
and a backend which doesn't support get_revision().
* Fix warning from GCC 9 with -Wdeprecated-copy (which is enabled by -Wextra)
if a reference to an Error object is thrown.
* Suppress GCC warning in our API headers when compiling code using Xapian with
GCC and -Wduplicated-branches.
* Mark some internal classes as final (following GCC -Wsuggest-final-types
suggestions to allow some method calls to be devirtualised).
* Fix to build with --enable-maintainer-mode and Perl < 5.10, which doesn't
have the `//=` operator. It's unlikely developers will have such an old
Perl, but the mingw environment on appveyor CI does. The use of `//=` was
introduced by changes in 1.4.10.
- Update to 1.4.12:
* Xapian::PostingSource: When a PostingSource without a clone() method is used
with a Database containing multiple shards, the documented behaviour has
always been that Xapian::InvalidOperationError is thrown. However, since at
least 1.4.0, this exception hasn't been thrown, but instead a single
PostingSource object would get used for all the shards, typically leading to
incorrect results. The actual behaviour now matches what was documented.
* Xapian::Database: Add size() method which reports the number of shards.
* Xapian::Database::check(): You can now pass a stub database which will check
all the databases listed in it (or throw Xapian::UnimplementError for
backends which don't support checking).
* Xapian::Document: When updating a document use a emplace_hint() to make the
bulk insertion O(n) instead of O(nlog(n)), and use std::move() to avoid
copying OmDocumentTerm objects.
* Xapian::Query: Add missing get_unique_terms_end() method.
* Xapian::iterator_valid(): Implement for Utf8Iterator
* Fix keepalive1 failures on some platforms. On some platforms a timeout
gives NetworkTimeoutError and on others NetworkError - since 1.4.10 changed
to checking the exact exception type, keepalive1 has been failing on the
former set of platforms. We now just check for NetworkError or a subclass
here (since NetworkTimeoutError is a subclass of NetworkError).
* Run cursordelbug1 testcase with multi databases too.
* Ownership of PostingSource objects during the match now makes use of the
optional reference-counting mechanism rather than a separate flag.
+ remote backend:
* Fix remote protocol design bug. Previously some messages didn't send a reply
but could result in an exception being sent over the link. That exception
would then get read as a response to the next message instead of its actual
response so we'd be out of step.
This fix necessitated a minor version bump in the remote protocol (to 39.1).
If you are upgrading a live system which uses the remote backend, upgrade the
servers before the clients.
* Fix socket leaks on errors during opening a database.
* Don't close remote DB socket on receiving EOF as the levels above won't
know it's been closed and may try to perform operations on it, which would be
problematic if that fd gets reused in the meantime. Leaving it open means
any further operations will also get EOF.
* We add a wrapper around the libc socket() function which deals with the
corner case where SOCK_CLOEXEC is defined but socket() fails if it is
specified (which can happen with a newer libc and older kernel).
Unfortunately, this wrapper wasn't checking the returned value from socket()
correctly, so when SOCK_CLOEXEC was specified and non-zero it would create
the socket() with SOCK_CLOEXEC, then leak that one and create it again
without SOCK_CLOEXEC. We now check the return value properly.
* Fix potential infinite loop in ValueCountMatchSpy::merge_results() if passed
serialised results with extra data appended (which shouldn't happen in normal
+ build system:
* Current versions of valgrind result in false positives on current versions of
macOS, so on this platform configure now only enables use of valgrind if it's
* Refactor macros to probe for compiler flags so they automatically cache
their results and consistently report success/failure.
* Rename our custom TYPE_SOCKLEN_T macro to XAPIAN_TYPE_SOCKLEN_T. The
AX_TYPE_SOCKLEN_T macro defines an alias of TYPE_SOCKLEN_T for itself which
means it can get used instead in some situations, but it isn't compatible
with our macro. We can't just switch to AX_TYPE_SOCKLEN_T as it doesn't
handle cases we need, so just rename our macro to avoid potential problems.
* Improve API documentation for Xapian::Query class. Add missing doc
comments and improve some of the existing ones.
* Add Unicode consortium names and codes for categories from Chapter 4, Version
11 of the Unicode standard. Patch from David Bremner.
* Improve configure --help output - drop "[default=no]" for --enable-*
options which default off.
* Fix API documentation typo - Query::op (the type) not op_ (a parameter name).
* Note which version Document::remove_postings() was added in.
* In the remote protocol documentation, MSG_REPLACEDOCUMENTTERM was documented
as not having a reply, but actually REPLY_ADDDOCUMENT is sent.
* Update list of <xapian/iterator.h> users.
* copydatabase: A change in 1.4.6 which added support for \ as directory
separator on platforms where that's the norm broke the code in copydatabase
which removes a trailing slash from input databases.
* Add missing '#include <cstring>'.
* Fix str() helper function when converting the most negative value
of a signed integer type.
* Avoid calling close() on fd we know must actually be a WIN32 SOCKET.
* Include <ios> not <iomanip> for std::boolalpha.
* Rework setenv() compatibility handling. Now that Solaris 9 is dead we can
assume setenv() is provided by Unix-like platforms (POSIX requires it). For
other platforms, provide a compatibility implementation of setenv() which
so the compatibility code is encapsulated in one place rather than replicated
at every use.
* Fix maintainer-mode builds on Solaris where /bin/tr is not POSIX compliant.
We now use the simple workaround suggested by the autoconf manual.
* Improve support for Sun C++:
+ Suppress unhelpful warning for lambda with multiple return statements.
+ Enable reporting the tags corresponding to warnings, which we need
to know in order to suppress any new unhelpful warnings.
+ Adjust our workaround for bug with this compiler's <cmath> header to avoid
a compiler warning.
+ Use -xldscope=symbolic for Sun C++. This flag is roughly equivalent to
- Bsymbolic-functions which we've probed for with GNU ld since Xapian 1.0.0.
- Update to 1.4.11:
* MSet::SNIPPET_CJK_NGRAM - new flag for use with MSet::snippet() to enable
support for selecting and highlighting snippets which works with the
QueryParser and TermGenerator FLAG_CJK_NGRAM flags. This mode can also be
enabled by setting environment variable XAPIAN_CJK_NGRAM to a non-empty
value. (There was nominally already support for XAPIAN_CJK_NGRAM in
MSet::snippet(), but it didn't work usefully - the highlighting added was all
empty start/end pairs at the end of the span of CJK characters containing the
CJK ngram terms, which to the user would typically look like it was selecting
the end of the text and not highlighting anything).
* Deprecate XAPIAN_CJK_NGRAM environment variable. There are now flags which
can be used instead in all cases, and there's sadly no portable thread-safe
way to read an environment variable so checking environment variables is
problematic in library code that may be used in multithreaded programs.
* Query::OP_ELITE_SET currently incorrectly recursively flattens any OP_OR (or
OP_OR-like) subqueries into the list of subqueries it selects from - until
that's fixed, we now select from the full exploded list rather than the last
n (where n is the number of direct subqueries of the OP_ELITE_SET).
* Testcases which need a generated database now get run with a sharded
* Avoid using strerror() in the testsuite which removes an obstacle to running
tests in parallel in separate threads.
* Extend detection of cases of OP_SYNONYM with disjoint subqueries (which means
we don't need document length) which was added in 1.4.8 - we now detect when
all subqueries are different terms, or when all subqueries are
non-overlapping wildcards. The second case is what QueryParser produces for
a wildcard or partial query with a query prefix which maps to more than one
+ glass backend:
* Handle an empty value slot lower bound gracefully. This shouldn't happen for
a non-empty slot, but has been reported by a notmuch user so it seems there
is (or perhaps was as the database was several years old) a way it can come
about. We now check for this situation and set the smallest possible valid
lower bound instead, so other code assuming a valid lower bound will work
+ chert backend:
* Handle an empty value slot lower bound gracefully, equivalent to the change
made for glass.
* HACKING: We no longer use auto_ptr<>.
* NEWS: Correct factual error in old entry - the 0.4.1 release was Open Muscat
not OmSee (the OmSee name was only applied after that final release was made,
and only used internally to BrightStation).
* Suppress more clang -Wself-assign-overloaded warnings in testcases which are
deliberately testing handling of self-assignment.
* Add missing includes of <cerrno>.
+ debug code:
* When configured with --enable-log, the O_SYNC flag was always specified when
opening the logfile, with the intention that the most recent log entries
wouldn't get lost if there was a crash, but O_SYNC can incur a significant
performance overhead and most debugging is not of such crashes. So we no
longer specify O_SYNC by default, but you can now request synchronous logging
by including %! anywhere in the filename specified with XAPIAN_DEBUG_LOG
(the %! is replaced with the empty string). We also now use O_DSYNC if
available in preference to O_SYNC, since the mtime of the log file isn't
- Update to 1.4.10:
* DatabaseClosedError: New exception class thrown instead of DatabaseError when
an operation is attempted which can't be completed because it involves a
database which close() was previously called on. DatabaseClosedError is a
subclass of DatabaseError so existing code catching DatabaseError will still
work as before.
* DatabaseNotFoundError: New exception class thrown instead of
DatabaseOpeningError when the problem is the problem is "file not found" or
similar. DatabaseNotFoundError is a subclass of DatabaseOpeningError so
existing code catching DatabaseOpeningError will still work as before.
* Query: Make &=, |= and ^= on Query objects opportunistically append to
an existing query with a matching query operator which has a reference
count of 1. This provides an easy way to incrementally build flatter query
* Query: Support `query &= ~query2` better - this now is handled exactly
equivalent to `query = query & ~query2` and gives `query AND_NOT query2`
instead of `query AND (<alldocuments> AND_NOT query2)`.
* QueryParser: Now uses &=, |= and ^= to produce flatter query trees. This
fixes problems with running out of stack space when handling Query object
trees built by abusing QueryParser to parse very large machine-generated
* Stopper: Fix incorrect accents in Hungarian stopword list. Patch from David
* Test MSet::snippet() with small and zero lengths.
* Fix testcase stubdb4 annotations - this testcase doesn't need a backend.
* Add PATH annotation for testcases needing get_database_path() to avoid having
to repeatedly list the backends where this is supported in testcase
* TEST_EXCEPTION helper macro now checks that the exact specified exception
type is thrown. Previously it would allow a subclass of the specified
exception type, but in testcases we really want to be able to test for an
* Map OP_VALUE_GE/OP_VALUE_LE on an empty slot to EmptyPostList. We already do
this for OP_VALUE_RANGE, and it's a little more efficient than creating a
postlist object which checks the empty value slot.
+ glass backend:
* We no longer flush all pending positional changes when a postlist, termlist
or all-terms is opened on a modified WritableDatabase. Doing so was
incurring a significant performance cost, and the first of these happens
internally when `replace_document(term, doc)` is used, which is the usual way
to support non-numeric unique ids. We now only flush pending positional
changes when committing.
+ remote backend:
* Use poll() where available instead of select(). poll() is specified by
POSIX.1-2001 so should be widely available by now, and it allows watching any
fd (select() is limited to watching fds < FD_SETSIZE). For any platforms
which still lack poll() we now workaround this select() limitation when a
high numbered fd needs to be watched (for example, by trying a non-blocking
read or write and on EAGAIN sleeping for a bit before retrying).
* Stop watching fds for "exceptional conditions" - none of these are relevant
to our usage.
* Remove 0.1s timeout in ready_to_read(). The comment says this is to avoid a
busy loop, but that's out of date - the matcher first checks which remotes
are ready to read and then does a second pass to handle those which weren't
with a blocking read.
+ build system:
* Stop probing for header sys/errno.h which is no longer used - it was only
needed for Compaq C++, support for which was dropped in 1.4.8.
* docs/valueranges.html: Update to document RangeProcessor instead of
ValueRangeProcessor - the latter is deprecated and will be gone in the next
* Document RangeProcessor::operator()() returns OP_INVALID to signal it doesn't
recognise a range.
* Update some URLs for pages which have moved.
* Use https for URLs where available.
* HACKING: Update "empty()" section for changes in C++11.
* Suppress clang warnings for self-assignment tests. Some testcases trigger
this new-ish clang warning while testing that self-assignment works, which
seems a useful thing to be testing - at least one of these is a regression
* Add std::move to fix clang -Wreturn-std-move warning (which is enabled by
* Add casts to fix ubsan warnings. These cases aren't undefined behaviour, but
are reported by ubsan extra checks implicit-integer-truncation and/or
implicit-conversion which it is useful to be able to enable to catch
* Fix check for when to use _byteswap_ulong() - in practice this would only
have caused a problem if a platform provided _byteswap_ushort() but not
_byteswap_ulong(), but we're not aware of any which do.
* Fix return values of do_bswap() helpers to match parameter types (previously
we always returned int and only supported swapping types up to 32 bits, so
this probably doesn't result in any behavioural changes).
* Only include <intrin.h> if we'll use it instead of always including it when
it exists. Including <intrin.h> can result in warnings about duplicate
declarations of builtin functions under mingw.
* Remove call to close()/closesocket() when the argument is always -1 (since
the change to use getaddrinfo() in 1.3.3).
* Tue Nov 20 2018 email@example.com
- Update to 1.4.9:
+ Document::add_posting(): Fix bugs with the change in 1.4.8 to more
efficiently handle insertion of a batch of extra positions in ascending
order. These could lead to missing positions and corrupted encoded
* remote backend:
+ Avoid hang if remote connection shutdown fails by not waiting for the
connection to close in this situation. Seems to fix occasional hangs seen on
macOS. Patch from Germán M. Bravo.
- Update to 1.4.8:
+ QueryParser,TermGenerator: Add new stemming mode STEM_SOME_FULL_POS.
This stores positional information for both stemmed and unstemmed terms,
allowing NEAR and ADJ to work with stemmed terms. The extra positional
information is likely to take up a significant amount of extra disk space so
the default STEM_SOME is likely to be a better choice for most users.
+ Database::check(): Fetch and decompress the document data to catch problems
with the splitting of large data into multiple entries, corruption of the
compressed data, etc. Also check that empty document data isn't explicitly
stored for glass.
+ Fix an incorrect type being used for term positions in the TermGenerator API.
These were Xapian::termcount but should be Xapian::termpos. Both are
typedefs for the same 32-bit unsigned integer type by default (almost always
"unsigned int") so this change is entirely compatible, except that if you
were configuring 1.4.7 or earlier with --enable-64bit-termcount you need to
also use the new --enable-64bit-termpos configure option with 1.4.8 and up or
rebuild your applications. This change was necessary to make
- -enable-64bit-termpos actually useful.
+ Add Document::remove_postings() method which removes all postings in a
specified term position range much more efficiently than by calling
remove_posting() repeatedly. It returns the number of postings removed.
+ Fix bugs with handling term positions >= 0x80000000. Reported by Gaurav
+ Document::add_posting(): More efficiently handle insertion of a batch of
extra positions in ascending order.
+ Query: Simplify OP_SYNONYM with single OP_WILDCARD subquery by converting to
OP_WILDCARD with combiner OP_SYNONYM, which means such cases can take
advantage of the new matcher optimisation in this release to avoid needing
document length for OP_WILDCARD with combiner OP_SYNONYM.
+ Catch and report std::exception from the test harness itself.
+ apitest: Drop special case for not storing doc length in testcase postlist5 -
all backends have stored document lengths for a long time.
+ test_harness: Create directories in a race-free way.
+ Avoid needing document length for an OP_WILDCARD with combiner OP_SYNONYM.
We know that we can't get any duplicate terms in the expansion of a wildcard
so the sum of the wdf from them can't possibly exceed the document length.
+ OP_SYNONYM: No longer tries to initialise weights for its subquery, which
should reduce the time taken to set up a large wildcard query.
+ OP_SYNONYM: Fix frequency estimates when OP_SYNONYM is used with a
subquery containing OP_XOR or OP_MAX - in such cases the frequency
estimates for the first subquery of the OP_XOR/OP_MAX were used for
all its subqueries. Also the estimated collection frequency is
now rounded to the nearest integer rather than always being rounded
* glass backend:
+ Revert change made in 1.4.6:
Enable glass's "open_nearby_postlist" optimisation (which especially helps
large wildcard queries) for writable databases without any uncommitted
changes as well.
The amended check isn't conservative enough as there may be postlist changes
in the inverter while the table is unmodified. This breaks testcase
T150-tagging.sh in notmuch's testsuite, reported by David Bremner.
+ When indexing a document without any terms we now avoid some unnecessary work
when storing its termlist.
* build system:
+ New --enable-64bit-termpos configure option which makes Xapian::termpos a
64-bit type and enables support for storing 64-bit termpos values in the
glass backend in an upwardly compatible way. Few people will actually want
to index documents more than 4 billion words long, but the extra numbering
space can be helpful if you want to use term positions in "interesting" ways.
+ Hook up configure --disable-sse/--enable-sse=sse options for MSVC.
+ Fix configure probes for builtin functions for clang. We need to specify the
argument types for each builtin since otherwise AC_CHECK_DECLS tries to
compile code which just tries to take a pointer to the builtin function
causing clang to give an error saying that's not allowed. If the argument
types are specified then AC_CHECK_DECLS tries to compile a call to the
builtin function instead.
+ Fix documentation comment typo.
+ xapian-delve: Test for all docs empty using get_total_length() which is
slightly simpler internally than get_avlength(), and avoids an exact floating
point equality check.
+ quest: Support --weight=coord.
+ xapian-pos: New tool to show term position info to help debugging when using
positional information in more complex ways.
+ Fix undefined behaviour from C++ ODR violation due to using the same name
two different non-static inline functions. It seems that with current GCC
versions the desired function always ends up being used, but with current
clang the other function is sometimes used, resulting in database corruption
when using value slots in docid 16384 or higher with the default glass
backend. Patch from Germán M. Bravo.
+ Suppress alignment cast warning on sparc Linux. The pointer being cast is to
a record returned by getdirentries(), so it should be suitable aligned.
+ Drop special handling for Compaq C++. We never actually achieved a working
build using it, and I can find no evidence that this compiler still exists,
let alone that it was updated for C++11 which we now require.
+ Create new database directories in race-free way.
+ Avoid throwing and handling an exception in replace_document() when
adding a document with a specified docid which is <= last_docid but currently
+ Use our portable code for handling UUIDs on all platforms, and only use
platform-specific code for generating a new UUID. This fixes a bug with
converting UUIDs to and from string representation on FreeBSD, NetBSD and
OpenBSD on little-endian platforms which resulted in reversed byte order in
the first three components, so the same database would report a different
UUID on these platforms compared to other platforms. With this fix, the
UUIDs of existing databases will appear to change on these platforms
(except in rare "palindronic" cases). Reported by Germán M. Bravo.
+ Fix to build with a C++17 compiler. Previously we used a "byte" type
internally which clashed with "std::byte" in source files which use
"using namespace std;". Fixes #768, reported by Laurent Stacul.
+ Adjust apitest testcase stubdb2 to allow for NetBSD oddity: NetBSD's
getaddrinfo() in IPv4 mode seems to resolve ::1 to an IPv4 address on the
+ Avoid timer_create() on OpenBSD and NetBSD. On OpenBSD it always fails with
ENOSYS (and there's no prototype in the libc headers), while on NetBSD it
seems to work, but the timer never seems to fire, so it's useless to us (see
+ Use SOCK_NONBLOCK if available to avoid a call to fcntl(). It's supported by
at least Linux, FreeBSD, NetBSD and OpenBSD.
+ Use O_NOINHERIT for O_CLOEXEC on Windows. This flag has essentially the same
effect, and it's common in other codebases to do this.
+ On AIX O_CLOEXEC may be a 64-bit constant which won't fit in an int. To
workaround this stupidity we now call the non-standard open64x() instead
of open() when the flags don't fit in an int.
+ Add functions to add/multiply with overflow check. These are implemented
with compiler builtins or equivalent where possible, so the overflow check
will typically just require a check of the processor's overflow or carry
* Wed Oct 24 2018 firstname.lastname@example.org
- Update to 1.4.7:
+ Database::check(): Fix bogus error reports for documents with length
zero due to a new check added in 1.4.6 that the doclength was between the
stored upper and lower bounds, which failed to allow for the lower bound
ignoring documents with length zero (since documents indexed only by
boolean terms aren't involved in weighted searches).
+ Query: Use of Query::MatchAll in multithreaded code causes problems
because the reference counting gets messed up by concurrent updates.
Document that Query(string()) should be used instead of MatchAll in
multithreaded code, and avoid using it in library code.
+ Stemming algorithms added for Irish, Lithuanian, Nepali and Tamil.
+ Merge Snowball compiler changes which improve code generation.
+ Merge optimisations to the Arabic and Turkish stemmers.
+ Fix duplicate test in apitest closedb10 testcase.
* See also https://xapian.org/docs/xapian-core-1.4.7/NEWS
* Tue Jul 24 2018 email@example.com
- Fix RPM groups.
- Trim bias and redundancies from description.
* Tue Jul 03 2018 firstname.lastname@example.org
- Update to 1.4.6:
* API classes now support C++11 move semantics when using a compiler which
we are confident supports them (currently compilers which define
__cplusplus >= 201103 plus a special check for MSVC 2015 or later).
C++11 move semantics provide a clean and efficient way for threaded code to
hand-off Xapian objects to worker threads, but in this case it's very
unhelpful for availability of these semantics to vary by compiler as it
quietly leads to a build with non-threadsafe behaviour. To address this,
user code can #define XAPIAN_MOVE_SEMANTICS before #include <xapian.h> to
force this on, and will then get a compilation failure if the compiler
lacks suitable support.
+ We were only escaping output for HTML/XML in some cases, which would
potentially allow HTML to be injected into output (this fixes
+ Include certain leading non-word characters in snippets. Previously we
started the snippet at the start of the first actual word, but there are
various cases where including non-word characters in front of the actual
word adds useful context or otherwise aids comprehension.
* Add MSetIterator::get_sort_key() method. The sort key has always been
available internally, but wasn't exposed via the public API before, which
seems like an oversight as the collapse key has long been available.
+ Allow Compactor::resolve_duplicate_metadata() implementations to delete
entries. Previously if an implementation returned an empty string this
would result in a user meta-data entry with an empty value, which isn't
normally achievable (empty meta-data values aren't stored), and so will
cause odd behaviour. We now handle an empty returned value by
interpreting it in the natural way - it means that the merged result is
to not set a value for that key in the output database.
+ Since 1.3.5 compacting a WritableDatabase with uncommitted changes throws
Xapian::InvalidOperationError when compacting to a single-file glass
database. This release adds similar checks for chert and when compacting
to a multiple-file glass database.
+ In the unlikely event that the total number of documents or the total
length of all documents overflow when trying to compact a multi-database,
we throw an exception. This is now a DatabaseError exception instead of a
const char* exception (a hang-over from before this code was turned into a
public API in the library).
* See also https://xapian.org/docs/xapian-core-1.4.6/NEWS