status: add print_status_gzbytes
[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 4
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_config notmuch_config_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_config_t *config, int argc, char *argv[]);
175
176 int
177 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
178
179 int
180 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
181
182 int
183 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
184
185 int
186 notmuch_reindex_command (notmuch_config_t *config, int argc, char *argv[]);
187
188 int
189 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
190
191 int
192 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
193
194 int
195 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
196
197 int
198 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
199
200 int
201 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
202
203 int
204 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
205
206 int
207 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
208
209 int
210 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
211
212 int
213 notmuch_compact_command (notmuch_config_t *config, 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-config.c */
254
255 typedef enum {
256     NOTMUCH_CONFIG_OPEN         = 1 << 0,
257     NOTMUCH_CONFIG_CREATE       = 1 << 1,
258 } notmuch_config_mode_t;
259
260 notmuch_config_t *
261 notmuch_config_open (void *ctx,
262                      const char *filename,
263                      notmuch_config_mode_t config_mode);
264
265 void
266 notmuch_config_close (notmuch_config_t *config);
267
268 int
269 notmuch_config_save (notmuch_config_t *config);
270
271 bool
272 notmuch_config_is_new (notmuch_config_t *config);
273
274 const char *
275 notmuch_config_get_database_path (notmuch_config_t *config);
276
277 void
278 notmuch_config_set_database_path (notmuch_config_t *config,
279                                   const char *database_path);
280
281 const char *
282 notmuch_config_get_user_name (notmuch_config_t *config);
283
284 void
285 notmuch_config_set_user_name (notmuch_config_t *config,
286                               const char *user_name);
287
288 const char *
289 notmuch_config_get_user_primary_email (notmuch_config_t *config);
290
291 void
292 notmuch_config_set_user_primary_email (notmuch_config_t *config,
293                                        const char *primary_email);
294
295 const char **
296 notmuch_config_get_user_other_email (notmuch_config_t *config,
297                                      size_t *length);
298
299 void
300 notmuch_config_set_user_other_email (notmuch_config_t *config,
301                                      const char *other_email[],
302                                      size_t length);
303
304 const char **
305 notmuch_config_get_new_tags (notmuch_config_t *config,
306                              size_t *length);
307 void
308 notmuch_config_set_new_tags (notmuch_config_t *config,
309                              const char *new_tags[],
310                              size_t length);
311
312 const char **
313 notmuch_config_get_new_ignore (notmuch_config_t *config,
314                                size_t *length);
315
316 void
317 notmuch_config_set_new_ignore (notmuch_config_t *config,
318                                const char *new_ignore[],
319                                size_t length);
320
321 bool
322 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
323
324 void
325 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
326                                               bool synchronize_flags);
327
328 const char **
329 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
330
331 void
332 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
333                                         const char *list[],
334                                         size_t length);
335
336 int
337 notmuch_run_hook (const char *db_path, const char *hook);
338
339 bool
340 debugger_is_active (void);
341
342 /* mime-node.c */
343
344 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
345  * abstracts the different ways of traversing different types of MIME
346  * parts, allowing a MIME message to be viewed as a generic tree of
347  * parts.  Message-type parts have one child, multipart-type parts
348  * have multiple children, and leaf parts have zero children.
349  */
350 struct mime_node {
351     /* The MIME object of this part.  This will be a GMimeMessage,
352      * GMimePart, GMimeMultipart, or a subclass of one of these.
353      *
354      * This will never be a GMimeMessagePart because GMimeMessagePart
355      * is structurally redundant with GMimeMessage.  If this part is a
356      * message (that is, 'part' is a GMimeMessage), then either
357      * envelope_file will be set to a notmuch_message_t (for top-level
358      * messages) or envelope_part will be set to a GMimeMessagePart
359      * (for embedded message parts).
360      */
361     GMimeObject *part;
362
363     /* If part is a GMimeMessage, these record the envelope of the
364      * message: either a notmuch_message_t representing a top-level
365      * message, or a GMimeMessagePart representing a MIME part
366      * containing a message.
367      */
368     notmuch_message_t *envelope_file;
369     GMimeMessagePart *envelope_part;
370
371     /* The number of children of this part. */
372     int nchildren;
373
374     /* The parent of this node or NULL if this is the root node. */
375     struct mime_node *parent;
376
377     /* The depth-first part number of this child if the MIME tree is
378      * being traversed in depth-first order, or -1 otherwise. */
379     int part_num;
380
381     /* True if decryption of this part was attempted. */
382     bool decrypt_attempted;
383     /* True if decryption of this part's child succeeded.  In this
384      * case, the decrypted part is substituted for the second child of
385      * this part (which would usually be the encrypted data). */
386     bool decrypt_success;
387
388     /* True if signature verification on this part was attempted. */
389     bool verify_attempted;
390
391     /* The list of signatures for signed or encrypted containers. If
392      * there are no signatures, this will be NULL. */
393     GMimeSignatureList *sig_list;
394
395     /* Internal: Context inherited from the root iterator. */
396     struct mime_node_context *ctx;
397
398     /* Internal: For successfully decrypted multipart parts, the
399      * decrypted part to substitute for the second child; or, for
400      * PKCS#7 parts, the part returned after removing/processing the
401      * PKCS#7 transformation */
402     GMimeObject *unwrapped_child;
403
404     /* Internal: The next child for depth-first traversal and the part
405      * number to assign it (or -1 if unknown). */
406     int next_child;
407     int next_part_num;
408 };
409
410 /* Construct a new MIME node pointing to the root message part of
411  * message. If crypto->verify is true, signed child parts will be
412  * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
413  * child parts will be decrypted using either stored session keys or
414  * asymmetric crypto.  If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
415  * only session keys will be tried.  If the crypto contexts
416  * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
417  * initialized.
418  *
419  * Return value:
420  *
421  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
422  *
423  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
424  *
425  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
426  */
427 notmuch_status_t
428 mime_node_open (const void *ctx, notmuch_message_t *message,
429                 _notmuch_crypto_t *crypto, mime_node_t **node_out);
430
431 /* Return a new MIME node for the requested child part of parent.
432  * parent will be used as the talloc context for the returned child
433  * node.
434  *
435  * In case of any failure, this function returns NULL, (after printing
436  * an error message on stderr).
437  */
438 mime_node_t *
439 mime_node_child (mime_node_t *parent, int child);
440
441 /* Return the nth child of node in a depth-first traversal.  If n is
442 * 0, returns node itself.  Returns NULL if there is no such part. */
443 mime_node_t *
444 mime_node_seek_dfs (mime_node_t *node, int n);
445
446 const _notmuch_message_crypto_t *
447 mime_node_get_message_crypto_status (mime_node_t *node);
448
449 typedef enum dump_formats {
450     DUMP_FORMAT_AUTO,
451     DUMP_FORMAT_BATCH_TAG,
452     DUMP_FORMAT_SUP
453 } dump_format_t;
454
455 typedef enum dump_includes {
456     DUMP_INCLUDE_TAGS           = 1,
457     DUMP_INCLUDE_CONFIG         = 2,
458     DUMP_INCLUDE_PROPERTIES     = 4
459 } dump_include_t;
460
461 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
462
463 #define NOTMUCH_DUMP_VERSION 3
464
465 int
466 notmuch_database_dump (notmuch_database_t *notmuch,
467                        const char *output_file_name,
468                        const char *query_str,
469                        dump_format_t output_format,
470                        dump_include_t include,
471                        bool gzip_output);
472
473 /* If status indicates error print appropriate
474  * messages to stderr.
475  */
476
477 notmuch_status_t
478 print_status_query (const char *loc,
479                     const notmuch_query_t *query,
480                     notmuch_status_t status);
481
482 notmuch_status_t
483 print_status_message (const char *loc,
484                       const notmuch_message_t *message,
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 notmuch_status_t
496 print_status_gzbytes (const char *loc,
497                       gzFile file,
498                       int bytes);
499
500 #include "command-line-arguments.h"
501
502 extern const 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
510
511 /* the state chosen by the user invoking one of the notmuch
512  * subcommands that does indexing */
513 struct _notmuch_client_indexing_cli_choices {
514     int decrypt_policy;
515     bool decrypt_policy_set;
516     notmuch_indexopts_t *opts;
517 };
518 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
519 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
520 notmuch_status_t
521 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch);
522
523 #endif