From 78cd5b80f6b2f3bb6ca1be80ae196c685b19e89f Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Thu, 2 Jun 2005 04:55:35 +0000 Subject: [PATCH] Renamed from makepath.c. (make_dir_parents): Renamed from make_path. All callers changed. --- lib/mkdir-p.c | 398 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 398 insertions(+) create mode 100644 lib/mkdir-p.c diff --git a/lib/mkdir-p.c b/lib/mkdir-p.c new file mode 100644 index 0000000..433d871 --- /dev/null +++ b/lib/mkdir-p.c @@ -0,0 +1,398 @@ +/* mkdir-p.c -- Ensure that a directory and its parents exist. + + Copyright (C) 1990, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005 + 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 + the Free Software Foundation; either version 2, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ + +/* Written by David MacKenzie and Jim Meyering. */ + +#if HAVE_CONFIG_H +# include +#endif + +#include "mkdir-p.h" + +#include + +#include +#include +#include +#if HAVE_UNISTD_H +# include +#endif + +#include +#include +#include + +#include "gettext.h" +#define _(msgid) gettext (msgid) + +#include "save-cwd.h" +#include "dirname.h" +#include "error.h" +#include "quote.h" +#include "stat-macros.h" + +#define WX_USR (S_IWUSR | S_IXUSR) + +#define CLEANUP_CWD \ + do \ + { \ + /* We're done operating on basename_dir. \ + Restore working directory. */ \ + if (do_chdir) \ + { \ + 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); \ + } \ + } \ + while (0) + +#define CLEANUP \ + do \ + { \ + umask (oldmask); \ + CLEANUP_CWD; \ + } \ + while (0) + +/* Attempt to create directory DIR (aka FULLDIR) 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 FULLDIR 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 (char const *dir, char const *fulldir, 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 (fulldir)); + ok = false; + } + else if (!S_ISDIR (stats.st_mode)) + { + error (0, 0, _("%s exists but is not a directory"), quote (fulldir)); + ok = false; + } + else + { + /* DIR (aka FULLDIR) already exists and is a directory. */ + } + } + + if (created_dir_p) + *created_dir_p = created_dir; + + return ok; +} + +/* Ensure that the directory ARG exists. + + Create any leading directories that don't already exist, with + permissions PARENT_MODE. + If the last element of ARG does not exist, create it as + a new directory with permissions MODE. + If OWNER and GROUP are non-negative, use them to set the UID and GID of + any created directories. + 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 true and ARG is an existing directory, + then do not attempt to set its permissions and ownership. + + Return true iff ARG exists as a directory with the proper + ownership and permissions when done. */ + +bool +make_dir_parents (char const *arg, + mode_t mode, + mode_t parent_mode, + uid_t owner, + gid_t group, + bool preserve_existing, + char const *verbose_fmt_string) +{ + struct stat stats; + bool retval = true; + + if (stat (arg, &stats) != 0) + { + char *slash; + 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; + bool do_chdir; /* Whether to chdir before each mkdir. */ + struct saved_cwd cwd; + char *basename_dir; + char *dir; + + /* Temporarily relax umask in case it's overly restrictive. */ + mode_t oldmask = umask (0); + + /* Make a copy of ARG that we can scribble NULs on. */ + dir = (char *) alloca (strlen (arg) + 1); + strcpy (dir, arg); + strip_trailing_slashes (dir); + + /* 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 & WX_USR) != WX_USR) + || ((owner != (uid_t) -1 || group != (gid_t) -1) + && (parent_mode & (S_ISUID | S_ISGID | S_ISVTX)) != 0)) + { + tmp_mode = S_IRWXU; + re_protect = true; + } + else + { + tmp_mode = parent_mode; + 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 DIR is an absolute file name, + we must chdir to `/' in order to enable the chdir optimization. + So if chdir ("/") fails, turn off the optimization. */ + if (do_chdir && dir[0] == '/') + { + /* POSIX says "//" might be special, so chdir to "//" if the + file name starts with exactly two slashes. */ + char const *root = "//" + (dir[1] != '/' || dir[2] == '/'); + if (chdir (root) != 0) + do_chdir = false; + } + + slash = dir; + + /* Skip over leading slashes. */ + while (*slash == '/') + slash++; + + while (1) + { + bool newly_created_dir; + + /* slash points to the leftmost unprocessed component of dir. */ + 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 = dir; + + *slash = '\0'; + if (! make_dir (basename_dir, dir, tmp_mode, &newly_created_dir)) + { + CLEANUP; + return false; + } + + if (newly_created_dir) + { + if (verbose_fmt_string) + error (0, 0, verbose_fmt_string, quote (dir)); + + 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 change owner and/or group of %s"), + quote (dir)); + 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 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, errno, _("cannot chdir to directory %s"), + quote (dir)); + CLEANUP; + return false; + } + + *slash++ = '/'; + + /* Avoid unnecessary calls to `stat' when given + file names containing multiple adjacent slashes. */ + while (*slash == '/') + slash++; + } + + if (!do_chdir) + basename_dir = dir; + + /* Done creating leading directories. Restore original umask. */ + umask (oldmask); + + /* We're done making leading directories. + Create the final component of the file name. */ + + if (! make_dir (basename_dir, dir, mode, NULL)) + { + CLEANUP; + return false; + } + + if (verbose_fmt_string != NULL) + error (0, 0, verbose_fmt_string, quote (dir)); + + if (owner != (uid_t) -1 || group != (gid_t) -1) + { + if (chown (basename_dir, owner, group) +#ifdef AFS + && errno != EPERM +#endif + ) + { + error (0, errno, _("cannot change owner and/or group of %s"), + quote (dir)); + 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 (dir)); + retval = false; + } + + CLEANUP_CWD; + + /* If the mode for leading directories didn't include owner "wx" + privileges, we have to reset their protections to the correct + value. */ + for (p = leading_dirs; p != NULL; p = p->next) + { + *(p->dirname_end) = '\0'; + if (chmod (dir, parent_mode) != 0) + { + error (0, errno, _("cannot change permissions of %s"), + quote (dir)); + retval = false; + } + } + } + else + { + /* We get here if the file already exists. */ + + char const *dir = arg; + + if (!S_ISDIR (stats.st_mode)) + { + error (0, 0, _("%s exists but is not a directory"), quote (dir)); + return false; + } + + if (!preserve_existing) + { + /* chown must precede chmod because on some systems, + chown clears the set[ug]id bits for non-superusers, + resulting in incorrect permissions. + 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) + && chown (dir, owner, group) +#ifdef AFS + && errno != EPERM +#endif + ) + { + error (0, errno, _("cannot change owner and/or group of %s"), + quote (dir)); + retval = false; + } + if (chmod (dir, mode) != 0) + { + error (0, errno, _("cannot change permissions of %s"), + quote (dir)); + retval = false; + } + } + } + + return retval; +} -- 2.7.4