X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-client.h;h=ebd43e8d296ec775808f527b757b73c137528235;hp=d026e6004239a1868dd44dde4b16de58fc0351a6;hb=HEAD;hpb=71f1228a518f08e94dc1ea4e2147f80d3484c615 diff --git a/notmuch-client.h b/notmuch-client.h index d026e600..1a87240d 100644 --- a/notmuch-client.h +++ b/notmuch-client.h @@ -24,16 +24,13 @@ #ifndef _GNU_SOURCE #define _GNU_SOURCE /* for getline */ #endif +#include #include #include #include "compat.h" -#include - -typedef GMimeCryptoContext notmuch_crypto_context_t; -/* This is automatically included only since gmime 2.6.10 */ -#include +#include "gmime-extra.h" #include "notmuch.h" @@ -52,12 +49,15 @@ typedef GMimeCryptoContext notmuch_crypto_context_t; #include #include #include +#include #include "talloc-extra.h" +#include "crypto.h" +#include "repair.h" -#define unused(x) x __attribute__ ((unused)) +#define unused(x) x ## _unused __attribute__ ((unused)) -#define STRINGIFY(s) STRINGIFY_(s) +#define STRINGIFY(s) STRINGIFY_ (s) #define STRINGIFY_(s) #s typedef struct mime_node mime_node_t; @@ -65,28 +65,23 @@ struct sprinter; struct notmuch_show_params; typedef struct notmuch_show_format { - struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream); - notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter, - struct mime_node *node, int indent, - const struct notmuch_show_params *params); + struct sprinter *(*new_sprinter)(notmuch_database_t * db, FILE *stream); + notmuch_status_t (*part)(const void *ctx, struct sprinter *sprinter, + struct mime_node *node, int indent, + const struct notmuch_show_params *params); } notmuch_show_format_t; -typedef struct notmuch_crypto { - notmuch_crypto_context_t* gpgctx; - notmuch_crypto_context_t* pkcs7ctx; - notmuch_bool_t verify; - notmuch_bool_t decrypt; - const char *gpgpath; -} notmuch_crypto_t; - typedef struct notmuch_show_params { - notmuch_bool_t entire_thread; - notmuch_bool_t omit_excluded; - notmuch_bool_t output_body; - notmuch_bool_t raw; + bool entire_thread; + bool omit_excluded; + bool output_body; + int duplicate; int part; - notmuch_crypto_t crypto; - notmuch_bool_t include_html; + int offset; + int limit; + _notmuch_crypto_t crypto; + bool include_html; + GMimeStream *out_stream; } notmuch_show_params_t; /* There's no point in continuing when we've detected that we've done @@ -95,12 +90,12 @@ typedef struct notmuch_show_params { * * Note that __location__ comes from talloc.h. */ -#define INTERNAL_ERROR(format, ...) \ - do { \ - fprintf(stderr, \ - "Internal error: " format " (%s)\n", \ - ##__VA_ARGS__, __location__); \ - exit (1); \ +#define INTERNAL_ERROR(format, ...) \ + do { \ + fprintf (stderr, \ + "Internal error: " format " (%s)\n", \ + ##__VA_ARGS__, __location__); \ + exit (1); \ } while (0) #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0])) @@ -111,8 +106,8 @@ typedef struct notmuch_show_params { static inline void chomp_newline (char *str) { - if (str && str[strlen(str)-1] == '\n') - str[strlen(str)-1] = '\0'; + if (str && str[strlen (str) - 1] == '\n') + str[strlen (str) - 1] = '\0'; } /* Exit status code indicating temporary failure; user is invited to @@ -145,7 +140,7 @@ chomp_newline (char *str) * this. New (required) map fields can be added without increasing * this. */ -#define NOTMUCH_FORMAT_CUR 2 +#define NOTMUCH_FORMAT_CUR 5 /* The minimum supported structured output format version. Requests * for format versions below this will return an error. */ #define NOTMUCH_FORMAT_MIN 1 @@ -164,7 +159,7 @@ chomp_newline (char *str) */ extern int notmuch_format_version; -typedef struct _notmuch_config notmuch_config_t; +typedef struct _notmuch_conffile notmuch_conffile_t; /* Commands that support structured output should support the * following argument @@ -178,50 +173,47 @@ typedef struct _notmuch_config notmuch_config_t; void notmuch_exit_if_unsupported_format (void); -notmuch_crypto_context_t * -notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol); - int -notmuch_crypto_cleanup (notmuch_crypto_t *crypto); +notmuch_count_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_dump_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_new_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_insert_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_reindex_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_reply_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_restore_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_search_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_address_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_setup_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_show_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_tag_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_config_command (notmuch_database_t *notmuch, int argc, char *argv[]); int -notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]); +notmuch_compact_command (notmuch_database_t *notmuch, int argc, char *argv[]); const char * notmuch_time_relative_date (const void *ctx, time_t then); @@ -240,12 +232,13 @@ show_one_part (const char *filename, int part); void format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node, - notmuch_bool_t first, notmuch_bool_t output_body, - notmuch_bool_t include_html); + int duplicate, + bool output_body, + bool include_html); void format_headers_sprinter (struct sprinter *sp, GMimeMessage *message, - notmuch_bool_t reply); + bool reply, const _notmuch_message_crypto_t *msg_crypto); typedef enum { NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0, @@ -261,95 +254,73 @@ json_quote_chararray (const void *ctx, const char *str, const size_t len); char * json_quote_str (const void *ctx, const char *str); -/* notmuch-config.c */ - -notmuch_config_t * -notmuch_config_open (void *ctx, - const char *filename, - notmuch_bool_t create_new); +/* notmuch-client-init.c */ -void -notmuch_config_close (notmuch_config_t *config); - -int -notmuch_config_save (notmuch_config_t *config); +void notmuch_client_init (void); -notmuch_bool_t -notmuch_config_is_new (notmuch_config_t *config); +/* notmuch-config.c */ -const char * -notmuch_config_get_database_path (notmuch_config_t *config); +typedef enum { + NOTMUCH_COMMAND_CONFIG_CREATE = 1 << 1, + NOTMUCH_COMMAND_DATABASE_EARLY = 1 << 2, + NOTMUCH_COMMAND_DATABASE_WRITE = 1 << 3, + NOTMUCH_COMMAND_DATABASE_CREATE = 1 << 4, + NOTMUCH_COMMAND_CONFIG_LOAD = 1 << 5, +} notmuch_command_mode_t; + +notmuch_conffile_t * +notmuch_conffile_open (notmuch_database_t *notmuch, + const char *filename, + bool create); void -notmuch_config_set_database_path (notmuch_config_t *config, - const char *database_path); +notmuch_conffile_close (notmuch_conffile_t *config); -const char * -notmuch_config_get_crypto_gpg_path (notmuch_config_t *config); +int +notmuch_conffile_save (notmuch_conffile_t *config); -void -notmuch_config_set_crypto_gpg_path (notmuch_config_t *config, - const char *gpg_path); - -const char * -notmuch_config_get_user_name (notmuch_config_t *config); +bool +notmuch_conffile_is_new (notmuch_conffile_t *config); void -notmuch_config_set_user_name (notmuch_config_t *config, - const char *user_name); - -const char * -notmuch_config_get_user_primary_email (notmuch_config_t *config); +notmuch_conffile_set_database_path (notmuch_conffile_t *config, + const char *database_path); void -notmuch_config_set_user_primary_email (notmuch_config_t *config, - const char *primary_email); - -const char ** -notmuch_config_get_user_other_email (notmuch_config_t *config, - size_t *length); +notmuch_conffile_set_user_name (notmuch_conffile_t *config, + const char *user_name); void -notmuch_config_set_user_other_email (notmuch_config_t *config, - const char *other_email[], - size_t length); +notmuch_conffile_set_user_primary_email (notmuch_conffile_t *config, + const char *primary_email); -const char ** -notmuch_config_get_new_tags (notmuch_config_t *config, - size_t *length); void -notmuch_config_set_new_tags (notmuch_config_t *config, - const char *new_tags[], - size_t length); - -const char ** -notmuch_config_get_new_ignore (notmuch_config_t *config, - size_t *length); +notmuch_conffile_set_user_other_email (notmuch_conffile_t *config, + const char *other_email[], + size_t length); void -notmuch_config_set_new_ignore (notmuch_config_t *config, - const char *new_ignore[], +notmuch_conffile_set_new_tags (notmuch_conffile_t *config, + const char *new_tags[], size_t length); -notmuch_bool_t -notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config); - void -notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config, - notmuch_bool_t synchronize_flags); - -const char ** -notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length); +notmuch_conffile_set_new_ignore (notmuch_conffile_t *config, + const char *new_ignore[], + size_t length); void -notmuch_config_set_search_exclude_tags (notmuch_config_t *config, - const char *list[], - size_t length); +notmuch_conffile_set_maildir_synchronize_flags (notmuch_conffile_t *config, + bool synchronize_flags); +void +notmuch_conffile_set_search_exclude_tags (notmuch_conffile_t *config, + const char *list[], + size_t length); int -notmuch_run_hook (const char *db_path, const char *hook); +notmuch_run_hook (notmuch_database_t *notmuch, const char *hook); -notmuch_bool_t +bool debugger_is_active (void); /* mime-node.c */ @@ -392,25 +363,27 @@ struct mime_node { int part_num; /* True if decryption of this part was attempted. */ - notmuch_bool_t decrypt_attempted; + bool decrypt_attempted; /* True if decryption of this part's child succeeded. In this * case, the decrypted part is substituted for the second child of * this part (which would usually be the encrypted data). */ - notmuch_bool_t decrypt_success; + bool decrypt_success; /* True if signature verification on this part was attempted. */ - notmuch_bool_t verify_attempted; + bool verify_attempted; /* The list of signatures for signed or encrypted containers. If * there are no signatures, this will be NULL. */ - GMimeSignatureList* sig_list; + GMimeSignatureList *sig_list; /* Internal: Context inherited from the root iterator. */ struct mime_node_context *ctx; /* Internal: For successfully decrypted multipart parts, the - * decrypted part to substitute for the second child. */ - GMimeObject *decrypted_child; + * decrypted part to substitute for the second child; or, for + * PKCS#7 parts, the part returned after removing/processing the + * PKCS#7 transformation */ + GMimeObject *unwrapped_child; /* Internal: The next child for depth-first traversal and the part * number to assign it (or -1 if unknown). */ @@ -419,10 +392,14 @@ struct mime_node { }; /* Construct a new MIME node pointing to the root message part of - * message. If crypto->verify is true, signed child parts will be - * verified. If crypto->decrypt is true, encrypted child parts will be - * decrypted. If the crypto contexts (crypto->gpgctx or - * crypto->pkcs7) are NULL, they will be lazily initialized. + * message. Use the duplicate-th filename if that parameter is + * positive. If crypto->verify is true, signed child parts will be + * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted + * child parts will be decrypted using either stored session keys or + * asymmetric crypto. If crypto->decrypt is NOTMUCH_DECRYPT_AUTO, + * only session keys will be tried. If the crypto contexts + * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily + * initialized. * * Return value: * @@ -434,7 +411,8 @@ struct mime_node { */ notmuch_status_t mime_node_open (const void *ctx, notmuch_message_t *message, - notmuch_crypto_t *crypto, mime_node_t **node_out); + int duplicate, + _notmuch_crypto_t *crypto, mime_node_t **node_out); /* Return a new MIME node for the requested child part of parent. * parent will be used as the talloc context for the returned child @@ -447,25 +425,28 @@ mime_node_t * mime_node_child (mime_node_t *parent, int child); /* Return the nth child of node in a depth-first traversal. If n is - * 0, returns node itself. Returns NULL if there is no such part. */ +* 0, returns node itself. Returns NULL if there is no such part. */ mime_node_t * mime_node_seek_dfs (mime_node_t *node, int n); -typedef enum dump_formats { +const _notmuch_message_crypto_t * +mime_node_get_message_crypto_status (mime_node_t *node); + +typedef enum { DUMP_FORMAT_AUTO, DUMP_FORMAT_BATCH_TAG, DUMP_FORMAT_SUP } dump_format_t; -typedef enum dump_includes { - DUMP_INCLUDE_TAGS = 1, - DUMP_INCLUDE_CONFIG = 2, - DUMP_INCLUDE_PROPERTIES = 4 +typedef enum { + DUMP_INCLUDE_TAGS = 1, + DUMP_INCLUDE_CONFIG = 2, + DUMP_INCLUDE_PROPERTIES = 4 } dump_include_t; #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES) -#define NOTMUCH_DUMP_VERSION 2 +#define NOTMUCH_DUMP_VERSION 3 int notmuch_database_dump (notmuch_database_t *notmuch, @@ -473,17 +454,22 @@ notmuch_database_dump (notmuch_database_t *notmuch, const char *query_str, dump_format_t output_format, dump_include_t include, - notmuch_bool_t gzip_output); + bool gzip_output); -/* If status is non-zero (i.e. error) print appropriate - messages to stderr. -*/ +/* If status indicates error print appropriate + * messages to stderr. + */ notmuch_status_t print_status_query (const char *loc, const notmuch_query_t *query, notmuch_status_t status); +notmuch_status_t +print_status_message (const char *loc, + const notmuch_message_t *message, + notmuch_status_t status); + notmuch_status_t print_status_database (const char *loc, const notmuch_database_t *database, @@ -492,13 +478,37 @@ print_status_database (const char *loc, int status_to_exit (notmuch_status_t status); +notmuch_status_t +print_status_gzbytes (const char *loc, + gzFile file, + int bytes); + +/* the __location__ macro is defined in talloc.h */ +#define ASSERT_GZBYTES(file, bytes) ((print_status_gzbytes (__location__, file, bytes)) ? exit (1) : \ + 0) +#define GZPRINTF(file, fmt, ...) ASSERT_GZBYTES (file, gzprintf (file, fmt, ##__VA_ARGS__)); +#define GZPUTS(file, str) ASSERT_GZBYTES (file, gzputs (file, str)); + #include "command-line-arguments.h" -extern char *notmuch_requested_db_uuid; -extern const notmuch_opt_desc_t notmuch_shared_options []; -void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch); +extern const notmuch_opt_desc_t notmuch_shared_options []; -void notmuch_process_shared_options (const char* subcommand_name); -int notmuch_minimal_options (const char* subcommand_name, +notmuch_query_syntax_t shared_option_query_syntax (); + +void notmuch_process_shared_options (notmuch_database_t *notmuch, const char *subcommand_name); +int notmuch_minimal_options (const char *subcommand_name, int argc, char **argv); + + +/* the state chosen by the user invoking one of the notmuch + * subcommands that does indexing */ +struct _notmuch_client_indexing_cli_choices { + int decrypt_policy; + bool decrypt_policy_set; +}; +extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices; +extern const notmuch_opt_desc_t notmuch_shared_indexing_options []; +notmuch_status_t +notmuch_process_shared_indexing_options (notmuch_indexopts_t *opts); + #endif