X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=lib%2Fnotmuch-private.h;h=1093429cfc77026289f49754c7ea5c84330c71e6;hp=5a0cf92540619ff5fa50951c5326c84e191051b8;hb=4dfcc8c9b2e1dbb965f69283dca50c7581c88050;hpb=7b78eb4af6e87532795d09bd82152002ab4a74b1 diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h index 5a0cf925..1093429c 100644 --- a/lib/notmuch-private.h +++ b/lib/notmuch-private.h @@ -13,7 +13,7 @@ * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see http://www.gnu.org/licenses/ . + * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Carl Worth */ @@ -24,6 +24,7 @@ #ifndef _GNU_SOURCE #define _GNU_SOURCE /* For getline and asprintf */ #endif +#include #include #include "compat.h" @@ -46,7 +47,12 @@ NOTMUCH_BEGIN_DECLS #include +#include "gmime-extra.h" + #include "xutil.h" +#include "error_util.h" +#include "string-util.h" +#include "crypto.h" #ifdef DEBUG # define DEBUG_DATABASE_SANITY 1 @@ -55,24 +61,18 @@ NOTMUCH_BEGIN_DECLS #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)])) -/* There's no point in continuing when we've detected that we've done - * something wrong internally (as opposed to the user passing in a - * bogus value). - * - * Note that PRINTF_ATTRIBUTE comes from talloc.h - */ -int -_internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2); +#define STRNCMP_LITERAL(var, literal) \ + strncmp ((var), (literal), sizeof (literal) - 1) -/* There's no point in continuing when we've detected that we've done - * something wrong internally (as opposed to the user passing in a - * bogus value). - * - * Note that __location__ comes from talloc.h. - */ -#define INTERNAL_ERROR(format, ...) \ - _internal_error (format " (%s).\n", \ - ##__VA_ARGS__, __location__) +/* Robust bit test/set/reset macros */ +#define _NOTMUCH_VALID_BIT(bit) \ + ((bit) >= 0 && ((unsigned long) bit) < CHAR_BIT * sizeof (unsigned long long)) +#define NOTMUCH_TEST_BIT(val, bit) \ + (_NOTMUCH_VALID_BIT(bit) ? !!((val) & (1ull << (bit))) : 0) +#define NOTMUCH_SET_BIT(valp, bit) \ + (_NOTMUCH_VALID_BIT(bit) ? (*(valp) |= (1ull << (bit))) : *(valp)) +#define NOTMUCH_CLEAR_BIT(valp, bit) \ + (_NOTMUCH_VALID_BIT(bit) ? (*(valp) &= ~(1ull << (bit))) : *(valp)) #define unused(x) x __attribute__ ((unused)) @@ -100,7 +100,10 @@ _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2); typedef enum { NOTMUCH_VALUE_TIMESTAMP = 0, - NOTMUCH_VALUE_MESSAGE_ID + NOTMUCH_VALUE_MESSAGE_ID, + NOTMUCH_VALUE_FROM, + NOTMUCH_VALUE_SUBJECT, + NOTMUCH_VALUE_LAST_MOD, } notmuch_value_t; /* Xapian (with flint backend) complains if we provide a term longer @@ -141,16 +144,32 @@ typedef enum _notmuch_private_status { * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is * that the caller has previously handled any expected * notmuch_private_status_t values.) + * + * Note that the function _internal_error does not return. Evaluating + * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler. */ #define COERCE_STATUS(private_status, format, ...) \ ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\ ? \ - (notmuch_status_t) _internal_error (format " (%s).\n", \ - ##__VA_ARGS__, \ - __location__) \ + _internal_error (format " (%s).\n", \ + ##__VA_ARGS__, \ + __location__), \ + (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \ : \ (notmuch_status_t) private_status) +/* Flags shared by various lookup functions. */ +typedef enum _notmuch_find_flags { + /* Lookup without creating any documents. This is the default + * behavior. */ + NOTMUCH_FIND_LOOKUP = 0, + /* If set, create the necessary document (or documents) if they + * are missing. Requires a read/write database. */ + NOTMUCH_FIND_CREATE = 1<<0, +} notmuch_find_flags_t; + +typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t; + /* database.cc */ /* Lookup a prefix value by name. @@ -161,9 +180,26 @@ typedef enum _notmuch_private_status { const char * _find_prefix (const char *name); +char * +_notmuch_message_id_compressed (void *ctx, const char *message_id); + notmuch_status_t _notmuch_database_ensure_writable (notmuch_database_t *notmuch); +notmuch_status_t +_notmuch_database_reopen (notmuch_database_t *notmuch); + +void +_notmuch_database_log (notmuch_database_t *notmuch, + const char *format, ...); + +void +_notmuch_database_log_append (notmuch_database_t *notmuch, + const char *format, ...); + +unsigned long +_notmuch_database_new_revision (notmuch_database_t *notmuch); + const char * _notmuch_database_relative_path (notmuch_database_t *notmuch, const char *path); @@ -189,6 +225,7 @@ _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch, notmuch_status_t _notmuch_database_find_directory_id (notmuch_database_t *database, const char *path, + notmuch_find_flags_t flags, unsigned int *directory_id); const char * @@ -200,6 +237,7 @@ notmuch_status_t _notmuch_database_filename_to_direntry (void *ctx, notmuch_database_t *notmuch, const char *filename, + notmuch_find_flags_t flags, char **direntry); /* directory.cc */ @@ -207,20 +245,12 @@ _notmuch_database_filename_to_direntry (void *ctx, notmuch_directory_t * _notmuch_directory_create (notmuch_database_t *notmuch, const char *path, + notmuch_find_flags_t flags, notmuch_status_t *status_ret); unsigned int _notmuch_directory_get_document_id (notmuch_directory_t *directory); -/* thread.cc */ - -notmuch_thread_t * -_notmuch_thread_create (void *ctx, - notmuch_database_t *notmuch, - const char *thread_id, - const char *query_string, - notmuch_sort_t sort); - /* message.cc */ notmuch_message_t * @@ -234,6 +264,9 @@ _notmuch_message_create_for_message_id (notmuch_database_t *notmuch, const char *message_id, notmuch_private_status_t *status); +unsigned int +_notmuch_message_get_doc_id (notmuch_message_t *message); + const char * _notmuch_message_get_in_reply_to (notmuch_message_t *message); @@ -247,6 +280,12 @@ _notmuch_message_remove_term (notmuch_message_t *message, const char *prefix_name, const char *value); +notmuch_private_status_t +_notmuch_message_has_term (notmuch_message_t *message, + const char *prefix_name, + const char *value, + bool *result); + notmuch_private_status_t _notmuch_message_gen_terms (notmuch_message_t *message, const char *prefix_name, @@ -255,20 +294,43 @@ _notmuch_message_gen_terms (notmuch_message_t *message, void _notmuch_message_upgrade_filename_storage (notmuch_message_t *message); +void +_notmuch_message_upgrade_folder (notmuch_message_t *message); + notmuch_status_t _notmuch_message_add_filename (notmuch_message_t *message, const char *filename); +notmuch_status_t +_notmuch_message_remove_filename (notmuch_message_t *message, + const char *filename); + +notmuch_status_t +_notmuch_message_rename (notmuch_message_t *message, + const char *new_filename); + void _notmuch_message_ensure_thread_id (notmuch_message_t *message); void -_notmuch_message_set_date (notmuch_message_t *message, - const char *date); +_notmuch_message_set_header_values (notmuch_message_t *message, + const char *date, + const char *from, + const char *subject); + +void +_notmuch_message_upgrade_last_mod (notmuch_message_t *message); void _notmuch_message_sync (notmuch_message_t *message); +notmuch_status_t +_notmuch_message_delete (notmuch_message_t *message); + +notmuch_private_status_t +_notmuch_message_initialize_ghost (notmuch_message_t *message, + const char *thread_id); + void _notmuch_message_close (notmuch_message_t *message); @@ -291,18 +353,11 @@ _notmuch_message_clear_data (notmuch_message_t *message); /* Set the author member of 'message' - this is the representation used * when displaying the message */ void -notmuch_message_set_author (notmuch_message_t *message, const char *author); +_notmuch_message_set_author (notmuch_message_t *message, const char *author); /* Get the author member of 'message' */ const char * -notmuch_message_get_author (notmuch_message_t *message); - - -/* index.cc */ - -notmuch_status_t -_notmuch_message_index_file (notmuch_message_t *message, - const char *filename); +_notmuch_message_get_author (notmuch_message_t *message); /* message-file.c */ @@ -319,41 +374,42 @@ typedef struct _notmuch_message_file notmuch_message_file_t; * Returns NULL if any error occurs. */ notmuch_message_file_t * -notmuch_message_file_open (const char *filename); +_notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename); /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */ notmuch_message_file_t * -_notmuch_message_file_open_ctx (void *ctx, const char *filename); +_notmuch_message_file_open_ctx (notmuch_database_t *notmuch, + void *ctx, const char *filename); /* Close a notmuch message previously opened with notmuch_message_open. */ void -notmuch_message_file_close (notmuch_message_file_t *message); +_notmuch_message_file_close (notmuch_message_file_t *message); -/* Restrict 'message' to only save the named headers. +/* Parse the message. * - * When the caller is only interested in a short list of headers, - * known in advance, calling this function can avoid wasted time and - * memory parsing/saving header values that will never be needed. + * This will be done automatically as necessary on other calls + * depending on it, but an explicit call allows for better error + * status reporting. + */ +notmuch_status_t +_notmuch_message_file_parse (notmuch_message_file_t *message); + +/* Get the gmime message of a message file. * - * The variable arguments should be a list of const char * with a - * final '(const char *) NULL' to terminate the list. + * The message file is parsed as necessary. * - * If this function is called, it must be called before any calls to - * notmuch_message_get_header for this message. + * The GMimeMessage* is set to *mime_message on success (which the + * caller must not unref). * - * After calling this function, if notmuch_message_get_header is - * called with a header name not in this list, then NULL will be - * returned even if that header exists in the actual message. + * XXX: Would be nice to not have to expose GMimeMessage here. */ -void -notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...); - -/* Identical to notmuch_message_restrict_headers but accepting a va_list. */ -void -notmuch_message_file_restrict_headersv (notmuch_message_file_t *message, - va_list va_headers); +notmuch_status_t +_notmuch_message_file_get_mime_message (notmuch_message_file_t *message, + GMimeMessage **mime_message); -/* Get the value of the specified header from the message. +/* Get the value of the specified header from the message as a UTF-8 string. + * + * The message file is parsed as necessary. * * The header name is case insensitive. * @@ -364,13 +420,37 @@ notmuch_message_file_restrict_headersv (notmuch_message_file_t *message, * only until the message is closed. The caller should copy it if * needing to modify the value or to hold onto it for longer. * - * Returns NULL if the message does not contain a header line matching - * 'header'. + * Returns NULL on errors, empty string if the message does not + * contain a header line matching 'header'. */ const char * -notmuch_message_file_get_header (notmuch_message_file_t *message, +_notmuch_message_file_get_header (notmuch_message_file_t *message, const char *header); +notmuch_status_t +_notmuch_message_file_get_headers (notmuch_message_file_t *message_file, + const char **from_out, + const char **subject_out, + const char **to_out, + const char **date_out, + char **message_id_out); + +const char * +_notmuch_message_file_get_filename (notmuch_message_file_t *message); + +/* add-message.cc */ +notmuch_status_t +_notmuch_database_link_message_to_parents (notmuch_database_t *notmuch, + notmuch_message_t *message, + notmuch_message_file_t *message_file, + const char **thread_id); +/* index.cc */ + +notmuch_status_t +_notmuch_message_index_file (notmuch_message_t *message, + notmuch_indexopts_t *indexopts, + notmuch_message_file_t *message_file); + /* messages.c */ typedef struct _notmuch_message_node { @@ -388,17 +468,14 @@ typedef struct _notmuch_message_list { * ignorance of that here. (See notmuch_mset_messages_t in query.cc) */ struct _notmuch_messages { - notmuch_bool_t is_of_list_type; + bool is_of_list_type; + notmuch_doc_id_set_t *excluded_doc_ids; notmuch_message_node_t *iterator; }; notmuch_message_list_t * _notmuch_message_list_create (const void *ctx); -void -_notmuch_message_list_append (notmuch_message_list_t *list, - notmuch_message_node_t *node); - void _notmuch_message_list_add_message (notmuch_message_list_t *list, notmuch_message_t *message); @@ -408,7 +485,7 @@ _notmuch_messages_create (notmuch_message_list_t *list); /* query.cc */ -notmuch_bool_t +bool _notmuch_mset_messages_valid (notmuch_messages_t *messages); notmuch_message_t * @@ -417,31 +494,171 @@ _notmuch_mset_messages_get (notmuch_messages_t *messages); void _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages); +bool +_notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids, + unsigned int doc_id); + +void +_notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids, + unsigned int doc_id); + +/* querying xapian documents by type (e.g. "mail" or "ghost"): */ +notmuch_status_t +_notmuch_query_search_documents (notmuch_query_t *query, + const char *type, + notmuch_messages_t **out); + +notmuch_status_t +_notmuch_query_count_documents (notmuch_query_t *query, + const char *type, + unsigned *count_out); +/* message-id.c */ + +/* Parse an RFC 822 message-id, discarding whitespace, any RFC 822 + * comments, and the '<' and '>' delimiters. + * + * If not NULL, then *next will be made to point to the first character + * not parsed, (possibly pointing to the final '\0' terminator. + * + * Returns a newly talloc'ed string belonging to 'ctx'. + * + * Returns NULL if there is any error parsing the message-id. */ +char * +_notmuch_message_id_parse (void *ctx, const char *message_id, const char **next); + + /* message.cc */ void _notmuch_message_add_reply (notmuch_message_t *message, - notmuch_message_node_t *reply); + notmuch_message_t *reply); +notmuch_database_t * +_notmuch_message_database (notmuch_message_t *message); +void +_notmuch_message_remove_unprefixed_terms (notmuch_message_t *message); /* sha1.c */ char * -notmuch_sha1_of_string (const char *str); +_notmuch_sha1_of_string (const char *str); char * -notmuch_sha1_of_file (const char *filename); +_notmuch_sha1_of_file (const char *filename); -/* tags.c */ +/* string-list.c */ -notmuch_tags_t * -_notmuch_tags_create (void *ctx); +typedef struct _notmuch_string_node { + char *string; + struct _notmuch_string_node *next; +} notmuch_string_node_t; + +typedef struct _notmuch_string_list { + int length; + notmuch_string_node_t *head; + notmuch_string_node_t **tail; +} notmuch_string_list_t; + +notmuch_string_list_t * +_notmuch_string_list_create (const void *ctx); + +/* + * return the number of strings in 'list' + */ +int +_notmuch_string_list_length (notmuch_string_list_t *list); + +/* Add 'string' to 'list'. + * + * The list will create its own talloced copy of 'string'. + */ +void +_notmuch_string_list_append (notmuch_string_list_t *list, + const char *string); void -_notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag); +_notmuch_string_list_sort (notmuch_string_list_t *list); + +/* string-map.c */ +typedef struct _notmuch_string_map notmuch_string_map_t; +typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t; +notmuch_string_map_t * +_notmuch_string_map_create (const void *ctx); void -_notmuch_tags_prepare_iterator (notmuch_tags_t *tags); +_notmuch_string_map_append (notmuch_string_map_t *map, + const char *key, + const char *value); + +const char * +_notmuch_string_map_get (notmuch_string_map_t *map, const char *key); + +notmuch_string_map_iterator_t * +_notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key, + bool exact); + +bool +_notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter); + +void +_notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter); + +const char * +_notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator); + +const char * +_notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator); + +void +_notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator); + +/* tags.c */ + +notmuch_tags_t * +_notmuch_tags_create (const void *ctx, notmuch_string_list_t *list); + +/* filenames.c */ + +/* The notmuch_filenames_t iterates over a notmuch_string_list_t of + * file names */ +notmuch_filenames_t * +_notmuch_filenames_create (const void *ctx, + notmuch_string_list_t *list); + +/* thread.cc */ + +notmuch_thread_t * +_notmuch_thread_create (void *ctx, + notmuch_database_t *notmuch, + unsigned int seed_doc_id, + notmuch_doc_id_set_t *match_set, + notmuch_string_list_t *excluded_terms, + notmuch_exclude_t omit_exclude, + notmuch_sort_t sort); + +/* indexopts.c */ + +struct _notmuch_indexopts { + _notmuch_crypto_t crypto; +}; NOTMUCH_END_DECLS +#ifdef __cplusplus +/* Implicit typecast from 'void *' to 'T *' is okay in C, but not in + * C++. In talloc_steal, an explicit cast is provided for type safety + * in some GCC versions. Otherwise, a cast is required. Provide a + * template function for this to maintain type safety, and redefine + * talloc_steal to use it. + */ +#if !(__GNUC__ >= 3) +template T * +_notmuch_talloc_steal (const void *new_ctx, const T *ptr) +{ + return static_cast (talloc_steal (new_ctx, ptr)); +} +#undef talloc_steal +#define talloc_steal _notmuch_talloc_steal +#endif +#endif + #endif