]> git.cworth.org Git - notmuch/blob - lib/database-private.h
version: bump to 0.34~0
[notmuch] / lib / database-private.h
1 /* database-private.h - For peeking into the internals of notmuch_database_t
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
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/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_DATABASE_PRIVATE_H
22 #define NOTMUCH_DATABASE_PRIVATE_H
23
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,
28  * but there it is.
29  */
30 #define __STDC_FORMAT_MACROS
31 #include <inttypes.h>
32
33 #include "notmuch-private.h"
34
35 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
36
37 #ifdef SILENCE_XAPIAN_DEPRECATION_WARNINGS
38 #define XAPIAN_DEPRECATED(D) D
39 #endif
40
41 #include <xapian.h>
42
43 #if HAVE_SFSEXP
44 #include <sexp.h>
45 #endif
46
47 /* Bit masks for _notmuch_database::features.  Features are named,
48  * independent aspects of the database schema.
49  *
50  * A database stores the set of features that it "uses" (implicitly
51  * before database version 3 and explicitly as of version 3).
52  *
53  * A given library version will "recognize" a particular set of
54  * features; if a database uses a feature that the library does not
55  * recognize, the library will refuse to open it.  It is assumed the
56  * set of recognized features grows monotonically over time.  A
57  * library version will "implement" some subset of the recognized
58  * features: some operations may require that the database use (or not
59  * use) some feature, while other operations may support both
60  * databases that use and that don't use some feature.
61  *
62  * On disk, the database stores string names for these features (see
63  * the feature_names array).  These enum bit values are never
64  * persisted to disk and may change freely.
65  */
66 enum _notmuch_features {
67     /* If set, file names are stored in "file-direntry" terms.  If
68      * unset, file names are stored in document data.
69      *
70      * Introduced: version 1. */
71     NOTMUCH_FEATURE_FILE_TERMS                  = 1 << 0,
72
73     /* If set, directory timestamps are stored in documents with
74      * XDIRECTORY terms and relative paths.  If unset, directory
75      * timestamps are stored in documents with XTIMESTAMP terms and
76      * absolute paths.
77      *
78      * Introduced: version 1. */
79     NOTMUCH_FEATURE_DIRECTORY_DOCS              = 1 << 1,
80
81     /* If set, the from, subject, and message-id headers are stored in
82      * message document values.  If unset, message documents *may*
83      * have these values, but if the value is empty, it must be
84      * retrieved from the message file.
85      *
86      * Introduced: optional in version 1, required as of version 3.
87      */
88     NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES      = 1 << 2,
89
90     /* If set, folder terms are boolean and path terms exist.  If
91      * unset, folder terms are probabilistic and stemmed and path
92      * terms do not exist.
93      *
94      * Introduced: version 2. */
95     NOTMUCH_FEATURE_BOOL_FOLDER                 = 1 << 3,
96
97     /* If set, missing messages are stored in ghost mail documents.
98      * If unset, thread IDs of ghost messages are stored as database
99      * metadata instead of in ghost documents.
100      *
101      * Introduced: version 3. */
102     NOTMUCH_FEATURE_GHOSTS                      = 1 << 4,
103
104
105     /* If set, then the database was created after the introduction of
106      * indexed mime types. If unset, then the database may contain a
107      * mixture of messages with indexed and non-indexed mime types.
108      *
109      * Introduced: version 3. */
110     NOTMUCH_FEATURE_INDEXED_MIMETYPES           = 1 << 5,
111
112     /* If set, messages store the revision number of the last
113      * modification in NOTMUCH_VALUE_LAST_MOD.
114      *
115      * Introduced: version 3. */
116     NOTMUCH_FEATURE_LAST_MOD                    = 1 << 6,
117
118     /* If set, unprefixed terms are stored only for the message body,
119      * not for headers.
120      *
121      * Introduced: version 3. */
122     NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY          = 1 << 7,
123 };
124
125 /* In C++, a named enum is its own type, so define bitwise operators
126  * on _notmuch_features. */
127 inline _notmuch_features
128 operator| (_notmuch_features a, _notmuch_features b)
129 {
130     return static_cast<_notmuch_features>(
131         static_cast<unsigned>(a) | static_cast<unsigned>(b));
132 }
133
134 inline _notmuch_features
135 operator& (_notmuch_features a, _notmuch_features b)
136 {
137     return static_cast<_notmuch_features>(
138         static_cast<unsigned>(a) & static_cast<unsigned>(b));
139 }
140
141 inline _notmuch_features
142 operator~ (_notmuch_features a)
143 {
144     return static_cast<_notmuch_features>(~static_cast<unsigned>(a));
145 }
146
147 inline _notmuch_features&
148 operator|= (_notmuch_features &a, _notmuch_features b)
149 {
150     a = a | b;
151     return a;
152 }
153
154 inline _notmuch_features&
155 operator&= (_notmuch_features &a, _notmuch_features b)
156 {
157     a = a & b;
158     return a;
159 }
160
161 /*
162  * Configuration options for xapian database fields */
163 typedef enum notmuch_field_flags {
164     NOTMUCH_FIELD_NO_FLAGS      = 0,
165     NOTMUCH_FIELD_EXTERNAL      = 1 << 0,
166     NOTMUCH_FIELD_PROBABILISTIC = 1 << 1,
167     NOTMUCH_FIELD_PROCESSOR     = 1 << 2,
168 } notmuch_field_flag_t;
169
170 /*
171  * define bitwise operators to hide casts */
172 inline notmuch_field_flag_t
173 operator| (notmuch_field_flag_t a, notmuch_field_flag_t b)
174 {
175     return static_cast<notmuch_field_flag_t>(
176         static_cast<unsigned>(a) | static_cast<unsigned>(b));
177 }
178
179 inline notmuch_field_flag_t
180 operator& (notmuch_field_flag_t a, notmuch_field_flag_t b)
181 {
182     return static_cast<notmuch_field_flag_t>(
183         static_cast<unsigned>(a) & static_cast<unsigned>(b));
184 }
185
186 #define NOTMUCH_QUERY_PARSER_FLAGS (Xapian::QueryParser::FLAG_BOOLEAN | \
187                                     Xapian::QueryParser::FLAG_PHRASE | \
188                                     Xapian::QueryParser::FLAG_LOVEHATE | \
189                                     Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE | \
190                                     Xapian::QueryParser::FLAG_WILDCARD | \
191                                     Xapian::QueryParser::FLAG_PURE_NOT)
192
193 struct _notmuch_database {
194     bool exception_reported;
195
196     /* Path to actual database */
197     const char *xapian_path;
198
199     /* Path to config loaded, if any */
200     const char *config_path;
201
202     int atomic_nesting;
203     /* true if changes have been made in this atomic section */
204     bool atomic_dirty;
205     Xapian::Database *xapian_db;
206     Xapian::WritableDatabase *writable_xapian_db;
207     bool open;
208     /* Bit mask of features used by this database.  This is a
209      * bitwise-OR of NOTMUCH_FEATURE_* values (above). */
210     enum _notmuch_features features;
211
212     unsigned int last_doc_id;
213
214     /* 16 bytes (+ terminator) for hexadecimal representation of
215      * a 64-bit integer. */
216     char thread_id_str[17];
217     uint64_t last_thread_id;
218
219     /* How many transactions have successfully completed since we last committed */
220     int transaction_count;
221     /* when to commit and reset the counter */
222     int transaction_threshold;
223
224     /* error reporting; this value persists only until the
225      * next library call. May be NULL */
226     char *status_string;
227
228     /* Highest committed revision number.  Modifications are recorded
229      * under a higher revision number, which can be generated with
230      * notmuch_database_new_revision. */
231     unsigned long revision;
232     const char *uuid;
233
234     /* Keep track of the number of times the database has been re-opened
235      * (or other global invalidations of notmuch's caching)
236      */
237     unsigned long view;
238     Xapian::QueryParser *query_parser;
239     Xapian::Stem *stemmer;
240     Xapian::TermGenerator *term_gen;
241     Xapian::RangeProcessor *value_range_processor;
242     Xapian::RangeProcessor *date_range_processor;
243     Xapian::RangeProcessor *last_mod_range_processor;
244
245     /* XXX it's slightly gross to use two parallel string->string maps
246      * here, but at least they are small */
247     notmuch_string_map_t *user_prefix;
248     notmuch_string_map_t *user_header;
249
250     /* Cached and possibly overridden configuration */
251     notmuch_string_map_t *config;
252 };
253
254 /* Prior to database version 3, features were implied by the database
255  * version number, so hard-code them for earlier versions. */
256 #define NOTMUCH_FEATURES_V0 ((enum _notmuch_features) 0)
257 #define NOTMUCH_FEATURES_V1 (NOTMUCH_FEATURES_V0 | NOTMUCH_FEATURE_FILE_TERMS | \
258                              NOTMUCH_FEATURE_DIRECTORY_DOCS)
259 #define NOTMUCH_FEATURES_V2 (NOTMUCH_FEATURES_V1 | NOTMUCH_FEATURE_BOOL_FOLDER)
260
261 /* Current database features.  If any of these are missing from a
262  * database, request an upgrade.
263  * NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES and
264  * NOTMUCH_FEATURE_INDEXED_MIMETYPES are not included because upgrade
265  * doesn't currently introduce the features (though brand new databases
266  * will have it). */
267 #define NOTMUCH_FEATURES_CURRENT \
268     (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_DIRECTORY_DOCS | \
269      NOTMUCH_FEATURE_BOOL_FOLDER | NOTMUCH_FEATURE_GHOSTS | \
270      NOTMUCH_FEATURE_LAST_MOD)
271
272 /* Return the list of terms from the given iterator matching a prefix.
273  * The prefix will be stripped from the strings in the returned list.
274  * The list will be allocated using ctx as the talloc context.
275  *
276  * The function returns NULL on failure.
277  */
278 notmuch_string_list_t *
279 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
280                                          Xapian::TermIterator &end,
281                                          const char *prefix);
282
283 void
284 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
285                                 const char *prefix_name,
286                                 const char *value,
287                                 Xapian::PostingIterator *begin,
288                                 Xapian::PostingIterator *end);
289
290 #define NOTMUCH_DATABASE_VERSION 3
291
292 /* features.cc */
293
294 _notmuch_features
295 _notmuch_database_parse_features (const void *ctx, const char *features, unsigned int version,
296                                   char mode, char **incompat_out);
297
298 char *
299 _notmuch_database_print_features (const void *ctx, unsigned int features);
300
301 /* prefix.cc */
302 notmuch_status_t
303 _notmuch_database_setup_standard_query_fields (notmuch_database_t *notmuch);
304
305 notmuch_status_t
306 _notmuch_database_setup_user_query_fields (notmuch_database_t *notmuch);
307
308 #if __cplusplus
309 /* query.cc */
310 notmuch_status_t
311 _notmuch_query_string_to_xapian_query (notmuch_database_t *notmuch,
312                                        std::string query_string,
313                                        Xapian::Query &output,
314                                        std::string &msg);
315 /* parse-sexp.cc */
316 notmuch_status_t
317 _notmuch_sexp_string_to_xapian_query (notmuch_database_t *notmuch, const char *querystr,
318                                       Xapian::Query &output);
319
320 notmuch_status_t
321 _notmuch_query_expand (notmuch_database_t *notmuch, const char *field, Xapian::Query subquery,
322                        Xapian::Query &output, std::string &msg);
323
324 /* regexp-fields.cc */
325 notmuch_status_t
326 _notmuch_regexp_to_query (notmuch_database_t *notmuch, Xapian::valueno slot, std::string field,
327                           std::string regexp_str,
328                           Xapian::Query &output, std::string &msg);
329
330 /* thread-fp.cc */
331 notmuch_status_t
332 _notmuch_query_name_to_query (notmuch_database_t *notmuch, const std::string name,
333                               Xapian::Query &output);
334
335 #if HAVE_SFSEXP
336 /* parse-sexp.cc */
337 notmuch_status_t
338 _notmuch_sexp_string_to_xapian_query (notmuch_database_t *notmuch, const char *querystr,
339                                       Xapian::Query &output);
340 #endif
341 #endif
342 #endif