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