1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #ifndef NOTMUCH_CLIENT_H
22 #define NOTMUCH_CLIENT_H
25 #define _GNU_SOURCE /* for getline */
32 #include <gmime/gmime.h>
34 typedef GMimeCryptoContext notmuch_crypto_context_t;
35 /* This is automatically included only since gmime 2.6.10 */
36 #include <gmime/gmime-pkcs7-context.h>
40 /* This is separate from notmuch-private.h because we're trying to
41 * keep notmuch.c from looking into any internals, (which helps us
42 * develop notmuch.h into a plausible library interface).
56 #include "talloc-extra.h"
58 #define unused(x) x __attribute__ ((unused))
60 #define STRINGIFY(s) STRINGIFY_(s)
61 #define STRINGIFY_(s) #s
63 typedef struct mime_node mime_node_t;
65 struct notmuch_show_params;
67 typedef struct notmuch_show_format {
68 struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream);
69 notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter,
70 struct mime_node *node, int indent,
71 const struct notmuch_show_params *params);
72 } notmuch_show_format_t;
74 typedef struct notmuch_crypto {
75 notmuch_crypto_context_t* gpgctx;
76 notmuch_crypto_context_t* pkcs7ctx;
77 notmuch_bool_t verify;
78 notmuch_bool_t decrypt;
82 typedef struct notmuch_show_params {
83 notmuch_bool_t entire_thread;
84 notmuch_bool_t omit_excluded;
85 notmuch_bool_t output_body;
87 notmuch_crypto_t crypto;
88 notmuch_bool_t include_html;
89 } notmuch_show_params_t;
91 /* There's no point in continuing when we've detected that we've done
92 * something wrong internally (as opposed to the user passing in a
95 * Note that __location__ comes from talloc.h.
97 #define INTERNAL_ERROR(format, ...) \
100 "Internal error: " format " (%s)\n", \
101 ##__VA_ARGS__, __location__); \
105 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
107 #define STRNCMP_LITERAL(var, literal) \
108 strncmp ((var), (literal), sizeof (literal) - 1)
111 chomp_newline (char *str)
113 if (str && str[strlen(str)-1] == '\n')
114 str[strlen(str)-1] = '\0';
117 /* Exit status code indicating temporary failure; user is invited to
120 * For example, file(s) in the mail store were removed or renamed
121 * after notmuch new scanned the directories but before indexing the
122 * file(s). If the file was renamed, the indexing might not be
123 * complete, and the user is advised to re-run notmuch new.
125 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
127 /* Exit status code indicating the requested format version is too old
128 * (support for that version has been dropped). CLI code should use
129 * notmuch_exit_if_unsupported_format rather than directly exiting
132 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
133 /* Exit status code indicating the requested format version is newer
134 * than the version supported by the CLI. CLI code should use
135 * notmuch_exit_if_unsupported_format rather than directly exiting
138 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
140 /* The current structured output format version. Requests for format
141 * versions above this will return an error. Backwards-incompatible
142 * changes such as removing map fields, changing the meaning of map
143 * fields, or changing the meanings of list elements should increase
144 * this. New (required) map fields can be added without increasing
147 #define NOTMUCH_FORMAT_CUR 3
148 /* The minimum supported structured output format version. Requests
149 * for format versions below this will return an error. */
150 #define NOTMUCH_FORMAT_MIN 1
151 /* The minimum non-deprecated structured output format version.
152 * Requests for format versions below this will print a stern warning.
153 * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
156 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
158 /* The output format version requested by the caller on the command
159 * line. If no format version is requested, this will be set to
160 * NOTMUCH_FORMAT_CUR. Even though the command-line option is
161 * per-command, this is global because commands can share structured
164 extern int notmuch_format_version;
166 typedef struct _notmuch_config notmuch_config_t;
168 /* Commands that support structured output should support the
170 * { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 }
171 * and should invoke notmuch_exit_if_unsupported_format to check the
172 * requested version. If notmuch_format_version is outside the
173 * supported range, this will print a detailed diagnostic message for
174 * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
175 * the invoking program of the problem.
178 notmuch_exit_if_unsupported_format (void);
180 notmuch_crypto_context_t *
181 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
184 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
187 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
190 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
193 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
196 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
199 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
202 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
205 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
208 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
211 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
214 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
217 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
220 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
223 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
226 notmuch_time_relative_date (const void *ctx, time_t then);
229 notmuch_time_print_formatted_seconds (double seconds);
232 notmuch_time_elapsed (struct timeval start, struct timeval end);
235 query_string_from_args (void *ctx, int argc, char *argv[]);
238 show_one_part (const char *filename, int part);
241 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
242 notmuch_bool_t first, notmuch_bool_t output_body,
243 notmuch_bool_t include_html);
246 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
247 notmuch_bool_t reply);
250 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
251 } notmuch_show_text_part_flags;
254 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
255 notmuch_show_text_part_flags flags);
258 json_quote_chararray (const void *ctx, const char *str, const size_t len);
261 json_quote_str (const void *ctx, const char *str);
263 /* notmuch-config.c */
266 NOTMUCH_CONFIG_OPEN = 1 << 0,
267 NOTMUCH_CONFIG_CREATE = 1 << 1,
268 } notmuch_config_mode_t;
271 notmuch_config_open (void *ctx,
272 const char *filename,
273 notmuch_config_mode_t config_mode);
276 notmuch_config_close (notmuch_config_t *config);
279 notmuch_config_save (notmuch_config_t *config);
282 notmuch_config_is_new (notmuch_config_t *config);
285 notmuch_config_get_database_path (notmuch_config_t *config);
288 notmuch_config_set_database_path (notmuch_config_t *config,
289 const char *database_path);
292 notmuch_config_get_crypto_gpg_path (notmuch_config_t *config);
295 notmuch_config_set_crypto_gpg_path (notmuch_config_t *config,
296 const char *gpg_path);
299 notmuch_config_get_user_name (notmuch_config_t *config);
302 notmuch_config_set_user_name (notmuch_config_t *config,
303 const char *user_name);
306 notmuch_config_get_user_primary_email (notmuch_config_t *config);
309 notmuch_config_set_user_primary_email (notmuch_config_t *config,
310 const char *primary_email);
313 notmuch_config_get_user_other_email (notmuch_config_t *config,
317 notmuch_config_set_user_other_email (notmuch_config_t *config,
318 const char *other_email[],
322 notmuch_config_get_new_tags (notmuch_config_t *config,
325 notmuch_config_set_new_tags (notmuch_config_t *config,
326 const char *new_tags[],
330 notmuch_config_get_new_ignore (notmuch_config_t *config,
334 notmuch_config_set_new_ignore (notmuch_config_t *config,
335 const char *new_ignore[],
339 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
342 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
343 notmuch_bool_t synchronize_flags);
346 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
349 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
354 notmuch_run_hook (const char *db_path, const char *hook);
357 debugger_is_active (void);
361 /* mime_node_t represents a single node in a MIME tree. A MIME tree
362 * abstracts the different ways of traversing different types of MIME
363 * parts, allowing a MIME message to be viewed as a generic tree of
364 * parts. Message-type parts have one child, multipart-type parts
365 * have multiple children, and leaf parts have zero children.
368 /* The MIME object of this part. This will be a GMimeMessage,
369 * GMimePart, GMimeMultipart, or a subclass of one of these.
371 * This will never be a GMimeMessagePart because GMimeMessagePart
372 * is structurally redundant with GMimeMessage. If this part is a
373 * message (that is, 'part' is a GMimeMessage), then either
374 * envelope_file will be set to a notmuch_message_t (for top-level
375 * messages) or envelope_part will be set to a GMimeMessagePart
376 * (for embedded message parts).
380 /* If part is a GMimeMessage, these record the envelope of the
381 * message: either a notmuch_message_t representing a top-level
382 * message, or a GMimeMessagePart representing a MIME part
383 * containing a message.
385 notmuch_message_t *envelope_file;
386 GMimeMessagePart *envelope_part;
388 /* The number of children of this part. */
391 /* The parent of this node or NULL if this is the root node. */
392 struct mime_node *parent;
394 /* The depth-first part number of this child if the MIME tree is
395 * being traversed in depth-first order, or -1 otherwise. */
398 /* True if decryption of this part was attempted. */
399 notmuch_bool_t decrypt_attempted;
400 /* True if decryption of this part's child succeeded. In this
401 * case, the decrypted part is substituted for the second child of
402 * this part (which would usually be the encrypted data). */
403 notmuch_bool_t decrypt_success;
405 /* True if signature verification on this part was attempted. */
406 notmuch_bool_t verify_attempted;
408 /* The list of signatures for signed or encrypted containers. If
409 * there are no signatures, this will be NULL. */
410 GMimeSignatureList* sig_list;
412 /* Internal: Context inherited from the root iterator. */
413 struct mime_node_context *ctx;
415 /* Internal: For successfully decrypted multipart parts, the
416 * decrypted part to substitute for the second child. */
417 GMimeObject *decrypted_child;
419 /* Internal: The next child for depth-first traversal and the part
420 * number to assign it (or -1 if unknown). */
425 /* Construct a new MIME node pointing to the root message part of
426 * message. If crypto->verify is true, signed child parts will be
427 * verified. If crypto->decrypt is true, encrypted child parts will be
428 * decrypted. If the crypto contexts (crypto->gpgctx or
429 * crypto->pkcs7) are NULL, they will be lazily initialized.
433 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
435 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
437 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
440 mime_node_open (const void *ctx, notmuch_message_t *message,
441 notmuch_crypto_t *crypto, mime_node_t **node_out);
443 /* Return a new MIME node for the requested child part of parent.
444 * parent will be used as the talloc context for the returned child
447 * In case of any failure, this function returns NULL, (after printing
448 * an error message on stderr).
451 mime_node_child (mime_node_t *parent, int child);
453 /* Return the nth child of node in a depth-first traversal. If n is
454 * 0, returns node itself. Returns NULL if there is no such part. */
456 mime_node_seek_dfs (mime_node_t *node, int n);
458 typedef enum dump_formats {
460 DUMP_FORMAT_BATCH_TAG,
464 typedef enum dump_includes {
465 DUMP_INCLUDE_TAGS = 1,
466 DUMP_INCLUDE_CONFIG = 2,
467 DUMP_INCLUDE_PROPERTIES = 4
470 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
472 #define NOTMUCH_DUMP_VERSION 3
475 notmuch_database_dump (notmuch_database_t *notmuch,
476 const char *output_file_name,
477 const char *query_str,
478 dump_format_t output_format,
479 dump_include_t include,
480 notmuch_bool_t gzip_output);
482 /* If status is non-zero (i.e. error) print appropriate
487 print_status_query (const char *loc,
488 const notmuch_query_t *query,
489 notmuch_status_t status);
492 print_status_database (const char *loc,
493 const notmuch_database_t *database,
494 notmuch_status_t status);
497 status_to_exit (notmuch_status_t status);
499 #include "command-line-arguments.h"
501 extern char *notmuch_requested_db_uuid;
502 extern const notmuch_opt_desc_t notmuch_shared_options [];
503 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
505 void notmuch_process_shared_options (const char* subcommand_name);
506 int notmuch_minimal_options (const char* subcommand_name,
507 int argc, char **argv);