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