git.cworth.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 <stdbool.h>
  28 #include <stdio.h>
  29 #include <sysexits.h>
  30
  31 #include "compat.h"
  32
  33 #include "gmime-extra.h"
  34
  35 #include "notmuch.h"
  36
  37 /* This is separate from notmuch-private.h because we're trying to
  38  * keep notmuch.c from looking into any internals, (which helps us
  39  * develop notmuch.h into a plausible library interface).
  40  */
  41 #include "xutil.h"
  42
  43 #include <stddef.h>
  44 #include <string.h>
  45 #include <sys/stat.h>
  46 #include <sys/time.h>
  47 #include <unistd.h>
  48 #include <dirent.h>
  49 #include <errno.h>
  50 #include <signal.h>
  51 #include <ctype.h>
  52 #include <zlib.h>
  53
  54 #include "talloc-extra.h"
  55 #include "crypto.h"
  56 #include "repair.h"
  57
  58 #define unused(x) x ## _unused __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)(notmuch_database_t * db, 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_show_params {
  75     bool entire_thread;
  76     bool omit_excluded;
  77     bool output_body;
  78     int duplicate;
  79     int part;
  80     _notmuch_crypto_t crypto;
  81     bool include_html;
  82     GMimeStream *out_stream;
  83 } notmuch_show_params_t;
  84
  85 /* There's no point in continuing when we've detected that we've done
  86  * something wrong internally (as opposed to the user passing in a
  87  * bogus value).
  88  *
  89  * Note that __location__ comes from talloc.h.
  90  */
  91 #define INTERNAL_ERROR(format, ...)                     \
  92     do {                                                \
  93         fprintf (stderr,                                 \
  94                  "Internal error: " format " (%s)\n",    \
  95                  ##__VA_ARGS__, __location__);           \
  96         exit (1);                                       \
  97     } while (0)
  98
  99 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
 100
 101 #define STRNCMP_LITERAL(var, literal) \
 102     strncmp ((var), (literal), sizeof (literal) - 1)
 103
 104 static inline void
 105 chomp_newline (char *str)
 106 {
 107     if (str && str[strlen (str) - 1] == '\n')
 108         str[strlen (str) - 1] = '\0';
 109 }
 110
 111 /* Exit status code indicating temporary failure; user is invited to
 112  * retry.
 113  *
 114  * For example, file(s) in the mail store were removed or renamed
 115  * after notmuch new scanned the directories but before indexing the
 116  * file(s). If the file was renamed, the indexing might not be
 117  * complete, and the user is advised to re-run notmuch new.
 118  */
 119 #define NOTMUCH_EXIT_TEMPFAIL EX_TEMPFAIL
 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 5
 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_conffile notmuch_conffile_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 int
 175 notmuch_count_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 176
 177 int
 178 notmuch_dump_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 179
 180 int
 181 notmuch_new_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 182
 183 int
 184 notmuch_insert_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 185
 186 int
 187 notmuch_reindex_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 188
 189 int
 190 notmuch_reply_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 191
 192 int
 193 notmuch_restore_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 194
 195 int
 196 notmuch_search_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 197
 198 int
 199 notmuch_address_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 200
 201 int
 202 notmuch_setup_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 203
 204 int
 205 notmuch_show_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 206
 207 int
 208 notmuch_tag_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 209
 210 int
 211 notmuch_config_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 212
 213 int
 214 notmuch_compact_command (notmuch_database_t *notmuch, int argc, char *argv[]);
 215
 216 const char *
 217 notmuch_time_relative_date (const void *ctx, time_t then);
 218
 219 void
 220 notmuch_time_print_formatted_seconds (double seconds);
 221
 222 double
 223 notmuch_time_elapsed (struct timeval start, struct timeval end);
 224
 225 char *
 226 query_string_from_args (void *ctx, int argc, char *argv[]);
 227
 228 notmuch_status_t
 229 show_one_part (const char *filename, int part);
 230
 231 void
 232 format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,
 233                       bool output_body,
 234                       bool include_html);
 235
 236 void
 237 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
 238                          bool reply, const _notmuch_message_crypto_t *msg_crypto);
 239
 240 typedef enum {
 241     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
 242 } notmuch_show_text_part_flags;
 243
 244 void
 245 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
 246                         notmuch_show_text_part_flags flags);
 247
 248 char *
 249 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 250
 251 char *
 252 json_quote_str (const void *ctx, const char *str);
 253
 254 /* notmuch-client-init.c */
 255
 256 void notmuch_client_init (void);
 257
 258 /* notmuch-config.c */
 259
 260 typedef enum {
 261     NOTMUCH_COMMAND_CONFIG_CREATE       = 1 << 1,
 262     NOTMUCH_COMMAND_DATABASE_EARLY      = 1 << 2,
 263     NOTMUCH_COMMAND_DATABASE_WRITE      = 1 << 3,
 264     NOTMUCH_COMMAND_DATABASE_CREATE     = 1 << 4,
 265     NOTMUCH_COMMAND_CONFIG_LOAD         = 1 << 5,
 266 } notmuch_command_mode_t;
 267
 268 notmuch_conffile_t *
 269 notmuch_conffile_open (notmuch_database_t *notmuch,
 270                        const char *filename,
 271                        bool create);
 272
 273 void
 274 notmuch_conffile_close (notmuch_conffile_t *config);
 275
 276 int
 277 notmuch_conffile_save (notmuch_conffile_t *config);
 278
 279 bool
 280 notmuch_conffile_is_new (notmuch_conffile_t *config);
 281
 282 void
 283 notmuch_conffile_set_database_path (notmuch_conffile_t *config,
 284                                     const char *database_path);
 285
 286 void
 287 notmuch_conffile_set_user_name (notmuch_conffile_t *config,
 288                                 const char *user_name);
 289
 290 void
 291 notmuch_conffile_set_user_primary_email (notmuch_conffile_t *config,
 292                                          const char *primary_email);
 293
 294 void
 295 notmuch_conffile_set_user_other_email (notmuch_conffile_t *config,
 296                                        const char *other_email[],
 297                                        size_t length);
 298
 299 void
 300 notmuch_conffile_set_new_tags (notmuch_conffile_t *config,
 301                                const char *new_tags[],
 302                                size_t length);
 303
 304 void
 305 notmuch_conffile_set_new_ignore (notmuch_conffile_t *config,
 306                                  const char *new_ignore[],
 307                                  size_t length);
 308
 309 void
 310 notmuch_conffile_set_maildir_synchronize_flags (notmuch_conffile_t *config,
 311                                                 bool synchronize_flags);
 312
 313 void
 314 notmuch_conffile_set_search_exclude_tags (notmuch_conffile_t *config,
 315                                           const char *list[],
 316                                           size_t length);
 317 int
 318 notmuch_run_hook (notmuch_database_t *notmuch, const char *hook);
 319
 320 bool
 321 debugger_is_active (void);
 322
 323 /* mime-node.c */
 324
 325 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
 326  * abstracts the different ways of traversing different types of MIME
 327  * parts, allowing a MIME message to be viewed as a generic tree of
 328  * parts.  Message-type parts have one child, multipart-type parts
 329  * have multiple children, and leaf parts have zero children.
 330  */
 331 struct mime_node {
 332     /* The MIME object of this part.  This will be a GMimeMessage,
 333      * GMimePart, GMimeMultipart, or a subclass of one of these.
 334      *
 335      * This will never be a GMimeMessagePart because GMimeMessagePart
 336      * is structurally redundant with GMimeMessage.  If this part is a
 337      * message (that is, 'part' is a GMimeMessage), then either
 338      * envelope_file will be set to a notmuch_message_t (for top-level
 339      * messages) or envelope_part will be set to a GMimeMessagePart
 340      * (for embedded message parts).
 341      */
 342     GMimeObject *part;
 343
 344     /* If part is a GMimeMessage, these record the envelope of the
 345      * message: either a notmuch_message_t representing a top-level
 346      * message, or a GMimeMessagePart representing a MIME part
 347      * containing a message.
 348      */
 349     notmuch_message_t *envelope_file;
 350     GMimeMessagePart *envelope_part;
 351
 352     /* The number of children of this part. */
 353     int nchildren;
 354
 355     /* The parent of this node or NULL if this is the root node. */
 356     struct mime_node *parent;
 357
 358     /* The depth-first part number of this child if the MIME tree is
 359      * being traversed in depth-first order, or -1 otherwise. */
 360     int part_num;
 361
 362     /* True if decryption of this part was attempted. */
 363     bool decrypt_attempted;
 364     /* True if decryption of this part's child succeeded.  In this
 365      * case, the decrypted part is substituted for the second child of
 366      * this part (which would usually be the encrypted data). */
 367     bool decrypt_success;
 368
 369     /* True if signature verification on this part was attempted. */
 370     bool verify_attempted;
 371
 372     /* The list of signatures for signed or encrypted containers. If
 373      * there are no signatures, this will be NULL. */
 374     GMimeSignatureList *sig_list;
 375
 376     /* Internal: Context inherited from the root iterator. */
 377     struct mime_node_context *ctx;
 378
 379     /* Internal: For successfully decrypted multipart parts, the
 380      * decrypted part to substitute for the second child; or, for
 381      * PKCS#7 parts, the part returned after removing/processing the
 382      * PKCS#7 transformation */
 383     GMimeObject *unwrapped_child;
 384
 385     /* Internal: The next child for depth-first traversal and the part
 386      * number to assign it (or -1 if unknown). */
 387     int next_child;
 388     int next_part_num;
 389 };
 390
 391 /* Construct a new MIME node pointing to the root message part of
 392  * message. If crypto->verify is true, signed child parts will be
 393  * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
 394  * child parts will be decrypted using either stored session keys or
 395  * asymmetric crypto.  If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
 396  * only session keys will be tried.  If the crypto contexts
 397  * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
 398  * initialized.
 399  *
 400  * Return value:
 401  *
 402  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
 403  *
 404  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
 405  *
 406  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
 407  */
 408 notmuch_status_t
 409 mime_node_open (const void *ctx, notmuch_message_t *message,
 410                 _notmuch_crypto_t *crypto, mime_node_t **node_out);
 411
 412 /* Return a new MIME node for the requested child part of parent.
 413  * parent will be used as the talloc context for the returned child
 414  * node.
 415  *
 416  * In case of any failure, this function returns NULL, (after printing
 417  * an error message on stderr).
 418  */
 419 mime_node_t *
 420 mime_node_child (mime_node_t *parent, int child);
 421
 422 /* Return the nth child of node in a depth-first traversal.  If n is
 423 * 0, returns node itself.  Returns NULL if there is no such part. */
 424 mime_node_t *
 425 mime_node_seek_dfs (mime_node_t *node, int n);
 426
 427 const _notmuch_message_crypto_t *
 428 mime_node_get_message_crypto_status (mime_node_t *node);
 429
 430 typedef enum {
 431     DUMP_FORMAT_AUTO,
 432     DUMP_FORMAT_BATCH_TAG,
 433     DUMP_FORMAT_SUP
 434 } dump_format_t;
 435
 436 typedef enum {
 437     DUMP_INCLUDE_TAGS           = 1,
 438     DUMP_INCLUDE_CONFIG         = 2,
 439     DUMP_INCLUDE_PROPERTIES     = 4
 440 } dump_include_t;
 441
 442 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
 443
 444 #define NOTMUCH_DUMP_VERSION 3
 445
 446 int
 447 notmuch_database_dump (notmuch_database_t *notmuch,
 448                        const char *output_file_name,
 449                        const char *query_str,
 450                        dump_format_t output_format,
 451                        dump_include_t include,
 452                        bool gzip_output);
 453
 454 /* If status indicates error print appropriate
 455  * messages to stderr.
 456  */
 457
 458 notmuch_status_t
 459 print_status_query (const char *loc,
 460                     const notmuch_query_t *query,
 461                     notmuch_status_t status);
 462
 463 notmuch_status_t
 464 print_status_message (const char *loc,
 465                       const notmuch_message_t *message,
 466                       notmuch_status_t status);
 467
 468 notmuch_status_t
 469 print_status_database (const char *loc,
 470                        const notmuch_database_t *database,
 471                        notmuch_status_t status);
 472
 473 int
 474 status_to_exit (notmuch_status_t status);
 475
 476 notmuch_status_t
 477 print_status_gzbytes (const char *loc,
 478                       gzFile file,
 479                       int bytes);
 480
 481 /* the __location__ macro is defined in talloc.h */
 482 #define ASSERT_GZBYTES(file, bytes) ((print_status_gzbytes (__location__, file, bytes)) ? exit (1) : \
 483                                      0)
 484 #define GZPRINTF(file, fmt, ...) ASSERT_GZBYTES (file, gzprintf (file, fmt, ##__VA_ARGS__));
 485 #define GZPUTS(file, str) ASSERT_GZBYTES (file, gzputs (file, str));
 486
 487 #include "command-line-arguments.h"
 488
 489 extern const notmuch_opt_desc_t notmuch_shared_options [];
 490
 491 notmuch_query_syntax_t shared_option_query_syntax ();
 492
 493 void notmuch_process_shared_options (notmuch_database_t *notmuch, const char *subcommand_name);
 494 int notmuch_minimal_options (const char *subcommand_name,
 495                              int argc, char **argv);
 496
 497
 498 /* the state chosen by the user invoking one of the notmuch
 499  * subcommands that does indexing */
 500 struct _notmuch_client_indexing_cli_choices {
 501     int decrypt_policy;
 502     bool decrypt_policy_set;
 503 };
 504 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
 505 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
 506 notmuch_status_t
 507 notmuch_process_shared_indexing_options (notmuch_indexopts_t *opts);
 508
 509 #endif