From 459544dde224afdfbf106d2a5aeb390b11af90ad Mon Sep 17 00:00:00 2001 From: Ethan Glasser-Camp Date: Tue, 26 Jun 2012 16:41:26 +2000 Subject: [PATCH] [RFC PATCH 01/14] All access to mail files goes through the mailstore module --- 8a/4ca85a52530ab73356039501e980330ac1ef67 | 418 ++++++++++++++++++++++ 1 file changed, 418 insertions(+) create mode 100644 8a/4ca85a52530ab73356039501e980330ac1ef67 diff --git a/8a/4ca85a52530ab73356039501e980330ac1ef67 b/8a/4ca85a52530ab73356039501e980330ac1ef67 new file mode 100644 index 000000000..dfc4b0332 --- /dev/null +++ b/8a/4ca85a52530ab73356039501e980330ac1ef67 @@ -0,0 +1,418 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 02198431FB6 + for ; Mon, 25 Jun 2012 13:42:23 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 1.061 +X-Spam-Level: * +X-Spam-Status: No, score=1.061 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_FROM=0.001, RCVD_IN_BL_SPAMCOP_NET=1.246, + RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_SORBS_WEB=0.614] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id HNCt9uOexQxJ for ; + Mon, 25 Jun 2012 13:42:22 -0700 (PDT) +Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com + [74.125.82.45]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client + certificate requested) by olra.theworths.org (Postfix) with ESMTPS id + 55CEA431FAF for ; Mon, 25 Jun 2012 13:42:22 -0700 + (PDT) +Received: by mail-wg0-f45.google.com with SMTP id dt14so3702167wgb.2 + for ; Mon, 25 Jun 2012 13:42:22 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references + :mime-version:content-type:content-transfer-encoding; + bh=y2Aq3cuCvohCZpgJoMJlo6niZDIsTkvXjckBUhToqLo=; + b=aMPsBYBAy1u9jtZt+kJhPkIkHsVBKj62Ye1ekrA23+1CFi3dhDlLjZMyP0KA+yQ0Ny + 2NMYDCwtuia1lEBgrf9YniVmJPe7EG+eXdPGyQaO5Y3mWrzMXk4cLY1wejvgPBOoUrj6 + 8AVJPdH9OnYFFBYPQ441m8hZPLBl3nmfboiWbzJAS+gWINhOHMJiEN8tmFd8cZMNV3mo + K7gNwgw8UB82JxgqhZJx4G+ukjUiqWrgWJYnL2CwnvYaesrmL1tx4BeCirnIDbZLZhXi + ZLJI56xXx6NoxGDCdZQR6T2sX28405HEOh+x3vsoq3CbOqKANDGAMNm+zQverGjPwpa+ + r3Lg== +Received: by 10.180.8.41 with SMTP id o9mr27141363wia.0.1340656941888; + Mon, 25 Jun 2012 13:42:21 -0700 (PDT) +Received: from localhost ([195.24.209.21]) + by mx.google.com with ESMTPS id bg10sm12236082wib.9.2012.06.25.13.42.13 + (version=TLSv1/SSLv3 cipher=OTHER); + Mon, 25 Jun 2012 13:42:20 -0700 (PDT) +From: Ethan Glasser-Camp +To: notmuch@notmuchmail.org +Subject: + [RFC PATCH 01/14] All access to mail files goes through the mailstore module +Date: Mon, 25 Jun 2012 16:41:26 -0400 +Message-Id: <1340656899-5644-2-git-send-email-ethan@betacantrips.com> +X-Mailer: git-send-email 1.7.9.5 +In-Reply-To: <1340656899-5644-1-git-send-email-ethan@betacantrips.com> +References: <1340656899-5644-1-git-send-email-ethan@betacantrips.com> +MIME-Version: 1.0 +Content-Type: text/plain; charset=UTF-8 +Content-Transfer-Encoding: 8bit +X-Mailman-Approved-At: Tue, 26 Jun 2012 03:51:54 -0700 +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Mon, 25 Jun 2012 20:42:24 -0000 + +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. + +Signed-off-by: Ethan Glasser-Camp +--- + 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 ++ */ ++#include ++ ++#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 + -- 2.26.2