* 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 <cworth@cworth.org>
*/
#ifndef _GNU_SOURCE
#define _GNU_SOURCE /* for getline */
#endif
+#include <stdbool.h>
#include <stdio.h>
+#include <sysexits.h>
#include "compat.h"
-#include <gmime/gmime.h>
-
-/* 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"
#include <dirent.h>
#include <errno.h>
#include <signal.h>
+#include <ctype.h>
-#include <talloc.h>
+#include "talloc-extra.h"
+#include "crypto.h"
#define unused(x) x __attribute__ ((unused))
#define STRINGIFY_(s) #s
typedef struct mime_node mime_node_t;
+struct sprinter;
struct notmuch_show_params;
typedef struct notmuch_show_format {
- const char *message_set_start;
- notmuch_status_t (*part) (const void *ctx,
+ 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);
- const char *message_set_sep;
- const char *message_set_end;
} 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 raw;
+ bool entire_thread;
+ bool omit_excluded;
+ bool output_body;
int part;
- notmuch_crypto_t crypto;
+ _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
str[strlen(str)-1] = '\0';
}
-notmuch_crypto_context_t *
-notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
+/* 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
+ * 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 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
+ * 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);
+
+int
+notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
int
-notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
+notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
int
-notmuch_count_command (void *ctx, int argc, char *argv[]);
+notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
int
-notmuch_dump_command (void *ctx, int argc, char *argv[]);
+notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
int
-notmuch_new_command (void *ctx, int argc, char *argv[]);
+notmuch_reindex_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);
show_one_part (const char *filename, int part);
void
-format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first);
+format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
+ bool output_body,
+ bool include_html);
void
-format_headers_json (const void *ctx, GMimeMessage *message, notmuch_bool_t reply);
+format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
+ bool reply);
typedef enum {
NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
/* notmuch-config.c */
-typedef struct _notmuch_config notmuch_config_t;
+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 *is_new_ret);
+ notmuch_config_mode_t config_mode);
void
notmuch_config_close (notmuch_config_t *config);
int
notmuch_config_save (notmuch_config_t *config);
+bool
+notmuch_config_is_new (notmuch_config_t *config);
+
const char *
notmuch_config_get_database_path (notmuch_config_t *config);
notmuch_config_set_database_path (notmuch_config_t *config,
const char *database_path);
+#if (GMIME_MAJOR_VERSION < 3)
+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);
+#endif
+
const char *
notmuch_config_get_user_name (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);
int
notmuch_run_hook (const char *db_path, const char *hook);
-notmuch_bool_t
+bool
debugger_is_active (void);
/* mime-node.c */
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
/* Internal: Context inherited from the root iterator. */
struct mime_node_context *ctx;
/* 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:
*/
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
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 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_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, notmuch_config_t *config);
+
#endif