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