lib: Rearrange the exclude code in query.cc
[notmuch] / lib / notmuch-private.h
1 /* notmuch-private.h - Internal interfaces for notmuch.
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 http://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_PRIVATE_H
22 #define NOTMUCH_PRIVATE_H
23
24 #ifndef _GNU_SOURCE
25 #define _GNU_SOURCE /* For getline and asprintf */
26 #endif
27 #include <stdio.h>
28
29 #include "compat.h"
30
31 #include "notmuch.h"
32
33 NOTMUCH_BEGIN_DECLS
34
35 #include <stdlib.h>
36 #include <stdarg.h>
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #include <sys/mman.h>
40 #include <string.h>
41 #include <errno.h>
42 #include <fcntl.h>
43 #include <unistd.h>
44 #include <ctype.h>
45 #include <assert.h>
46
47 #include <talloc.h>
48
49 #include "xutil.h"
50 #include "error_util.h"
51
52 #pragma GCC visibility push(hidden)
53
54 #ifdef DEBUG
55 # define DEBUG_DATABASE_SANITY 1
56 # define DEBUG_QUERY 1
57 #endif
58
59 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
60
61 #define STRNCMP_LITERAL(var, literal) \
62     strncmp ((var), (literal), sizeof (literal) - 1)
63
64 #define unused(x) x __attribute__ ((unused))
65
66 #ifdef __cplusplus
67 # define visible __attribute__((visibility("default")))
68 #else
69 # define visible
70 #endif
71
72 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
73  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
74  */
75 /* these macros gain us a few percent of speed on gcc */
76 #if (__GNUC__ >= 3)
77 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
78    as its first argument */
79 #ifndef likely
80 #define likely(x)   __builtin_expect(!!(x), 1)
81 #endif
82 #ifndef unlikely
83 #define unlikely(x) __builtin_expect(!!(x), 0)
84 #endif
85 #else
86 #ifndef likely
87 #define likely(x) (x)
88 #endif
89 #ifndef unlikely
90 #define unlikely(x) (x)
91 #endif
92 #endif
93
94 typedef enum {
95     NOTMUCH_VALUE_TIMESTAMP = 0,
96     NOTMUCH_VALUE_MESSAGE_ID,
97     NOTMUCH_VALUE_FROM,
98     NOTMUCH_VALUE_SUBJECT
99 } notmuch_value_t;
100
101 /* Xapian (with flint backend) complains if we provide a term longer
102  * than this, but I haven't yet found a way to query the limit
103  * programmatically. */
104 #define NOTMUCH_TERM_MAX 245
105
106 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
107
108 /* For message IDs we have to be even more restrictive. Beyond fitting
109  * into the term limit, we also use message IDs to construct
110  * metadata-key values. And the documentation says that these should
111  * be restricted to about 200 characters. (The actual limit for the
112  * chert backend at least is 252.)
113  */
114 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
115
116 typedef enum _notmuch_private_status {
117     /* First, copy all the public status values. */
118     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
119     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
120     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
121     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
122     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
123     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
124     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
125     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
126
127     /* Then add our own private values. */
128     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
129     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
130
131     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
132 } notmuch_private_status_t;
133
134 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
135  * value, generating an internal error if the private value is equal
136  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
137  * that the caller has previously handled any expected
138  * notmuch_private_status_t values.)
139  */
140 #define COERCE_STATUS(private_status, format, ...)                      \
141     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
142      ?                                                                  \
143      (notmuch_status_t) _internal_error (format " (%s).\n",             \
144                                          ##__VA_ARGS__,                 \
145                                          __location__)                  \
146      :                                                                  \
147      (notmuch_status_t) private_status)
148
149 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
150
151 /* database.cc */
152
153 /* Lookup a prefix value by name.
154  *
155  * XXX: This should really be static inside of message.cc, and we can
156  * do that once we convert database.cc to use the
157  * _notmuch_message_add/remove_term functions. */
158 const char *
159 _find_prefix (const char *name);
160
161 notmuch_status_t
162 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
163
164 const char *
165 _notmuch_database_relative_path (notmuch_database_t *notmuch,
166                                  const char *path);
167
168 notmuch_status_t
169 _notmuch_database_split_path (void *ctx,
170                               const char *path,
171                               const char **directory,
172                               const char **basename);
173
174 const char *
175 _notmuch_database_get_directory_db_path (const char *path);
176
177 unsigned int
178 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
179
180 notmuch_private_status_t
181 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
182                                       const char *prefix_name,
183                                       const char *value,
184                                       unsigned int *doc_id);
185
186 notmuch_status_t
187 _notmuch_database_find_directory_id (notmuch_database_t *database,
188                                      const char *path,
189                                      unsigned int *directory_id);
190
191 const char *
192 _notmuch_database_get_directory_path (void *ctx,
193                                       notmuch_database_t *notmuch,
194                                       unsigned int doc_id);
195
196 notmuch_status_t
197 _notmuch_database_filename_to_direntry (void *ctx,
198                                         notmuch_database_t *notmuch,
199                                         const char *filename,
200                                         char **direntry);
201
202 /* directory.cc */
203
204 notmuch_directory_t *
205 _notmuch_directory_create (notmuch_database_t *notmuch,
206                            const char *path,
207                            notmuch_status_t *status_ret);
208
209 unsigned int
210 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
211
212 /* thread.cc */
213
214 notmuch_thread_t *
215 _notmuch_thread_create (void *ctx,
216                         notmuch_database_t *notmuch,
217                         unsigned int seed_doc_id,
218                         notmuch_doc_id_set_t *match_set,
219                         notmuch_sort_t sort);
220
221 /* message.cc */
222
223 notmuch_message_t *
224 _notmuch_message_create (const void *talloc_owner,
225                          notmuch_database_t *notmuch,
226                          unsigned int doc_id,
227                          notmuch_private_status_t *status);
228
229 notmuch_message_t *
230 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
231                                         const char *message_id,
232                                         notmuch_private_status_t *status);
233
234 unsigned int
235 _notmuch_message_get_doc_id (notmuch_message_t *message);
236
237 const char *
238 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
239
240 notmuch_private_status_t
241 _notmuch_message_add_term (notmuch_message_t *message,
242                            const char *prefix_name,
243                            const char *value);
244
245 notmuch_private_status_t
246 _notmuch_message_remove_term (notmuch_message_t *message,
247                               const char *prefix_name,
248                               const char *value);
249
250 notmuch_private_status_t
251 _notmuch_message_gen_terms (notmuch_message_t *message,
252                             const char *prefix_name,
253                             const char *text);
254
255 void
256 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
257
258 notmuch_status_t
259 _notmuch_message_add_filename (notmuch_message_t *message,
260                                const char *filename);
261
262 notmuch_status_t
263 _notmuch_message_remove_filename (notmuch_message_t *message,
264                                   const char *filename);
265
266 notmuch_status_t
267 _notmuch_message_rename (notmuch_message_t *message,
268                          const char *new_filename);
269
270 void
271 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
272
273 void
274 _notmuch_message_set_header_values (notmuch_message_t *message,
275                                     const char *date,
276                                     const char *from,
277                                     const char *subject);
278 void
279 _notmuch_message_sync (notmuch_message_t *message);
280
281 notmuch_status_t
282 _notmuch_message_delete (notmuch_message_t *message);
283
284 void
285 _notmuch_message_close (notmuch_message_t *message);
286
287 /* Get a copy of the data in this message document.
288  *
289  * Caller should talloc_free the result when done.
290  *
291  * This function is intended to support database upgrade and really
292  * shouldn't be used otherwise. */
293 char *
294 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
295
296 /* Clear the data in this message document.
297  *
298  * This function is intended to support database upgrade and really
299  * shouldn't be used otherwise. */
300 void
301 _notmuch_message_clear_data (notmuch_message_t *message);
302
303 /* Set the author member of 'message' - this is the representation used
304  * when displaying the message */
305 void
306 notmuch_message_set_author (notmuch_message_t *message, const char *author);
307
308 /* Get the author member of 'message' */
309 const char *
310 notmuch_message_get_author (notmuch_message_t *message);
311
312
313 /* index.cc */
314
315 notmuch_status_t
316 _notmuch_message_index_file (notmuch_message_t *message,
317                              const char *filename);
318
319 /* message-file.c */
320
321 /* XXX: I haven't decided yet whether these will actually get exported
322  * into the public interface in notmuch.h
323  */
324
325 typedef struct _notmuch_message_file notmuch_message_file_t;
326
327 /* Open a file containing a single email message.
328  *
329  * The caller should call notmuch_message_close when done with this.
330  *
331  * Returns NULL if any error occurs.
332  */
333 notmuch_message_file_t *
334 notmuch_message_file_open (const char *filename);
335
336 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
337 notmuch_message_file_t *
338 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
339
340 /* Close a notmuch message previously opened with notmuch_message_open. */
341 void
342 notmuch_message_file_close (notmuch_message_file_t *message);
343
344 /* Restrict 'message' to only save the named headers.
345  *
346  * When the caller is only interested in a short list of headers,
347  * known in advance, calling this function can avoid wasted time and
348  * memory parsing/saving header values that will never be needed.
349  *
350  * The variable arguments should be a list of const char * with a
351  * final '(const char *) NULL' to terminate the list.
352  *
353  * If this function is called, it must be called before any calls to
354  * notmuch_message_get_header for this message.
355  *
356  * After calling this function, if notmuch_message_get_header is
357  * called with a header name not in this list, then NULL will be
358  * returned even if that header exists in the actual message.
359  */
360 void
361 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
362
363 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
364 void
365 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
366                                         va_list va_headers);
367
368 /* Get the value of the specified header from the message.
369  *
370  * The header name is case insensitive.
371  *
372  * The Received: header is special - for it all Received: headers in
373  * the message are concatenated
374  *
375  * The returned value is owned by the notmuch message and is valid
376  * only until the message is closed. The caller should copy it if
377  * needing to modify the value or to hold onto it for longer.
378  *
379  * Returns NULL if the message does not contain a header line matching
380  * 'header'.
381  */
382 const char *
383 notmuch_message_file_get_header (notmuch_message_file_t *message,
384                                  const char *header);
385
386 /* messages.c */
387
388 typedef struct _notmuch_message_node {
389     notmuch_message_t *message;
390     struct _notmuch_message_node *next;
391 } notmuch_message_node_t;
392
393 typedef struct _notmuch_message_list {
394     notmuch_message_node_t *head;
395     notmuch_message_node_t **tail;
396 } notmuch_message_list_t;
397
398 /* There's a rumor that there's an alternate struct _notmuch_messages
399  * somewhere with some nasty C++ objects in it. We'll try to maintain
400  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
401  */
402 struct visible _notmuch_messages {
403     notmuch_bool_t is_of_list_type;
404     notmuch_message_node_t *iterator;
405 };
406
407 notmuch_message_list_t *
408 _notmuch_message_list_create (const void *ctx);
409
410 void
411 _notmuch_message_list_append (notmuch_message_list_t *list,
412                               notmuch_message_node_t *node);
413
414 void
415 _notmuch_message_list_add_message (notmuch_message_list_t *list,
416                                    notmuch_message_t *message);
417
418 notmuch_messages_t *
419 _notmuch_messages_create (notmuch_message_list_t *list);
420
421 /* query.cc */
422
423 notmuch_bool_t
424 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
425
426 notmuch_message_t *
427 _notmuch_mset_messages_get (notmuch_messages_t *messages);
428
429 void
430 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
431
432 notmuch_bool_t
433 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
434                               unsigned int doc_id);
435
436 void
437 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
438                             unsigned int doc_id);
439
440 /* message.cc */
441
442 void
443 _notmuch_message_add_reply (notmuch_message_t *message,
444                             notmuch_message_node_t *reply);
445
446 /* sha1.c */
447
448 char *
449 notmuch_sha1_of_string (const char *str);
450
451 char *
452 notmuch_sha1_of_file (const char *filename);
453
454 /* string-list.c */
455
456 typedef struct _notmuch_string_node {
457     char *string;
458     struct _notmuch_string_node *next;
459 } notmuch_string_node_t;
460
461 typedef struct visible _notmuch_string_list {
462     int length;
463     notmuch_string_node_t *head;
464     notmuch_string_node_t **tail;
465 } notmuch_string_list_t;
466
467 notmuch_string_list_t *
468 _notmuch_string_list_create (const void *ctx);
469
470 /* Add 'string' to 'list'.
471  *
472  * The list will create its own talloced copy of 'string'.
473  */
474 void
475 _notmuch_string_list_append (notmuch_string_list_t *list,
476                              const char *string);
477
478 void
479 _notmuch_string_list_sort (notmuch_string_list_t *list);
480
481 /* tags.c */
482
483 notmuch_tags_t *
484 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
485
486 /* filenames.c */
487
488 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
489  * file names */
490 notmuch_filenames_t *
491 _notmuch_filenames_create (const void *ctx,
492                            notmuch_string_list_t *list);
493
494 #pragma GCC visibility pop
495
496 NOTMUCH_END_DECLS
497
498 #endif