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 #ifdef DEBUG
  52 # define DEBUG_DATABASE_SANITY 1
  53 # define DEBUG_QUERY 1
  54 #endif
  55
  56 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
  57
  58 /* There's no point in continuing when we've detected that we've done
  59  * something wrong internally (as opposed to the user passing in a
  60  * bogus value).
  61  *
  62  * Note that PRINTF_ATTRIBUTE comes from talloc.h
  63  */
  64 int
  65 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
  66
  67 /* There's no point in continuing when we've detected that we've done
  68  * something wrong internally (as opposed to the user passing in a
  69  * bogus value).
  70  *
  71  * Note that __location__ comes from talloc.h.
  72  */
  73 #define INTERNAL_ERROR(format, ...)                     \
  74     _internal_error (format " (%s).\n",                 \
  75                      ##__VA_ARGS__, __location__)
  76
  77 #define unused(x) x __attribute__ ((unused))
  78
  79 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
  80  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
  81  */
  82 /* these macros gain us a few percent of speed on gcc */
  83 #if (__GNUC__ >= 3)
  84 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
  85    as its first argument */
  86 #ifndef likely
  87 #define likely(x)   __builtin_expect(!!(x), 1)
  88 #endif
  89 #ifndef unlikely
  90 #define unlikely(x) __builtin_expect(!!(x), 0)
  91 #endif
  92 #else
  93 #ifndef likely
  94 #define likely(x) (x)
  95 #endif
  96 #ifndef unlikely
  97 #define unlikely(x) (x)
  98 #endif
  99 #endif
 100
 101 typedef enum {
 102     NOTMUCH_VALUE_TIMESTAMP = 0,
 103     NOTMUCH_VALUE_MESSAGE_ID
 104 } notmuch_value_t;
 105
 106 /* Xapian (with flint backend) complains if we provide a term longer
 107  * than this, but I haven't yet found a way to query the limit
 108  * programmatically. */
 109 #define NOTMUCH_TERM_MAX 245
 110
 111 typedef enum _notmuch_private_status {
 112     /* First, copy all the public status values. */
 113     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
 114     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
 115     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE = NOTMUCH_STATUS_READ_ONLY_DATABASE,
 116     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
 117     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
 118     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
 119     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
 120     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
 121
 122     /* Then add our own private values. */
 123     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG = NOTMUCH_STATUS_LAST_STATUS,
 124     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
 125
 126     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
 127 } notmuch_private_status_t;
 128
 129 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
 130  * value, generating an internal error if the private value is equal
 131  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
 132  * that the caller has previously handled any expected
 133  * notmuch_private_status_t values.)
 134  */
 135 #define COERCE_STATUS(private_status, format, ...)                      \
 136     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
 137      ?                                                                  \
 138      (notmuch_status_t) _internal_error (format " (%s).\n",             \
 139                                          ##__VA_ARGS__,                 \
 140                                          __location__)                  \
 141      :                                                                  \
 142      (notmuch_status_t) private_status)
 143
 144 /* database.cc */
 145
 146 /* Lookup a prefix value by name.
 147  *
 148  * XXX: This should really be static inside of message.cc, and we can
 149  * do that once we convert database.cc to use the
 150  * _notmuch_message_add/remove_term functions. */
 151 const char *
 152 _find_prefix (const char *name);
 153
 154 notmuch_status_t
 155 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
 156
 157 const char *
 158 _notmuch_database_relative_path (notmuch_database_t *notmuch,
 159                                  const char *path);
 160
 161 notmuch_status_t
 162 _notmuch_database_split_path (void *ctx,
 163                               const char *path,
 164                               const char **directory,
 165                               const char **basename);
 166
 167 const char *
 168 _notmuch_database_get_directory_db_path (const char *path);
 169
 170 notmuch_private_status_t
 171 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
 172                                       const char *prefix_name,
 173                                       const char *value,
 174                                       unsigned int *doc_id);
 175
 176 notmuch_status_t
 177 _notmuch_database_find_directory_id (notmuch_database_t *database,
 178                                      const char *path,
 179                                      unsigned int *directory_id);
 180
 181 const char *
 182 _notmuch_database_get_directory_path (void *ctx,
 183                                       notmuch_database_t *notmuch,
 184                                       unsigned int doc_id);
 185
 186 notmuch_status_t
 187 _notmuch_database_filename_to_direntry (void *ctx,
 188                                         notmuch_database_t *notmuch,
 189                                         const char *filename,
 190                                         char **direntry);
 191
 192 /* directory.cc */
 193
 194 notmuch_directory_t *
 195 _notmuch_directory_create (notmuch_database_t *notmuch,
 196                            const char *path,
 197                            notmuch_status_t *status_ret);
 198
 199 unsigned int
 200 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
 201
 202 /* thread.cc */
 203
 204 notmuch_thread_t *
 205 _notmuch_thread_create (void *ctx,
 206                         notmuch_database_t *notmuch,
 207                         const char *thread_id,
 208                         const char *query_string,
 209                         notmuch_sort_t sort);
 210
 211 /* message.cc */
 212
 213 notmuch_message_t *
 214 _notmuch_message_create (const void *talloc_owner,
 215                          notmuch_database_t *notmuch,
 216                          unsigned int doc_id,
 217                          notmuch_private_status_t *status);
 218
 219 notmuch_message_t *
 220 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 221                                         const char *message_id,
 222                                         notmuch_private_status_t *status);
 223
 224 const char *
 225 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
 226
 227 notmuch_private_status_t
 228 _notmuch_message_add_term (notmuch_message_t *message,
 229                            const char *prefix_name,
 230                            const char *value);
 231
 232 notmuch_private_status_t
 233 _notmuch_message_remove_term (notmuch_message_t *message,
 234                               const char *prefix_name,
 235                               const char *value);
 236
 237 notmuch_private_status_t
 238 _notmuch_message_gen_terms (notmuch_message_t *message,
 239                             const char *prefix_name,
 240                             const char *text);
 241
 242 void
 243 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
 244
 245 notmuch_status_t
 246 _notmuch_message_add_filename (notmuch_message_t *message,
 247                                const char *filename);
 248
 249 void
 250 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
 251
 252 void
 253 _notmuch_message_set_date (notmuch_message_t *message,
 254                            const char *date);
 255
 256 void
 257 _notmuch_message_sync (notmuch_message_t *message);
 258
 259 void
 260 _notmuch_message_close (notmuch_message_t *message);
 261
 262 /* Get a copy of the data in this message document.
 263  *
 264  * Caller should talloc_free the result when done.
 265  *
 266  * This function is intended to support database upgrade and really
 267  * shouldn't be used otherwise. */
 268 char *
 269 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
 270
 271 /* Clear the data in this message document.
 272  *
 273  * This function is intended to support database upgrade and really
 274  * shouldn't be used otherwise. */
 275 void
 276 _notmuch_message_clear_data (notmuch_message_t *message);
 277
 278 /* Set the author member of 'message' - this is the representation used
 279  * when displaying the message */
 280 void
 281 notmuch_message_set_author (notmuch_message_t *message, const char *author);
 282
 283 /* Get the author member of 'message' */
 284 const char *
 285 notmuch_message_get_author (notmuch_message_t *message);
 286
 287
 288 /* index.cc */
 289
 290 notmuch_status_t
 291 _notmuch_message_index_file (notmuch_message_t *message,
 292                              const char *filename);
 293
 294 /* message-file.c */
 295
 296 /* XXX: I haven't decided yet whether these will actually get exported
 297  * into the public interface in notmuch.h
 298  */
 299
 300 typedef struct _notmuch_message_file notmuch_message_file_t;
 301
 302 /* Open a file containing a single email message.
 303  *
 304  * The caller should call notmuch_message_close when done with this.
 305  *
 306  * Returns NULL if any error occurs.
 307  */
 308 notmuch_message_file_t *
 309 notmuch_message_file_open (const char *filename);
 310
 311 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
 312 notmuch_message_file_t *
 313 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
 314
 315 /* Close a notmuch message previously opened with notmuch_message_open. */
 316 void
 317 notmuch_message_file_close (notmuch_message_file_t *message);
 318
 319 /* Restrict 'message' to only save the named headers.
 320  *
 321  * When the caller is only interested in a short list of headers,
 322  * known in advance, calling this function can avoid wasted time and
 323  * memory parsing/saving header values that will never be needed.
 324  *
 325  * The variable arguments should be a list of const char * with a
 326  * final '(const char *) NULL' to terminate the list.
 327  *
 328  * If this function is called, it must be called before any calls to
 329  * notmuch_message_get_header for this message.
 330  *
 331  * After calling this function, if notmuch_message_get_header is
 332  * called with a header name not in this list, then NULL will be
 333  * returned even if that header exists in the actual message.
 334  */
 335 void
 336 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
 337
 338 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
 339 void
 340 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
 341                                         va_list va_headers);
 342
 343 /* Get the value of the specified header from the message.
 344  *
 345  * The header name is case insensitive.
 346  *
 347  * The returned value is owned by the notmuch message and is valid
 348  * only until the message is closed. The caller should copy it if
 349  * needing to modify the value or to hold onto it for longer.
 350  *
 351  * Returns NULL if the message does not contain a header line matching
 352  * 'header'.
 353  */
 354 const char *
 355 notmuch_message_file_get_header (notmuch_message_file_t *message,
 356                                  const char *header);
 357
 358 /* messages.c */
 359
 360 typedef struct _notmuch_message_node {
 361     notmuch_message_t *message;
 362     struct _notmuch_message_node *next;
 363 } notmuch_message_node_t;
 364
 365 typedef struct _notmuch_message_list {
 366     notmuch_message_node_t *head;
 367     notmuch_message_node_t **tail;
 368 } notmuch_message_list_t;
 369
 370 /* There's a rumor that there's an alternate struct _notmuch_messages
 371  * somewhere with some nasty C++ objects in it. We'll try to maintain
 372  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
 373  */
 374 struct _notmuch_messages {
 375     notmuch_bool_t is_of_list_type;
 376     notmuch_message_node_t *iterator;
 377 };
 378
 379 notmuch_message_list_t *
 380 _notmuch_message_list_create (const void *ctx);
 381
 382 void
 383 _notmuch_message_list_append (notmuch_message_list_t *list,
 384                               notmuch_message_node_t *node);
 385
 386 void
 387 _notmuch_message_list_add_message (notmuch_message_list_t *list,
 388                                    notmuch_message_t *message);
 389
 390 notmuch_messages_t *
 391 _notmuch_messages_create (notmuch_message_list_t *list);
 392
 393 /* query.cc */
 394
 395 notmuch_bool_t
 396 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
 397
 398 notmuch_message_t *
 399 _notmuch_mset_messages_get (notmuch_messages_t *messages);
 400
 401 void
 402 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
 403
 404 /* message.cc */
 405
 406 void
 407 _notmuch_message_add_reply (notmuch_message_t *message,
 408                             notmuch_message_node_t *reply);
 409
 410 /* sha1.c */
 411
 412 char *
 413 notmuch_sha1_of_string (const char *str);
 414
 415 char *
 416 notmuch_sha1_of_file (const char *filename);
 417
 418 /* tags.c */
 419
 420 notmuch_tags_t *
 421 _notmuch_tags_create (void *ctx);
 422
 423 void
 424 _notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag);
 425
 426 void
 427 _notmuch_tags_prepare_iterator (notmuch_tags_t *tags);
 428
 429 NOTMUCH_END_DECLS
 430
 431 #endif