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
  51 #pragma GCC visibility push(hidden)
  52
  53 #ifdef DEBUG
  54 # define DEBUG_DATABASE_SANITY 1
  55 # define DEBUG_QUERY 1
  56 #endif
  57
  58 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
  59
  60 #define STRNCMP_LITERAL(var, literal) \
  61     strncmp ((var), (literal), sizeof (literal) - 1)
  62
  63 /* There's no point in continuing when we've detected that we've done
  64  * something wrong internally (as opposed to the user passing in a
  65  * bogus value).
  66  *
  67  * Note that PRINTF_ATTRIBUTE comes from talloc.h
  68  */
  69 int
  70 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
  71
  72 /* There's no point in continuing when we've detected that we've done
  73  * something wrong internally (as opposed to the user passing in a
  74  * bogus value).
  75  *
  76  * Note that __location__ comes from talloc.h.
  77  */
  78 #define INTERNAL_ERROR(format, ...)                     \
  79     _internal_error (format " (%s).\n",                 \
  80                      ##__VA_ARGS__, __location__)
  81
  82 #define unused(x) x __attribute__ ((unused))
  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_t;
 110
 111 /* Xapian (with flint backend) complains if we provide a term longer
 112  * than this, but I haven't yet found a way to query the limit
 113  * programmatically. */
 114 #define NOTMUCH_TERM_MAX 245
 115
 116 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
 117
 118 /* For message IDs we have to be even more restrictive. Beyond fitting
 119  * into the term limit, we also use message IDs to construct
 120  * metadata-key values. And the documentation says that these should
 121  * be restricted to about 200 characters. (The actual limit for the
 122  * chert backend at least is 252.)
 123  */
 124 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
 125
 126 typedef enum _notmuch_private_status {
 127     /* First, copy all the public status values. */
 128     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
 129     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
 130     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
 131     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
 132     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
 133     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
 134     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
 135     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
 136
 137     /* Then add our own private values. */
 138     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
 139     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
 140
 141     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
 142 } notmuch_private_status_t;
 143
 144 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
 145  * value, generating an internal error if the private value is equal
 146  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
 147  * that the caller has previously handled any expected
 148  * notmuch_private_status_t values.)
 149  */
 150 #define COERCE_STATUS(private_status, format, ...)                      \
 151     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
 152      ?                                                                  \
 153      (notmuch_status_t) _internal_error (format " (%s).\n",             \
 154                                          ##__VA_ARGS__,                 \
 155                                          __location__)                  \
 156      :                                                                  \
 157      (notmuch_status_t) private_status)
 158
 159 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
 160
 161 /* database.cc */
 162
 163 /* Lookup a prefix value by name.
 164  *
 165  * XXX: This should really be static inside of message.cc, and we can
 166  * do that once we convert database.cc to use the
 167  * _notmuch_message_add/remove_term functions. */
 168 const char *
 169 _find_prefix (const char *name);
 170
 171 notmuch_status_t
 172 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
 173
 174 const char *
 175 _notmuch_database_relative_path (notmuch_database_t *notmuch,
 176                                  const char *path);
 177
 178 notmuch_status_t
 179 _notmuch_database_split_path (void *ctx,
 180                               const char *path,
 181                               const char **directory,
 182                               const char **basename);
 183
 184 const char *
 185 _notmuch_database_get_directory_db_path (const char *path);
 186
 187 unsigned int
 188 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
 189
 190 notmuch_private_status_t
 191 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
 192                                       const char *prefix_name,
 193                                       const char *value,
 194                                       unsigned int *doc_id);
 195
 196 notmuch_status_t
 197 _notmuch_database_find_directory_id (notmuch_database_t *database,
 198                                      const char *path,
 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                                         char **direntry);
 211
 212 /* directory.cc */
 213
 214 notmuch_directory_t *
 215 _notmuch_directory_create (notmuch_database_t *notmuch,
 216                            const char *path,
 217                            notmuch_status_t *status_ret);
 218
 219 unsigned int
 220 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
 221
 222 /* thread.cc */
 223
 224 notmuch_thread_t *
 225 _notmuch_thread_create (void *ctx,
 226                         notmuch_database_t *notmuch,
 227                         unsigned int seed_doc_id,
 228                         notmuch_doc_id_set_t *match_set,
 229                         notmuch_sort_t sort);
 230
 231 /* message.cc */
 232
 233 notmuch_message_t *
 234 _notmuch_message_create (const void *talloc_owner,
 235                          notmuch_database_t *notmuch,
 236                          unsigned int doc_id,
 237                          notmuch_private_status_t *status);
 238
 239 notmuch_message_t *
 240 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 241                                         const char *message_id,
 242                                         notmuch_private_status_t *status);
 243
 244 unsigned int
 245 _notmuch_message_get_doc_id (notmuch_message_t *message);
 246
 247 const char *
 248 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
 249
 250 notmuch_private_status_t
 251 _notmuch_message_add_term (notmuch_message_t *message,
 252                            const char *prefix_name,
 253                            const char *value);
 254
 255 notmuch_private_status_t
 256 _notmuch_message_remove_term (notmuch_message_t *message,
 257                               const char *prefix_name,
 258                               const char *value);
 259
 260 notmuch_private_status_t
 261 _notmuch_message_gen_terms (notmuch_message_t *message,
 262                             const char *prefix_name,
 263                             const char *text);
 264
 265 void
 266 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
 267
 268 notmuch_status_t
 269 _notmuch_message_add_filename (notmuch_message_t *message,
 270                                const char *filename);
 271
 272 notmuch_status_t
 273 _notmuch_message_rename (notmuch_message_t *message,
 274                          const char *new_filename);
 275
 276 void
 277 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
 278
 279 void
 280 _notmuch_message_set_date (notmuch_message_t *message,
 281                            const char *date);
 282
 283 void
 284 _notmuch_message_sync (notmuch_message_t *message);
 285
 286 void
 287 _notmuch_message_close (notmuch_message_t *message);
 288
 289 /* Get a copy of the data in this message document.
 290  *
 291  * Caller should talloc_free the result when done.
 292  *
 293  * This function is intended to support database upgrade and really
 294  * shouldn't be used otherwise. */
 295 char *
 296 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
 297
 298 /* Clear the data in this message document.
 299  *
 300  * This function is intended to support database upgrade and really
 301  * shouldn't be used otherwise. */
 302 void
 303 _notmuch_message_clear_data (notmuch_message_t *message);
 304
 305 /* Set the author member of 'message' - this is the representation used
 306  * when displaying the message */
 307 void
 308 notmuch_message_set_author (notmuch_message_t *message, const char *author);
 309
 310 /* Get the author member of 'message' */
 311 const char *
 312 notmuch_message_get_author (notmuch_message_t *message);
 313
 314
 315 /* index.cc */
 316
 317 notmuch_status_t
 318 _notmuch_message_index_file (notmuch_message_t *message,
 319                              const char *filename);
 320
 321 /* message-file.c */
 322
 323 /* XXX: I haven't decided yet whether these will actually get exported
 324  * into the public interface in notmuch.h
 325  */
 326
 327 typedef struct _notmuch_message_file notmuch_message_file_t;
 328
 329 /* Open a file containing a single email message.
 330  *
 331  * The caller should call notmuch_message_close when done with this.
 332  *
 333  * Returns NULL if any error occurs.
 334  */
 335 notmuch_message_file_t *
 336 notmuch_message_file_open (const char *filename);
 337
 338 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
 339 notmuch_message_file_t *
 340 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
 341
 342 /* Close a notmuch message previously opened with notmuch_message_open. */
 343 void
 344 notmuch_message_file_close (notmuch_message_file_t *message);
 345
 346 /* Restrict 'message' to only save the named headers.
 347  *
 348  * When the caller is only interested in a short list of headers,
 349  * known in advance, calling this function can avoid wasted time and
 350  * memory parsing/saving header values that will never be needed.
 351  *
 352  * The variable arguments should be a list of const char * with a
 353  * final '(const char *) NULL' to terminate the list.
 354  *
 355  * If this function is called, it must be called before any calls to
 356  * notmuch_message_get_header for this message.
 357  *
 358  * After calling this function, if notmuch_message_get_header is
 359  * called with a header name not in this list, then NULL will be
 360  * returned even if that header exists in the actual message.
 361  */
 362 void
 363 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
 364
 365 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
 366 void
 367 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
 368                                         va_list va_headers);
 369
 370 /* Get the value of the specified header from the message.
 371  *
 372  * The header name is case insensitive.
 373  *
 374  * The Received: header is special - for it all Received: headers in
 375  * the message are concatenated
 376  *
 377  * The returned value is owned by the notmuch message and is valid
 378  * only until the message is closed. The caller should copy it if
 379  * needing to modify the value or to hold onto it for longer.
 380  *
 381  * Returns NULL if the message does not contain a header line matching
 382  * 'header'.
 383  */
 384 const char *
 385 notmuch_message_file_get_header (notmuch_message_file_t *message,
 386                                  const char *header);
 387
 388 /* messages.c */
 389
 390 typedef struct _notmuch_message_node {
 391     notmuch_message_t *message;
 392     struct _notmuch_message_node *next;
 393 } notmuch_message_node_t;
 394
 395 typedef struct _notmuch_message_list {
 396     notmuch_message_node_t *head;
 397     notmuch_message_node_t **tail;
 398 } notmuch_message_list_t;
 399
 400 /* There's a rumor that there's an alternate struct _notmuch_messages
 401  * somewhere with some nasty C++ objects in it. We'll try to maintain
 402  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
 403  */
 404 struct _notmuch_messages {
 405     notmuch_bool_t is_of_list_type;
 406     notmuch_message_node_t *iterator;
 407 };
 408
 409 notmuch_message_list_t *
 410 _notmuch_message_list_create (const void *ctx);
 411
 412 void
 413 _notmuch_message_list_append (notmuch_message_list_t *list,
 414                               notmuch_message_node_t *node);
 415
 416 void
 417 _notmuch_message_list_add_message (notmuch_message_list_t *list,
 418                                    notmuch_message_t *message);
 419
 420 notmuch_messages_t *
 421 _notmuch_messages_create (notmuch_message_list_t *list);
 422
 423 /* query.cc */
 424
 425 notmuch_bool_t
 426 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
 427
 428 notmuch_message_t *
 429 _notmuch_mset_messages_get (notmuch_messages_t *messages);
 430
 431 void
 432 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
 433
 434 notmuch_bool_t
 435 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
 436                               unsigned int doc_id);
 437
 438 void
 439 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
 440                             unsigned int doc_id);
 441
 442 /* message.cc */
 443
 444 void
 445 _notmuch_message_add_reply (notmuch_message_t *message,
 446                             notmuch_message_node_t *reply);
 447
 448 /* sha1.c */
 449
 450 char *
 451 notmuch_sha1_of_string (const char *str);
 452
 453 char *
 454 notmuch_sha1_of_file (const char *filename);
 455
 456 /* tags.c */
 457
 458 notmuch_tags_t *
 459 _notmuch_tags_create (void *ctx);
 460
 461 void
 462 _notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag);
 463
 464 void
 465 _notmuch_tags_prepare_iterator (notmuch_tags_t *tags);
 466
 467 /* filenames.c */
 468
 469 typedef struct _notmuch_filename_node {
 470     char *filename;
 471     struct _notmuch_filename_node *next;
 472 } notmuch_filename_node_t;
 473
 474 typedef struct _notmuch_filename_list {
 475     notmuch_filename_node_t *head;
 476     notmuch_filename_node_t **tail;
 477 } notmuch_filename_list_t;
 478
 479 notmuch_filename_list_t *
 480 _notmuch_filename_list_create (const void *ctx);
 481
 482 /* Add 'filename' to 'list'.
 483  *
 484  * The list will create its own talloced copy of 'filename'.
 485  */
 486 void
 487 _notmuch_filename_list_add_filename (notmuch_filename_list_t *list,
 488                                      const char *filename);
 489
 490 void
 491 _notmuch_filename_list_destroy (notmuch_filename_list_t *list);
 492
 493 /* The notmuch_filenames_t is an iterator object for a
 494  * notmuch_filename_list_t */
 495 notmuch_filenames_t *
 496 _notmuch_filenames_create (const void *ctx,
 497                            notmuch_filename_list_t *list);
 498
 499 #pragma GCC visibility pop
 500
 501 NOTMUCH_END_DECLS
 502
 503 #endif