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