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