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