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
43 /* This is separate from notmuch-private.h because we're trying to
44 * keep notmuch.c from looking into any internals, (which helps us
45 * develop notmuch.h into a plausible library interface).
60 #define unused(x) x __attribute__ ((unused))
62 #define STRINGIFY(s) STRINGIFY_(s)
63 #define STRINGIFY_(s) #s
65 typedef struct mime_node mime_node_t;
66 struct notmuch_show_params;
68 typedef struct notmuch_show_format {
69 const char *message_set_start;
70 notmuch_status_t (*part) (const void *ctx,
71 struct mime_node *node, int indent,
72 const struct notmuch_show_params *params);
73 const char *message_set_sep;
74 const char *message_set_end;
75 } notmuch_show_format_t;
77 typedef struct notmuch_show_params {
78 notmuch_bool_t entire_thread;
79 notmuch_bool_t omit_excluded;
82 #ifdef GMIME_ATLEAST_26
83 GMimeCryptoContext* cryptoctx;
85 GMimeCipherContext* cryptoctx;
87 notmuch_bool_t decrypt;
88 } notmuch_show_params_t;
90 /* There's no point in continuing when we've detected that we've done
91 * something wrong internally (as opposed to the user passing in a
94 * Note that __location__ comes from talloc.h.
96 #define INTERNAL_ERROR(format, ...) \
99 "Internal error: " format " (%s)\n", \
100 ##__VA_ARGS__, __location__); \
104 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
106 #define STRNCMP_LITERAL(var, literal) \
107 strncmp ((var), (literal), sizeof (literal) - 1)
110 chomp_newline (char *str)
112 if (str && str[strlen(str)-1] == '\n')
113 str[strlen(str)-1] = '\0';
117 notmuch_count_command (void *ctx, int argc, char *argv[]);
120 notmuch_dump_command (void *ctx, int argc, char *argv[]);
123 notmuch_new_command (void *ctx, int argc, char *argv[]);
126 notmuch_reply_command (void *ctx, int argc, char *argv[]);
129 notmuch_restore_command (void *ctx, int argc, char *argv[]);
132 notmuch_search_command (void *ctx, int argc, char *argv[]);
135 notmuch_setup_command (void *ctx, int argc, char *argv[]);
138 notmuch_show_command (void *ctx, int argc, char *argv[]);
141 notmuch_tag_command (void *ctx, int argc, char *argv[]);
144 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
147 notmuch_cat_command (void *ctx, int argc, char *argv[]);
150 notmuch_config_command (void *ctx, int argc, char *argv[]);
153 notmuch_time_relative_date (const void *ctx, time_t then);
156 notmuch_time_print_formatted_seconds (double seconds);
159 notmuch_time_elapsed (struct timeval start, struct timeval end);
162 query_string_from_args (void *ctx, int argc, char *argv[]);
165 show_one_part (const char *filename, int part);
168 format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first);
171 format_headers_json (const void *ctx, GMimeMessage *message, notmuch_bool_t reply);
174 NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
175 } notmuch_show_text_part_flags;
178 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
179 notmuch_show_text_part_flags flags);
182 json_quote_chararray (const void *ctx, const char *str, const size_t len);
185 json_quote_str (const void *ctx, const char *str);
187 /* notmuch-config.c */
189 typedef struct _notmuch_config notmuch_config_t;
192 notmuch_config_open (void *ctx,
193 const char *filename,
194 notmuch_bool_t *is_new_ret);
197 notmuch_config_close (notmuch_config_t *config);
200 notmuch_config_save (notmuch_config_t *config);
203 notmuch_config_get_database_path (notmuch_config_t *config);
206 notmuch_config_set_database_path (notmuch_config_t *config,
207 const char *database_path);
210 notmuch_config_get_user_name (notmuch_config_t *config);
213 notmuch_config_set_user_name (notmuch_config_t *config,
214 const char *user_name);
217 notmuch_config_get_user_primary_email (notmuch_config_t *config);
220 notmuch_config_set_user_primary_email (notmuch_config_t *config,
221 const char *primary_email);
224 notmuch_config_get_user_other_email (notmuch_config_t *config,
228 notmuch_config_set_user_other_email (notmuch_config_t *config,
229 const char *other_email[],
233 notmuch_config_get_new_tags (notmuch_config_t *config,
236 notmuch_config_set_new_tags (notmuch_config_t *config,
237 const char *new_tags[],
241 notmuch_config_get_new_ignore (notmuch_config_t *config,
245 notmuch_config_set_new_ignore (notmuch_config_t *config,
246 const char *new_ignore[],
250 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
253 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
254 notmuch_bool_t synchronize_flags);
257 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
260 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
265 notmuch_run_hook (const char *db_path, const char *hook);
268 debugger_is_active (void);
272 /* mime_node_t represents a single node in a MIME tree. A MIME tree
273 * abstracts the different ways of traversing different types of MIME
274 * parts, allowing a MIME message to be viewed as a generic tree of
275 * parts. Message-type parts have one child, multipart-type parts
276 * have multiple children, and leaf parts have zero children.
279 /* The MIME object of this part. This will be a GMimeMessage,
280 * GMimePart, GMimeMultipart, or a subclass of one of these.
282 * This will never be a GMimeMessagePart because GMimeMessagePart
283 * is structurally redundant with GMimeMessage. If this part is a
284 * message (that is, 'part' is a GMimeMessage), then either
285 * envelope_file will be set to a notmuch_message_t (for top-level
286 * messages) or envelope_part will be set to a GMimeMessagePart
287 * (for embedded message parts).
291 /* If part is a GMimeMessage, these record the envelope of the
292 * message: either a notmuch_message_t representing a top-level
293 * message, or a GMimeMessagePart representing a MIME part
294 * containing a message.
296 notmuch_message_t *envelope_file;
297 GMimeMessagePart *envelope_part;
299 /* The number of children of this part. */
302 /* The parent of this node or NULL if this is the root node. */
303 struct mime_node *parent;
305 /* The depth-first part number of this child if the MIME tree is
306 * being traversed in depth-first order, or -1 otherwise. */
309 /* True if decryption of this part was attempted. */
310 notmuch_bool_t decrypt_attempted;
311 /* True if decryption of this part's child succeeded. In this
312 * case, the decrypted part is substituted for the second child of
313 * this part (which would usually be the encrypted data). */
314 notmuch_bool_t decrypt_success;
316 /* True if signature verification on this part was attempted. */
317 notmuch_bool_t verify_attempted;
318 #ifdef GMIME_ATLEAST_26
319 /* The list of signatures for signed or encrypted containers. If
320 * there are no signatures, this will be NULL. */
321 GMimeSignatureList* sig_list;
323 /* For signed or encrypted containers, the validity of the
324 * signature. May be NULL if signature verification failed. If
325 * there are simply no signatures, this will be non-NULL with an
326 * empty signers list. */
327 const GMimeSignatureValidity *sig_validity;
330 /* Internal: Context inherited from the root iterator. */
331 struct mime_node_context *ctx;
333 /* Internal: For successfully decrypted multipart parts, the
334 * decrypted part to substitute for the second child. */
335 GMimeObject *decrypted_child;
337 /* Internal: The next child for depth-first traversal and the part
338 * number to assign it (or -1 if unknown). */
343 /* Construct a new MIME node pointing to the root message part of
344 * message. If cryptoctx is non-NULL, it will be used to verify
345 * signatures on any child parts. If decrypt is true, then cryptoctx
346 * will additionally be used to decrypt any encrypted child parts.
350 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
352 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
354 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
357 mime_node_open (const void *ctx, notmuch_message_t *message,
358 #ifdef GMIME_ATLEAST_26
359 GMimeCryptoContext *cryptoctx,
361 GMimeCipherContext *cryptoctx,
363 notmuch_bool_t decrypt, mime_node_t **node_out);
365 /* Return a new MIME node for the requested child part of parent.
366 * parent will be used as the talloc context for the returned child
369 * In case of any failure, this function returns NULL, (after printing
370 * an error message on stderr).
373 mime_node_child (mime_node_t *parent, int child);
375 /* Return the nth child of node in a depth-first traversal. If n is
376 * 0, returns node itself. Returns NULL if there is no such part. */
378 mime_node_seek_dfs (mime_node_t *node, int n);
380 #include "command-line-arguments.h"