Re: [PATCH 2/2] new: Centralize file type stat-ing logic
authorAustin Clements <amdragon@MIT.EDU>
Mon, 7 May 2012 22:18:33 +0000 (18:18 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:46:59 +0000 (09:46 -0800)
fd/1b96912f22390a2a896fc195898e5b5cc76af2 [new file with mode: 0644]

diff --git a/fd/1b96912f22390a2a896fc195898e5b5cc76af2 b/fd/1b96912f22390a2a896fc195898e5b5cc76af2
new file mode 100644 (file)
index 0000000..2d630ed
--- /dev/null
@@ -0,0 +1,310 @@
+Return-Path: <amdragon@mit.edu>\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 65018431FB6\r
+       for <notmuch@notmuchmail.org>; Mon,  7 May 2012 15:18:41 -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 3cXfqcv1+zrc for <notmuch@notmuchmail.org>;\r
+       Mon,  7 May 2012 15:18:40 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-4.mit.edu (DMZ-MAILSEC-SCANNER-4.MIT.EDU\r
+       [18.9.25.15])\r
+       by olra.theworths.org (Postfix) with ESMTP id 1F65F431FAE\r
+       for <notmuch@notmuchmail.org>; Mon,  7 May 2012 15:18:40 -0700 (PDT)\r
+X-AuditID: 1209190f-b7f4f6d00000092b-79-4fa84a3dc175\r
+Received: from mailhub-auth-2.mit.edu ( [18.7.62.36])\r
+       by dmz-mailsec-scanner-4.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 38.29.02347.D3A48AF4; Mon,  7 May 2012 18:18:37 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id q47MIZuo013106; \r
+       Mon, 7 May 2012 18:18:36 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q47MIXDY005680\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Mon, 7 May 2012 18:18:34 -0400 (EDT)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1SRWGH-0000B2-Hc; Mon, 07 May 2012 18:18:33 -0400\r
+Date: Mon, 7 May 2012 18:18:33 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Jani Nikula <jani@nikula.org>\r
+Subject: Re: [PATCH 2/2] new: Centralize file type stat-ing logic\r
+Message-ID: <20120507221833.GW2704@mit.edu>\r
+References: <1336414186-15293-1-git-send-email-amdragon@mit.edu>\r
+       <1336414186-15293-3-git-send-email-amdragon@mit.edu>\r
+       <CAB+hUn_rcz00p4kobjcf57aiyqSAWSPGgRSCNNG0b5eSye=3DQ@mail.gmail.com>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=iso-8859-1\r
+Content-Disposition: inline\r
+Content-Transfer-Encoding: 8bit\r
+In-Reply-To:\r
+ <CAB+hUn_rcz00p4kobjcf57aiyqSAWSPGgRSCNNG0b5eSye=3DQ@mail.gmail.com>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFlrCKsWRmVeSWpSXmKPExsUixG6nomvrtcLf4PlOdoum6c4W12/OZLaY\r
+       cX4XiwOzx637r9k9nq26xeyx7OhPxgDmKC6blNSczLLUIn27BK6MeRO+sRRsdK/49fALUwPj\r
+       c6MuRk4OCQETiS9bDrND2GISF+6tZwOxhQT2MUqs3MnRxcgFZK9nlGg+t4AdwjnBJLH43DxW\r
+       CGcJo8Snd90sIC0sAioSk7vesoLYbAIaEtv2L2cEsUUEFCU2n9wPZjML+Eq8vfYArEZYwFFi\r
+       +pLNzF2MHBy8AtoS/1brQcwE2vy0+RTYGbwCghInZz5hgejVkdi59Q4bSD2zgLTE8n8cEGF5\r
+       ieats5lBbE6BQInvjzaA2aJA50w5uY1tAqPwLCSTZiGZNAth0iwkkxYwsqxilE3JrdLNTczM\r
+       KU5N1i1OTszLSy3SNdHLzSzRS00p3cQIigxOSf4djN8OKh1iFOBgVOLhVXyx3F+INbGsuDL3\r
+       EKMkB5OSKC+z2wp/Ib6k/JTKjMTijPii0pzU4kOMEhzMSiK8bWJAOd6UxMqq1KJ8mJQ0B4uS\r
+       OK+a1js/IYH0xJLU7NTUgtQimKwMB4eSBO85T6BGwaLU9NSKtMycEoQ0EwcnyHAeoOHeIDW8\r
+       xQWJucWZ6RD5U4yKUuK8fSAJAZBERmkeXC8scb1iFAd6RZg3D6SKB5j04LpfAQ1mAhq8+dky\r
+       kMEliQgpqQZGkenxJUfq9s5qqbTf+ZPnXpXAyVnS1sU5/qdLueSOrGsP0REoZHfc2nHF9NRz\r
+       NcutE1T3PJ6Wu/epfMaGHRlKC1U/vNl6fv+cmjs7Yn2C3nzZ/HWBRzQnY9P5Naz9NeF7p5wx\r
+       tjK/zcA857/rslZF8T033u55tbFjwsvZm7Q711/gWRRd+nzZXCWW4oxEQy3mouJEAA45T043        AwAA\r
+Cc: Notmuch Mail <notmuch@notmuchmail.org>, 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: Mon, 07 May 2012 22:18:41 -0000\r
+\r
+Quoth Jani Nikula on May 08 at 12:08 am:\r
+>    On May 7, 2012 9:10 PM, "Austin Clements" <[1]amdragon@mit.edu> wrote:\r
+>    >\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
+>    Please find some quick drive-by-review below.\r
+\r
+Thanks for the review!  New version on its way...\r
+\r
+>    J.\r
+> \r
+>    > ---\r
+>    >  notmuch-new.c |   99\r
+>    ++++++++++++++++++++++++++++++++++-----------------------\r
+>    >  test/new      |    2 +-\r
+>    >  2 files changed, 60 insertions(+), 41 deletions(-)\r
+>    >\r
+>    > diff --git a/notmuch-new.c b/notmuch-new.c\r
+>    > index cb720cc..cf2580e 100644\r
+>    > --- a/notmuch-new.c\r
+>    > +++ b/notmuch-new.c\r
+>    > @@ -154,6 +154,44 @@ dirent_sort_strcmp_name (const struct dirent **a,\r
+>    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;\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 < sizeof(modes)/sizeof(modes[0]) &&\r
+> \r
+>    ARRAY_SIZE()\r
+\r
+Huh.  I went looking for that.  I wonder how I missed it.\r
+\r
+>    > +       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
+>    > +       return -1;\r
+> \r
+>    Does talloc set errno in this case? I suspect not.\r
+> \r
+>    > +    err = stat(abspath, &statbuf);\r
+>    > +    talloc_free (abspath);\r
+> \r
+>    This likely breaks your promise about errno. You can't trust talloc_free()\r
+>    not calling some function that sets errno.\r
+\r
+Setting errno was a late and apparently not well thought-out addition.\r
+The new patch should set it on all of the error paths and save it\r
+around things that may modify it.\r
+\r
+>    > +    if (err < 0)\r
+>    > +       return -1;\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\r
+>    all\r
+>    > @@ -162,12 +200,12 @@ dirent_sort_strcmp_name (const struct dirent **a,\r
+>    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,\r
+>    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 !=\r
+>    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 +288,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 +355,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,\r
+>    num_fs_entries);\r
+>    > +    is_maildir = _entries_resemble_maildir (path, fs_entries,\r
+>    num_fs_entries);\r
+>    >\r
+>    >     for (i = 0; i < num_fs_entries; i++) {\r
+>    >        if (interrupted)\r
+>    > @@ -325,17 +363,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 loose lots of mail\r
+> \r
+>    s/loose/lose/ ?\r
+\r
+Oops.\r
+\r
+>    > +            * just because a user broke a symlink. */\r
+>    > +           fprintf (stderr, "Error reading file %s/%s: %s\n",\r
+>    > +                    path, entry->d_name, strerror (errno));\r
+> \r
+>    You can't trust errno here, as explained above.\r
+\r
+Fixed above.\r
+\r
+>    > +           return NOTMUCH_STATUS_FILE_ERROR;\r
+>    > +       } else if (entry_type != S_IFDIR) {\r
+>    >            continue;\r
+>    >        }\r
+>    >\r
+>    > @@ -425,31 +462,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,\r
+>    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
+> \r
+>    Ditto.\r
+> \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\r
+>    or directory\r
+>    > +"Error reading file /run/shm/nm/tmp.new/mail/broken: No such file or\r
+>    directory\r
+>    >  Note: A fatal error was encountered: Something went wrong trying to\r
+>    read or write a file\r
+>    >  No new mail."\r
+>    >  rm "${MAIL_DIR}/broken"\r
+>    >\r
+>    > _______________________________________________\r
+>    > notmuch mailing list\r
+>    > [2]notmuch@notmuchmail.org\r
+>    > [3]http://notmuchmail.org/mailman/listinfo/notmuch\r