Update from libc.
[gnulib.git] / lib / makepath.c
index b592116..20e9a12 100644 (file)
@@ -1,5 +1,5 @@
 /* makepath.c -- Ensure that a directory path exists.
-   Copyright (C) 1990 Free Software Foundation, Inc.
+   Copyright (C) 1990, 1997, 1998, 1999 Free Software Foundation, Inc.
 
    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
    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, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
+   along with this program; if not, write to the Free Software Foundation,
+   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
 
-/* Written by David MacKenzie <djm@gnu.ai.mit.edu> and
-   Jim Meyering <meyering@cs.utexas.edu>.  */
+/* Written by David MacKenzie <djm@gnu.ai.mit.edu> and Jim Meyering.  */
 
-#ifdef HAVE_CONFIG_H
-#include <config.h>
+#if HAVE_CONFIG_H
+# include <config.h>
 #endif
 
-#ifdef __GNUC__
-#define alloca __builtin_alloca
-#else
-#ifdef HAVE_ALLOCA_H
-#include <alloca.h>
-#else
-#ifdef _AIX
- #pragma alloca
+#if __GNUC__
+# define alloca __builtin_alloca
 #else
+# if HAVE_ALLOCA_H
+#  include <alloca.h>
+# else
+#  ifdef _AIX
+ #  pragma alloca
+#  else
 char *alloca ();
-#endif
-#endif
+#  endif
+# endif
 #endif
 
 #include <stdio.h>
 #include <sys/types.h>
 #include <sys/stat.h>
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
+#if HAVE_UNISTD_H
+# include <unistd.h>
 #endif
 
-#ifdef STAT_MACROS_BROKEN
-#undef S_ISDIR
-#endif /* STAT_MACROS_BROKEN.  */
+#if STAT_MACROS_BROKEN
+# undef S_ISDIR
+#endif
 
 #if !defined(S_ISDIR) && defined(S_IFDIR)
-#define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
+# define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
 #endif
 
-#ifdef STDC_HEADERS
-#include <stdlib.h>
+#if STDC_HEADERS
+# include <stdlib.h>
 #endif
 
-#ifdef HAVE_ERRNO_H
-#include <errno.h>
+#if HAVE_ERRNO_H
+# include <errno.h>
 #endif
 
-#ifndef STDC_HEADERS
+#ifndef errno
 extern int errno;
 #endif
 
-#if defined(STDC_HEADERS) || defined(HAVE_STRING_H)
-#include <string.h>
-#ifndef index
-#define index strchr
+#if HAVE_STRING_H
+# include <string.h>
+#else
+# include <strings.h>
+# ifndef strchr
+#  define strchr index
+# endif
+#endif
+
+#ifndef S_ISUID
+# define S_ISUID 04000
+#endif
+#ifndef S_ISGID
+# define S_ISGID 02000
+#endif
+#ifndef S_ISVTX
+# define S_ISVTX 01000
+#endif
+#ifndef S_IRUSR
+# define S_IRUSR 0200
+#endif
+#ifndef S_IWUSR
+# define S_IWUSR 0200
+#endif
+#ifndef S_IXUSR
+# define S_IXUSR 0100
+#endif
+
+#ifndef S_IRWXU
+# define S_IRWXU (S_IRUSR | S_IWUSR | S_IXUSR)
+#endif
+
+#define WX_USR (S_IWUSR | S_IXUSR)
+
+/* Include this before libintl.h so we get our definition of PARAMS. */
+#include "makepath.h"
+
+#if HAVE_LOCALE_H
+# include <locale.h>
 #endif
+
+#if ENABLE_NLS
+# include <libintl.h>
+# define _(Text) gettext (Text)
 #else
-#include <strings.h>
+# define _(Text) Text
 #endif
 
 #ifdef __MSDOS__
@@ -77,9 +115,84 @@ typedef int uid_t;
 typedef int gid_t;
 #endif
 
