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 */
35 #include "error_util.h"
36 #include "string-util.h"
44 #include <sys/types.h>
57 # define DEBUG_DATABASE_SANITY 1
58 # define DEBUG_THREADING 1
59 # define DEBUG_QUERY 1
62 #define COMPILE_TIME_ASSERT(pred) ((void) sizeof (char[1 - 2 * ! (pred)]))
64 #define STRNCMP_LITERAL(var, literal) \
65 strncmp ((var), (literal), sizeof (literal) - 1)
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))
77 #define unused(x) x ## _unused __attribute__ ((unused))
79 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
80 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
82 /* these macros gain us a few percent of speed on gcc */
84 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
85 * as its first argument */
87 #define likely(x) __builtin_expect (! ! (x), 1)
90 #define unlikely(x) __builtin_expect (! ! (x), 0)
97 #define unlikely(x) (x)
102 NOTMUCH_VALUE_TIMESTAMP = 0,
103 NOTMUCH_VALUE_MESSAGE_ID,
105 NOTMUCH_VALUE_SUBJECT,
106 NOTMUCH_VALUE_LAST_MOD,
109 /* Xapian (with flint backend) complains if we provide a term longer
110 * than this, but I haven't yet found a way to query the limit
111 * programmatically. */
112 #define NOTMUCH_TERM_MAX 245
114 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
116 /* For message IDs we have to be even more restrictive. Beyond fitting
117 * into the term limit, we also use message IDs to construct
118 * metadata-key values. And the documentation says that these should
119 * be restricted to about 200 characters. (The actual limit for the
120 * chert backend at least is 252.)
122 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
125 /* First, copy all the public status values. */
126 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
127 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
128 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
129 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
130 NOTMUCH_PRIVATE_STATUS_FILE_ERROR = NOTMUCH_STATUS_FILE_ERROR,
131 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
132 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
133 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
134 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
135 NOTMUCH_PRIVATE_STATUS_UNBALANCED_ATOMIC = NOTMUCH_STATUS_UNBALANCED_ATOMIC,
136 NOTMUCH_PRIVATE_STATUS_UNSUPPORTED_OPERATION = NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
137 NOTMUCH_PRIVATE_STATUS_UPGRADE_REQUIRED = NOTMUCH_STATUS_UPGRADE_REQUIRED,
138 NOTMUCH_PRIVATE_STATUS_PATH_ERROR = NOTMUCH_STATUS_PATH_ERROR,
139 NOTMUCH_PRIVATE_STATUS_IGNORED = NOTMUCH_STATUS_IGNORED,
140 NOTMUCH_PRIVATE_STATUS_ILLEGAL_ARGUMENT = NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
141 NOTMUCH_PRIVATE_STATUS_MALFORMED_CRYPTO_PROTOCOL = NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
142 NOTMUCH_PRIVATE_STATUS_FAILED_CRYPTO_CONTEXT_CREATION = NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
143 NOTMUCH_PRIVATE_STATUS_UNKNOWN_CRYPTO_PROTOCOL = NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
144 NOTMUCH_PRIVATE_STATUS_NO_CONFIG = NOTMUCH_STATUS_NO_CONFIG,
145 NOTMUCH_PRIVATE_STATUS_NO_DATABASE = NOTMUCH_STATUS_NO_DATABASE,
146 NOTMUCH_PRIVATE_STATUS_DATABASE_EXISTS = NOTMUCH_STATUS_DATABASE_EXISTS,
148 /* Then add our own private values. */
149 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
150 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
151 NOTMUCH_PRIVATE_STATUS_BAD_PREFIX,
153 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
154 } notmuch_private_status_t;
156 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
157 * value, generating an internal error if the private value is equal
158 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
159 * that the caller has previously handled any expected
160 * notmuch_private_status_t values.)
162 * Note that the function _internal_error does not return. Evaluating
163 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
165 #define COERCE_STATUS(private_status, format, ...) \
166 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS) \
168 _internal_error (format " (%s).\n", \
171 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
173 (notmuch_status_t) private_status)
175 /* Flags shared by various lookup functions. */
177 /* Lookup without creating any documents. This is the default
179 NOTMUCH_FIND_LOOKUP = 0,
180 /* If set, create the necessary document (or documents) if they
181 * are missing. Requires a read/write database. */
182 NOTMUCH_FIND_CREATE = 1 << 0,
183 } notmuch_find_flags_t;
185 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
189 /* Lookup a prefix value by name.
191 * XXX: This should really be static inside of message.cc, and we can
192 * do that once we convert database.cc to use the
193 * _notmuch_message_add/remove_term functions. */
195 _find_prefix (const char *name);
197 /* Lookup a prefix value by name, including possibly user defined prefixes
200 _notmuch_database_prefix (notmuch_database_t *notmuch, const char *name);
203 _notmuch_message_id_compressed (void *ctx, const char *message_id);
206 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
209 _notmuch_database_log (notmuch_database_t *notmuch,
210 const char *format, ...);
213 _notmuch_database_log_append (notmuch_database_t *notmuch,
214 const char *format, ...);
217 _notmuch_database_new_revision (notmuch_database_t *notmuch);
220 _notmuch_database_relative_path (notmuch_database_t *notmuch,
224 _notmuch_database_split_path (void *ctx,
226 const char **directory,
227 const char **basename);
230 _notmuch_database_get_directory_db_path (const char *path);
233 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
235 notmuch_private_status_t
236 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
237 const char *prefix_name,
239 unsigned int *doc_id);
242 _notmuch_database_find_directory_id (notmuch_database_t *database,
244 notmuch_find_flags_t flags,
245 unsigned int *directory_id);
248 _notmuch_database_get_directory_path (void *ctx,
249 notmuch_database_t *notmuch,
250 unsigned int doc_id);
253 _notmuch_database_filename_to_direntry (void *ctx,
254 notmuch_database_t *notmuch,
255 const char *filename,
256 notmuch_find_flags_t flags,
261 notmuch_directory_t *
262 _notmuch_directory_find_or_create (notmuch_database_t *notmuch,
264 notmuch_find_flags_t flags,
265 notmuch_status_t *status_ret);
268 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
270 notmuch_database_mode_t
271 _notmuch_database_mode (notmuch_database_t *notmuch);
276 _notmuch_message_create (const void *talloc_owner,
277 notmuch_database_t *notmuch,
279 notmuch_private_status_t *status);
282 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
283 const char *message_id,
284 notmuch_private_status_t *status);
287 _notmuch_message_get_doc_id (notmuch_message_t *message);
290 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
292 notmuch_private_status_t
293 _notmuch_message_add_term (notmuch_message_t *message,
294 const char *prefix_name,
297 notmuch_private_status_t
298 _notmuch_message_remove_term (notmuch_message_t *message,
299 const char *prefix_name,
302 notmuch_private_status_t
303 _notmuch_message_has_term (notmuch_message_t *message,
304 const char *prefix_name,
308 notmuch_private_status_t
309 _notmuch_message_gen_terms (notmuch_message_t *message,
310 const char *prefix_name,
314 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
317 _notmuch_message_upgrade_folder (notmuch_message_t *message);
320 _notmuch_message_add_filename (notmuch_message_t *message,
321 const char *filename);
324 _notmuch_message_remove_filename (notmuch_message_t *message,
325 const char *filename);
328 _notmuch_message_rename (notmuch_message_t *message,
329 const char *new_filename);
332 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
335 _notmuch_message_set_header_values (notmuch_message_t *message,
338 const char *subject);
341 _notmuch_message_update_subject (notmuch_message_t *message,
342 const char *subject);
345 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
348 _notmuch_message_sync (notmuch_message_t *message);
351 _notmuch_message_delete (notmuch_message_t *message);
353 notmuch_private_status_t
354 _notmuch_message_initialize_ghost (notmuch_message_t *message,
355 const char *thread_id);
358 _notmuch_message_close (notmuch_message_t *message);
360 /* Get a copy of the data in this message document.
362 * Caller should talloc_free the result when done.
364 * This function is intended to support database upgrade and really
365 * shouldn't be used otherwise. */
367 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
369 /* Clear the data in this message document.
371 * This function is intended to support database upgrade and really
372 * shouldn't be used otherwise. */
374 _notmuch_message_clear_data (notmuch_message_t *message);
376 /* Set the author member of 'message' - this is the representation used
377 * when displaying the message */
379 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
381 /* Get the author member of 'message' */
383 _notmuch_message_get_author (notmuch_message_t *message);
387 /* XXX: I haven't decided yet whether these will actually get exported
388 * into the public interface in notmuch.h
391 typedef struct _notmuch_message_file notmuch_message_file_t;
393 /* Open a file containing a single email message.
395 * The caller should call notmuch_message_close when done with this.
397 * Returns NULL if any error occurs.
399 notmuch_message_file_t *
400 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
402 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
403 notmuch_message_file_t *
404 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
405 void *ctx, const char *filename);
407 /* Close a notmuch message previously opened with notmuch_message_open. */
409 _notmuch_message_file_close (notmuch_message_file_t *message);
411 /* Parse the message.
413 * This will be done automatically as necessary on other calls
414 * depending on it, but an explicit call allows for better error
418 _notmuch_message_file_parse (notmuch_message_file_t *message);
420 /* Get the gmime message of a message file.
422 * The message file is parsed as necessary.
424 * The GMimeMessage* is set to *mime_message on success (which the
425 * caller must not unref).
427 * XXX: Would be nice to not have to expose GMimeMessage here.
430 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
431 GMimeMessage **mime_message);
433 /* Get the value of the specified header from the message as a UTF-8 string.
435 * The message file is parsed as necessary.
437 * The header name is case insensitive.
439 * The Received: header is special - for it all Received: headers in
440 * the message are concatenated
442 * The returned value is owned by the notmuch message and is valid
443 * only until the message is closed. The caller should copy it if
444 * needing to modify the value or to hold onto it for longer.
446 * Returns NULL on errors, empty string if the message does not
447 * contain a header line matching 'header'.
450 _notmuch_message_file_get_header (notmuch_message_file_t *message,
454 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
455 const char **from_out,
456 const char **subject_out,
458 const char **date_out,
459 char **message_id_out);
462 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
466 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
467 notmuch_message_t *message,
468 notmuch_message_file_t *message_file,
469 const char **thread_id);
473 _notmuch_filter_init ();
476 _notmuch_message_index_file (notmuch_message_t *message,
477 notmuch_indexopts_t *indexopts,
478 notmuch_message_file_t *message_file);
486 typedef struct _notmuch_message_node {
487 notmuch_message_t *message;
488 struct _notmuch_message_node *next;
489 } notmuch_message_node_t;
491 typedef struct _notmuch_message_list {
492 notmuch_message_node_t *head;
493 notmuch_message_node_t **tail;
494 } notmuch_message_list_t;
496 /* There's a rumor that there's an alternate struct _notmuch_messages
497 * somewhere with some nasty C++ objects in it. We'll try to maintain
498 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
500 struct _notmuch_messages {
501 bool is_of_list_type;
502 notmuch_doc_id_set_t *excluded_doc_ids;
503 notmuch_message_node_t *iterator;
506 notmuch_message_list_t *
507 _notmuch_message_list_create (const void *ctx);
510 _notmuch_message_list_empty (notmuch_message_list_t *list);
513 _notmuch_message_list_add_message (notmuch_message_list_t *list,
514 notmuch_message_t *message);
517 _notmuch_messages_create (notmuch_message_list_t *list);
520 _notmuch_messages_has_next (notmuch_messages_t *messages);
525 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
528 _notmuch_mset_messages_get (notmuch_messages_t *messages);
531 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
534 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
535 unsigned int doc_id);
538 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
539 unsigned int doc_id);
541 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
543 _notmuch_query_search_documents (notmuch_query_t *query,
545 notmuch_messages_t **out);
548 _notmuch_query_count_documents (notmuch_query_t *query,
550 unsigned *count_out);
553 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
554 * comments, and the '<' and '>' delimiters.
556 * If not NULL, then *next will be made to point to the first character
557 * not parsed, (possibly pointing to the final '\0' terminator.
559 * Returns a newly talloc'ed string belonging to 'ctx'.
561 * Returns NULL if there is any error parsing the message-id. */
563 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
565 /* Parse a message-id, discarding leading and trailing whitespace, and
566 * '<' and '>' delimiters.
568 * Apply a probably-stricter-than RFC definition of what is allowed in
569 * a message-id. In particular, forbid whitespace.
571 * Returns a newly talloc'ed string belonging to 'ctx'.
573 * Returns NULL if there is any error parsing the message-id.
577 _notmuch_message_id_parse_strict (void *ctx, const char *message_id);
583 _notmuch_message_add_reply (notmuch_message_t *message,
584 notmuch_message_t *reply);
587 _notmuch_message_remove_unprefixed_terms (notmuch_message_t *message);
590 _notmuch_message_get_thread_id_only (notmuch_message_t *message);
592 size_t _notmuch_message_get_thread_depth (notmuch_message_t *message);
595 _notmuch_message_label_depths (notmuch_message_t *message,
598 notmuch_message_list_t *
599 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list);
604 _notmuch_sha1_of_string (const char *str);
607 _notmuch_sha1_of_file (const char *filename);
611 typedef struct _notmuch_string_node {
613 struct _notmuch_string_node *next;
614 } notmuch_string_node_t;
616 typedef struct _notmuch_string_list {
618 notmuch_string_node_t *head;
619 notmuch_string_node_t **tail;
620 } notmuch_string_list_t;
622 notmuch_string_list_t *
623 _notmuch_string_list_create (const void *ctx);
626 * return the number of strings in 'list'
629 _notmuch_string_list_length (notmuch_string_list_t *list);
631 /* Add 'string' to 'list'.
633 * The list will create its own talloced copy of 'string'.
636 _notmuch_string_list_append (notmuch_string_list_t *list,
640 _notmuch_string_list_sort (notmuch_string_list_t *list);
642 const notmuch_string_list_t *
643 _notmuch_message_get_references (notmuch_message_t *message);
646 typedef struct _notmuch_string_map notmuch_string_map_t;
647 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
648 notmuch_string_map_t *
649 _notmuch_string_map_create (const void *ctx);
652 _notmuch_string_map_append (notmuch_string_map_t *map,
657 _notmuch_string_map_set (notmuch_string_map_t *map,
662 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
664 notmuch_string_map_iterator_t *
665 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
669 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
672 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
675 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
678 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
681 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
683 /* Create an iterator for user headers. Destroy with
684 * _notmuch_string_map_iterator_destroy. Actually in database.cc*/
685 notmuch_string_map_iterator_t *
686 _notmuch_database_user_headers (notmuch_database_t *notmuch);
691 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
695 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
697 notmuch_filenames_t *
698 _notmuch_filenames_create (const void *ctx,
699 notmuch_string_list_t *list);
704 _notmuch_thread_create (void *ctx,
705 notmuch_database_t *notmuch,
706 unsigned int seed_doc_id,
707 notmuch_doc_id_set_t *match_set,
708 notmuch_string_list_t *excluded_terms,
709 notmuch_exclude_t omit_exclude,
710 notmuch_sort_t sort);
714 struct _notmuch_indexopts;
716 #define CONFIG_HEADER_PREFIX "index.header."
718 #define EMPTY_STRING(s) ((s)[0] == '\0')
722 _notmuch_config_load_from_database (notmuch_database_t *db);
725 _notmuch_config_load_from_file (notmuch_database_t *db, GKeyFile *file);
728 _notmuch_config_load_defaults (notmuch_database_t *db);
731 _notmuch_config_cache (notmuch_database_t *db, notmuch_config_key_t key, const char *val);
735 _notmuch_choose_xapian_path (void *ctx, const char *database_path, const char **xapian_path,
741 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
742 * C++. In talloc_steal, an explicit cast is provided for type safety
743 * in some GCC versions. Otherwise, a cast is required. Provide a
744 * template function for this to maintain type safety, and redefine
745 * talloc_steal to use it.
747 #if ! (__GNUC__ >= 3)
748 template <class T> T *
749 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
751 return static_cast<T *> (talloc_steal (new_ctx, ptr));
754 #define talloc_steal _notmuch_talloc_steal