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 #define COERCE_STATUS(private_status, format, ...)                      \
 141     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
 142      ?                                                                  \
 143      (notmuch_status_t) _internal_error (format " (%s).\n",             \
 144                                          ##__VA_ARGS__,                 \
 145                                          __location__)                  \
 146      :                                                                  \
 147      (notmuch_status_t) private_status)
 148
 149 /* Flags shared by various lookup functions. */
 150 typedef enum _notmuch_find_flags {
 151     /* If set, create the necessary document (or documents) if they
 152      * are missing.  Requires a read/write database. */
 153     NOTMUCH_FIND_CREATE = 1<<0,
 154 } notmuch_find_flags_t;
 155
 156 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
 157
 158 typedef struct _notmuch_string_list notmuch_string_list_t;
 159
 160 /* database.cc */
 161
 162 /* Lookup a prefix value by name.
 163  *
 164  * XXX: This should really be static inside of message.cc, and we can
 165  * do that once we convert database.cc to use the
 166  * _notmuch_message_add/remove_term functions. */
 167 const char *
 168 _find_prefix (const char *name);
 169
 170 notmuch_status_t
 171 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
 172
 173 const char *
 174 _notmuch_database_relative_path (notmuch_database_t *notmuch,
 175                                  const char *path);
 176
 177 notmuch_status_t
 178 _notmuch_database_split_path (void *ctx,
 179                               const char *path,
 180                               const char **directory,
 181                               const char **basename);
 182
 183 const char *
 184 _notmuch_database_get_directory_db_path (const char *path);
 185
 186 unsigned int
 187 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
 188
 189 notmuch_private_status_t
 190 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
 191                                       const char *prefix_name,
 192                                       const char *value,
 193                                       unsigned int *doc_id);
 194
 195 notmuch_status_t
 196 _notmuch_database_find_directory_id (notmuch_database_t *database,
 197                                      const char *path,
 198                                      notmuch_find_flags_t flags,
 199                                      unsigned int *directory_id);
 200
 201 const char *
 202 _notmuch_database_get_directory_path (void *ctx,
 203                                       notmuch_database_t *notmuch,
 204                                       unsigned int doc_id);
 205
 206 notmuch_status_t
 207 _notmuch_database_filename_to_direntry (void *ctx,
 208                                         notmuch_database_t *notmuch,
 209                                         const char *filename,
 210                                         notmuch_find_flags_t flags,
 211                                         char **direntry);
 212
 213 /* directory.cc */
 214
 215 notmuch_directory_t *
 216 _notmuch_directory_create (notmuch_database_t *notmuch,
 217                            const char *path,
 218                            notmuch_find_flags_t flags,
 219                            notmuch_status_t *status_ret);
 220
 221 unsigned int
 222 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
 223
 224 /* thread.cc */
 225
 226 notmuch_thread_t *
 227 _notmuch_thread_create (void *ctx,
 228                         notmuch_database_t *notmuch,
 229                         unsigned int seed_doc_id,
 230                         notmuch_doc_id_set_t *match_set,
 231                         notmuch_string_list_t *excluded_terms,
 232                         notmuch_sort_t sort);
 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 notmuch_status_t
 272 _notmuch_message_add_filename (notmuch_message_t *message,
 273                                const char *filename);
 274
 275 notmuch_status_t
 276 _notmuch_message_remove_filename (notmuch_message_t *message,
 277                                   const char *filename);
 278
 279 notmuch_status_t
 280 _notmuch_message_rename (notmuch_message_t *message,
 281                          const char *new_filename);
 282
 283 void
 284 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
 285
 286 void
 287 _notmuch_message_set_header_values (notmuch_message_t *message,
 288                                     const char *date,
 289                                     const char *from,
 290                                     const char *subject);
 291 void
 292 _notmuch_message_sync (notmuch_message_t *message);
 293
 294 notmuch_status_t
 295 _notmuch_message_delete (notmuch_message_t *message);
 296
 297 void
 298 _notmuch_message_close (notmuch_message_t *message);
 299
 300 /* Get a copy of the data in this message document.
 301  *
 302  * Caller should talloc_free the result when done.
 303  *
 304  * This function is intended to support database upgrade and really
 305  * shouldn't be used otherwise. */
 306 char *
 307 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
 308
 309 /* Clear the data in this message document.
 310  *
 311  * This function is intended to support database upgrade and really
 312  * shouldn't be used otherwise. */
 313 void
 314 _notmuch_message_clear_data (notmuch_message_t *message);
 315
 316 /* Set the author member of 'message' - this is the representation used
 317  * when displaying the message */
 318 void
 319 notmuch_message_set_author (notmuch_message_t *message, const char *author);
 320
 321 /* Get the author member of 'message' */
 322 const char *
 323 notmuch_message_get_author (notmuch_message_t *message);
 324
 325
 326 /* index.cc */
 327
 328 notmuch_status_t
 329 _notmuch_message_index_file (notmuch_message_t *message,
 330                              const char *filename);
 331
 332 /* message-file.c */
 333
 334 /* XXX: I haven't decided yet whether these will actually get exported
 335  * into the public interface in notmuch.h
 336  */
 337
 338 typedef struct _notmuch_message_file notmuch_message_file_t;
 339
 340 /* Open a file containing a single email message.
 341  *
 342  * The caller should call notmuch_message_close when done with this.
 343  *
 344  * Returns NULL if any error occurs.
 345  */
 346 notmuch_message_file_t *
 347 notmuch_message_file_open (const char *filename);
 348
 349 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
 350 notmuch_message_file_t *
 351 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
 352
 353 /* Close a notmuch message previously opened with notmuch_message_open. */
 354 void
 355 notmuch_message_file_close (notmuch_message_file_t *message);
 356
 357 /* Restrict 'message' to only save the named headers.
 358  *
 359  * When the caller is only interested in a short list of headers,
 360  * known in advance, calling this function can avoid wasted time and
 361  * memory parsing/saving header values that will never be needed.
 362  *
 363  * The variable arguments should be a list of const char * with a
 364  * final '(const char *) NULL' to terminate the list.
 365  *
 366  * If this function is called, it must be called before any calls to
 367  * notmuch_message_get_header for this message.
 368  *
 369  * After calling this function, if notmuch_message_get_header is
 370  * called with a header name not in this list, then NULL will be
 371  * returned even if that header exists in the actual message.
 372  */
 373 void
 374 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
 375
 376 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
 377 void
 378 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
 379                                         va_list va_headers);
 380
 381 /* Get the value of the specified header from the message.
 382  *
 383  * The header name is case insensitive.
 384  *
 385  * The Received: header is special - for it all Received: headers in
 386  * the message are concatenated
 387  *
 388  * The returned value is owned by the notmuch message and is valid
 389  * only until the message is closed. The caller should copy it if
 390  * needing to modify the value or to hold onto it for longer.
 391  *
 392  * Returns NULL if the message does not contain a header line matching
 393  * 'header'.
 394  */
 395 const char *
 396 notmuch_message_file_get_header (notmuch_message_file_t *message,
 397                                  const char *header);
 398
 399 /* messages.c */
 400
 401 typedef struct _notmuch_message_node {
 402     notmuch_message_t *message;
 403     struct _notmuch_message_node *next;
 404 } notmuch_message_node_t;
 405
 406 typedef struct _notmuch_message_list {
 407     notmuch_message_node_t *head;
 408     notmuch_message_node_t **tail;
 409 } notmuch_message_list_t;
 410
 411 /* There's a rumor that there's an alternate struct _notmuch_messages
 412  * somewhere with some nasty C++ objects in it. We'll try to maintain
 413  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
 414  */
 415 struct visible _notmuch_messages {
 416     notmuch_bool_t is_of_list_type;
 417     notmuch_doc_id_set_t *excluded_doc_ids;
 418     notmuch_message_node_t *iterator;
 419 };
 420
 421 notmuch_message_list_t *
 422 _notmuch_message_list_create (const void *ctx);
 423
 424 void
 425 _notmuch_message_list_append (notmuch_message_list_t *list,
 426                               notmuch_message_node_t *node);
 427
 428 void
 429 _notmuch_message_list_add_message (notmuch_message_list_t *list,
 430                                    notmuch_message_t *message);
 431
 432 notmuch_messages_t *
 433 _notmuch_messages_create (notmuch_message_list_t *list);
 434
 435 /* query.cc */
 436
 437 notmuch_bool_t
 438 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
 439
 440 notmuch_message_t *
 441 _notmuch_mset_messages_get (notmuch_messages_t *messages);
 442
 443 void
 444 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
 445
 446 notmuch_bool_t
 447 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
 448                               unsigned int doc_id);
 449
 450 void
 451 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
 452                             unsigned int doc_id);
 453
 454 /* message.cc */
 455
 456 void
 457 _notmuch_message_add_reply (notmuch_message_t *message,
 458                             notmuch_message_node_t *reply);
 459
 460 /* sha1.c */
 461
 462 char *
 463 notmuch_sha1_of_string (const char *str);
 464
 465 char *
 466 notmuch_sha1_of_file (const char *filename);
 467
 468 /* string-list.c */
 469
 470 typedef struct _notmuch_string_node {
 471     char *string;
 472     struct _notmuch_string_node *next;
 473 } notmuch_string_node_t;
 474
 475 struct visible _notmuch_string_list {
 476     int length;
 477     notmuch_string_node_t *head;
 478     notmuch_string_node_t **tail;
 479 };
 480
 481 notmuch_string_list_t *
 482 _notmuch_string_list_create (const void *ctx);
 483
 484 /* Add 'string' to 'list'.
 485  *
 486  * The list will create its own talloced copy of 'string'.
 487  */
 488 void
 489 _notmuch_string_list_append (notmuch_string_list_t *list,
 490                              const char *string);
 491
 492 void
 493 _notmuch_string_list_sort (notmuch_string_list_t *list);
 494
 495 /* tags.c */
 496
 497 notmuch_tags_t *
 498 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
 499
 500 /* filenames.c */
 501
 502 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
 503  * file names */
 504 notmuch_filenames_t *
 505 _notmuch_filenames_create (const void *ctx,
 506                            notmuch_string_list_t *list);
 507
 508 NOTMUCH_END_DECLS
 509
 510 #ifdef __cplusplus
 511 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
 512  * C++. In talloc_steal, an explicit cast is provided for type safety
 513  * in some GCC versions. Otherwise, a cast is required. Provide a
 514  * template function for this to maintain type safety, and redefine
 515  * talloc_steal to use it.
 516  */
 517 #if !(__GNUC__ >= 3)
 518 template <class T> T *
 519 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
 520 {
 521     return static_cast<T *> (talloc_steal (new_ctx, ptr));
 522 }
 523 #undef talloc_steal
 524 #define talloc_steal _notmuch_talloc_steal
 525 #endif
 526 #endif
 527
 528 #pragma GCC visibility pop
 529
 530 #endif