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 #define unused(x) x __attribute__ ((unused))
69 # define visible __attribute__((visibility("default")))
74 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
75 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
77 /* these macros gain us a few percent of speed on gcc */
79 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
80 as its first argument */
82 #define likely(x) __builtin_expect(!!(x), 1)
85 #define unlikely(x) __builtin_expect(!!(x), 0)
92 #define unlikely(x) (x)
97 NOTMUCH_VALUE_TIMESTAMP = 0,
98 NOTMUCH_VALUE_MESSAGE_ID,
100 NOTMUCH_VALUE_SUBJECT
103 /* Xapian (with flint backend) complains if we provide a term longer
104 * than this, but I haven't yet found a way to query the limit
105 * programmatically. */
106 #define NOTMUCH_TERM_MAX 245
108 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
110 /* For message IDs we have to be even more restrictive. Beyond fitting
111 * into the term limit, we also use message IDs to construct
112 * metadata-key values. And the documentation says that these should
113 * be restricted to about 200 characters. (The actual limit for the
114 * chert backend at least is 252.)
116 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
118 typedef enum _notmuch_private_status {
119 /* First, copy all the public status values. */
120 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
121 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
122 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
123 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
124 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
125 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
126 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
127 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
129 /* Then add our own private values. */
130 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
131 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
133 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
134 } notmuch_private_status_t;
136 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
137 * value, generating an internal error if the private value is equal
138 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
139 * that the caller has previously handled any expected
140 * notmuch_private_status_t values.)
142 * Note that the function _internal_error does not return. Evaluating
143 * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
145 #define COERCE_STATUS(private_status, format, ...) \
146 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
148 _internal_error (format " (%s).\n", \
151 (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \
153 (notmuch_status_t) private_status)
155 /* Flags shared by various lookup functions. */
156 typedef enum _notmuch_find_flags {
157 /* Lookup without creating any documents. This is the default
159 NOTMUCH_FIND_LOOKUP = 0,
160 /* If set, create the necessary document (or documents) if they
161 * are missing. Requires a read/write database. */
162 NOTMUCH_FIND_CREATE = 1<<0,
163 } notmuch_find_flags_t;
165 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
169 /* Lookup a prefix value by name.
171 * XXX: This should really be static inside of message.cc, and we can
172 * do that once we convert database.cc to use the
173 * _notmuch_message_add/remove_term functions. */
175 _find_prefix (const char *name);
178 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
181 _notmuch_database_relative_path (notmuch_database_t *notmuch,
185 _notmuch_database_split_path (void *ctx,
187 const char **directory,
188 const char **basename);
191 _notmuch_database_get_directory_db_path (const char *path);
194 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
196 notmuch_private_status_t
197 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
198 const char *prefix_name,
200 unsigned int *doc_id);
203 _notmuch_database_find_directory_id (notmuch_database_t *database,
205 notmuch_find_flags_t flags,
206 unsigned int *directory_id);
209 _notmuch_database_get_directory_path (void *ctx,
210 notmuch_database_t *notmuch,
211 unsigned int doc_id);
214 _notmuch_database_filename_to_direntry (void *ctx,
215 notmuch_database_t *notmuch,
216 const char *filename,
217 notmuch_find_flags_t flags,
222 notmuch_directory_t *
223 _notmuch_directory_create (notmuch_database_t *notmuch,
225 notmuch_find_flags_t flags,
226 notmuch_status_t *status_ret);
229 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
234 _notmuch_message_create (const void *talloc_owner,
235 notmuch_database_t *notmuch,
237 notmuch_private_status_t *status);
240 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
241 const char *message_id,
242 notmuch_private_status_t *status);
245 _notmuch_message_get_doc_id (notmuch_message_t *message);
248 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
250 notmuch_private_status_t
251 _notmuch_message_add_term (notmuch_message_t *message,
252 const char *prefix_name,
255 notmuch_private_status_t
256 _notmuch_message_remove_term (notmuch_message_t *message,
257 const char *prefix_name,
260 notmuch_private_status_t
261 _notmuch_message_gen_terms (notmuch_message_t *message,
262 const char *prefix_name,
266 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
269 _notmuch_message_upgrade_folder (notmuch_message_t *message);
272 _notmuch_message_add_filename (notmuch_message_t *message,
273 const char *filename);
276 _notmuch_message_remove_filename (notmuch_message_t *message,
277 const char *filename);
280 _notmuch_message_rename (notmuch_message_t *message,
281 const char *new_filename);
284 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
287 _notmuch_message_set_header_values (notmuch_message_t *message,
290 const char *subject);
292 _notmuch_message_sync (notmuch_message_t *message);
295 _notmuch_message_delete (notmuch_message_t *message);
298 _notmuch_message_close (notmuch_message_t *message);
300 /* Get a copy of the data in this message document.
302 * Caller should talloc_free the result when done.
304 * This function is intended to support database upgrade and really
305 * shouldn't be used otherwise. */
307 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
309 /* Clear the data in this message document.
311 * This function is intended to support database upgrade and really
312 * shouldn't be used otherwise. */
314 _notmuch_message_clear_data (notmuch_message_t *message);
316 /* Set the author member of 'message' - this is the representation used
317 * when displaying the message */
319 notmuch_message_set_author (notmuch_message_t *message, const char *author);
321 /* Get the author member of 'message' */
323 notmuch_message_get_author (notmuch_message_t *message);
327 /* XXX: I haven't decided yet whether these will actually get exported
328 * into the public interface in notmuch.h
331 typedef struct _notmuch_message_file notmuch_message_file_t;
333 /* Open a file containing a single email message.
335 * The caller should call notmuch_message_close when done with this.
337 * Returns NULL if any error occurs.
339 notmuch_message_file_t *
340 notmuch_message_file_open (const char *filename);
342 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
343 notmuch_message_file_t *
344 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
346 /* Close a notmuch message previously opened with notmuch_message_open. */
348 notmuch_message_file_close (notmuch_message_file_t *message);
350 /* Parse the message.
352 * This will be done automatically as necessary on other calls
353 * depending on it, but an explicit call allows for better error
357 _notmuch_message_file_parse (notmuch_message_file_t *message);
359 /* Get the gmime message of a message file.
361 * The message file is parsed as necessary.
363 * The GMimeMessage* is set to *mime_message on success (which the
364 * caller must not unref).
366 * XXX: Would be nice to not have to expose GMimeMessage here.
369 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
370 GMimeMessage **mime_message);
372 /* Get the value of the specified header from the message as a UTF-8 string.
374 * The message file is parsed as necessary.
376 * The header name is case insensitive.
378 * The Received: header is special - for it all Received: headers in
379 * the message are concatenated
381 * The returned value is owned by the notmuch message and is valid
382 * only until the message is closed. The caller should copy it if
383 * needing to modify the value or to hold onto it for longer.
385 * Returns NULL on errors, empty string if the message does not
386 * contain a header line matching 'header'.
389 notmuch_message_file_get_header (notmuch_message_file_t *message,
395 _notmuch_message_index_file (notmuch_message_t *message,
396 notmuch_message_file_t *message_file);
400 typedef struct _notmuch_message_node {
401 notmuch_message_t *message;
402 struct _notmuch_message_node *next;
403 } notmuch_message_node_t;
405 typedef struct _notmuch_message_list {
406 notmuch_message_node_t *head;
407 notmuch_message_node_t **tail;
408 } notmuch_message_list_t;
410 /* There's a rumor that there's an alternate struct _notmuch_messages
411 * somewhere with some nasty C++ objects in it. We'll try to maintain
412 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
414 struct visible _notmuch_messages {
415 notmuch_bool_t is_of_list_type;
416 notmuch_doc_id_set_t *excluded_doc_ids;
417 notmuch_message_node_t *iterator;
420 notmuch_message_list_t *
421 _notmuch_message_list_create (const void *ctx);
424 _notmuch_message_list_add_message (notmuch_message_list_t *list,
425 notmuch_message_t *message);
428 _notmuch_messages_create (notmuch_message_list_t *list);
433 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
436 _notmuch_mset_messages_get (notmuch_messages_t *messages);
439 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
442 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
443 unsigned int doc_id);
446 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
447 unsigned int doc_id);
452 _notmuch_message_add_reply (notmuch_message_t *message,
453 notmuch_message_t *reply);
458 notmuch_sha1_of_string (const char *str);
461 notmuch_sha1_of_file (const char *filename);
465 typedef struct _notmuch_string_node {
467 struct _notmuch_string_node *next;
468 } notmuch_string_node_t;
470 typedef struct visible _notmuch_string_list {
472 notmuch_string_node_t *head;
473 notmuch_string_node_t **tail;
474 } notmuch_string_list_t;
476 notmuch_string_list_t *
477 _notmuch_string_list_create (const void *ctx);
479 /* Add 'string' to 'list'.
481 * The list will create its own talloced copy of 'string'.
484 _notmuch_string_list_append (notmuch_string_list_t *list,
488 _notmuch_string_list_sort (notmuch_string_list_t *list);
493 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
497 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
499 notmuch_filenames_t *
500 _notmuch_filenames_create (const void *ctx,
501 notmuch_string_list_t *list);
506 _notmuch_thread_create (void *ctx,
507 notmuch_database_t *notmuch,
508 unsigned int seed_doc_id,
509 notmuch_doc_id_set_t *match_set,
510 notmuch_string_list_t *excluded_terms,
511 notmuch_exclude_t omit_exclude,
512 notmuch_sort_t sort);
517 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
518 * C++. In talloc_steal, an explicit cast is provided for type safety
519 * in some GCC versions. Otherwise, a cast is required. Provide a
520 * template function for this to maintain type safety, and redefine
521 * talloc_steal to use it.
524 template <class T> T *
525 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
527 return static_cast<T *> (talloc_steal (new_ctx, ptr));
530 #define talloc_steal _notmuch_talloc_steal
534 #pragma GCC visibility pop