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