cli: modify mime_node_open to take new crypto struct as argument
[notmuch] / notmuch-client.h
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
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/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_CLIENT_H
22 #define NOTMUCH_CLIENT_H
23
24 #ifndef _GNU_SOURCE
25 #define _GNU_SOURCE /* for getline */
26 #endif
27 #include <stdio.h>
28
29 #include "compat.h"
30
31 #include <gmime/gmime.h>
32
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;
40 #else
41 typedef GMimeCipherContext notmuch_crypto_context_t;
42 #endif
43
44 #include "notmuch.h"
45
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).
49  */
50 #include "xutil.h"
51
52 #include <stddef.h>
53 #include <string.h>
54 #include <sys/stat.h>
55 #include <sys/time.h>
56 #include <unistd.h>
57 #include <dirent.h>
58 #include <errno.h>
59 #include <signal.h>
60
61 #include <talloc.h>
62
63 #define unused(x) x __attribute__ ((unused))
64
65 #define STRINGIFY(s) STRINGIFY_(s)
66 #define STRINGIFY_(s) #s
67
68 typedef struct mime_node mime_node_t;
69 struct notmuch_show_params;
70
71 typedef struct notmuch_show_format {
72     const char *message_set_start;
73     notmuch_status_t (*part) (const void *ctx,
74                               struct mime_node *node, int indent,
75                               const struct notmuch_show_params *params);
76     const char *message_set_sep;
77     const char *message_set_end;
78 } notmuch_show_format_t;
79
80 typedef struct notmuch_crypto {
81     notmuch_crypto_context_t* gpgctx;
82     notmuch_bool_t decrypt;
83 } notmuch_crypto_t;
84
85 typedef struct notmuch_show_params {
86     notmuch_bool_t entire_thread;
87     notmuch_bool_t omit_excluded;
88     notmuch_bool_t raw;
89     int part;
90     notmuch_crypto_t crypto;
91 } notmuch_show_params_t;
92
93 /* There's no point in continuing when we've detected that we've done
94  * something wrong internally (as opposed to the user passing in a
95  * bogus value).
96  *
97  * Note that __location__ comes from talloc.h.
98  */
99 #define INTERNAL_ERROR(format, ...)                     \
100     do {                                                \
101         fprintf(stderr,                                 \
102                 "Internal error: " format " (%s)\n",    \
103                 ##__VA_ARGS__, __location__);           \
104         exit (1);                                       \
105     } while (0)
106
107 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
108
109 #define STRNCMP_LITERAL(var, literal) \
110     strncmp ((var), (literal), sizeof (literal) - 1)
111
112 static inline void
113 chomp_newline (char *str)
114 {
115     if (str && str[strlen(str)-1] == '\n')
116         str[strlen(str)-1] = '\0';
117 }
118
119 notmuch_crypto_context_t *
120 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
121
122 int
123 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
124
125 int
126 notmuch_count_command (void *ctx, int argc, char *argv[]);
127
128 int
129 notmuch_dump_command (void *ctx, int argc, char *argv[]);
130
131 int
132 notmuch_new_command (void *ctx, int argc, char *argv[]);
133
134 int
135 notmuch_reply_command (void *ctx, int argc, char *argv[]);
136
137 int
138 notmuch_restore_command (void *ctx, int argc, char *argv[]);
139
140 int
141 notmuch_search_command (void *ctx, int argc, char *argv[]);
142
143 int
144 notmuch_setup_command (void *ctx, int argc, char *argv[]);
145
146 int
147 notmuch_show_command (void *ctx, int argc, char *argv[]);
148
149 int
150 notmuch_tag_command (void *ctx, int argc, char *argv[]);
151
152 int
153 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
154
155 int
156 notmuch_cat_command (void *ctx, int argc, char *argv[]);
157
158 int
159 notmuch_config_command (void *ctx, int argc, char *argv[]);
160
161 const char *
162 notmuch_time_relative_date (const void *ctx, time_t then);
163
164 void
165 notmuch_time_print_formatted_seconds (double seconds);
166
167 double
168 notmuch_time_elapsed (struct timeval start, struct timeval end);
169
170 char *
171 query_string_from_args (void *ctx, int argc, char *argv[]);
172
173 notmuch_status_t
174 show_one_part (const char *filename, int part);
175
176 void
177 format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first);
178
179 void
180 format_headers_json (const void *ctx, GMimeMessage *message, notmuch_bool_t reply);
181
182 typedef enum {
183     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
184 } notmuch_show_text_part_flags;
185
186 void
187 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
188                         notmuch_show_text_part_flags flags);
189
190 char *
191 json_quote_chararray (const void *ctx, const char *str, const size_t len);
192
193 char *
194 json_quote_str (const void *ctx, const char *str);
195
196 /* notmuch-config.c */
197
198 typedef struct _notmuch_config notmuch_config_t;
199
200 notmuch_config_t *
201 notmuch_config_open (void *ctx,
202                      const char *filename,
203                      notmuch_bool_t *is_new_ret);
204
205 void
206 notmuch_config_close (notmuch_config_t *config);
207
208 int
209 notmuch_config_save (notmuch_config_t *config);
210
211 const char *
212 notmuch_config_get_database_path (notmuch_config_t *config);
213
214 void
215 notmuch_config_set_database_path (notmuch_config_t *config,
216                                   const char *database_path);
217
218 const char *
219 notmuch_config_get_user_name (notmuch_config_t *config);
220
221 void
222 notmuch_config_set_user_name (notmuch_config_t *config,
223                               const char *user_name);
224
225 const char *
226 notmuch_config_get_user_primary_email (notmuch_config_t *config);
227
228 void
229 notmuch_config_set_user_primary_email (notmuch_config_t *config,
230                                        const char *primary_email);
231
232 const char **
233 notmuch_config_get_user_other_email (notmuch_config_t *config,
234                                      size_t *length);
235
236 void
237 notmuch_config_set_user_other_email (notmuch_config_t *config,
238                                      const char *other_email[],
239                                      size_t length);
240
241 const char **
242 notmuch_config_get_new_tags (notmuch_config_t *config,
243                              size_t *length);
244 void
245 notmuch_config_set_new_tags (notmuch_config_t *config,
246                              const char *new_tags[],
247                              size_t length);
248
249 const char **
250 notmuch_config_get_new_ignore (notmuch_config_t *config,
251                                size_t *length);
252
253 void
254 notmuch_config_set_new_ignore (notmuch_config_t *config,
255                                const char *new_ignore[],
256                                size_t length);
257
258 notmuch_bool_t
259 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
260
261 void
262 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
263                                               notmuch_bool_t synchronize_flags);
264
265 const char **
266 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
267
268 void
269 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
270                                       const char *list[],
271                                       size_t length);
272
273 int
274 notmuch_run_hook (const char *db_path, const char *hook);
275
276 notmuch_bool_t
277 debugger_is_active (void);
278
279 /* mime-node.c */
280
281 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
282  * abstracts the different ways of traversing different types of MIME
283  * parts, allowing a MIME message to be viewed as a generic tree of
284  * parts.  Message-type parts have one child, multipart-type parts
285  * have multiple children, and leaf parts have zero children.
286  */
287 struct mime_node {
288     /* The MIME object of this part.  This will be a GMimeMessage,
289      * GMimePart, GMimeMultipart, or a subclass of one of these.
290      *
291      * This will never be a GMimeMessagePart because GMimeMessagePart
292      * is structurally redundant with GMimeMessage.  If this part is a
293      * message (that is, 'part' is a GMimeMessage), then either
294      * envelope_file will be set to a notmuch_message_t (for top-level
295      * messages) or envelope_part will be set to a GMimeMessagePart
296      * (for embedded message parts).
297      */
298     GMimeObject *part;
299
300     /* If part is a GMimeMessage, these record the envelope of the
301      * message: either a notmuch_message_t representing a top-level
302      * message, or a GMimeMessagePart representing a MIME part
303      * containing a message.
304      */
305     notmuch_message_t *envelope_file;
306     GMimeMessagePart *envelope_part;
307
308     /* The number of children of this part. */
309     int nchildren;
310
311     /* The parent of this node or NULL if this is the root node. */
312     struct mime_node *parent;
313
314     /* The depth-first part number of this child if the MIME tree is
315      * being traversed in depth-first order, or -1 otherwise. */
316     int part_num;
317
318     /* True if decryption of this part was attempted. */
319     notmuch_bool_t decrypt_attempted;
320     /* True if decryption of this part's child succeeded.  In this
321      * case, the decrypted part is substituted for the second child of
322      * this part (which would usually be the encrypted data). */
323     notmuch_bool_t decrypt_success;
324
325     /* True if signature verification on this part was attempted. */
326     notmuch_bool_t verify_attempted;
327 #ifdef GMIME_ATLEAST_26
328     /* The list of signatures for signed or encrypted containers. If
329      * there are no signatures, this will be NULL. */
330     GMimeSignatureList* sig_list;
331 #else
332     /* For signed or encrypted containers, the validity of the
333      * signature.  May be NULL if signature verification failed.  If
334      * there are simply no signatures, this will be non-NULL with an
335      * empty signers list. */
336     const GMimeSignatureValidity *sig_validity;
337 #endif
338
339     /* Internal: Context inherited from the root iterator. */
340     struct mime_node_context *ctx;
341
342     /* Internal: For successfully decrypted multipart parts, the
343      * decrypted part to substitute for the second child. */
344     GMimeObject *decrypted_child;
345
346     /* Internal: The next child for depth-first traversal and the part
347      * number to assign it (or -1 if unknown). */
348     int next_child;
349     int next_part_num;
350 };
351
352 /* Construct a new MIME node pointing to the root message part of
353  * message.  If crypto->gpgctx is non-NULL, it will be used to verify
354  * signatures on any child parts.  If crypto->decrypt is true, then
355  * crypto.gpgctx will additionally be used to decrypt any encrypted
356  * child parts.
357  *
358  * Return value:
359  *
360  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
361  *
362  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
363  *
364  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
365  */
366 notmuch_status_t
367 mime_node_open (const void *ctx, notmuch_message_t *message,
368                 notmuch_crypto_t *crypto, mime_node_t **node_out);
369
370 /* Return a new MIME node for the requested child part of parent.
371  * parent will be used as the talloc context for the returned child
372  * node.
373  *
374  * In case of any failure, this function returns NULL, (after printing
375  * an error message on stderr).
376  */
377 mime_node_t *
378 mime_node_child (mime_node_t *parent, int child);
379
380 /* Return the nth child of node in a depth-first traversal.  If n is
381  * 0, returns node itself.  Returns NULL if there is no such part. */
382 mime_node_t *
383 mime_node_seek_dfs (mime_node_t *node, int n);
384
385 #include "command-line-arguments.h"
386 #endif