3721431e02e005e697d7e3e15f11a48a6a2edc44
[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 https://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 <gmime/gmime.h>
50
51 #include "xutil.h"
52 #include "error_util.h"
53 #include "string-util.h"
54
55 #pragma GCC visibility push(hidden)
56
57 #ifdef DEBUG
58 # define DEBUG_DATABASE_SANITY 1
59 # define DEBUG_QUERY 1
60 #endif
61
62 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
63
64 #define STRNCMP_LITERAL(var, literal) \
65     strncmp ((var), (literal), sizeof (literal) - 1)
66
67 /* Robust bit test/set/reset macros */
68 #define _NOTMUCH_VALID_BIT(bit) \
69     ((bit) >= 0 && ((unsigned long) bit) < CHAR_BIT * sizeof (unsigned long long))
70 #define NOTMUCH_TEST_BIT(val, bit) \
71     (_NOTMUCH_VALID_BIT(bit) ? !!((val) & (1ull << (bit))) : 0)
72 #define NOTMUCH_SET_BIT(valp, bit) \
73     (_NOTMUCH_VALID_BIT(bit) ? (*(valp) |= (1ull << (bit))) : *(valp))
74 #define NOTMUCH_CLEAR_BIT(valp,  bit) \
75     (_NOTMUCH_VALID_BIT(bit) ? (*(valp) &= ~(1ull << (bit))) : *(valp))
76
77 #define unused(x) x __attribute__ ((unused))
78
79 #ifdef __cplusplus
80 # define visible __attribute__((visibility("default")))
81 #else
82 # define visible
83 #endif
84
85 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
86  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
87  */
88 /* these macros gain us a few percent of speed on gcc */
89 #if (__GNUC__ >= 3)
90 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
91    as its first argument */
92 #ifndef likely
93 #define likely(x)   __builtin_expect(!!(x), 1)
94 #endif
95 #ifndef unlikely
96 #define unlikely(x) __builtin_expect(!!(x), 0)
97 #endif
98 #else
99 #ifndef likely
100 #define likely(x) (x)
101 #endif
102 #ifndef unlikely
103 #define unlikely(x) (x)
104 #endif
105 #endif
106
107 typedef enum {
108     NOTMUCH_VALUE_TIMESTAMP = 0,
109     NOTMUCH_VALUE_MESSAGE_ID,
110     NOTMUCH_VALUE_FROM,
111     NOTMUCH_VALUE_SUBJECT,
112     NOTMUCH_VALUE_LAST_MOD,
113 } notmuch_value_t;
114
115 /* Xapian (with flint backend) complains if we provide a term longer
116  * than this, but I haven't yet found a way to query the limit
117  * programmatically. */
118 #define NOTMUCH_TERM_MAX 245
119
120 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
121
122 /* For message IDs we have to be even more restrictive. Beyond fitting
123  * into the term limit, we also use message IDs to construct
124  * metadata-key values. And the documentation says that these should
125  * be restricted to about 200 characters. (The actual limit for the
126  * chert backend at least is 252.)
127  */
128 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
129
130 typedef enum _notmuch_private_status {
131     /* First, copy all the public status values. */
132     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
133     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
134     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
135     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
136     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
137     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
138     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
139     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
140
141     /* Then add our own private values. */
142     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
143     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
144
145     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
146 } notmuch_private_status_t;
147
148 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
149  * value, generating an internal error if the private value is equal
150  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
151  * that the caller has previously handled any expected
152  * notmuch_private_status_t values.)
153  *
154  * Note that the function _internal_error does not return. Evaluating
155  * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
156  */
157 #define COERCE_STATUS(private_status, format, ...)                      \
158     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
159      ?                                                                  \
160      _internal_error (format " (%s).\n",                                \
161                       ##__VA_ARGS__,                                    \
162                       __location__),                                    \
163      (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS                  \
164      :                                                                  \
165      (notmuch_status_t) private_status)
166
167 /* Flags shared by various lookup functions. */
168 typedef enum _notmuch_find_flags {
169     /* Lookup without creating any documents.  This is the default
170      * behavior. */
171     NOTMUCH_FIND_LOOKUP = 0,
172     /* If set, create the necessary document (or documents) if they
173      * are missing.  Requires a read/write database. */
174     NOTMUCH_FIND_CREATE = 1<<0,
175 } notmuch_find_flags_t;
176
177 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
178
179 /* database.cc */
180
181 /* Lookup a prefix value by name.
182  *
183  * XXX: This should really be static inside of message.cc, and we can
184  * do that once we convert database.cc to use the
185  * _notmuch_message_add/remove_term functions. */
186 const char *
187 _find_prefix (const char *name);
188
189 char *
190 _notmuch_message_id_compressed (void *ctx, const char *message_id);
191
192 notmuch_status_t
193 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
194
195 void
196 _notmuch_database_log (notmuch_database_t *notmuch,
197                        const char *format, ...);
198
199 unsigned long
200 _notmuch_database_new_revision (notmuch_database_t *notmuch);
201
202 const char *
203 _notmuch_database_relative_path (notmuch_database_t *notmuch,
204                                  const char *path);
205
206 notmuch_status_t
207 _notmuch_database_split_path (void *ctx,
208                               const char *path,
209                               const char **directory,
210                               const char **basename);
211
212 const char *
213 _notmuch_database_get_directory_db_path (const char *path);
214
215 unsigned int
216 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
217
218 notmuch_private_status_t
219 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
220                                       const char *prefix_name,
221                                       const char *value,
222                                       unsigned int *doc_id);
223
224 notmuch_status_t
225 _notmuch_database_find_directory_id (notmuch_database_t *database,
226                                      const char *path,
227                                      notmuch_find_flags_t flags,
228                                      unsigned int *directory_id);
229
230 const char *
231 _notmuch_database_get_directory_path (void *ctx,
232                                       notmuch_database_t *notmuch,
233                                       unsigned int doc_id);
234
235 notmuch_status_t
236 _notmuch_database_filename_to_direntry (void *ctx,
237                                         notmuch_database_t *notmuch,
238                                         const char *filename,
239                                         notmuch_find_flags_t flags,
240                                         char **direntry);
241
242 /* directory.cc */
243
244 notmuch_directory_t *
245 _notmuch_directory_create (notmuch_database_t *notmuch,
246                            const char *path,
247                            notmuch_find_flags_t flags,
248                            notmuch_status_t *status_ret);
249
250 unsigned int
251 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
252
253 /* message.cc */
254
255 notmuch_message_t *
256 _notmuch_message_create (const void *talloc_owner,
257                          notmuch_database_t *notmuch,
258                          unsigned int doc_id,
259                          notmuch_private_status_t *status);
260
261 notmuch_message_t *
262 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
263                                         const char *message_id,
264                                         notmuch_private_status_t *status);
265
266 unsigned int
267 _notmuch_message_get_doc_id (notmuch_message_t *message);
268
269 const char *
270 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
271
272 notmuch_private_status_t
273 _notmuch_message_add_term (notmuch_message_t *message,
274                            const char *prefix_name,
275                            const char *value);
276
277 notmuch_private_status_t
278 _notmuch_message_remove_term (notmuch_message_t *message,
279                               const char *prefix_name,
280                               const char *value);
281
282 notmuch_private_status_t
283 _notmuch_message_has_term (notmuch_message_t *message,
284                            const char *prefix_name,
285                            const char *value,
286                            notmuch_bool_t *result);
287
288 notmuch_private_status_t
289 _notmuch_message_gen_terms (notmuch_message_t *message,
290                             const char *prefix_name,
291                             const char *text);
292
293 void
294 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
295
296 void
297 _notmuch_message_upgrade_folder (notmuch_message_t *message);
298
299 notmuch_status_t
300 _notmuch_message_add_filename (notmuch_message_t *message,
301                                const char *filename);
302
303 notmuch_status_t
304 _notmuch_message_remove_filename (notmuch_message_t *message,
305                                   const char *filename);
306
307 notmuch_status_t
308 _notmuch_message_rename (notmuch_message_t *message,
309                          const char *new_filename);
310
311 void
312 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
313
314 void
315 _notmuch_message_set_header_values (notmuch_message_t *message,
316                                     const char *date,
317                                     const char *from,
318                                     const char *subject);
319
320 void
321 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
322
323 void
324 _notmuch_message_sync (notmuch_message_t *message);
325
326 notmuch_status_t
327 _notmuch_message_delete (notmuch_message_t *message);
328
329 notmuch_private_status_t
330 _notmuch_message_initialize_ghost (notmuch_message_t *message,
331                                    const char *thread_id);
332
333 void
334 _notmuch_message_close (notmuch_message_t *message);
335
336 /* Get a copy of the data in this message document.
337  *
338  * Caller should talloc_free the result when done.
339  *
340  * This function is intended to support database upgrade and really
341  * shouldn't be used otherwise. */
342 char *
343 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
344
345 /* Clear the data in this message document.
346  *
347  * This function is intended to support database upgrade and really
348  * shouldn't be used otherwise. */
349 void
350 _notmuch_message_clear_data (notmuch_message_t *message);
351
352 /* Set the author member of 'message' - this is the representation used
353  * when displaying the message */
354 void
355 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
356
357 /* Get the author member of 'message' */
358 const char *
359 _notmuch_message_get_author (notmuch_message_t *message);
360
361 /* message-file.c */
362
363 /* XXX: I haven't decided yet whether these will actually get exported
364  * into the public interface in notmuch.h
365  */
366
367 typedef struct _notmuch_message_file notmuch_message_file_t;
368
369 /* Open a file containing a single email message.
370  *
371  * The caller should call notmuch_message_close when done with this.
372  *
373  * Returns NULL if any error occurs.
374  */
375 notmuch_message_file_t *
376 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
377
378 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
379 notmuch_message_file_t *
380 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
381                                 void *ctx, const char *filename);
382
383 /* Close a notmuch message previously opened with notmuch_message_open. */
384 void
385 _notmuch_message_file_close (notmuch_message_file_t *message);
386
387 /* Parse the message.
388  *
389  * This will be done automatically as necessary on other calls
390  * depending on it, but an explicit call allows for better error
391  * status reporting.
392  */
393 notmuch_status_t
394 _notmuch_message_file_parse (notmuch_message_file_t *message);
395
396 /* Get the gmime message of a message file.
397  *
398  * The message file is parsed as necessary.
399  *
400  * The GMimeMessage* is set to *mime_message on success (which the
401  * caller must not unref).
402  *
403  * XXX: Would be nice to not have to expose GMimeMessage here.
404  */
405 notmuch_status_t
406 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
407                                         GMimeMessage **mime_message);
408
409 /* Get the value of the specified header from the message as a UTF-8 string.
410  *
411  * The message file is parsed as necessary.
412  *
413  * The header name is case insensitive.
414  *
415  * The Received: header is special - for it all Received: headers in
416  * the message are concatenated
417  *
418  * The returned value is owned by the notmuch message and is valid
419  * only until the message is closed. The caller should copy it if
420  * needing to modify the value or to hold onto it for longer.
421  *
422  * Returns NULL on errors, empty string if the message does not
423  * contain a header line matching 'header'.
424  */
425 const char *
426 _notmuch_message_file_get_header (notmuch_message_file_t *message,
427                                  const char *header);
428
429 /* index.cc */
430
431 notmuch_status_t
432 _notmuch_message_index_file (notmuch_message_t *message,
433                              notmuch_message_file_t *message_file);
434
435 /* messages.c */
436
437 typedef struct _notmuch_message_node {
438     notmuch_message_t *message;
439     struct _notmuch_message_node *next;
440 } notmuch_message_node_t;
441
442 typedef struct _notmuch_message_list {
443     notmuch_message_node_t *head;
444     notmuch_message_node_t **tail;
445 } notmuch_message_list_t;
446
447 /* There's a rumor that there's an alternate struct _notmuch_messages
448  * somewhere with some nasty C++ objects in it. We'll try to maintain
449  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
450  */
451 struct visible _notmuch_messages {
452     notmuch_bool_t is_of_list_type;
453     notmuch_doc_id_set_t *excluded_doc_ids;
454     notmuch_message_node_t *iterator;
455 };
456
457 notmuch_message_list_t *
458 _notmuch_message_list_create (const void *ctx);
459
460 void
461 _notmuch_message_list_add_message (notmuch_message_list_t *list,
462                                    notmuch_message_t *message);
463
464 notmuch_messages_t *
465 _notmuch_messages_create (notmuch_message_list_t *list);
466
467 /* query.cc */
468
469 notmuch_bool_t
470 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
471
472 notmuch_message_t *
473 _notmuch_mset_messages_get (notmuch_messages_t *messages);
474
475 void
476 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
477
478 notmuch_bool_t
479 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
480                               unsigned int doc_id);
481
482 void
483 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
484                             unsigned int doc_id);
485
486 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
487 notmuch_status_t
488 _notmuch_query_search_documents (notmuch_query_t *query,
489                                  const char *type,
490                                  notmuch_messages_t **out);
491
492 notmuch_status_t
493 _notmuch_query_count_documents (notmuch_query_t *query,
494                                 const char *type,
495                                 unsigned *count_out);
496
497 /* message.cc */
498
499 void
500 _notmuch_message_add_reply (notmuch_message_t *message,
501                             notmuch_message_t *reply);
502 notmuch_database_t *
503 _notmuch_message_database (notmuch_message_t *message);
504
505 /* sha1.c */
506
507 char *
508 _notmuch_sha1_of_string (const char *str);
509
510 char *
511 _notmuch_sha1_of_file (const char *filename);
512
513 /* string-list.c */
514
515 typedef struct _notmuch_string_node {
516     char *string;
517     struct _notmuch_string_node *next;
518 } notmuch_string_node_t;
519
520 typedef struct visible _notmuch_string_list {
521     int length;
522     notmuch_string_node_t *head;
523     notmuch_string_node_t **tail;
524 } notmuch_string_list_t;
525
526 notmuch_string_list_t *
527 _notmuch_string_list_create (const void *ctx);
528
529 /* Add 'string' to 'list'.
530  *
531  * The list will create its own talloced copy of 'string'.
532  */
533 void
534 _notmuch_string_list_append (notmuch_string_list_t *list,
535                              const char *string);
536
537 void
538 _notmuch_string_list_sort (notmuch_string_list_t *list);
539
540 /* tags.c */
541
542 notmuch_tags_t *
543 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
544
545 /* filenames.c */
546
547 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
548  * file names */
549 notmuch_filenames_t *
550 _notmuch_filenames_create (const void *ctx,
551                            notmuch_string_list_t *list);
552
553 /* thread.cc */
554
555 notmuch_thread_t *
556 _notmuch_thread_create (void *ctx,
557                         notmuch_database_t *notmuch,
558                         unsigned int seed_doc_id,
559                         notmuch_doc_id_set_t *match_set,
560                         notmuch_string_list_t *excluded_terms,
561                         notmuch_exclude_t omit_exclude,
562                         notmuch_sort_t sort);
563
564 NOTMUCH_END_DECLS
565
566 #ifdef __cplusplus
567 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
568  * C++. In talloc_steal, an explicit cast is provided for type safety
569  * in some GCC versions. Otherwise, a cast is required. Provide a
570  * template function for this to maintain type safety, and redefine
571  * talloc_steal to use it.
572  */
573 #if !(__GNUC__ >= 3)
574 template <class T> T *
575 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
576 {
577     return static_cast<T *> (talloc_steal (new_ctx, ptr));
578 }
579 #undef talloc_steal
580 #define talloc_steal _notmuch_talloc_steal
581 #endif
582 #endif
583
584 #pragma GCC visibility pop
585
586 #endif