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