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 && ((unsigned long) 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 void
 194 _notmuch_database_log (notmuch_database_t *notmuch,
 195                        const char *format, ...);
 196
 197 const char *
 198 _notmuch_database_relative_path (notmuch_database_t *notmuch,
 199                                  const char *path);
 200
 201 notmuch_status_t
 202 _notmuch_database_split_path (void *ctx,
 203                               const char *path,
 204                               const char **directory,
 205                               const char **basename);
 206
 207 const char *
 208 _notmuch_database_get_directory_db_path (const char *path);
 209
 210 unsigned int
 211 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
 212
 213 notmuch_private_status_t
 214 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
 215                                       const char *prefix_name,
 216                                       const char *value,
 217                                       unsigned int *doc_id);
 218
 219 notmuch_status_t
 220 _notmuch_database_find_directory_id (notmuch_database_t *database,
 221                                      const char *path,
 222                                      notmuch_find_flags_t flags,
 223                                      unsigned int *directory_id);
 224
 225 const char *
 226 _notmuch_database_get_directory_path (void *ctx,
 227                                       notmuch_database_t *notmuch,
 228                                       unsigned int doc_id);
 229
 230 notmuch_status_t
 231 _notmuch_database_filename_to_direntry (void *ctx,
 232                                         notmuch_database_t *notmuch,
 233                                         const char *filename,
 234                                         notmuch_find_flags_t flags,
 235                                         char **direntry);
 236
 237 /* directory.cc */
 238
 239 notmuch_directory_t *
 240 _notmuch_directory_create (notmuch_database_t *notmuch,
 241                            const char *path,
 242                            notmuch_find_flags_t flags,
 243                            notmuch_status_t *status_ret);
 244
 245 unsigned int
 246 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
 247
 248 /* message.cc */
 249
 250 notmuch_message_t *
 251 _notmuch_message_create (const void *talloc_owner,
 252                          notmuch_database_t *notmuch,
 253                          unsigned int doc_id,
 254                          notmuch_private_status_t *status);
 255
 256 notmuch_message_t *
 257 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 258                                         const char *message_id,
 259                                         notmuch_private_status_t *status);
 260
 261 unsigned int
 262 _notmuch_message_get_doc_id (notmuch_message_t *message);
 263
 264 const char *
 265 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
 266
 267 notmuch_private_status_t
 268 _notmuch_message_add_term (notmuch_message_t *message,
 269                            const char *prefix_name,
 270                            const char *value);
 271
 272 notmuch_private_status_t
 273 _notmuch_message_remove_term (notmuch_message_t *message,
 274                               const char *prefix_name,
 275                               const char *value);
 276
 277 notmuch_private_status_t
 278 _notmuch_message_gen_terms (notmuch_message_t *message,
 279                             const char *prefix_name,
 280                             const char *text);
 281
 282 void
 283 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
 284
 285 void
 286 _notmuch_message_upgrade_folder (notmuch_message_t *message);
 287
 288 notmuch_status_t
 289 _notmuch_message_add_filename (notmuch_message_t *message,
 290                                const char *filename);
 291
 292 notmuch_status_t
 293 _notmuch_message_remove_filename (notmuch_message_t *message,
 294                                   const char *filename);
 295
 296 notmuch_status_t
 297 _notmuch_message_rename (notmuch_message_t *message,
 298                          const char *new_filename);
 299
 300 void
 301 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
 302
 303 void
 304 _notmuch_message_set_header_values (notmuch_message_t *message,
 305                                     const char *date,
 306                                     const char *from,
 307                                     const char *subject);
 308 void
 309 _notmuch_message_sync (notmuch_message_t *message);
 310
 311 notmuch_status_t
 312 _notmuch_message_delete (notmuch_message_t *message);
 313
 314 notmuch_private_status_t
 315 _notmuch_message_initialize_ghost (notmuch_message_t *message,
 316                                    const char *thread_id);
 317
 318 void
 319 _notmuch_message_close (notmuch_message_t *message);
 320
 321 /* Get a copy of the data in this message document.
 322  *
 323  * Caller should talloc_free the result when done.
 324  *
 325  * This function is intended to support database upgrade and really
 326  * shouldn't be used otherwise. */
 327 char *
 328 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
 329
 330 /* Clear the data in this message document.
 331  *
 332  * This function is intended to support database upgrade and really
 333  * shouldn't be used otherwise. */
 334 void
 335 _notmuch_message_clear_data (notmuch_message_t *message);
 336
 337 /* Set the author member of 'message' - this is the representation used
 338  * when displaying the message */
 339 void
 340 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
 341
 342 /* Get the author member of 'message' */
 343 const char *
 344 _notmuch_message_get_author (notmuch_message_t *message);
 345
 346 /* message-file.c */
 347
 348 /* XXX: I haven't decided yet whether these will actually get exported
 349  * into the public interface in notmuch.h
 350  */
 351
 352 typedef struct _notmuch_message_file notmuch_message_file_t;
 353
 354 /* Open a file containing a single email message.
 355  *
 356  * The caller should call notmuch_message_close when done with this.
 357  *
 358  * Returns NULL if any error occurs.
 359  */
 360 notmuch_message_file_t *
 361 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
 362
 363 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
 364 notmuch_message_file_t *
 365 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
 366                                 void *ctx, const char *filename);
 367
 368 /* Close a notmuch message previously opened with notmuch_message_open. */
 369 void
 370 _notmuch_message_file_close (notmuch_message_file_t *message);
 371
 372 /* Parse the message.
 373  *
 374  * This will be done automatically as necessary on other calls
 375  * depending on it, but an explicit call allows for better error
 376  * status reporting.
 377  */
 378 notmuch_status_t
 379 _notmuch_message_file_parse (notmuch_message_file_t *message);
 380
 381 /* Get the gmime message of a message file.
 382  *
 383  * The message file is parsed as necessary.
 384  *
 385  * The GMimeMessage* is set to *mime_message on success (which the
 386  * caller must not unref).
 387  *
 388  * XXX: Would be nice to not have to expose GMimeMessage here.
 389  */
 390 notmuch_status_t
 391 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
 392                                         GMimeMessage **mime_message);
 393
 394 /* Get the value of the specified header from the message as a UTF-8 string.
 395  *
 396  * The message file is parsed as necessary.
 397  *
 398  * The header name is case insensitive.
 399  *
 400  * The Received: header is special - for it all Received: headers in
 401  * the message are concatenated
 402  *
 403  * The returned value is owned by the notmuch message and is valid
 404  * only until the message is closed. The caller should copy it if
 405  * needing to modify the value or to hold onto it for longer.
 406  *
 407  * Returns NULL on errors, empty string if the message does not
 408  * contain a header line matching 'header'.
 409  */
 410 const char *
 411 _notmuch_message_file_get_header (notmuch_message_file_t *message,
 412                                  const char *header);
 413
 414 /* index.cc */
 415
 416 notmuch_status_t
 417 _notmuch_message_index_file (notmuch_message_t *message,
 418                              notmuch_message_file_t *message_file);
 419
 420 /* messages.c */
 421
 422 typedef struct _notmuch_message_node {
 423     notmuch_message_t *message;
 424     struct _notmuch_message_node *next;
 425 } notmuch_message_node_t;
 426
 427 typedef struct _notmuch_message_list {
 428     notmuch_message_node_t *head;
 429     notmuch_message_node_t **tail;
 430 } notmuch_message_list_t;
 431
 432 /* There's a rumor that there's an alternate struct _notmuch_messages
 433  * somewhere with some nasty C++ objects in it. We'll try to maintain
 434  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
 435  */
 436 struct visible _notmuch_messages {
 437     notmuch_bool_t is_of_list_type;
 438     notmuch_doc_id_set_t *excluded_doc_ids;
 439     notmuch_message_node_t *iterator;
 440 };
 441
 442 notmuch_message_list_t *
 443 _notmuch_message_list_create (const void *ctx);
 444
 445 void
 446 _notmuch_message_list_add_message (notmuch_message_list_t *list,
 447                                    notmuch_message_t *message);
 448
 449 notmuch_messages_t *
 450 _notmuch_messages_create (notmuch_message_list_t *list);
 451
 452 /* query.cc */
 453
 454 notmuch_bool_t
 455 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
 456
 457 notmuch_message_t *
 458 _notmuch_mset_messages_get (notmuch_messages_t *messages);
 459
 460 void
 461 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
 462
 463 notmuch_bool_t
 464 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
 465                               unsigned int doc_id);
 466
 467 void
 468 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
 469                             unsigned int doc_id);
 470
 471 /* message.cc */
 472
 473 void
 474 _notmuch_message_add_reply (notmuch_message_t *message,
 475                             notmuch_message_t *reply);
 476 notmuch_database_t *
 477 _notmuch_message_database (notmuch_message_t *message);
 478
 479 /* sha1.c */
 480
 481 char *
 482 _notmuch_sha1_of_string (const char *str);
 483
 484 char *
 485 _notmuch_sha1_of_file (const char *filename);
 486
 487 /* string-list.c */
 488
 489 typedef struct _notmuch_string_node {
 490     char *string;
 491     struct _notmuch_string_node *next;
 492 } notmuch_string_node_t;
 493
 494 typedef struct visible _notmuch_string_list {
 495     int length;
 496     notmuch_string_node_t *head;
 497     notmuch_string_node_t **tail;
 498 } notmuch_string_list_t;
 499
 500 notmuch_string_list_t *
 501 _notmuch_string_list_create (const void *ctx);
 502
 503 /* Add 'string' to 'list'.
 504  *
 505  * The list will create its own talloced copy of 'string'.
 506  */
 507 void
 508 _notmuch_string_list_append (notmuch_string_list_t *list,
 509                              const char *string);
 510
 511 void
 512 _notmuch_string_list_sort (notmuch_string_list_t *list);
 513
 514 /* tags.c */
 515
 516 notmuch_tags_t *
 517 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
 518
 519 /* filenames.c */
 520
 521 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
 522  * file names */
 523 notmuch_filenames_t *
 524 _notmuch_filenames_create (const void *ctx,
 525                            notmuch_string_list_t *list);
 526
 527 /* thread.cc */
 528
 529 notmuch_thread_t *
 530 _notmuch_thread_create (void *ctx,
 531                         notmuch_database_t *notmuch,
 532                         unsigned int seed_doc_id,
 533                         notmuch_doc_id_set_t *match_set,
 534                         notmuch_string_list_t *excluded_terms,
 535                         notmuch_exclude_t omit_exclude,
 536                         notmuch_sort_t sort);
 537
 538 NOTMUCH_END_DECLS
 539
 540 #ifdef __cplusplus
 541 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
 542  * C++. In talloc_steal, an explicit cast is provided for type safety
 543  * in some GCC versions. Otherwise, a cast is required. Provide a
 544  * template function for this to maintain type safety, and redefine
 545  * talloc_steal to use it.
 546  */
 547 #if !(__GNUC__ >= 3)
 548 template <class T> T *
 549 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
 550 {
 551     return static_cast<T *> (talloc_steal (new_ctx, ptr));
 552 }
 553 #undef talloc_steal
 554 #define talloc_steal _notmuch_talloc_steal
 555 #endif
 556 #endif
 557
 558 #pragma GCC visibility pop
 559
 560 #endif