X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-client.h;h=d1b7801784f40850fe419b8a374b161694236e74;hp=0bfa4da9606a4b62b052aec3a42e04148bceaccf;hb=33382c2b5ba2537952a60ea378feff36961e4713;hpb=241a88ce2f3c8d76b5a63a202d8455757c0e751e diff --git a/notmuch-client.h b/notmuch-client.h index 0bfa4da9..d1b78017 100644 --- a/notmuch-client.h +++ b/notmuch-client.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,22 +24,13 @@ #ifndef _GNU_SOURCE #define _GNU_SOURCE /* for getline */ #endif +#include #include +#include #include "compat.h" -#include - -/* GMIME_CHECK_VERSION in gmime 2.4 is not usable from the - * preprocessor (it calls a runtime function). But since - * GMIME_MAJOR_VERSION and friends were added in gmime 2.6, we can use - * these to check the version number. */ -#ifdef GMIME_MAJOR_VERSION -#define GMIME_ATLEAST_26 -typedef GMimeCryptoContext notmuch_crypto_context_t; -#else -typedef GMimeCipherContext notmuch_crypto_context_t; -#endif +#include "gmime-extra.h" #include "notmuch.h" @@ -57,12 +48,14 @@ typedef GMimeCipherContext notmuch_crypto_context_t; #include #include #include +#include #include "talloc-extra.h" +#include "crypto.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; @@ -70,26 +63,20 @@ 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)(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); } notmuch_show_format_t; -typedef struct notmuch_crypto { - notmuch_crypto_context_t* gpgctx; - notmuch_bool_t verify; - notmuch_bool_t decrypt; -} 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 part; - notmuch_crypto_t crypto; - notmuch_bool_t include_html; + _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 @@ -98,12 +85,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])) @@ -114,10 +101,20 @@ 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 + * retry. + * + * For example, file(s) in the mail store were removed or renamed + * after notmuch new scanned the directories but before indexing the + * file(s). If the file was renamed, the indexing might not be + * complete, and the user is advised to re-run notmuch new. + */ +#define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL + /* Exit status code indicating the requested format version is too old * (support for that version has been dropped). CLI code should use * notmuch_exit_if_unsupported_format rather than directly exiting @@ -138,10 +135,16 @@ chomp_newline (char *str) * this. New (required) map fields can be added without increasing * this. */ -#define NOTMUCH_FORMAT_CUR 1 +#define NOTMUCH_FORMAT_CUR 4 /* The minimum supported structured output format version. Requests * for format versions below this will return an error. */ #define NOTMUCH_FORMAT_MIN 1 +/* The minimum non-deprecated structured output format version. + * Requests for format versions below this will print a stern warning. + * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR, + * inclusive. + */ +#define NOTMUCH_FORMAT_MIN_ACTIVE 1 /* The output format version requested by the caller on the command * line. If no format version is requested, this will be set to @@ -165,12 +168,6 @@ 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); - int notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]); @@ -183,6 +180,9 @@ notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]); int notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]); +int +notmuch_reindex_command (notmuch_config_t *config, int argc, char *argv[]); + int notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]); @@ -192,6 +192,9 @@ notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]); int notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]); +int +notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]); + int notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]); @@ -224,12 +227,12 @@ 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); + 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, @@ -247,10 +250,15 @@ json_quote_str (const void *ctx, const char *str); /* notmuch-config.c */ +typedef enum { + NOTMUCH_CONFIG_OPEN = 1 << 0, + NOTMUCH_CONFIG_CREATE = 1 << 1, +} notmuch_config_mode_t; + notmuch_config_t * notmuch_config_open (void *ctx, const char *filename, - notmuch_bool_t create_new); + notmuch_config_mode_t config_mode); void notmuch_config_close (notmuch_config_t *config); @@ -258,7 +266,7 @@ notmuch_config_close (notmuch_config_t *config); int notmuch_config_save (notmuch_config_t *config); -notmuch_bool_t +bool notmuch_config_is_new (notmuch_config_t *config); const char * @@ -308,25 +316,25 @@ notmuch_config_set_new_ignore (notmuch_config_t *config, const char *new_ignore[], size_t length); -notmuch_bool_t +bool 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); + bool synchronize_flags); const char ** notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length); void notmuch_config_set_search_exclude_tags (notmuch_config_t *config, - const char *list[], - size_t length); + const char *list[], + size_t length); int notmuch_run_hook (const char *db_path, const char *hook); -notmuch_bool_t +bool debugger_is_active (void); /* mime-node.c */ @@ -369,25 +377,18 @@ 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; -#ifdef GMIME_ATLEAST_26 + bool verify_attempted; + /* The list of signatures for signed or encrypted containers. If * there are no signatures, this will be NULL. */ - GMimeSignatureList* sig_list; -#else - /* For signed or encrypted containers, the validity of the - * signature. May be NULL if signature verification failed. If - * there are simply no signatures, this will be non-NULL with an - * empty signers list. */ - const GMimeSignatureValidity *sig_validity; -#endif + GMimeSignatureList *sig_list; /* Internal: Context inherited from the root iterator. */ struct mime_node_context *ctx; @@ -404,8 +405,11 @@ 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 crypto->gpgctx is NULL, it will be lazily + * 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: @@ -418,7 +422,7 @@ 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); + _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 @@ -431,9 +435,80 @@ 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); +const _notmuch_message_crypto_t * +mime_node_get_message_crypto_status (mime_node_t *node); + +typedef enum dump_formats { + 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 +} dump_include_t; + +#define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES) + +#define NOTMUCH_DUMP_VERSION 3 + +int +notmuch_database_dump (notmuch_database_t *notmuch, + const char *output_file_name, + const char *query_str, + dump_format_t output_format, + dump_include_t include, + bool gzip_output); + +/* If status is non-zero (i.e. 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, + notmuch_status_t status); + +int +status_to_exit (notmuch_status_t status); + #include "command-line-arguments.h" + +extern const 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); + +void notmuch_process_shared_options (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; + notmuch_indexopts_t *opts; +}; +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_database_t *notmuch); + #endif