]> git.notmuchmail.org Git - notmuch/blob - lib/notmuch-private.h
e86f45825fa303e715318460299b545877176937
[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 <stdbool.h>
28 #include <stdio.h>
29
30 #include "compat.h"
31
32 #include "notmuch.h"
33
34 NOTMUCH_BEGIN_DECLS
35
36 #include <stdlib.h>
37 #include <stdarg.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <sys/mman.h>
41 #include <string.h>
42 #include <errno.h>
43 #include <fcntl.h>
44 #include <unistd.h>
45 #include <ctype.h>
46 #include <assert.h>
47
48 #include <talloc.h>
49
50 #include "gmime-extra.h"
51
52 #include "xutil.h"
53 #include "error_util.h"
54 #include "string-util.h"
55
56 #ifdef DEBUG
57 # define DEBUG_DATABASE_SANITY 1
58 # define DEBUG_QUERY 1
59 #endif
60
61 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
62
63 #define STRNCMP_LITERAL(var, literal) \
64     strncmp ((var), (literal), sizeof (literal) - 1)
65
66 /* Robust bit test/set/reset macros */
67 #define _NOTMUCH_VALID_BIT(bit) \
68     ((bit) >= 0 && ((unsigned long) bit) < CHAR_BIT * sizeof (unsigned long long))
69 #define NOTMUCH_TEST_BIT(val, bit) \
70     (_NOTMUCH_VALID_BIT(bit) ? !!((val) & (1ull << (bit))) : 0)
71 #define NOTMUCH_SET_BIT(valp, bit) \
72     (_NOTMUCH_VALID_BIT(bit) ? (*(valp) |= (1ull << (bit))) : *(valp))
73 #define NOTMUCH_CLEAR_BIT(valp,  bit) \
74     (_NOTMUCH_VALID_BIT(bit) ? (*(valp) &= ~(1ull << (bit))) : *(valp))
75
76 #define unused(x) x __attribute__ ((unused))
77
78 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
79  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
80  */
81 /* these macros gain us a few percent of speed on gcc */
82 #if (__GNUC__ >= 3)
83 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
84    as its first argument */
85 #ifndef likely
86 #define likely(x)   __builtin_expect(!!(x), 1)
87 #endif
88 #ifndef unlikely
89 #define unlikely(x) __builtin_expect(!!(x), 0)
90 #endif
91 #else
92 #ifndef likely
93 #define likely(x) (x)
94 #endif
95 #ifndef unlikely
96 #define unlikely(x) (x)
97 #endif
98 #endif
99
100 typedef enum {
101     NOTMUCH_VALUE_TIMESTAMP = 0,
102     NOTMUCH_VALUE_MESSAGE_ID,
103     NOTMUCH_VALUE_FROM,
104     NOTMUCH_VALUE_SUBJECT,
105     NOTMUCH_VALUE_LAST_MOD,
106 } notmuch_value_t;
107
108 /* Xapian (with flint backend) complains if we provide a term longer
109  * than this, but I haven't yet found a way to query the limit
110  * programmatically. */
111 #define NOTMUCH_TERM_MAX 245
112
113 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
114
115 /* For message IDs we have to be even more restrictive. Beyond fitting
116  * into the term limit, we also use message IDs to construct
117  * metadata-key values. And the documentation says that these should
118  * be restricted to about 200 characters. (The actual limit for the
119  * chert backend at least is 252.)
120  */
121 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
122
123 typedef enum _notmuch_private_status {
124     /* First, copy all the public status values. */
125     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
126     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
127     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
128     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
129     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
130     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
131     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
132     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
133
134     /* Then add our own private values. */
135     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
136     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
137
138     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
139 } notmuch_private_status_t;
140
141 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
142  * value, generating an internal error if the private value is equal
143  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
144  * that the caller has previously handled any expected
145  * notmuch_private_status_t values.)
146  *
147  * Note that the function _internal_error does not return. Evaluating
148  * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
149  */
150 #define COERCE_STATUS(private_status, format, ...)                      \
151     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
152      ?                                                                  \
153      _internal_error (format " (%s).\n",                                \
154                       ##__VA_ARGS__,                                    \
155                       __location__),                                    \
156      (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS                  \
157      :                                                                  \
158      (notmuch_status_t) private_status)
159
160 /* Flags shared by various lookup functions. */
161 typedef enum _notmuch_find_flags {
162     /* Lookup without creating any documents.  This is the default
163      * behavior. */
164     NOTMUCH_FIND_LOOKUP = 0,
165     /* If set, create the necessary document (or documents) if they
166      * are missing.  Requires a read/write database. */
167     NOTMUCH_FIND_CREATE = 1<<0,
168 } notmuch_find_flags_t;
169
170 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
171
172 /* database.cc */
173
174 /* Lookup a prefix value by name.
175  *
176  * XXX: This should really be static inside of message.cc, and we can
177  * do that once we convert database.cc to use the
178  * _notmuch_message_add/remove_term functions. */
179 const char *
180 _find_prefix (const char *name);
181
182 char *
183 _notmuch_message_id_compressed (void *ctx, const char *message_id);
184
185 notmuch_status_t
186 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
187
188 notmuch_status_t
189 _notmuch_database_reopen (notmuch_database_t *notmuch);
190
191 void
192 _notmuch_database_log (notmuch_database_t *notmuch,
193                        const char *format, ...);
194
195 void
196 _notmuch_database_log_append (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                            bool *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 notmuch_status_t
430 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
431                                    const char **from_out,
432                                    const char **subject_out,
433                                    const char **to_out,
434                                    const char **date_out,
435                                    char **message_id_out);
436
437 const char *
438 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
439
440 /* add-message.cc */
441 notmuch_status_t
442 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
443                                            notmuch_message_t *message,
444                                            notmuch_message_file_t *message_file,
445                                            const char **thread_id);
446 /* index.cc */
447
448 notmuch_status_t
449 _notmuch_message_index_file (notmuch_message_t *message,
450                              notmuch_message_file_t *message_file);
451
452 /* messages.c */
453
454 typedef struct _notmuch_message_node {
455     notmuch_message_t *message;
456     struct _notmuch_message_node *next;
457 } notmuch_message_node_t;
458
459 typedef struct _notmuch_message_list {
460     notmuch_message_node_t *head;
461     notmuch_message_node_t **tail;
462 } notmuch_message_list_t;
463
464 /* There's a rumor that there's an alternate struct _notmuch_messages
465  * somewhere with some nasty C++ objects in it. We'll try to maintain
466  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
467  */
468 struct _notmuch_messages {
469     bool is_of_list_type;
470     notmuch_doc_id_set_t *excluded_doc_ids;
471     notmuch_message_node_t *iterator;
472 };
473
474 notmuch_message_list_t *
475 _notmuch_message_list_create (const void *ctx);
476
477 void
478 _notmuch_message_list_add_message (notmuch_message_list_t *list,
479                                    notmuch_message_t *message);
480
481 notmuch_messages_t *
482 _notmuch_messages_create (notmuch_message_list_t *list);
483
484 /* query.cc */
485
486 bool
487 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
488
489 notmuch_message_t *
490 _notmuch_mset_messages_get (notmuch_messages_t *messages);
491
492 void
493 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
494
495 bool
496 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
497                               unsigned int doc_id);
498
499 void
500 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
501                             unsigned int doc_id);
502
503 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
504 notmuch_status_t
505 _notmuch_query_search_documents (notmuch_query_t *query,
506                                  const char *type,
507                                  notmuch_messages_t **out);
508
509 notmuch_status_t
510 _notmuch_query_count_documents (notmuch_query_t *query,
511                                 const char *type,
512                                 unsigned *count_out);
513 /* message-id.c */
514
515 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
516  * comments, and the '<' and '>' delimiters.
517  *
518  * If not NULL, then *next will be made to point to the first character
519  * not parsed, (possibly pointing to the final '\0' terminator.
520  *
521  * Returns a newly talloc'ed string belonging to 'ctx'.
522  *
523  * Returns NULL if there is any error parsing the message-id. */
524 char *
525 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
526
527
528 /* message.cc */
529
530 void
531 _notmuch_message_add_reply (notmuch_message_t *message,
532                             notmuch_message_t *reply);
533 notmuch_database_t *
534 _notmuch_message_database (notmuch_message_t *message);
535
536 void
537 _notmuch_message_remove_unprefixed_terms (notmuch_message_t *message);
538 /* sha1.c */
539
540 char *
541 _notmuch_sha1_of_string (const char *str);
542
543 char *
544 _notmuch_sha1_of_file (const char *filename);
545
546 /* string-list.c */
547
548 typedef struct _notmuch_string_node {
549     char *string;
550     struct _notmuch_string_node *next;
551 } notmuch_string_node_t;
552
553 typedef struct _notmuch_string_list {
554     int length;
555     notmuch_string_node_t *head;
556     notmuch_string_node_t **tail;
557 } notmuch_string_list_t;
558
559 notmuch_string_list_t *
560 _notmuch_string_list_create (const void *ctx);
561
562 /*
563  * return the number of strings in 'list'
564  */
565 int
566 _notmuch_string_list_length (notmuch_string_list_t *list);
567
568 /* Add 'string' to 'list'.
569  *
570  * The list will create its own talloced copy of 'string'.
571  */
572 void
573 _notmuch_string_list_append (notmuch_string_list_t *list,
574                              const char *string);
575
576 void
577 _notmuch_string_list_sort (notmuch_string_list_t *list);
578
579 /* string-map.c */
580 typedef struct _notmuch_string_map  notmuch_string_map_t;
581 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
582 notmuch_string_map_t *
583 _notmuch_string_map_create (const void *ctx);
584
585 void
586 _notmuch_string_map_append (notmuch_string_map_t *map,
587                             const char *key,
588                             const char *value);
589
590 const char *
591 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
592
593 notmuch_string_map_iterator_t *
594 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
595                                      bool exact);
596
597 bool
598 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
599
600 void
601 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
602
603 const char *
604 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
605
606 const char *
607 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
608
609 void
610 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
611
612 /* tags.c */
613
614 notmuch_tags_t *
615 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
616
617 /* filenames.c */
618
619 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
620  * file names */
621 notmuch_filenames_t *
622 _notmuch_filenames_create (const void *ctx,
623                            notmuch_string_list_t *list);
624
625 /* thread.cc */
626
627 notmuch_thread_t *
628 _notmuch_thread_create (void *ctx,
629                         notmuch_database_t *notmuch,
630                         unsigned int seed_doc_id,
631                         notmuch_doc_id_set_t *match_set,
632                         notmuch_string_list_t *excluded_terms,
633                         notmuch_exclude_t omit_exclude,
634                         notmuch_sort_t sort);
635
636 NOTMUCH_END_DECLS
637
638 #ifdef __cplusplus
639 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
640  * C++. In talloc_steal, an explicit cast is provided for type safety
641  * in some GCC versions. Otherwise, a cast is required. Provide a
642  * template function for this to maintain type safety, and redefine
643  * talloc_steal to use it.
644  */
645 #if !(__GNUC__ >= 3)
646 template <class T> T *
647 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
648 {
649     return static_cast<T *> (talloc_steal (new_ctx, ptr));
650 }
651 #undef talloc_steal
652 #define talloc_steal _notmuch_talloc_steal
653 #endif
654 #endif
655
656 #endif