4a4f86c41b8794c5adc9b323779cdacc496cba7d
[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 http://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
29 #include "compat.h"
30
31 #include <gmime/gmime.h>
32
33 /* GMIME_CHECK_VERSION in gmime 2.4 is not usable from the
34  * preprocessor (it calls a runtime function). But since
35  * GMIME_MAJOR_VERSION and friends were added in gmime 2.6, we can use
36  * these to check the version number. */
37 #ifdef GMIME_MAJOR_VERSION
38 #define GMIME_ATLEAST_26
39 typedef GMimeCryptoContext notmuch_crypto_context_t;
40 #else
41 typedef GMimeCipherContext notmuch_crypto_context_t;
42 #endif
43
44 #include "notmuch.h"
45
46 /* This is separate from notmuch-private.h because we're trying to
47  * keep notmuch.c from looking into any internals, (which helps us
48  * develop notmuch.h into a plausible library interface).
49  */
50 #include "xutil.h"
51
52 #include <stddef.h>
53 #include <string.h>
54 #include <sys/stat.h>
55 #include <sys/time.h>
56 #include <unistd.h>
57 #include <dirent.h>
58 #include <errno.h>
59 #include <signal.h>
60
61 #include "talloc-extra.h"
62
63 #define unused(x) x __attribute__ ((unused))
64
65 #define STRINGIFY(s) STRINGIFY_(s)
66 #define STRINGIFY_(s) #s
67
68 typedef struct mime_node mime_node_t;
69 struct sprinter;
70 struct notmuch_show_params;
71
72 typedef struct notmuch_show_format {
73     struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream);
74     notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter,
75                               struct mime_node *node, int indent,
76                               const struct notmuch_show_params *params);
77 } notmuch_show_format_t;
78
79 typedef struct notmuch_crypto {
80     notmuch_crypto_context_t* gpgctx;
81     notmuch_bool_t verify;
82     notmuch_bool_t decrypt;
83     const char *gpgpath;
84 } notmuch_crypto_t;
85
86 typedef struct notmuch_show_params {
87     notmuch_bool_t entire_thread;
88     notmuch_bool_t omit_excluded;
89     notmuch_bool_t output_body;
90     notmuch_bool_t raw;
91     int part;
92     notmuch_crypto_t crypto;
93     notmuch_bool_t include_html;
94 } notmuch_show_params_t;
95
96 /* There's no point in continuing when we've detected that we've done
97  * something wrong internally (as opposed to the user passing in a
98  * bogus value).
99  *
100  * Note that __location__ comes from talloc.h.
101  */
102 #define INTERNAL_ERROR(format, ...)                     \
103     do {                                                \
104         fprintf(stderr,                                 \
105                 "Internal error: " format " (%s)\n",    \
106                 ##__VA_ARGS__, __location__);           \
107         exit (1);                                       \
108     } while (0)
109
110 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
111
112 #define STRNCMP_LITERAL(var, literal) \
113     strncmp ((var), (literal), sizeof (literal) - 1)
114
115 static inline void
116 chomp_newline (char *str)
117 {
118     if (str && str[strlen(str)-1] == '\n')
119         str[strlen(str)-1] = '\0';
120 }
121
122 /* Exit status code indicating the requested format version is too old
123  * (support for that version has been dropped).  CLI code should use
124  * notmuch_exit_if_unsupported_format rather than directly exiting
125  * with this code.
126  */
127 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
128 /* Exit status code indicating the requested format version is newer
129  * than the version supported by the CLI.  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_NEW 21
134
135 /* The current structured output format version.  Requests for format
136  * versions above this will return an error.  Backwards-incompatible
137  * changes such as removing map fields, changing the meaning of map
138  * fields, or changing the meanings of list elements should increase
139  * this.  New (required) map fields can be added without increasing
140  * this.
141  */
142 #define NOTMUCH_FORMAT_CUR 2
143 /* The minimum supported structured output format version.  Requests
144  * for format versions below this will return an error. */
145 #define NOTMUCH_FORMAT_MIN 1
146 /* The minimum non-deprecated structured output format version.
147  * Requests for format versions below this will print a stern warning.
148  * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
149  * inclusive.
150  */
151 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
152
153 /* The output format version requested by the caller on the command
154  * line.  If no format version is requested, this will be set to
155  * NOTMUCH_FORMAT_CUR.  Even though the command-line option is
156  * per-command, this is global because commands can share structured
157  * output code.
158  */
159 extern int notmuch_format_version;
160
161 typedef struct _notmuch_config notmuch_config_t;
162
163 /* Commands that support structured output should support the
164  * following argument
165  *  { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 }
166  * and should invoke notmuch_exit_if_unsupported_format to check the
167  * requested version.  If notmuch_format_version is outside the
168  * supported range, this will print a detailed diagnostic message for
169  * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
170  * the invoking program of the problem.
171  */
172 void
173 notmuch_exit_if_unsupported_format (void);
174
175 notmuch_crypto_context_t *
176 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
177
178 int
179 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
180
181 int
182 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
183
184 int
185 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
186
187 int
188 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
189
190 int
191 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
192
193 int
194 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
195
196 int
197 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
198
199 int
200 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
201
202 int
203 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
204
205 int
206 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
207
208 int
209 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
210
211 int
212 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
213
214 int
215 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
216
217 int
218 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
219
220 const char *
221 notmuch_time_relative_date (const void *ctx, time_t then);
222
223 void
224 notmuch_time_print_formatted_seconds (double seconds);
225
226 double
227 notmuch_time_elapsed (struct timeval start, struct timeval end);
228
229 char *
230 query_string_from_args (void *ctx, int argc, char *argv[]);
231
232 notmuch_status_t
233 show_one_part (const char *filename, int part);
234
235 void
236 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
237                       notmuch_bool_t first, notmuch_bool_t output_body,
238                       notmuch_bool_t include_html);
239
240 void
241 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
242                          notmuch_bool_t reply);
243
244 typedef enum {
245     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
246 } notmuch_show_text_part_flags;
247
248 void
249 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
250                         notmuch_show_text_part_flags flags);
251
252 char *
253 json_quote_chararray (const void *ctx, const char *str, const size_t len);
254
255 char *
256 json_quote_str (const void *ctx, const char *str);
257
258 /* notmuch-config.c */
259
260 notmuch_config_t *
261 notmuch_config_open (void *ctx,
262                      const char *filename,
263                      notmuch_bool_t create_new);
264
265 void
266 notmuch_config_close (notmuch_config_t *config);
267
268 int
269 notmuch_config_save (notmuch_config_t *config);
270
271 notmuch_bool_t
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_crypto_gpg_path (notmuch_config_t *config);
283
284 void
285 notmuch_config_set_crypto_gpg_path (notmuch_config_t *config,
286                                   const char *gpg_path);
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 notmuch_bool_t
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                                               notmuch_bool_t 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 notmuch_bool_t
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     notmuch_bool_t 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     notmuch_bool_t decrypt_success;
394
395     /* True if signature verification on this part was attempted. */
396     notmuch_bool_t verify_attempted;
397 #ifdef GMIME_ATLEAST_26
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 #else
402     /* For signed or encrypted containers, the validity of the
403      * signature.  May be NULL if signature verification failed.  If
404      * there are simply no signatures, this will be non-NULL with an
405      * empty signers list. */
406     const GMimeSignatureValidity *sig_validity;
407 #endif
408
409     /* Internal: Context inherited from the root iterator. */
410     struct mime_node_context *ctx;
411
412     /* Internal: For successfully decrypted multipart parts, the
413      * decrypted part to substitute for the second child. */
414     GMimeObject *decrypted_child;
415
416     /* Internal: The next child for depth-first traversal and the part
417      * number to assign it (or -1 if unknown). */
418     int next_child;
419     int next_part_num;
420 };
421
422 /* Construct a new MIME node pointing to the root message part of
423  * message. If crypto->verify is true, signed child parts will be
424  * verified. If crypto->decrypt is true, encrypted child parts will be
425  * decrypted.  If crypto->gpgctx is NULL, it will be lazily
426  * initialized.
427  *
428  * Return value:
429  *
430  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
431  *
432  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
433  *
434  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
435  */
436 notmuch_status_t
437 mime_node_open (const void *ctx, notmuch_message_t *message,
438                 notmuch_crypto_t *crypto, mime_node_t **node_out);
439
440 /* Return a new MIME node for the requested child part of parent.
441  * parent will be used as the talloc context for the returned child
442  * node.
443  *
444  * In case of any failure, this function returns NULL, (after printing
445  * an error message on stderr).
446  */
447 mime_node_t *
448 mime_node_child (mime_node_t *parent, int child);
449
450 /* Return the nth child of node in a depth-first traversal.  If n is
451  * 0, returns node itself.  Returns NULL if there is no such part. */
452 mime_node_t *
453 mime_node_seek_dfs (mime_node_t *node, int n);
454
455 typedef enum dump_formats {
456     DUMP_FORMAT_AUTO,
457     DUMP_FORMAT_BATCH_TAG,
458     DUMP_FORMAT_SUP
459 } dump_format_t;
460
461 int
462 notmuch_database_dump (notmuch_database_t *notmuch,
463                        const char *output_file_name,
464                        const char *query_str,
465                        dump_format_t output_format,
466                        notmuch_bool_t gzip_output);
467
468 #include "command-line-arguments.h"
469
470 extern char *notmuch_requested_db_uuid;
471 extern const notmuch_opt_desc_t  notmuch_shared_options [];
472 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
473
474 void notmuch_process_shared_options (const char* subcommand_name);
475 int notmuch_minimal_options (const char* subcommand_name,
476                              int argc, char **argv);
477 #endif