From Derek Price:
[gnulib.git] / lib / makepath.c
index ea1b407..1bc12c3 100644 (file)
@@ -1,5 +1,7 @@
 /* makepath.c -- Ensure that a directory path exists.
-   Copyright (C) 1990, 1997, 1998, 1999, 2000 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,87 +34,20 @@ 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
-
-#ifndef S_IRWXUGO
-# define S_IRWXUGO (S_IRWXU | S_IRWXG | S_IRWXO)
-#endif
-
-#if STDC_HEADERS
-# include <stdlib.h>
-#endif
-
-#if HAVE_ERRNO_H
-# include <errno.h>
-#endif
-
-#ifndef errno
-extern int errno;
-#endif
-
-#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
+#include <stdlib.h>
+#include <errno.h>
+#include <string.h>
 
-#if ENABLE_NLS
-# include <libintl.h>
-# define _(Text) gettext (Text)
-#else
-# define _(Text) Text
-#endif
-
-#ifdef __MSDOS__
-typedef int uid_t;
-typedef int gid_t;
-#endif
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
 
 #include "save-cwd.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                                                   \
@@ -131,10 +56,16 @@ void strip_trailing_slashes ();
         Restore working directory.  */                 \
       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)
@@ -148,18 +79,19 @@ 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 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
+   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 will return zero
-   (indicating success) and will set *CREATED_DIR_P to zero.  */
+   Note that if DIR already exists, this function returns true
+   (indicating success) and clears *CREATED_DIR_P.  */
 
-static int
-make_dir (const char *dir, const char *dirpath, mode_t mode, int *created_dir_p)
+bool
+make_dir (const char *dir, const char *dirpath, mode_t mode,
+         bool *created_dir_p)
 {
-  int fail = 0;
-  int created_dir;
+  bool ok = true;
+  bool created_dir;
 
   created_dir = (mkdir (dir, mode) == 0);
 
@@ -178,13 +110,14 @@ make_dir (const char *dir, const char *dirpath, mode_t mode, int *created_dir_p)
 
       if (stat (dir, &stats))
        {
-         error (0, saved_errno, _("cannot create directory `%s'"), dirpath);
-         fail = 1;
+         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"), dirpath);
-         fail = 1;
+         error (0, 0, _("%s exists but is not a directory"), quote (dirpath));
+         ok = false;
        }
       else
        {
@@ -195,11 +128,10 @@ make_dir (const char *dir, const char *dirpath, mode_t mode, int *created_dir_p)
   if (created_dir_p)
     *created_dir_p = created_dir;
 
-  return fail;
+  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.
@@ -210,36 +142,36 @@ make_dir (const char *dir, const char *dirpath, mode_t mode, int *created_dir_p)
    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.  */
 
-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)
 {
   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 do_chdir;            /* Whether to chdir before each mkdir.  */
+      bool do_chdir;           /* Whether to chdir before each mkdir.  */
       struct saved_cwd cwd;
       char *basename_dir;
       char *dirpath;
@@ -260,23 +192,23 @@ make_path (const char *argpath,
              && (parent_mode & (S_ISUID | S_ISGID | S_ISVTX)) != 0))
        {
          tmp_mode = S_IRWXU;
-         re_protect = 1;
+         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);
+      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 = 0;
+       do_chdir = false;
 
       slash = dirpath;
 
@@ -286,8 +218,7 @@ make_path (const char *argpath,
 
       while (1)
        {
-         int newly_created_dir;
-         int fail;
+         bool newly_created_dir;
 
          /* slash points to the leftmost unprocessed component of dirpath.  */
          basename_dir = slash;
@@ -302,28 +233,28 @@ make_path (const char *argpath,
            basename_dir = dirpath;
 
          *slash = '\0';
-         fail = make_dir (basename_dir, dirpath, tmp_mode, &newly_created_dir);
-         if (fail)
+         if (! make_dir (basename_dir, dirpath, tmp_mode, &newly_created_dir))
            {
              CLEANUP;
-             return 1;
+             return false;
            }
 
          if (newly_created_dir)
            {
              if (verbose_fmt_string)
-               error (0, 0, verbose_fmt_string, dirpath);
+               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)
+#if defined AFS && defined EPERM
                  && errno != EPERM
 #endif
                  )
                {
-                 error (0, errno, "%s", dirpath);
+                 error (0, errno, _("cannot change owner and/or group of %s"),
+                        quote (dirpath));
                  CLEANUP;
-                 return 1;
+                 return false;
                }
 
              if (re_protect)
@@ -342,9 +273,10 @@ make_path (const char *argpath,
             stat and mkdir process O(n^2) file name components.  */
          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++ = '/';
@@ -358,20 +290,20 @@ make_path (const char *argpath,
       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.  */
 
-      if (make_dir (basename_dir, dirpath, mode, NULL))
+      if (make_dir (basename_dir, dirpath, mode, NULL))
        {
          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)
        {
@@ -381,20 +313,23 @@ make_path (const char *argpath,
 #endif
              )
            {
-             error (0, errno, _("cannot chown %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 may not have honored the `special' bits.  */
+        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 chmod %s"), dirpath);
-         retval = 1;
+         error (0, errno, _("cannot change permissions of %s"),
+                quote (dirpath));
+         retval = false;
        }
 
       CLEANUP_CWD;
@@ -407,8 +342,9 @@ make_path (const char *argpath,
          *(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;
            }
        }
     }
@@ -420,8 +356,8 @@ make_path (const char *argpath,
 
       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)
@@ -439,13 +375,15 @@ make_path (const char *argpath,
 #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;
            }
        }
     }