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