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