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"
58 # define DEBUG_DATABASE_SANITY 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,
139 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
140 } notmuch_private_status_t;
142 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
143 * value, generating an internal error if the private value is equal
144 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
145 * that the caller has previously handled any expected
146 * notmuch_private_status_t values.)
148 * Note that the function _internal_error does not return. Evaluating
149 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
151 #define COERCE_STATUS(private_status, format, ...) \
152 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
154 _internal_error (format " (%s).\n", \
157 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
159 (notmuch_status_t) private_status)
161 /* Flags shared by various lookup functions. */
162 typedef enum _notmuch_find_flags {
163 /* Lookup without creating any documents. This is the default
165 NOTMUCH_FIND_LOOKUP = 0,
166 /* If set, create the necessary document (or documents) if they
167 * are missing. Requires a read/write database. */
168 NOTMUCH_FIND_CREATE = 1<<0,
169 } notmuch_find_flags_t;
171 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
175 /* Lookup a prefix value by name.
177 * XXX: This should really be static inside of message.cc, and we can
178 * do that once we convert database.cc to use the
179 * _notmuch_message_add/remove_term functions. */
181 _find_prefix (const char *name);
184 _notmuch_message_id_compressed (void *ctx, const char *message_id);
187 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
190 _notmuch_database_reopen (notmuch_database_t *notmuch);
193 _notmuch_database_log (notmuch_database_t *notmuch,
194 const char *format, ...);
197 _notmuch_database_log_append (notmuch_database_t *notmuch,
198 const char *format, ...);
201 _notmuch_database_new_revision (notmuch_database_t *notmuch);
204 _notmuch_database_relative_path (notmuch_database_t *notmuch,
208 _notmuch_database_split_path (void *ctx,
210 const char **directory,
211 const char **basename);
214 _notmuch_database_get_directory_db_path (const char *path);
217 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
219 notmuch_private_status_t
220 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
221 const char *prefix_name,
223 unsigned int *doc_id);
226 _notmuch_database_find_directory_id (notmuch_database_t *database,
228 notmuch_find_flags_t flags,
229 unsigned int *directory_id);
232 _notmuch_database_get_directory_path (void *ctx,
233 notmuch_database_t *notmuch,
234 unsigned int doc_id);
237 _notmuch_database_filename_to_direntry (void *ctx,
238 notmuch_database_t *notmuch,
239 const char *filename,
240 notmuch_find_flags_t flags,
245 notmuch_directory_t *
246 _notmuch_directory_create (notmuch_database_t *notmuch,
248 notmuch_find_flags_t flags,
249 notmuch_status_t *status_ret);
252 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
257 _notmuch_message_create (const void *talloc_owner,
258 notmuch_database_t *notmuch,
260 notmuch_private_status_t *status);
263 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
264 const char *message_id,
265 notmuch_private_status_t *status);
268 _notmuch_message_get_doc_id (notmuch_message_t *message);
271 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
273 notmuch_private_status_t
274 _notmuch_message_add_term (notmuch_message_t *message,
275 const char *prefix_name,
278 notmuch_private_status_t
279 _notmuch_message_remove_term (notmuch_message_t *message,
280 const char *prefix_name,
283 notmuch_private_status_t
284 _notmuch_message_has_term (notmuch_message_t *message,
285 const char *prefix_name,
289 notmuch_private_status_t
290 _notmuch_message_gen_terms (notmuch_message_t *message,
291 const char *prefix_name,
295 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
298 _notmuch_message_upgrade_folder (notmuch_message_t *message);
301 _notmuch_message_add_filename (notmuch_message_t *message,
302 const char *filename);
305 _notmuch_message_remove_filename (notmuch_message_t *message,
306 const char *filename);
309 _notmuch_message_rename (notmuch_message_t *message,
310 const char *new_filename);
313 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
316 _notmuch_message_set_header_values (notmuch_message_t *message,
319 const char *subject);
322 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
325 _notmuch_message_sync (notmuch_message_t *message);
328 _notmuch_message_delete (notmuch_message_t *message);
330 notmuch_private_status_t
331 _notmuch_message_initialize_ghost (notmuch_message_t *message,
332 const char *thread_id);
335 _notmuch_message_close (notmuch_message_t *message);
337 /* Get a copy of the data in this message document.
339 * Caller should talloc_free the result when done.
341 * This function is intended to support database upgrade and really
342 * shouldn't be used otherwise. */
344 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
346 /* Clear the data in this message document.
348 * This function is intended to support database upgrade and really
349 * shouldn't be used otherwise. */
351 _notmuch_message_clear_data (notmuch_message_t *message);
353 /* Set the author member of 'message' - this is the representation used
354 * when displaying the message */
356 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
358 /* Get the author member of 'message' */
360 _notmuch_message_get_author (notmuch_message_t *message);
364 /* XXX: I haven't decided yet whether these will actually get exported
365 * into the public interface in notmuch.h
368 typedef struct _notmuch_message_file notmuch_message_file_t;
370 /* Open a file containing a single email message.
372 * The caller should call notmuch_message_close when done with this.
374 * Returns NULL if any error occurs.
376 notmuch_message_file_t *
377 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
379 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
380 notmuch_message_file_t *
381 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
382 void *ctx, const char *filename);
384 /* Close a notmuch message previously opened with notmuch_message_open. */
386 _notmuch_message_file_close (notmuch_message_file_t *message);
388 /* Parse the message.
390 * This will be done automatically as necessary on other calls
391 * depending on it, but an explicit call allows for better error
395 _notmuch_message_file_parse (notmuch_message_file_t *message);
397 /* Get the gmime message of a message file.
399 * The message file is parsed as necessary.
401 * The GMimeMessage* is set to *mime_message on success (which the
402 * caller must not unref).
404 * XXX: Would be nice to not have to expose GMimeMessage here.
407 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
408 GMimeMessage **mime_message);
410 /* Get the value of the specified header from the message as a UTF-8 string.
412 * The message file is parsed as necessary.
414 * The header name is case insensitive.
416 * The Received: header is special - for it all Received: headers in
417 * the message are concatenated
419 * The returned value is owned by the notmuch message and is valid
420 * only until the message is closed. The caller should copy it if
421 * needing to modify the value or to hold onto it for longer.
423 * Returns NULL on errors, empty string if the message does not
424 * contain a header line matching 'header'.
427 _notmuch_message_file_get_header (notmuch_message_file_t *message,
431 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
432 const char **from_out,
433 const char **subject_out,
435 const char **date_out,
436 char **message_id_out);
439 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
443 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
444 notmuch_message_t *message,
445 notmuch_message_file_t *message_file,
446 const char **thread_id);
450 _notmuch_message_index_file (notmuch_message_t *message,
451 notmuch_indexopts_t *indexopts,
452 notmuch_message_file_t *message_file);
456 typedef struct _notmuch_message_node {
457 notmuch_message_t *message;
458 struct _notmuch_message_node *next;
459 } notmuch_message_node_t;
461 typedef struct _notmuch_message_list {
462 notmuch_message_node_t *head;
463 notmuch_message_node_t **tail;
464 } notmuch_message_list_t;
466 /* There's a rumor that there's an alternate struct _notmuch_messages
467 * somewhere with some nasty C++ objects in it. We'll try to maintain
468 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
470 struct _notmuch_messages {
471 bool is_of_list_type;
472 notmuch_doc_id_set_t *excluded_doc_ids;
473 notmuch_message_node_t *iterator;
476 notmuch_message_list_t *
477 _notmuch_message_list_create (const void *ctx);
480 _notmuch_message_list_add_message (notmuch_message_list_t *list,
481 notmuch_message_t *message);
484 _notmuch_messages_create (notmuch_message_list_t *list);
489 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
492 _notmuch_mset_messages_get (notmuch_messages_t *messages);
495 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
498 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
499 unsigned int doc_id);
502 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
503 unsigned int doc_id);
505 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
507 _notmuch_query_search_documents (notmuch_query_t *query,
509 notmuch_messages_t **out);
512 _notmuch_query_count_documents (notmuch_query_t *query,
514 unsigned *count_out);
517 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
518 * comments, and the '<' and '>' delimiters.
520 * If not NULL, then *next will be made to point to the first character
521 * not parsed, (possibly pointing to the final '\0' terminator.
523 * Returns a newly talloc'ed string belonging to 'ctx'.
525 * Returns NULL if there is any error parsing the message-id. */
527 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
533 _notmuch_message_add_reply (notmuch_message_t *message,
534 notmuch_message_t *reply);
536 _notmuch_message_database (notmuch_message_t *message);
539 _notmuch_message_remove_unprefixed_terms (notmuch_message_t *message);
543 _notmuch_sha1_of_string (const char *str);
546 _notmuch_sha1_of_file (const char *filename);
550 typedef struct _notmuch_string_node {
552 struct _notmuch_string_node *next;
553 } notmuch_string_node_t;
555 typedef struct _notmuch_string_list {
557 notmuch_string_node_t *head;
558 notmuch_string_node_t **tail;
559 } notmuch_string_list_t;
561 notmuch_string_list_t *
562 _notmuch_string_list_create (const void *ctx);
565 * return the number of strings in 'list'
568 _notmuch_string_list_length (notmuch_string_list_t *list);
570 /* Add 'string' to 'list'.
572 * The list will create its own talloced copy of 'string'.
575 _notmuch_string_list_append (notmuch_string_list_t *list,
579 _notmuch_string_list_sort (notmuch_string_list_t *list);
582 typedef struct _notmuch_string_map notmuch_string_map_t;
583 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
584 notmuch_string_map_t *
585 _notmuch_string_map_create (const void *ctx);
588 _notmuch_string_map_append (notmuch_string_map_t *map,
593 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
595 notmuch_string_map_iterator_t *
596 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
600 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
603 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
606 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
609 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
612 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
617 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
621 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
623 notmuch_filenames_t *
624 _notmuch_filenames_create (const void *ctx,
625 notmuch_string_list_t *list);
630 _notmuch_thread_create (void *ctx,
631 notmuch_database_t *notmuch,
632 unsigned int seed_doc_id,
633 notmuch_doc_id_set_t *match_set,
634 notmuch_string_list_t *excluded_terms,
635 notmuch_exclude_t omit_exclude,
636 notmuch_sort_t sort);
640 struct _notmuch_indexopts {
641 _notmuch_crypto_t crypto;
647 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
648 * C++. In talloc_steal, an explicit cast is provided for type safety
649 * in some GCC versions. Otherwise, a cast is required. Provide a
650 * template function for this to maintain type safety, and redefine
651 * talloc_steal to use it.
654 template <class T> T *
655 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
657 return static_cast<T *> (talloc_steal (new_ctx, ptr));
660 #define talloc_steal _notmuch_talloc_steal