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 http://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"
54 #pragma GCC visibility push(hidden)
57 # define DEBUG_DATABASE_SANITY 1
58 # define DEBUG_QUERY 1
61 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
63 #define STRNCMP_LITERAL(var, literal) \
64 strncmp ((var), (literal), sizeof (literal) - 1)
66 /* Robust bit test/set/reset macros */
67 #define NOTMUCH_TEST_BIT(val, bit) \
68 (((bit) < 0 || (bit) >= CHAR_BIT * sizeof (unsigned long long)) ? 0 \
69 : !!((val) & (1ull << (bit))))
70 #define NOTMUCH_SET_BIT(valp, bit) \
71 (((bit) < 0 || (bit) >= CHAR_BIT * sizeof (unsigned long long)) ? *(valp) \
72 : (*(valp) |= (1ull << (bit))))
73 #define NOTMUCH_CLEAR_BIT(valp, bit) \
74 (((bit) < 0 || (bit) >= CHAR_BIT * sizeof (unsigned long long)) ? *(valp) \
75 : (*(valp) &= ~(1ull << (bit))))
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
114 /* Xapian (with flint backend) complains if we provide a term longer
115 * than this, but I haven't yet found a way to query the limit
116 * programmatically. */
117 #define NOTMUCH_TERM_MAX 245
119 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
121 /* For message IDs we have to be even more restrictive. Beyond fitting
122 * into the term limit, we also use message IDs to construct
123 * metadata-key values. And the documentation says that these should
124 * be restricted to about 200 characters. (The actual limit for the
125 * chert backend at least is 252.)
127 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
129 typedef enum _notmuch_private_status {
130 /* First, copy all the public status values. */
131 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
132 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
133 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
134 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
135 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
136 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
137 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
138 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
140 /* Then add our own private values. */
141 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
142 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
144 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
145 } notmuch_private_status_t;
147 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
148 * value, generating an internal error if the private value is equal
149 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
150 * that the caller has previously handled any expected
151 * notmuch_private_status_t values.)
153 * Note that the function _internal_error does not return. Evaluating
154 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
156 #define COERCE_STATUS(private_status, format, ...) \
157 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
159 _internal_error (format " (%s).\n", \
162 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
164 (notmuch_status_t) private_status)
166 /* Flags shared by various lookup functions. */
167 typedef enum _notmuch_find_flags {
168 /* Lookup without creating any documents. This is the default
170 NOTMUCH_FIND_LOOKUP = 0,
171 /* If set, create the necessary document (or documents) if they
172 * are missing. Requires a read/write database. */
173 NOTMUCH_FIND_CREATE = 1<<0,
174 } notmuch_find_flags_t;
176 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
180 /* Lookup a prefix value by name.
182 * XXX: This should really be static inside of message.cc, and we can
183 * do that once we convert database.cc to use the
184 * _notmuch_message_add/remove_term functions. */
186 _find_prefix (const char *name);
189 _notmuch_message_id_compressed (void *ctx, const char *message_id);
192 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
195 _notmuch_database_relative_path (notmuch_database_t *notmuch,
199 _notmuch_database_split_path (void *ctx,
201 const char **directory,
202 const char **basename);
205 _notmuch_database_get_directory_db_path (const char *path);
208 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
210 notmuch_private_status_t
211 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
212 const char *prefix_name,
214 unsigned int *doc_id);
217 _notmuch_database_find_directory_id (notmuch_database_t *database,
219 notmuch_find_flags_t flags,
220 unsigned int *directory_id);
223 _notmuch_database_get_directory_path (void *ctx,
224 notmuch_database_t *notmuch,
225 unsigned int doc_id);
228 _notmuch_database_filename_to_direntry (void *ctx,
229 notmuch_database_t *notmuch,
230 const char *filename,
231 notmuch_find_flags_t flags,
236 notmuch_directory_t *
237 _notmuch_directory_create (notmuch_database_t *notmuch,
239 notmuch_find_flags_t flags,
240 notmuch_status_t *status_ret);
243 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
248 _notmuch_message_create (const void *talloc_owner,
249 notmuch_database_t *notmuch,
251 notmuch_private_status_t *status);
254 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
255 const char *message_id,
256 notmuch_private_status_t *status);
259 _notmuch_message_get_doc_id (notmuch_message_t *message);
262 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
264 notmuch_private_status_t
265 _notmuch_message_add_term (notmuch_message_t *message,
266 const char *prefix_name,
269 notmuch_private_status_t
270 _notmuch_message_remove_term (notmuch_message_t *message,
271 const char *prefix_name,
274 notmuch_private_status_t
275 _notmuch_message_gen_terms (notmuch_message_t *message,
276 const char *prefix_name,
280 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
283 _notmuch_message_upgrade_folder (notmuch_message_t *message);
286 _notmuch_message_add_filename (notmuch_message_t *message,
287 const char *filename);
290 _notmuch_message_remove_filename (notmuch_message_t *message,
291 const char *filename);
294 _notmuch_message_rename (notmuch_message_t *message,
295 const char *new_filename);
298 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
301 _notmuch_message_set_header_values (notmuch_message_t *message,
304 const char *subject);
306 _notmuch_message_sync (notmuch_message_t *message);
309 _notmuch_message_delete (notmuch_message_t *message);
311 notmuch_private_status_t
312 _notmuch_message_initialize_ghost (notmuch_message_t *message,
313 const char *thread_id);
316 _notmuch_message_close (notmuch_message_t *message);
318 /* Get a copy of the data in this message document.
320 * Caller should talloc_free the result when done.
322 * This function is intended to support database upgrade and really
323 * shouldn't be used otherwise. */
325 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
327 /* Clear the data in this message document.
329 * This function is intended to support database upgrade and really
330 * shouldn't be used otherwise. */
332 _notmuch_message_clear_data (notmuch_message_t *message);
334 /* Set the author member of 'message' - this is the representation used
335 * when displaying the message */
337 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
339 /* Get the author member of 'message' */
341 _notmuch_message_get_author (notmuch_message_t *message);
345 /* XXX: I haven't decided yet whether these will actually get exported
346 * into the public interface in notmuch.h
349 typedef struct _notmuch_message_file notmuch_message_file_t;
351 /* Open a file containing a single email message.
353 * The caller should call notmuch_message_close when done with this.
355 * Returns NULL if any error occurs.
357 notmuch_message_file_t *
358 _notmuch_message_file_open (const char *filename);
360 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
361 notmuch_message_file_t *
362 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
364 /* Close a notmuch message previously opened with notmuch_message_open. */
366 _notmuch_message_file_close (notmuch_message_file_t *message);
368 /* Parse the message.
370 * This will be done automatically as necessary on other calls
371 * depending on it, but an explicit call allows for better error
375 _notmuch_message_file_parse (notmuch_message_file_t *message);
377 /* Get the gmime message of a message file.
379 * The message file is parsed as necessary.
381 * The GMimeMessage* is set to *mime_message on success (which the
382 * caller must not unref).
384 * XXX: Would be nice to not have to expose GMimeMessage here.
387 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
388 GMimeMessage **mime_message);
390 /* Get the value of the specified header from the message as a UTF-8 string.
392 * The message file is parsed as necessary.
394 * The header name is case insensitive.
396 * The Received: header is special - for it all Received: headers in
397 * the message are concatenated
399 * The returned value is owned by the notmuch message and is valid
400 * only until the message is closed. The caller should copy it if
401 * needing to modify the value or to hold onto it for longer.
403 * Returns NULL on errors, empty string if the message does not
404 * contain a header line matching 'header'.
407 _notmuch_message_file_get_header (notmuch_message_file_t *message,
413 _notmuch_message_index_file (notmuch_message_t *message,
414 notmuch_message_file_t *message_file);
418 typedef struct _notmuch_message_node {
419 notmuch_message_t *message;
420 struct _notmuch_message_node *next;
421 } notmuch_message_node_t;
423 typedef struct _notmuch_message_list {
424 notmuch_message_node_t *head;
425 notmuch_message_node_t **tail;
426 } notmuch_message_list_t;
428 /* There's a rumor that there's an alternate struct _notmuch_messages
429 * somewhere with some nasty C++ objects in it. We'll try to maintain
430 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
432 struct visible _notmuch_messages {
433 notmuch_bool_t is_of_list_type;
434 notmuch_doc_id_set_t *excluded_doc_ids;
435 notmuch_message_node_t *iterator;
438 notmuch_message_list_t *
439 _notmuch_message_list_create (const void *ctx);
442 _notmuch_message_list_add_message (notmuch_message_list_t *list,
443 notmuch_message_t *message);
446 _notmuch_messages_create (notmuch_message_list_t *list);
451 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
454 _notmuch_mset_messages_get (notmuch_messages_t *messages);
457 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
460 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
461 unsigned int doc_id);
464 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
465 unsigned int doc_id);
470 _notmuch_message_add_reply (notmuch_message_t *message,
471 notmuch_message_t *reply);
476 _notmuch_sha1_of_string (const char *str);
479 _notmuch_sha1_of_file (const char *filename);
483 typedef struct _notmuch_string_node {
485 struct _notmuch_string_node *next;
486 } notmuch_string_node_t;
488 typedef struct visible _notmuch_string_list {
490 notmuch_string_node_t *head;
491 notmuch_string_node_t **tail;
492 } notmuch_string_list_t;
494 notmuch_string_list_t *
495 _notmuch_string_list_create (const void *ctx);
497 /* Add 'string' to 'list'.
499 * The list will create its own talloced copy of 'string'.
502 _notmuch_string_list_append (notmuch_string_list_t *list,
506 _notmuch_string_list_sort (notmuch_string_list_t *list);
511 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
515 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
517 notmuch_filenames_t *
518 _notmuch_filenames_create (const void *ctx,
519 notmuch_string_list_t *list);
524 _notmuch_thread_create (void *ctx,
525 notmuch_database_t *notmuch,
526 unsigned int seed_doc_id,
527 notmuch_doc_id_set_t *match_set,
528 notmuch_string_list_t *excluded_terms,
529 notmuch_exclude_t omit_exclude,
530 notmuch_sort_t sort);
535 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
536 * C++. In talloc_steal, an explicit cast is provided for type safety
537 * in some GCC versions. Otherwise, a cast is required. Provide a
538 * template function for this to maintain type safety, and redefine
539 * talloc_steal to use it.
542 template <class T> T *
543 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
545 return static_cast<T *> (talloc_steal (new_ctx, ptr));
548 #define talloc_steal _notmuch_talloc_steal
552 #pragma GCC visibility pop