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