git.notmuchmail.org Git - notmuch/blob - notmuch-client.h

   1 /* notmuch - Not much of an email program, (just index and search)
   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_CLIENT_H
  22 #define NOTMUCH_CLIENT_H
  23
  24 #ifndef _GNU_SOURCE
  25 #define _GNU_SOURCE /* for getline */
  26 #endif
  27 #include <stdio.h>
  28
  29 #include "compat.h"
  30
  31 #include <gmime/gmime.h>
  32
  33 /* GMIME_CHECK_VERSION in gmime 2.4 is not usable from the
  34  * preprocessor (it calls a runtime function). But since
  35  * GMIME_MAJOR_VERSION and friends were added in gmime 2.6, we can use
  36  * these to check the version number. */
  37 #ifdef GMIME_MAJOR_VERSION
  38 #define GMIME_ATLEAST_26
  39 typedef GMimeCryptoContext notmuch_crypto_context_t;
  40 #else
  41 typedef GMimeCipherContext notmuch_crypto_context_t;
  42 #endif
  43
  44 #include "notmuch.h"
  45
  46 /* This is separate from notmuch-private.h because we're trying to
  47  * keep notmuch.c from looking into any internals, (which helps us
  48  * develop notmuch.h into a plausible library interface).
  49  */
  50 #include "xutil.h"
  51
  52 #include <stddef.h>
  53 #include <string.h>
  54 #include <sys/stat.h>
  55 #include <sys/time.h>
  56 #include <unistd.h>
  57 #include <dirent.h>
  58 #include <errno.h>
  59 #include <signal.h>
  60
  61 #include "talloc-extra.h"
  62
  63 #define unused(x) x __attribute__ ((unused))
  64
  65 #define STRINGIFY(s) STRINGIFY_(s)
  66 #define STRINGIFY_(s) #s
  67
  68 typedef struct mime_node mime_node_t;
  69 struct sprinter;
  70 struct notmuch_show_params;
  71
  72 typedef struct notmuch_show_format {
  73     struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream);
  74     notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter,
  75                               struct mime_node *node, int indent,
  76                               const struct notmuch_show_params *params);
  77 } notmuch_show_format_t;
  78
  79 typedef struct notmuch_crypto {
  80     notmuch_crypto_context_t* gpgctx;
  81     notmuch_bool_t verify;
  82     notmuch_bool_t decrypt;
  83 } notmuch_crypto_t;
  84
  85 typedef struct notmuch_show_params {
  86     notmuch_bool_t entire_thread;
  87     notmuch_bool_t omit_excluded;
  88     notmuch_bool_t output_body;
  89     notmuch_bool_t raw;
  90     int part;
  91     notmuch_crypto_t crypto;
  92     notmuch_bool_t include_html;
  93 } notmuch_show_params_t;
  94
  95 /* There's no point in continuing when we've detected that we've done
  96  * something wrong internally (as opposed to the user passing in a
  97  * bogus value).
  98  *
  99  * Note that __location__ comes from talloc.h.
 100  */
 101 #define INTERNAL_ERROR(format, ...)                     \
 102     do {                                                \
 103         fprintf(stderr,                                 \
 104                 "Internal error: " format " (%s)\n",    \
 105                 ##__VA_ARGS__, __location__);           \
 106         exit (1);                                       \
 107     } while (0)
 108
 109 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
 110
 111 #define STRNCMP_LITERAL(var, literal) \
 112     strncmp ((var), (literal), sizeof (literal) - 1)
 113
 114 static inline void
 115 chomp_newline (char *str)
 116 {
 117     if (str && str[strlen(str)-1] == '\n')
 118         str[strlen(str)-1] = '\0';
 119 }
 120
 121 /* Exit status code indicating the requested format version is too old
 122  * (support for that version has been dropped).  CLI code should use
 123  * notmuch_exit_if_unsupported_format rather than directly exiting
 124  * with this code.
 125  */
 126 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
 127 /* Exit status code indicating the requested format version is newer
 128  * than the version supported by the CLI.  CLI code should use
 129  * notmuch_exit_if_unsupported_format rather than directly exiting
 130  * with this code.
 131  */
 132 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
 133
 134 /* The current structured output format version.  Requests for format
 135  * versions above this will return an error.  Backwards-incompatible
 136  * changes such as removing map fields, changing the meaning of map
 137  * fields, or changing the meanings of list elements should increase
 138  * this.  New (required) map fields can be added without increasing
 139  * this.
 140  */
 141 #define NOTMUCH_FORMAT_CUR 2
 142 /* The minimum supported structured output format version.  Requests
 143  * for format versions below this will return an error. */
 144 #define NOTMUCH_FORMAT_MIN 1
 145 /* The minimum non-deprecated structured output format version.
 146  * Requests for format versions below this will print a stern warning.
 147  * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
 148  * inclusive.
 149  */
 150 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
 151
 152 /* The output format version requested by the caller on the command
 153  * line.  If no format version is requested, this will be set to
 154  * NOTMUCH_FORMAT_CUR.  Even though the command-line option is
 155  * per-command, this is global because commands can share structured
 156  * output code.
 157  */
 158 extern int notmuch_format_version;
 159
 160 typedef struct _notmuch_config notmuch_config_t;
 161
 162 /* Commands that support structured output should support the
 163  * following argument
 164  *  { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 }
 165  * and should invoke notmuch_exit_if_unsupported_format to check the
 166  * requested version.  If notmuch_format_version is outside the
 167  * supported range, this will print a detailed diagnostic message for
 168  * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
 169  * the invoking program of the problem.
 170  */
 171 void
 172 notmuch_exit_if_unsupported_format (void);
 173
 174 notmuch_crypto_context_t *
 175 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
 176
 177 int
 178 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
 179
 180 int
 181 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
 182
 183 int
 184 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
 185
 186 int
 187 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
 188
 189 int
 190 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
 191
 192 int
 193 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
 194
 195 int
 196 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
 197
 198 int
 199 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
 200
 201 int
 202 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
 203
 204 int
 205 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
 206
 207 int
 208 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
 209
 210 int
 211 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
 212
 213 int
 214 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
 215
 216 int
 217 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
 218
 219 const char *
 220 notmuch_time_relative_date (const void *ctx, time_t then);
 221
 222 void
 223 notmuch_time_print_formatted_seconds (double seconds);
 224
 225 double
 226 notmuch_time_elapsed (struct timeval start, struct timeval end);
 227
 228 char *
 229 query_string_from_args (void *ctx, int argc, char *argv[]);
 230
 231 notmuch_status_t
 232 show_one_part (const char *filename, int part);
 233
 234 void
 235 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
 236                       notmuch_bool_t first, notmuch_bool_t output_body,
 237                       notmuch_bool_t include_html);
 238
 239 void
 240 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
 241                          notmuch_bool_t reply);
 242
 243 typedef enum {
 244     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
 245 } notmuch_show_text_part_flags;
 246
 247 void
 248 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
 249                         notmuch_show_text_part_flags flags);
 250
 251 char *
 252 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 253
 254 char *
 255 json_quote_str (const void *ctx, const char *str);
 256
 257 /* notmuch-config.c */
 258
 259 notmuch_config_t *
 260 notmuch_config_open (void *ctx,
 261                      const char *filename,
 262                      notmuch_bool_t create_new);
 263
 264 void
 265 notmuch_config_close (notmuch_config_t *config);
 266
 267 int
 268 notmuch_config_save (notmuch_config_t *config);
 269
 270 notmuch_bool_t
 271 notmuch_config_is_new (notmuch_config_t *config);
 272
 273 const char *
 274 notmuch_config_get_database_path (notmuch_config_t *config);
 275
 276 void
 277 notmuch_config_set_database_path (notmuch_config_t *config,
 278                                   const char *database_path);
 279
 280 const char *
 281 notmuch_config_get_user_name (notmuch_config_t *config);
 282
 283 void
 284 notmuch_config_set_user_name (notmuch_config_t *config,
 285                               const char *user_name);
 286
 287 const char *
 288 notmuch_config_get_user_primary_email (notmuch_config_t *config);
 289
 290 void
 291 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 292                                        const char *primary_email);
 293
 294 const char **
 295 notmuch_config_get_user_other_email (notmuch_config_t *config,
 296                                      size_t *length);
 297
 298 void
 299 notmuch_config_set_user_other_email (notmuch_config_t *config,
 300                                      const char *other_email[],
 301                                      size_t length);
 302
 303 const char **
 304 notmuch_config_get_new_tags (notmuch_config_t *config,
 305                              size_t *length);
 306 void
 307 notmuch_config_set_new_tags (notmuch_config_t *config,
 308                              const char *new_tags[],
 309                              size_t length);
 310
 311 const char **
 312 notmuch_config_get_new_ignore (notmuch_config_t *config,
 313                                size_t *length);
 314
 315 void
 316 notmuch_config_set_new_ignore (notmuch_config_t *config,
 317                                const char *new_ignore[],
 318                                size_t length);
 319
 320 notmuch_bool_t
 321 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
 322
 323 void
 324 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
 325                                               notmuch_bool_t synchronize_flags);
 326
 327 const char **
 328 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
 329
 330 void
 331 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
 332                                       const char *list[],
 333                                       size_t length);
 334
 335 int
 336 notmuch_run_hook (const char *db_path, const char *hook);
 337
 338 notmuch_bool_t
 339 debugger_is_active (void);
 340
 341 /* mime-node.c */
 342
 343 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
 344  * abstracts the different ways of traversing different types of MIME
 345  * parts, allowing a MIME message to be viewed as a generic tree of
 346  * parts.  Message-type parts have one child, multipart-type parts
 347  * have multiple children, and leaf parts have zero children.
 348  */
 349 struct mime_node {
 350     /* The MIME object of this part.  This will be a GMimeMessage,
 351      * GMimePart, GMimeMultipart, or a subclass of one of these.
 352      *
 353      * This will never be a GMimeMessagePart because GMimeMessagePart
 354      * is structurally redundant with GMimeMessage.  If this part is a
 355      * message (that is, 'part' is a GMimeMessage), then either
 356      * envelope_file will be set to a notmuch_message_t (for top-level
 357      * messages) or envelope_part will be set to a GMimeMessagePart
 358      * (for embedded message parts).
 359      */
 360     GMimeObject *part;
 361
 362     /* If part is a GMimeMessage, these record the envelope of the
 363      * message: either a notmuch_message_t representing a top-level
 364      * message, or a GMimeMessagePart representing a MIME part
 365      * containing a message.
 366      */
 367     notmuch_message_t *envelope_file;
 368     GMimeMessagePart *envelope_part;
 369
 370     /* The number of children of this part. */
 371     int nchildren;
 372
 373     /* The parent of this node or NULL if this is the root node. */
 374     struct mime_node *parent;
 375
 376     /* The depth-first part number of this child if the MIME tree is
 377      * being traversed in depth-first order, or -1 otherwise. */
 378     int part_num;
 379
 380     /* True if decryption of this part was attempted. */
 381     notmuch_bool_t decrypt_attempted;
 382     /* True if decryption of this part's child succeeded.  In this
 383      * case, the decrypted part is substituted for the second child of
 384      * this part (which would usually be the encrypted data). */
 385     notmuch_bool_t decrypt_success;
 386
 387     /* True if signature verification on this part was attempted. */
 388     notmuch_bool_t verify_attempted;
 389 #ifdef GMIME_ATLEAST_26
 390     /* The list of signatures for signed or encrypted containers. If
 391      * there are no signatures, this will be NULL. */
 392     GMimeSignatureList* sig_list;
 393 #else
 394     /* For signed or encrypted containers, the validity of the
 395      * signature.  May be NULL if signature verification failed.  If
 396      * there are simply no signatures, this will be non-NULL with an
 397      * empty signers list. */
 398     const GMimeSignatureValidity *sig_validity;
 399 #endif
 400
 401     /* Internal: Context inherited from the root iterator. */
 402     struct mime_node_context *ctx;
 403
 404     /* Internal: For successfully decrypted multipart parts, the
 405      * decrypted part to substitute for the second child. */
 406     GMimeObject *decrypted_child;
 407
 408     /* Internal: The next child for depth-first traversal and the part
 409      * number to assign it (or -1 if unknown). */
 410     int next_child;
 411     int next_part_num;
 412 };
 413
 414 /* Construct a new MIME node pointing to the root message part of
 415  * message. If crypto->verify is true, signed child parts will be
 416  * verified. If crypto->decrypt is true, encrypted child parts will be
 417  * decrypted.  If crypto->gpgctx is NULL, it will be lazily
 418  * initialized.
 419  *
 420  * Return value:
 421  *
 422  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
 423  *
 424  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
 425  *
 426  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
 427  */
 428 notmuch_status_t
 429 mime_node_open (const void *ctx, notmuch_message_t *message,
 430                 notmuch_crypto_t *crypto, mime_node_t **node_out);
 431
 432 /* Return a new MIME node for the requested child part of parent.
 433  * parent will be used as the talloc context for the returned child
 434  * node.
 435  *
 436  * In case of any failure, this function returns NULL, (after printing
 437  * an error message on stderr).
 438  */
 439 mime_node_t *
 440 mime_node_child (mime_node_t *parent, int child);
 441
 442 /* Return the nth child of node in a depth-first traversal.  If n is
 443  * 0, returns node itself.  Returns NULL if there is no such part. */
 444 mime_node_t *
 445 mime_node_seek_dfs (mime_node_t *node, int n);
 446
 447 typedef enum dump_formats {
 448     DUMP_FORMAT_AUTO,
 449     DUMP_FORMAT_BATCH_TAG,
 450     DUMP_FORMAT_SUP
 451 } dump_format_t;
 452
 453 int
 454 notmuch_database_dump (notmuch_database_t *notmuch,
 455                        const char *output_file_name,
 456                        const char *query_str,
 457                        dump_format_t output_format,
 458                        notmuch_bool_t gzip_output);
 459
 460 #include "command-line-arguments.h"
 461 #endif