From e75ed405541156ef324625810c54ab69d39b183d Mon Sep 17 00:00:00 2001 From: Peter Wang Date: Sun, 23 Jun 2013 22:20:45 +1000 Subject: [PATCH] [PATCH v7b] cli: add insert command --- d8/51eab81a174d64de9f128483da0c3cc0452021 | 468 ++++++++++++++++++++++ 1 file changed, 468 insertions(+) create mode 100644 d8/51eab81a174d64de9f128483da0c3cc0452021 diff --git a/d8/51eab81a174d64de9f128483da0c3cc0452021 b/d8/51eab81a174d64de9f128483da0c3cc0452021 new file mode 100644 index 000000000..e8bf42aef --- /dev/null +++ b/d8/51eab81a174d64de9f128483da0c3cc0452021 @@ -0,0 +1,468 @@ +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 AC87F431FBD + for ; Sun, 23 Jun 2013 05:22:12 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.799 +X-Spam-Level: +X-Spam-Status: No, score=-0.799 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_DNSWL_LOW=-0.7] 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 X0Ik+F8RTVDB for ; + Sun, 23 Jun 2013 05:22:04 -0700 (PDT) +Received: from mail-pa0-f52.google.com (mail-pa0-f52.google.com + [209.85.220.52]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 1550B431FAE + for ; Sun, 23 Jun 2013 05:22:04 -0700 (PDT) +Received: by mail-pa0-f52.google.com with SMTP id kq13so9838787pab.11 + for ; Sun, 23 Jun 2013 05:22:03 -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=pOsmMgka/CU6Vg8Kb91qx1E75PefBJNSdan0Ucanq48=; + b=gWP3bKlr8TYddXhntLIqi+CcDzAqMcVarrVdIQf+BIlYqlZ5933GGxTnVXBz6sfYG9 + WTTHwqHT9YvOZMzwRV80a2A9EcGFWYIpxxbFLub+9PefZcR3PyDzo5XQ3KOqJ54EBkcX + tSoYtVftmYOmQL+HOTmLax7awQORXXOWYU3cwlfQD3Hg9uiqsF3SmtiMfUxeu6bNLEJD + XJsmkQdlq8FpGo58Eu7WGe4khrtGBQME3eRlnLjGbJ17oMJEKZJ5ZWLzmppfQ0I3ErjN + A6HlhFs7JnLdfQsBcisS9JD6yVpG2rOXwaUa2PilHAXUHGogId/1WNW+QcDlw5zEOnx3 + p0zA== +X-Received: by 10.66.232.196 with SMTP id tq4mr24043107pac.167.1371990123313; + Sun, 23 Jun 2013 05:22:03 -0700 (PDT) +Received: from localhost (215.42.233.220.static.exetel.com.au. + [220.233.42.215]) by mx.google.com with ESMTPSA id + tq8sm13290702pbc.30.2013.06.23.05.22.00 for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sun, 23 Jun 2013 05:22:02 -0700 (PDT) +From: Peter Wang +To: notmuch@notmuchmail.org +Subject: =?UTF-8?q?=5BPATCH=20v7b=5D=20cli=3A=20add=20insert=20command?= +Date: Sun, 23 Jun 2013 22:20:45 +1000 +Message-Id: <1371990045-20890-1-git-send-email-novalazy@gmail.com> +X-Mailer: git-send-email 1.7.12.1 +In-Reply-To: <20130623221942.GA18938@hili.localdomain> +References: <20130623221942.GA18938@hili.localdomain> +MIME-Version: 1.0 +Content-Type: text/plain; charset=UTF-8 +Content-Transfer-Encoding: 8bit +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: Sun, 23 Jun 2013 12:22:12 -0000 + +The notmuch insert command reads a message from standard input, +writes it to a Maildir folder, and then incorporates the message into +the notmuch database. Essentially it moves the functionality of +notmuch-deliver into notmuch. + +Though it could be used as an alternative to notmuch new, the reason +I want this is to allow my notmuch frontend to add postponed or sent +messages to the mail store and notmuch database, without resorting to +another tool (e.g. notmuch-deliver) nor directly modifying the maildir. +--- + Makefile.local | 1 + + notmuch-client.h | 3 + + notmuch-insert.c | 337 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + notmuch.c | 2 + + 4 files changed, 343 insertions(+) + create mode 100644 notmuch-insert.c + +diff --git a/Makefile.local b/Makefile.local +index 644623f..84043fe 100644 +--- a/Makefile.local ++++ b/Makefile.local +@@ -261,6 +261,7 @@ notmuch_client_srcs = \ + notmuch-config.c \ + notmuch-count.c \ + notmuch-dump.c \ ++ notmuch-insert.c \ + notmuch-new.c \ + notmuch-reply.c \ + notmuch-restore.c \ +diff --git a/notmuch-client.h b/notmuch-client.h +index 4a3c7ac..dfe81e6 100644 +--- a/notmuch-client.h ++++ b/notmuch-client.h +@@ -181,6 +181,9 @@ int + notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]); + + int ++notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]); ++ ++int + notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]); + + int +diff --git a/notmuch-insert.c b/notmuch-insert.c +new file mode 100644 +index 0000000..1228afa +--- /dev/null ++++ b/notmuch-insert.c +@@ -0,0 +1,337 @@ ++/* notmuch - Not much of an email program, (just index and search) ++ * ++ * Copyright © 2013 Peter Wang ++ * ++ * Based in part on notmuch-deliver ++ * Copyright © 2010 Ali Polatel ++ * ++ * 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: Peter Wang ++ */ ++ ++#include "notmuch-client.h" ++#include "tag-util.h" ++ ++#include ++#include ++#include ++ ++static volatile sig_atomic_t interrupted; ++ ++static void ++handle_sigint (unused (int sig)) ++{ ++ static char msg[] = "Stopping... \n"; ++ ++ /* This write is "opportunistic", so it's okay to ignore the ++ * result. It is not required for correctness, and if it does ++ * fail or produce a short write, we want to get out of the signal ++ * handler as quickly as possible, not retry it. */ ++ IGNORE_RESULT (write (2, msg, sizeof (msg) - 1)); ++ interrupted = 1; ++} ++ ++/* Like gethostname but guarantees that a null-terminated hostname is ++ * returned, even if it has to make one up. Invalid characters are ++ * substituted such that the hostname can be used within a filename. ++ */ ++static void ++safe_gethostname (char *hostname, size_t len) ++{ ++ char *p; ++ ++ if (gethostname (hostname, len) == -1) { ++ strncpy (hostname, "unknown", len); ++ } ++ hostname[len - 1] = '\0'; ++ ++ for (p = hostname; *p != '\0'; p++) { ++ if (*p == '/' || *p == ':') ++ *p = '_'; ++ } ++} ++ ++/* Call fsync() on a directory path. */ ++static notmuch_bool_t ++sync_dir (const char *dir) ++{ ++ notmuch_bool_t ret; ++ int fd; ++ ++ fd = open (dir, O_RDONLY); ++ if (fd == -1) { ++ fprintf (stderr, "Error: open() dir failed: %s\n", strerror (errno)); ++ return FALSE; ++ } ++ ret = (fsync (fd) == 0); ++ if (! ret) { ++ fprintf (stderr, "Error: fsync() dir failed: %s\n", strerror (errno)); ++ } ++ close (fd); ++ return ret; ++} ++ ++/* Open a unique file in the 'tmp' sub-directory of dir. ++ * Returns the file descriptor on success, or -1 on failure. ++ * On success, file paths for the message in the 'tmp' and 'new' ++ * directories are returned via tmppath and newpath, ++ * and the path of the 'new' directory itself in newdir. */ ++static int ++maildir_open_tmp_file (void *ctx, const char *dir, ++ char **tmppath, char **newpath, char **newdir) ++{ ++ pid_t pid; ++ char hostname[256]; ++ struct timeval tv; ++ char *filename; ++ int fd = -1; ++ ++ /* We follow the Dovecot file name generation algorithm. */ ++ pid = getpid (); ++ safe_gethostname (hostname, sizeof (hostname)); ++ do { ++ gettimeofday (&tv, NULL); ++ filename = talloc_asprintf (ctx, "%ld.M%ldP%d.%s", ++ tv.tv_sec, tv.tv_usec, pid, hostname); ++ if (! filename) { ++ fprintf (stderr, "Out of memory\n"); ++ return -1; ++ } ++ ++ *tmppath = talloc_asprintf (ctx, "%s/tmp/%s", dir, filename); ++ if (! *tmppath) { ++ fprintf (stderr, "Out of memory\n"); ++ return -1; ++ } ++ ++ fd = open (*tmppath, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600); ++ } while (fd == -1 && errno == EEXIST); ++ ++ if (fd == -1) { ++ fprintf (stderr, "Error: opening %s: %s\n", *tmppath, strerror (errno)); ++ return -1; ++ } ++ ++ *newdir = talloc_asprintf (ctx, "%s/new", dir); ++ *newpath = talloc_asprintf (ctx, "%s/new/%s", dir, filename); ++ if (! *newdir || ! *newpath) { ++ fprintf (stderr, "Out of memory\n"); ++ close (fd); ++ unlink (*tmppath); ++ return -1; ++ } ++ ++ talloc_free (filename); ++ ++ return fd; ++} ++ ++/* Copy the contents of standard input (fdin) into fdout. ++ * Returns TRUE if a non-empty file was written successfully. ++ * Otherwise, return FALSE. */ ++static notmuch_bool_t ++copy_stdin (int fdin, int fdout) ++{ ++ notmuch_bool_t empty = TRUE; ++ ++ while (! interrupted) { ++ ssize_t remain; ++ char buf[4096]; ++ char *p; ++ ++ remain = read (fdin, buf, sizeof (buf)); ++ if (remain == 0) ++ break; ++ if (remain < 0) { ++ if (errno == EINTR) ++ continue; ++ fprintf (stderr, "Error: reading from standard input: %s\n", ++ strerror (errno)); ++ return FALSE; ++ } ++ ++ p = buf; ++ do { ++ ssize_t written = write (fdout, p, remain); ++ if (written < 0 && errno == EINTR) ++ continue; ++ if (written <= 0) { ++ fprintf (stderr, "Error: writing to temporary file: %s", ++ strerror (errno)); ++ return FALSE; ++ } ++ p += written; ++ remain -= written; ++ empty = FALSE; ++ } while (remain > 0); ++ } ++ ++ return (!interrupted && !empty); ++} ++ ++/* Add the specified message file to the notmuch database, applying tags. ++ * The file is renamed to encode notmuch tags as maildir flags. */ ++static void ++add_file_to_database (notmuch_database_t *notmuch, const char *path, ++ tag_op_list_t *tag_ops) ++{ ++ notmuch_message_t *message; ++ notmuch_status_t status; ++ ++ status = notmuch_database_add_message (notmuch, path, &message); ++ switch (status) { ++ case NOTMUCH_STATUS_SUCCESS: ++ case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: ++ break; ++ default: ++ case NOTMUCH_STATUS_FILE_NOT_EMAIL: ++ case NOTMUCH_STATUS_READ_ONLY_DATABASE: ++ case NOTMUCH_STATUS_XAPIAN_EXCEPTION: ++ case NOTMUCH_STATUS_OUT_OF_MEMORY: ++ case NOTMUCH_STATUS_FILE_ERROR: ++ case NOTMUCH_STATUS_NULL_POINTER: ++ case NOTMUCH_STATUS_TAG_TOO_LONG: ++ case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: ++ case NOTMUCH_STATUS_UNBALANCED_ATOMIC: ++ case NOTMUCH_STATUS_LAST_STATUS: ++ fprintf (stderr, "Error: failed to add `%s' to notmuch database: %s\n", ++ path, notmuch_status_to_string (status)); ++ return; ++ } ++ ++ if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) { ++ /* Don't change tags of an existing message. */ ++ status = notmuch_message_tags_to_maildir_flags (message); ++ if (status != NOTMUCH_STATUS_SUCCESS) ++ fprintf (stderr, "Error: failed to sync tags to maildir flags\n"); ++ } else { ++ tag_op_list_apply (message, tag_ops, TAG_FLAG_MAILDIR_SYNC); ++ } ++ ++ notmuch_message_destroy (message); ++} ++ ++static notmuch_bool_t ++insert_message (void *ctx, notmuch_database_t *notmuch, int fdin, ++ const char *dir, tag_op_list_t *tag_ops) ++{ ++ char *tmppath; ++ char *newpath; ++ char *newdir; ++ int fdout; ++ char *cleanup_path; ++ ++ fdout = maildir_open_tmp_file (ctx, dir, &tmppath, &newpath, &newdir); ++ if (fdout < 0) ++ return FALSE; ++ ++ cleanup_path = tmppath; ++ ++ if (! copy_stdin (fdin, fdout)) ++ goto FAIL; ++ ++ if (fsync (fdout) != 0) { ++ fprintf (stderr, "Error: fsync failed: %s\n", strerror (errno)); ++ goto FAIL; ++ } ++ ++ close (fdout); ++ fdout = -1; ++ ++ /* Atomically move the new message file from the Maildir 'tmp' directory ++ * to the 'new' directory. We follow the Dovecot recommendation to ++ * simply use rename() instead of link() and unlink(). ++ * See also: http://wiki.dovecot.org/MailboxFormat/Maildir#Mail_delivery ++ */ ++ if (rename (tmppath, newpath) != 0) { ++ fprintf (stderr, "Error: rename() failed: %s\n", strerror (errno)); ++ goto FAIL; ++ } ++ ++ cleanup_path = newpath; ++ ++ if (! sync_dir (newdir)) ++ goto FAIL; ++ ++ /* Even if adding the message to the notmuch database fails, ++ * the message is on disk and we consider the delivery completed. */ ++ add_file_to_database (notmuch, newpath, tag_ops); ++ ++ return TRUE; ++ ++ FAIL: ++ if (fdout >= 0) ++ close (fdout); ++ unlink (cleanup_path); ++ return FALSE; ++} ++ ++int ++notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]) ++{ ++ notmuch_database_t *notmuch; ++ struct sigaction action; ++ const char *db_path; ++ const char **new_tags; ++ size_t new_tags_length; ++ tag_op_list_t *tag_ops; ++ char *query_string = NULL; ++ const char *maildir; ++ int opt_index = 1; ++ unsigned int i; ++ notmuch_bool_t ret; ++ ++ db_path = notmuch_config_get_database_path (config); ++ new_tags = notmuch_config_get_new_tags (config, &new_tags_length); ++ ++ tag_ops = tag_op_list_create (config); ++ if (tag_ops == NULL) { ++ fprintf (stderr, "Out of memory.\n"); ++ return 1; ++ } ++ for (i = 0; i < new_tags_length; i++) { ++ if (tag_op_list_append (tag_ops, new_tags[i], FALSE)) ++ return 1; ++ } ++ ++ if (parse_tag_command_line (config, argc - opt_index, argv + opt_index, ++ &query_string, tag_ops)) ++ return 1; ++ ++ if (*query_string != '\0') { ++ fprintf (stderr, "Error: unexpected query string: %s\n", query_string); ++ return 1; ++ } ++ ++ maildir = db_path; ++ ++ /* Setup our handler for SIGINT. We do not set SA_RESTART so that copying ++ * from standard input may be interrupted. */ ++ memset (&action, 0, sizeof (struct sigaction)); ++ action.sa_handler = handle_sigint; ++ sigemptyset (&action.sa_mask); ++ action.sa_flags = 0; ++ sigaction (SIGINT, &action, NULL); ++ ++ if (notmuch_database_open (notmuch_config_get_database_path (config), ++ NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much)) ++ return 1; ++ ++ ret = insert_message (config, notmuch, STDIN_FILENO, maildir, tag_ops); ++ ++ notmuch_database_destroy (notmuch); ++ ++ return (ret) ? 0 : 1; ++} +diff --git a/notmuch.c b/notmuch.c +index 45a73ce..d11f214 100644 +--- a/notmuch.c ++++ b/notmuch.c +@@ -44,6 +44,8 @@ static command_t commands[] = { + "Interactively setup notmuch for first use." }, + { "new", notmuch_new_command, FALSE, + "Find and import new messages to the notmuch database." }, ++ { "insert", notmuch_insert_command, FALSE, ++ "Add a new message into the maildir and notmuch database." }, + { "search", notmuch_search_command, FALSE, + "Search for messages matching the given search terms." }, + { "show", notmuch_show_command, FALSE, +-- +1.7.12.1 + -- 2.26.2