Merge branch 'release'
[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 https://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 #include <sysexits.h>
29
30 #include "compat.h"
31
32 #include <gmime/gmime.h>
33
34 typedef GMimeCryptoContext notmuch_crypto_context_t;
35 /* This is automatically included only since gmime 2.6.10 */
36 #include <gmime/gmime-pkcs7-context.h>
37
38 #include "notmuch.h"
39
40 /* This is separate from notmuch-private.h because we're trying to
41  * keep notmuch.c from looking into any internals, (which helps us
42  * develop notmuch.h into a plausible library interface).
43  */
44 #include "xutil.h"
45
46 #include <stddef.h>
47 #include <string.h>
48 #include <sys/stat.h>
49 #include <sys/time.h>
50 #include <unistd.h>
51 #include <dirent.h>
52 #include <errno.h>
53 #include <signal.h>
54 #include <ctype.h>
55
56 #include "talloc-extra.h"
57
58 #define unused(x) x __attribute__ ((unused))
59
60 #define STRINGIFY(s) STRINGIFY_(s)
61 #define STRINGIFY_(s) #s
62
63 typedef struct mime_node mime_node_t;
64 struct sprinter;
65 struct notmuch_show_params;
66
67 typedef struct notmuch_show_format {
68     struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream);
69     notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter,
70                               struct mime_node *node, int indent,
71                               const struct notmuch_show_params *params);
72 } notmuch_show_format_t;
73
74 typedef struct notmuch_crypto {
75     notmuch_crypto_context_t* gpgctx;
76     notmuch_crypto_context_t* pkcs7ctx;
77     notmuch_bool_t verify;
78     notmuch_bool_t decrypt;
79     const char *gpgpath;
80 } notmuch_crypto_t;
81
82 typedef struct notmuch_show_params {
83     notmuch_bool_t entire_thread;
84     notmuch_bool_t omit_excluded;
85     notmuch_bool_t output_body;
86     int part;
87     notmuch_crypto_t crypto;
88     notmuch_bool_t include_html;
89 } notmuch_show_params_t;
90
91 /* There's no point in continuing when we've detected that we've done
92  * something wrong internally (as opposed to the user passing in a
93  * bogus value).
94  *
95  * Note that __location__ comes from talloc.h.
96  */
97 #define INTERNAL_ERROR(format, ...)                     \
98     do {                                                \
99         fprintf(stderr,                                 \
100                 "Internal error: " format " (%s)\n",    \
101                 ##__VA_ARGS__, __location__);           \
102         exit (1);                                       \
103     } while (0)
104
105 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
106
107 #define STRNCMP_LITERAL(var, literal) \
108     strncmp ((var), (literal), sizeof (literal) - 1)
109
110 static inline void
111 chomp_newline (char *str)
112 {
113     if (str && str[strlen(str)-1] == '\n')
114         str[strlen(str)-1] = '\0';
115 }
116
117 /* Exit status code indicating temporary failure; user is invited to
118  * retry.
119  *
120  * For example, file(s) in the mail store were removed or renamed
121  * after notmuch new scanned the directories but before indexing the
122  * file(s). If the file was renamed, the indexing might not be
123  * complete, and the user is advised to re-run notmuch new.
124  */
125 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
126
127 /* Exit status code indicating the requested format version is too old
128  * (support for that version has been dropped).  CLI code should use
129  * notmuch_exit_if_unsupported_format rather than directly exiting
130  * with this code.
131  */
132 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
133 /* Exit status code indicating the requested format version is newer
134  * than the version supported by the CLI.  CLI code should use
135  * notmuch_exit_if_unsupported_format rather than directly exiting
136  * with this code.
137  */
138 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
139
140 /* The current structured output format version.  Requests for format
141  * versions above this will return an error.  Backwards-incompatible
142  * changes such as removing map fields, changing the meaning of map
143  * fields, or changing the meanings of list elements should increase
144  * this.  New (required) map fields can be added without increasing
145  * this.
146  */
147 #define NOTMUCH_FORMAT_CUR 3
148 /* The minimum supported structured output format version.  Requests
149  * for format versions below this will return an error. */
150 #define NOTMUCH_FORMAT_MIN 1
151 /* The minimum non-deprecated structured output format version.
152  * Requests for format versions below this will print a stern warning.
153  * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
154  * inclusive.
155  */
156 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
157
158 /* The output format version requested by the caller on the command
159  * line.  If no format version is requested, this will be set to
160  * NOTMUCH_FORMAT_CUR.  Even though the command-line option is
161  * per-command, this is global because commands can share structured
162  * output code.
163  */
164 extern int notmuch_format_version;
165
166 typedef struct _notmuch_config notmuch_config_t;
167
168 /* Commands that support structured output should support the
169  * following argument
170  *  { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 }
171  * and should invoke notmuch_exit_if_unsupported_format to check the
172  * requested version.  If notmuch_format_version is outside the
173  * supported range, this will print a detailed diagnostic message for
174  * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
175  * the invoking program of the problem.
176  */
177 void
178 notmuch_exit_if_unsupported_format (void);
179
180 notmuch_crypto_context_t *
181 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
182
183 int
184 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
185
186 int
187 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
188
189 int
190 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
191
192 int
193 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
194
195 int
196 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
197
198 int
199 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
200
201 int
202 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
203
204 int
205 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
206
207 int
208 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
209
210 int
211 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
212
213 int
214 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
215
216 int
217 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
218
219 int
220 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
221
222 int
223 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
224
225 const char *
226 notmuch_time_relative_date (const void *ctx, time_t then);
227
228 void
229 notmuch_time_print_formatted_seconds (double seconds);
230
231 double
232 notmuch_time_elapsed (struct timeval start, struct timeval end);
233
234 char *
235 query_string_from_args (void *ctx, int argc, char *argv[]);
236
237 notmuch_status_t
238 show_one_part (const char *filename, int part);
239
240 void
241 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
242                       notmuch_bool_t first, notmuch_bool_t output_body,
243                       notmuch_bool_t include_html);
244
245 void
246 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
247                          notmuch_bool_t reply);
248
249 typedef enum {
250     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
251 } notmuch_show_text_part_flags;
252
253 void
254 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
255                         notmuch_show_text_part_flags flags);
256
257 char *
258 json_quote_chararray (const void *ctx, const char *str, const size_t len);
259
260 char *
261 json_quote_str (const void *ctx, const char *str);
262
263 /* notmuch-config.c */
264
265 typedef enum {
266     NOTMUCH_CONFIG_OPEN = 1 << 0,
267     NOTMUCH_CONFIG_CREATE = 1 << 1,
268 } notmuch_config_mode_t;
269
270 notmuch_config_t *
271 notmuch_config_open (void *ctx,
272                      const char *filename,
273                      notmuch_config_mode_t config_mode);
274
275 void
276 notmuch_config_close (notmuch_config_t *config);
277
278 int
279 notmuch_config_save (notmuch_config_t *config);
280
281 notmuch_bool_t
282 notmuch_config_is_new (notmuch_config_t *config);
283
284 const char *
285 notmuch_config_get_database_path (notmuch_config_t *config);
286
287 void
288 notmuch_config_set_database_path (notmuch_config_t *config,
289                                   const char *database_path);
290
291 const char *
292 notmuch_config_get_crypto_gpg_path (notmuch_config_t *config);
293
294 void
295 notmuch_config_set_crypto_gpg_path (notmuch_config_t *config,
296                                   const char *gpg_path);
297
298 const char *
299 notmuch_config_get_user_name (notmuch_config_t *config);
300
301 void
302 notmuch_config_set_user_name (notmuch_config_t *config,
303                               const char *user_name);
304
305 const char *
306 notmuch_config_get_user_primary_email (notmuch_config_t *config);
307
308 void
309 notmuch_config_set_user_primary_email (notmuch_config_t *config,
310                                        const char *primary_email);
311
312 const char **
313 notmuch_config_get_user_other_email (notmuch_config_t *config,
314                                      size_t *length);
315
316 void
317 notmuch_config_set_user_other_email (notmuch_config_t *config,
318                                      const char *other_email[],
319                                      size_t length);
320
321 const char **
322 notmuch_config_get_new_tags (notmuch_config_t *config,
323                              size_t *length);
324 void
325 notmuch_config_set_new_tags (notmuch_config_t *config,
326                              const char *new_tags[],
327                              size_t length);
328
329 const char **
330 notmuch_config_get_new_ignore (notmuch_config_t *config,
331                                size_t *length);
332
333 void
334 notmuch_config_set_new_ignore (notmuch_config_t *config,
335                                const char *new_ignore[],
336                                size_t length);
337
338 notmuch_bool_t
339 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
340
341 void
342 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
343                                               notmuch_bool_t synchronize_flags);
344
345 const char **
346 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
347
348 void
349 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
350                                       const char *list[],
351                                       size_t length);
352
353 int
354 notmuch_run_hook (const char *db_path, const char *hook);
355
356 notmuch_bool_t
357 debugger_is_active (void);
358
359 /* mime-node.c */
360
361 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
362  * abstracts the different ways of traversing different types of MIME
363  * parts, allowing a MIME message to be viewed as a generic tree of
364  * parts.  Message-type parts have one child, multipart-type parts
365  * have multiple children, and leaf parts have zero children.
366  */
367 struct mime_node {
368     /* The MIME object of this part.  This will be a GMimeMessage,
369      * GMimePart, GMimeMultipart, or a subclass of one of these.
370      *
371      * This will never be a GMimeMessagePart because GMimeMessagePart
372      * is structurally redundant with GMimeMessage.  If this part is a
373      * message (that is, 'part' is a GMimeMessage), then either
374      * envelope_file will be set to a notmuch_message_t (for top-level
375      * messages) or envelope_part will be set to a GMimeMessagePart
376      * (for embedded message parts).
377      */
378     GMimeObject *part;
379
380     /* If part is a GMimeMessage, these record the envelope of the
381      * message: either a notmuch_message_t representing a top-level
382      * message, or a GMimeMessagePart representing a MIME part
383      * containing a message.
384      */
385     notmuch_message_t *envelope_file;
386     GMimeMessagePart *envelope_part;
387
388     /* The number of children of this part. */
389     int nchildren;
390
391     /* The parent of this node or NULL if this is the root node. */
392     struct mime_node *parent;
393
394     /* The depth-first part number of this child if the MIME tree is
395      * being traversed in depth-first order, or -1 otherwise. */
396     int part_num;
397
398     /* True if decryption of this part was attempted. */
399     notmuch_bool_t decrypt_attempted;
400     /* True if decryption of this part's child succeeded.  In this
401      * case, the decrypted part is substituted for the second child of
402      * this part (which would usually be the encrypted data). */
403     notmuch_bool_t decrypt_success;
404
405     /* True if signature verification on this part was attempted. */
406     notmuch_bool_t verify_attempted;
407
408     /* The list of signatures for signed or encrypted containers. If
409      * there are no signatures, this will be NULL. */
410     GMimeSignatureList* sig_list;
411
412     /* Internal: Context inherited from the root iterator. */
413     struct mime_node_context *ctx;
414
415     /* Internal: For successfully decrypted multipart parts, the
416      * decrypted part to substitute for the second child. */
417     GMimeObject *decrypted_child;
418
419     /* Internal: The next child for depth-first traversal and the part
420      * number to assign it (or -1 if unknown). */
421     int next_child;
422     int next_part_num;
423 };
424
425 /* Construct a new MIME node pointing to the root message part of
426  * message. If crypto->verify is true, signed child parts will be
427  * verified. If crypto->decrypt is true, encrypted child parts will be
428  * decrypted.  If the crypto contexts (crypto->gpgctx or
429  * crypto->pkcs7) are NULL, they will be lazily initialized.
430  *
431  * Return value:
432  *
433  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
434  *
435  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
436  *
437  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
438  */
439 notmuch_status_t
440 mime_node_open (const void *ctx, notmuch_message_t *message,
441                 notmuch_crypto_t *crypto, mime_node_t **node_out);
442
443 /* Return a new MIME node for the requested child part of parent.
444  * parent will be used as the talloc context for the returned child
445  * node.
446  *
447  * In case of any failure, this function returns NULL, (after printing
448  * an error message on stderr).
449  */
450 mime_node_t *
451 mime_node_child (mime_node_t *parent, int child);
452
453 /* Return the nth child of node in a depth-first traversal.  If n is
454  * 0, returns node itself.  Returns NULL if there is no such part. */
455 mime_node_t *
456 mime_node_seek_dfs (mime_node_t *node, int n);
457
458 typedef enum dump_formats {
459     DUMP_FORMAT_AUTO,
460     DUMP_FORMAT_BATCH_TAG,
461     DUMP_FORMAT_SUP
462 } dump_format_t;
463
464 typedef enum dump_includes {
465     DUMP_INCLUDE_TAGS = 1,
466     DUMP_INCLUDE_CONFIG = 2,
467     DUMP_INCLUDE_PROPERTIES = 4
468 } dump_include_t;
469
470 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
471
472 #define NOTMUCH_DUMP_VERSION 3
473
474 int
475 notmuch_database_dump (notmuch_database_t *notmuch,
476                        const char *output_file_name,
477                        const char *query_str,
478                        dump_format_t output_format,
479                        dump_include_t include,
480                        notmuch_bool_t gzip_output);
481
482 /* If status is non-zero (i.e. error) print appropriate
483    messages to stderr.
484 */
485
486 notmuch_status_t
487 print_status_query (const char *loc,
488                     const notmuch_query_t *query,
489                     notmuch_status_t status);
490
491 notmuch_status_t
492 print_status_database (const char *loc,
493                        const notmuch_database_t *database,
494                        notmuch_status_t status);
495
496 int
497 status_to_exit (notmuch_status_t status);
498
499 #include "command-line-arguments.h"
500
501 extern char *notmuch_requested_db_uuid;
502 extern const notmuch_opt_desc_t  notmuch_shared_options [];
503 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
504
505 void notmuch_process_shared_options (const char* subcommand_name);
506 int notmuch_minimal_options (const char* subcommand_name,
507                              int argc, char **argv);
508 #endif