1 /* database-private.h - For peeking into the internals of notmuch_database_t
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #ifndef NOTMUCH_DATABASE_PRIVATE_H
22 #define NOTMUCH_DATABASE_PRIVATE_H
24 /* According to WG14/N1124, a C++ implementation won't provide us a
25 * macro like PRIx64 (which gives a printf format string for
26 * formatting a uint64_t as hexadecimal) unless we define
27 * __STDC_FORMAT_MACROS before including inttypes.h. That's annoying,
30 #define __STDC_FORMAT_MACROS
33 #include "notmuch-private.h"
35 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
37 #ifdef SILENCE_XAPIAN_DEPRECATION_WARNINGS
38 #define XAPIAN_DEPRECATED(D) D
43 /* Bit masks for _notmuch_database::features. Features are named,
44 * independent aspects of the database schema.
46 * A database stores the set of features that it "uses" (implicitly
47 * before database version 3 and explicitly as of version 3).
49 * A given library version will "recognize" a particular set of
50 * features; if a database uses a feature that the library does not
51 * recognize, the library will refuse to open it. It is assumed the
52 * set of recognized features grows monotonically over time. A
53 * library version will "implement" some subset of the recognized
54 * features: some operations may require that the database use (or not
55 * use) some feature, while other operations may support both
56 * databases that use and that don't use some feature.
58 * On disk, the database stores string names for these features (see
59 * the feature_names array). These enum bit values are never
60 * persisted to disk and may change freely.
62 enum _notmuch_features {
63 /* If set, file names are stored in "file-direntry" terms. If
64 * unset, file names are stored in document data.
66 * Introduced: version 1. */
67 NOTMUCH_FEATURE_FILE_TERMS = 1 << 0,
69 /* If set, directory timestamps are stored in documents with
70 * XDIRECTORY terms and relative paths. If unset, directory
71 * timestamps are stored in documents with XTIMESTAMP terms and
74 * Introduced: version 1. */
75 NOTMUCH_FEATURE_DIRECTORY_DOCS = 1 << 1,
77 /* If set, the from, subject, and message-id headers are stored in
78 * message document values. If unset, message documents *may*
79 * have these values, but if the value is empty, it must be
80 * retrieved from the message file.
82 * Introduced: optional in version 1, required as of version 3.
84 NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES = 1 << 2,
86 /* If set, folder terms are boolean and path terms exist. If
87 * unset, folder terms are probabilistic and stemmed and path
90 * Introduced: version 2. */
91 NOTMUCH_FEATURE_BOOL_FOLDER = 1 << 3,
93 /* If set, missing messages are stored in ghost mail documents.
94 * If unset, thread IDs of ghost messages are stored as database
95 * metadata instead of in ghost documents.
97 * Introduced: version 3. */
98 NOTMUCH_FEATURE_GHOSTS = 1 << 4,
101 /* If set, then the database was created after the introduction of
102 * indexed mime types. If unset, then the database may contain a
103 * mixture of messages with indexed and non-indexed mime types.
105 * Introduced: version 3. */
106 NOTMUCH_FEATURE_INDEXED_MIMETYPES = 1 << 5,
108 /* If set, messages store the revision number of the last
109 * modification in NOTMUCH_VALUE_LAST_MOD.
111 * Introduced: version 3. */
112 NOTMUCH_FEATURE_LAST_MOD = 1 << 6,
114 /* If set, unprefixed terms are stored only for the message body,
117 * Introduced: version 3. */
118 NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY = 1 << 7,
121 /* In C++, a named enum is its own type, so define bitwise operators
122 * on _notmuch_features. */
123 inline _notmuch_features
124 operator| (_notmuch_features a, _notmuch_features b)
126 return static_cast<_notmuch_features>(
127 static_cast<unsigned>(a) | static_cast<unsigned>(b));
130 inline _notmuch_features
131 operator& (_notmuch_features a, _notmuch_features b)
133 return static_cast<_notmuch_features>(
134 static_cast<unsigned>(a) & static_cast<unsigned>(b));
137 inline _notmuch_features
138 operator~ (_notmuch_features a)
140 return static_cast<_notmuch_features>(~static_cast<unsigned>(a));
143 inline _notmuch_features&
144 operator|= (_notmuch_features &a, _notmuch_features b)
150 inline _notmuch_features&
151 operator&= (_notmuch_features &a, _notmuch_features b)
158 * Configuration options for xapian database fields */
159 typedef enum notmuch_field_flags {
160 NOTMUCH_FIELD_NO_FLAGS = 0,
161 NOTMUCH_FIELD_EXTERNAL = 1 << 0,
162 NOTMUCH_FIELD_PROBABILISTIC = 1 << 1,
163 NOTMUCH_FIELD_PROCESSOR = 1 << 2,
164 } notmuch_field_flag_t;
167 * define bitwise operators to hide casts */
168 inline notmuch_field_flag_t
169 operator| (notmuch_field_flag_t a, notmuch_field_flag_t b)
171 return static_cast<notmuch_field_flag_t>(
172 static_cast<unsigned>(a) | static_cast<unsigned>(b));
175 inline notmuch_field_flag_t
176 operator& (notmuch_field_flag_t a, notmuch_field_flag_t b)
178 return static_cast<notmuch_field_flag_t>(
179 static_cast<unsigned>(a) & static_cast<unsigned>(b));
182 #define NOTMUCH_QUERY_PARSER_FLAGS (Xapian::QueryParser::FLAG_BOOLEAN | \
183 Xapian::QueryParser::FLAG_PHRASE | \
184 Xapian::QueryParser::FLAG_LOVEHATE | \
185 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE | \
186 Xapian::QueryParser::FLAG_WILDCARD | \
187 Xapian::QueryParser::FLAG_PURE_NOT)
189 struct _notmuch_database {
190 bool exception_reported;
192 /* Path to actual database */
193 const char *xapian_path;
195 /* Path to config loaded, if any */
196 const char *config_path;
199 /* true if changes have been made in this atomic section */
201 Xapian::Database *xapian_db;
202 Xapian::WritableDatabase *writable_xapian_db;
204 /* Bit mask of features used by this database. This is a
205 * bitwise-OR of NOTMUCH_FEATURE_* values (above). */
206 enum _notmuch_features features;
208 unsigned int last_doc_id;
210 /* 16 bytes (+ terminator) for hexadecimal representation of
211 * a 64-bit integer. */
212 char thread_id_str[17];
213 uint64_t last_thread_id;
215 /* error reporting; this value persists only until the
216 * next library call. May be NULL */
219 /* Highest committed revision number. Modifications are recorded
220 * under a higher revision number, which can be generated with
221 * notmuch_database_new_revision. */
222 unsigned long revision;
225 /* Keep track of the number of times the database has been re-opened
226 * (or other global invalidations of notmuch's caching)
229 Xapian::QueryParser *query_parser;
230 Xapian::TermGenerator *term_gen;
231 Xapian::RangeProcessor *value_range_processor;
232 Xapian::RangeProcessor *date_range_processor;
233 Xapian::RangeProcessor *last_mod_range_processor;
235 /* XXX it's slightly gross to use two parallel string->string maps
236 * here, but at least they are small */
237 notmuch_string_map_t *user_prefix;
238 notmuch_string_map_t *user_header;
240 /* Cached and possibly overridden configuration */
241 notmuch_string_map_t *config;
244 /* Prior to database version 3, features were implied by the database
245 * version number, so hard-code them for earlier versions. */
246 #define NOTMUCH_FEATURES_V0 ((enum _notmuch_features) 0)
247 #define NOTMUCH_FEATURES_V1 (NOTMUCH_FEATURES_V0 | NOTMUCH_FEATURE_FILE_TERMS | \
248 NOTMUCH_FEATURE_DIRECTORY_DOCS)
249 #define NOTMUCH_FEATURES_V2 (NOTMUCH_FEATURES_V1 | NOTMUCH_FEATURE_BOOL_FOLDER)
251 /* Current database features. If any of these are missing from a
252 * database, request an upgrade.
253 * NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES and
254 * NOTMUCH_FEATURE_INDEXED_MIMETYPES are not included because upgrade
255 * doesn't currently introduce the features (though brand new databases
257 #define NOTMUCH_FEATURES_CURRENT \
258 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_DIRECTORY_DOCS | \
259 NOTMUCH_FEATURE_BOOL_FOLDER | NOTMUCH_FEATURE_GHOSTS | \
260 NOTMUCH_FEATURE_LAST_MOD)
262 /* Return the list of terms from the given iterator matching a prefix.
263 * The prefix will be stripped from the strings in the returned list.
264 * The list will be allocated using ctx as the talloc context.
266 * The function returns NULL on failure.
268 notmuch_string_list_t *
269 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
270 Xapian::TermIterator &end,
274 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
275 const char *prefix_name,
277 Xapian::PostingIterator *begin,
278 Xapian::PostingIterator *end);
280 #define NOTMUCH_DATABASE_VERSION 3
285 _notmuch_database_parse_features (const void *ctx, const char *features, unsigned int version,
286 char mode, char **incompat_out);
289 _notmuch_database_print_features (const void *ctx, unsigned int features);
293 _notmuch_database_setup_standard_query_fields (notmuch_database_t *notmuch);
296 _notmuch_database_setup_user_query_fields (notmuch_database_t *notmuch);