cli: add --include-html option to notmuch show
[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 } notmuch_crypto_t;
84
85 typedef struct notmuch_show_params {
86     notmuch_bool_t entire_thread;
87     notmuch_bool_t omit_excluded;
88     notmuch_bool_t output_body;
89     notmuch_bool_t raw;
90     int part;
91     notmuch_crypto_t crypto;
92     notmuch_bool_t include_html;
93 } notmuch_show_params_t;
94
95 /* There's no point in continuing when we've detected that we've done
96  * something wrong internally (as opposed to the user passing in a
97  * bogus value).
98  *
99  * Note that __location__ comes from talloc.h.
100  */
101 #define INTERNAL_ERROR(format, ...)                     \
102     do {                                                \
103         fprintf(stderr,                                 \
104                 "Internal error: " format " (%s)\n",    \
105                 ##__VA_ARGS__, __location__);           \
106         exit (1);                                       \
107     } while (0)
108
109 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
110
111 #define STRNCMP_LITERAL(var, literal) \
112     strncmp ((var), (literal), sizeof (literal) - 1)
113
114 static inline void
115 chomp_newline (char *str)
116 {
117     if (str && str[strlen(str)-1] == '\n')
118         str[strlen(str)-1] = '\0';
119 }
120
121 /* Exit status code indicating the requested format version is too old
122  * (support for that version has been dropped).  CLI code should use
123  * notmuch_exit_if_unsupported_format rather than directly exiting
124  * with this code.
125  */
126 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
127 /* Exit status code indicating the requested format version is newer
128  * than the version supported by the CLI.  CLI code should use
129  * notmuch_exit_if_unsupported_format rather than directly exiting
130  * with this code.
131  */
132 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
133
134 /* The current structured output format version.  Requests for format
135  * versions above this will return an error.  Backwards-incompatible
136  * changes such as removing map fields, changing the meaning of map
137  * fields, or changing the meanings of list elements should increase
138  * this.  New (required) map fields can be added without increasing
139  * this.
140  */
141 #define NOTMUCH_FORMAT_CUR 1
142 /* The minimum supported structured output format version.  Requests
143  * for format versions below this will return an error. */
144 #define NOTMUCH_FORMAT_MIN 1
145
146 /* The output format version requested by the caller on the command
147  * line.  If no format version is requested, this will be set to
148  * NOTMUCH_FORMAT_CUR.  Even though the command-line option is
149  * per-command, this is global because commands can share structured
150  * output code.
151  */
152 extern int notmuch_format_version;
153
154 typedef struct _notmuch_config notmuch_config_t;
155
156 /* Commands that support structured output should support the
157  * following argument
158  *  { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 }
159  * and should invoke notmuch_exit_if_unsupported_format to check the
160  * requested version.  If notmuch_format_version is outside the
161  * supported range, this will print a detailed diagnostic message for
162  * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
163  * the invoking program of the problem.
164  */
165 void
166 notmuch_exit_if_unsupported_format (void);
167
168 notmuch_crypto_context_t *
169 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
170
171 int
172 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
173
174 int
175 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
176
177 int
178 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
179
180 int
181 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
182
183 int
184 notmuch_insert_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_setup_command (notmuch_config_t *config, int argc, char *argv[]);
197
198 int
199 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
200
201 int
202 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
203
204 int
205 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
206
207 const char *
208 notmuch_time_relative_date (const void *ctx, time_t then);
209
210 void
211 notmuch_time_print_formatted_seconds (double seconds);
212
213 double
214 notmuch_time_elapsed (struct timeval start, struct timeval end);
215
216 char *
217 query_string_from_args (void *ctx, int argc, char *argv[]);
218
219 notmuch_status_t
220 show_one_part (const char *filename, int part);
221
222 void
223 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
224                       notmuch_bool_t first, notmuch_bool_t output_body,
225                       notmuch_bool_t include_html);
226
227 void
228 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
229                          notmuch_bool_t reply);
230
231 typedef enum {
232     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
233 } notmuch_show_text_part_flags;
234
235 void
236 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
237                         notmuch_show_text_part_flags flags);
238
239 char *
240 json_quote_chararray (const void *ctx, const char *str, const size_t len);
241
242 char *
243 json_quote_str (const void *ctx, const char *str);
244
245 /* notmuch-config.c */
246
247 notmuch_config_t *
248 notmuch_config_open (void *ctx,
249                      const char *filename,
250                      notmuch_bool_t create_new);
251
252 void
253 notmuch_config_close (notmuch_config_t *config);
254
255 int
256 notmuch_config_save (notmuch_config_t *config);
257
258 notmuch_bool_t
259 notmuch_config_is_new (notmuch_config_t *config);
260
261 const char *
262 notmuch_config_get_database_path (notmuch_config_t *config);
263
264 void
265 notmuch_config_set_database_path (notmuch_config_t *config,
266                                   const char *database_path);
267
268 const char *
269 notmuch_config_get_user_name (notmuch_config_t *config);
270
271 void
272 notmuch_config_set_user_name (notmuch_config_t *config,
273                               const char *user_name);
274
275 const char *
276 notmuch_config_get_user_primary_email (notmuch_config_t *config);
277
278 void
279 notmuch_config_set_user_primary_email (notmuch_config_t *config,
280                                        const char *primary_email);
281
282 const char **
283 notmuch_config_get_user_other_email (notmuch_config_t *config,
284                                      size_t *length);
285
286 void
287 notmuch_config_set_user_other_email (notmuch_config_t *config,
288                                      const char *other_email[],
289                                      size_t length);
290
291 const char **
292 notmuch_config_get_new_tags (notmuch_config_t *config,
293                              size_t *length);
294 void
295 notmuch_config_set_new_tags (notmuch_config_t *config,
296                              const char *new_tags[],
297                              size_t length);
298
299 const char **
300 notmuch_config_get_new_ignore (notmuch_config_t *config,
301                                size_t *length);
302
303 void
304 notmuch_config_set_new_ignore (notmuch_config_t *config,
305                                const char *new_ignore[],
306                                size_t length);
307
308 notmuch_bool_t
309 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
310
311 void
312 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
313                                               notmuch_bool_t synchronize_flags);
314
315 const char **
316 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
317
318 void
319 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
320                                       const char *list[],
321                                       size_t length);
322
323 int
324 notmuch_run_hook (const char *db_path, const char *hook);
325
326 notmuch_bool_t
327 debugger_is_active (void);
328
329 /* mime-node.c */
330
331 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
332  * abstracts the different ways of traversing different types of MIME
333  * parts, allowing a MIME message to be viewed as a generic tree of
334  * parts.  Message-type parts have one child, multipart-type parts
335  * have multiple children, and leaf parts have zero children.
336  */
337 struct mime_node {
338     /* The MIME object of this part.  This will be a GMimeMessage,
339      * GMimePart, GMimeMultipart, or a subclass of one of these.
340      *
341      * This will never be a GMimeMessagePart because GMimeMessagePart
342      * is structurally redundant with GMimeMessage.  If this part is a
343      * message (that is, 'part' is a GMimeMessage), then either
344      * envelope_file will be set to a notmuch_message_t (for top-level
345      * messages) or envelope_part will be set to a GMimeMessagePart
346      * (for embedded message parts).
347      */
348     GMimeObject *part;
349
350     /* If part is a GMimeMessage, these record the envelope of the
351      * message: either a notmuch_message_t representing a top-level
352      * message, or a GMimeMessagePart representing a MIME part
353      * containing a message.
354      */
355     notmuch_message_t *envelope_file;
356     GMimeMessagePart *envelope_part;
357
358     /* The number of children of this part. */
359     int nchildren;
360
361     /* The parent of this node or NULL if this is the root node. */
362     struct mime_node *parent;
363
364     /* The depth-first part number of this child if the MIME tree is
365      * being traversed in depth-first order, or -1 otherwise. */
366     int part_num;
367
368     /* True if decryption of this part was attempted. */
369     notmuch_bool_t decrypt_attempted;
370     /* True if decryption of this part's child succeeded.  In this
371      * case, the decrypted part is substituted for the second child of
372      * this part (which would usually be the encrypted data). */
373     notmuch_bool_t decrypt_success;
374
375     /* True if signature verification on this part was attempted. */
376     notmuch_bool_t verify_attempted;
377 #ifdef GMIME_ATLEAST_26
378     /* The list of signatures for signed or encrypted containers. If
379      * there are no signatures, this will be NULL. */
380     GMimeSignatureList* sig_list;
381 #else
382     /* For signed or encrypted containers, the validity of the
383      * signature.  May be NULL if signature verification failed.  If
384      * there are simply no signatures, this will be non-NULL with an
385      * empty signers list. */
386     const GMimeSignatureValidity *sig_validity;
387 #endif
388
389     /* Internal: Context inherited from the root iterator. */
390     struct mime_node_context *ctx;
391
392     /* Internal: For successfully decrypted multipart parts, the
393      * decrypted part to substitute for the second child. */
394     GMimeObject *decrypted_child;
395
396     /* Internal: The next child for depth-first traversal and the part
397      * number to assign it (or -1 if unknown). */
398     int next_child;
399     int next_part_num;
400 };
401
402 /* Construct a new MIME node pointing to the root message part of
403  * message. If crypto->verify is true, signed child parts will be
404  * verified. If crypto->decrypt is true, encrypted child parts will be
405  * decrypted.  If crypto->gpgctx is NULL, it will be lazily
406  * initialized.
407  *
408  * Return value:
409  *
410  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
411  *
412  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
413  *
414  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
415  */
416 notmuch_status_t
417 mime_node_open (const void *ctx, notmuch_message_t *message,
418                 notmuch_crypto_t *crypto, mime_node_t **node_out);
419
420 /* Return a new MIME node for the requested child part of parent.
421  * parent will be used as the talloc context for the returned child
422  * node.
423  *
424  * In case of any failure, this function returns NULL, (after printing
425  * an error message on stderr).
426  */
427 mime_node_t *
428 mime_node_child (mime_node_t *parent, int child);
429
430 /* Return the nth child of node in a depth-first traversal.  If n is
431  * 0, returns node itself.  Returns NULL if there is no such part. */
432 mime_node_t *
433 mime_node_seek_dfs (mime_node_t *node, int n);
434
435 #include "command-line-arguments.h"
436 #endif