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                       int duplicate,
 234                       bool output_body,
 235                       bool include_html);
 236
 237 void
 238 format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,
 239                          bool reply, const _notmuch_message_crypto_t *msg_crypto);
 240
 241 typedef enum {
 242     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,
 243 } notmuch_show_text_part_flags;
 244
 245 void
 246 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
 247                         notmuch_show_text_part_flags flags);
 248
 249 char *
 250 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 251
 252 char *
 253 json_quote_str (const void *ctx, const char *str);
 254
 255 /* notmuch-client-init.c */
 256
 257 void notmuch_client_init (void);
 258
 259 /* notmuch-config.c */
 260
 261 typedef enum {
 262     NOTMUCH_COMMAND_CONFIG_CREATE       = 1 << 1,
 263     NOTMUCH_COMMAND_DATABASE_EARLY      = 1 << 2,
 264     NOTMUCH_COMMAND_DATABASE_WRITE      = 1 << 3,
 265     NOTMUCH_COMMAND_DATABASE_CREATE     = 1 << 4,
 266     NOTMUCH_COMMAND_CONFIG_LOAD         = 1 << 5,
 267 } notmuch_command_mode_t;
 268
 269 notmuch_conffile_t *
 270 notmuch_conffile_open (notmuch_database_t *notmuch,
 271                        const char *filename,
 272                        bool create);
 273
 274 void
 275 notmuch_conffile_close (notmuch_conffile_t *config);
 276
 277 int
 278 notmuch_conffile_save (notmuch_conffile_t *config);
 279
 280 bool
 281 notmuch_conffile_is_new (notmuch_conffile_t *config);
 282
 283 void
 284 notmuch_conffile_set_database_path (notmuch_conffile_t *config,
 285                                     const char *database_path);
 286
 287 void
 288 notmuch_conffile_set_user_name (notmuch_conffile_t *config,
 289                                 const char *user_name);
 290
 291 void
 292 notmuch_conffile_set_user_primary_email (notmuch_conffile_t *config,
 293                                          const char *primary_email);
 294
 295 void
 296 notmuch_conffile_set_user_other_email (notmuch_conffile_t *config,
 297                                        const char *other_email[],
 298                                        size_t length);
 299
 300 void
 301 notmuch_conffile_set_new_tags (notmuch_conffile_t *config,
 302                                const char *new_tags[],
 303                                size_t length);
 304
 305 void
 306 notmuch_conffile_set_new_ignore (notmuch_conffile_t *config,
 307                                  const char *new_ignore[],
 308                                  size_t length);
 309
 310 void
 311 notmuch_conffile_set_maildir_synchronize_flags (notmuch_conffile_t *config,
 312                                                 bool synchronize_flags);
 313
 314 void
 315 notmuch_conffile_set_search_exclude_tags (notmuch_conffile_t *config,
 316                                           const char *list[],
 317                                           size_t length);
 318 int
 319 notmuch_run_hook (notmuch_database_t *notmuch, const char *hook);
 320
 321 bool
 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     bool 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     bool decrypt_success;
 369
 370     /* True if signature verification on this part was attempted. */
 371     bool verify_attempted;
 372
 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
 377     /* Internal: Context inherited from the root iterator. */
 378     struct mime_node_context *ctx;
 379
 380     /* Internal: For successfully decrypted multipart parts, the
 381      * decrypted part to substitute for the second child; or, for
 382      * PKCS#7 parts, the part returned after removing/processing the
 383      * PKCS#7 transformation */
 384     GMimeObject *unwrapped_child;
 385
 386     /* Internal: The next child for depth-first traversal and the part
 387      * number to assign it (or -1 if unknown). */
 388     int next_child;
 389     int next_part_num;
 390 };
 391
 392 /* Construct a new MIME node pointing to the root message part of
 393  * message. Use the duplicate-th filename if that parameter is
 394  * positive. If crypto->verify is true, signed child parts will be
 395  * verified. If crypto->decrypt is NOTMUCH_DECRYPT_TRUE, encrypted
 396  * child parts will be decrypted using either stored session keys or
 397  * asymmetric crypto.  If crypto->decrypt is NOTMUCH_DECRYPT_AUTO,
 398  * only session keys will be tried.  If the crypto contexts
 399  * (crypto->gpgctx or crypto->pkcs7) are NULL, they will be lazily
 400  * initialized.
 401  *
 402  * Return value:
 403  *
 404  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
 405  *
 406  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
 407  *
 408  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
 409  */
 410 notmuch_status_t
 411 mime_node_open (const void *ctx, notmuch_message_t *message,
 412                 int duplicate,
 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 const _notmuch_message_crypto_t *
 431 mime_node_get_message_crypto_status (mime_node_t *node);
 432
 433 typedef enum {
 434     DUMP_FORMAT_AUTO,
 435     DUMP_FORMAT_BATCH_TAG,
 436     DUMP_FORMAT_SUP
 437 } dump_format_t;
 438
 439 typedef enum {
 440     DUMP_INCLUDE_TAGS           = 1,
 441     DUMP_INCLUDE_CONFIG         = 2,
 442     DUMP_INCLUDE_PROPERTIES     = 4
 443 } dump_include_t;
 444
 445 #define DUMP_INCLUDE_DEFAULT (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES)
 446
 447 #define NOTMUCH_DUMP_VERSION 3
 448
 449 int
 450 notmuch_database_dump (notmuch_database_t *notmuch,
 451                        const char *output_file_name,
 452                        const char *query_str,
 453                        dump_format_t output_format,
 454                        dump_include_t include,
 455                        bool gzip_output);
 456
 457 /* If status indicates error print appropriate
 458  * messages to stderr.
 459  */
 460
 461 notmuch_status_t
 462 print_status_query (const char *loc,
 463                     const notmuch_query_t *query,
 464                     notmuch_status_t status);
 465
 466 notmuch_status_t
 467 print_status_message (const char *loc,
 468                       const notmuch_message_t *message,
 469                       notmuch_status_t status);
 470
 471 notmuch_status_t
 472 print_status_database (const char *loc,
 473                        const notmuch_database_t *database,
 474                        notmuch_status_t status);
 475
 476 int
 477 status_to_exit (notmuch_status_t status);
 478
 479 notmuch_status_t
 480 print_status_gzbytes (const char *loc,
 481                       gzFile file,
 482                       int bytes);
 483
 484 /* the __location__ macro is defined in talloc.h */
 485 #define ASSERT_GZBYTES(file, bytes) ((print_status_gzbytes (__location__, file, bytes)) ? exit (1) : \
 486                                      0)
 487 #define GZPRINTF(file, fmt, ...) ASSERT_GZBYTES (file, gzprintf (file, fmt, ##__VA_ARGS__));
 488 #define GZPUTS(file, str) ASSERT_GZBYTES (file, gzputs (file, str));
 489
 490 #include "command-line-arguments.h"
 491
 492 extern const notmuch_opt_desc_t notmuch_shared_options [];
 493
 494 notmuch_query_syntax_t shared_option_query_syntax ();
 495
 496 void notmuch_process_shared_options (notmuch_database_t *notmuch, const char *subcommand_name);
 497 int notmuch_minimal_options (const char *subcommand_name,
 498                              int argc, char **argv);
 499
 500
 501 /* the state chosen by the user invoking one of the notmuch
 502  * subcommands that does indexing */
 503 struct _notmuch_client_indexing_cli_choices {
 504     int decrypt_policy;
 505     bool decrypt_policy_set;
 506 };
 507 extern struct _notmuch_client_indexing_cli_choices indexing_cli_choices;
 508 extern const notmuch_opt_desc_t notmuch_shared_indexing_options [];
 509 notmuch_status_t
 510 notmuch_process_shared_indexing_options (notmuch_indexopts_t *opts);
 511
 512 #endif