1 /* notmuch-private.h - Internal interfaces for notmuch.
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_PRIVATE_H
22 #define NOTMUCH_PRIVATE_H
25 #define _GNU_SOURCE /* For getline and asprintf */
38 #include <sys/types.h>
50 #include "gmime-extra.h"
53 #include "error_util.h"
54 #include "string-util.h"
59 # define DEBUG_DATABASE_SANITY 1
60 # define DEBUG_THREADING 1
61 # define DEBUG_QUERY 1
64 #define COMPILE_TIME_ASSERT(pred) ((void) sizeof (char[1 - 2 * ! (pred)]))
66 #define STRNCMP_LITERAL(var, literal) \
67 strncmp ((var), (literal), sizeof (literal) - 1)
69 /* Robust bit test/set/reset macros */
70 #define _NOTMUCH_VALID_BIT(bit) \
71 ((bit) >= 0 && ((unsigned long) bit) < CHAR_BIT * sizeof (unsigned long long))
72 #define NOTMUCH_TEST_BIT(val, bit) \
73 (_NOTMUCH_VALID_BIT (bit) ? ! ! ((val) & (1ull << (bit))) : 0)
74 #define NOTMUCH_SET_BIT(valp, bit) \
75 (_NOTMUCH_VALID_BIT (bit) ? (*(valp) |= (1ull << (bit))) : *(valp))
76 #define NOTMUCH_CLEAR_BIT(valp, bit) \
77 (_NOTMUCH_VALID_BIT (bit) ? (*(valp) &= ~(1ull << (bit))) : *(valp))
79 #define unused(x) x __attribute__ ((unused))
81 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
82 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
84 /* these macros gain us a few percent of speed on gcc */
86 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
87 * as its first argument */
89 #define likely(x) __builtin_expect (! ! (x), 1)
92 #define unlikely(x) __builtin_expect (! ! (x), 0)
99 #define unlikely(x) (x)
104 NOTMUCH_VALUE_TIMESTAMP = 0,
105 NOTMUCH_VALUE_MESSAGE_ID,
107 NOTMUCH_VALUE_SUBJECT,
108 NOTMUCH_VALUE_LAST_MOD,
111 /* Xapian (with flint backend) complains if we provide a term longer
112 * than this, but I haven't yet found a way to query the limit
113 * programmatically. */
114 #define NOTMUCH_TERM_MAX 245
116 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
118 /* For message IDs we have to be even more restrictive. Beyond fitting
119 * into the term limit, we also use message IDs to construct
120 * metadata-key values. And the documentation says that these should
121 * be restricted to about 200 characters. (The actual limit for the
122 * chert backend at least is 252.)
124 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
126 typedef enum _notmuch_private_status {
127 /* First, copy all the public status values. */
128 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
129 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
130 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
131 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
132 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
133 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
134 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
135 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
137 /* Then add our own private values. */
138 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
139 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
140 NOTMUCH_PRIVATE_STATUS_BAD_PREFIX,
142 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
143 } notmuch_private_status_t;
145 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
146 * value, generating an internal error if the private value is equal
147 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
148 * that the caller has previously handled any expected
149 * notmuch_private_status_t values.)
151 * Note that the function _internal_error does not return. Evaluating
152 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
154 #define COERCE_STATUS(private_status, format, ...) \
155 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS) \
157 _internal_error (format " (%s).\n", \
160 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
162 (notmuch_status_t) private_status)
164 /* Flags shared by various lookup functions. */
165 typedef enum _notmuch_find_flags {
166 /* Lookup without creating any documents. This is the default
168 NOTMUCH_FIND_LOOKUP = 0,
169 /* If set, create the necessary document (or documents) if they
170 * are missing. Requires a read/write database. */
171 NOTMUCH_FIND_CREATE = 1 << 0,
172 } notmuch_find_flags_t;
174 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
178 /* Lookup a prefix value by name.
180 * XXX: This should really be static inside of message.cc, and we can
181 * do that once we convert database.cc to use the
182 * _notmuch_message_add/remove_term functions. */
184 _find_prefix (const char *name);
186 /* Lookup a prefix value by name, including possibly user defined prefixes
189 _notmuch_database_prefix (notmuch_database_t *notmuch, const char *name);
192 _notmuch_message_id_compressed (void *ctx, const char *message_id);
195 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
198 _notmuch_database_reopen (notmuch_database_t *notmuch);
201 _notmuch_database_log (notmuch_database_t *notmuch,
202 const char *format, ...);
205 _notmuch_database_log_append (notmuch_database_t *notmuch,
206 const char *format, ...);
209 _notmuch_database_new_revision (notmuch_database_t *notmuch);
212 _notmuch_database_relative_path (notmuch_database_t *notmuch,
216 _notmuch_database_split_path (void *ctx,
218 const char **directory,
219 const char **basename);
222 _notmuch_database_get_directory_db_path (const char *path);
225 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
227 notmuch_private_status_t
228 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
229 const char *prefix_name,
231 unsigned int *doc_id);
234 _notmuch_database_find_directory_id (notmuch_database_t *database,
236 notmuch_find_flags_t flags,
237 unsigned int *directory_id);
240 _notmuch_database_get_directory_path (void *ctx,
241 notmuch_database_t *notmuch,
242 unsigned int doc_id);
245 _notmuch_database_filename_to_direntry (void *ctx,
246 notmuch_database_t *notmuch,
247 const char *filename,
248 notmuch_find_flags_t flags,
253 notmuch_directory_t *
254 _notmuch_directory_create (notmuch_database_t *notmuch,
256 notmuch_find_flags_t flags,
257 notmuch_status_t *status_ret);
260 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
265 _notmuch_message_create (const void *talloc_owner,
266 notmuch_database_t *notmuch,
268 notmuch_private_status_t *status);
271 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
272 const char *message_id,
273 notmuch_private_status_t *status);
276 _notmuch_message_get_doc_id (notmuch_message_t *message);
279 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
281 notmuch_private_status_t
282 _notmuch_message_add_term (notmuch_message_t *message,
283 const char *prefix_name,
286 notmuch_private_status_t
287 _notmuch_message_remove_term (notmuch_message_t *message,
288 const char *prefix_name,
291 notmuch_private_status_t
292 _notmuch_message_has_term (notmuch_message_t *message,
293 const char *prefix_name,
297 notmuch_private_status_t
298 _notmuch_message_gen_terms (notmuch_message_t *message,
299 const char *prefix_name,
303 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
306 _notmuch_message_upgrade_folder (notmuch_message_t *message);
309 _notmuch_message_add_filename (notmuch_message_t *message,
310 const char *filename);
313 _notmuch_message_remove_filename (notmuch_message_t *message,
314 const char *filename);
317 _notmuch_message_rename (notmuch_message_t *message,
318 const char *new_filename);
321 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
324 _notmuch_message_set_header_values (notmuch_message_t *message,
327 const char *subject);
330 _notmuch_message_update_subject (notmuch_message_t *message,
331 const char *subject);
334 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
337 _notmuch_message_sync (notmuch_message_t *message);
340 _notmuch_message_delete (notmuch_message_t *message);
342 notmuch_private_status_t
343 _notmuch_message_initialize_ghost (notmuch_message_t *message,
344 const char *thread_id);
347 _notmuch_message_close (notmuch_message_t *message);
349 /* Get a copy of the data in this message document.
351 * Caller should talloc_free the result when done.
353 * This function is intended to support database upgrade and really
354 * shouldn't be used otherwise. */
356 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
358 /* Clear the data in this message document.
360 * This function is intended to support database upgrade and really
361 * shouldn't be used otherwise. */
363 _notmuch_message_clear_data (notmuch_message_t *message);
365 /* Set the author member of 'message' - this is the representation used
366 * when displaying the message */
368 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
370 /* Get the author member of 'message' */
372 _notmuch_message_get_author (notmuch_message_t *message);
376 /* XXX: I haven't decided yet whether these will actually get exported
377 * into the public interface in notmuch.h
380 typedef struct _notmuch_message_file notmuch_message_file_t;
382 /* Open a file containing a single email message.
384 * The caller should call notmuch_message_close when done with this.
386 * Returns NULL if any error occurs.
388 notmuch_message_file_t *
389 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
391 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
392 notmuch_message_file_t *
393 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
394 void *ctx, const char *filename);
396 /* Close a notmuch message previously opened with notmuch_message_open. */
398 _notmuch_message_file_close (notmuch_message_file_t *message);
400 /* Parse the message.
402 * This will be done automatically as necessary on other calls
403 * depending on it, but an explicit call allows for better error
407 _notmuch_message_file_parse (notmuch_message_file_t *message);
409 /* Get the gmime message of a message file.
411 * The message file is parsed as necessary.
413 * The GMimeMessage* is set to *mime_message on success (which the
414 * caller must not unref).
416 * XXX: Would be nice to not have to expose GMimeMessage here.
419 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
420 GMimeMessage **mime_message);
422 /* Get the value of the specified header from the message as a UTF-8 string.
424 * The message file is parsed as necessary.
426 * The header name is case insensitive.
428 * The Received: header is special - for it all Received: headers in
429 * the message are concatenated
431 * The returned value is owned by the notmuch message and is valid
432 * only until the message is closed. The caller should copy it if
433 * needing to modify the value or to hold onto it for longer.
435 * Returns NULL on errors, empty string if the message does not
436 * contain a header line matching 'header'.
439 _notmuch_message_file_get_header (notmuch_message_file_t *message,
443 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
444 const char **from_out,
445 const char **subject_out,
447 const char **date_out,
448 char **message_id_out);
451 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
455 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
456 notmuch_message_t *message,
457 notmuch_message_file_t *message_file,
458 const char **thread_id);
462 _notmuch_message_index_file (notmuch_message_t *message,
463 notmuch_indexopts_t *indexopts,
464 notmuch_message_file_t *message_file);
468 typedef struct _notmuch_message_node {
469 notmuch_message_t *message;
470 struct _notmuch_message_node *next;
471 } notmuch_message_node_t;
473 typedef struct _notmuch_message_list {
474 notmuch_message_node_t *head;
475 notmuch_message_node_t **tail;
476 } notmuch_message_list_t;
478 /* There's a rumor that there's an alternate struct _notmuch_messages
479 * somewhere with some nasty C++ objects in it. We'll try to maintain
480 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
482 struct _notmuch_messages {
483 bool is_of_list_type;
484 notmuch_doc_id_set_t *excluded_doc_ids;
485 notmuch_message_node_t *iterator;
488 notmuch_message_list_t *
489 _notmuch_message_list_create (const void *ctx);
492 _notmuch_message_list_empty (notmuch_message_list_t *list);
495 _notmuch_message_list_add_message (notmuch_message_list_t *list,
496 notmuch_message_t *message);
499 _notmuch_messages_create (notmuch_message_list_t *list);
502 _notmuch_messages_has_next (notmuch_messages_t *messages);
507 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
510 _notmuch_mset_messages_get (notmuch_messages_t *messages);
513 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
516 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
517 unsigned int doc_id);
520 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
521 unsigned int doc_id);
523 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
525 _notmuch_query_search_documents (notmuch_query_t *query,
527 notmuch_messages_t **out);
530 _notmuch_query_count_documents (notmuch_query_t *query,
532 unsigned *count_out);
535 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
536 * comments, and the '<' and '>' delimiters.
538 * If not NULL, then *next will be made to point to the first character
539 * not parsed, (possibly pointing to the final '\0' terminator.
541 * Returns a newly talloc'ed string belonging to 'ctx'.
543 * Returns NULL if there is any error parsing the message-id. */
545 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
547 /* Parse a message-id, discarding leading and trailing whitespace, and
548 * '<' and '>' delimiters.
550 * Apply a probably-stricter-than RFC definition of what is allowed in
551 * a message-id. In particular, forbid whitespace.
553 * Returns a newly talloc'ed string belonging to 'ctx'.
555 * Returns NULL if there is any error parsing the message-id.
559 _notmuch_message_id_parse_strict (void *ctx, const char *message_id);
565 _notmuch_message_add_reply (notmuch_message_t *message,
566 notmuch_message_t *reply);
569 _notmuch_message_remove_unprefixed_terms (notmuch_message_t *message);
572 _notmuch_message_get_thread_id_only (notmuch_message_t *message);
574 size_t _notmuch_message_get_thread_depth (notmuch_message_t *message);
577 _notmuch_message_label_depths (notmuch_message_t *message,
580 notmuch_message_list_t *
581 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list);
586 _notmuch_sha1_of_string (const char *str);
589 _notmuch_sha1_of_file (const char *filename);
593 typedef struct _notmuch_string_node {
595 struct _notmuch_string_node *next;
596 } notmuch_string_node_t;
598 typedef struct _notmuch_string_list {
600 notmuch_string_node_t *head;
601 notmuch_string_node_t **tail;
602 } notmuch_string_list_t;
604 notmuch_string_list_t *
605 _notmuch_string_list_create (const void *ctx);
608 * return the number of strings in 'list'
611 _notmuch_string_list_length (notmuch_string_list_t *list);
613 /* Add 'string' to 'list'.
615 * The list will create its own talloced copy of 'string'.
618 _notmuch_string_list_append (notmuch_string_list_t *list,
622 _notmuch_string_list_sort (notmuch_string_list_t *list);
624 const notmuch_string_list_t *
625 _notmuch_message_get_references (notmuch_message_t *message);
628 typedef struct _notmuch_string_map notmuch_string_map_t;
629 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
630 notmuch_string_map_t *
631 _notmuch_string_map_create (const void *ctx);
634 _notmuch_string_map_append (notmuch_string_map_t *map,
639 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
641 notmuch_string_map_iterator_t *
642 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
646 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
649 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
652 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
655 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
658 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
660 /* Create an iterator for user headers. Destroy with
661 * _notmuch_string_map_iterator_destroy. Actually in database.cc*/
662 notmuch_string_map_iterator_t *
663 _notmuch_database_user_headers (notmuch_database_t *notmuch);
668 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
672 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
674 notmuch_filenames_t *
675 _notmuch_filenames_create (const void *ctx,
676 notmuch_string_list_t *list);
681 _notmuch_thread_create (void *ctx,
682 notmuch_database_t *notmuch,
683 unsigned int seed_doc_id,
684 notmuch_doc_id_set_t *match_set,
685 notmuch_string_list_t *excluded_terms,
686 notmuch_exclude_t omit_exclude,
687 notmuch_sort_t sort);
691 struct _notmuch_indexopts {
692 _notmuch_crypto_t crypto;
695 #define CONFIG_HEADER_PREFIX "index.header."
697 #define EMPTY_STRING(s) ((s)[0] == '\0')
702 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
703 * C++. In talloc_steal, an explicit cast is provided for type safety
704 * in some GCC versions. Otherwise, a cast is required. Provide a
705 * template function for this to maintain type safety, and redefine
706 * talloc_steal to use it.
708 #if ! (__GNUC__ >= 3)
709 template <class T> T *
710 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
712 return static_cast<T *> (talloc_steal (new_ctx, ptr));
715 #define talloc_steal _notmuch_talloc_steal