cli/show: list all filenames of a message in the formatted output
[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     notmuch_bool_t raw;
87     int part;
88     notmuch_crypto_t crypto;
89     notmuch_bool_t include_html;
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 notmuch_config_t *
267 notmuch_config_open (void *ctx,
268                      const char *filename,
269                      notmuch_bool_t create_new);
270
271 void
272 notmuch_config_close (notmuch_config_t *config);
273
274 int
275 notmuch_config_save (notmuch_config_t *config);
276
277 notmuch_bool_t
278 notmuch_config_is_new (notmuch_config_t *config);
279
280 const char *
281 notmuch_config_get_database_path (notmuch_config_t *config);
282
283 void
284 notmuch_config_set_database_path (notmuch_config_t *config,
285                                   const char *database_path);
286
287 const char *
288 notmuch_config_get_crypto_gpg_path (notmuch_config_t *config);
289
290 void
291 notmuch_config_set_crypto_gpg_path (notmuch_config_t *config,
292                                   const char *gpg_path);
293
294 const char *
295 notmuch_config_get_user_name (notmuch_config_t *config);
296
297 void
298 notmuch_config_set_user_name (notmuch_config_t *config,
299                               const char *user_name);
300
301 const char *
302 notmuch_config_get_user_primary_email (notmuch_config_t *config);
303
304 void
305 notmuch_config_set_user_primary_email (notmuch_config_t *config,
306                                        const char *primary_email);
307
308 const char **
309 notmuch_config_get_user_other_email (notmuch_config_t *config,
310                                      size_t *length);
311
312 void
313 notmuch_config_set_user_other_email (notmuch_config_t *config,
314                                      const char *other_email[],
315                                      size_t length);
316
317 const char **
318 notmuch_config_get_new_tags (notmuch_config_t *config,
319                              size_t *length);
320 void
321 notmuch_config_set_new_tags (notmuch_config_t *config,
322                              const char *new_tags[],
323                              size_t length);
324
325 const char **
326 notmuch_config_get_new_ignore (notmuch_config_t *config,
327                                size_t *length);
328
329 void
330 notmuch_config_set_new_ignore (notmuch_config_t *config,
331                                const char *new_ignore[],
332                                size_t length);
333
334 notmuch_bool_t
335 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
336
337 void
338 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
339                                               notmuch_bool_t synchronize_flags);
340
341 const char **
342 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
343
344 void
345 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
346                                       const char *list[],
347                                       size_t length);
348
349 int
350 notmuch_run_hook (const char *db_path, const char *hook);
351
352 notmuch_bool_t
353 debugger_is_active (void);
354
355 /* mime-node.c */
356
357 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
358  * abstracts the different ways of traversing different types of MIME
359  * parts, allowing a MIME message to be viewed as a generic tree of
360  * parts.  Message-type parts have one child, multipart-type parts
361  * have multiple children, and leaf parts have zero children.
362  */
363 struct mime_node {
364     /* The MIME object of this part.  This will be a GMimeMessage,
365      * GMimePart, GMimeMultipart, or a subclass of one of these.
366      *
367      * This will never be a GMimeMessagePart because GMimeMessagePart
368      * is structurally redundant with GMimeMessage.  If this part is a
369      * message (that is, 'part' is a GMimeMessage), then either
370      * envelope_file will be set to a notmuch_message_t (for top-level
371      * messages) or envelope_part will be set to a GMimeMessagePart
372      * (for embedded message parts).
373      */
374     GMimeObject *part;
375
376     /* If part is a GMimeMessage, these record the envelope of the
377      * message: either a notmuch_message_t representing a top-level
378      * message, or a GMimeMessagePart representing a MIME part
379      * containing a message.
380      */
381     notmuch_message_t *envelope_file;
382     GMimeMessagePart *envelope_part;
383
384     /* The number of children of this part. */
385     int nchildren;
386
387     /* The parent of this node or NULL if this is the root node. */
388     struct mime_node *parent;
389
390     /* The depth-first part number of this child if the MIME tree is
391      * being traversed in depth-first order, or -1 otherwise. */
392     int part_num;
393
394     /* True if decryption of this part was attempted. */
395     notmuch_bool_t decrypt_attempted;
396     /* True if decryption of this part's child succeeded.  In this
397      * case, the decrypted part is substituted for the second child of
398      * this part (which would usually be the encrypted data). */
399     notmuch_bool_t decrypt_success;
400
401     /* True if signature verification on this part was attempted. */
402     notmuch_bool_t verify_attempted;
403
404     /* The list of signatures for signed or encrypted containers. If
405      * there are no signatures, this will be NULL. */
406     GMimeSignatureList* sig_list;
407
408     /* Internal: Context inherited from the root iterator. */
409     struct mime_node_context *ctx;
410
411     /* Internal: For successfully decrypted multipart parts, the
412      * decrypted part to substitute for the second child. */
413     GMimeObject *decrypted_child;
414
415     /* Internal: The next child for depth-first traversal and the part
416      * number to assign it (or -1 if unknown). */
417     int next_child;
418     int next_part_num;
419 };
420
421 /* Construct a new MIME node pointing to the root message part of
422  * message. If crypto->verify is true, signed child parts will be
423  * verified. If crypto->decrypt is true, encrypted child parts will be
424  * decrypted.  If the crypto contexts (crypto->gpgctx or
425  * crypto->pkcs7) are NULL, they will be lazily initialized.
426  *
427  * Return value:
428  *
429  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
430  *
431  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
432  *
433  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
434  */
435 notmuch_status_t
436 mime_node_open (const void *ctx, notmuch_message_t *message,
437                 notmuch_crypto_t *crypto, mime_node_t **node_out);
438
439 /* Return a new MIME node for the requested child part of parent.
440  * parent will be used as the talloc context for the returned child
441  * node.
442  *
443  * In case of any failure, this function returns NULL, (after printing
444  * an error message on stderr).
445  */
446 mime_node_t *
447 mime_node_child (mime_node_t *parent, int child);
448
449 /* Return the nth child of node in a depth-first traversal.  If n is
450  * 0, returns node itself.  Returns NULL if there is no such part. */
451 mime_node_t *
452 mime_node_seek_dfs (mime_node_t *node, int n);
453
454 typedef enum dump_formats {
455     DUMP_FORMAT_AUTO,
456     DUMP_FORMAT_BATCH_TAG,
457     DUMP_FORMAT_SUP
458 } dump_format_t;
459
460 typedef enum dump_includes {
461     DUMP_INCLUDE_TAGS = 1,
462     DUMP_INCLUDE_CONFIG = 2,
463     DUMP_INCLUDE_PROPERTIES = 4
464 } dump_include_t;
465
466 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
467
468 #define NOTMUCH_DUMP_VERSION 2
469
470 int
471 notmuch_database_dump (notmuch_database_t *notmuch,
472                        const char *output_file_name,
473                        const char *query_str,
474                        dump_format_t output_format,
475                        dump_include_t include,
476                        notmuch_bool_t gzip_output);
477
478 /* If status is non-zero (i.e. error) print appropriate
479    messages to stderr.
480 */
481
482 notmuch_status_t
483 print_status_query (const char *loc,
484                     const notmuch_query_t *query,
485                     notmuch_status_t status);
486
487 notmuch_status_t
488 print_status_database (const char *loc,
489                        const notmuch_database_t *database,
490                        notmuch_status_t status);
491
492 int
493 status_to_exit (notmuch_status_t status);
494
495 #include "command-line-arguments.h"
496
497 extern char *notmuch_requested_db_uuid;
498 extern const notmuch_opt_desc_t  notmuch_shared_options [];
499 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
500
501 void notmuch_process_shared_options (const char* subcommand_name);
502 int notmuch_minimal_options (const char* subcommand_name,
503                              int argc, char **argv);
504 #endif