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>
50 #include "error_util.h"
52 #pragma GCC visibility push(hidden)
55 # define DEBUG_DATABASE_SANITY 1
56 # define DEBUG_QUERY 1
59 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
61 #define STRNCMP_LITERAL(var, literal) \
62 strncmp ((var), (literal), sizeof (literal) - 1)
64 #define unused(x) x __attribute__ ((unused))
67 # define visible __attribute__((visibility("default")))
72 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
73 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
75 /* these macros gain us a few percent of speed on gcc */
77 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
78 as its first argument */
80 #define likely(x) __builtin_expect(!!(x), 1)
83 #define unlikely(x) __builtin_expect(!!(x), 0)
90 #define unlikely(x) (x)
95 NOTMUCH_VALUE_TIMESTAMP = 0,
96 NOTMUCH_VALUE_MESSAGE_ID,
101 /* Xapian (with flint backend) complains if we provide a term longer
102 * than this, but I haven't yet found a way to query the limit
103 * programmatically. */
104 #define NOTMUCH_TERM_MAX 245
106 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
108 /* For message IDs we have to be even more restrictive. Beyond fitting
109 * into the term limit, we also use message IDs to construct
110 * metadata-key values. And the documentation says that these should
111 * be restricted to about 200 characters. (The actual limit for the
112 * chert backend at least is 252.)
114 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
116 typedef enum _notmuch_private_status {
117 /* First, copy all the public status values. */
118 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
119 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
120 NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
121 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
122 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
123 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
124 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
125 NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
127 /* Then add our own private values. */
128 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
129 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
131 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
132 } notmuch_private_status_t;
134 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
135 * value, generating an internal error if the private value is equal
136 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
137 * that the caller has previously handled any expected
138 * notmuch_private_status_t values.)
140 #define COERCE_STATUS(private_status, format, ...) \
141 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
143 (notmuch_status_t) _internal_error (format " (%s).\n", \
147 (notmuch_status_t) private_status)
149 /* Flags shared by various lookup functions. */
150 typedef enum _notmuch_find_flags {
151 /* If set, create the necessary document (or documents) if they
152 * are missing. Requires a read/write database. */
153 NOTMUCH_FIND_CREATE = 1<<0,
154 } notmuch_find_flags_t;
156 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
158 typedef struct _notmuch_string_list notmuch_string_list_t;
162 /* Lookup a prefix value by name.
164 * XXX: This should really be static inside of message.cc, and we can
165 * do that once we convert database.cc to use the
166 * _notmuch_message_add/remove_term functions. */
168 _find_prefix (const char *name);
171 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
174 _notmuch_database_relative_path (notmuch_database_t *notmuch,
178 _notmuch_database_split_path (void *ctx,
180 const char **directory,
181 const char **basename);
184 _notmuch_database_get_directory_db_path (const char *path);
187 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
189 notmuch_private_status_t
190 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
191 const char *prefix_name,
193 unsigned int *doc_id);
196 _notmuch_database_find_directory_id (notmuch_database_t *database,
198 notmuch_find_flags_t flags,
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,
210 notmuch_find_flags_t flags,
215 notmuch_directory_t *
216 _notmuch_directory_create (notmuch_database_t *notmuch,
218 notmuch_find_flags_t flags,
219 notmuch_status_t *status_ret);
222 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
227 _notmuch_thread_create (void *ctx,
228 notmuch_database_t *notmuch,
229 unsigned int seed_doc_id,
230 notmuch_doc_id_set_t *match_set,
231 notmuch_string_list_t *excluded_terms,
232 notmuch_sort_t sort);
237 _notmuch_message_create (const void *talloc_owner,
238 notmuch_database_t *notmuch,
240 notmuch_private_status_t *status);
243 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
244 const char *message_id,
245 notmuch_private_status_t *status);
248 _notmuch_message_get_doc_id (notmuch_message_t *message);
251 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
253 notmuch_private_status_t
254 _notmuch_message_add_term (notmuch_message_t *message,
255 const char *prefix_name,
258 notmuch_private_status_t
259 _notmuch_message_remove_term (notmuch_message_t *message,
260 const char *prefix_name,
263 notmuch_private_status_t
264 _notmuch_message_gen_terms (notmuch_message_t *message,
265 const char *prefix_name,
269 _notmuch_message_upgrade_filename_storage (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);
329 _notmuch_message_index_file (notmuch_message_t *message,
330 const char *filename);
334 /* XXX: I haven't decided yet whether these will actually get exported
335 * into the public interface in notmuch.h
338 typedef struct _notmuch_message_file notmuch_message_file_t;
340 /* Open a file containing a single email message.
342 * The caller should call notmuch_message_close when done with this.
344 * Returns NULL if any error occurs.
346 notmuch_message_file_t *
347 notmuch_message_file_open (const char *filename);
349 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
350 notmuch_message_file_t *
351 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
353 /* Close a notmuch message previously opened with notmuch_message_open. */
355 notmuch_message_file_close (notmuch_message_file_t *message);
357 /* Restrict 'message' to only save the named headers.
359 * When the caller is only interested in a short list of headers,
360 * known in advance, calling this function can avoid wasted time and
361 * memory parsing/saving header values that will never be needed.
363 * The variable arguments should be a list of const char * with a
364 * final '(const char *) NULL' to terminate the list.
366 * If this function is called, it must be called before any calls to
367 * notmuch_message_get_header for this message.
369 * After calling this function, if notmuch_message_get_header is
370 * called with a header name not in this list, then NULL will be
371 * returned even if that header exists in the actual message.
374 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
376 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
378 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
381 /* Get the value of the specified header from the message.
383 * The header name is case insensitive.
385 * The Received: header is special - for it all Received: headers in
386 * the message are concatenated
388 * The returned value is owned by the notmuch message and is valid
389 * only until the message is closed. The caller should copy it if
390 * needing to modify the value or to hold onto it for longer.
392 * Returns NULL if the message does not contain a header line matching
396 notmuch_message_file_get_header (notmuch_message_file_t *message,
401 typedef struct _notmuch_message_node {
402 notmuch_message_t *message;
403 struct _notmuch_message_node *next;
404 } notmuch_message_node_t;
406 typedef struct _notmuch_message_list {
407 notmuch_message_node_t *head;
408 notmuch_message_node_t **tail;
409 } notmuch_message_list_t;
411 /* There's a rumor that there's an alternate struct _notmuch_messages
412 * somewhere with some nasty C++ objects in it. We'll try to maintain
413 * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
415 struct visible _notmuch_messages {
416 notmuch_bool_t is_of_list_type;
417 notmuch_doc_id_set_t *excluded_doc_ids;
418 notmuch_message_node_t *iterator;
421 notmuch_message_list_t *
422 _notmuch_message_list_create (const void *ctx);
425 _notmuch_message_list_append (notmuch_message_list_t *list,
426 notmuch_message_node_t *node);
429 _notmuch_message_list_add_message (notmuch_message_list_t *list,
430 notmuch_message_t *message);
433 _notmuch_messages_create (notmuch_message_list_t *list);
438 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
441 _notmuch_mset_messages_get (notmuch_messages_t *messages);
444 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
447 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
448 unsigned int doc_id);
451 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
452 unsigned int doc_id);
457 _notmuch_message_add_reply (notmuch_message_t *message,
458 notmuch_message_node_t *reply);
463 notmuch_sha1_of_string (const char *str);
466 notmuch_sha1_of_file (const char *filename);
470 typedef struct _notmuch_string_node {
472 struct _notmuch_string_node *next;
473 } notmuch_string_node_t;
475 struct visible _notmuch_string_list {
477 notmuch_string_node_t *head;
478 notmuch_string_node_t **tail;
481 notmuch_string_list_t *
482 _notmuch_string_list_create (const void *ctx);
484 /* Add 'string' to 'list'.
486 * The list will create its own talloced copy of 'string'.
489 _notmuch_string_list_append (notmuch_string_list_t *list,
493 _notmuch_string_list_sort (notmuch_string_list_t *list);
498 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
502 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
504 notmuch_filenames_t *
505 _notmuch_filenames_create (const void *ctx,
506 notmuch_string_list_t *list);
511 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
512 * C++. In talloc_steal, an explicit cast is provided for type safety
513 * in some GCC versions. Otherwise, a cast is required. Provide a
514 * template function for this to maintain type safety, and redefine
515 * talloc_steal to use it.
518 template <class T> T *
519 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
521 return static_cast<T *> (talloc_steal (new_ctx, ptr));
524 #define talloc_steal _notmuch_talloc_steal
528 #pragma GCC visibility pop