Updated
[gnulib.git] / lib / makepath.c
index 1784431..1bc12c3 100644 (file)
@@ -1,5 +1,7 @@
 /* makepath.c -- Ensure that a directory path exists.
-   Copyright (C) 1990, 1997 Free Software Foundation, Inc.
+
+   Copyright (C) 1990, 1997, 1998, 1999, 2000, 2002, 2003, 2004 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
 # include <config.h>
 #endif
 
-#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
+#include "makepath.h"
+
+#include <alloca.h>
 
 #include <stdio.h>
 #include <sys/types.h>
@@ -42,57 +34,38 @@ char *alloca ();
 # include <unistd.h>
 #endif
 
-#if STAT_MACROS_BROKEN
-# undef S_ISDIR
-#endif
-
-#if !defined(S_ISDIR) && defined(S_IFDIR)
-# define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
-#endif
-
-#if STDC_HEADERS
-# include <stdlib.h>
-#endif
-
-#if HAVE_ERRNO_H
-# include <errno.h>
-#endif
+#include <stdlib.h>
+#include <errno.h>
+#include <string.h>
 
-#ifndef errno
-extern int errno;
-#endif
-
-#if HAVE_STRING_H
-# include <string.h>
-#else
-# include <strings.h>
-# ifndef strchr
-#  define strchr index
-# endif
-#endif
-
-#ifdef __MSDOS__
-typedef int uid_t;
-typedef int gid_t;
-#endif
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
 
 #include "save-cwd.h"
-#include "makepath.h"
+#include "dirname.h"
 #include "error.h"
+#include "quote.h"
+#include "stat-macros.h"
 
-void strip_trailing_slashes ();
+#define WX_USR (S_IWUSR | S_IXUSR)
 
 #define CLEANUP_CWD                                    \
   do                                                   \
     {                                                  \
       /* We're done operating on basename_dir.         \
         Restore working directory.  */                 \
-      if (saved_cwd)                                   \
+      if (do_chdir)                                    \
        {                                               \
-         int fail = restore_cwd (&cwd, NULL, NULL);    \
+         if (restore_cwd (&cwd) != 0)                  \
+           {                                           \
+             int _saved_errno = errno;                 \
+             error (0, errno,                          \
+               _("failed to return to initial working directory")); \
+             free_cwd (&cwd);                          \
+             errno = _saved_errno;                     \
+             return 1;                                 \
+           }                                           \
          free_cwd (&cwd);                              \
-         if (fail)                                     \
-           return 1;                                   \
        }                                               \
     }                                                  \
   while (0)
@@ -105,8 +78,60 @@ void strip_trailing_slashes ();
     }                                                  \
   while (0)
 
+/* Attempt to create directory DIR (aka DIRPATH) with the specified MODE.
+   If CREATED_DIR_P is non-NULL, set *CREATED_DIR_P if this
+   function creates DIR and clear it otherwise.  Give a diagnostic and
+   return false 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 returns true
+   (indicating success) and clears *CREATED_DIR_P.  */
+
+bool
+make_dir (const char *dir, const char *dirpath, mode_t mode,
+         bool *created_dir_p)
+{
+  bool ok = true;
+  bool 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"),
+                quote (dirpath));
+         ok = false;
+       }
+      else if (!S_ISDIR (stats.st_mode))
+       {
+         error (0, 0, _("%s exists but is not a directory"), quote (dirpath));
+         ok = false;
+       }
+      else
+       {
+         /* DIR (aka DIRPATH) already exists and is a directory. */
+       }
+    }
+
+  if (created_dir_p)
+    *created_dir_p = created_dir;
+
+  return ok;
+}
+
 /* Ensure that the directory ARGPATH exists.
-   Remove any trailing slashes from ARGPATH before calling this function.
 
    Create any leading directories that don't already exist, with
    permissions PARENT_MODE.
@@ -117,56 +142,42 @@ void strip_trailing_slashes ();
    If VERBOSE_FMT_STRING is nonzero, use it as a printf format
    string for printing a message after successfully making a directory,
    with the name of the directory that was just made as an argument.
-   If PRESERVE_EXISTING is non-zero and ARGPATH is an existing directory,
+   If PRESERVE_EXISTING is true and ARGPATH is an existing directory,
    then do not attempt to set its permissions and ownership.
 
-   Return 0 if ARGPATH exists as a directory with the proper
-   ownership and permissions when done, otherwise 1.  */
+   Return true iff ARGPATH exists as a directory with the proper
+   ownership and permissions when done.  */
 
