X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=lib%2Fnotmuch-private.h;h=1093429cfc77026289f49754c7ea5c84330c71e6;hp=f38ccb39b1ecfcbc5884341fc4024f50762665e4;hb=4dfcc8c9b2e1dbb965f69283dca50c7581c88050;hpb=16aa65ba2575fd504c31d9671d8c5150f8e8adf1 diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h index f38ccb39..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,10 +47,12 @@ NOTMUCH_BEGIN_DECLS #include +#include "gmime-extra.h" + #include "xutil.h" #include "error_util.h" - -#pragma GCC visibility push(hidden) +#include "string-util.h" +#include "crypto.h" #ifdef DEBUG # define DEBUG_DATABASE_SANITY 1 @@ -61,13 +64,17 @@ NOTMUCH_BEGIN_DECLS #define STRNCMP_LITERAL(var, literal) \ strncmp ((var), (literal), sizeof (literal) - 1) -#define unused(x) x __attribute__ ((unused)) +/* 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)) -#ifdef __cplusplus -# define visible __attribute__((visibility("default"))) -#else -# define visible -#endif +#define unused(x) x __attribute__ ((unused)) /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of * unlikely. The talloc source code comes to us via the GNU LGPL v. 3. @@ -95,7 +102,8 @@ typedef enum { NOTMUCH_VALUE_TIMESTAMP = 0, NOTMUCH_VALUE_MESSAGE_ID, NOTMUCH_VALUE_FROM, - NOTMUCH_VALUE_SUBJECT + NOTMUCH_VALUE_SUBJECT, + NOTMUCH_VALUE_LAST_MOD, } notmuch_value_t; /* Xapian (with flint backend) complains if we provide a term longer @@ -144,8 +152,8 @@ typedef enum _notmuch_private_status { ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\ ? \ _internal_error (format " (%s).\n", \ - ##__VA_ARGS__, \ - __location__), \ + ##__VA_ARGS__, \ + __location__), \ (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS \ : \ (notmuch_status_t) private_status) @@ -162,8 +170,6 @@ typedef enum _notmuch_find_flags { typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t; -typedef struct _notmuch_string_list notmuch_string_list_t; - /* database.cc */ /* Lookup a prefix value by name. @@ -174,9 +180,26 @@ typedef struct _notmuch_string_list notmuch_string_list_t; 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); @@ -228,16 +251,6 @@ _notmuch_directory_create (notmuch_database_t *notmuch, 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, - unsigned int seed_doc_id, - notmuch_doc_id_set_t *match_set, - notmuch_string_list_t *excluded_terms, - notmuch_sort_t sort); - /* message.cc */ notmuch_message_t * @@ -267,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, @@ -275,6 +294,9 @@ _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); @@ -295,12 +317,20 @@ _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); @@ -323,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 */ @@ -351,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. * @@ -396,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 { @@ -419,8 +467,8 @@ typedef struct _notmuch_message_list { * somewhere with some nasty C++ objects in it. We'll try to maintain * ignorance of that here. (See notmuch_mset_messages_t in query.cc) */ -struct visible _notmuch_messages { - notmuch_bool_t is_of_list_type; +struct _notmuch_messages { + bool is_of_list_type; notmuch_doc_id_set_t *excluded_doc_ids; notmuch_message_node_t *iterator; }; @@ -437,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 * @@ -446,27 +494,56 @@ _notmuch_mset_messages_get (notmuch_messages_t *messages); void _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages); -notmuch_bool_t +bool _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids, - unsigned int doc_id); + unsigned int doc_id); void _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids, - unsigned int doc_id); + 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_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); /* string-list.c */ @@ -475,15 +552,21 @@ typedef struct _notmuch_string_node { struct _notmuch_string_node *next; } notmuch_string_node_t; -struct visible _notmuch_string_list { +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'. @@ -495,6 +578,39 @@ _notmuch_string_list_append (notmuch_string_list_t *list, void _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_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 * @@ -508,6 +624,23 @@ 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 @@ -528,6 +661,4 @@ _notmuch_talloc_steal (const void *new_ctx, const T *ptr) #endif #endif -#pragma GCC visibility pop - #endif