-#include "makepath.h"
-#include "safe-stat.h"
-void error ();
+#include "save-cwd.h"
+#include "error.h"
+
+void strip_trailing_slashes ();
+
+#define CLEANUP_CWD                                    \
+  do                                                   \
+    {                                                  \
+      /* We're done operating on basename_dir.         \
+        Restore working directory.  */                 \
+      if (do_chdir)                                    \
+       {                                               \
+         int _fail = restore_cwd (&cwd, NULL, NULL);   \
+         free_cwd (&cwd);                              \
+         if (_fail)                                    \
+           return 1;                                   \
+       }                                               \
+    }                                                  \
+  while (0)
+
+#define CLEANUP                                                \
+  do                                                   \
+    {                                                  \
+      umask (oldmask);                                 \
+      CLEANUP_CWD;                                     \
+    }                                                  \
+  while (0)
+
+/* Attempt to create directory DIR (aka DIRPATH) with the specified MODE.
+   If CREATED_DIR_P is non-NULL, set *CREATED_DIR_P to non-zero if this
+   function creates DIR and to zero otherwise.  Give a diagnostic and
+   return non-zero if DIR cannot be created or cannot be determined to
+   exist already.  Use DIRPATH in any diagnostic, not DIR.
+   Note that if DIR already exists, this function will return zero
+   (indicating success) and will set *CREATED_DIR_P to zero.  */
+
+static int
+make_dir (const char *dir, const char *dirpath, mode_t mode, int *created_dir_p)
+{
+  int fail = 0;
+  int created_dir;
+
+  created_dir = (mkdir (dir, mode) == 0);
+
+  if (!created_dir)
+    {
+      struct stat stats;
+      int saved_errno = errno;
+
+      /* The mkdir and stat calls below may appear to be reversed.
+        They are not.  It is important to call mkdir first and then to
+        call stat (to distinguish the three cases) only if mkdir fails.
+        The alternative to this approach is to `stat' each directory,
+        then to call mkdir if it doesn't exist.  But if some other process
+        were to create the directory between the stat & mkdir, the mkdir
+        would fail with EEXIST.  */
+
+      if (stat (dir, &stats))
+       {
+         error (0, saved_errno, _("cannot create directory `%s'"), dirpath);
+         fail = 1;
+       }
+      else if (!S_ISDIR (stats.st_mode))
+       {
+         error (0, 0, _("`%s' exists but is not a directory"), dirpath);
+         fail = 1;
+       }
+      else
+       {
+         /* DIR (aka DIRPATH) already exists and is a directory. */
+       }
+    }
+
+  if (created_dir_p)
+    *created_dir_p = created_dir;
+
+  return fail;
+}
 
 /* Ensure that the directory ARGPATH exists.
    Remove any trailing slashes from ARGPATH before calling this function.
@@ -99,7 +212,6 @@ void error ();
    Return 0 if ARGPATH exists as a directory with the proper
    ownership and permissions when done, otherwise 1.  */
 