-#if __STDC__
-int
+bool
 make_path (const char *argpath,
-          int mode,
-          int parent_mode,
+          mode_t mode,
+          mode_t parent_mode,
           uid_t owner,
           gid_t group,
-          int preserve_existing,
+          bool 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
 {
   struct stat stats;
-  int retval = 0;
+  bool retval = true;
 
   if (stat (argpath, &stats))
     {
       char *slash;
-      int tmp_mode;            /* Initial perms for leading dirs.  */
-      int re_protect;          /* Should leading dirs be unwritable? */
+      mode_t tmp_mode;         /* Initial perms for leading dirs.  */
+      bool re_protect;         /* Should leading dirs be unwritable? */
       struct ptr_list
       {
        char *dirname_end;
        struct ptr_list *next;
       };
       struct ptr_list *p, *leading_dirs = NULL;
-      int saved_cwd = 0;
+      bool do_chdir;           /* Whether to chdir before each mkdir.  */
       struct saved_cwd cwd;
       char *basename_dir;
-      int first_subdir = 1;
       char *dirpath;
 
       /* Temporarily relax umask in case it's overly restrictive.  */
-      int oldmask = umask (0);
+      mode_t oldmask = umask (0);
 
       /* Make a copy of ARGPATH that we can scribble NULs on.  */
       dirpath = (char *) alloca (strlen (argpath) + 1);
@@ -176,19 +187,29 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
       /* 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;
-         re_protect = 1;
+         tmp_mode = S_IRWXU;
+         re_protect = true;
        }
       else
        {
          tmp_mode = parent_mode;
-         re_protect = 0;
+         re_protect = false;
        }
 
+      /* If we can record the current working directory, we may be able
+        to do the chdir optimization.  */
+      do_chdir = (save_cwd (&cwd) == 0);
+
+      /* 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 = false;
+
       slash = dirpath;
 
       /* Skip over leading slashes.  */
@@ -197,6 +218,8 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
 
       while (1)
        {
+         bool newly_created_dir;
+
          /* slash points to the leftmost unprocessed component of dirpath.  */
          basename_dir = slash;
 
@@ -204,72 +227,56 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
          if (slash == NULL)
            break;
 
-         if (first_subdir)
-           {
-             first_subdir = 0;
-             saved_cwd = !save_cwd (&cwd);
-           }
-
-         /* If save_cwd could not record the current directory, then don't
-            do the chdir optimization and resort to using full pathnames.  */
-
-         if (!saved_cwd)
+         /* 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 (mkdir (basename_dir, tmp_mode))
+         if (! make_dir (basename_dir, dirpath, tmp_mode, &newly_created_dir))
            {
-             if (stat (basename_dir, &stats))
-               {
-                 error (0, errno, "cannot create directory `%s'", dirpath);
-                 CLEANUP;
-                 return 1;
-               }
-             else if (!S_ISDIR (stats.st_mode))
-               {
-                 error (0, 0, "`%s' exists but is not a directory", dirpath);
-                 CLEANUP;
-                 return 1;
-               }
-             else
-               {
-                 /* DIRPATH already exists and is a directory. */
-               }
+             CLEANUP;
+             return false;
            }
 
-         if (verbose_fmt_string != NULL)
-           error (0, 0, verbose_fmt_string, dirpath);
+         if (newly_created_dir)
+           {
+             if (verbose_fmt_string)
+               error (0, 0, verbose_fmt_string, quote (dirpath));
 
-         if (owner != (uid_t) -1 && group != (gid_t) -1
-             && chown (basename_dir, owner, group)
-#if defined(AFS) && defined (EPERM)
-             && errno != EPERM
+             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, "%s", dirpath);
-             CLEANUP;
-             return 1;
-           }
+                 )
+               {
+                 error (0, errno, _("cannot change owner and/or group of %s"),
+                        quote (dirpath));
+                 CLEANUP;
+                 return false;
+               }
 
-         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;
+               }
            }
 
          /* 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 (saved_cwd && chdir (basename_dir) < 0)
+         if (do_chdir && chdir (basename_dir) < 0)
            {
-             error (0, errno, "cannot chdir to directory, %s", dirpath);
+             error (0, errno, _("cannot chdir to directory %s"),
+                    quote (dirpath));
              CLEANUP;
-             return 1;
+             return false;
            }
 
          *slash++ = '/';
@@ -280,29 +287,25 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
            slash++;
        }
 
-      if (!saved_cwd)
+      if (!do_chdir)
        basename_dir = dirpath;
 
+      /* Done creating leading directories.  Restore original umask.  */
+      umask (oldmask);
+
       /* 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 (stat (basename_dir, &stats) && mkdir (basename_dir, mode))
+      if (! make_dir (basename_dir, dirpath, mode, NULL))
        {
-         error (0, errno, "cannot create directory `%s'", dirpath);
          CLEANUP;
-         return 1;
+         return false;
        }
 
-      /* Done creating directories.  Restore original umask.  */
-      umask (oldmask);
-
       if (verbose_fmt_string != NULL)
