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 */
33 #include "gmime-extra.h"
37 /* This is separate from notmuch-private.h because we're trying to
38 * keep notmuch.c from looking into any internals, (which helps us
39 * develop notmuch.h into a plausible library interface).
53 #include "talloc-extra.h"
56 #define unused(x) x __attribute__ ((unused))
58 #define STRINGIFY(s) STRINGIFY_(s)
59 #define STRINGIFY_(s) #s
61 typedef struct mime_node mime_node_t;
63 struct notmuch_show_params;
65 typedef struct notmuch_show_format {
66 struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream);
67 notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter,
68 struct mime_node *node, int indent,
69 const struct notmuch_show_params *params);
70 } notmuch_show_format_t;
72 typedef struct notmuch_show_params {
77 _notmuch_crypto_t crypto;
79 GMimeStream *out_stream;
80 } notmuch_show_params_t;
82 /* There's no point in continuing when we've detected that we've done
83 * something wrong internally (as opposed to the user passing in a
86 * Note that __location__ comes from talloc.h.
88 #define INTERNAL_ERROR(format, ...) \
91 "Internal error: " format " (%s)\n", \
92 ##__VA_ARGS__, __location__); \
96 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
98 #define STRNCMP_LITERAL(var, literal) \
99 strncmp ((var), (literal), sizeof (literal) - 1)
102 chomp_newline (char *str)
104 if (str && str[strlen(str)-1] == '\n')
105 str[strlen(str)-1] = '\0';
108 /* Exit status code indicating temporary failure; user is invited to
111 * For example, file(s) in the mail store were removed or renamed
112 * after notmuch new scanned the directories but before indexing the
113 * file(s). If the file was renamed, the indexing might not be
114 * complete, and the user is advised to re-run notmuch new.
116 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
118 /* Exit status code indicating the requested format version is too old
119 * (support for that version has been dropped). CLI code should use
120 * notmuch_exit_if_unsupported_format rather than directly exiting
123 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
124 /* Exit status code indicating the requested format version is newer
125 * than the version supported by the CLI. CLI code should use
126 * notmuch_exit_if_unsupported_format rather than directly exiting
129 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
131 /* The current structured output format version. Requests for format
132 * versions above this will return an error. Backwards-incompatible
133 * changes such as removing map fields, changing the meaning of map
134 * fields, or changing the meanings of list elements should increase
135 * this. New (required) map fields can be added without increasing
138 #define NOTMUCH_FORMAT_CUR 4
139 /* The minimum supported structured output format version. Requests
140 * for format versions below this will return an error. */
141 #define NOTMUCH_FORMAT_MIN 1
142 /* The minimum non-deprecated structured output format version.
143 * Requests for format versions below this will print a stern warning.
144 * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
147 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
149 /* The output format version requested by the caller on the command
150 * line. If no format version is requested, this will be set to
151 * NOTMUCH_FORMAT_CUR. Even though the command-line option is
152 * per-command, this is global because commands can share structured
155 extern int notmuch_format_version;
157 typedef struct _notmuch_config notmuch_config_t;
159 /* Commands that support structured output should support the
161 * { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 }
162 * and should invoke notmuch_exit_if_unsupported_format to check the
163 * requested version. If notmuch_format_version is outside the
164 * supported range, this will print a detailed diagnostic message for
165 * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
166 * the invoking program of the problem.
169 notmuch_exit_if_unsupported_format (void);
172 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
175 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
178 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
181 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
184 notmuch_reindex_command (notmuch_config_t *config, int argc, char *argv[]);
187 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
190 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
193 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
196 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
199 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
202 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
205 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
208 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
211 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
214 notmuch_time_relative_date (const void *ctx, time_t then);
217 notmuch_time_print_formatted_seconds (double seconds);
220 notmuch_time_elapsed (struct timeval start, struct timeval end);
223 query_string_from_args (void *ctx, int argc, char *argv[]);
226 show_one_part (const char *filename, int part);
229 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
234 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
238 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
239 } notmuch_show_text_part_flags;
242 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
243 notmuch_show_text_part_flags flags);
246 json_quote_chararray (const void *ctx, const char *str, const size_t len);
249 json_quote_str (const void *ctx, const char *str);
251 /* notmuch-config.c */
254 NOTMUCH_CONFIG_OPEN = 1 << 0,
255 NOTMUCH_CONFIG_CREATE = 1 << 1,
256 } notmuch_config_mode_t;
259 notmuch_config_open (void *ctx,
260 const char *filename,
261 notmuch_config_mode_t config_mode);
264 notmuch_config_close (notmuch_config_t *config);
267 notmuch_config_save (notmuch_config_t *config);
270 notmuch_config_is_new (notmuch_config_t *config);
273 notmuch_config_get_database_path (notmuch_config_t *config);
276 notmuch_config_set_database_path (notmuch_config_t *config,
277 const char *database_path);
279 #if (GMIME_MAJOR_VERSION < 3)
281 notmuch_config_get_crypto_gpg_path (notmuch_config_t *config);
284 notmuch_config_set_crypto_gpg_path (notmuch_config_t *config,
285 const char *gpg_path);
289 notmuch_config_get_user_name (notmuch_config_t *config);
292 notmuch_config_set_user_name (notmuch_config_t *config,
293 const char *user_name);
296 notmuch_config_get_user_primary_email (notmuch_config_t *config);
299 notmuch_config_set_user_primary_email (notmuch_config_t *config,
300 const char *primary_email);
303 notmuch_config_get_user_other_email (notmuch_config_t *config,
307 notmuch_config_set_user_other_email (notmuch_config_t *config,
308 const char *other_email[],
312 notmuch_config_get_new_tags (notmuch_config_t *config,
315 notmuch_config_set_new_tags (notmuch_config_t *config,
316 const char *new_tags[],
320 notmuch_config_get_new_ignore (notmuch_config_t *config,
324 notmuch_config_set_new_ignore (notmuch_config_t *config,
325 const char *new_ignore[],
329 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
332 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
333 bool synchronize_flags);
336 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
339 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
344 notmuch_run_hook (const char *db_path, const char *hook);
347 debugger_is_active (void);
351 /* mime_node_t represents a single node in a MIME tree. A MIME tree
352 * abstracts the different ways of traversing different types of MIME
353 * parts, allowing a MIME message to be viewed as a generic tree of
354 * parts. Message-type parts have one child, multipart-type parts
355 * have multiple children, and leaf parts have zero children.
358 /* The MIME object of this part. This will be a GMimeMessage,
359 * GMimePart, GMimeMultipart, or a subclass of one of these.
361 * This will never be a GMimeMessagePart because GMimeMessagePart
362 * is structurally redundant with GMimeMessage. If this part is a
363 * message (that is, 'part' is a GMimeMessage), then either
364 * envelope_file will be set to a notmuch_message_t (for top-level
365 * messages) or envelope_part will be set to a GMimeMessagePart
366 * (for embedded message parts).
370 /* If part is a GMimeMessage, these record the envelope of the
371 * message: either a notmuch_message_t representing a top-level
372 * message, or a GMimeMessagePart representing a MIME part
373 * containing a message.
375 notmuch_message_t *envelope_file;
376 GMimeMessagePart *envelope_part;
378 /* The number of children of this part. */
381 /* The parent of this node or NULL if this is the root node. */
382 struct mime_node *parent;
384 /* The depth-first part number of this child if the MIME tree is
385 * being traversed in depth-first order, or -1 otherwise. */
388 /* True if decryption of this part was attempted. */
389 bool decrypt_attempted;
390 /* True if decryption of this part's child succeeded. In this
391 * case, the decrypted part is substituted for the second child of
392 * this part (which would usually be the encrypted data). */
393 bool decrypt_success;
395 /* True if signature verification on this part was attempted. */
396 bool verify_attempted;
398 /* The list of signatures for signed or encrypted containers. If
399 * there are no signatures, this will be NULL. */
400 GMimeSignatureList* sig_list;
402 /* Internal: Context inherited from the root iterator. */
403 struct mime_node_context *ctx;
405 /* Internal: For successfully decrypted multipart parts, the
406 * decrypted part to substitute for the second child. */
407 GMimeObject *decrypted_child;
409 /* Internal: The next child for depth-first traversal and the part
410 * number to assign it (or -1 if unknown). */
415 /* Construct a new MIME node pointing to the root message part of
416 * message. If crypto->verify is true, signed child parts will be
417 * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
418 * child parts will be decrypted using either stored session keys or
419 * asymmetric crypto. If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
420 * only session keys will be tried. If the crypto contexts
421 * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
426 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
428 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
430 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
433 mime_node_open (const void *ctx, notmuch_message_t *message,
434 _notmuch_crypto_t *crypto, mime_node_t **node_out);
436 /* Return a new MIME node for the requested child part of parent.
437 * parent will be used as the talloc context for the returned child
440 * In case of any failure, this function returns NULL, (after printing
441 * an error message on stderr).
444 mime_node_child (mime_node_t *parent, int child);
446 /* Return the nth child of node in a depth-first traversal. If n is
447 * 0, returns node itself. Returns NULL if there is no such part. */
449 mime_node_seek_dfs (mime_node_t *node, int n);
451 typedef enum dump_formats {
453 DUMP_FORMAT_BATCH_TAG,
457 typedef enum dump_includes {
458 DUMP_INCLUDE_TAGS = 1,
459 DUMP_INCLUDE_CONFIG = 2,
460 DUMP_INCLUDE_PROPERTIES = 4
463 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
465 #define NOTMUCH_DUMP_VERSION 3
468 notmuch_database_dump (notmuch_database_t *notmuch,
469 const char *output_file_name,
470 const char *query_str,
471 dump_format_t output_format,
472 dump_include_t include,
475 /* If status is non-zero (i.e. error) print appropriate
480 print_status_query (const char *loc,
481 const notmuch_query_t *query,
482 notmuch_status_t status);
485 print_status_message (const char *loc,
486 const notmuch_message_t *message,
487 notmuch_status_t status);
490 print_status_database (const char *loc,
491 const notmuch_database_t *database,
492 notmuch_status_t status);
495 status_to_exit (notmuch_status_t status);
497 #include "command-line-arguments.h"
499 extern const char *notmuch_requested_db_uuid;
500 extern const notmuch_opt_desc_t notmuch_shared_options [];
501 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
503 void notmuch_process_shared_options (const char* subcommand_name);
504 int notmuch_minimal_options (const char* subcommand_name,
505 int argc, char **argv);
508 /* the state chosen by the user invoking one of the notmuch
509 * subcommands that does indexing */
510 struct _notmuch_client_indexing_cli_choices {
512 bool decrypt_policy_set;
513 notmuch_indexopts_t * opts;
515 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
516 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
518 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch, notmuch_config_t *config);