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