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