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