X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-client.h;h=9ce2aef17431b3cd9792cc08477fcb630f434eea;hp=ae9344b2ae332cd6e7025710bb292bff73846865;hb=60ac94fe58635f9c40724afa0f35965fc9ff1afc;hpb=1cbaad158e36a1402f1f9bc49ba7f2b56640c0d1 diff --git a/notmuch-client.h b/notmuch-client.h index ae9344b2..9ce2aef1 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 */ @@ -30,16 +30,9 @@ #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 +/* This is automatically included only since gmime 2.6.10 */ +#include #include "notmuch.h" @@ -57,8 +50,9 @@ typedef GMimeCipherContext notmuch_crypto_context_t; #include #include #include +#include -#include +#include "talloc-extra.h" #define unused(x) x __attribute__ ((unused)) @@ -78,8 +72,10 @@ typedef struct notmuch_show_format { 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 { @@ -89,6 +85,7 @@ typedef struct notmuch_show_params { notmuch_bool_t raw; int part; notmuch_crypto_t crypto; + notmuch_bool_t include_html; } notmuch_show_params_t; /* There's no point in continuing when we've detected that we've done @@ -117,6 +114,59 @@ chomp_newline (char *str) str[strlen(str)-1] = '\0'; } +/* 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 + * with this code. + */ +#define NOTMUCH_EXIT_FORMAT_TOO_OLD 20 +/* Exit status code indicating the requested format version is newer + * than the version supported by the CLI. CLI code should use + * notmuch_exit_if_unsupported_format rather than directly exiting + * with this code. + */ +#define NOTMUCH_EXIT_FORMAT_TOO_NEW 21 + +/* The current structured output format version. Requests for format + * versions above this will return an error. Backwards-incompatible + * changes such as removing map fields, changing the meaning of map + * fields, or changing the meanings of list elements should increase + * this. New (required) map fields can be added without increasing + * this. + */ +#define NOTMUCH_FORMAT_CUR 2 +/* 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 + * NOTMUCH_FORMAT_CUR. Even though the command-line option is + * per-command, this is global because commands can share structured + * output code. + */ +extern int notmuch_format_version; + +typedef struct _notmuch_config notmuch_config_t; + +/* Commands that support structured output should support the + * following argument + * { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 } + * and should invoke notmuch_exit_if_unsupported_format to check the + * requested version. If notmuch_format_version is outside the + * supported range, this will print a detailed diagnostic message for + * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform + * the invoking program of the problem. + */ +void +notmuch_exit_if_unsupported_format (void); + notmuch_crypto_context_t * notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol); @@ -124,40 +174,43 @@ int notmuch_crypto_cleanup (notmuch_crypto_t *crypto); int -notmuch_count_command (void *ctx, int argc, char *argv[]); +notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]); + +int +notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_dump_command (void *ctx, int argc, char *argv[]); +notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_new_command (void *ctx, int argc, char *argv[]); +notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_reply_command (void *ctx, int argc, char *argv[]); +notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_restore_command (void *ctx, int argc, char *argv[]); +notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_search_command (void *ctx, int argc, char *argv[]); +notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_setup_command (void *ctx, int argc, char *argv[]); +notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_show_command (void *ctx, int argc, char *argv[]); +notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_tag_command (void *ctx, int argc, char *argv[]); +notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_search_tags_command (void *ctx, int argc, char *argv[]); +notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_cat_command (void *ctx, int argc, char *argv[]); +notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]); int -notmuch_config_command (void *ctx, int argc, char *argv[]); +notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]); const char * notmuch_time_relative_date (const void *ctx, time_t then); @@ -175,12 +228,13 @@ notmuch_status_t show_one_part (const char *filename, int part); void -format_part_json (const void *ctx, struct sprinter *sp, mime_node_t *node, - notmuch_bool_t first, notmuch_bool_t output_body); +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); void -format_headers_json (struct sprinter *sp, GMimeMessage *message, - notmuch_bool_t reply); +format_headers_sprinter (struct sprinter *sp, GMimeMessage *message, + notmuch_bool_t reply); typedef enum { NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0, @@ -198,12 +252,10 @@ json_quote_str (const void *ctx, const char *str); /* notmuch-config.c */ -typedef struct _notmuch_config notmuch_config_t; - notmuch_config_t * notmuch_config_open (void *ctx, const char *filename, - notmuch_bool_t *is_new_ret); + notmuch_bool_t create_new); void notmuch_config_close (notmuch_config_t *config); @@ -211,6 +263,9 @@ notmuch_config_close (notmuch_config_t *config); int notmuch_config_save (notmuch_config_t *config); +notmuch_bool_t +notmuch_config_is_new (notmuch_config_t *config); + const char * notmuch_config_get_database_path (notmuch_config_t *config); @@ -218,6 +273,13 @@ void notmuch_config_set_database_path (notmuch_config_t *config, const char *database_path); +const char * +notmuch_config_get_crypto_gpg_path (notmuch_config_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); @@ -327,17 +389,10 @@ struct mime_node { /* True if signature verification on this part was attempted. */ notmuch_bool_t verify_attempted; -#ifdef GMIME_ATLEAST_26 + /* 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 /* Internal: Context inherited from the root iterator. */ struct mime_node_context *ctx; @@ -355,8 +410,8 @@ 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 - * initialized. + * decrypted. If the crypto contexts (crypto->gpgctx or + * crypto->pkcs7) are NULL, they will be lazily initialized. * * Return value: * @@ -385,5 +440,51 @@ mime_node_child (mime_node_t *parent, int child); mime_node_t * mime_node_seek_dfs (mime_node_t *node, int n); +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 2 + +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, + notmuch_bool_t 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_database (const char *loc, + const notmuch_database_t *database, + notmuch_status_t status); + #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); + +void notmuch_process_shared_options (const char* subcommand_name); +int notmuch_minimal_options (const char* subcommand_name, + int argc, char **argv); #endif