diff options
author | Daniel Kahn Gillmor <dkg@fifthhorseman.net> | 2019-08-29 11:38:47 -0400 |
---|---|---|
committer | David Bremner <david@tethera.net> | 2019-09-01 08:20:25 -0300 |
commit | 1b29822cf55eb53e1d45a71c2a3e4a2c2a4574d1 (patch) | |
tree | 7c8042ad6a3ecd9572c169dadc5eb565f7e12b0a | |
parent | dcfa2fc99667467011516a3223f7889c05955746 (diff) |
repair: set up codebase for repair functionality
This adds no functionality directly, but is a useful starting point
for adding new repair functionality.
Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
-rw-r--r-- | doc/man7/notmuch-properties.rst | 12 | ||||
-rw-r--r-- | lib/notmuch-private.h | 1 | ||||
-rw-r--r-- | notmuch-client.h | 1 | ||||
-rw-r--r-- | util/Makefile.local | 1 | ||||
-rw-r--r-- | util/repair.c | 21 | ||||
-rw-r--r-- | util/repair.h | 17 |
6 files changed, 53 insertions, 0 deletions
diff --git a/doc/man7/notmuch-properties.rst b/doc/man7/notmuch-properties.rst index 802e6763..2e610683 100644 --- a/doc/man7/notmuch-properties.rst +++ b/doc/man7/notmuch-properties.rst @@ -109,6 +109,18 @@ of its normal activity. example, an AES-128 key might be stashed in a notmuch property as: ``session-key=7:14B16AF65536C28AF209828DFE34C9E0``. +**index.repaired** + + Some messages arrive in forms that are confusing to view; they can + be mangled by mail transport agents, or the sending mail user + agent may structure them in a way that is confusing. If notmuch + knows how to both detect and repair such a problematic message, it + will do so during indexing. + + If it applies a message repair during indexing, it will use the + ``index.repaired`` property to note the type of repair(s) it + performed. + SEE ALSO ======== diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h index 9bdb68ab..28ced3a2 100644 --- a/lib/notmuch-private.h +++ b/lib/notmuch-private.h @@ -53,6 +53,7 @@ NOTMUCH_BEGIN_DECLS #include "error_util.h" #include "string-util.h" #include "crypto.h" +#include "repair.h" #ifdef DEBUG # define DEBUG_DATABASE_SANITY 1 diff --git a/notmuch-client.h b/notmuch-client.h index d1b78017..74690054 100644 --- a/notmuch-client.h +++ b/notmuch-client.h @@ -52,6 +52,7 @@ #include "talloc-extra.h" #include "crypto.h" +#include "repair.h" #define unused(x) x ## _unused __attribute__ ((unused)) diff --git a/util/Makefile.local b/util/Makefile.local index 46f8af3a..f5d72f79 100644 --- a/util/Makefile.local +++ b/util/Makefile.local @@ -6,6 +6,7 @@ extra_cflags += -I$(srcdir)/$(dir) libnotmuch_util_c_srcs := $(dir)/xutil.c $(dir)/error_util.c $(dir)/hex-escape.c \ $(dir)/string-util.c $(dir)/talloc-extra.c $(dir)/zlib-extra.c \ $(dir)/util.c $(dir)/gmime-extra.c $(dir)/crypto.c \ + $(dir)/repair.c \ $(dir)/unicode-util.c libnotmuch_util_modules := $(libnotmuch_util_c_srcs:.c=.o) diff --git a/util/repair.c b/util/repair.c new file mode 100644 index 00000000..f91c1244 --- /dev/null +++ b/util/repair.c @@ -0,0 +1,21 @@ +/* notmuch - Not much of an email program, (just index and search) + * + * Copyright © 2019 Daniel Kahn Gillmor + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see https://www.gnu.org/licenses/ . + * + * Authors: Daniel Kahn Gillmor <dkg@fifthhorseman.net> + */ + +#include "repair.h" diff --git a/util/repair.h b/util/repair.h new file mode 100644 index 00000000..70e2b7bc --- /dev/null +++ b/util/repair.h @@ -0,0 +1,17 @@ +#ifndef _REPAIR_H +#define _REPAIR_H + +#include "gmime-extra.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/* This is a collection of message structure and message format repair + * techniques that are designed to improve the user experience of + * notmuch */ + +#ifdef __cplusplus +} +#endif +#endif |