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_show_params_t;
  93
  94 /* There's no point in continuing when we've detected that we've done
  95  * something wrong internally (as opposed to the user passing in a
  96  * bogus value).
  97  *
  98  * Note that __location__ comes from talloc.h.
  99  */
 100 #define INTERNAL_ERROR(format, ...)                     \
 101     do {                                                \
 102         fprintf(stderr,                                 \
 103                 "Internal error: " format " (%s)\n",    \
 104                 ##__VA_ARGS__, __location__);           \
 105         exit (1);                                       \
 106     } while (0)
 107
 108 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
 109
 110 #define STRNCMP_LITERAL(var, literal) \
 111     strncmp ((var), (literal), sizeof (literal) - 1)
 112
 113 static inline void
 114 chomp_newline (char *str)
 115 {
 116     if (str && str[strlen(str)-1] == '\n')
 117         str[strlen(str)-1] = '\0';
 118 }
 119
 120 /* Exit status code indicating the requested format version is too old
 121  * (support for that version has been dropped).  CLI code should use
 122  * notmuch_exit_if_unsupported_format rather than directly exiting
 123  * with this code.
 124  */
 125 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
 126 /* Exit status code indicating the requested format version is newer
 127  * than the version supported by the CLI.  CLI code should use
 128  * notmuch_exit_if_unsupported_format rather than directly exiting
 129  * with this code.
 130  */
 131 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
 132
 133 /* The current structured output format version.  Requests for format
 134  * versions above this will return an error.  Backwards-incompatible
 135  * changes such as removing map fields, changing the meaning of map
 136  * fields, or changing the meanings of list elements should increase
 137  * this.  New (required) map fields can be added without increasing
 138  * this.
 139  */
 140 #define NOTMUCH_FORMAT_CUR 1
 141 /* The minimum supported structured output format version.  Requests
 142  * for format versions below this will return an error. */
 143 #define NOTMUCH_FORMAT_MIN 1
 144
 145 /* The output format version requested by the caller on the command
 146  * line.  If no format version is requested, this will be set to
 147  * NOTMUCH_FORMAT_CUR.  Even though the command-line option is
 148  * per-command, this is global because commands can share structured
 149  * output code.
 150  */
 151 extern int notmuch_format_version;
 152
 153 typedef struct _notmuch_config notmuch_config_t;
 154
 155 /* Commands that support structured output should support the
 156  * following argument
 157  *  { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 }
 158  * and should invoke notmuch_exit_if_unsupported_format to check the
 159  * requested version.  If notmuch_format_version is outside the
 160  * supported range, this will print a detailed diagnostic message for
 161  * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
 162  * the invoking program of the problem.
 163  */
 164 void
 165 notmuch_exit_if_unsupported_format (void);
 166
 167 notmuch_crypto_context_t *
 168 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
 169
 170 int
 171 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
 172
 173 int
 174 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
 175
 176 int
 177 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
 178
 179 int
 180 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
 181
 182 int
 183 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
 184
 185 int
 186 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
 187
 188 int
 189 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
 190
 191 int
 192 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
 193
 194 int
 195 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
 196
 197 int
 198 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
 199
 200 int
 201 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
 202
 203 const char *
 204 notmuch_time_relative_date (const void *ctx, time_t then);
 205
 206 void
 207 notmuch_time_print_formatted_seconds (double seconds);
 208
 209 double
 210 notmuch_time_elapsed (struct timeval start, struct timeval end);
 211
 212 char *
 213 query_string_from_args (void *ctx, int argc, char *argv[]);
 214
 215 notmuch_status_t
 216 show_one_part (const char *filename, int part);
 217
 218 void
 219 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
 220                       notmuch_bool_t first, notmuch_bool_t output_body);
 221
 222 void
 223 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
 224                          notmuch_bool_t reply);
 225
 226 typedef enum {
 227     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
 228 } notmuch_show_text_part_flags;
 229
 230 void
 231 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
 232                         notmuch_show_text_part_flags flags);
 233
 234 char *
 235 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 236
 237 char *
 238 json_quote_str (const void *ctx, const char *str);
 239
 240 /* notmuch-config.c */
 241
 242 notmuch_config_t *
 243 notmuch_config_open (void *ctx,
 244                      const char *filename,
 245                      notmuch_bool_t create_new);
 246
 247 void
 248 notmuch_config_close (notmuch_config_t *config);
 249
 250 int
 251 notmuch_config_save (notmuch_config_t *config);
 252
 253 notmuch_bool_t
 254 notmuch_config_is_new (notmuch_config_t *config);
 255
 256 const char *
 257 notmuch_config_get_database_path (notmuch_config_t *config);
 258
 259 void
 260 notmuch_config_set_database_path (notmuch_config_t *config,
 261                                   const char *database_path);
 262
 263 const char *
 264 notmuch_config_get_user_name (notmuch_config_t *config);
 265
 266 void
 267 notmuch_config_set_user_name (notmuch_config_t *config,
 268                               const char *user_name);
 269
 270 const char *
 271 notmuch_config_get_user_primary_email (notmuch_config_t *config);
 272
 273 void
 274 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 275                                        const char *primary_email);
 276
 277 const char **
 278 notmuch_config_get_user_other_email (notmuch_config_t *config,
 279                                      size_t *length);
 280
 281 void
 282 notmuch_config_set_user_other_email (notmuch_config_t *config,
 283                                      const char *other_email[],
 284                                      size_t length);
 285
 286 const char **
 287 notmuch_config_get_new_tags (notmuch_config_t *config,
 288                              size_t *length);
 289 void
 290 notmuch_config_set_new_tags (notmuch_config_t *config,
 291                              const char *new_tags[],
 292                              size_t length);
 293
 294 const char **
 295 notmuch_config_get_new_ignore (notmuch_config_t *config,
 296                                size_t *length);
 297
 298 void
 299 notmuch_config_set_new_ignore (notmuch_config_t *config,
 300                                const char *new_ignore[],
 301                                size_t length);
 302
 303 notmuch_bool_t
 304 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
 305
 306 void
 307 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
 308                                               notmuch_bool_t synchronize_flags);
 309
 310 const char **
 311 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
 312
 313 void
 314 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
 315                                       const char *list[],
 316                                       size_t length);
 317
 318 int
 319 notmuch_run_hook (const char *db_path, const char *hook);
 320
 321 notmuch_bool_t
 322 debugger_is_active (void);
 323
 324 /* mime-node.c */
 325
 326 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
 327  * abstracts the different ways of traversing different types of MIME
 328  * parts, allowing a MIME message to be viewed as a generic tree of
 329  * parts.  Message-type parts have one child, multipart-type parts
 330  * have multiple children, and leaf parts have zero children.
 331  */
 332 struct mime_node {
 333     /* The MIME object of this part.  This will be a GMimeMessage,
 334      * GMimePart, GMimeMultipart, or a subclass of one of these.
 335      *
 336      * This will never be a GMimeMessagePart because GMimeMessagePart
 337      * is structurally redundant with GMimeMessage.  If this part is a
 338      * message (that is, 'part' is a GMimeMessage), then either
 339      * envelope_file will be set to a notmuch_message_t (for top-level
 340      * messages) or envelope_part will be set to a GMimeMessagePart
 341      * (for embedded message parts).
 342      */
 343     GMimeObject *part;
 344
 345     /* If part is a GMimeMessage, these record the envelope of the
 346      * message: either a notmuch_message_t representing a top-level
 347      * message, or a GMimeMessagePart representing a MIME part
 348      * containing a message.
 349      */
 350     notmuch_message_t *envelope_file;
 351     GMimeMessagePart *envelope_part;
 352
 353     /* The number of children of this part. */
 354     int nchildren;
 355
 356     /* The parent of this node or NULL if this is the root node. */
 357     struct mime_node *parent;
 358
 359     /* The depth-first part number of this child if the MIME tree is
 360      * being traversed in depth-first order, or -1 otherwise. */
 361     int part_num;
 362
 363     /* True if decryption of this part was attempted. */
 364     notmuch_bool_t decrypt_attempted;
 365     /* True if decryption of this part's child succeeded.  In this
 366      * case, the decrypted part is substituted for the second child of
 367      * this part (which would usually be the encrypted data). */
 368     notmuch_bool_t decrypt_success;
 369
 370     /* True if signature verification on this part was attempted. */
 371     notmuch_bool_t verify_attempted;
 372 #ifdef GMIME_ATLEAST_26
 373     /* The list of signatures for signed or encrypted containers. If
 374      * there are no signatures, this will be NULL. */
 375     GMimeSignatureList* sig_list;
 376 #else
 377     /* For signed or encrypted containers, the validity of the
 378      * signature.  May be NULL if signature verification failed.  If
 379      * there are simply no signatures, this will be non-NULL with an
 380      * empty signers list. */
 381     const GMimeSignatureValidity *sig_validity;
 382 #endif
 383
 384     /* Internal: Context inherited from the root iterator. */
 385     struct mime_node_context *ctx;
 386
 387     /* Internal: For successfully decrypted multipart parts, the
 388      * decrypted part to substitute for the second child. */
 389     GMimeObject *decrypted_child;
 390
 391     /* Internal: The next child for depth-first traversal and the part
 392      * number to assign it (or -1 if unknown). */
 393     int next_child;
 394     int next_part_num;
 395 };
 396
 397 /* Construct a new MIME node pointing to the root message part of
 398  * message. If crypto->verify is true, signed child parts will be
 399  * verified. If crypto->decrypt is true, encrypted child parts will be
 400  * decrypted.  If crypto->gpgctx is NULL, it will be lazily
 401  * initialized.
 402  *
 403  * Return value:
 404  *
 405  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
 406  *
 407  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
 408  *
 409  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
 410  */
 411 notmuch_status_t
 412 mime_node_open (const void *ctx, notmuch_message_t *message,
 413                 notmuch_crypto_t *crypto, mime_node_t **node_out);
 414
 415 /* Return a new MIME node for the requested child part of parent.
 416  * parent will be used as the talloc context for the returned child
 417  * node.
 418  *
 419  * In case of any failure, this function returns NULL, (after printing
 420  * an error message on stderr).
 421  */
 422 mime_node_t *
 423 mime_node_child (mime_node_t *parent, int child);
 424
 425 /* Return the nth child of node in a depth-first traversal.  If n is
 426  * 0, returns node itself.  Returns NULL if there is no such part. */
 427 mime_node_t *
 428 mime_node_seek_dfs (mime_node_t *node, int n);
 429
 430 #include "command-line-arguments.h"
 431 #endif