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