test/emacs: tests for notmuch-{tree,unthreaded} with bad CWD
[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 <stdbool.h>
28 #include <stdio.h>
29 #include <sysexits.h>
30
31 #include "compat.h"
32
33 #include "gmime-extra.h"
34
35 #include "notmuch.h"
36
37 /* This is separate from notmuch-private.h because we're trying to
38  * keep notmuch.c from looking into any internals, (which helps us
39  * develop notmuch.h into a plausible library interface).
40  */
41 #include "xutil.h"
42
43 #include <stddef.h>
44 #include <string.h>
45 #include <sys/stat.h>
46 #include <sys/time.h>
47 #include <unistd.h>
48 #include <dirent.h>
49 #include <errno.h>
50 #include <signal.h>
51 #include <ctype.h>
52 #include <zlib.h>
53
54 #include "talloc-extra.h"
55 #include "crypto.h"
56 #include "repair.h"
57
58 #define unused(x) x ## _unused __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_show_params {
75     bool entire_thread;
76     bool omit_excluded;
77     bool output_body;
78     int part;
79     _notmuch_crypto_t crypto;
80     bool include_html;
81     GMimeStream *out_stream;
82 } notmuch_show_params_t;
83
84 /* There's no point in continuing when we've detected that we've done
85  * something wrong internally (as opposed to the user passing in a
86  * bogus value).
87  *
88  * Note that __location__ comes from talloc.h.
89  */
90 #define INTERNAL_ERROR(format, ...)                     \
91     do {                                                \
92         fprintf (stderr,                                 \
93                  "Internal error: " format " (%s)\n",    \
94                  ##__VA_ARGS__, __location__);           \
95         exit (1);                                       \
96     } while (0)
97
98 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
99
100 #define STRNCMP_LITERAL(var, literal) \
101     strncmp ((var), (literal), sizeof (literal) - 1)
102
103 static inline void
104 chomp_newline (char *str)
105 {
106     if (str && str[strlen (str) - 1] == '\n')
107         str[strlen (str) - 1] = '\0';
108 }
109
110 /* Exit status code indicating temporary failure; user is invited to
111  * retry.
112  *
113  * For example, file(s) in the mail store were removed or renamed
114  * after notmuch new scanned the directories but before indexing the
115  * file(s). If the file was renamed, the indexing might not be
116  * complete, and the user is advised to re-run notmuch new.
117  */
118 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
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 5
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 /* The minimum non-deprecated structured output format version.
145  * Requests for format versions below this will print a stern warning.
146  * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
147  * inclusive.
148  */
149 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
150
151 /* The output format version requested by the caller on the command
152  * line.  If no format version is requested, this will be set to
153  * NOTMUCH_FORMAT_CUR.  Even though the command-line option is
154  * per-command, this is global because commands can share structured
155  * output code.
156  */
157 extern int notmuch_format_version;
158
159 typedef struct _notmuch_conffile notmuch_conffile_t;
160
161 /* Commands that support structured output should support the
162  * following argument
163  *  { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 }
164  * and should invoke notmuch_exit_if_unsupported_format to check the
165  * requested version.  If notmuch_format_version is outside the
166  * supported range, this will print a detailed diagnostic message for
167  * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
168  * the invoking program of the problem.
169  */
170 void
171 notmuch_exit_if_unsupported_format (void);
172
173 int
174 notmuch_count_command (notmuch_database_t *notmuch, int argc, char *argv[]);
175
176 int
177 notmuch_dump_command (notmuch_database_t *notmuch, int argc, char *argv[]);
178
179 int
180 notmuch_new_command (notmuch_database_t *notmuch, int argc, char *argv[]);
181
182 int
183 notmuch_insert_command (notmuch_database_t *notmuch, int argc, char *argv[]);
184
185 int
186 notmuch_reindex_command (notmuch_database_t *notmuch, int argc, char *argv[]);
187
188 int
189 notmuch_reply_command (notmuch_database_t *notmuch, int argc, char *argv[]);
190
191 int
192 notmuch_restore_command (notmuch_database_t *notmuch, int argc, char *argv[]);
193
194 int
195 notmuch_search_command (notmuch_database_t *notmuch, int argc, char *argv[]);
196
197 int
198 notmuch_address_command (notmuch_database_t *notmuch, int argc, char *argv[]);
199
200 int
201 notmuch_setup_command (notmuch_database_t *notmuch, int argc, char *argv[]);
202
203 int
204 notmuch_show_command (notmuch_database_t *notmuch, int argc, char *argv[]);
205
206 int
207 notmuch_tag_command (notmuch_database_t *notmuch, int argc, char *argv[]);
208
209 int
210 notmuch_config_command (notmuch_database_t *notmuch, int argc, char *argv[]);
211
212 int
213 notmuch_compact_command (notmuch_database_t *notmuch, int argc, char *argv[]);
214
215 const char *
216 notmuch_time_relative_date (const void *ctx, time_t then);
217
218 void
219 notmuch_time_print_formatted_seconds (double seconds);
220
221 double
222 notmuch_time_elapsed (struct timeval start, struct timeval end);
223
224 char *
225 query_string_from_args (void *ctx, int argc, char *argv[]);
226
227 notmuch_status_t
228 show_one_part (const char *filename, int part);
229
230 void
231 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
232                       bool output_body,
233                       bool include_html);
234
235 void
236 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
237                          bool reply, const _notmuch_message_crypto_t *msg_crypto);
238
239 typedef enum {
240     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
241 } notmuch_show_text_part_flags;
242
243 void
244 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
245                         notmuch_show_text_part_flags flags);
246
247 char *
248 json_quote_chararray (const void *ctx, const char *str, const size_t len);
249
250 char *
251 json_quote_str (const void *ctx, const char *str);
252
253 /* notmuch-client-init.c */
254
255 void notmuch_client_init (void);
256
257 /* notmuch-config.c */
258
259 typedef enum {
260     NOTMUCH_COMMAND_CONFIG_CREATE       = 1 << 1,
261     NOTMUCH_COMMAND_DATABASE_EARLY      = 1 << 2,
262     NOTMUCH_COMMAND_DATABASE_WRITE      = 1 << 3,
263     NOTMUCH_COMMAND_DATABASE_CREATE     = 1 << 4,
264     NOTMUCH_COMMAND_CONFIG_LOAD         = 1 << 5,
265 } notmuch_command_mode_t;
266
267 notmuch_conffile_t *
268 notmuch_conffile_open (notmuch_database_t *notmuch,
269                        const char *filename,
270                        bool create);
271
272 void
273 notmuch_conffile_close (notmuch_conffile_t *config);
274
275 int
276 notmuch_conffile_save (notmuch_conffile_t *config);
277
278 bool
279 notmuch_conffile_is_new (notmuch_conffile_t *config);
280
281 void
282 notmuch_conffile_set_database_path (notmuch_conffile_t *config,
283                                     const char *database_path);
284
285 void
286 notmuch_conffile_set_user_name (notmuch_conffile_t *config,
287                                 const char *user_name);
288
289 void
290 notmuch_conffile_set_user_primary_email (notmuch_conffile_t *config,
291                                          const char *primary_email);
292
293 void
294 notmuch_conffile_set_user_other_email (notmuch_conffile_t *config,
295                                        const char *other_email[],
296                                        size_t length);
297
298 void
299 notmuch_conffile_set_new_tags (notmuch_conffile_t *config,
300                                const char *new_tags[],
301                                size_t length);
302
303 void
304 notmuch_conffile_set_new_ignore (notmuch_conffile_t *config,
305                                  const char *new_ignore[],
306                                  size_t length);
307
308 void
309 notmuch_conffile_set_maildir_synchronize_flags (notmuch_conffile_t *config,
310                                                 bool synchronize_flags);
311
312 void
313 notmuch_conffile_set_search_exclude_tags (notmuch_conffile_t *config,
314                                           const char *list[],
315                                           size_t length);
316 int
317 notmuch_run_hook (notmuch_database_t *notmuch, const char *hook);
318
319 bool
320 debugger_is_active (void);
321
322 /* mime-node.c */
323
324 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
325  * abstracts the different ways of traversing different types of MIME
326  * parts, allowing a MIME message to be viewed as a generic tree of
327  * parts.  Message-type parts have one child, multipart-type parts
328  * have multiple children, and leaf parts have zero children.
329  */
330 struct mime_node {
331     /* The MIME object of this part.  This will be a GMimeMessage,
332      * GMimePart, GMimeMultipart, or a subclass of one of these.
333      *
334      * This will never be a GMimeMessagePart because GMimeMessagePart
335      * is structurally redundant with GMimeMessage.  If this part is a
336      * message (that is, 'part' is a GMimeMessage), then either
337      * envelope_file will be set to a notmuch_message_t (for top-level
338      * messages) or envelope_part will be set to a GMimeMessagePart
339      * (for embedded message parts).
340      */
341     GMimeObject *part;
342
343     /* If part is a GMimeMessage, these record the envelope of the
344      * message: either a notmuch_message_t representing a top-level
345      * message, or a GMimeMessagePart representing a MIME part
346      * containing a message.
347      */
348     notmuch_message_t *envelope_file;
349     GMimeMessagePart *envelope_part;
350
351     /* The number of children of this part. */
352     int nchildren;
353
354     /* The parent of this node or NULL if this is the root node. */
355     struct mime_node *parent;
356
357     /* The depth-first part number of this child if the MIME tree is
358      * being traversed in depth-first order, or -1 otherwise. */
359     int part_num;
360
361     /* True if decryption of this part was attempted. */
362     bool decrypt_attempted;
363     /* True if decryption of this part's child succeeded.  In this
364      * case, the decrypted part is substituted for the second child of
365      * this part (which would usually be the encrypted data). */
366     bool decrypt_success;
367
368     /* True if signature verification on this part was attempted. */
369     bool verify_attempted;
370
371     /* The list of signatures for signed or encrypted containers. If
372      * there are no signatures, this will be NULL. */
373     GMimeSignatureList *sig_list;
374
375     /* Internal: Context inherited from the root iterator. */
376     struct mime_node_context *ctx;
377
378     /* Internal: For successfully decrypted multipart parts, the
379      * decrypted part to substitute for the second child; or, for
380      * PKCS#7 parts, the part returned after removing/processing the
381      * PKCS#7 transformation */
382     GMimeObject *unwrapped_child;
383
384     /* Internal: The next child for depth-first traversal and the part
385      * number to assign it (or -1 if unknown). */
386     int next_child;
387     int next_part_num;
388 };
389
390 /* Construct a new MIME node pointing to the root message part of
391  * message. If crypto->verify is true, signed child parts will be
392  * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
393  * child parts will be decrypted using either stored session keys or
394  * asymmetric crypto.  If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
395  * only session keys will be tried.  If the crypto contexts
396  * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
397  * initialized.
398  *
399  * Return value:
400  *
401  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
402  *
403  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
404  *
405  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
406  */
407 notmuch_status_t
408 mime_node_open (const void *ctx, notmuch_message_t *message,
409                 _notmuch_crypto_t *crypto, mime_node_t **node_out);
410
411 /* Return a new MIME node for the requested child part of parent.
412  * parent will be used as the talloc context for the returned child
413  * node.
414  *
415  * In case of any failure, this function returns NULL, (after printing
416  * an error message on stderr).
417  */
418 mime_node_t *
419 mime_node_child (mime_node_t *parent, int child);
420
421 /* Return the nth child of node in a depth-first traversal.  If n is
422 * 0, returns node itself.  Returns NULL if there is no such part. */
423 mime_node_t *
424 mime_node_seek_dfs (mime_node_t *node, int n);
425
426 const _notmuch_message_crypto_t *
427 mime_node_get_message_crypto_status (mime_node_t *node);
428
429 typedef enum dump_formats {
430     DUMP_FORMAT_AUTO,
431     DUMP_FORMAT_BATCH_TAG,
432     DUMP_FORMAT_SUP
433 } dump_format_t;
434
435 typedef enum dump_includes {
436     DUMP_INCLUDE_TAGS           = 1,
437     DUMP_INCLUDE_CONFIG         = 2,
438     DUMP_INCLUDE_PROPERTIES     = 4
439 } dump_include_t;
440
441 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
442
443 #define NOTMUCH_DUMP_VERSION 3
444
445 int
446 notmuch_database_dump (notmuch_database_t *notmuch,
447                        const char *output_file_name,
448                        const char *query_str,
449                        dump_format_t output_format,
450                        dump_include_t include,
451                        bool gzip_output);
452
453 /* If status indicates error print appropriate
454  * messages to stderr.
455  */
456
457 notmuch_status_t
458 print_status_query (const char *loc,
459                     const notmuch_query_t *query,
460                     notmuch_status_t status);
461
462 notmuch_status_t
463 print_status_message (const char *loc,
464                       const notmuch_message_t *message,
465                       notmuch_status_t status);
466
467 notmuch_status_t
468 print_status_database (const char *loc,
469                        const notmuch_database_t *database,
470                        notmuch_status_t status);
471
472 int
473 status_to_exit (notmuch_status_t status);
474
475 notmuch_status_t
476 print_status_gzbytes (const char *loc,
477                       gzFile file,
478                       int bytes);
479
480 /* the __location__ macro is defined in talloc.h */
481 #define ASSERT_GZBYTES(file, bytes) ((print_status_gzbytes (__location__, file, bytes)) ? exit (1) : \
482                                      0)
483 #define GZPRINTF(file, fmt, ...) ASSERT_GZBYTES (file, gzprintf (file, fmt, ##__VA_ARGS__));
484 #define GZPUTS(file, str) ASSERT_GZBYTES (file, gzputs (file, str));
485
486 #include "command-line-arguments.h"
487
488 extern const notmuch_opt_desc_t notmuch_shared_options [];
489
490 notmuch_query_syntax_t shared_option_query_syntax ();
491
492 void notmuch_process_shared_options (notmuch_database_t *notmuch, const char *subcommand_name);
493 int notmuch_minimal_options (const char *subcommand_name,
494                              int argc, char **argv);
495
496
497 /* the state chosen by the user invoking one of the notmuch
498  * subcommands that does indexing */
499 struct _notmuch_client_indexing_cli_choices {
500     int decrypt_policy;
501     bool decrypt_policy_set;
502     notmuch_indexopts_t *opts;
503 };
504 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
505 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
506 notmuch_status_t
507 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch);
508
509 #endif