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