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 __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))
124 typedef enum _notmuch_private_status {
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_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
131 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
132 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
133 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
135 /* Then add our own private values. */
136 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
137 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
138 NOTMUCH_PRIVATE_STATUS_BAD_PREFIX,
140 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
141 } notmuch_private_status_t;
143 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
144 * value, generating an internal error if the private value is equal
145 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
146 * that the caller has previously handled any expected
147 * notmuch_private_status_t values.)
149 * Note that the function _internal_error does not return. Evaluating
150 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
152 #define COERCE_STATUS(private_status, format, ...) \
153 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS) \
155 _internal_error (format " (%s).\n", \
158 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
160 (notmuch_status_t) private_status)
162 /* Flags shared by various lookup functions. */
163 typedef enum _notmuch_find_flags {
164 /* Lookup without creating any documents. This is the default
166 NOTMUCH_FIND_LOOKUP = 0,
167 /* If set, create the necessary document (or documents) if they
168 * are missing. Requires a read/write database. */
169 NOTMUCH_FIND_CREATE = 1 << 0,
170 } notmuch_find_flags_t;
172 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
176 /* Lookup a prefix value by name.
178 * XXX: This should really be static inside of message.cc, and we can
179 * do that once we convert database.cc to use the
180 * _notmuch_message_add/remove_term functions. */
182 _find_prefix (const char *name);
184 /* Lookup a prefix value by name, including possibly user defined prefixes
187 _notmuch_database_prefix (notmuch_database_t *notmuch, const char *name);
190 _notmuch_message_id_compressed (void *ctx, const char *message_id);
193 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
196 _notmuch_database_reopen (notmuch_database_t *notmuch);
199 _notmuch_database_log (notmuch_database_t *notmuch,
200 const char *format, ...);
203 _notmuch_database_log_append (notmuch_database_t *notmuch,
204 const char *format, ...);
207 _notmuch_database_new_revision (notmuch_database_t *notmuch);
210 _notmuch_database_relative_path (notmuch_database_t *notmuch,
214 _notmuch_database_split_path (void *ctx,
216 const char **directory,
217 const char **basename);
220 _notmuch_database_get_directory_db_path (const char *path);
223 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
225 notmuch_private_status_t
226 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
227 const char *prefix_name,
229 unsigned int *doc_id);
232 _notmuch_database_find_directory_id (notmuch_database_t *database,
234 notmuch_find_flags_t flags,
235 unsigned int *directory_id);
238 _notmuch_database_get_directory_path (void *ctx,
239 notmuch_database_t *notmuch,
240 unsigned int doc_id);
243 _notmuch_database_filename_to_direntry (void *ctx,
244 notmuch_database_t *notmuch,
245 const char *filename,
246 notmuch_find_flags_t flags,
251 notmuch_directory_t *
252 _notmuch_directory_find_or_create (notmuch_database_t *notmuch,
254 notmuch_find_flags_t flags,
255 notmuch_status_t *status_ret);
258 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
260 notmuch_database_mode_t
261 _notmuch_database_mode (notmuch_database_t *notmuch);
266 _notmuch_message_create (const void *talloc_owner,
267 notmuch_database_t *notmuch,
269 notmuch_private_status_t *status);
272 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
273 const char *message_id,
274 notmuch_private_status_t *status);
277 _notmuch_message_get_doc_id (notmuch_message_t *message);
280 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
282 notmuch_private_status_t
283 _notmuch_message_add_term (notmuch_message_t *message,
284 const char *prefix_name,
287 notmuch_private_status_t
288 _notmuch_message_remove_term (notmuch_message_t *message,
289 const char *prefix_name,
292 notmuch_private_status_t
293 _notmuch_message_has_term (notmuch_message_t *message,
294 const char *prefix_name,
298 notmuch_private_status_t
299 _notmuch_message_gen_terms (notmuch_message_t *message,
300 const char *prefix_name,
304 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
307 _notmuch_message_upgrade_folder (notmuch_message_t *message);
310 _notmuch_message_add_filename (notmuch_message_t *message,
311 const char *filename);
314 _notmuch_message_remove_filename (notmuch_message_t *message,
315 const char *filename);
318 _notmuch_message_rename (notmuch_message_t *message,
319 const char *new_filename);
322 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
325 _notmuch_message_set_header_values (notmuch_message_t *message,
328 const char *subject);
331 _notmuch_message_update_subject (notmuch_message_t *message,
332 const char *subject);
335 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
338 _notmuch_message_sync (notmuch_message_t *message);
341 _notmuch_message_delete (notmuch_message_t *message);
343 notmuch_private_status_t
344 _notmuch_message_initialize_ghost (notmuch_message_t *message,
345 const char *thread_id);
348 _notmuch_message_close (notmuch_message_t *message);
350 /* Get a copy of the data in this message document.
352 * Caller should talloc_free the result when done.
354 * This function is intended to support database upgrade and really
355 * shouldn't be used otherwise. */
357 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
359 /* Clear the data in this message document.
361 * This function is intended to support database upgrade and really
362 * shouldn't be used otherwise. */
364 _notmuch_message_clear_data (notmuch_message_t *message);
366 /* Set the author member of 'message' - this is the representation used
367 * when displaying the message */
369 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
371 /* Get the author member of 'message' */
373 _notmuch_message_get_author (notmuch_message_t *message);
377 /* XXX: I haven't decided yet whether these will actually get exported
378 * into the public interface in notmuch.h
381 typedef struct _notmuch_message_file notmuch_message_file_t;
383 /* Open a file containing a single email message.
385 * The caller should call notmuch_message_close when done with this.
387 * Returns NULL if any error occurs.
389 notmuch_message_file_t *
390 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
392 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
393 notmuch_message_file_t *
394 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
395 void *ctx, const char *filename);
397 /* Close a notmuch message previously opened with notmuch_message_open. */
399 _notmuch_message_file_close (notmuch_message_file_t *message);
401 /* Parse the message.
403 * This will be done automatically as necessary on other calls
404 * depending on it, but an explicit call allows for better error
408 _notmuch_message_file_parse (notmuch_message_file_t *message);
410 /* Get the gmime message of a message file.
412 * The message file is parsed as necessary.
414 * The GMimeMessage* is set to *mime_message on success (which the
415 * caller must not unref).
417 * XXX: Would be nice to not have to expose GMimeMessage here.
420 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
421 GMimeMessage **mime_message);
423 /* Get the value of the specified header from the message as a UTF-8 string.
425 * The message file is parsed as necessary.
427 * The header name is case insensitive.
429 * The Received: header is special - for it all Received: headers in
430 * the message are concatenated
432 * The returned value is owned by the notmuch message and is valid
433 * only until the message is closed. The caller should copy it if
434 * needing to modify the value or to hold onto it for longer.
436 * Returns NULL on errors, empty string if the message does not
437 * contain a header line matching 'header'.
440 _notmuch_message_file_get_header (notmuch_message_file_t *message,
444 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
445 const char **from_out,
446 const char **subject_out,
448 const char **date_out,
449 char **message_id_out);
452 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
456 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
457 notmuch_message_t *message,
458 notmuch_message_file_t *message_file,
459 const char **thread_id);
463 _notmuch_message_index_file (notmuch_message_t *message,
464 notmuch_indexopts_t *indexopts,
465 notmuch_message_file_t *message_file);
469 typedef struct _notmuch_message_node {
470 notmuch_message_t *message;
471 struct _notmuch_message_node *next;
472 } notmuch_message_node_t;
474 typedef struct _notmuch_message_list {
475 notmuch_message_node_t *head;
476 notmuch_message_node_t **tail;
477 } notmuch_message_list_t;
479 /* There's a rumor that there's an alternate struct _notmuch_messages
480 * somewhere with some nasty C++ objects in it. We'll try to maintain
481 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
483 struct _notmuch_messages {
484 bool is_of_list_type;
485 notmuch_doc_id_set_t *excluded_doc_ids;
486 notmuch_message_node_t *iterator;
489 notmuch_message_list_t *
490 _notmuch_message_list_create (const void *ctx);
493 _notmuch_message_list_empty (notmuch_message_list_t *list);
496 _notmuch_message_list_add_message (notmuch_message_list_t *list,
497 notmuch_message_t *message);
500 _notmuch_messages_create (notmuch_message_list_t *list);
503 _notmuch_messages_has_next (notmuch_messages_t *messages);
508 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
511 _notmuch_mset_messages_get (notmuch_messages_t *messages);
514 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
517 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
518 unsigned int doc_id);
521 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
522 unsigned int doc_id);
524 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
526 _notmuch_query_search_documents (notmuch_query_t *query,
528 notmuch_messages_t **out);
531 _notmuch_query_count_documents (notmuch_query_t *query,
533 unsigned *count_out);
536 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
537 * comments, and the '<' and '>' delimiters.
539 * If not NULL, then *next will be made to point to the first character
540 * not parsed, (possibly pointing to the final '\0' terminator.
542 * Returns a newly talloc'ed string belonging to 'ctx'.
544 * Returns NULL if there is any error parsing the message-id. */
546 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
548 /* Parse a message-id, discarding leading and trailing whitespace, and
549 * '<' and '>' delimiters.
551 * Apply a probably-stricter-than RFC definition of what is allowed in
552 * a message-id. In particular, forbid whitespace.
554 * Returns a newly talloc'ed string belonging to 'ctx'.
556 * Returns NULL if there is any error parsing the message-id.
560 _notmuch_message_id_parse_strict (void *ctx, const char *message_id);
566 _notmuch_message_add_reply (notmuch_message_t *message,
567 notmuch_message_t *reply);
570 _notmuch_message_remove_unprefixed_terms (notmuch_message_t *message);
573 _notmuch_message_get_thread_id_only (notmuch_message_t *message);
575 size_t _notmuch_message_get_thread_depth (notmuch_message_t *message);
578 _notmuch_message_label_depths (notmuch_message_t *message,
581 notmuch_message_list_t *
582 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list);
587 _notmuch_sha1_of_string (const char *str);
590 _notmuch_sha1_of_file (const char *filename);
594 typedef struct _notmuch_string_node {
596 struct _notmuch_string_node *next;
597 } notmuch_string_node_t;
599 typedef struct _notmuch_string_list {
601 notmuch_string_node_t *head;
602 notmuch_string_node_t **tail;
603 } notmuch_string_list_t;
605 notmuch_string_list_t *
606 _notmuch_string_list_create (const void *ctx);
609 * return the number of strings in 'list'
612 _notmuch_string_list_length (notmuch_string_list_t *list);
614 /* Add 'string' to 'list'.
616 * The list will create its own talloced copy of 'string'.
619 _notmuch_string_list_append (notmuch_string_list_t *list,
623 _notmuch_string_list_sort (notmuch_string_list_t *list);
625 const notmuch_string_list_t *
626 _notmuch_message_get_references (notmuch_message_t *message);
629 typedef struct _notmuch_string_map notmuch_string_map_t;
630 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
631 notmuch_string_map_t *
632 _notmuch_string_map_create (const void *ctx);
635 _notmuch_string_map_append (notmuch_string_map_t *map,
640 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
642 notmuch_string_map_iterator_t *
643 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
647 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
650 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
653 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
656 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
659 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
661 /* Create an iterator for user headers. Destroy with
662 * _notmuch_string_map_iterator_destroy. Actually in database.cc*/
663 notmuch_string_map_iterator_t *
664 _notmuch_database_user_headers (notmuch_database_t *notmuch);
669 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
673 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
675 notmuch_filenames_t *
676 _notmuch_filenames_create (const void *ctx,
677 notmuch_string_list_t *list);
682 _notmuch_thread_create (void *ctx,
683 notmuch_database_t *notmuch,
684 unsigned int seed_doc_id,
685 notmuch_doc_id_set_t *match_set,
686 notmuch_string_list_t *excluded_terms,
687 notmuch_exclude_t omit_exclude,
688 notmuch_sort_t sort);
692 struct _notmuch_indexopts {
693 _notmuch_crypto_t crypto;
696 #define CONFIG_HEADER_PREFIX "index.header."
698 #define EMPTY_STRING(s) ((s)[0] == '\0')
703 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
704 * C++. In talloc_steal, an explicit cast is provided for type safety
705 * in some GCC versions. Otherwise, a cast is required. Provide a
706 * template function for this to maintain type safety, and redefine
707 * talloc_steal to use it.
709 #if ! (__GNUC__ >= 3)
710 template <class T> T *
711 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
713 return static_cast<T *> (talloc_steal (new_ctx, ptr));
716 #define talloc_steal _notmuch_talloc_steal