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