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
66 struct notmuch_show_params;
68 typedef struct notmuch_show_format {
69 const char *message_set_start;
70 void (*part) (const void *ctx,
71 struct mime_node *node, int indent,
72 const struct notmuch_show_params *params);
73 const char *message_start;
74 void (*message) (const void *ctx,
75 notmuch_message_t *message,
77 const char *header_start;
78 void (*header) (const void *ctx,
79 notmuch_message_t *message);
80 void (*header_message_part) (GMimeMessage *message);
81 const char *header_end;
82 const char *body_start;
83 void (*part_start) (GMimeObject *part,
85 void (*part_encstatus) (int status);
86 #ifdef GMIME_ATLEAST_26
87 void (*part_sigstatus) (GMimeSignatureList* siglist);
89 void (*part_sigstatus) (const GMimeSignatureValidity* validity);
91 void (*part_content) (GMimeObject *part);
92 void (*part_end) (GMimeObject *part);
95 const char *message_end;
96 const char *message_set_sep;
97 const char *message_set_end;
98 } notmuch_show_format_t;
100 typedef struct notmuch_show_params {
104 #ifdef GMIME_ATLEAST_26
105 GMimeCryptoContext* cryptoctx;
107 GMimeCipherContext* cryptoctx;
110 } notmuch_show_params_t;
112 /* There's no point in continuing when we've detected that we've done
113 * something wrong internally (as opposed to the user passing in a
116 * Note that __location__ comes from talloc.h.
118 #define INTERNAL_ERROR(format, ...) \
121 "Internal error: " format " (%s)\n", \
122 ##__VA_ARGS__, __location__); \
126 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
128 #define STRNCMP_LITERAL(var, literal) \
129 strncmp ((var), (literal), sizeof (literal) - 1)
132 chomp_newline (char *str)
134 if (str && str[strlen(str)-1] == '\n')
135 str[strlen(str)-1] = '\0';
139 notmuch_count_command (void *ctx, int argc, char *argv[]);
142 notmuch_dump_command (void *ctx, int argc, char *argv[]);
145 notmuch_new_command (void *ctx, int argc, char *argv[]);
148 notmuch_reply_command (void *ctx, int argc, char *argv[]);
151 notmuch_restore_command (void *ctx, int argc, char *argv[]);
154 notmuch_search_command (void *ctx, int argc, char *argv[]);
157 notmuch_setup_command (void *ctx, int argc, char *argv[]);
160 notmuch_show_command (void *ctx, int argc, char *argv[]);
163 notmuch_tag_command (void *ctx, int argc, char *argv[]);
166 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
169 notmuch_cat_command (void *ctx, int argc, char *argv[]);
172 notmuch_config_command (void *ctx, int argc, char *argv[]);
175 notmuch_time_relative_date (const void *ctx, time_t then);
178 notmuch_time_print_formatted_seconds (double seconds);
181 notmuch_time_elapsed (struct timeval start, struct timeval end);
184 query_string_from_args (void *ctx, int argc, char *argv[]);
187 show_message_body (notmuch_message_t *message,
188 const notmuch_show_format_t *format,
189 notmuch_show_params_t *params);
192 show_one_part (const char *filename, int part);
195 json_quote_chararray (const void *ctx, const char *str, const size_t len);
198 json_quote_str (const void *ctx, const char *str);
200 /* notmuch-config.c */
202 typedef struct _notmuch_config notmuch_config_t;
205 notmuch_config_open (void *ctx,
206 const char *filename,
207 notmuch_bool_t *is_new_ret);
210 notmuch_config_close (notmuch_config_t *config);
213 notmuch_config_save (notmuch_config_t *config);
216 notmuch_config_get_database_path (notmuch_config_t *config);
219 notmuch_config_set_database_path (notmuch_config_t *config,
220 const char *database_path);
223 notmuch_config_get_user_name (notmuch_config_t *config);
226 notmuch_config_set_user_name (notmuch_config_t *config,
227 const char *user_name);
230 notmuch_config_get_user_primary_email (notmuch_config_t *config);
233 notmuch_config_set_user_primary_email (notmuch_config_t *config,
234 const char *primary_email);
237 notmuch_config_get_user_other_email (notmuch_config_t *config,
241 notmuch_config_set_user_other_email (notmuch_config_t *config,
242 const char *other_email[],
246 notmuch_config_get_new_tags (notmuch_config_t *config,
249 notmuch_config_set_new_tags (notmuch_config_t *config,
250 const char *new_tags[],
254 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
257 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
258 notmuch_bool_t synchronize_flags);
261 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
264 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
269 notmuch_run_hook (const char *db_path, const char *hook);
272 debugger_is_active (void);
276 /* mime_node_t represents a single node in a MIME tree. A MIME tree
277 * abstracts the different ways of traversing different types of MIME
278 * parts, allowing a MIME message to be viewed as a generic tree of
279 * parts. Message-type parts have one child, multipart-type parts
280 * have multiple children, and leaf parts have zero children.
282 typedef struct mime_node {
283 /* The MIME object of this part. This will be a GMimeMessage,
284 * GMimePart, GMimeMultipart, or a subclass of one of these.
286 * This will never be a GMimeMessagePart because GMimeMessagePart
287 * is structurally redundant with GMimeMessage. If this part is a
288 * message (that is, 'part' is a GMimeMessage), then either
289 * envelope_file will be set to a notmuch_message_t (for top-level
290 * messages) or envelope_part will be set to a GMimeMessagePart
291 * (for embedded message parts).
295 /* If part is a GMimeMessage, these record the envelope of the
296 * message: either a notmuch_message_t representing a top-level
297 * message, or a GMimeMessagePart representing a MIME part
298 * containing a message.
300 notmuch_message_t *envelope_file;
301 GMimeMessagePart *envelope_part;
303 /* The number of children of this part. */
306 /* The parent of this node or NULL if this is the root node. */
307 struct mime_node *parent;
309 /* The depth-first part number of this child if the MIME tree is
310 * being traversed in depth-first order, or -1 otherwise. */
313 /* True if decryption of this part was attempted. */
314 notmuch_bool_t decrypt_attempted;
315 /* True if decryption of this part's child succeeded. In this
316 * case, the decrypted part is substituted for the second child of
317 * this part (which would usually be the encrypted data). */
318 notmuch_bool_t decrypt_success;
320 /* True if signature verification on this part was attempted. */
321 notmuch_bool_t verify_attempted;
322 #ifdef GMIME_ATLEAST_26
323 /* The list of signatures for signed or encrypted containers. If
324 * there are no signatures, this will be NULL. */
325 GMimeSignatureList* sig_list;
327 /* For signed or encrypted containers, the validity of the
328 * signature. May be NULL if signature verification failed. If
329 * there are simply no signatures, this will be non-NULL with an
330 * empty signers list. */
331 const GMimeSignatureValidity *sig_validity;
334 /* Internal: Context inherited from the root iterator. */
335 struct mime_node_context *ctx;
337 /* Internal: For successfully decrypted multipart parts, the
338 * decrypted part to substitute for the second child. */
339 GMimeObject *decrypted_child;
341 /* Internal: The next child for depth-first traversal and the part
342 * number to assign it (or -1 if unknown). */
347 /* Construct a new MIME node pointing to the root message part of
348 * message. If cryptoctx is non-NULL, it will be used to verify
349 * signatures on any child parts. If decrypt is true, then cryptoctx
350 * will additionally be used to decrypt any encrypted child parts.
354 * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
356 * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
358 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
361 mime_node_open (const void *ctx, notmuch_message_t *message,
362 #ifdef GMIME_ATLEAST_26
363 GMimeCryptoContext *cryptoctx,
365 GMimeCipherContext *cryptoctx,
367 notmuch_bool_t decrypt, mime_node_t **node_out);
369 /* Return a new MIME node for the requested child part of parent.
370 * parent will be used as the talloc context for the returned child
373 * In case of any failure, this function returns NULL, (after printing
374 * an error message on stderr).
377 mime_node_child (mime_node_t *parent, int child);
379 /* Return the nth child of node in a depth-first traversal. If n is
380 * 0, returns node itself. Returns NULL if there is no such part. */
382 mime_node_seek_dfs (mime_node_t *node, int n);
384 #include "command-line-arguments.h"