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