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>
51 #pragma GCC visibility push(hidden)
54 # define DEBUG_DATABASE_SANITY 1
55 # define DEBUG_QUERY 1
58 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
60 #define STRNCMP_LITERAL(var, literal) \
61 strncmp ((var), (literal), sizeof (literal) - 1)
63 /* There's no point in continuing when we've detected that we've done
64 * something wrong internally (as opposed to the user passing in a
67 * Note that PRINTF_ATTRIBUTE comes from talloc.h
70 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
72 /* There's no point in continuing when we've detected that we've done
73 * something wrong internally (as opposed to the user passing in a
76 * Note that __location__ comes from talloc.h.
78 #define INTERNAL_ERROR(format, ...) \
79 _internal_error (format " (%s).\n", \
80 ##__VA_ARGS__, __location__)
82 #define unused(x) x __attribute__ ((unused))
84 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
85 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
87 /* these macros gain us a few percent of speed on gcc */
89 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
90 as its first argument */
92 #define likely(x) __builtin_expect(!!(x), 1)
95 #define unlikely(x) __builtin_expect(!!(x), 0)
102 #define unlikely(x) (x)
107 NOTMUCH_VALUE_TIMESTAMP = 0,
108 NOTMUCH_VALUE_MESSAGE_ID
111 /* Xapian (with flint backend) complains if we provide a term longer
112 * than this, but I haven't yet found a way to query the limit
113 * programmatically. */
114 #define NOTMUCH_TERM_MAX 245
116 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
118 /* For message IDs we have to be even more restrictive. Beyond fitting
119 * into the term limit, we also use message IDs to construct
120 * metadata-key values. And the documentation says that these should
121 * be restricted to about 200 characters. (The actual limit for the
122 * chert backend at least is 252.)
124 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
126 typedef enum _notmuch_private_status {
127 /* First, copy all the public status values. */
128 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
129 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
130 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
131 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
132 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
133 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
134 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
135 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
137 /* Then add our own private values. */
138 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
139 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
141 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
142 } notmuch_private_status_t;
144 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
145 * value, generating an internal error if the private value is equal
146 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
147 * that the caller has previously handled any expected
148 * notmuch_private_status_t values.)
150 #define COERCE_STATUS(private_status, format, ...) \
151 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
153 (notmuch_status_t) _internal_error (format " (%s).\n", \
157 (notmuch_status_t) private_status)
159 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
163 /* Lookup a prefix value by name.
165 * XXX: This should really be static inside of message.cc, and we can
166 * do that once we convert database.cc to use the
167 * _notmuch_message_add/remove_term functions. */
169 _find_prefix (const char *name);
172 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
175 _notmuch_database_relative_path (notmuch_database_t *notmuch,
179 _notmuch_database_split_path (void *ctx,
181 const char **directory,
182 const char **basename);
185 _notmuch_database_get_directory_db_path (const char *path);
188 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
190 notmuch_private_status_t
191 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
192 const char *prefix_name,
194 unsigned int *doc_id);
197 _notmuch_database_find_directory_id (notmuch_database_t *database,
199 unsigned int *directory_id);
202 _notmuch_database_get_directory_path (void *ctx,
203 notmuch_database_t *notmuch,
204 unsigned int doc_id);
207 _notmuch_database_filename_to_direntry (void *ctx,
208 notmuch_database_t *notmuch,
209 const char *filename,
214 notmuch_directory_t *
215 _notmuch_directory_create (notmuch_database_t *notmuch,
217 notmuch_status_t *status_ret);
220 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
225 _notmuch_thread_create (void *ctx,
226 notmuch_database_t *notmuch,
227 unsigned int seed_doc_id,
228 notmuch_doc_id_set_t *match_set,
229 notmuch_sort_t sort);
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_add_filename (notmuch_message_t *message,
270 const char *filename);
273 _notmuch_message_remove_filename (notmuch_message_t *message,
274 const char *filename);
277 _notmuch_message_rename (notmuch_message_t *message,
278 const char *new_filename);
281 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
284 _notmuch_message_set_date (notmuch_message_t *message,
288 _notmuch_message_sync (notmuch_message_t *message);
291 _notmuch_message_close (notmuch_message_t *message);
293 /* Get a copy of the data in this message document.
295 * Caller should talloc_free the result when done.
297 * This function is intended to support database upgrade and really
298 * shouldn't be used otherwise. */
300 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
302 /* Clear the data in this message document.
304 * This function is intended to support database upgrade and really
305 * shouldn't be used otherwise. */
307 _notmuch_message_clear_data (notmuch_message_t *message);
309 /* Set the author member of 'message' - this is the representation used
310 * when displaying the message */
312 notmuch_message_set_author (notmuch_message_t *message, const char *author);
314 /* Get the author member of 'message' */
316 notmuch_message_get_author (notmuch_message_t *message);
322 _notmuch_message_index_file (notmuch_message_t *message,
323 const char *filename);
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 /* Restrict 'message' to only save the named headers.
352 * When the caller is only interested in a short list of headers,
353 * known in advance, calling this function can avoid wasted time and
354 * memory parsing/saving header values that will never be needed.
356 * The variable arguments should be a list of const char * with a
357 * final '(const char *) NULL' to terminate the list.
359 * If this function is called, it must be called before any calls to
360 * notmuch_message_get_header for this message.
362 * After calling this function, if notmuch_message_get_header is
363 * called with a header name not in this list, then NULL will be
364 * returned even if that header exists in the actual message.
367 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
369 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
371 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
374 /* Get the value of the specified header from the message.
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 if the message does not contain a header line matching
389 notmuch_message_file_get_header (notmuch_message_file_t *message,
394 typedef struct _notmuch_message_node {
395 notmuch_message_t *message;
396 struct _notmuch_message_node *next;
397 } notmuch_message_node_t;
399 typedef struct _notmuch_message_list {
400 notmuch_message_node_t *head;
401 notmuch_message_node_t **tail;
402 } notmuch_message_list_t;
404 /* There's a rumor that there's an alternate struct _notmuch_messages
405 * somewhere with some nasty C++ objects in it. We'll try to maintain
406 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
408 struct _notmuch_messages {
409 notmuch_bool_t is_of_list_type;
410 notmuch_message_node_t *iterator;
413 notmuch_message_list_t *
414 _notmuch_message_list_create (const void *ctx);
417 _notmuch_message_list_append (notmuch_message_list_t *list,
418 notmuch_message_node_t *node);
421 _notmuch_message_list_add_message (notmuch_message_list_t *list,
422 notmuch_message_t *message);
425 _notmuch_messages_create (notmuch_message_list_t *list);
430 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
433 _notmuch_mset_messages_get (notmuch_messages_t *messages);
436 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
439 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
440 unsigned int doc_id);
443 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
444 unsigned int doc_id);
449 _notmuch_message_add_reply (notmuch_message_t *message,
450 notmuch_message_node_t *reply);
455 notmuch_sha1_of_string (const char *str);
458 notmuch_sha1_of_file (const char *filename);
462 typedef struct _notmuch_string_node {
464 struct _notmuch_string_node *next;
465 } notmuch_string_node_t;
467 typedef struct _notmuch_string_list {
469 notmuch_string_node_t *head;
470 notmuch_string_node_t **tail;
471 } notmuch_string_list_t;
473 notmuch_string_list_t *
474 _notmuch_string_list_create (const void *ctx);
476 /* Add 'string' to 'list'.
478 * The list will create its own talloced copy of 'string'.
481 _notmuch_string_list_append (notmuch_string_list_t *list,
485 _notmuch_string_list_sort (notmuch_string_list_t *list);
490 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
494 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
496 notmuch_filenames_t *
497 _notmuch_filenames_create (const void *ctx,
498 notmuch_string_list_t *list);
500 #pragma GCC visibility pop