-#if defined (__GNUC__) || (defined (__STDC__) && __STDC__)
 int
 make_path (const char *argpath,
           int mode,
@@ -108,30 +220,11 @@ make_path (const char *argpath,
           gid_t group,
           int preserve_existing,
           const char *verbose_fmt_string)
-#else
-int
-make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
-          verbose_fmt_string)
-     const char *argpath;
-     int mode;
-     int parent_mode;
-     uid_t owner;
-     gid_t group;
-     int preserve_existing;
-     const char *verbose_fmt_string;
-#endif
 {
-  char *dirpath;               /* A copy we can scribble NULs on.  */
   struct stat stats;
   int retval = 0;
-  int oldmask = umask (0);
-
-  /* FIXME: move this alloca and strcpy into the if-block.
-     Set dirpath to argpath in the else-block.  */
-  dirpath = (char *) alloca (strlen (argpath) + 1);
-  strcpy (dirpath, argpath);
 
-  if (SAFE_STAT (dirpath, &stats))
+  if (stat (argpath, &stats))
     {
       char *slash;
       int tmp_mode;            /* Initial perms for leading dirs.  */
@@ -142,15 +235,27 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
        struct ptr_list *next;
       };
       struct ptr_list *p, *leading_dirs = NULL;
+      int do_chdir;            /* Whether to chdir before each mkdir.  */
+      struct saved_cwd cwd;
+      char *basename_dir;
+      char *dirpath;
+
+      /* Temporarily relax umask in case it's overly restrictive.  */
+      mode_t oldmask = umask (0);
+
+      /* Make a copy of ARGPATH that we can scribble NULs on.  */
+      dirpath = (char *) alloca (strlen (argpath) + 1);
+      strcpy (dirpath, argpath);
+      strip_trailing_slashes (dirpath);
 
       /* If leading directories shouldn't be writable or executable,
         or should have set[ug]id or sticky bits set and we are setting
         their owners, we need to fix their permissions after making them.  */
-      if (((parent_mode & 0300) != 0300)
-         || (owner != (uid_t) -1 && group != (gid_t) -1
-             && (parent_mode & 07000) != 0))
+      if (((parent_mode & WX_USR) != WX_USR)
+         || ((owner != (uid_t) -1 || group != (gid_t) -1)
+             && (parent_mode & (S_ISUID | S_ISGID | S_ISVTX)) != 0))
        {
-         tmp_mode = 0700;
+         tmp_mode = S_IRWXU;
          re_protect = 1;
        }
       else
@@ -159,49 +264,82 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
          re_protect = 0;
        }
 
+      /* If we can record the current working directory, we may be able
+        to do the chdir optimization.  */
+      do_chdir = !save_cwd (&cwd);
+
+      /* If we've saved the cwd and DIRPATH is an absolute pathname,
+        we must chdir to `/' in order to enable the chdir optimization.
+         So if chdir ("/") fails, turn off the optimization.  */
+      if (do_chdir && *dirpath == '/' && chdir ("/") < 0)
+       do_chdir = 0;
+
       slash = dirpath;
+
+      /* Skip over leading slashes.  */
       while (*slash == '/')
        slash++;
