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"
57 #define unused(x) x ## _unused __attribute__ ((unused))
59 #define STRINGIFY(s) STRINGIFY_ (s)
60 #define STRINGIFY_(s) #s
62 typedef struct mime_node mime_node_t;
64 struct notmuch_show_params;
66 typedef struct notmuch_show_format {
67 struct sprinter *(*new_sprinter)(const void *ctx, FILE *stream);
68 notmuch_status_t (*part)(const void *ctx, struct sprinter *sprinter,
69 struct mime_node *node, int indent,
70 const struct notmuch_show_params *params);
71 } notmuch_show_format_t;
73 typedef struct notmuch_show_params {
78 _notmuch_crypto_t crypto;
80 GMimeStream *out_stream;
81 } notmuch_show_params_t;
83 /* There's no point in continuing when we've detected that we've done
84 * something wrong internally (as opposed to the user passing in a
87 * Note that __location__ comes from talloc.h.
89 #define INTERNAL_ERROR(format, ...) \
92 "Internal error: " format " (%s)\n", \
93 ##__VA_ARGS__, __location__); \
97 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
99 #define STRNCMP_LITERAL(var, literal) \
100 strncmp ((var), (literal), sizeof (literal) - 1)
103 chomp_newline (char *str)
105 if (str && str[strlen (str) - 1] == '\n')
106 str[strlen (str) - 1] = '\0';
109 /* Exit status code indicating temporary failure; user is invited to
112 * For example, file(s) in the mail store were removed or renamed
113 * after notmuch new scanned the directories but before indexing the
114 * file(s). If the file was renamed, the indexing might not be
115 * complete, and the user is advised to re-run notmuch new.
117 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
119 /* Exit status code indicating the requested format version is too old
120 * (support for that version has been dropped). CLI code should use
121 * notmuch_exit_if_unsupported_format rather than directly exiting
124 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
125 /* Exit status code indicating the requested format version is newer
126 * than the version supported by the CLI. CLI code should use
127 * notmuch_exit_if_unsupported_format rather than directly exiting
130 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
132 /* The current structured output format version. Requests for format
133 * versions above this will return an error. Backwards-incompatible
134 * changes such as removing map fields, changing the meaning of map
135 * fields, or changing the meanings of list elements should increase
136 * this. New (required) map fields can be added without increasing
139 #define NOTMUCH_FORMAT_CUR 4
140 /* The minimum supported structured output format version. Requests
141 * for format versions below this will return an error. */
142 #define NOTMUCH_FORMAT_MIN 1
143 /* The minimum non-deprecated structured output format version.
144 * Requests for format versions below this will print a stern warning.
145 * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
148 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
150 /* The output format version requested by the caller on the command
151 * line. If no format version is requested, this will be set to
152 * NOTMUCH_FORMAT_CUR. Even though the command-line option is
153 * per-command, this is global because commands can share structured
156 extern int notmuch_format_version;
158 typedef struct _notmuch_config notmuch_config_t;
160 /* Commands that support structured output should support the
162 * { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 }
163 * and should invoke notmuch_exit_if_unsupported_format to check the
164 * requested version. If notmuch_format_version is outside the
165 * supported range, this will print a detailed diagnostic message for
166 * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
167 * the invoking program of the problem.
170 notmuch_exit_if_unsupported_format (void);
173 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
176 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
179 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
182 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
185 notmuch_reindex_command (notmuch_config_t *config, int argc, char *argv[]);
188 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
191 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
194 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
197 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
200 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
203 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
206 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
209 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
212 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
215 notmuch_time_relative_date (const void *ctx, time_t then);
218 notmuch_time_print_formatted_seconds (double seconds);
221 notmuch_time_elapsed (struct timeval start, struct timeval end);
224 query_string_from_args (void *ctx, int argc, char *argv[]);
227 show_one_part (const char *filename, int part);
230 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
235 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
236 bool reply, const _notmuch_message_crypto_t *msg_crypto);
239 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
240 } notmuch_show_text_part_flags;
243 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
244 notmuch_show_text_part_flags flags);
247 json_quote_chararray (const void *ctx, const char *str, const size_t len);
250 json_quote_str (const void *ctx, const char *str);
252 /* notmuch-config.c */
255 NOTMUCH_CONFIG_OPEN = 1 << 0,
256 NOTMUCH_CONFIG_CREATE = 1 << 1,
257 } notmuch_config_mode_t;
260 notmuch_config_open (void *ctx,
261 const char *filename,
262 notmuch_config_mode_t config_mode);
265 notmuch_config_close (notmuch_config_t *config);
268 notmuch_config_save (notmuch_config_t *config);
271 notmuch_config_is_new (notmuch_config_t *config);
274 notmuch_config_get_database_path (notmuch_config_t *config);
277 notmuch_config_set_database_path (notmuch_config_t *config,
278 const char *database_path);
281 notmuch_config_get_user_name (notmuch_config_t *config);
284 notmuch_config_set_user_name (notmuch_config_t *config,
285 const char *user_name);
288 notmuch_config_get_user_primary_email (notmuch_config_t *config);
291 notmuch_config_set_user_primary_email (notmuch_config_t *config,
292 const char *primary_email);
295 notmuch_config_get_user_other_email (notmuch_config_t *config,
299 notmuch_config_set_user_other_email (notmuch_config_t *config,
300 const char *other_email[],
304 notmuch_config_get_new_tags (notmuch_config_t *config,
307 notmuch_config_set_new_tags (notmuch_config_t *config,
308 const char *new_tags[],
312 notmuch_config_get_new_ignore (notmuch_config_t *config,
316 notmuch_config_set_new_ignore (notmuch_config_t *config,
317 const char *new_ignore[],
321 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
324 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
325 bool synchronize_flags);
328 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
331 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
336 notmuch_run_hook (const char *db_path, const char *hook);
339 debugger_is_active (void);
343 /* mime_node_t represents a single node in a MIME tree. A MIME tree
344 * abstracts the different ways of traversing different types of MIME
345 * parts, allowing a MIME message to be viewed as a generic tree of
346 * parts. Message-type parts have one child, multipart-type parts
347 * have multiple children, and leaf parts have zero children.
350 /* The MIME object of this part. This will be a GMimeMessage,
351 * GMimePart, GMimeMultipart, or a subclass of one of these.
353 * This will never be a GMimeMessagePart because GMimeMessagePart
354 * is structurally redundant with GMimeMessage. If this part is a
355 * message (that is, 'part' is a GMimeMessage), then either
356 * envelope_file will be set to a notmuch_message_t (for top-level
357 * messages) or envelope_part will be set to a GMimeMessagePart
358 * (for embedded message parts).
362 /* If part is a GMimeMessage, these record the envelope of the
363 * message: either a notmuch_message_t representing a top-level
364 * message, or a GMimeMessagePart representing a MIME part
365 * containing a message.
367 notmuch_message_t *envelope_file;
368 GMimeMessagePart *envelope_part;
370 /* The number of children of this part. */
373 /* The parent of this node or NULL if this is the root node. */
374 struct mime_node *parent;
376 /* The depth-first part number of this child if the MIME tree is
377 * being traversed in depth-first order, or -1 otherwise. */
380 /* True if decryption of this part was attempted. */
381 bool decrypt_attempted;
382 /* True if decryption of this part's child succeeded. In this
383 * case, the decrypted part is substituted for the second child of
384 * this part (which would usually be the encrypted data). */
385 bool decrypt_success;
387 /* True if signature verification on this part was attempted. */
388 bool verify_attempted;
390 /* The list of signatures for signed or encrypted containers. If
391 * there are no signatures, this will be NULL. */
392 GMimeSignatureList *sig_list;
394 /* Internal: Context inherited from the root iterator. */
395 struct mime_node_context *ctx;
397 /* Internal: For successfully decrypted multipart parts, the
398 * decrypted part to substitute for the second child. */
399 GMimeObject *decrypted_child;
401 /* Internal: The next child for depth-first traversal and the part
402 * number to assign it (or -1 if unknown). */
407 /* Construct a new MIME node pointing to the root message part of
408 * message. If crypto->verify is true, signed child parts will be
409 * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
410 * child parts will be decrypted using either stored session keys or
411 * asymmetric crypto. If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
412 * only session keys will be tried. If the crypto contexts
413 * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
418 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
420 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
422 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
425 mime_node_open (const void *ctx, notmuch_message_t *message,
426 _notmuch_crypto_t *crypto, mime_node_t **node_out);
428 /* Return a new MIME node for the requested child part of parent.
429 * parent will be used as the talloc context for the returned child
432 * In case of any failure, this function returns NULL, (after printing
433 * an error message on stderr).
436 mime_node_child (mime_node_t *parent, int child);
438 /* Return the nth child of node in a depth-first traversal. If n is
439 * 0, returns node itself. Returns NULL if there is no such part. */
441 mime_node_seek_dfs (mime_node_t *node, int n);
443 const _notmuch_message_crypto_t *
444 mime_node_get_message_crypto_status (mime_node_t *node);
446 typedef enum dump_formats {
448 DUMP_FORMAT_BATCH_TAG,
452 typedef enum dump_includes {
453 DUMP_INCLUDE_TAGS = 1,
454 DUMP_INCLUDE_CONFIG = 2,
455 DUMP_INCLUDE_PROPERTIES = 4
458 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
460 #define NOTMUCH_DUMP_VERSION 3
463 notmuch_database_dump (notmuch_database_t *notmuch,
464 const char *output_file_name,
465 const char *query_str,
466 dump_format_t output_format,
467 dump_include_t include,
470 /* If status is non-zero (i.e. error) print appropriate
471 * messages to stderr.
475 print_status_query (const char *loc,
476 const notmuch_query_t *query,
477 notmuch_status_t status);
480 print_status_message (const char *loc,
481 const notmuch_message_t *message,
482 notmuch_status_t status);
485 print_status_database (const char *loc,
486 const notmuch_database_t *database,
487 notmuch_status_t status);
490 status_to_exit (notmuch_status_t status);
492 #include "command-line-arguments.h"
494 extern const char *notmuch_requested_db_uuid;
495 extern const notmuch_opt_desc_t notmuch_shared_options [];
496 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
498 void notmuch_process_shared_options (const char *subcommand_name);
499 int notmuch_minimal_options (const char *subcommand_name,
500 int argc, char **argv);
503 /* the state chosen by the user invoking one of the notmuch
504 * subcommands that does indexing */
505 struct _notmuch_client_indexing_cli_choices {
507 bool decrypt_policy_set;
508 notmuch_indexopts_t *opts;
510 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
511 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
513 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch);