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