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-extra.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_bool_t verify;
76 notmuch_bool_t decrypt;
77 #if (GMIME_MAJOR_VERSION < 3)
78 notmuch_crypto_context_t* gpgctx;
79 notmuch_crypto_context_t* pkcs7ctx;
84 typedef struct notmuch_show_params {
85 notmuch_bool_t entire_thread;
86 notmuch_bool_t omit_excluded;
87 notmuch_bool_t output_body;
89 notmuch_crypto_t crypto;
90 notmuch_bool_t include_html;
91 GMimeStream *out_stream;
92 } notmuch_show_params_t;
94 /* There's no point in continuing when we've detected that we've done
95 * something wrong internally (as opposed to the user passing in a
98 * Note that __location__ comes from talloc.h.
100 #define INTERNAL_ERROR(format, ...) \
103 "Internal error: " format " (%s)\n", \
104 ##__VA_ARGS__, __location__); \
108 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
110 #define STRNCMP_LITERAL(var, literal) \
111 strncmp ((var), (literal), sizeof (literal) - 1)
114 chomp_newline (char *str)
116 if (str && str[strlen(str)-1] == '\n')
117 str[strlen(str)-1] = '\0';
120 /* Exit status code indicating temporary failure; user is invited to
123 * For example, file(s) in the mail store were removed or renamed
124 * after notmuch new scanned the directories but before indexing the
125 * file(s). If the file was renamed, the indexing might not be
126 * complete, and the user is advised to re-run notmuch new.
128 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
130 /* Exit status code indicating the requested format version is too old
131 * (support for that version has been dropped). CLI code should use
132 * notmuch_exit_if_unsupported_format rather than directly exiting
135 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
136 /* Exit status code indicating the requested format version is newer
137 * than the version supported by the CLI. CLI code should use
138 * notmuch_exit_if_unsupported_format rather than directly exiting
141 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
143 /* The current structured output format version. Requests for format
144 * versions above this will return an error. Backwards-incompatible
145 * changes such as removing map fields, changing the meaning of map
146 * fields, or changing the meanings of list elements should increase
147 * this. New (required) map fields can be added without increasing
150 #define NOTMUCH_FORMAT_CUR 4
151 /* The minimum supported structured output format version. Requests
152 * for format versions below this will return an error. */
153 #define NOTMUCH_FORMAT_MIN 1
154 /* The minimum non-deprecated structured output format version.
155 * Requests for format versions below this will print a stern warning.
156 * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
159 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
161 /* The output format version requested by the caller on the command
162 * line. If no format version is requested, this will be set to
163 * NOTMUCH_FORMAT_CUR. Even though the command-line option is
164 * per-command, this is global because commands can share structured
167 extern int notmuch_format_version;
169 typedef struct _notmuch_config notmuch_config_t;
171 /* Commands that support structured output should support the
173 * { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 }
174 * and should invoke notmuch_exit_if_unsupported_format to check the
175 * requested version. If notmuch_format_version is outside the
176 * supported range, this will print a detailed diagnostic message for
177 * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
178 * the invoking program of the problem.
181 notmuch_exit_if_unsupported_format (void);
183 #if (GMIME_MAJOR_VERSION <3)
184 notmuch_crypto_context_t *
185 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
189 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
192 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
195 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
198 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
201 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
204 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
207 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
210 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
213 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
216 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
219 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
222 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
225 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
228 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
231 notmuch_time_relative_date (const void *ctx, time_t then);
234 notmuch_time_print_formatted_seconds (double seconds);
237 notmuch_time_elapsed (struct timeval start, struct timeval end);
240 query_string_from_args (void *ctx, int argc, char *argv[]);
243 show_one_part (const char *filename, int part);
246 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
247 notmuch_bool_t first, notmuch_bool_t output_body,
248 notmuch_bool_t include_html);
251 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
252 notmuch_bool_t reply);
255 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
256 } notmuch_show_text_part_flags;
259 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
260 notmuch_show_text_part_flags flags);
263 json_quote_chararray (const void *ctx, const char *str, const size_t len);
266 json_quote_str (const void *ctx, const char *str);
268 /* notmuch-config.c */
271 NOTMUCH_CONFIG_OPEN = 1 << 0,
272 NOTMUCH_CONFIG_CREATE = 1 << 1,
273 } notmuch_config_mode_t;
276 notmuch_config_open (void *ctx,
277 const char *filename,
278 notmuch_config_mode_t config_mode);
281 notmuch_config_close (notmuch_config_t *config);
284 notmuch_config_save (notmuch_config_t *config);
287 notmuch_config_is_new (notmuch_config_t *config);
290 notmuch_config_get_database_path (notmuch_config_t *config);
293 notmuch_config_set_database_path (notmuch_config_t *config,
294 const char *database_path);
296 #if (GMIME_MAJOR_VERSION < 3)
298 notmuch_config_get_crypto_gpg_path (notmuch_config_t *config);
301 notmuch_config_set_crypto_gpg_path (notmuch_config_t *config,
302 const char *gpg_path);
306 notmuch_config_get_user_name (notmuch_config_t *config);
309 notmuch_config_set_user_name (notmuch_config_t *config,
310 const char *user_name);
313 notmuch_config_get_user_primary_email (notmuch_config_t *config);
316 notmuch_config_set_user_primary_email (notmuch_config_t *config,
317 const char *primary_email);
320 notmuch_config_get_user_other_email (notmuch_config_t *config,
324 notmuch_config_set_user_other_email (notmuch_config_t *config,
325 const char *other_email[],
329 notmuch_config_get_new_tags (notmuch_config_t *config,
332 notmuch_config_set_new_tags (notmuch_config_t *config,
333 const char *new_tags[],
337 notmuch_config_get_new_ignore (notmuch_config_t *config,
341 notmuch_config_set_new_ignore (notmuch_config_t *config,
342 const char *new_ignore[],
346 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
349 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
350 notmuch_bool_t synchronize_flags);
353 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
356 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
361 notmuch_run_hook (const char *db_path, const char *hook);
364 debugger_is_active (void);
368 /* mime_node_t represents a single node in a MIME tree. A MIME tree
369 * abstracts the different ways of traversing different types of MIME
370 * parts, allowing a MIME message to be viewed as a generic tree of
371 * parts. Message-type parts have one child, multipart-type parts
372 * have multiple children, and leaf parts have zero children.
375 /* The MIME object of this part. This will be a GMimeMessage,
376 * GMimePart, GMimeMultipart, or a subclass of one of these.
378 * This will never be a GMimeMessagePart because GMimeMessagePart
379 * is structurally redundant with GMimeMessage. If this part is a
380 * message (that is, 'part' is a GMimeMessage), then either
381 * envelope_file will be set to a notmuch_message_t (for top-level
382 * messages) or envelope_part will be set to a GMimeMessagePart
383 * (for embedded message parts).
387 /* If part is a GMimeMessage, these record the envelope of the
388 * message: either a notmuch_message_t representing a top-level
389 * message, or a GMimeMessagePart representing a MIME part
390 * containing a message.
392 notmuch_message_t *envelope_file;
393 GMimeMessagePart *envelope_part;
395 /* The number of children of this part. */
398 /* The parent of this node or NULL if this is the root node. */
399 struct mime_node *parent;
401 /* The depth-first part number of this child if the MIME tree is
402 * being traversed in depth-first order, or -1 otherwise. */
405 /* True if decryption of this part was attempted. */
406 notmuch_bool_t decrypt_attempted;
407 /* True if decryption of this part's child succeeded. In this
408 * case, the decrypted part is substituted for the second child of
409 * this part (which would usually be the encrypted data). */
410 notmuch_bool_t decrypt_success;
412 /* True if signature verification on this part was attempted. */
413 notmuch_bool_t verify_attempted;
415 /* The list of signatures for signed or encrypted containers. If
416 * there are no signatures, this will be NULL. */
417 GMimeSignatureList* sig_list;
419 /* Internal: Context inherited from the root iterator. */
420 struct mime_node_context *ctx;
422 /* Internal: For successfully decrypted multipart parts, the
423 * decrypted part to substitute for the second child. */
424 GMimeObject *decrypted_child;
426 /* Internal: The next child for depth-first traversal and the part
427 * number to assign it (or -1 if unknown). */
432 /* Construct a new MIME node pointing to the root message part of
433 * message. If crypto->verify is true, signed child parts will be
434 * verified. If crypto->decrypt is true, encrypted child parts will be
435 * decrypted. If the crypto contexts (crypto->gpgctx or
436 * crypto->pkcs7) are NULL, they will be lazily initialized.
440 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
442 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
444 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
447 mime_node_open (const void *ctx, notmuch_message_t *message,
448 notmuch_crypto_t *crypto, mime_node_t **node_out);
450 /* Return a new MIME node for the requested child part of parent.
451 * parent will be used as the talloc context for the returned child
454 * In case of any failure, this function returns NULL, (after printing
455 * an error message on stderr).
458 mime_node_child (mime_node_t *parent, int child);
460 /* Return the nth child of node in a depth-first traversal. If n is
461 * 0, returns node itself. Returns NULL if there is no such part. */
463 mime_node_seek_dfs (mime_node_t *node, int n);
465 typedef enum dump_formats {
467 DUMP_FORMAT_BATCH_TAG,
471 typedef enum dump_includes {
472 DUMP_INCLUDE_TAGS = 1,
473 DUMP_INCLUDE_CONFIG = 2,
474 DUMP_INCLUDE_PROPERTIES = 4
477 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
479 #define NOTMUCH_DUMP_VERSION 3
482 notmuch_database_dump (notmuch_database_t *notmuch,
483 const char *output_file_name,
484 const char *query_str,
485 dump_format_t output_format,
486 dump_include_t include,
487 notmuch_bool_t gzip_output);
489 /* If status is non-zero (i.e. error) print appropriate
494 print_status_query (const char *loc,
495 const notmuch_query_t *query,
496 notmuch_status_t status);
499 print_status_database (const char *loc,
500 const notmuch_database_t *database,
501 notmuch_status_t status);
504 status_to_exit (notmuch_status_t status);
506 #include "command-line-arguments.h"
508 extern char *notmuch_requested_db_uuid;
509 extern const notmuch_opt_desc_t notmuch_shared_options [];
510 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
512 void notmuch_process_shared_options (const char* subcommand_name);
513 int notmuch_minimal_options (const char* subcommand_name,
514 int argc, char **argv);