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