703ae7bb7a014c06bb03f18d7b9994b42275ba21
[notmuch] / lib / notmuch-private.h
1 /* notmuch-private.h - Internal interfaces for notmuch.
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_PRIVATE_H
22 #define NOTMUCH_PRIVATE_H
23
24 #ifndef _GNU_SOURCE
25 #define _GNU_SOURCE /* For getline and asprintf */
26 #endif
27 #include <stdio.h>
28
29 #include "compat.h"
30
31 #include "notmuch.h"
32
33 NOTMUCH_BEGIN_DECLS
34
35 #include <stdlib.h>
36 #include <stdarg.h>
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #include <sys/mman.h>
40 #include <string.h>
41 #include <errno.h>
42 #include <fcntl.h>
43 #include <unistd.h>
44 #include <ctype.h>
45 #include <assert.h>
46
47 #include <talloc.h>
48
49 #include <gmime/gmime.h>
50
51 #include "xutil.h"
52 #include "error_util.h"
53
54 #pragma GCC visibility push(hidden)
55
56 #ifdef DEBUG
57 # define DEBUG_DATABASE_SANITY 1
58 # define DEBUG_QUERY 1
59 #endif
60
61 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
62
63 #define STRNCMP_LITERAL(var, literal) \
64     strncmp ((var), (literal), sizeof (literal) - 1)
65
66 #define unused(x) x __attribute__ ((unused))
67
68 #ifdef __cplusplus
69 # define visible __attribute__((visibility("default")))
70 #else
71 # define visible
72 #endif
73
74 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
75  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
76  */
77 /* these macros gain us a few percent of speed on gcc */
78 #if (__GNUC__ >= 3)
79 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
80    as its first argument */
81 #ifndef likely
82 #define likely(x)   __builtin_expect(!!(x), 1)
83 #endif
84 #ifndef unlikely
85 #define unlikely(x) __builtin_expect(!!(x), 0)
86 #endif
87 #else
88 #ifndef likely
89 #define likely(x) (x)
90 #endif
91 #ifndef unlikely
92 #define unlikely(x) (x)
93 #endif
94 #endif
95
96 typedef enum {
97     NOTMUCH_VALUE_TIMESTAMP = 0,
98     NOTMUCH_VALUE_MESSAGE_ID,
99     NOTMUCH_VALUE_FROM,
100     NOTMUCH_VALUE_SUBJECT
101 } notmuch_value_t;
102
103 /* Xapian (with flint backend) complains if we provide a term longer
104  * than this, but I haven't yet found a way to query the limit
105  * programmatically. */
106 #define NOTMUCH_TERM_MAX 245
107
108 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
109
110 /* For message IDs we have to be even more restrictive. Beyond fitting
111  * into the term limit, we also use message IDs to construct
112  * metadata-key values. And the documentation says that these should
113  * be restricted to about 200 characters. (The actual limit for the
114  * chert backend at least is 252.)
115  */
116 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
117
118 typedef enum _notmuch_private_status {
119     /* First, copy all the public status values. */
120     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
121     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
122     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
123     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
124     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
125     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
126     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
127     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
128
129     /* Then add our own private values. */
130     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
131     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
132
133     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
134 } notmuch_private_status_t;
135
136 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
137  * value, generating an internal error if the private value is equal
138  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
139  * that the caller has previously handled any expected
140  * notmuch_private_status_t values.)
141  *
142  * Note that the function _internal_error does not return. Evaluating
143  * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
144  */
145 #define COERCE_STATUS(private_status, format, ...)                      \
146     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
147      ?                                                                  \
148      _internal_error (format " (%s).\n",                                \
149                       ##__VA_ARGS__,                                    \
150                       __location__),                                    \
151      (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS                  \
152      :                                                                  \
153      (notmuch_status_t) private_status)
154
155 /* Flags shared by various lookup functions. */
156 typedef enum _notmuch_find_flags {
157     /* Lookup without creating any documents.  This is the default
158      * behavior. */
159     NOTMUCH_FIND_LOOKUP = 0,
160     /* If set, create the necessary document (or documents) if they
161      * are missing.  Requires a read/write database. */
162     NOTMUCH_FIND_CREATE = 1<<0,
163 } notmuch_find_flags_t;
164
165 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
166
167 /* database.cc */
168
169 /* Lookup a prefix value by name.
170  *
171  * XXX: This should really be static inside of message.cc, and we can
172  * do that once we convert database.cc to use the
173  * _notmuch_message_add/remove_term functions. */
174 const char *
175 _find_prefix (const char *name);
176
177 notmuch_status_t
178 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
179
180 const char *
181 _notmuch_database_relative_path (notmuch_database_t *notmuch,
182                                  const char *path);
183
184 notmuch_status_t
185 _notmuch_database_split_path (void *ctx,
186                               const char *path,
187                               const char **directory,
188                               const char **basename);
189
190 const char *
191 _notmuch_database_get_directory_db_path (const char *path);
192
193 unsigned int
194 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
195
196 notmuch_private_status_t
197 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
198                                       const char *prefix_name,
199                                       const char *value,
200                                       unsigned int *doc_id);
201
202 notmuch_status_t
203 _notmuch_database_find_directory_id (notmuch_database_t *database,
204                                      const char *path,
205                                      notmuch_find_flags_t flags,
206                                      unsigned int *directory_id);
207
208 const char *
209 _notmuch_database_get_directory_path (void *ctx,
210                                       notmuch_database_t *notmuch,
211                                       unsigned int doc_id);
212
213 notmuch_status_t
214 _notmuch_database_filename_to_direntry (void *ctx,
215                                         notmuch_database_t *notmuch,
216                                         const char *filename,
217                                         notmuch_find_flags_t flags,
218                                         char **direntry);
219
220 /* directory.cc */
221
222 notmuch_directory_t *
223 _notmuch_directory_create (notmuch_database_t *notmuch,
224                            const char *path,
225                            notmuch_find_flags_t flags,
226                            notmuch_status_t *status_ret);
227
228 unsigned int
229 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
230
231 /* message.cc */
232
233 notmuch_message_t *
234 _notmuch_message_create (const void *talloc_owner,
235                          notmuch_database_t *notmuch,
236                          unsigned int doc_id,
237                          notmuch_private_status_t *status);
238
239 notmuch_message_t *
240 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
241                                         const char *message_id,
242                                         notmuch_private_status_t *status);
243
244 unsigned int
245 _notmuch_message_get_doc_id (notmuch_message_t *message);
246
247 const char *
248 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
249
250 notmuch_private_status_t
251 _notmuch_message_add_term (notmuch_message_t *message,
252                            const char *prefix_name,
253                            const char *value);
254
255 notmuch_private_status_t
256 _notmuch_message_remove_term (notmuch_message_t *message,
257                               const char *prefix_name,
258                               const char *value);
259
260 notmuch_private_status_t
261 _notmuch_message_gen_terms (notmuch_message_t *message,
262                             const char *prefix_name,
263                             const char *text);
264
265 void
266 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
267
268 void
269 _notmuch_message_upgrade_folder (notmuch_message_t *message);
270
271 notmuch_status_t
272 _notmuch_message_add_filename (notmuch_message_t *message,
273                                const char *filename);
274
275 notmuch_status_t
276 _notmuch_message_remove_filename (notmuch_message_t *message,
277                                   const char *filename);
278
279 notmuch_status_t
280 _notmuch_message_rename (notmuch_message_t *message,
281                          const char *new_filename);
282
283 void
284 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
285
286 void
287 _notmuch_message_set_header_values (notmuch_message_t *message,
288                                     const char *date,
289                                     const char *from,
290                                     const char *subject);
291 void
292 _notmuch_message_sync (notmuch_message_t *message);
293
294 notmuch_status_t
295 _notmuch_message_delete (notmuch_message_t *message);
296
297 void
298 _notmuch_message_close (notmuch_message_t *message);
299
300 /* Get a copy of the data in this message document.
301  *
302  * Caller should talloc_free the result when done.
303  *
304  * This function is intended to support database upgrade and really
305  * shouldn't be used otherwise. */
306 char *
307 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
308
309 /* Clear the data in this message document.
310  *
311  * This function is intended to support database upgrade and really
312  * shouldn't be used otherwise. */
313 void
314 _notmuch_message_clear_data (notmuch_message_t *message);
315
316 /* Set the author member of 'message' - this is the representation used
317  * when displaying the message */
318 void
319 notmuch_message_set_author (notmuch_message_t *message, const char *author);
320
321 /* Get the author member of 'message' */
322 const char *
323 notmuch_message_get_author (notmuch_message_t *message);
324
325 /* message-file.c */
326
327 /* XXX: I haven't decided yet whether these will actually get exported
328  * into the public interface in notmuch.h
329  */
330
331 typedef struct _notmuch_message_file notmuch_message_file_t;
332
333 /* Open a file containing a single email message.
334  *
335  * The caller should call notmuch_message_close when done with this.
336  *
337  * Returns NULL if any error occurs.
338  */
339 notmuch_message_file_t *
340 notmuch_message_file_open (const char *filename);
341
342 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
343 notmuch_message_file_t *
344 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
345
346 /* Close a notmuch message previously opened with notmuch_message_open. */
347 void
348 notmuch_message_file_close (notmuch_message_file_t *message);
349
350 /* Parse the message.
351  *
352  * This will be done automatically as necessary on other calls
353  * depending on it, but an explicit call allows for better error
354  * status reporting.
355  */
356 notmuch_status_t
357 _notmuch_message_file_parse (notmuch_message_file_t *message);
358
359 /* Get the gmime message of a message file.
360  *
361  * The message file is parsed as necessary.
362  *
363  * The GMimeMessage* is set to *mime_message on success (which the
364  * caller must not unref).
365  *
366  * XXX: Would be nice to not have to expose GMimeMessage here.
367  */
368 notmuch_status_t
369 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
370                                         GMimeMessage **mime_message);
371
372 /* Get the value of the specified header from the message as a UTF-8 string.
373  *
374  * The message file is parsed as necessary.
375  *
376  * The header name is case insensitive.
377  *
378  * The Received: header is special - for it all Received: headers in
379  * the message are concatenated
380  *
381  * The returned value is owned by the notmuch message and is valid
382  * only until the message is closed. The caller should copy it if
383  * needing to modify the value or to hold onto it for longer.
384  *
385  * Returns NULL on errors, empty string if the message does not
386  * contain a header line matching 'header'.
387  */
388 const char *
389 notmuch_message_file_get_header (notmuch_message_file_t *message,
390                                  const char *header);
391
392 /* index.cc */
393
394 notmuch_status_t
395 _notmuch_message_index_file (notmuch_message_t *message,
396                              notmuch_message_file_t *message_file);
397
398 /* messages.c */
399
400 typedef struct _notmuch_message_node {
401     notmuch_message_t *message;
402     struct _notmuch_message_node *next;
403 } notmuch_message_node_t;
404
405 typedef struct _notmuch_message_list {
406     notmuch_message_node_t *head;
407     notmuch_message_node_t **tail;
408 } notmuch_message_list_t;
409
410 /* There's a rumor that there's an alternate struct _notmuch_messages
411  * somewhere with some nasty C++ objects in it. We'll try to maintain
412  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
413  */
414 struct visible _notmuch_messages {
415     notmuch_bool_t is_of_list_type;
416     notmuch_doc_id_set_t *excluded_doc_ids;
417     notmuch_message_node_t *iterator;
418 };
419
420 notmuch_message_list_t *
421 _notmuch_message_list_create (const void *ctx);
422
423 void
424 _notmuch_message_list_add_message (notmuch_message_list_t *list,
425                                    notmuch_message_t *message);
426
427 notmuch_messages_t *
428 _notmuch_messages_create (notmuch_message_list_t *list);
429
430 /* query.cc */
431
432 notmuch_bool_t
433 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
434
435 notmuch_message_t *
436 _notmuch_mset_messages_get (notmuch_messages_t *messages);
437
438 void
439 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
440
441 notmuch_bool_t
442 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
443                               unsigned int doc_id);
444
445 void
446 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
447                             unsigned int doc_id);
448
449 /* message.cc */
450
451 void
452 _notmuch_message_add_reply (notmuch_message_t *message,
453                             notmuch_message_t *reply);
454
455 /* sha1.c */
456
457 char *
458 notmuch_sha1_of_string (const char *str);
459
460 char *
461 notmuch_sha1_of_file (const char *filename);
462
463 /* string-list.c */
464
465 typedef struct _notmuch_string_node {
466     char *string;
467     struct _notmuch_string_node *next;
468 } notmuch_string_node_t;
469
470 typedef struct visible _notmuch_string_list {
471     int length;
472     notmuch_string_node_t *head;
473     notmuch_string_node_t **tail;
474 } notmuch_string_list_t;
475
476 notmuch_string_list_t *
477 _notmuch_string_list_create (const void *ctx);
478
479 /* Add 'string' to 'list'.
480  *
481  * The list will create its own talloced copy of 'string'.
482  */
483 void
484 _notmuch_string_list_append (notmuch_string_list_t *list,
485                              const char *string);
486
487 void
488 _notmuch_string_list_sort (notmuch_string_list_t *list);
489
490 /* tags.c */
491
492 notmuch_tags_t *
493 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
494
495 /* filenames.c */
496
497 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
498  * file names */
499 notmuch_filenames_t *
500 _notmuch_filenames_create (const void *ctx,
501                            notmuch_string_list_t *list);
502
503 /* thread.cc */
504
505 notmuch_thread_t *
506 _notmuch_thread_create (void *ctx,
507                         notmuch_database_t *notmuch,
508                         unsigned int seed_doc_id,
509                         notmuch_doc_id_set_t *match_set,
510                         notmuch_string_list_t *excluded_terms,
511                         notmuch_exclude_t omit_exclude,
512                         notmuch_sort_t sort);
513
514 NOTMUCH_END_DECLS
515
516 #ifdef __cplusplus
517 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
518  * C++. In talloc_steal, an explicit cast is provided for type safety
519  * in some GCC versions. Otherwise, a cast is required. Provide a
520  * template function for this to maintain type safety, and redefine
521  * talloc_steal to use it.
522  */
523 #if !(__GNUC__ >= 3)
524 template <class T> T *
525 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
526 {
527     return static_cast<T *> (talloc_steal (new_ctx, ptr));
528 }
529 #undef talloc_steal
530 #define talloc_steal _notmuch_talloc_steal
531 #endif
532 #endif
533
534 #pragma GCC visibility pop
535
536 #endif