lib: Implement versioning in the database and provide upgrade function.
[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 #ifdef DEBUG
52 # define DEBUG_DATABASE_SANITY 1
53 # define DEBUG_QUERY 1
54 #endif
55
56 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
57
58 /* There's no point in continuing when we've detected that we've done
59  * something wrong internally (as opposed to the user passing in a
60  * bogus value).
61  *
62  * Note that PRINTF_ATTRIBUTE comes from talloc.h
63  */
64 int
65 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
66
67 /* There's no point in continuing when we've detected that we've done
68  * something wrong internally (as opposed to the user passing in a
69  * bogus value).
70  *
71  * Note that __location__ comes from talloc.h.
72  */
73 #define INTERNAL_ERROR(format, ...)                     \
74     _internal_error (format " (%s).\n",                 \
75                      ##__VA_ARGS__, __location__)
76
77 #define unused(x) x __attribute__ ((unused))
78
79 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
80  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
81  */
82 /* these macros gain us a few percent of speed on gcc */
83 #if (__GNUC__ >= 3)
84 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
85    as its first argument */
86 #ifndef likely
87 #define likely(x)   __builtin_expect(!!(x), 1)
88 #endif
89 #ifndef unlikely
90 #define unlikely(x) __builtin_expect(!!(x), 0)
91 #endif
92 #else
93 #ifndef likely
94 #define likely(x) (x)
95 #endif
96 #ifndef unlikely
97 #define unlikely(x) (x)
98 #endif
99 #endif
100
101 typedef enum {
102     NOTMUCH_VALUE_TIMESTAMP = 0,
103     NOTMUCH_VALUE_MESSAGE_ID
104 } notmuch_value_t;
105
106 /* Xapian (with flint backend) complains if we provide a term longer
107  * than this, but I haven't yet found a way to query the limit
108  * programmatically. */
109 #define NOTMUCH_TERM_MAX 245
110
111 typedef enum _notmuch_private_status {
112     /* First, copy all the public status values. */
113     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
114     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
115     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
116     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
117     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
118     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
119     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
120     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
121
122     /* Then add our own private values. */
123     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
124     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
125
126     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
127 } notmuch_private_status_t;
128
129 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
130  * value, generating an internal error if the private value is equal
131  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
132  * that the caller has previously handled any expected
133  * notmuch_private_status_t values.)
134  */
135 #define COERCE_STATUS(private_status, format, ...)                      \
136     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
137      ?                                                                  \
138      (notmuch_status_t) _internal_error (format " (%s).\n",             \
139                                          ##__VA_ARGS__,                 \
140                                          __location__)                  \
141      :                                                                  \
142      (notmuch_status_t) private_status)
143
144 /* database.cc */
145
146 /* Lookup a prefix value by name.
147  *
148  * XXX: This should really be static inside of message.cc, and we can
149  * do that once we convert database.cc to use the
150  * _notmuch_message_add/remove_term functions. */
151 const char *
152 _find_prefix (const char *name);
153
154 notmuch_status_t
155 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
156
157 const char *
158 _notmuch_database_relative_path (notmuch_database_t *notmuch,
159                                  const char *path);
160
161 notmuch_status_t
162 _notmuch_database_split_path (void *ctx,
163                               const char *path,
164                               const char **directory,
165                               const char **basename);
166
167 const char *
168 _notmuch_database_get_directory_db_path (const char *path);
169
170 notmuch_private_status_t
171 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
172                                       const char *prefix_name,
173                                       const char *value,
174                                       unsigned int *doc_id);
175
176 notmuch_status_t
177 _notmuch_database_find_directory_id (notmuch_database_t *database,
178                                      const char *path,
179                                      unsigned int *directory_id);
180
181 const char *
182 _notmuch_database_get_directory_path (void *ctx,
183                                       notmuch_database_t *notmuch,
184                                       unsigned int doc_id);
185
186 notmuch_status_t
187 _notmuch_database_filename_to_direntry (void *ctx,
188                                         notmuch_database_t *notmuch,
189                                         const char *filename,
190                                         char **direntry);
191
192 /* directory.cc */
193
194 notmuch_directory_t *
195 _notmuch_directory_create (notmuch_database_t *notmuch,
196                            const char *path,
197                            notmuch_status_t *status_ret);
198
199 unsigned int
200 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
201
202 /* thread.cc */
203
204 notmuch_thread_t *
205 _notmuch_thread_create (void *ctx,
206                         notmuch_database_t *notmuch,
207                         const char *thread_id,
208                         const char *query_string);
209
210 /* message.cc */
211
212 notmuch_message_t *
213 _notmuch_message_create (const void *talloc_owner,
214                          notmuch_database_t *notmuch,
215                          unsigned int doc_id,
216                          notmuch_private_status_t *status);
217
218 notmuch_message_t *
219 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
220                                         const char *message_id,
221                                         notmuch_private_status_t *status);
222
223 const char *
224 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
225
226 notmuch_private_status_t
227 _notmuch_message_add_term (notmuch_message_t *message,
228                            const char *prefix_name,
229                            const char *value);
230
231 notmuch_private_status_t
232 _notmuch_message_remove_term (notmuch_message_t *message,
233                               const char *prefix_name,
234                               const char *value);
235
236 notmuch_private_status_t
237 _notmuch_message_gen_terms (notmuch_message_t *message,
238                             const char *prefix_name,
239                             const char *text);
240
241 void
242 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
243
244 notmuch_status_t
245 _notmuch_message_add_filename (notmuch_message_t *message,
246                                const char *filename);
247
248 void
249 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
250
251 void
252 _notmuch_message_set_date (notmuch_message_t *message,
253                            const char *date);
254
255 void
256 _notmuch_message_sync (notmuch_message_t *message);
257
258 void
259 _notmuch_message_close (notmuch_message_t *message);
260
261 /* index.cc */
262
263 notmuch_status_t
264 _notmuch_message_index_file (notmuch_message_t *message,
265                              const char *filename);
266
267 /* message-file.c */
268
269 /* XXX: I haven't decided yet whether these will actually get exported
270  * into the public interface in notmuch.h
271  */
272
273 typedef struct _notmuch_message_file notmuch_message_file_t;
274
275 /* Open a file containing a single email message.
276  *
277  * The caller should call notmuch_message_close when done with this.
278  *
279  * Returns NULL if any error occurs.
280  */
281 notmuch_message_file_t *
282 notmuch_message_file_open (const char *filename);
283
284 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
285 notmuch_message_file_t *
286 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
287
288 /* Close a notmuch message previously opened with notmuch_message_open. */
289 void
290 notmuch_message_file_close (notmuch_message_file_t *message);
291
292 /* Restrict 'message' to only save the named headers.
293  *
294  * When the caller is only interested in a short list of headers,
295  * known in advance, calling this function can avoid wasted time and
296  * memory parsing/saving header values that will never be needed.
297  *
298  * The variable arguments should be a list of const char * with a
299  * final '(const char *) NULL' to terminate the list.
300  *
301  * If this function is called, it must be called before any calls to
302  * notmuch_message_get_header for this message.
303  *
304  * After calling this function, if notmuch_message_get_header is
305  * called with a header name not in this list, then NULL will be
306  * returned even if that header exists in the actual message.
307  */
308 void
309 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
310
311 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
312 void
313 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
314                                         va_list va_headers);
315
316 /* Get the value of the specified header from the message.
317  *
318  * The header name is case insensitive.
319  *
320  * The returned value is owned by the notmuch message and is valid
321  * only until the message is closed. The caller should copy it if
322  * needing to modify the value or to hold onto it for longer.
323  *
324  * Returns NULL if the message does not contain a header line matching
325  * 'header'.
326  */
327 const char *
328 notmuch_message_file_get_header (notmuch_message_file_t *message,
329                                  const char *header);
330
331 /* messages.c */
332
333 typedef struct _notmuch_message_node {
334     notmuch_message_t *message;
335     struct _notmuch_message_node *next;
336 } notmuch_message_node_t;
337
338 typedef struct _notmuch_message_list {
339     notmuch_message_node_t *head;
340     notmuch_message_node_t **tail;
341 } notmuch_message_list_t;
342
343 /* There's a rumor that there's an alternate struct _notmuch_messages
344  * somewhere with some nasty C++ objects in it. We'll try to maintain
345  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
346  */
347 struct _notmuch_messages {
348     notmuch_bool_t is_of_list_type;
349     notmuch_message_node_t *iterator;
350 };
351
352 notmuch_message_list_t *
353 _notmuch_message_list_create (const void *ctx);
354
355 void
356 _notmuch_message_list_append (notmuch_message_list_t *list,
357                               notmuch_message_node_t *node);
358
359 void
360 _notmuch_message_list_add_message (notmuch_message_list_t *list,
361                                    notmuch_message_t *message);
362
363 notmuch_messages_t *
364 _notmuch_messages_create (notmuch_message_list_t *list);
365
366 /* query.cc */
367
368 notmuch_bool_t
369 _notmuch_mset_messages_has_more (notmuch_messages_t *messages);
370
371 notmuch_message_t *
372 _notmuch_mset_messages_get (notmuch_messages_t *messages);
373
374 void
375 _notmuch_mset_messages_advance (notmuch_messages_t *messages);
376
377 /* message.cc */
378
379 void
380 _notmuch_message_add_reply (notmuch_message_t *message,
381                             notmuch_message_node_t *reply);
382
383 /* sha1.c */
384
385 char *
386 notmuch_sha1_of_string (const char *str);
387
388 char *
389 notmuch_sha1_of_file (const char *filename);
390
391 /* tags.c */
392
393 notmuch_tags_t *
394 _notmuch_tags_create (void *ctx);
395
396 void
397 _notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag);
398
399 void
400 _notmuch_tags_prepare_iterator (notmuch_tags_t *tags);
401
402 NOTMUCH_END_DECLS
403
404 #endif