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,
175 int argc, char *argv[]);
178 notmuch_dump_command (notmuch_config_t *config, notmuch_database_t *notmuch,
179 int argc, char *argv[]);
182 notmuch_new_command (notmuch_config_t *config, notmuch_database_t *notmuch,
183 int argc, char *argv[]);
186 notmuch_insert_command (notmuch_config_t *config, notmuch_database_t *notmuch,
187 int argc, char *argv[]);
190 notmuch_reindex_command (notmuch_config_t *config, notmuch_database_t *notmuch,
191 int argc, char *argv[]);
194 notmuch_reply_command (notmuch_config_t *config, notmuch_database_t *notmuch,
195 int argc, char *argv[]);
198 notmuch_restore_command (notmuch_config_t *config, notmuch_database_t *notmuch,
199 int argc, char *argv[]);
202 notmuch_search_command (notmuch_config_t *config, notmuch_database_t *notmuch,
203 int argc, char *argv[]);
206 notmuch_address_command (notmuch_config_t *config, notmuch_database_t *notmuch,
207 int argc, char *argv[]);
210 notmuch_setup_command (notmuch_config_t *config, notmuch_database_t *notmuch,
211 int argc, char *argv[]);
214 notmuch_show_command (notmuch_config_t *config, notmuch_database_t *notmuch,
215 int argc, char *argv[]);
218 notmuch_tag_command (notmuch_config_t *config, notmuch_database_t *notmuch,
219 int argc, char *argv[]);
222 notmuch_config_command (notmuch_config_t *config, notmuch_database_t *notmuch,
223 int argc, char *argv[]);
226 notmuch_compact_command (notmuch_config_t *config, notmuch_database_t *notmuch,
227 int argc, char *argv[]);
230 notmuch_time_relative_date (const void *ctx, time_t then);
233 notmuch_time_print_formatted_seconds (double seconds);
236 notmuch_time_elapsed (struct timeval start, struct timeval end);
239 query_string_from_args (void *ctx, int argc, char *argv[]);
242 show_one_part (const char *filename, int part);
245 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
250 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
251 bool reply, const _notmuch_message_crypto_t *msg_crypto);
254 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
255 } notmuch_show_text_part_flags;
258 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
259 notmuch_show_text_part_flags flags);
262 json_quote_chararray (const void *ctx, const char *str, const size_t len);
265 json_quote_str (const void *ctx, const char *str);
267 /* notmuch-config.c */
270 NOTMUCH_COMMAND_CONFIG_OPEN = 1 << 0,
271 NOTMUCH_COMMAND_CONFIG_CREATE = 1 << 1,
272 NOTMUCH_COMMAND_DATABASE_EARLY = 1 << 2,
273 NOTMUCH_COMMAND_DATABASE_WRITE = 1 << 3,
274 NOTMUCH_COMMAND_DATABASE_CREATE = 1 << 4,
275 } notmuch_command_mode_t;
278 notmuch_config_open (void *ctx,
279 const char *filename,
280 notmuch_command_mode_t config_mode);
283 notmuch_config_close (notmuch_config_t *config);
286 notmuch_config_save (notmuch_config_t *config);
289 notmuch_config_is_new (notmuch_config_t *config);
292 notmuch_config_get_database_path (notmuch_config_t *config);
295 notmuch_config_set_database_path (notmuch_config_t *config,
296 const char *database_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 bool 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,
353 _notmuch_config_get_path (notmuch_config_t *config);
356 notmuch_run_hook (notmuch_database_t *notmuch, const char *hook);
359 debugger_is_active (void);
363 /* mime_node_t represents a single node in a MIME tree. A MIME tree
364 * abstracts the different ways of traversing different types of MIME
365 * parts, allowing a MIME message to be viewed as a generic tree of
366 * parts. Message-type parts have one child, multipart-type parts
367 * have multiple children, and leaf parts have zero children.
370 /* The MIME object of this part. This will be a GMimeMessage,
371 * GMimePart, GMimeMultipart, or a subclass of one of these.
373 * This will never be a GMimeMessagePart because GMimeMessagePart
374 * is structurally redundant with GMimeMessage. If this part is a
375 * message (that is, 'part' is a GMimeMessage), then either
376 * envelope_file will be set to a notmuch_message_t (for top-level
377 * messages) or envelope_part will be set to a GMimeMessagePart
378 * (for embedded message parts).
382 /* If part is a GMimeMessage, these record the envelope of the
383 * message: either a notmuch_message_t representing a top-level
384 * message, or a GMimeMessagePart representing a MIME part
385 * containing a message.
387 notmuch_message_t *envelope_file;
388 GMimeMessagePart *envelope_part;
390 /* The number of children of this part. */
393 /* The parent of this node or NULL if this is the root node. */
394 struct mime_node *parent;
396 /* The depth-first part number of this child if the MIME tree is
397 * being traversed in depth-first order, or -1 otherwise. */
400 /* True if decryption of this part was attempted. */
401 bool decrypt_attempted;
402 /* True if decryption of this part's child succeeded. In this
403 * case, the decrypted part is substituted for the second child of
404 * this part (which would usually be the encrypted data). */
405 bool decrypt_success;
407 /* True if signature verification on this part was attempted. */
408 bool verify_attempted;
410 /* The list of signatures for signed or encrypted containers. If
411 * there are no signatures, this will be NULL. */
412 GMimeSignatureList *sig_list;
414 /* Internal: Context inherited from the root iterator. */
415 struct mime_node_context *ctx;
417 /* Internal: For successfully decrypted multipart parts, the
418 * decrypted part to substitute for the second child; or, for
419 * PKCS#7 parts, the part returned after removing/processing the
420 * PKCS#7 transformation */
421 GMimeObject *unwrapped_child;
423 /* Internal: The next child for depth-first traversal and the part
424 * number to assign it (or -1 if unknown). */
429 /* Construct a new MIME node pointing to the root message part of
430 * message. If crypto->verify is true, signed child parts will be
431 * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
432 * child parts will be decrypted using either stored session keys or
433 * asymmetric crypto. If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
434 * only session keys will be tried. If the crypto contexts
435 * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
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 const _notmuch_message_crypto_t *
466 mime_node_get_message_crypto_status (mime_node_t *node);
468 typedef enum dump_formats {
470 DUMP_FORMAT_BATCH_TAG,
474 typedef enum dump_includes {
475 DUMP_INCLUDE_TAGS = 1,
476 DUMP_INCLUDE_CONFIG = 2,
477 DUMP_INCLUDE_PROPERTIES = 4
480 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
482 #define NOTMUCH_DUMP_VERSION 3
485 notmuch_database_dump (notmuch_database_t *notmuch,
486 const char *output_file_name,
487 const char *query_str,
488 dump_format_t output_format,
489 dump_include_t include,
492 /* If status indicates error print appropriate
493 * messages to stderr.
497 print_status_query (const char *loc,
498 const notmuch_query_t *query,
499 notmuch_status_t status);
502 print_status_message (const char *loc,
503 const notmuch_message_t *message,
504 notmuch_status_t status);
507 print_status_database (const char *loc,
508 const notmuch_database_t *database,
509 notmuch_status_t status);
512 status_to_exit (notmuch_status_t status);
515 print_status_gzbytes (const char *loc,
519 /* the __location__ macro is defined in talloc.h */
520 #define ASSERT_GZBYTES(file, bytes) ((print_status_gzbytes (__location__, file, bytes)) ? exit (1) : \
522 #define GZPRINTF(file, fmt, ...) ASSERT_GZBYTES (file, gzprintf (file, fmt, ##__VA_ARGS__));
523 #define GZPUTS(file, str) ASSERT_GZBYTES (file, gzputs (file, str));
525 #include "command-line-arguments.h"
527 extern const char *notmuch_requested_db_uuid;
528 extern const notmuch_opt_desc_t notmuch_shared_options [];
529 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
531 void notmuch_process_shared_options (const char *subcommand_name);
532 int notmuch_minimal_options (const char *subcommand_name,
533 int argc, char **argv);
536 /* the state chosen by the user invoking one of the notmuch
537 * subcommands that does indexing */
538 struct _notmuch_client_indexing_cli_choices {
540 bool decrypt_policy_set;
541 notmuch_indexopts_t *opts;
543 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
544 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
546 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch);