[PATCH] notmuch-new: Test if directory looks like Maildir before skipping tmp.

[PATCH] notmuch-new: Test if directory looks like Maildir before skipping tmp.

[Jan Janak]

'notmuch new' skips directory entries with the name 'tmp'. This is to
prevent notmuch from processing possibly incomplete Maildir messages
stored in that directory.

This patch attempts to refine the feature. If "tmp" entry is found,
it first checks if the containing directory looks like a Maildir
directory. This is done by searching for other common Maildir
subdirectories. If they exist and if the entry "tmp" is a directory
then it is skipped.

Files and subdirectories with the name "tmp" that do not look like
Maildir will still be processed by 'notmuch new'.

Signed-off-by: Jan Janak <jan@ryngle.com>
---
 notmuch-new.c |   28 +++++++++++++++++++++++++++-
 1 files changed, 27 insertions(+), 1 deletions(-)

diff --git a/notmuch-new.c b/notmuch-new.c
index e32b92a..3e1c9a7 100644
--- a/notmuch-new.c
+++ b/notmuch-new.c
@@ -80,6 +80,30 @@ static int ino_cmp(const struct dirent **a, const struct dirent **b)
     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
 }
 
+/* Test if the directory looks like a Maildir directory.
+ *
+ * Search through the array of directory entries to see if we can find all
+ * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
+ *
+ * Return 1 if the directory looks like a Maildir and 0 otherwise.
+ */
+static int is_maildir (struct dirent **entries, int count)
+{
+    int i, found = 0;
+
+    for (i = 0; i < count; i++) {
+	if (entries[i]->d_type != DT_DIR) continue;
+	if (strcmp(entries[i]->d_name, "new") == 0 ||
+	    strcmp(entries[i]->d_name, "cur") == 0 ||
+	    strcmp(entries[i]->d_name, "tmp") == 0)
+	{
+	    found++;
+	}
+    }
+
+    return found >= 3;
+}
+
 /* Examine 'path' recursively as follows:
  *
  *   o Ask the filesystem for the mtime of 'path' (path_mtime)
@@ -159,7 +183,9 @@ add_files_recursive (notmuch_database_t *notmuch,
 	 * user specify files to be ignored. */
 	if (strcmp (entry->d_name, ".") == 0 ||
 	    strcmp (entry->d_name, "..") == 0 ||
-	    strcmp (entry->d_name, "tmp") == 0 ||
+	    (entry->d_type == DT_DIR &&
+	     (strcmp (entry->d_name, "tmp") == 0) &&
+	     is_maildir (namelist, num_entries)) ||
 	    strcmp (entry->d_name, ".notmuch") ==0)
 	{
 	    continue;
-- 
1.6.3.3

Re: [PATCH] notmuch-new: Test if directory looks like Maildir before skipping tmp.

[Scott Robinson]

Excerpts from Jan Janak's message of Wed Nov 25 11:43:15 -0800 2009:
> +/* Test if the directory looks like a Maildir directory.
> + *
> + * Search through the array of directory entries to see if we can find all
> + * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
> + *
> + * Return 1 if the directory looks like a Maildir and 0 otherwise.
> + */
> +static int is_maildir (struct dirent **entries, int count)
> +{
> +    int i, found = 0;
> +
> +    for (i = 0; i < count; i++) {
> +    if (entries[i]->d_type != DT_DIR) continue;
> +    if (strcmp(entries[i]->d_name, "new") == 0 ||
> +        strcmp(entries[i]->d_name, "cur") == 0 ||
> +        strcmp(entries[i]->d_name, "tmp") == 0)
> +    {
> +        found++;
> +    }
> +    }
> +
> +    return found >= 3;
> +}

Maybe put the "found >= 3" in the for loop's stop-condition?
-- 
Scott Robinson | http://quadhome.com/

Q: Why are my replies five sentences or less?
A: http://five.sentenc.es/

[PATCH] notmuch-new: Test if directory looks like Maildir before skipping tmp.

[Jan Janak]

'notmuch new' skips directory entries with the name 'tmp'. This is to
prevent notmuch from processing possibly incomplete Maildir messages
stored in that directory.

This patch attempts to refine the feature. If "tmp" entry is found,
it first checks if the containing directory looks like a Maildir
directory. This is done by searching for other common Maildir
subdirectories. If they exist and if the entry "tmp" is a directory
then it is skipped.

Files and subdirectories with the name "tmp" that do not look like
Maildir will still be processed by 'notmuch new'.

Signed-off-by: Jan Janak <jan@ryngle.com>
---
 notmuch-new.c |   29 ++++++++++++++++++++++++++++-
 1 files changed, 28 insertions(+), 1 deletions(-)

diff --git a/notmuch-new.c b/notmuch-new.c
index e32b92a..10dc72b 100644
--- a/notmuch-new.c
+++ b/notmuch-new.c
@@ -80,6 +80,31 @@ static int ino_cmp(const struct dirent **a, const struct dirent **b)
     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
 }
 
