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 https://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 #include <sysexits.h>
  29
  30 #include "compat.h"
  31
  32 #include "gmime-extra.h"
  33
  34 typedef GMimeCryptoContext notmuch_crypto_context_t;
  35 /* This is automatically included only since gmime 2.6.10 */
  36 #include <gmime/gmime-pkcs7-context.h>
  37
  38 #include "notmuch.h"
  39
  40 /* This is separate from notmuch-private.h because we're trying to
  41  * keep notmuch.c from looking into any internals, (which helps us
  42  * develop notmuch.h into a plausible library interface).
  43  */
  44 #include "xutil.h"
  45
  46 #include <stddef.h>
  47 #include <string.h>
  48 #include <sys/stat.h>
  49 #include <sys/time.h>
  50 #include <unistd.h>
  51 #include <dirent.h>
  52 #include <errno.h>
  53 #include <signal.h>
  54 #include <ctype.h>
  55
  56 #include "talloc-extra.h"
  57
  58 #define unused(x) x __attribute__ ((unused))
  59
  60 #define STRINGIFY(s) STRINGIFY_(s)
  61 #define STRINGIFY_(s) #s
  62
  63 typedef struct mime_node mime_node_t;
  64 struct sprinter;
  65 struct notmuch_show_params;
  66
  67 typedef struct notmuch_show_format {
  68     struct sprinter *(*new_sprinter) (const void *ctx, FILE *stream);
  69     notmuch_status_t (*part) (const void *ctx, struct sprinter *sprinter,
  70                               struct mime_node *node, int indent,
  71                               const struct notmuch_show_params *params);
  72 } notmuch_show_format_t;
  73
  74 typedef struct notmuch_crypto {
  75     notmuch_crypto_context_t* gpgctx;
  76     notmuch_crypto_context_t* pkcs7ctx;
  77     notmuch_bool_t verify;
  78     notmuch_bool_t decrypt;
  79 #if (GMIME_MAJOR_VERSION < 3)
  80     const char *gpgpath;
  81 #endif
  82 } notmuch_crypto_t;
  83
  84 typedef struct notmuch_show_params {
  85     notmuch_bool_t entire_thread;
  86     notmuch_bool_t omit_excluded;
  87     notmuch_bool_t output_body;
  88     int part;
  89     notmuch_crypto_t crypto;
  90     notmuch_bool_t include_html;
  91     GMimeStream *out_stream;
  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 temporary failure; user is invited to
 121  * retry.
 122  *
 123  * For example, file(s) in the mail store were removed or renamed
 124  * after notmuch new scanned the directories but before indexing the
 125  * file(s). If the file was renamed, the indexing might not be
 126  * complete, and the user is advised to re-run notmuch new.
 127  */
 128 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
 129
 130 /* Exit status code indicating the requested format version is too old
 131  * (support for that version has been dropped).  CLI code should use
 132  * notmuch_exit_if_unsupported_format rather than directly exiting
 133  * with this code.
 134  */
 135 #define NOTMUCH_EXIT_FORMAT_TOO_OLD 20
 136 /* Exit status code indicating the requested format version is newer
 137  * than the version supported by the CLI.  CLI code should use
 138  * notmuch_exit_if_unsupported_format rather than directly exiting
 139  * with this code.
 140  */
 141 #define NOTMUCH_EXIT_FORMAT_TOO_NEW 21
 142
 143 /* The current structured output format version.  Requests for format
 144  * versions above this will return an error.  Backwards-incompatible
 145  * changes such as removing map fields, changing the meaning of map
 146  * fields, or changing the meanings of list elements should increase
 147  * this.  New (required) map fields can be added without increasing
 148  * this.
 149  */
 150 #define NOTMUCH_FORMAT_CUR 4
 151 /* The minimum supported structured output format version.  Requests
 152  * for format versions below this will return an error. */
 153 #define NOTMUCH_FORMAT_MIN 1
 154 /* The minimum non-deprecated structured output format version.
 155  * Requests for format versions below this will print a stern warning.
 156  * Must be between NOTMUCH_FORMAT_MIN and NOTMUCH_FORMAT_CUR,
 157  * inclusive.
 158  */
 159 #define NOTMUCH_FORMAT_MIN_ACTIVE 1
 160
 161 /* The output format version requested by the caller on the command
 162  * line.  If no format version is requested, this will be set to
 163  * NOTMUCH_FORMAT_CUR.  Even though the command-line option is
 164  * per-command, this is global because commands can share structured
 165  * output code.
 166  */
 167 extern int notmuch_format_version;
 168
 169 typedef struct _notmuch_config notmuch_config_t;
 170
 171 /* Commands that support structured output should support the
 172  * following argument
 173  *  { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 }
 174  * and should invoke notmuch_exit_if_unsupported_format to check the
 175  * requested version.  If notmuch_format_version is outside the
 176  * supported range, this will print a detailed diagnostic message for
 177  * the user and exit with NOTMUCH_EXIT_FORMAT_TOO_{OLD,NEW} to inform
 178  * the invoking program of the problem.
 179  */
 180 void
 181 notmuch_exit_if_unsupported_format (void);
 182
 183 notmuch_crypto_context_t *
 184 notmuch_crypto_get_context (notmuch_crypto_t *crypto, const char *protocol);
 185
 186 int
 187 notmuch_crypto_cleanup (notmuch_crypto_t *crypto);
 188
 189 int
 190 notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]);
 191
 192 int
 193 notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]);
 194
 195 int
 196 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]);
 197
 198 int
 199 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]);
 200
 201 int
 202 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]);
 203
 204 int
 205 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]);
 206
 207 int
 208 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]);
 209
 210 int
 211 notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]);
 212
 213 int
 214 notmuch_setup_command (notmuch_config_t *config, int argc, char *argv[]);
 215
 216 int
 217 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]);
 218
 219 int
 220 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]);
 221
 222 int
 223 notmuch_config_command (notmuch_config_t *config, int argc, char *argv[]);
 224
 225 int
 226 notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]);
 227
 228 const char *
 229 notmuch_time_relative_date (const void *ctx, time_t then);
 230
 231 void
 232 notmuch_time_print_formatted_seconds (double seconds);
 233
 234 double
 235 notmuch_time_elapsed (struct timeval start, struct timeval end);
 236
 237 char *
 238 query_string_from_args (void *ctx, int argc, char *argv[]);
 239
 240 notmuch_status_t
 241 show_one_part (const char *filename, int part);
 242
 243 void
 244 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
 245                       notmuch_bool_t first, notmuch_bool_t output_body,
 246                       notmuch_bool_t include_html);
 247
 248 void
 249 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
 250                          notmuch_bool_t reply);
 251
 252 typedef enum {
 253     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
 254 } notmuch_show_text_part_flags;
 255
 256 void
 257 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
 258                         notmuch_show_text_part_flags flags);
 259
 260 char *
 261 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 262
 263 char *
 264 json_quote_str (const void *ctx, const char *str);
 265
 266 /* notmuch-config.c */
 267
 268 typedef enum {
 269     NOTMUCH_CONFIG_OPEN = 1 << 0,
 270     NOTMUCH_CONFIG_CREATE = 1 << 1,
 271 } notmuch_config_mode_t;
 272
 273 notmuch_config_t *
 274 notmuch_config_open (void *ctx,
 275                      const char *filename,
 276                      notmuch_config_mode_t config_mode);
 277
 278 void
 279 notmuch_config_close (notmuch_config_t *config);
 280
 281 int
 282 notmuch_config_save (notmuch_config_t *config);
 283
 284 notmuch_bool_t
 285 notmuch_config_is_new (notmuch_config_t *config);
 286
 287 const char *
 288 notmuch_config_get_database_path (notmuch_config_t *config);
 289
 290 void
 291 notmuch_config_set_database_path (notmuch_config_t *config,
 292                                   const char *database_path);
 293
 294 #if (GMIME_MAJOR_VERSION < 3)
 295 const char *
 296 notmuch_config_get_crypto_gpg_path (notmuch_config_t *config);
 297
 298 void
 299 notmuch_config_set_crypto_gpg_path (notmuch_config_t *config,
 300                                   const char *gpg_path);
 301 #endif
 302
 303 const char *
 304 notmuch_config_get_user_name (notmuch_config_t *config);
 305
 306 void
 307 notmuch_config_set_user_name (notmuch_config_t *config,
 308                               const char *user_name);
 309
 310 const char *
 311 notmuch_config_get_user_primary_email (notmuch_config_t *config);
 312
 313 void
 314 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 315                                        const char *primary_email);
 316
 317 const char **
 318 notmuch_config_get_user_other_email (notmuch_config_t *config,
 319                                      size_t *length);
 320
 321 void
 322 notmuch_config_set_user_other_email (notmuch_config_t *config,
 323                                      const char *other_email[],
 324                                      size_t length);
 325
 326 const char **
 327 notmuch_config_get_new_tags (notmuch_config_t *config,
 328                              size_t *length);
 329 void
 330 notmuch_config_set_new_tags (notmuch_config_t *config,
 331                              const char *new_tags[],
 332                              size_t length);
 333
 334 const char **
 335 notmuch_config_get_new_ignore (notmuch_config_t *config,
 336                                size_t *length);
 337
 338 void
 339 notmuch_config_set_new_ignore (notmuch_config_t *config,
 340                                const char *new_ignore[],
 341                                size_t length);
 342
 343 notmuch_bool_t
 344 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
 345
 346 void
 347 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
 348                                               notmuch_bool_t synchronize_flags);
 349
 350 const char **
 351 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
 352
 353 void
 354 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
 355                                       const char *list[],
 356                                       size_t length);
 357
 358 int
 359 notmuch_run_hook (const char *db_path, const char *hook);
 360
 361 notmuch_bool_t
 362 debugger_is_active (void);
 363
 364 /* mime-node.c */
 365
 366 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
 367  * abstracts the different ways of traversing different types of MIME
 368  * parts, allowing a MIME message to be viewed as a generic tree of
 369  * parts.  Message-type parts have one child, multipart-type parts
 370  * have multiple children, and leaf parts have zero children.
 371  */
 372 struct mime_node {
 373     /* The MIME object of this part.  This will be a GMimeMessage,
 374      * GMimePart, GMimeMultipart, or a subclass of one of these.
 375      *
 376      * This will never be a GMimeMessagePart because GMimeMessagePart
 377      * is structurally redundant with GMimeMessage.  If this part is a
 378      * message (that is, 'part' is a GMimeMessage), then either
 379      * envelope_file will be set to a notmuch_message_t (for top-level
 380      * messages) or envelope_part will be set to a GMimeMessagePart
 381      * (for embedded message parts).
 382      */
 383     GMimeObject *part;
 384
 385     /* If part is a GMimeMessage, these record the envelope of the
 386      * message: either a notmuch_message_t representing a top-level
 387      * message, or a GMimeMessagePart representing a MIME part
 388      * containing a message.
 389      */
 390     notmuch_message_t *envelope_file;
 391     GMimeMessagePart *envelope_part;
 392
 393     /* The number of children of this part. */
 394     int nchildren;
 395
 396     /* The parent of this node or NULL if this is the root node. */
 397     struct mime_node *parent;
 398
 399     /* The depth-first part number of this child if the MIME tree is
 400      * being traversed in depth-first order, or -1 otherwise. */
 401     int part_num;
 402
 403     /* True if decryption of this part was attempted. */
 404     notmuch_bool_t decrypt_attempted;
 405     /* True if decryption of this part's child succeeded.  In this
 406      * case, the decrypted part is substituted for the second child of
 407      * this part (which would usually be the encrypted data). */
 408     notmuch_bool_t decrypt_success;
 409
 410     /* True if signature verification on this part was attempted. */
 411     notmuch_bool_t verify_attempted;
 412
 413     /* The list of signatures for signed or encrypted containers. If
 414      * there are no signatures, this will be NULL. */
 415     GMimeSignatureList* sig_list;
 416
 417     /* Internal: Context inherited from the root iterator. */
 418     struct mime_node_context *ctx;
 419
 420     /* Internal: For successfully decrypted multipart parts, the
 421      * decrypted part to substitute for the second child. */
 422     GMimeObject *decrypted_child;
 423
 424     /* Internal: The next child for depth-first traversal and the part
 425      * number to assign it (or -1 if unknown). */
 426     int next_child;
 427     int next_part_num;
 428 };
 429
 430 /* Construct a new MIME node pointing to the root message part of
 431  * message. If crypto->verify is true, signed child parts will be
 432  * verified. If crypto->decrypt is true, encrypted child parts will be
 433  * decrypted.  If the crypto contexts (crypto->gpgctx or
 434  * crypto->pkcs7) are NULL, they will be lazily initialized.
 435  *
 436  * Return value:
 437  *
 438  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
 439  *
 440  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
 441  *
 442  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
 443  */
 444 notmuch_status_t
 445 mime_node_open (const void *ctx, notmuch_message_t *message,
 446                 notmuch_crypto_t *crypto, mime_node_t **node_out);
 447
 448 /* Return a new MIME node for the requested child part of parent.
 449  * parent will be used as the talloc context for the returned child
 450  * node.
 451  *
 452  * In case of any failure, this function returns NULL, (after printing
 453  * an error message on stderr).
 454  */
 455 mime_node_t *
 456 mime_node_child (mime_node_t *parent, int child);
 457
 458 /* Return the nth child of node in a depth-first traversal.  If n is
 459  * 0, returns node itself.  Returns NULL if there is no such part. */
 460 mime_node_t *
 461 mime_node_seek_dfs (mime_node_t *node, int n);
 462
 463 typedef enum dump_formats {
 464     DUMP_FORMAT_AUTO,
 465     DUMP_FORMAT_BATCH_TAG,
 466     DUMP_FORMAT_SUP
 467 } dump_format_t;
 468
 469 typedef enum dump_includes {
 470     DUMP_INCLUDE_TAGS = 1,
 471     DUMP_INCLUDE_CONFIG = 2,
 472     DUMP_INCLUDE_PROPERTIES = 4
 473 } dump_include_t;
 474
 475 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
 476
 477 #define NOTMUCH_DUMP_VERSION 3
 478
 479 int
 480 notmuch_database_dump (notmuch_database_t *notmuch,
 481                        const char *output_file_name,
 482                        const char *query_str,
 483                        dump_format_t output_format,
 484                        dump_include_t include,
 485                        notmuch_bool_t gzip_output);
 486
 487 /* If status is non-zero (i.e. error) print appropriate
 488    messages to stderr.
 489 */
 490
 491 notmuch_status_t
 492 print_status_query (const char *loc,
 493                     const notmuch_query_t *query,
 494                     notmuch_status_t status);
 495
 496 notmuch_status_t
 497 print_status_database (const char *loc,
 498                        const notmuch_database_t *database,
 499                        notmuch_status_t status);
 500
 501 int
 502 status_to_exit (notmuch_status_t status);
 503
 504 #include "command-line-arguments.h"
 505
 506 extern char *notmuch_requested_db_uuid;
 507 extern const notmuch_opt_desc_t  notmuch_shared_options [];
 508 void notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
 509
 510 void notmuch_process_shared_options (const char* subcommand_name);
 511 int notmuch_minimal_options (const char* subcommand_name,
 512                              int argc, char **argv);
 513 #endif