[RFC PATCH 01/14] All access to mail files goes through the mailstore module
Mark Walters
markwalters1009 at gmail.com
Thu Jun 28 13:48:03 PDT 2012
On Mon, 25 Jun 2012, Ethan Glasser-Camp <ethan.glasser.camp at gmail.com> wrote:
> This commit introduces the mailstore module which provides two
> functions, notmuch_mailstore_open and notmuch_mailstore_close. These
> functions are currently just stub calls to fopen and fclose, but later
> can be made more complex in order to support mail storage systems
> where one message might not be one file.
I would prefer this patch split into two: one doing the stuff mentioned
in the commit message and one the notmuch_sha1_of_message/
notmuch_sha1_of_file change (or at least mention this latter change in
the commit message).
Best wishes
Mark
> Signed-off-by: Ethan Glasser-Camp <ethan at betacantrips.com>
> ---
> lib/Makefile.local | 1 +
> lib/database.cc | 2 +-
> lib/index.cc | 2 +-
> lib/mailstore.c | 34 ++++++++++++++++++++++++
> lib/message-file.c | 6 ++---
> lib/notmuch-private.h | 3 +++
> lib/notmuch.h | 16 +++++++++++
> lib/sha1.c | 70 +++++++++++++++++++++++++++++++++++++------------
> mime-node.c | 4 +--
> notmuch-show.c | 12 ++++-----
> 10 files changed, 120 insertions(+), 30 deletions(-)
> create mode 100644 lib/mailstore.c
>
> diff --git a/lib/Makefile.local b/lib/Makefile.local
> index 8a9aa28..cfc77bb 100644
> --- a/lib/Makefile.local
> +++ b/lib/Makefile.local
> @@ -51,6 +51,7 @@ libnotmuch_c_srcs = \
> $(dir)/filenames.c \
> $(dir)/string-list.c \
> $(dir)/libsha1.c \
> + $(dir)/mailstore.c \
> $(dir)/message-file.c \
> $(dir)/messages.c \
> $(dir)/sha1.c \
> diff --git a/lib/database.cc b/lib/database.cc
> index 761dc1a..c035edc 100644
> --- a/lib/database.cc
> +++ b/lib/database.cc
> @@ -1773,7 +1773,7 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
> if (message_id == NULL ) {
> /* No message-id at all, let's generate one by taking a
> * hash over the file's contents. */
> - char *sha1 = notmuch_sha1_of_file (filename);
> + char *sha1 = notmuch_sha1_of_message (filename);
>
> /* If that failed too, something is really wrong. Give up. */
> if (sha1 == NULL) {
> diff --git a/lib/index.cc b/lib/index.cc
> index e377732..b607e82 100644
> --- a/lib/index.cc
> +++ b/lib/index.cc
> @@ -441,7 +441,7 @@ _notmuch_message_index_file (notmuch_message_t *message,
> initialized = 1;
> }
>
> - file = fopen (filename, "r");
> + file = notmuch_mailstore_open (filename);
> if (! file) {
> fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
> ret = NOTMUCH_STATUS_FILE_ERROR;
> diff --git a/lib/mailstore.c b/lib/mailstore.c
> new file mode 100644
> index 0000000..48acd47
> --- /dev/null
> +++ b/lib/mailstore.c
> @@ -0,0 +1,34 @@
> +/* mailstore.c - code to access individual messages
> + *
> + * Copyright © 2009 Carl Worth
> + *
> + * 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 http://www.gnu.org/licenses/ .
> + *
> + * Author: Carl Worth <cworth at cworth.org>
> + */
> +#include <stdio.h>
> +
> +#include "notmuch-private.h"
> +
> +FILE *
> +notmuch_mailstore_open (const char *filename)
> +{
> + return fopen (filename, "r");
> +}
> +
> +int
> +notmuch_mailstore_close (FILE *file)
> +{
> + return fclose (file);
> +}
> diff --git a/lib/message-file.c b/lib/message-file.c
> index 915aba8..271389c 100644
> --- a/lib/message-file.c
> +++ b/lib/message-file.c
> @@ -86,7 +86,7 @@ _notmuch_message_file_destructor (notmuch_message_file_t *message)
> g_hash_table_destroy (message->headers);
>
> if (message->file)
> - fclose (message->file);
> + notmuch_mailstore_close (message->file);
>
> return 0;
> }
> @@ -104,7 +104,7 @@ _notmuch_message_file_open_ctx (void *ctx, const char *filename)
>
> talloc_set_destructor (message, _notmuch_message_file_destructor);
>
> - message->file = fopen (filename, "r");
> + message->file = notmuch_mailstore_open (filename);
> if (message->file == NULL)
> goto FAIL;
>
> @@ -361,7 +361,7 @@ notmuch_message_file_get_header (notmuch_message_file_t *message,
> }
>
> if (message->parsing_finished) {
> - fclose (message->file);
> + notmuch_mailstore_close (message->file);
> message->file = NULL;
> }
>
> diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h
> index bfb4111..5dbe821 100644
> --- a/lib/notmuch-private.h
> +++ b/lib/notmuch-private.h
> @@ -468,6 +468,9 @@ notmuch_sha1_of_string (const char *str);
> char *
> notmuch_sha1_of_file (const char *filename);
>
> +char *
> +notmuch_sha1_of_message (const char *filename);
> +
> /* string-list.c */
>
> typedef struct _notmuch_string_node {
> diff --git a/lib/notmuch.h b/lib/notmuch.h
> index 3633bed..0ca367b 100644
> --- a/lib/notmuch.h
> +++ b/lib/notmuch.h
> @@ -1233,6 +1233,22 @@ notmuch_message_thaw (notmuch_message_t *message);
> void
> notmuch_message_destroy (notmuch_message_t *message);
>
> +/* Get access to the underlying data of a message.
> + *
> + * Right now, all messages are simple files in maildirs, but this is
> + * hopefully subject to change.
> + *
> + * If the returned FILE* is not NULL, be sure to call
> + * notmuch_mailstore_close when you're done with it.
> + */
> +FILE *
> +notmuch_mailstore_open (const char *filename);
> +
> +/* Release any resources associated with this file.
> + */
> +int
> +notmuch_mailstore_close (FILE *file);
> +
> /* Is the given 'tags' iterator pointing at a valid tag.
> *
> * When this function returns TRUE, notmuch_tags_get will return a
> diff --git a/lib/sha1.c b/lib/sha1.c
> index cc48108..462c07e 100644
> --- a/lib/sha1.c
> +++ b/lib/sha1.c
> @@ -64,19 +64,11 @@ notmuch_sha1_of_string (const char *str)
> return _hex_of_sha1_digest (digest);
> }
>
> -/* Create a hexadecimal string version of the SHA-1 digest of the
> - * contents of the named file.
> - *
> - * This function returns a newly allocated string which the caller
> - * should free() when finished.
> - *
> - * If any error occurs while reading the file, (permission denied,
> - * file not found, etc.), this function returns NULL.
> +/* Internal function to feed the contents of a FILE * to the sha1 functions.
> */
> -char *
> -notmuch_sha1_of_file (const char *filename)
> -{
> - FILE *file;
> +
> +static char *
> +_notmuch_sha1_of_filep (FILE *file){
> #define BLOCK_SIZE 4096
> unsigned char block[BLOCK_SIZE];
> size_t bytes_read;
> @@ -84,14 +76,10 @@ notmuch_sha1_of_file (const char *filename)
> unsigned char digest[SHA1_DIGEST_SIZE];
> char *result;
>
> - file = fopen (filename, "r");
> - if (file == NULL)
> - return NULL;
> -
> sha1_begin (&sha1);
>
> while (1) {
> - bytes_read = fread (block, 1, 4096, file);
> + bytes_read = fread (block, 1, BLOCK_SIZE, file);
> if (bytes_read == 0) {
> if (feof (file)) {
> break;
> @@ -108,8 +96,56 @@ notmuch_sha1_of_file (const char *filename)
>
> result = _hex_of_sha1_digest (digest);
>
> + return result;
> +}
> +
> +/* Create a hexadecimal string version of the SHA-1 digest of the
> + * contents of the named file.
> + *
> + * This function returns a newly allocated string which the caller
> + * should free() when finished.
> + *
> + * If any error occurs while reading the file, (permission denied,
> + * file not found, etc.), this function returns NULL.
> + */
> +char *
> +notmuch_sha1_of_file (const char *filename)
> +{
> + FILE *file;
> + char *result;
> + file = fopen (filename, "r");
> + if (file == NULL)
> + return NULL;
> +
> + result = _notmuch_sha1_of_filep (file);
> +
> fclose (file);
>
> return result;
> }
>
> +/* Create a hexadecimal string version of the SHA-1 digest of the
> + * contents of the named message, which is accessed via a mailstore.
> + *
> + * This function returns a newly allocated string which the caller
> + * should free() when finished.
> + *
> + * If any error occurs while reading the file, (permission denied,
> + * file not found, etc.), this function returns NULL.
> + */
> +char *
> +notmuch_sha1_of_message (const char *filename)
> +{
> + FILE *file;
> + char *result;
> +
> + file = notmuch_mailstore_open (filename);
> + if (file == NULL)
> + return NULL;
> +
> + result = _notmuch_sha1_of_filep (file);
> +
> + notmuch_mailstore_close (file);
> +
> + return result;
> +}
> diff --git a/mime-node.c b/mime-node.c
> index 97e8b48..a5c60d0 100644
> --- a/mime-node.c
> +++ b/mime-node.c
> @@ -49,7 +49,7 @@ _mime_node_context_free (mime_node_context_t *res)
> g_object_unref (res->stream);
>
> if (res->file)
> - fclose (res->file);
> + notmuch_mailstore_close (res->file);
>
> return 0;
> }
> @@ -79,7 +79,7 @@ mime_node_open (const void *ctx, notmuch_message_t *message,
> }
> talloc_set_destructor (mctx, _mime_node_context_free);
>
> - mctx->file = fopen (filename, "r");
> + mctx->file = notmuch_mailstore_open (filename);
> if (! mctx->file) {
> fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
> status = NOTMUCH_STATUS_FILE_ERROR;
> diff --git a/notmuch-show.c b/notmuch-show.c
> index 8247f1d..2847d25 100644
> --- a/notmuch-show.c
> +++ b/notmuch-show.c
> @@ -692,7 +692,7 @@ format_part_mbox (const void *ctx, mime_node_t *node, unused (int indent),
> INTERNAL_ERROR ("format_part_mbox requires a root part");
>
> filename = notmuch_message_get_filename (message);
> - file = fopen (filename, "r");
> + file = notmuch_mailstore_open (filename);
> if (file == NULL) {
> fprintf (stderr, "Failed to open %s: %s\n",
> filename, strerror (errno));
> @@ -716,7 +716,7 @@ format_part_mbox (const void *ctx, mime_node_t *node, unused (int indent),
>
> printf ("\n");
>
> - fclose (file);
> + notmuch_mailstore_close (file);
>
> return NOTMUCH_STATUS_SUCCESS;
> }
> @@ -739,7 +739,7 @@ format_part_raw (unused (const void *ctx), mime_node_t *node,
> return NOTMUCH_STATUS_FILE_ERROR;
> }
>
> - file = fopen (filename, "r");
> + file = notmuch_mailstore_open (filename);
> if (file == NULL) {
> fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
> return NOTMUCH_STATUS_FILE_ERROR;
> @@ -749,18 +749,18 @@ format_part_raw (unused (const void *ctx), mime_node_t *node,
> size = fread (buf, 1, sizeof (buf), file);
> if (ferror (file)) {
> fprintf (stderr, "Error: Read failed from %s\n", filename);
> - fclose (file);
> + notmuch_mailstore_close (file);
> return NOTMUCH_STATUS_FILE_ERROR;
> }
>
> if (fwrite (buf, size, 1, stdout) != 1) {
> fprintf (stderr, "Error: Write failed\n");
> - fclose (file);
> + notmuch_mailstore_close (file);
> return NOTMUCH_STATUS_FILE_ERROR;
> }
> }
>
> - fclose (file);
> + notmuch_mailstore_close (file);
> return NOTMUCH_STATUS_SUCCESS;
> }
>
> --
> 1.7.9.5
>
> _______________________________________________
> notmuch mailing list
> notmuch at notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch
More information about the notmuch
mailing list