-       error (0, 0, verbose_fmt_string, dirpath);
+       error (0, 0, verbose_fmt_string, quote (dirpath));
 
-      if (owner != (uid_t) -1 && group != (gid_t) -1)
+      if (owner != (uid_t) -1 || group != (gid_t) -1)
        {
          if (chown (basename_dir, owner, group)
 #ifdef AFS
@@ -310,17 +313,25 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
 #endif
              )
            {
-             error (0, errno, "cannot chown %s", dirpath);
-             retval = 1;
-           }
-         /* chown may have turned off some permission bits we wanted.  */
-         if ((mode & 07000) != 0 && chmod (basename_dir, mode))
-           {
-             error (0, errno, "cannot chmod %s", dirpath);
-             retval = 1;
+             error (0, errno, _("cannot change owner and/or group of %s"),
+                    quote (dirpath));
+             retval = false;
            }
        }
 
+      /* The above chown may have turned off some permission bits in MODE.
+        Another reason we may have to use chmod here is that mkdir(2) is
+        required to honor only the file permission bits.  In particular,
+        it need not honor the `special' bits, so if MODE includes any
+        special bits, set them here.  */
+      if ((mode & ~S_IRWXUGO)
+         && chmod (basename_dir, mode))
+       {
+         error (0, errno, _("cannot change permissions of %s"),
+                quote (dirpath));
+         retval = false;
+       }
+
       CLEANUP_CWD;
 
       /* If the mode for leading directories didn't include owner "wx"
@@ -331,8 +342,9 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
          *(p->dirname_end) = '\0';
          if (chmod (dirpath, parent_mode))
            {
-             error (0, errno, "%s", dirpath);
-             retval = 1;
+             error (0, errno, _("cannot change permissions of %s"),
+                    quote (dirpath));
+             retval = false;
            }
        }
     }
@@ -344,8 +356,8 @@ make_path (argpath, mode, parent_mode, owner, group, preserve_existing,
 
       if (!S_ISDIR (stats.st_mode))
        {
-         error (0, 0, "`%s' exists but is not a directory", dirpath);
-         return 1;
+         error (0, 0, _("%s exists but is not a directory"), quote (dirpath));
+         return false;
        }
 
       if (!preserve_existing)
@@ -356,20 +368,22 @@ 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
 #endif
              )
            {
-             error (0, errno, "%s", dirpath);
-             retval = 1;
+             error (0, errno, _("cannot change owner and/or group of %s"),
+                    quote (dirpath));
+             retval = false;
            }
          if (chmod (dirpath, mode))
            {
-             error (0, errno, "%s", dirpath);
-             retval = 1;
+             error (0, errno, _("cannot change permissions of %s"),
+                                quote (dirpath));
+             retval = false;
            }
        }
     }