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 http://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 */
31 #include <gmime/gmime.h>
33 /* GMIME_CHECK_VERSION in gmime 2.4 is not usable from the
34 * preprocessor (it calls a runtime function). But since
35 * GMIME_MAJOR_VERSION and friends were added in gmime 2.6, we can use
36 * these to check the version number. */
37 #ifdef GMIME_MAJOR_VERSION
38 #define GMIME_ATLEAST_26
39 typedef GMimeCryptoContext notmuch_crypto_context_t;
41 typedef GMimeCipherContext notmuch_crypto_context_t;
46 /* This is separate from notmuch-private.h because we're trying to
47 * keep notmuch.c from looking into any internals, (which helps us
48 * develop notmuch.h into a plausible library interface).
62 #include "talloc-extra.h"
64 #define unused(x) x __attribute__ ((unused))
66 #define STRINGIFY(s) STRINGIFY_(s)
67 #define STRINGIFY_(s) #s
69 typedef struct mime_node mime_node_t;
71 struct notmuch_show_params;
73 typedef struct notmuch_show_format {
74 struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream);
75 notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter,
76 struct mime_node *node, int indent,
77 const struct notmuch_show_params *params);
78 } notmuch_show_format_t;
80 typedef struct notmuch_crypto {
81 notmuch_crypto_context_t* gpgctx;
82 notmuch_bool_t verify;
83 notmuch_bool_t decrypt;
86 typedef struct notmuch_show_params {
87 notmuch_bool_t entire_thread;
88 notmuch_bool_t omit_excluded;
89 notmuch_bool_t output_body;
92 notmuch_crypto_t crypto;
93 } notmuch_show_params_t;
95 /* There's no point in continuing when we've detected that we've done
96 * something wrong internally (as opposed to the user passing in a
99 * Note that __location__ comes from talloc.h.
101 #define INTERNAL_ERROR(format, ...) \
104 "Internal error: " format " (%s)\n", \
105 ##__VA_ARGS__, __location__); \
109 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
111 #define STRNCMP_LITERAL(var, literal) \
112 strncmp ((var), (literal), sizeof (literal) - 1)
115 chomp_newline (char *str)
117 if (str && str[strlen(str)-1] == '\n')
118 str[strlen(str)-1] = '\0';
121 /* Exit status code indicating the requested format version is too old
122 * (support for that version has been dropped). CLI code should use
123 * notmuch_exit_if_unsupported_format rather than directly exiting
126 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
127 /* Exit status code indicating the requested format version is newer
128 * than the version supported by the CLI. CLI code should use
129 * notmuch_exit_if_unsupported_format rather than directly exiting
132 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
134 /* The current structured output format version. Requests for format
135 * versions above this will return an error. Backwards-incompatible
136 * changes such as removing map fields, changing the meaning of map
137 * fields, or changing the meanings of list elements should increase
138 * this. New (required) map fields can be added without increasing
141 #define NOTMUCH_FORMAT_CUR 1
142 /* The minimum supported structured output format version. Requests
143 * for format versions below this will return an error. */
144 #define NOTMUCH_FORMAT_MIN 1
146 /* The output format version requested by the caller on the command
147 * line. If no format version is requested, this will be set to
148 * NOTMUCH_FORMAT_CUR. Even though the command-line option is
149 * per-command, this is global because commands can share structured
152 extern int notmuch_format_version;
154 typedef struct _notmuch_config notmuch_config_t;
156 /* Commands that support structured output should support the
158 * { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 }
159 * and should invoke notmuch_exit_if_unsupported_format to check the
160 * requested version. If notmuch_format_version is outside the
161 * supported range, this will print a detailed diagnostic message for
162 * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
163 * the invoking program of the problem.
166 notmuch_exit_if_unsupported_format (void);
168 notmuch_crypto_context_t *
169 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
172 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
175 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
178 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
181 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
184 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
187 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
190 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
193 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
196 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
199 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
202 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
205 notmuch_time_relative_date (const void *ctx, time_t then);
208 notmuch_time_print_formatted_seconds (double seconds);
211 notmuch_time_elapsed (struct timeval start, struct timeval end);
214 query_string_from_args (void *ctx, int argc, char *argv[]);
217 show_one_part (const char *filename, int part);
220 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
221 notmuch_bool_t first, notmuch_bool_t output_body);
224 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
225 notmuch_bool_t reply);
228 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
229 } notmuch_show_text_part_flags;
232 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
233 notmuch_show_text_part_flags flags);
236 json_quote_chararray (const void *ctx, const char *str, const size_t len);
239 json_quote_str (const void *ctx, const char *str);
241 /* notmuch-config.c */
244 notmuch_config_open (void *ctx,
245 const char *filename,
246 notmuch_bool_t create_new);
249 notmuch_config_close (notmuch_config_t *config);
252 notmuch_config_save (notmuch_config_t *config);
255 notmuch_config_is_new (notmuch_config_t *config);
258 notmuch_config_get_database_path (notmuch_config_t *config);
261 notmuch_config_set_database_path (notmuch_config_t *config,
262 const char *database_path);
265 notmuch_config_get_user_name (notmuch_config_t *config);
268 notmuch_config_set_user_name (notmuch_config_t *config,
269 const char *user_name);
272 notmuch_config_get_user_primary_email (notmuch_config_t *config);
275 notmuch_config_set_user_primary_email (notmuch_config_t *config,
276 const char *primary_email);
279 notmuch_config_get_user_other_email (notmuch_config_t *config,
283 notmuch_config_set_user_other_email (notmuch_config_t *config,
284 const char *other_email[],
288 notmuch_config_get_new_tags (notmuch_config_t *config,
291 notmuch_config_set_new_tags (notmuch_config_t *config,
292 const char *new_tags[],
296 notmuch_config_get_new_ignore (notmuch_config_t *config,
300 notmuch_config_set_new_ignore (notmuch_config_t *config,
301 const char *new_ignore[],
305 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
308 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
309 notmuch_bool_t synchronize_flags);
312 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
315 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
320 notmuch_run_hook (const char *db_path, const char *hook);
323 debugger_is_active (void);
327 /* mime_node_t represents a single node in a MIME tree. A MIME tree
328 * abstracts the different ways of traversing different types of MIME
329 * parts, allowing a MIME message to be viewed as a generic tree of
330 * parts. Message-type parts have one child, multipart-type parts
331 * have multiple children, and leaf parts have zero children.
334 /* The MIME object of this part. This will be a GMimeMessage,
335 * GMimePart, GMimeMultipart, or a subclass of one of these.
337 * This will never be a GMimeMessagePart because GMimeMessagePart
338 * is structurally redundant with GMimeMessage. If this part is a
339 * message (that is, 'part' is a GMimeMessage), then either
340 * envelope_file will be set to a notmuch_message_t (for top-level
341 * messages) or envelope_part will be set to a GMimeMessagePart
342 * (for embedded message parts).
346 /* If part is a GMimeMessage, these record the envelope of the
347 * message: either a notmuch_message_t representing a top-level
348 * message, or a GMimeMessagePart representing a MIME part
349 * containing a message.
351 notmuch_message_t *envelope_file;
352 GMimeMessagePart *envelope_part;
354 /* The number of children of this part. */
357 /* The parent of this node or NULL if this is the root node. */
358 struct mime_node *parent;
360 /* The depth-first part number of this child if the MIME tree is
361 * being traversed in depth-first order, or -1 otherwise. */
364 /* True if decryption of this part was attempted. */
365 notmuch_bool_t decrypt_attempted;
366 /* True if decryption of this part's child succeeded. In this
367 * case, the decrypted part is substituted for the second child of
368 * this part (which would usually be the encrypted data). */
369 notmuch_bool_t decrypt_success;
371 /* True if signature verification on this part was attempted. */
372 notmuch_bool_t verify_attempted;
373 #ifdef GMIME_ATLEAST_26
374 /* The list of signatures for signed or encrypted containers. If
375 * there are no signatures, this will be NULL. */
376 GMimeSignatureList* sig_list;
378 /* For signed or encrypted containers, the validity of the
379 * signature. May be NULL if signature verification failed. If
380 * there are simply no signatures, this will be non-NULL with an
381 * empty signers list. */
382 const GMimeSignatureValidity *sig_validity;
385 /* Internal: Context inherited from the root iterator. */
386 struct mime_node_context *ctx;
388 /* Internal: For successfully decrypted multipart parts, the
389 * decrypted part to substitute for the second child. */
390 GMimeObject *decrypted_child;
392 /* Internal: The next child for depth-first traversal and the part
393 * number to assign it (or -1 if unknown). */
398 /* Construct a new MIME node pointing to the root message part of
399 * message. If crypto->verify is true, signed child parts will be
400 * verified. If crypto->decrypt is true, encrypted child parts will be
401 * decrypted. If crypto->gpgctx is NULL, it will be lazily
406 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
408 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
410 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
413 mime_node_open (const void *ctx, notmuch_message_t *message,
414 notmuch_crypto_t *crypto, mime_node_t **node_out);
416 /* Return a new MIME node for the requested child part of parent.
417 * parent will be used as the talloc context for the returned child
420 * In case of any failure, this function returns NULL, (after printing
421 * an error message on stderr).
424 mime_node_child (mime_node_t *parent, int child);
426 /* Return the nth child of node in a depth-first traversal. If n is
427 * 0, returns node itself. Returns NULL if there is no such part. */
429 mime_node_seek_dfs (mime_node_t *node, int n);
431 #include "command-line-arguments.h"