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 */
37 #include <sys/types.h>
49 #include "gmime-extra.h"
52 #include "error_util.h"
53 #include "string-util.h"
56 # define DEBUG_DATABASE_SANITY 1
57 # define DEBUG_QUERY 1
60 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
62 #define STRNCMP_LITERAL(var, literal) \
63 strncmp ((var), (literal), sizeof (literal) - 1)
65 /* Robust bit test/set/reset macros */
66 #define _NOTMUCH_VALID_BIT(bit) \
67 ((bit) >= 0 && ((unsigned long) bit) < CHAR_BIT * sizeof (unsigned long long))
68 #define NOTMUCH_TEST_BIT(val, bit) \
69 (_NOTMUCH_VALID_BIT(bit) ? !!((val) & (1ull << (bit))) : 0)
70 #define NOTMUCH_SET_BIT(valp, bit) \
71 (_NOTMUCH_VALID_BIT(bit) ? (*(valp) |= (1ull << (bit))) : *(valp))
72 #define NOTMUCH_CLEAR_BIT(valp, bit) \
73 (_NOTMUCH_VALID_BIT(bit) ? (*(valp) &= ~(1ull << (bit))) : *(valp))
75 #define unused(x) x __attribute__ ((unused))
77 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
78 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
80 /* these macros gain us a few percent of speed on gcc */
82 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
83 as its first argument */
85 #define likely(x) __builtin_expect(!!(x), 1)
88 #define unlikely(x) __builtin_expect(!!(x), 0)
95 #define unlikely(x) (x)
100 NOTMUCH_VALUE_TIMESTAMP = 0,
101 NOTMUCH_VALUE_MESSAGE_ID,
103 NOTMUCH_VALUE_SUBJECT,
104 NOTMUCH_VALUE_LAST_MOD,
107 /* Xapian (with flint backend) complains if we provide a term longer
108 * than this, but I haven't yet found a way to query the limit
109 * programmatically. */
110 #define NOTMUCH_TERM_MAX 245
112 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
114 /* For message IDs we have to be even more restrictive. Beyond fitting
115 * into the term limit, we also use message IDs to construct
116 * metadata-key values. And the documentation says that these should
117 * be restricted to about 200 characters. (The actual limit for the
118 * chert backend at least is 252.)
120 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
122 typedef enum _notmuch_private_status {
123 /* First, copy all the public status values. */
124 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
125 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
126 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
127 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
128 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
129 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
130 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
131 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
133 /* Then add our own private values. */
134 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
135 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
137 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
138 } notmuch_private_status_t;
140 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
141 * value, generating an internal error if the private value is equal
142 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
143 * that the caller has previously handled any expected
144 * notmuch_private_status_t values.)
146 * Note that the function _internal_error does not return. Evaluating
147 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
149 #define COERCE_STATUS(private_status, format, ...) \
150 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
152 _internal_error (format " (%s).\n", \
155 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
157 (notmuch_status_t) private_status)
159 /* Flags shared by various lookup functions. */
160 typedef enum _notmuch_find_flags {
161 /* Lookup without creating any documents. This is the default
163 NOTMUCH_FIND_LOOKUP = 0,
164 /* If set, create the necessary document (or documents) if they
165 * are missing. Requires a read/write database. */
166 NOTMUCH_FIND_CREATE = 1<<0,
167 } notmuch_find_flags_t;
169 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
173 /* Lookup a prefix value by name.
175 * XXX: This should really be static inside of message.cc, and we can
176 * do that once we convert database.cc to use the
177 * _notmuch_message_add/remove_term functions. */
179 _find_prefix (const char *name);
182 _notmuch_message_id_compressed (void *ctx, const char *message_id);
185 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
188 _notmuch_database_reopen (notmuch_database_t *notmuch);
191 _notmuch_database_log (notmuch_database_t *notmuch,
192 const char *format, ...);
195 _notmuch_database_log_append (notmuch_database_t *notmuch,
196 const char *format, ...);
199 _notmuch_database_new_revision (notmuch_database_t *notmuch);
202 _notmuch_database_relative_path (notmuch_database_t *notmuch,
206 _notmuch_database_split_path (void *ctx,
208 const char **directory,
209 const char **basename);
212 _notmuch_database_get_directory_db_path (const char *path);
215 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
217 notmuch_private_status_t
218 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
219 const char *prefix_name,
221 unsigned int *doc_id);
224 _notmuch_database_find_directory_id (notmuch_database_t *database,
226 notmuch_find_flags_t flags,
227 unsigned int *directory_id);
230 _notmuch_database_get_directory_path (void *ctx,
231 notmuch_database_t *notmuch,
232 unsigned int doc_id);
235 _notmuch_database_filename_to_direntry (void *ctx,
236 notmuch_database_t *notmuch,
237 const char *filename,
238 notmuch_find_flags_t flags,
243 notmuch_directory_t *
244 _notmuch_directory_create (notmuch_database_t *notmuch,
246 notmuch_find_flags_t flags,
247 notmuch_status_t *status_ret);
250 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
255 _notmuch_message_create (const void *talloc_owner,
256 notmuch_database_t *notmuch,
258 notmuch_private_status_t *status);
261 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
262 const char *message_id,
263 notmuch_private_status_t *status);
266 _notmuch_message_get_doc_id (notmuch_message_t *message);
269 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
271 notmuch_private_status_t
272 _notmuch_message_add_term (notmuch_message_t *message,
273 const char *prefix_name,
276 notmuch_private_status_t
277 _notmuch_message_remove_term (notmuch_message_t *message,
278 const char *prefix_name,
281 notmuch_private_status_t
282 _notmuch_message_has_term (notmuch_message_t *message,
283 const char *prefix_name,
285 notmuch_bool_t *result);
287 notmuch_private_status_t
288 _notmuch_message_gen_terms (notmuch_message_t *message,
289 const char *prefix_name,
293 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
296 _notmuch_message_upgrade_folder (notmuch_message_t *message);
299 _notmuch_message_add_filename (notmuch_message_t *message,
300 const char *filename);
303 _notmuch_message_remove_filename (notmuch_message_t *message,
304 const char *filename);
307 _notmuch_message_rename (notmuch_message_t *message,
308 const char *new_filename);
311 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
314 _notmuch_message_set_header_values (notmuch_message_t *message,
317 const char *subject);
320 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
323 _notmuch_message_sync (notmuch_message_t *message);
326 _notmuch_message_delete (notmuch_message_t *message);
328 notmuch_private_status_t
329 _notmuch_message_initialize_ghost (notmuch_message_t *message,
330 const char *thread_id);
333 _notmuch_message_close (notmuch_message_t *message);
335 /* Get a copy of the data in this message document.
337 * Caller should talloc_free the result when done.
339 * This function is intended to support database upgrade and really
340 * shouldn't be used otherwise. */
342 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
344 /* Clear the data in this message document.
346 * This function is intended to support database upgrade and really
347 * shouldn't be used otherwise. */
349 _notmuch_message_clear_data (notmuch_message_t *message);
351 /* Set the author member of 'message' - this is the representation used
352 * when displaying the message */
354 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
356 /* Get the author member of 'message' */
358 _notmuch_message_get_author (notmuch_message_t *message);
362 /* XXX: I haven't decided yet whether these will actually get exported
363 * into the public interface in notmuch.h
366 typedef struct _notmuch_message_file notmuch_message_file_t;
368 /* Open a file containing a single email message.
370 * The caller should call notmuch_message_close when done with this.
372 * Returns NULL if any error occurs.
374 notmuch_message_file_t *
375 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
377 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
378 notmuch_message_file_t *
379 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
380 void *ctx, const char *filename);
382 /* Close a notmuch message previously opened with notmuch_message_open. */
384 _notmuch_message_file_close (notmuch_message_file_t *message);
386 /* Parse the message.
388 * This will be done automatically as necessary on other calls
389 * depending on it, but an explicit call allows for better error
393 _notmuch_message_file_parse (notmuch_message_file_t *message);
395 /* Get the gmime message of a message file.
397 * The message file is parsed as necessary.
399 * The GMimeMessage* is set to *mime_message on success (which the
400 * caller must not unref).
402 * XXX: Would be nice to not have to expose GMimeMessage here.
405 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
406 GMimeMessage **mime_message);
408 /* Get the value of the specified header from the message as a UTF-8 string.
410 * The message file is parsed as necessary.
412 * The header name is case insensitive.
414 * The Received: header is special - for it all Received: headers in
415 * the message are concatenated
417 * The returned value is owned by the notmuch message and is valid
418 * only until the message is closed. The caller should copy it if
419 * needing to modify the value or to hold onto it for longer.
421 * Returns NULL on errors, empty string if the message does not
422 * contain a header line matching 'header'.
425 _notmuch_message_file_get_header (notmuch_message_file_t *message,
429 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
430 const char **from_out,
431 const char **subject_out,
433 const char **date_out,
434 char **message_id_out);
437 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
442 _notmuch_message_index_file (notmuch_message_t *message,
443 notmuch_message_file_t *message_file);
447 typedef struct _notmuch_message_node {
448 notmuch_message_t *message;
449 struct _notmuch_message_node *next;
450 } notmuch_message_node_t;
452 typedef struct _notmuch_message_list {
453 notmuch_message_node_t *head;
454 notmuch_message_node_t **tail;
455 } notmuch_message_list_t;
457 /* There's a rumor that there's an alternate struct _notmuch_messages
458 * somewhere with some nasty C++ objects in it. We'll try to maintain
459 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
461 struct _notmuch_messages {
462 notmuch_bool_t is_of_list_type;
463 notmuch_doc_id_set_t *excluded_doc_ids;
464 notmuch_message_node_t *iterator;
467 notmuch_message_list_t *
468 _notmuch_message_list_create (const void *ctx);
471 _notmuch_message_list_add_message (notmuch_message_list_t *list,
472 notmuch_message_t *message);
475 _notmuch_messages_create (notmuch_message_list_t *list);
480 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
483 _notmuch_mset_messages_get (notmuch_messages_t *messages);
486 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
489 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
490 unsigned int doc_id);
493 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
494 unsigned int doc_id);
496 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
498 _notmuch_query_search_documents (notmuch_query_t *query,
500 notmuch_messages_t **out);
503 _notmuch_query_count_documents (notmuch_query_t *query,
505 unsigned *count_out);
508 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
509 * comments, and the '<' and '>' delimiters.
511 * If not NULL, then *next will be made to point to the first character
512 * not parsed, (possibly pointing to the final '\0' terminator.
514 * Returns a newly talloc'ed string belonging to 'ctx'.
516 * Returns NULL if there is any error parsing the message-id. */
518 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
524 _notmuch_message_add_reply (notmuch_message_t *message,
525 notmuch_message_t *reply);
527 _notmuch_message_database (notmuch_message_t *message);
532 _notmuch_sha1_of_string (const char *str);
535 _notmuch_sha1_of_file (const char *filename);
539 typedef struct _notmuch_string_node {
541 struct _notmuch_string_node *next;
542 } notmuch_string_node_t;
544 typedef struct _notmuch_string_list {
546 notmuch_string_node_t *head;
547 notmuch_string_node_t **tail;
548 } notmuch_string_list_t;
550 notmuch_string_list_t *
551 _notmuch_string_list_create (const void *ctx);
554 * return the number of strings in 'list'
557 _notmuch_string_list_length (notmuch_string_list_t *list);
559 /* Add 'string' to 'list'.
561 * The list will create its own talloced copy of 'string'.
564 _notmuch_string_list_append (notmuch_string_list_t *list,
568 _notmuch_string_list_sort (notmuch_string_list_t *list);
571 typedef struct _notmuch_string_map notmuch_string_map_t;
572 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
573 notmuch_string_map_t *
574 _notmuch_string_map_create (const void *ctx);
577 _notmuch_string_map_append (notmuch_string_map_t *map,
582 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
584 notmuch_string_map_iterator_t *
585 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
586 notmuch_bool_t exact);
589 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
592 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
595 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
598 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
601 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
606 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
610 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
612 notmuch_filenames_t *
613 _notmuch_filenames_create (const void *ctx,
614 notmuch_string_list_t *list);
619 _notmuch_thread_create (void *ctx,
620 notmuch_database_t *notmuch,
621 unsigned int seed_doc_id,
622 notmuch_doc_id_set_t *match_set,
623 notmuch_string_list_t *excluded_terms,
624 notmuch_exclude_t omit_exclude,
625 notmuch_sort_t sort);
630 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
631 * C++. In talloc_steal, an explicit cast is provided for type safety
632 * in some GCC versions. Otherwise, a cast is required. Provide a
633 * template function for this to maintain type safety, and redefine
634 * talloc_steal to use it.
637 template <class T> T *
638 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
640 return static_cast<T *> (talloc_steal (new_ctx, ptr));
643 #define talloc_steal _notmuch_talloc_steal