+/* Test if the directory looks like a Maildir directory.
+ *
+ * Search through the array of directory entries to see if we can find all
+ * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
+ *
+ * Return 1 if the directory looks like a Maildir and 0 otherwise.
+ */
+static int is_maildir (struct dirent **entries, int count)
+{
+    int i, found = 0;
+
+    for (i = 0; i < count; i++) {
+	if (entries[i]->d_type != DT_DIR) continue;
+	if (strcmp(entries[i]->d_name, "new") == 0 ||
+	    strcmp(entries[i]->d_name, "cur") == 0 ||
+	    strcmp(entries[i]->d_name, "tmp") == 0)
+	{
+	    found++;
+	    if (found == 3) return 1;
+	}
+    }
+
+    return 0;
+}
+
 /* Examine 'path' recursively as follows:
  *
  *   o Ask the filesystem for the mtime of 'path' (path_mtime)
@@ -159,7 +184,9 @@ add_files_recursive (notmuch_database_t *notmuch,
 	 * user specify files to be ignored. */
 	if (strcmp (entry->d_name, ".") == 0 ||
 	    strcmp (entry->d_name, "..") == 0 ||
-	    strcmp (entry->d_name, "tmp") == 0 ||
+	    (entry->d_type == DT_DIR &&
+	     (strcmp (entry->d_name, "tmp") == 0) &&
+	     is_maildir (namelist, num_entries)) ||
 	    strcmp (entry->d_name, ".notmuch") ==0)
 	{
 	    continue;
-- 
1.6.3.3

Re: [PATCH] notmuch-new: Test if directory looks like Maildir before skipping tmp.

[Jan Janak]

On 25-11 12:12, Scott Robinson wrote:
> Excerpts from Jan Janak's message of Wed Nov 25 11:43:15 -0800 2009:
> > +/* Test if the directory looks like a Maildir directory.
> > + *
> > + * Search through the array of directory entries to see if we can find all
> > + * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
> > + *
> > + * Return 1 if the directory looks like a Maildir and 0 otherwise.
> > + */
> > +static int is_maildir (struct dirent **entries, int count)
> > +{
> > +    int i, found = 0;
> > +
> > +    for (i = 0; i < count; i++) {
> > +    if (entries[i]->d_type != DT_DIR) continue;
> > +    if (strcmp(entries[i]->d_name, "new") == 0 ||
> > +        strcmp(entries[i]->d_name, "cur") == 0 ||
> > +        strcmp(entries[i]->d_name, "tmp") == 0)
> > +    {
> > +        found++;
> > +    }
> > +    }
> > +
> > +    return found >= 3;
> > +}
> 
> Maybe put the "found >= 3" in the for loop's stop-condition?

You are right, of course. Resubmitted, thanks a lot!

  -- Jan

Re: [PATCH] notmuch-new: Test if directory looks like Maildir before skipping tmp.

[Carl Worth]

On Wed, 25 Nov 2009 22:11:45 +0100, Jan Janak <jan@ryngle.com> wrote:
> Files and subdirectories with the name "tmp" that do not look like
> Maildir will still be processed by 'notmuch new'.

This is a nice improvement. I realize we neglected to document the
original "tmp" skipping. This should definitely be safer, (though we
should document this as well).

And this maildir detection will also be useful for the outstanding patch
to add tags based on flags in maildir filenames.

I pushed the patch and then made two, minor whitespace fixes:

> +static int is_maildir (struct dirent **entries, int count)

The function name in the definition here belongs on its own line.

> +	    if (found == 3) return 1;

Having the action of the "if" statement on the same line as the "if"
itself hides it too much. That also belongs on the next line.

-Carl