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