+/* mime-node.c */
+
+/* mime_node_t represents a single node in a MIME tree. A MIME tree
+ * abstracts the different ways of traversing different types of MIME
+ * parts, allowing a MIME message to be viewed as a generic tree of
+ * parts. Message-type parts have one child, multipart-type parts
+ * have multiple children, and leaf parts have zero children.
+ */
+struct mime_node {
+ /* The MIME object of this part. This will be a GMimeMessage,
+ * GMimePart, GMimeMultipart, or a subclass of one of these.
+ *
+ * This will never be a GMimeMessagePart because GMimeMessagePart
+ * is structurally redundant with GMimeMessage. If this part is a
+ * message (that is, 'part' is a GMimeMessage), then either
+ * envelope_file will be set to a notmuch_message_t (for top-level
+ * messages) or envelope_part will be set to a GMimeMessagePart
+ * (for embedded message parts).
+ */
+ GMimeObject *part;
+
+ /* If part is a GMimeMessage, these record the envelope of the
+ * message: either a notmuch_message_t representing a top-level
+ * message, or a GMimeMessagePart representing a MIME part
+ * containing a message.
+ */
+ notmuch_message_t *envelope_file;
+ GMimeMessagePart *envelope_part;
+
+ /* The number of children of this part. */
+ int nchildren;
+
+ /* The parent of this node or NULL if this is the root node. */
+ struct mime_node *parent;
+
+ /* The depth-first part number of this child if the MIME tree is
+ * being traversed in depth-first order, or -1 otherwise. */
+ int part_num;
+
+ /* True if decryption of this part was 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). */
+ bool decrypt_success;
+
+ /* True if signature verification on this part was 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;
+
+ /* 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;
+
+ /* Internal: The next child for depth-first traversal and the part
+ * number to assign it (or -1 if unknown). */
+ int next_child;
+ int next_part_num;
+};
+
+/* 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 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_SUCCESS: Root node is returned in *node_out.
+ *
+ * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
+ *
+ * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
+ */
+notmuch_status_t
+mime_node_open (const void *ctx, notmuch_message_t *message,
+ _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
+ * node.
+ *
+ * In case of any failure, this function returns NULL, (after printing
+ * an error message on stderr).
+ */
+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. */
+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);
+