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/gmime.h>
52 #include "error_util.h"
53 #include "string-util.h"
55 #pragma GCC visibility push(hidden)
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))
80 # define visible __attribute__((visibility("default")))
85 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
86 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
88 /* these macros gain us a few percent of speed on gcc */
90 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
91 as its first argument */
93 #define likely(x) __builtin_expect(!!(x), 1)
96 #define unlikely(x) __builtin_expect(!!(x), 0)
100 #define likely(x) (x)
103 #define unlikely(x) (x)
108 NOTMUCH_VALUE_TIMESTAMP = 0,
109 NOTMUCH_VALUE_MESSAGE_ID,
111 NOTMUCH_VALUE_SUBJECT,
112 NOTMUCH_VALUE_LAST_MOD,
115 /* Xapian (with flint backend) complains if we provide a term longer
116 * than this, but I haven't yet found a way to query the limit
117 * programmatically. */
118 #define NOTMUCH_TERM_MAX 245
120 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
122 /* For message IDs we have to be even more restrictive. Beyond fitting
123 * into the term limit, we also use message IDs to construct
124 * metadata-key values. And the documentation says that these should
125 * be restricted to about 200 characters. (The actual limit for the
126 * chert backend at least is 252.)
128 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
130 typedef enum _notmuch_private_status {
131 /* First, copy all the public status values. */
132 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
133 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
134 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
135 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
136 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
137 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
138 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
139 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
141 /* Then add our own private values. */
142 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
143 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
145 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
146 } notmuch_private_status_t;
148 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
149 * value, generating an internal error if the private value is equal
150 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
151 * that the caller has previously handled any expected
152 * notmuch_private_status_t values.)
154 * Note that the function _internal_error does not return. Evaluating
155 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
157 #define COERCE_STATUS(private_status, format, ...) \
158 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
160 _internal_error (format " (%s).\n", \
163 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
165 (notmuch_status_t) private_status)
167 /* Flags shared by various lookup functions. */
168 typedef enum _notmuch_find_flags {
169 /* Lookup without creating any documents. This is the default
171 NOTMUCH_FIND_LOOKUP = 0,
172 /* If set, create the necessary document (or documents) if they
173 * are missing. Requires a read/write database. */
174 NOTMUCH_FIND_CREATE = 1<<0,
175 } notmuch_find_flags_t;
177 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
181 /* Lookup a prefix value by name.
183 * XXX: This should really be static inside of message.cc, and we can
184 * do that once we convert database.cc to use the
185 * _notmuch_message_add/remove_term functions. */
187 _find_prefix (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_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);
263 _notmuch_message_create (const void *talloc_owner,
264 notmuch_database_t *notmuch,
266 notmuch_private_status_t *status);
269 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
270 const char *message_id,
271 notmuch_private_status_t *status);
274 _notmuch_message_get_doc_id (notmuch_message_t *message);
277 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
279 notmuch_private_status_t
280 _notmuch_message_add_term (notmuch_message_t *message,
281 const char *prefix_name,
284 notmuch_private_status_t
285 _notmuch_message_remove_term (notmuch_message_t *message,
286 const char *prefix_name,
289 notmuch_private_status_t
290 _notmuch_message_has_term (notmuch_message_t *message,
291 const char *prefix_name,
293 notmuch_bool_t *result);
295 notmuch_private_status_t
296 _notmuch_message_gen_terms (notmuch_message_t *message,
297 const char *prefix_name,
301 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
304 _notmuch_message_upgrade_folder (notmuch_message_t *message);
307 _notmuch_message_add_filename (notmuch_message_t *message,
308 const char *filename);
311 _notmuch_message_remove_filename (notmuch_message_t *message,
312 const char *filename);
315 _notmuch_message_rename (notmuch_message_t *message,
316 const char *new_filename);
319 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
322 _notmuch_message_set_header_values (notmuch_message_t *message,
325 const char *subject);
328 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
331 _notmuch_message_sync (notmuch_message_t *message);
334 _notmuch_message_delete (notmuch_message_t *message);
336 notmuch_private_status_t
337 _notmuch_message_initialize_ghost (notmuch_message_t *message,
338 const char *thread_id);
341 _notmuch_message_close (notmuch_message_t *message);
343 /* Get a copy of the data in this message document.
345 * Caller should talloc_free the result when done.
347 * This function is intended to support database upgrade and really
348 * shouldn't be used otherwise. */
350 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
352 /* Clear the data in this message document.
354 * This function is intended to support database upgrade and really
355 * shouldn't be used otherwise. */
357 _notmuch_message_clear_data (notmuch_message_t *message);
359 /* Set the author member of 'message' - this is the representation used
360 * when displaying the message */
362 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
364 /* Get the author member of 'message' */
366 _notmuch_message_get_author (notmuch_message_t *message);
370 /* XXX: I haven't decided yet whether these will actually get exported
371 * into the public interface in notmuch.h
374 typedef struct _notmuch_message_file notmuch_message_file_t;
376 /* Open a file containing a single email message.
378 * The caller should call notmuch_message_close when done with this.
380 * Returns NULL if any error occurs.
382 notmuch_message_file_t *
383 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
385 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
386 notmuch_message_file_t *
387 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
388 void *ctx, const char *filename);
390 /* Close a notmuch message previously opened with notmuch_message_open. */
392 _notmuch_message_file_close (notmuch_message_file_t *message);
394 /* Parse the message.
396 * This will be done automatically as necessary on other calls
397 * depending on it, but an explicit call allows for better error
401 _notmuch_message_file_parse (notmuch_message_file_t *message);
403 /* Get the gmime message of a message file.
405 * The message file is parsed as necessary.
407 * The GMimeMessage* is set to *mime_message on success (which the
408 * caller must not unref).
410 * XXX: Would be nice to not have to expose GMimeMessage here.
413 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
414 GMimeMessage **mime_message);
416 /* Get the value of the specified header from the message as a UTF-8 string.
418 * The message file is parsed as necessary.
420 * The header name is case insensitive.
422 * The Received: header is special - for it all Received: headers in
423 * the message are concatenated
425 * The returned value is owned by the notmuch message and is valid
426 * only until the message is closed. The caller should copy it if
427 * needing to modify the value or to hold onto it for longer.
429 * Returns NULL on errors, empty string if the message does not
430 * contain a header line matching 'header'.
433 _notmuch_message_file_get_header (notmuch_message_file_t *message,
439 _notmuch_message_index_file (notmuch_message_t *message,
440 notmuch_message_file_t *message_file);
444 typedef struct _notmuch_message_node {
445 notmuch_message_t *message;
446 struct _notmuch_message_node *next;
447 } notmuch_message_node_t;
449 typedef struct _notmuch_message_list {
450 notmuch_message_node_t *head;
451 notmuch_message_node_t **tail;
452 } notmuch_message_list_t;
454 /* There's a rumor that there's an alternate struct _notmuch_messages
455 * somewhere with some nasty C++ objects in it. We'll try to maintain
456 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
458 struct visible _notmuch_messages {
459 notmuch_bool_t is_of_list_type;
460 notmuch_doc_id_set_t *excluded_doc_ids;
461 notmuch_message_node_t *iterator;
464 notmuch_message_list_t *
465 _notmuch_message_list_create (const void *ctx);
468 _notmuch_message_list_add_message (notmuch_message_list_t *list,
469 notmuch_message_t *message);
472 _notmuch_messages_create (notmuch_message_list_t *list);
477 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
480 _notmuch_mset_messages_get (notmuch_messages_t *messages);
483 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
486 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
487 unsigned int doc_id);
490 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
491 unsigned int doc_id);
493 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
495 _notmuch_query_search_documents (notmuch_query_t *query,
497 notmuch_messages_t **out);
500 _notmuch_query_count_documents (notmuch_query_t *query,
502 unsigned *count_out);
507 _notmuch_message_add_reply (notmuch_message_t *message,
508 notmuch_message_t *reply);
510 _notmuch_message_database (notmuch_message_t *message);
515 _notmuch_sha1_of_string (const char *str);
518 _notmuch_sha1_of_file (const char *filename);
522 typedef struct _notmuch_string_node {
524 struct _notmuch_string_node *next;
525 } notmuch_string_node_t;
527 typedef struct visible _notmuch_string_list {
529 notmuch_string_node_t *head;
530 notmuch_string_node_t **tail;
531 } notmuch_string_list_t;
533 notmuch_string_list_t *
534 _notmuch_string_list_create (const void *ctx);
536 /* Add 'string' to 'list'.
538 * The list will create its own talloced copy of 'string'.
541 _notmuch_string_list_append (notmuch_string_list_t *list,
545 _notmuch_string_list_sort (notmuch_string_list_t *list);
548 typedef struct _notmuch_string_map notmuch_string_map_t;
549 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
550 notmuch_string_map_t *
551 _notmuch_string_map_create (const void *ctx);
554 _notmuch_string_map_append (notmuch_string_map_t *map,
559 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
561 notmuch_string_map_iterator_t *
562 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
563 notmuch_bool_t exact);
566 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
569 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
572 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
575 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
578 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
583 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
587 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
589 notmuch_filenames_t *
590 _notmuch_filenames_create (const void *ctx,
591 notmuch_string_list_t *list);
596 _notmuch_thread_create (void *ctx,
597 notmuch_database_t *notmuch,
598 unsigned int seed_doc_id,
599 notmuch_doc_id_set_t *match_set,
600 notmuch_string_list_t *excluded_terms,
601 notmuch_exclude_t omit_exclude,
602 notmuch_sort_t sort);
607 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
608 * C++. In talloc_steal, an explicit cast is provided for type safety
609 * in some GCC versions. Otherwise, a cast is required. Provide a
610 * template function for this to maintain type safety, and redefine
611 * talloc_steal to use it.
614 template <class T> T *
615 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
617 return static_cast<T *> (talloc_steal (new_ctx, ptr));
620 #define talloc_steal _notmuch_talloc_steal
624 #pragma GCC visibility pop