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