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