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