-      while ((slash = index (slash, '/')))
+
+      while (1)
        {
+         int newly_created_dir;
+         int fail;
+
+         /* slash points to the leftmost unprocessed component of dirpath.  */
+         basename_dir = slash;
+
+         slash = strchr (slash, '/');
+         if (slash == NULL)
+           break;
+
+         /* If we're *not* doing chdir before each mkdir, then we have to refer
+            to the target using the full (multi-component) directory name.  */
+         if (!do_chdir)
+           basename_dir = dirpath;
+
          *slash = '\0';
-         if (SAFE_STAT (dirpath, &stats))
+         fail = make_dir (basename_dir, dirpath, tmp_mode, &newly_created_dir);
+         if (fail)
            {
-             if (mkdir (dirpath, tmp_mode))
+             CLEANUP;
+             return 1;
+           }
+
+         if (newly_created_dir)
+           {
+             if (verbose_fmt_string)
+               fprintf (stderr, verbose_fmt_string, dirpath);
+
+             if ((owner != (uid_t) -1 || group != (gid_t) -1)
+                 && chown (basename_dir, owner, group)
+#if defined(AFS) && defined (EPERM)
+                 && errno != EPERM
+#endif
+                 )
                {
-                 error (0, errno, "cannot create directory `%s'", dirpath);
-                 umask (oldmask);
+                 error (0, errno, "%s", dirpath);
+                 CLEANUP;
                  return 1;
                }
-             else
-               {
-                 if (verbose_fmt_string != NULL)
-                   error (0, 0, verbose_fmt_string, dirpath);
 
-                 if (owner != (uid_t) -1 && group != (gid_t) -1
-                     && chown (dirpath, owner, group)
-#if defined(AFS) && defined (EPERM)
-                     && errno != EPERM
-#endif
-                     )
-                   {
-                     error (0, errno, "%s", dirpath);
-                     retval = 1;
-                   }
-                 if (re_protect)
-                   {
-                     struct ptr_list *new = (struct ptr_list *)
-                       alloca (sizeof (struct ptr_list));
-                     new->dirname_end = slash;
-                     new->next = leading_dirs;
-                     leading_dirs = new;
-                   }
+             if (re_protect)
+               {
+                 struct ptr_list *new = (struct ptr_list *)
+                   alloca (sizeof (struct ptr_list));
+                 new->dirname_end = slash;
+                 new->next = leading_dirs;
+                 leading_dirs = new;
                }
            }
-         else if (!S_ISDIR (stats.st_mode))
+
+         /* If we were able to save the initial working directory,
+            then we can use chdir to change into each directory before
+            creating an entry in that directory.  This avoids making
+            stat and mkdir process O(n^2) file name components.  */
+         if (do_chdir && chdir (basename_dir) < 0)
            {
-             error (0, 0, "`%s' exists but is not a directory", dirpath);
-             umask (oldmask);
+             error (0, errno, _("cannot chdir to directory, %s"), dirpath);
+             CLEANUP;
              return 1;
            }
 
@@ -213,40 +351,46 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
            slash++;
        }
 
+      if (!do_chdir)
+       basename_dir = dirpath;
+
       /* We're done making leading directories.
         Create the final component of the path.  */
 
-      /* The path could end in "/." or contain "/..", so test
-        if we really have to create the directory.  */
-
-      if (SAFE_STAT (dirpath, &stats) && mkdir (dirpath, mode))
+      if (make_dir (basename_dir, dirpath, mode, NULL))
        {
-         error (0, errno, "cannot create directory `%s'", dirpath);
-         umask (oldmask);
+         CLEANUP;
          return 1;
        }
+
+      /* Done creating directories.  Restore original umask.  */
+      umask (oldmask);
+
       if (verbose_fmt_string != NULL)
        error (0, 0, verbose_fmt_string, dirpath);
 
       if (owner != (uid_t) -1 && group != (gid_t) -1)
        {
-         if (chown (dirpath, owner, group)
+         if (chown (basename_dir, owner, group)
 #ifdef AFS
              && errno != EPERM
 #endif
              )
            {
-             error (0, errno, "%s", dirpath);
+             error (0, errno, _("cannot chown %s"), dirpath);
              retval = 1;
            }
          /* chown may have turned off some permission bits we wanted.  */
-         if ((mode & 07000) != 0 && chmod (dirpath, mode))
+         if ((mode & (S_ISUID | S_ISGID | S_ISVTX))
+             && chmod (basename_dir, mode))
            {
-             error (0, errno, "%s", dirpath);
+             error (0, errno, _("cannot chmod %s"), dirpath);
              retval = 1;
            }
        }
 
+      CLEANUP_CWD;
+
       /* If the mode for leading directories didn't include owner "wx"
         privileges, we have to reset their protections to the correct
         value.  */
@@ -264,10 +408,11 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
     {
       /* We get here if the entire path already exists.  */
 
+      const char *dirpath = argpath;
+
       if (!S_ISDIR (stats.st_mode))
        {
-         error (0, 0, "`%s' exists but is not a directory", dirpath);
-         umask (oldmask);
+         error (0, 0, _("`%s' exists but is not a directory"), dirpath);
          return 1;
        }
 
@@ -279,7 +424,7 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
             On System V, users can give away files with chown and then not
             be able to chmod them.  So don't give files away.  */
 
-         if (owner != (uid_t) -1 && group != (gid_t) -1
+         if ((owner != (uid_t) -1 || group != (gid_t) -1)
              && chown (dirpath, owner, group)
 #ifdef AFS
              && errno != EPERM
@@ -297,6 +442,5 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
        }
     }
 
-  umask (oldmask);
   return retval;
 }