Re: [PATCH v2 2/2] new: Centralize file type stat-ing logic
authorJani Nikula <jani@nikula.org>
Tue, 8 May 2012 07:58:28 +0000 (07:58 +0000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:47:00 +0000 (09:47 -0800)
42/450e0c3f881fd1db066ddd273333454831076b [new file with mode: 0644]

diff --git a/42/450e0c3f881fd1db066ddd273333454831076b b/42/450e0c3f881fd1db066ddd273333454831076b
new file mode 100644 (file)
index 0000000..446baf6
--- /dev/null
@@ -0,0 +1,258 @@
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 3AF1A431FAF\r
+       for <notmuch@notmuchmail.org>; Tue,  8 May 2012 00:58:36 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id y4o8OzivJ0Rr for <notmuch@notmuchmail.org>;\r
+       Tue,  8 May 2012 00:58:34 -0700 (PDT)\r
+Received: from mail-qc0-f181.google.com (mail-qc0-f181.google.com\r
+       [209.85.216.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C3993431FAE\r
+       for <notmuch@notmuchmail.org>; Tue,  8 May 2012 00:58:34 -0700 (PDT)\r
+Received: by qcsk26 with SMTP id k26so152066qcs.26\r
+       for <notmuch@notmuchmail.org>; Tue, 08 May 2012 00:58:33 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=from:to:cc:subject:in-reply-to:references:user-agent:date\r
+       :message-id:mime-version:content-type:x-gm-message-state;\r
+       bh=AvnmJ/5kI/eNjOsRv0F9hhkYVq2Ln0xarqnCHxcmBXw=;\r
+       b=i23hCtM6IMjfmjQDi7EQA7txBP9Zvs3E0FBPIto9SVU68UiIW5O5XHDLTzddbqWtGO\r
+       0pZwJLoRsFxKAyeS6xEwENNWQYgJvefBRHdbuPWlNzGwDqD5dNKfy0zm1NIZCDhAPapk\r
+       2rxfFidneztRtz3k6IUlXpC+yX8JaXYF/MOa0Zfs2GxfXkqExss47hm+ADc8Ouuf7fC6\r
+       1/D5YF/yxzueCsLx1gSLTLUd8ABa97++EK4XFL6NfSutlF5ZtKf2/57Z0QzSIYSRxywt\r
+       o3I2MfIBP4NkOk3l6u0oMlEPg90+lvBXu4PDjrDgBuWkVSYRKb8KWG1WzjyQqZiNokhI\r
+       PD9g==\r
+Received: by 10.224.205.6 with SMTP id fo6mr10210783qab.73.1336463912954;\r
+       Tue, 08 May 2012 00:58:32 -0700 (PDT)\r
+Received: from localhost (nikula.org. [92.243.24.172])\r
+       by mx.google.com with ESMTPS id bm15sm2680690qab.17.2012.05.08.00.58.30\r
+       (version=SSLv3 cipher=OTHER); Tue, 08 May 2012 00:58:32 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: Austin Clements <amdragon@MIT.EDU>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v2 2/2] new: Centralize file type stat-ing logic\r
+In-Reply-To: <1336429240-1114-3-git-send-email-amdragon@mit.edu>\r
+References: <1336414186-15293-1-git-send-email-amdragon@mit.edu>\r
+       <1336429240-1114-1-git-send-email-amdragon@mit.edu>\r
+       <1336429240-1114-3-git-send-email-amdragon@mit.edu>\r
+User-Agent: Notmuch/0.11.1+222~ga47a98c (http://notmuchmail.org) Emacs/23.1.1\r
+       (i686-pc-linux-gnu)\r
+Date: Tue, 08 May 2012 07:58:28 +0000\r
+Message-ID: <87r4uvdryz.fsf@nikula.org>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Gm-Message-State:\r
+ ALoCoQl9ItXHqbHEak1VBDEU3KqrTo5GO5ue8xuA/6kGn/FOJzkzG/L7EUE8aMGQMSGTOZ6ZMPs7\r
+Cc: Vladimir Marek <vlmarek@volny.cz>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 08 May 2012 07:58:36 -0000\r
+\r
+On Mon,  7 May 2012 18:20:40 -0400, Austin Clements <amdragon@MIT.EDU> wrote:\r
+> This moves our logic to get a file's type into one function.  This has\r
+> several benefits: we can support OSes and file systems that do not\r
+> provide dirent.d_type or always return DT_UNKNOWN, complex\r
+> symlink-handling logic has been replaced by a simple stat fall-through\r
+> in one place, and the error message for un-stat-able file is more\r
+> accurate (previously, the error always mentioned directories, even\r
+> though a broken symlink is not a directory).\r
+\r
+LGTM.\r
+\r
+> ---\r
+>  notmuch-new.c |  103 +++++++++++++++++++++++++++++++++++----------------------\r
+>  test/new      |    2 +-\r
+>  2 files changed, 64 insertions(+), 41 deletions(-)\r
+> \r
+> diff --git a/notmuch-new.c b/notmuch-new.c\r
+> index cb720cc..8955677 100644\r
+> --- a/notmuch-new.c\r
+> +++ b/notmuch-new.c\r
+> @@ -154,6 +154,48 @@ dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)\r
+>      return strcmp ((*a)->d_name, (*b)->d_name);\r
+>  }\r
+>  \r
+> +/* Return the type of a directory entry relative to path as a stat(2)\r
+> + * mode.  Like stat, this follows symlinks.  Returns -1 and sets errno\r
+> + * if the file's type cannot be determined (which includes dangling\r
+> + * symlinks).\r
+> + */\r
+> +static int\r
+> +dirent_type (const char *path, const struct dirent *entry)\r
+> +{\r
+> +    struct stat statbuf;\r
+> +    char *abspath;\r
+> +    int err, saved_errno;\r
+> +\r
+> +#ifdef _DIRENT_HAVE_D_TYPE\r
+> +    /* Mapping from d_type to stat mode_t.  We omit DT_LNK so that\r
+> +     * we'll fall through to stat and get the real file type. */\r
+> +    static const mode_t modes[] = {\r
+> +    [DT_BLK]  = S_IFBLK,\r
+> +    [DT_CHR]  = S_IFCHR,\r
+> +    [DT_DIR]  = S_IFDIR,\r
+> +    [DT_FIFO] = S_IFIFO,\r
+> +    [DT_REG]  = S_IFREG,\r
+> +    [DT_SOCK] = S_IFSOCK\r
+> +    };\r
+> +    if (entry->d_type < ARRAY_SIZE(modes) && modes[entry->d_type])\r
+> +    return modes[entry->d_type];\r
+> +#endif\r
+> +\r
+> +    abspath = talloc_asprintf (NULL, "%s/%s", path, entry->d_name);\r
+> +    if (!abspath) {\r
+> +    errno = ENOMEM;\r
+> +    return -1;\r
+> +    }\r
+> +    err = stat(abspath, &statbuf);\r
+> +    saved_errno = errno;\r
+> +    talloc_free (abspath);\r
+> +    if (err < 0) {\r
+> +    errno = saved_errno;\r
+> +    return -1;\r
+> +    }\r
+> +    return statbuf.st_mode & S_IFMT;\r
+> +}\r
+> +\r
+>  /* Test if the directory looks like a Maildir directory.\r
+>   *\r
+>   * Search through the array of directory entries to see if we can find all\r
+> @@ -162,12 +204,12 @@ dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)\r
+>   * Return 1 if the directory looks like a Maildir and 0 otherwise.\r
+>   */\r
+>  static int\r
+> -_entries_resemble_maildir (struct dirent **entries, int count)\r
+> +_entries_resemble_maildir (const char *path, struct dirent **entries, int count)\r
+>  {\r
+>      int i, found = 0;\r
+>  \r
+>      for (i = 0; i < count; i++) {\r
+> -    if (entries[i]->d_type != DT_DIR && entries[i]->d_type != DT_UNKNOWN)\r
+> +    if (dirent_type (path, entries[i]) != S_IFDIR)\r
+>          continue;\r
+>  \r
+>      if (strcmp(entries[i]->d_name, "new") == 0 ||\r
+> @@ -250,7 +292,7 @@ add_files_recursive (notmuch_database_t *notmuch,\r
+>      notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;\r
+>      notmuch_message_t *message = NULL;\r
+>      struct dirent **fs_entries = NULL;\r
+> -    int i, num_fs_entries;\r
+> +    int i, num_fs_entries, entry_type;\r
+>      notmuch_directory_t *directory;\r
+>      notmuch_filenames_t *db_files = NULL;\r
+>      notmuch_filenames_t *db_subdirs = NULL;\r
+> @@ -317,7 +359,7 @@ add_files_recursive (notmuch_database_t *notmuch,\r
+>      }\r
+>  \r
+>      /* Pass 1: Recurse into all sub-directories. */\r
+> -    is_maildir = _entries_resemble_maildir (fs_entries, num_fs_entries);\r
+> +    is_maildir = _entries_resemble_maildir (path, fs_entries, num_fs_entries);\r
+>  \r
+>      for (i = 0; i < num_fs_entries; i++) {\r
+>      if (interrupted)\r
+> @@ -325,17 +367,16 @@ add_files_recursive (notmuch_database_t *notmuch,\r
+>  \r
+>      entry = fs_entries[i];\r
+>  \r
+> -    /* We only want to descend into directories.\r
+> -     * But symlinks can be to directories too, of course.\r
+> -     *\r
+> -     * And if the filesystem doesn't tell us the file type in the\r
+> -     * scandir results, then it might be a directory (and if not,\r
+> -     * then we'll stat and return immediately in the next level of\r
+> -     * recursion). */\r
+> -    if (entry->d_type != DT_DIR &&\r
+> -        entry->d_type != DT_LNK &&\r
+> -        entry->d_type != DT_UNKNOWN)\r
+> -    {\r
+> +    /* We only want to descend into directories (and symlinks to\r
+> +     * directories). */\r
+> +    entry_type = dirent_type (path, entry);\r
+> +    if (entry_type == -1) {\r
+> +        /* Be pessimistic, e.g. so we don't lose lots of mail just\r
+> +         * because a user broke a symlink. */\r
+> +        fprintf (stderr, "Error reading file %s/%s: %s\n",\r
+> +                 path, entry->d_name, strerror (errno));\r
+> +        return NOTMUCH_STATUS_FILE_ERROR;\r
+> +    } else if (entry_type != S_IFDIR) {\r
+>          continue;\r
+>      }\r
+>  \r
+> @@ -425,31 +466,13 @@ add_files_recursive (notmuch_database_t *notmuch,\r
+>          notmuch_filenames_move_to_next (db_subdirs);\r
+>      }\r
+>  \r
+> -    /* If we're looking at a symlink, we only want to add it if it\r
+> -     * links to a regular file, (and not to a directory, say).\r
+> -     *\r
+> -     * Similarly, if the file is of unknown type (due to filesystem\r
+> -     * limitations), then we also need to look closer.\r
+> -     *\r
+> -     * In either case, a stat does the trick.\r
+> -     */\r
+> -    if (entry->d_type == DT_LNK || entry->d_type == DT_UNKNOWN) {\r
+> -        int err;\r
+> -\r
+> -        next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);\r
+> -        err = stat (next, &st);\r
+> -        talloc_free (next);\r
+> -        next = NULL;\r
+> -\r
+> -        /* Don't emit an error for a link pointing nowhere, since\r
+> -         * the directory-traversal pass will have already done\r
+> -         * that. */\r
+> -        if (err)\r
+> -            continue;\r
+> -\r
+> -        if (! S_ISREG (st.st_mode))\r
+> -            continue;\r
+> -    } else if (entry->d_type != DT_REG) {\r
+> +    /* Only add regular files (and symlinks to regular files). */\r
+> +    entry_type = dirent_type (path, entry);\r
+> +    if (entry_type == -1) {\r
+> +        fprintf (stderr, "Error reading file %s/%s: %s\n",\r
+> +                 path, entry->d_name, strerror (errno));\r
+> +        return NOTMUCH_STATUS_FILE_ERROR;\r
+> +    } else if (entry_type != S_IFREG) {\r
+>          continue;\r
+>      }\r
+>  \r
+> diff --git a/test/new b/test/new\r
+> index 26253db..e3900f5 100755\r
+> --- a/test/new\r
+> +++ b/test/new\r
+> @@ -140,7 +140,7 @@ test_begin_subtest "Broken symlink aborts"\r
+>  ln -s does-not-exist "${MAIL_DIR}/broken"\r
+>  output=$(NOTMUCH_NEW 2>&1)\r
+>  test_expect_equal "$output" \\r
+> -"Error reading directory /run/shm/nm/tmp.new/mail/broken: No such file or directory\r
+> +"Error reading file /run/shm/nm/tmp.new/mail/broken: No such file or directory\r
+>  Note: A fatal error was encountered: Something went wrong trying to read or write a file\r
+>  No new mail."\r
+>  rm "${MAIL_DIR}/broken"\r
+> -- \r
+> 1.7.10\r
+> \r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r