d377b044fdccb06886b3a111f5e0daee0f7b7e78
[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.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 notmuch_show_params;
70
71 typedef struct notmuch_show_format {
72     const char *message_set_start;
73     notmuch_status_t (*part) (const void *ctx,
74                               struct mime_node *node, int indent,
75                               const struct notmuch_show_params *params);
76     const char *message_set_sep;
77     const char *message_set_end;
78 } notmuch_show_format_t;
79
80 typedef struct notmuch_show_params {
81     notmuch_bool_t entire_thread;
82     notmuch_bool_t omit_excluded;
83     notmuch_bool_t raw;
84     int part;
85     notmuch_crypto_context_t* cryptoctx;
86     notmuch_bool_t decrypt;
87 } notmuch_show_params_t;
88
89 /* There's no point in continuing when we've detected that we've done
90  * something wrong internally (as opposed to the user passing in a
91  * bogus value).
92  *
93  * Note that __location__ comes from talloc.h.
94  */
95 #define INTERNAL_ERROR(format, ...)                     \
96     do {                                                \
97         fprintf(stderr,                                 \
98                 "Internal error: " format " (%s)\n",    \
99                 ##__VA_ARGS__, __location__);           \
100         exit (1);                                       \
101     } while (0)
102
103 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
104
105 #define STRNCMP_LITERAL(var, literal) \
106     strncmp ((var), (literal), sizeof (literal) - 1)
107
108 static inline void
109 chomp_newline (char *str)
110 {
111     if (str && str[strlen(str)-1] == '\n')
112         str[strlen(str)-1] = '\0';
113 }
114
115 int
116 notmuch_count_command (void *ctx, int argc, char *argv[]);
117
118 int
119 notmuch_dump_command (void *ctx, int argc, char *argv[]);
120
121 int
122 notmuch_new_command (void *ctx, int argc, char *argv[]);
123
124 int
125 notmuch_reply_command (void *ctx, int argc, char *argv[]);
126
127 int
128 notmuch_restore_command (void *ctx, int argc, char *argv[]);
129
130 int
131 notmuch_search_command (void *ctx, int argc, char *argv[]);
132
133 int
134 notmuch_setup_command (void *ctx, int argc, char *argv[]);
135
136 int
137 notmuch_show_command (void *ctx, int argc, char *argv[]);
138
139 int
140 notmuch_tag_command (void *ctx, int argc, char *argv[]);
141
142 int
143 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
144
145 int
146 notmuch_cat_command (void *ctx, int argc, char *argv[]);
147
148 int
149 notmuch_config_command (void *ctx, int argc, char *argv[]);
150
151 const char *
152 notmuch_time_relative_date (const void *ctx, time_t then);
153
154 void
155 notmuch_time_print_formatted_seconds (double seconds);
156
157 double
158 notmuch_time_elapsed (struct timeval start, struct timeval end);
159
160 char *
161 query_string_from_args (void *ctx, int argc, char *argv[]);
162
163 notmuch_status_t
164 show_one_part (const char *filename, int part);
165
166 void
167 format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first);
168
169 void
170 format_headers_json (const void *ctx, GMimeMessage *message, notmuch_bool_t reply);
171
172 typedef enum {
173     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
174 } notmuch_show_text_part_flags;
175
176 void
177 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
178                         notmuch_show_text_part_flags flags);
179
180 char *
181 json_quote_chararray (const void *ctx, const char *str, const size_t len);
182
183 char *
184 json_quote_str (const void *ctx, const char *str);
185
186 /* notmuch-config.c */
187
188 typedef struct _notmuch_config notmuch_config_t;
189
190 notmuch_config_t *
191 notmuch_config_open (void *ctx,
192                      const char *filename,
193                      notmuch_bool_t *is_new_ret);
194
195 void
196 notmuch_config_close (notmuch_config_t *config);
197
198 int
199 notmuch_config_save (notmuch_config_t *config);
200
201 const char *
202 notmuch_config_get_database_path (notmuch_config_t *config);
203
204 void
205 notmuch_config_set_database_path (notmuch_config_t *config,
206                                   const char *database_path);
207
208 const char *
209 notmuch_config_get_user_name (notmuch_config_t *config);
210
211 void
212 notmuch_config_set_user_name (notmuch_config_t *config,
213                               const char *user_name);
214
215 const char *
216 notmuch_config_get_user_primary_email (notmuch_config_t *config);
217
218 void
219 notmuch_config_set_user_primary_email (notmuch_config_t *config,
220                                        const char *primary_email);
221
222 const char **
223 notmuch_config_get_user_other_email (notmuch_config_t *config,
224                                      size_t *length);
225
226 void
227 notmuch_config_set_user_other_email (notmuch_config_t *config,
228                                      const char *other_email[],
229                                      size_t length);
230
231 const char **
232 notmuch_config_get_new_tags (notmuch_config_t *config,
233                              size_t *length);
234 void
235 notmuch_config_set_new_tags (notmuch_config_t *config,
236                              const char *new_tags[],
237                              size_t length);
238
239 const char **
240 notmuch_config_get_new_ignore (notmuch_config_t *config,
241                                size_t *length);
242
243 void
244 notmuch_config_set_new_ignore (notmuch_config_t *config,
245                                const char *new_ignore[],
246                                size_t length);
247
248 notmuch_bool_t
249 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
250
251 void
252 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
253                                               notmuch_bool_t synchronize_flags);
254
255 const char **
256 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
257
258 void
259 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
260                                       const char *list[],
261                                       size_t length);
262
263 int
264 notmuch_run_hook (const char *db_path, const char *hook);
265
266 notmuch_bool_t
267 debugger_is_active (void);
268
269 /* mime-node.c */
270
271 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
272  * abstracts the different ways of traversing different types of MIME
273  * parts, allowing a MIME message to be viewed as a generic tree of
274  * parts.  Message-type parts have one child, multipart-type parts
275  * have multiple children, and leaf parts have zero children.
276  */
277 struct mime_node {
278     /* The MIME object of this part.  This will be a GMimeMessage,
279      * GMimePart, GMimeMultipart, or a subclass of one of these.
280      *
281      * This will never be a GMimeMessagePart because GMimeMessagePart
282      * is structurally redundant with GMimeMessage.  If this part is a
283      * message (that is, 'part' is a GMimeMessage), then either
284      * envelope_file will be set to a notmuch_message_t (for top-level
285      * messages) or envelope_part will be set to a GMimeMessagePart
286      * (for embedded message parts).
287      */
288     GMimeObject *part;
289
290     /* If part is a GMimeMessage, these record the envelope of the
291      * message: either a notmuch_message_t representing a top-level
292      * message, or a GMimeMessagePart representing a MIME part
293      * containing a message.
294      */
295     notmuch_message_t *envelope_file;
296     GMimeMessagePart *envelope_part;
297
298     /* The number of children of this part. */
299     int nchildren;
300
301     /* The parent of this node or NULL if this is the root node. */
302     struct mime_node *parent;
303
304     /* The depth-first part number of this child if the MIME tree is
305      * being traversed in depth-first order, or -1 otherwise. */
306     int part_num;
307
308     /* True if decryption of this part was attempted. */
309     notmuch_bool_t decrypt_attempted;
310     /* True if decryption of this part's child succeeded.  In this
311      * case, the decrypted part is substituted for the second child of
312      * this part (which would usually be the encrypted data). */
313     notmuch_bool_t decrypt_success;
314
315     /* True if signature verification on this part was attempted. */
316     notmuch_bool_t verify_attempted;
317 #ifdef GMIME_ATLEAST_26
318     /* The list of signatures for signed or encrypted containers. If
319      * there are no signatures, this will be NULL. */
320     GMimeSignatureList* sig_list;
321 #else
322     /* For signed or encrypted containers, the validity of the
323      * signature.  May be NULL if signature verification failed.  If
324      * there are simply no signatures, this will be non-NULL with an
325      * empty signers list. */
326     const GMimeSignatureValidity *sig_validity;
327 #endif
328
329     /* Internal: Context inherited from the root iterator. */
330     struct mime_node_context *ctx;
331
332     /* Internal: For successfully decrypted multipart parts, the
333      * decrypted part to substitute for the second child. */
334     GMimeObject *decrypted_child;
335
336     /* Internal: The next child for depth-first traversal and the part
337      * number to assign it (or -1 if unknown). */
338     int next_child;
339     int next_part_num;
340 };
341
342 /* Construct a new MIME node pointing to the root message part of
343  * message.  If cryptoctx is non-NULL, it will be used to verify
344  * signatures on any child parts.  If decrypt is true, then cryptoctx
345  * will additionally be used to decrypt any encrypted child parts.
346  *
347  * Return value:
348  *
349  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
350  *
351  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
352  *
353  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
354  */
355 notmuch_status_t
356 mime_node_open (const void *ctx, notmuch_message_t *message,
357                 notmuch_crypto_context_t *cryptoctx,
358                 notmuch_bool_t decrypt, mime_node_t **node_out);
359
360 /* Return a new MIME node for the requested child part of parent.
361  * parent will be used as the talloc context for the returned child
362  * node.
363  *
364  * In case of any failure, this function returns NULL, (after printing
365  * an error message on stderr).
366  */
367 mime_node_t *
368 mime_node_child (mime_node_t *parent, int child);
369
370 /* Return the nth child of node in a depth-first traversal.  If n is
371  * 0, returns node itself.  Returns NULL if there is no such part. */
372 mime_node_t *
373 mime_node_seek_dfs (mime_node_t *node, int n);
374
375 #include "command-line-arguments.h"
376 #endif