]> git.notmuchmail.org Git - notmuch/blob - lib/notmuch-private.h
lib: Add an API to find a message by filename.
[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
51 #pragma GCC visibility push(hidden)
52
53 #ifdef DEBUG
54 # define DEBUG_DATABASE_SANITY 1
55 # define DEBUG_QUERY 1
56 #endif
57
58 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
59
60 #define STRNCMP_LITERAL(var, literal) \
61     strncmp ((var), (literal), sizeof (literal) - 1)
62
63 /* There's no point in continuing when we've detected that we've done
64  * something wrong internally (as opposed to the user passing in a
65  * bogus value).
66  *
67  * Note that PRINTF_ATTRIBUTE comes from talloc.h
68  */
69 int
70 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
71
72 /* There's no point in continuing when we've detected that we've done
73  * something wrong internally (as opposed to the user passing in a
74  * bogus value).
75  *
76  * Note that __location__ comes from talloc.h.
77  */
78 #define INTERNAL_ERROR(format, ...)                     \
79     _internal_error (format " (%s).\n",                 \
80                      ##__VA_ARGS__, __location__)
81
82 #define unused(x) x __attribute__ ((unused))
83
84 #ifdef __cplusplus
85 # define visible __attribute__((visibility("default")))
86 #else
87 # define visible
88 #endif
89
90 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
91  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
92  */
93 /* these macros gain us a few percent of speed on gcc */
94 #if (__GNUC__ >= 3)
95 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
96    as its first argument */
97 #ifndef likely
98 #define likely(x)   __builtin_expect(!!(x), 1)
99 #endif
100 #ifndef unlikely
101 #define unlikely(x) __builtin_expect(!!(x), 0)
102 #endif
103 #else
104 #ifndef likely
105 #define likely(x) (x)
106 #endif
107 #ifndef unlikely
108 #define unlikely(x) (x)
109 #endif
110 #endif
111
112 typedef enum {
113     NOTMUCH_VALUE_TIMESTAMP = 0,
114     NOTMUCH_VALUE_MESSAGE_ID
115 } notmuch_value_t;
116
117 /* Xapian (with flint backend) complains if we provide a term longer
118  * than this, but I haven't yet found a way to query the limit
119  * programmatically. */
120 #define NOTMUCH_TERM_MAX 245
121
122 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
123
124 /* For message IDs we have to be even more restrictive. Beyond fitting
125  * into the term limit, we also use message IDs to construct
126  * metadata-key values. And the documentation says that these should
127  * be restricted to about 200 characters. (The actual limit for the
128  * chert backend at least is 252.)
129  */
130 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
131
132 typedef enum _notmuch_private_status {
133     /* First, copy all the public status values. */
134     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
135     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
136     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
137     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
139     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
140     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
141     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
142
143     /* Then add our own private values. */
144     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
145     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
146
147     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
148 } notmuch_private_status_t;
149
150 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
151  * value, generating an internal error if the private value is equal
152  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
153  * that the caller has previously handled any expected
154  * notmuch_private_status_t values.)
155  */
156 #define COERCE_STATUS(private_status, format, ...)                      \
157     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
158      ?                                                                  \
159      (notmuch_status_t) _internal_error (format " (%s).\n",             \
160                                          ##__VA_ARGS__,                 \
161                                          __location__)                  \
162      :                                                                  \
163      (notmuch_status_t) private_status)
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                                      unsigned int *directory_id);
206
207 const char *
208 _notmuch_database_get_directory_path (void *ctx,
209                                       notmuch_database_t *notmuch,
210                                       unsigned int doc_id);
211
212 notmuch_status_t
213 _notmuch_database_filename_to_direntry (void *ctx,
214                                         notmuch_database_t *notmuch,
215                                         const char *filename,
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_status_t *status_ret);
224
225 unsigned int
226 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
227
228 /* thread.cc */
229
230 notmuch_thread_t *
231 _notmuch_thread_create (void *ctx,
232                         notmuch_database_t *notmuch,
233                         unsigned int seed_doc_id,
234                         notmuch_doc_id_set_t *match_set,
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_date (notmuch_message_t *message,
291                            const char *date);
292
293 void
294 _notmuch_message_sync (notmuch_message_t *message);
295
296 notmuch_status_t
297 _notmuch_message_delete (notmuch_message_t *message);
298
299 void
300 _notmuch_message_close (notmuch_message_t *message);
301
302 /* Get a copy of the data in this message document.
303  *
304  * Caller should talloc_free the result when done.
305  *
306  * This function is intended to support database upgrade and really
307  * shouldn't be used otherwise. */
308 char *
309 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
310
311 /* Clear the data in this message document.
312  *
313  * This function is intended to support database upgrade and really
314  * shouldn't be used otherwise. */
315 void
316 _notmuch_message_clear_data (notmuch_message_t *message);
317
318 /* Set the author member of 'message' - this is the representation used
319  * when displaying the message */
320 void
321 notmuch_message_set_author (notmuch_message_t *message, const char *author);
322
323 /* Get the author member of 'message' */
324 const char *
325 notmuch_message_get_author (notmuch_message_t *message);
326
327
328 /* index.cc */
329
330 notmuch_status_t
331 _notmuch_message_index_file (notmuch_message_t *message,
332                              const char *filename);
333
334 /* message-file.c */
335
336 /* XXX: I haven't decided yet whether these will actually get exported
337  * into the public interface in notmuch.h
338  */
339
340 typedef struct _notmuch_message_file notmuch_message_file_t;
341
342 /* Open a file containing a single email message.
343  *
344  * The caller should call notmuch_message_close when done with this.
345  *
346  * Returns NULL if any error occurs.
347  */
348 notmuch_message_file_t *
349 notmuch_message_file_open (const char *filename);
350
351 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
352 notmuch_message_file_t *
353 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
354
355 /* Close a notmuch message previously opened with notmuch_message_open. */
356 void
357 notmuch_message_file_close (notmuch_message_file_t *message);
358
359 /* Restrict 'message' to only save the named headers.
360  *
361  * When the caller is only interested in a short list of headers,
362  * known in advance, calling this function can avoid wasted time and
363  * memory parsing/saving header values that will never be needed.
364  *
365  * The variable arguments should be a list of const char * with a
366  * final '(const char *) NULL' to terminate the list.
367  *
368  * If this function is called, it must be called before any calls to
369  * notmuch_message_get_header for this message.
370  *
371  * After calling this function, if notmuch_message_get_header is
372  * called with a header name not in this list, then NULL will be
373  * returned even if that header exists in the actual message.
374  */
375 void
376 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
377
378 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
379 void
380 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
381                                         va_list va_headers);
382
383 /* Get the value of the specified header from the message.
384  *
385  * The header name is case insensitive.
386  *
387  * The Received: header is special - for it all Received: headers in
388  * the message are concatenated
389  *
390  * The returned value is owned by the notmuch message and is valid
391  * only until the message is closed. The caller should copy it if
392  * needing to modify the value or to hold onto it for longer.
393  *
394  * Returns NULL if the message does not contain a header line matching
395  * 'header'.
396  */
397 const char *
398 notmuch_message_file_get_header (notmuch_message_file_t *message,
399                                  const char *header);
400
401 /* messages.c */
402
403 typedef struct _notmuch_message_node {
404     notmuch_message_t *message;
405     struct _notmuch_message_node *next;
406 } notmuch_message_node_t;
407
408 typedef struct _notmuch_message_list {
409     notmuch_message_node_t *head;
410     notmuch_message_node_t **tail;
411 } notmuch_message_list_t;
412
413 /* There's a rumor that there's an alternate struct _notmuch_messages
414  * somewhere with some nasty C++ objects in it. We'll try to maintain
415  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
416  */
417 struct visible _notmuch_messages {
418     notmuch_bool_t is_of_list_type;
419     notmuch_message_node_t *iterator;
420 };
421
422 notmuch_message_list_t *
423 _notmuch_message_list_create (const void *ctx);
424
425 void
426 _notmuch_message_list_append (notmuch_message_list_t *list,
427                               notmuch_message_node_t *node);
428
429 void
430 _notmuch_message_list_add_message (notmuch_message_list_t *list,
431                                    notmuch_message_t *message);
432
433 notmuch_messages_t *
434 _notmuch_messages_create (notmuch_message_list_t *list);
435
436 /* query.cc */
437
438 notmuch_bool_t
439 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
440
441 notmuch_message_t *
442 _notmuch_mset_messages_get (notmuch_messages_t *messages);
443
444 void
445 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
446
447 notmuch_bool_t
448 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
449                               unsigned int doc_id);
450
451 void
452 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
453                             unsigned int doc_id);
454
455 /* message.cc */
456
457 void
458 _notmuch_message_add_reply (notmuch_message_t *message,
459                             notmuch_message_node_t *reply);
460
461 /* sha1.c */
462
463 char *
464 notmuch_sha1_of_string (const char *str);
465
466 char *
467 notmuch_sha1_of_file (const char *filename);
468
469 /* string-list.c */
470
471 typedef struct _notmuch_string_node {
472     char *string;
473     struct _notmuch_string_node *next;
474 } notmuch_string_node_t;
475
476 typedef struct _notmuch_string_list {
477     int length;
478     notmuch_string_node_t *head;
479     notmuch_string_node_t **tail;
480 } notmuch_string_list_t;
481
482 notmuch_string_list_t *
483 _notmuch_string_list_create (const void *ctx);
484
485 /* Add 'string' to 'list'.
486  *
487  * The list will create its own talloced copy of 'string'.
488  */
489 void
490 _notmuch_string_list_append (notmuch_string_list_t *list,
491                              const char *string);
492
493 void
494 _notmuch_string_list_sort (notmuch_string_list_t *list);
495
496 /* tags.c */
497
498 notmuch_tags_t *
499 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
500
501 /* filenames.c */
502
503 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
504  * file names */
505 notmuch_filenames_t *
506 _notmuch_filenames_create (const void *ctx,
507                            notmuch_string_list_t *list);
508
509 #pragma GCC visibility pop
510
511 NOTMUCH_END_DECLS
512
513 #endif