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 http://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 /* GMIME_CHECK_VERSION in gmime 2.4 is not usable from the
  34  * preprocessor (it calls a runtime function). But since
  35  * GMIME_MAJOR_VERSION and friends were added in gmime 2.6, we can use
  36  * these to check the version number. */
  37 #ifdef GMIME_MAJOR_VERSION
  38 #define GMIME_ATLEAST_26
  39 #endif
  40
  41 #include "notmuch.h"
  42
  43 /* This is separate from notmuch-private.h because we're trying to
  44  * keep notmuch.c from looking into any internals, (which helps us
  45  * develop notmuch.h into a plausible library interface).
  46  */
  47 #include "xutil.h"
  48
  49 #include <stddef.h>
  50 #include <string.h>
  51 #include <sys/stat.h>
  52 #include <sys/time.h>
  53 #include <unistd.h>
  54 #include <dirent.h>
  55 #include <errno.h>
  56 #include <signal.h>
  57
  58 #include <talloc.h>
  59
  60 #define unused(x) x __attribute__ ((unused))
  61
  62 #define STRINGIFY(s) STRINGIFY_(s)
  63 #define STRINGIFY_(s) #s
  64
  65 typedef struct notmuch_show_format {
  66     const char *message_set_start;
  67     const char *message_start;
  68     void (*message) (const void *ctx,
  69                      notmuch_message_t *message,
  70                      int indent);
  71     const char *header_start;
  72     void (*header) (const void *ctx,
  73                     notmuch_message_t *message);
  74     void (*header_message_part) (GMimeMessage *message);
  75     const char *header_end;
  76     const char *body_start;
  77     void (*part_start) (GMimeObject *part,
  78                         int *part_count);
  79     void (*part_encstatus) (int status);
  80 #ifdef GMIME_ATLEAST_26
  81     void (*part_sigstatus) (GMimeSignatureList* siglist);
  82 #else
  83     void (*part_sigstatus) (const GMimeSignatureValidity* validity);
  84 #endif
  85     void (*part_content) (GMimeObject *part);
  86     void (*part_end) (GMimeObject *part);
  87     const char *part_sep;
  88     const char *body_end;
  89     const char *message_end;
  90     const char *message_set_sep;
  91     const char *message_set_end;
  92 } notmuch_show_format_t;
  93
  94 typedef struct notmuch_show_params {
  95     int entire_thread;
  96     int raw;
  97     int part;
  98 #ifdef GMIME_ATLEAST_26
  99     GMimeCryptoContext* cryptoctx;
 100 #else
 101     GMimeCipherContext* cryptoctx;
 102 #endif
 103     int decrypt;
 104 } notmuch_show_params_t;
 105
 106 /* There's no point in continuing when we've detected that we've done
 107  * something wrong internally (as opposed to the user passing in a
 108  * bogus value).
 109  *
 110  * Note that __location__ comes from talloc.h.
 111  */
 112 #define INTERNAL_ERROR(format, ...)                     \
 113     do {                                                \
 114         fprintf(stderr,                                 \
 115                 "Internal error: " format " (%s)\n",    \
 116                 ##__VA_ARGS__, __location__);           \
 117         exit (1);                                       \
 118     } while (0)
 119
 120 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
 121
 122 #define STRNCMP_LITERAL(var, literal) \
 123     strncmp ((var), (literal), sizeof (literal) - 1)
 124
 125 static inline void
 126 chomp_newline (char *str)
 127 {
 128     if (str && str[strlen(str)-1] == '\n')
 129         str[strlen(str)-1] = '\0';
 130 }
 131
 132 int
 133 notmuch_count_command (void *ctx, int argc, char *argv[]);
 134
 135 int
 136 notmuch_dump_command (void *ctx, int argc, char *argv[]);
 137
 138 int
 139 notmuch_new_command (void *ctx, int argc, char *argv[]);
 140
 141 int
 142 notmuch_reply_command (void *ctx, int argc, char *argv[]);
 143
 144 int
 145 notmuch_restore_command (void *ctx, int argc, char *argv[]);
 146
 147 int
 148 notmuch_search_command (void *ctx, int argc, char *argv[]);
 149
 150 int
 151 notmuch_setup_command (void *ctx, int argc, char *argv[]);
 152
 153 int
 154 notmuch_show_command (void *ctx, int argc, char *argv[]);
 155
 156 int
 157 notmuch_tag_command (void *ctx, int argc, char *argv[]);
 158
 159 int
 160 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
 161
 162 int
 163 notmuch_cat_command (void *ctx, int argc, char *argv[]);
 164
 165 int
 166 notmuch_config_command (void *ctx, int argc, char *argv[]);
 167
 168 const char *
 169 notmuch_time_relative_date (const void *ctx, time_t then);
 170
 171 void
 172 notmuch_time_print_formatted_seconds (double seconds);
 173
 174 double
 175 notmuch_time_elapsed (struct timeval start, struct timeval end);
 176
 177 char *
 178 query_string_from_args (void *ctx, int argc, char *argv[]);
 179
 180 notmuch_status_t
 181 show_message_body (notmuch_message_t *message,
 182                    const notmuch_show_format_t *format,
 183                    notmuch_show_params_t *params);
 184
 185 notmuch_status_t
 186 show_one_part (const char *filename, int part);
 187
 188 char *
 189 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 190
 191 char *
 192 json_quote_str (const void *ctx, const char *str);
 193
 194 /* notmuch-config.c */
 195
 196 typedef struct _notmuch_config notmuch_config_t;
 197
 198 notmuch_config_t *
 199 notmuch_config_open (void *ctx,
 200                      const char *filename,
 201                      notmuch_bool_t *is_new_ret);
 202
 203 void
 204 notmuch_config_close (notmuch_config_t *config);
 205
 206 int
 207 notmuch_config_save (notmuch_config_t *config);
 208
 209 const char *
 210 notmuch_config_get_database_path (notmuch_config_t *config);
 211
 212 void
 213 notmuch_config_set_database_path (notmuch_config_t *config,
 214                                   const char *database_path);
 215
 216 const char *
 217 notmuch_config_get_user_name (notmuch_config_t *config);
 218
 219 void
 220 notmuch_config_set_user_name (notmuch_config_t *config,
 221                               const char *user_name);
 222
 223 const char *
 224 notmuch_config_get_user_primary_email (notmuch_config_t *config);
 225
 226 void
 227 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 228                                        const char *primary_email);
 229
 230 const char **
 231 notmuch_config_get_user_other_email (notmuch_config_t *config,
 232                                      size_t *length);
 233
 234 void
 235 notmuch_config_set_user_other_email (notmuch_config_t *config,
 236                                      const char *other_email[],
 237                                      size_t length);
 238
 239 const char **
 240 notmuch_config_get_new_tags (notmuch_config_t *config,
 241                              size_t *length);
 242 void
 243 notmuch_config_set_new_tags (notmuch_config_t *config,
 244                              const char *new_tags[],
 245                              size_t length);
 246
 247 notmuch_bool_t
 248 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
 249
 250 void
 251 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
 252                                               notmuch_bool_t synchronize_flags);
 253
 254 const char **
 255 notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length);
 256
 257 void
 258 notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
 259                                       const char *list[],
 260                                       size_t length);
 261
 262 int
 263 notmuch_run_hook (const char *db_path, const char *hook);
 264
 265 notmuch_bool_t
 266 debugger_is_active (void);
 267
 268 /* mime-node.c */
 269
 270 /* mime_node_t represents a single node in a MIME tree.  A MIME tree
 271  * abstracts the different ways of traversing different types of MIME
 272  * parts, allowing a MIME message to be viewed as a generic tree of
 273  * parts.  Message-type parts have one child, multipart-type parts
 274  * have multiple children, and leaf parts have zero children.
 275  */
 276 typedef struct mime_node {
 277     /* The MIME object of this part.  This will be a GMimeMessage,
 278      * GMimePart, GMimeMultipart, or a subclass of one of these.
 279      *
 280      * This will never be a GMimeMessagePart because GMimeMessagePart
 281      * is structurally redundant with GMimeMessage.  If this part is a
 282      * message (that is, 'part' is a GMimeMessage), then either
 283      * envelope_file will be set to a notmuch_message_t (for top-level
 284      * messages) or envelope_part will be set to a GMimeMessagePart
 285      * (for embedded message parts).
 286      */
 287     GMimeObject *part;
 288
 289     /* If part is a GMimeMessage, these record the envelope of the
 290      * message: either a notmuch_message_t representing a top-level
 291      * message, or a GMimeMessagePart representing a MIME part
 292      * containing a message.
 293      */
 294     notmuch_message_t *envelope_file;
 295     GMimeMessagePart *envelope_part;
 296
 297     /* The number of children of this part. */
 298     int nchildren;
 299
 300     /* True if decryption of this part was attempted. */
 301     notmuch_bool_t decrypt_attempted;
 302     /* True if decryption of this part's child succeeded.  In this
 303      * case, the decrypted part is substituted for the second child of
 304      * this part (which would usually be the encrypted data). */
 305     notmuch_bool_t decrypt_success;
 306
 307     /* True if signature verification on this part was attempted. */
 308     notmuch_bool_t verify_attempted;
 309 #ifdef GMIME_ATLEAST_26
 310     /* The list of signatures for signed or encrypted containers. If
 311      * there are no signatures, this will be NULL. */
 312     GMimeSignatureList* sig_list;
 313 #else
 314     /* For signed or encrypted containers, the validity of the
 315      * signature.  May be NULL if signature verification failed.  If
 316      * there are simply no signatures, this will be non-NULL with an
 317      * empty signers list. */
 318     const GMimeSignatureValidity *sig_validity;
 319 #endif
 320
 321     /* Internal: Context inherited from the root iterator. */
 322     struct mime_node_context *ctx;
 323
 324     /* Internal: For successfully decrypted multipart parts, the
 325      * decrypted part to substitute for the second child. */
 326     GMimeObject *decrypted_child;
 327 } mime_node_t;
 328
 329 /* Construct a new MIME node pointing to the root message part of
 330  * message.  If cryptoctx is non-NULL, it will be used to verify
 331  * signatures on any child parts.  If decrypt is true, then cryptoctx
 332  * will additionally be used to decrypt any encrypted child parts.
 333  *
 334  * Return value:
 335  *
 336  * NOTMUCH_STATUS_SUCCESS: Root node is returned in *node_out.
 337  *
 338  * NOTMUCH_STATUS_FILE_ERROR: Failed to open message file.
 339  *
 340  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
 341  */
 342 notmuch_status_t
 343 mime_node_open (const void *ctx, notmuch_message_t *message,
 344 #ifdef GMIME_ATLEAST_26
 345                 GMimeCryptoContext *cryptoctx,
 346 #else
 347                 GMimeCipherContext *cryptoctx,
 348 #endif
 349                 notmuch_bool_t decrypt, mime_node_t **node_out);
 350
 351 /* Return a new MIME node for the requested child part of parent.
 352  * parent will be used as the talloc context for the returned child
 353  * node.
 354  *
 355  * In case of any failure, this function returns NULL, (after printing
 356  * an error message on stderr).
 357  */
 358 mime_node_t *
 359 mime_node_child (const mime_node_t *parent, int child);
 360
 361 /* Return the nth child of node in a depth-first traversal.  If n is
 362  * 0, returns node itself.  Returns NULL if there is no such part. */
 363 mime_node_t *
 364 mime_node_seek_dfs (mime_node_t *node, int n);
 365
 366 #include "command-line-arguments.h"
 367 #endif