From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Subject: [PATCH v3 1/2] cli: introduce the concept of user defined hooks
Date: Tue, 6 Dec 2011 15:22:37 +0200 [thread overview]
Message-ID: <f1ea48544f712c54bbb14d167c14869b2cd6a6d7.1323176771.git.jani@nikula.org> (raw)
In-Reply-To: <cover.1323176771.git.jani@nikula.org>
In-Reply-To: <cover.1323176771.git.jani@nikula.org>
Add mechanism for running user defined hooks. Hooks are executables or
symlinks to executables stored under the new notmuch hooks directory,
<database-path>/.notmuch/hooks.
No hooks are introduced here, but adding support for a hook is now a simple
matter of calling the new notmuch_run_hook() function at an appropriate
location with the hook name.
Signed-off-by: Jani Nikula <jani@nikula.org>
---
Makefile.local | 1 +
hooks.c | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
notmuch-client.h | 3 ++
3 files changed, 97 insertions(+), 0 deletions(-)
create mode 100644 hooks.c
diff --git a/Makefile.local b/Makefile.local
index c94402b..60ae9cb 100644
--- a/Makefile.local
+++ b/Makefile.local
@@ -298,6 +298,7 @@ notmuch_client_srcs = \
debugger.c \
gmime-filter-reply.c \
gmime-filter-headers.c \
+ hooks.c \
notmuch.c \
notmuch-config.c \
notmuch-count.c \
diff --git a/hooks.c b/hooks.c
new file mode 100644
index 0000000..c2d59c1
--- /dev/null
+++ b/hooks.c
@@ -0,0 +1,93 @@
+/* notmuch - Not much of an email program, (just index and search)
+ *
+ * This file is part of notmuch.
+ *
+ * Copyright © 2011 Jani Nikula
+ *
+ * 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: Jani Nikula <jani@nikula.org>
+ */
+
+#include "notmuch-client.h"
+#include <sys/wait.h>
+
+int
+notmuch_run_hook (const char *db_path, const char *hook)
+{
+ char *hook_path;
+ int status = 0;
+ pid_t pid;
+
+ hook_path = talloc_asprintf (NULL, "%s/%s/%s/%s", db_path, ".notmuch",
+ "hooks", hook);
+ if (hook_path == NULL) {
+ fprintf (stderr, "Out of memory\n");
+ return 1;
+ }
+
+ /* Check access before fork() for speed and simplicity of error handling. */
+ if (access (hook_path, X_OK) == -1) {
+ /* Ignore ENOENT. It's okay not to have a hook, hook dir, or even
+ * notmuch dir. Dangling symbolic links also result in ENOENT, but
+ * we'll ignore that too for simplicity. */
+ if (errno != ENOENT) {
+ fprintf (stderr, "Error: %s hook access failed: %s\n", hook,
+ strerror (errno));
+ status = 1;
+ }
+ goto DONE;
+ }
+
+ pid = fork();
+ if (pid == -1) {
+ fprintf (stderr, "Error: %s hook fork failed: %s\n", hook,
+ strerror (errno));
+ status = 1;
+ goto DONE;
+ } else if (pid == 0) {
+ execl (hook_path, hook_path, NULL);
+ /* Same as above for ENOENT, but unlikely now. Indicate all other errors
+ * to parent through non-zero exit status. */
+ if (errno != ENOENT) {
+ fprintf (stderr, "Error: %s hook execution failed: %s\n", hook,
+ strerror (errno));
+ status = 1;
+ }
+ exit (status);
+ }
+
+ if (waitpid (pid, &status, 0) == -1) {
+ fprintf (stderr, "Error: %s hook wait failed: %s\n", hook,
+ strerror (errno));
+ status = 1;
+ goto DONE;
+ }
+
+ if (!WIFEXITED (status) || WEXITSTATUS (status)) {
+ if (WEXITSTATUS (status)) {
+ fprintf (stderr, "Error: %s hook failed with status %d\n",
+ hook, WEXITSTATUS (status));
+ } else if (WIFSIGNALED (status)) {
+ fprintf (stderr, "Error: %s hook terminated with signal %d\n",
+ hook, WTERMSIG (status));
+ }
+ status = 1;
+ }
+
+ DONE:
+ talloc_free (hook_path);
+
+ return status;
+}
diff --git a/notmuch-client.h b/notmuch-client.h
index b50cb38..a91ad6c 100644
--- a/notmuch-client.h
+++ b/notmuch-client.h
@@ -235,6 +235,9 @@ void
notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
notmuch_bool_t synchronize_flags);
+int
+notmuch_run_hook (const char *db_path, const char *hook);
+
notmuch_bool_t
debugger_is_active (void);
--
1.7.5.4
next prev parent reply other threads:[~2011-12-06 13:23 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-02 21:00 [PATCH 1/2] cli: add mechanism for running user configurable hooks Jani Nikula
2011-12-02 21:00 ` [PATCH 2/2] cli: add support for running notmuch new pre and post hooks Jani Nikula
2011-12-02 21:05 ` [PATCH 1/2] cli: add mechanism for running user configurable hooks Jani Nikula
2011-12-03 23:16 ` [PATCH v2 1/2] cli: introduce the concept of user defined hooks Jani Nikula
2011-12-03 23:16 ` [PATCH v2 2/2] cli: add support for pre and post notmuch new hooks Jani Nikula
2011-12-04 4:00 ` Austin Clements
2011-12-04 19:36 ` Jani Nikula
2011-12-04 19:54 ` Tom Prince
2011-12-04 16:46 ` Tom Prince
2011-12-04 19:56 ` Jani Nikula
2011-12-04 3:42 ` [PATCH v2 1/2] cli: introduce the concept of user defined hooks Austin Clements
2011-12-04 12:35 ` Jani Nikula
2011-12-04 16:41 ` Austin Clements
2011-12-06 13:22 ` [PATCH v3 0/2] notmuch hooks Jani Nikula
2011-12-06 13:22 ` Jani Nikula [this message]
2011-12-06 13:30 ` [PATCH v3 1/2] cli: introduce the concept of user defined hooks Jani Nikula
2011-12-06 13:22 ` [PATCH v3 2/2] cli: add support for pre and post notmuch new hooks Jani Nikula
2011-12-07 2:27 ` [PATCH v3 0/2] notmuch hooks Jameson Graef Rollins
2011-12-07 19:42 ` Jani Nikula
2011-12-07 22:13 ` Jameson Graef Rollins
2011-12-08 8:49 ` Tomi Ollila
2011-12-08 16:29 ` Jameson Graef Rollins
2011-12-07 2:47 ` Jameson Graef Rollins
2011-12-07 3:16 ` Tom Prince
2011-12-07 18:05 ` Jani Nikula
2011-12-07 18:10 ` Jameson Graef Rollins
2011-12-07 20:11 ` Austin Clements
2011-12-08 22:48 ` [PATCH v4 0/3] " Jani Nikula
2011-12-08 22:48 ` [PATCH v4 1/3] cli: introduce the concept of user defined hooks Jani Nikula
2011-12-08 23:34 ` Austin Clements
2011-12-09 13:55 ` Jani Nikula
2011-12-09 15:59 ` Austin Clements
2011-12-08 22:48 ` [PATCH v4 2/3] cli: add support for pre and post notmuch new hooks Jani Nikula
2011-12-08 22:48 ` [PATCH v4 3/3] test: add tests for hooks Jani Nikula
2011-12-10 22:04 ` [PATCH v4 0/3] notmuch hooks Jameson Graef Rollins
2011-12-11 18:29 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=f1ea48544f712c54bbb14d167c14869b2cd6a6d7.1323176771.git.jani@nikula.org \
--to=jani@nikula.org \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).