lib: Make directory document creation optional for _notmuch_directory_create
[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     /* If set, create the necessary document (or documents) if they
152      * are missing.  Requires a read/write database. */
153     NOTMUCH_FIND_CREATE = 1<<0,
154 } notmuch_find_flags_t;
155
156 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
157
158 typedef struct _notmuch_string_list notmuch_string_list_t;
159
160 /* database.cc */
161
162 /* Lookup a prefix value by name.
163  *
164  * XXX: This should really be static inside of message.cc, and we can
165  * do that once we convert database.cc to use the
166  * _notmuch_message_add/remove_term functions. */
167 const char *
168 _find_prefix (const char *name);
169
170 notmuch_status_t
171 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
172
173 const char *
174 _notmuch_database_relative_path (notmuch_database_t *notmuch,
175                                  const char *path);
176
177 notmuch_status_t
178 _notmuch_database_split_path (void *ctx,
179                               const char *path,
180                               const char **directory,
181                               const char **basename);
182
183 const char *
184 _notmuch_database_get_directory_db_path (const char *path);
185
186 unsigned int
187 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
188
189 notmuch_private_status_t
190 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
191                                       const char *prefix_name,
192                                       const char *value,
193                                       unsigned int *doc_id);
194
195 notmuch_status_t
196 _notmuch_database_find_directory_id (notmuch_database_t *database,
197                                      const char *path,
198                                      unsigned int *directory_id);
199
200 const char *
201 _notmuch_database_get_directory_path (void *ctx,
202                                       notmuch_database_t *notmuch,
203                                       unsigned int doc_id);
204
205 notmuch_status_t
206 _notmuch_database_filename_to_direntry (void *ctx,
207                                         notmuch_database_t *notmuch,
208                                         const char *filename,
209                                         char **direntry);
210
211 /* directory.cc */
212
213 notmuch_directory_t *
214 _notmuch_directory_create (notmuch_database_t *notmuch,
215                            const char *path,
216                            notmuch_find_flags_t flags,
217                            notmuch_status_t *status_ret);
218
219 unsigned int
220 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
221
222 /* thread.cc */
223
224 notmuch_thread_t *
225 _notmuch_thread_create (void *ctx,
226                         notmuch_database_t *notmuch,
227                         unsigned int seed_doc_id,
228                         notmuch_doc_id_set_t *match_set,
229                         notmuch_string_list_t *excluded_terms,
230                         notmuch_sort_t sort);
231
232 /* message.cc */
233
234 notmuch_message_t *
235 _notmuch_message_create (const void *talloc_owner,
236                          notmuch_database_t *notmuch,
237                          unsigned int doc_id,
238                          notmuch_private_status_t *status);
239
240 notmuch_message_t *
241 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
242                                         const char *message_id,
243                                         notmuch_private_status_t *status);
244
245 unsigned int
246 _notmuch_message_get_doc_id (notmuch_message_t *message);
247
248 const char *
249 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
250
251 notmuch_private_status_t
252 _notmuch_message_add_term (notmuch_message_t *message,
253                            const char *prefix_name,
254                            const char *value);
255
256 notmuch_private_status_t
257 _notmuch_message_remove_term (notmuch_message_t *message,
258                               const char *prefix_name,
259                               const char *value);
260
261 notmuch_private_status_t
262 _notmuch_message_gen_terms (notmuch_message_t *message,
263                             const char *prefix_name,
264                             const char *text);
265
266 void
267 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
268
269 notmuch_status_t
270 _notmuch_message_add_filename (notmuch_message_t *message,
271                                const char *filename);
272
273 notmuch_status_t
274 _notmuch_message_remove_filename (notmuch_message_t *message,
275                                   const char *filename);
276
277 notmuch_status_t
278 _notmuch_message_rename (notmuch_message_t *message,
279                          const char *new_filename);
280
281 void
282 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
283
284 void
285 _notmuch_message_set_header_values (notmuch_message_t *message,
286                                     const char *date,
287                                     const char *from,
288                                     const char *subject);
289 void
290 _notmuch_message_sync (notmuch_message_t *message);
291
292 notmuch_status_t
293 _notmuch_message_delete (notmuch_message_t *message);
294
295 void
296 _notmuch_message_close (notmuch_message_t *message);
297
298 /* Get a copy of the data in this message document.
299  *
300  * Caller should talloc_free the result when done.
301  *
302  * This function is intended to support database upgrade and really
303  * shouldn't be used otherwise. */
304 char *
305 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
306
307 /* Clear the data in this message document.
308  *
309  * This function is intended to support database upgrade and really
310  * shouldn't be used otherwise. */
311 void
312 _notmuch_message_clear_data (notmuch_message_t *message);
313
314 /* Set the author member of 'message' - this is the representation used
315  * when displaying the message */
316 void
317 notmuch_message_set_author (notmuch_message_t *message, const char *author);
318
319 /* Get the author member of 'message' */
320 const char *
321 notmuch_message_get_author (notmuch_message_t *message);
322
323
324 /* index.cc */
325
326 notmuch_status_t
327 _notmuch_message_index_file (notmuch_message_t *message,
328                              const char *filename);
329
330 /* message-file.c */
331
332 /* XXX: I haven't decided yet whether these will actually get exported
333  * into the public interface in notmuch.h
334  */
335
336 typedef struct _notmuch_message_file notmuch_message_file_t;
337
338 /* Open a file containing a single email message.
339  *
340  * The caller should call notmuch_message_close when done with this.
341  *
342  * Returns NULL if any error occurs.
343  */
344 notmuch_message_file_t *
345 notmuch_message_file_open (const char *filename);
346
347 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
348 notmuch_message_file_t *
349 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
350
351 /* Close a notmuch message previously opened with notmuch_message_open. */
352 void
353 notmuch_message_file_close (notmuch_message_file_t *message);
354
355 /* Restrict 'message' to only save the named headers.
356  *
357  * When the caller is only interested in a short list of headers,
358  * known in advance, calling this function can avoid wasted time and
359  * memory parsing/saving header values that will never be needed.
360  *
361  * The variable arguments should be a list of const char * with a
362  * final '(const char *) NULL' to terminate the list.
363  *
364  * If this function is called, it must be called before any calls to
365  * notmuch_message_get_header for this message.
366  *
367  * After calling this function, if notmuch_message_get_header is
368  * called with a header name not in this list, then NULL will be
369  * returned even if that header exists in the actual message.
370  */
371 void
372 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
373
374 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
375 void
376 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
377                                         va_list va_headers);
378
379 /* Get the value of the specified header from the message.
380  *
381  * The header name is case insensitive.
382  *
383  * The Received: header is special - for it all Received: headers in
384  * the message are concatenated
385  *
386  * The returned value is owned by the notmuch message and is valid
387  * only until the message is closed. The caller should copy it if
388  * needing to modify the value or to hold onto it for longer.
389  *
390  * Returns NULL if the message does not contain a header line matching
391  * 'header'.
392  */
393 const char *
394 notmuch_message_file_get_header (notmuch_message_file_t *message,
395                                  const char *header);
396
397 /* messages.c */
398
399 typedef struct _notmuch_message_node {
400     notmuch_message_t *message;
401     struct _notmuch_message_node *next;
402 } notmuch_message_node_t;
403
404 typedef struct _notmuch_message_list {
405     notmuch_message_node_t *head;
406     notmuch_message_node_t **tail;
407 } notmuch_message_list_t;
408
409 /* There's a rumor that there's an alternate struct _notmuch_messages
410  * somewhere with some nasty C++ objects in it. We'll try to maintain
411  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
412  */
413 struct visible _notmuch_messages {
414     notmuch_bool_t is_of_list_type;
415     notmuch_doc_id_set_t *excluded_doc_ids;
416     notmuch_message_node_t *iterator;
417 };
418
419 notmuch_message_list_t *
420 _notmuch_message_list_create (const void *ctx);
421
422 void
423 _notmuch_message_list_append (notmuch_message_list_t *list,
424                               notmuch_message_node_t *node);
425
426 void
427 _notmuch_message_list_add_message (notmuch_message_list_t *list,
428                                    notmuch_message_t *message);
429
430 notmuch_messages_t *
431 _notmuch_messages_create (notmuch_message_list_t *list);
432
433 /* query.cc */
434
435 notmuch_bool_t
436 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
437
438 notmuch_message_t *
439 _notmuch_mset_messages_get (notmuch_messages_t *messages);
440
441 void
442 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
443
444 notmuch_bool_t
445 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
446                               unsigned int doc_id);
447
448 void
449 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
450                             unsigned int doc_id);
451
452 /* message.cc */
453
454 void
455 _notmuch_message_add_reply (notmuch_message_t *message,
456                             notmuch_message_node_t *reply);
457
458 /* sha1.c */
459
460 char *
461 notmuch_sha1_of_string (const char *str);
462
463 char *
464 notmuch_sha1_of_file (const char *filename);
465
466 /* string-list.c */
467
468 typedef struct _notmuch_string_node {
469     char *string;
470     struct _notmuch_string_node *next;
471 } notmuch_string_node_t;
472
473 struct visible _notmuch_string_list {
474     int length;
475     notmuch_string_node_t *head;
476     notmuch_string_node_t **tail;
477 };
478
479 notmuch_string_list_t *
480 _notmuch_string_list_create (const void *ctx);
481
482 /* Add 'string' to 'list'.
483  *
484  * The list will create its own talloced copy of 'string'.
485  */
486 void
487 _notmuch_string_list_append (notmuch_string_list_t *list,
488                              const char *string);
489
490 void
491 _notmuch_string_list_sort (notmuch_string_list_t *list);
492
493 /* tags.c */
494
495 notmuch_tags_t *
496 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
497
498 /* filenames.c */
499
500 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
501  * file names */
502 notmuch_filenames_t *
503 _notmuch_filenames_create (const void *ctx,
504                            notmuch_string_list_t *list);
505
506 NOTMUCH_END_DECLS
507
508 #ifdef __cplusplus
509 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
510  * C++. In talloc_steal, an explicit cast is provided for type safety
511  * in some GCC versions. Otherwise, a cast is required. Provide a
512  * template function for this to maintain type safety, and redefine
513  * talloc_steal to use it.
514  */
515 #if !(__GNUC__ >= 3)
516 template <class T> T *
517 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
518 {
519     return static_cast<T *> (talloc_steal (new_ctx, ptr));
520 }
521 #undef talloc_steal
522 #define talloc_steal _notmuch_talloc_steal
523 #endif
524 #endif
525
526 #pragma GCC visibility pop
527
528 #endif