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).
54 #include "talloc-extra.h"
58 #define unused(x) x ## _unused __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_show_params {
79 _notmuch_crypto_t crypto;
81 GMimeStream *out_stream;
82 } notmuch_show_params_t;
84 /* There's no point in continuing when we've detected that we've done
85 * something wrong internally (as opposed to the user passing in a
88 * Note that __location__ comes from talloc.h.
90 #define INTERNAL_ERROR(format, ...) \
93 "Internal error: " format " (%s)\n", \
94 ##__VA_ARGS__, __location__); \
98 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
100 #define STRNCMP_LITERAL(var, literal) \
101 strncmp ((var), (literal), sizeof (literal) - 1)
104 chomp_newline (char *str)
106 if (str && str[strlen (str) - 1] == '\n')
107 str[strlen (str) - 1] = '\0';
110 /* Exit status code indicating temporary failure; user is invited to
113 * For example, file(s) in the mail store were removed or renamed
114 * after notmuch new scanned the directories but before indexing the
115 * file(s). If the file was renamed, the indexing might not be
116 * complete, and the user is advised to re-run notmuch new.
118 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
120 /* Exit status code indicating the requested format version is too old
121 * (support for that version has been dropped). CLI code should use
122 * notmuch_exit_if_unsupported_format rather than directly exiting
125 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
126 /* Exit status code indicating the requested format version is newer
127 * than the version supported by the CLI. CLI code should use
128 * notmuch_exit_if_unsupported_format rather than directly exiting
131 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
133 /* The current structured output format version. Requests for format
134 * versions above this will return an error. Backwards-incompatible
135 * changes such as removing map fields, changing the meaning of map
136 * fields, or changing the meanings of list elements should increase
137 * this. New (required) map fields can be added without increasing
140 #define NOTMUCH_FORMAT_CUR 4
141 /* The minimum supported structured output format version. Requests
142 * for format versions below this will return an error. */
143 #define NOTMUCH_FORMAT_MIN 1
144 /* The minimum non-deprecated structured output format version.
145 * Requests for format versions below this will print a stern warning.
146 * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
149 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
151 /* The output format version requested by the caller on the command
152 * line. If no format version is requested, this will be set to
153 * NOTMUCH_FORMAT_CUR. Even though the command-line option is
154 * per-command, this is global because commands can share structured
157 extern int notmuch_format_version;
159 typedef struct _notmuch_config notmuch_config_t;
161 /* Commands that support structured output should support the
163 * { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 }
164 * and should invoke notmuch_exit_if_unsupported_format to check the
165 * requested version. If notmuch_format_version is outside the
166 * supported range, this will print a detailed diagnostic message for
167 * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
168 * the invoking program of the problem.
171 notmuch_exit_if_unsupported_format (void);
174 notmuch_count_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
177 notmuch_dump_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
180 notmuch_new_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
183 notmuch_insert_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
186 notmuch_reindex_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
189 notmuch_reply_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
192 notmuch_restore_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
195 notmuch_search_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
198 notmuch_address_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
201 notmuch_setup_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
204 notmuch_show_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
207 notmuch_tag_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
210 notmuch_config_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
213 notmuch_compact_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
216 notmuch_time_relative_date (const void *ctx, time_t then);
219 notmuch_time_print_formatted_seconds (double seconds);
222 notmuch_time_elapsed (struct timeval start, struct timeval end);
225 query_string_from_args (void *ctx, int argc, char *argv[]);
228 show_one_part (const char *filename, int part);
231 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
236 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
237 bool reply, const _notmuch_message_crypto_t *msg_crypto);
240 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
241 } notmuch_show_text_part_flags;
244 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
245 notmuch_show_text_part_flags flags);
248 json_quote_chararray (const void *ctx, const char *str, const size_t len);
251 json_quote_str (const void *ctx, const char *str);
253 /* notmuch-config.c */
256 NOTMUCH_COMMAND_CONFIG_OPEN = 1 << 0,
257 NOTMUCH_COMMAND_CONFIG_CREATE = 1 << 1,
258 NOTMUCH_COMMAND_DATABASE_EARLY = 1 << 2,
259 NOTMUCH_COMMAND_DATABASE_WRITE = 1 << 3,
260 } notmuch_command_mode_t;
263 notmuch_config_open (void *ctx,
264 const char *filename,
265 notmuch_command_mode_t config_mode);
268 notmuch_config_close (notmuch_config_t *config);
271 notmuch_config_save (notmuch_config_t *config);
274 notmuch_config_is_new (notmuch_config_t *config);
277 notmuch_config_get_database_path (notmuch_config_t *config);
280 notmuch_config_set_database_path (notmuch_config_t *config,
281 const char *database_path);
284 notmuch_config_get_user_name (notmuch_config_t *config);
287 notmuch_config_set_user_name (notmuch_config_t *config,
288 const char *user_name);
291 notmuch_config_get_user_primary_email (notmuch_config_t *config);
294 notmuch_config_set_user_primary_email (notmuch_config_t *config,
295 const char *primary_email);
298 notmuch_config_get_user_other_email (notmuch_config_t *config,
302 notmuch_config_set_user_other_email (notmuch_config_t *config,
303 const char *other_email[],
307 notmuch_config_get_new_tags (notmuch_config_t *config,
310 notmuch_config_set_new_tags (notmuch_config_t *config,
311 const char *new_tags[],
315 notmuch_config_get_new_ignore (notmuch_config_t *config,
319 notmuch_config_set_new_ignore (notmuch_config_t *config,
320 const char *new_ignore[],
324 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
327 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
328 bool synchronize_flags);
331 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
334 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
338 _notmuch_config_get_path (notmuch_config_t *config);
341 notmuch_run_hook (const char *db_path, const char *hook);
344 debugger_is_active (void);
348 /* mime_node_t represents a single node in a MIME tree. A MIME tree
349 * abstracts the different ways of traversing different types of MIME
350 * parts, allowing a MIME message to be viewed as a generic tree of
351 * parts. Message-type parts have one child, multipart-type parts
352 * have multiple children, and leaf parts have zero children.
355 /* The MIME object of this part. This will be a GMimeMessage,
356 * GMimePart, GMimeMultipart, or a subclass of one of these.
358 * This will never be a GMimeMessagePart because GMimeMessagePart
359 * is structurally redundant with GMimeMessage. If this part is a
360 * message (that is, 'part' is a GMimeMessage), then either
361 * envelope_file will be set to a notmuch_message_t (for top-level
362 * messages) or envelope_part will be set to a GMimeMessagePart
363 * (for embedded message parts).
367 /* If part is a GMimeMessage, these record the envelope of the
368 * message: either a notmuch_message_t representing a top-level
369 * message, or a GMimeMessagePart representing a MIME part
370 * containing a message.
372 notmuch_message_t *envelope_file;
373 GMimeMessagePart *envelope_part;
375 /* The number of children of this part. */
378 /* The parent of this node or NULL if this is the root node. */
379 struct mime_node *parent;
381 /* The depth-first part number of this child if the MIME tree is
382 * being traversed in depth-first order, or -1 otherwise. */
385 /* True if decryption of this part was attempted. */
386 bool decrypt_attempted;
387 /* True if decryption of this part's child succeeded. In this
388 * case, the decrypted part is substituted for the second child of
389 * this part (which would usually be the encrypted data). */
390 bool decrypt_success;
392 /* True if signature verification on this part was attempted. */
393 bool verify_attempted;
395 /* The list of signatures for signed or encrypted containers. If
396 * there are no signatures, this will be NULL. */
397 GMimeSignatureList *sig_list;
399 /* Internal: Context inherited from the root iterator. */
400 struct mime_node_context *ctx;
402 /* Internal: For successfully decrypted multipart parts, the
403 * decrypted part to substitute for the second child; or, for
404 * PKCS#7 parts, the part returned after removing/processing the
405 * PKCS#7 transformation */
406 GMimeObject *unwrapped_child;
408 /* Internal: The next child for depth-first traversal and the part
409 * number to assign it (or -1 if unknown). */
414 /* Construct a new MIME node pointing to the root message part of
415 * message. If crypto->verify is true, signed child parts will be
416 * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
417 * child parts will be decrypted using either stored session keys or
418 * asymmetric crypto. If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
419 * only session keys will be tried. If the crypto contexts
420 * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
425 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
427 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
429 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
432 mime_node_open (const void *ctx, notmuch_message_t *message,
433 _notmuch_crypto_t *crypto, mime_node_t **node_out);
435 /* Return a new MIME node for the requested child part of parent.
436 * parent will be used as the talloc context for the returned child
439 * In case of any failure, this function returns NULL, (after printing
440 * an error message on stderr).
443 mime_node_child (mime_node_t *parent, int child);
445 /* Return the nth child of node in a depth-first traversal. If n is
446 * 0, returns node itself. Returns NULL if there is no such part. */
448 mime_node_seek_dfs (mime_node_t *node, int n);
450 const _notmuch_message_crypto_t *
451 mime_node_get_message_crypto_status (mime_node_t *node);
453 typedef enum dump_formats {
455 DUMP_FORMAT_BATCH_TAG,
459 typedef enum dump_includes {
460 DUMP_INCLUDE_TAGS = 1,
461 DUMP_INCLUDE_CONFIG = 2,
462 DUMP_INCLUDE_PROPERTIES = 4
465 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
467 #define NOTMUCH_DUMP_VERSION 3
470 notmuch_database_dump (notmuch_database_t *notmuch,
471 const char *output_file_name,
472 const char *query_str,
473 dump_format_t output_format,
474 dump_include_t include,
477 /* If status indicates error print appropriate
478 * messages to stderr.
482 print_status_query (const char *loc,
483 const notmuch_query_t *query,
484 notmuch_status_t status);
487 print_status_message (const char *loc,
488 const notmuch_message_t *message,
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);
500 print_status_gzbytes (const char *loc,
504 /* the __location__ macro is defined in talloc.h */
505 #define ASSERT_GZBYTES(file, bytes) ((print_status_gzbytes (__location__, file, bytes)) ? exit (1) : 0)
506 #define GZPRINTF(file, fmt, ...) ASSERT_GZBYTES (file, gzprintf (file, fmt, ##__VA_ARGS__));
507 #define GZPUTS(file, str) ASSERT_GZBYTES(file, gzputs (file, str));
509 #include "command-line-arguments.h"
511 extern const char *notmuch_requested_db_uuid;
512 extern const notmuch_opt_desc_t notmuch_shared_options [];
513 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
515 void notmuch_process_shared_options (const char *subcommand_name);
516 int notmuch_minimal_options (const char *subcommand_name,
517 int argc, char **argv);
520 /* the state chosen by the user invoking one of the notmuch
521 * subcommands that does indexing */
522 struct _notmuch_client_indexing_cli_choices {
524 bool decrypt_policy_set;
525 notmuch_indexopts_t *opts;
527 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
528 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
530 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch);