1 /* makepath.c -- Ensure that a directory path exists.
3 Copyright (C) 1990, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19 /* Written by David MacKenzie <djm@gnu.ai.mit.edu> and Jim Meyering. */
22 * Modified by Kern Sibbald for use in Bacula, December 2000
32 #if !defined(S_ISDIR) && defined(S_IFDIR)
33 # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
37 # define S_IRWXUGO (S_IRWXU | S_IRWXG | S_IRWXO)
42 # define S_ISUID 04000
45 # define S_ISGID 02000
48 # define S_ISVTX 01000
61 # define S_IRWXU (S_IRUSR | S_IWUSR | S_IXUSR)
64 #define WX_USR (S_IWUSR | S_IXUSR)
66 #define quote(path) path
68 extern void strip_trailing_slashes();
71 cleanup(struct saved_cwd *cwd)
74 int _fail = restore_cwd(cwd, NULL, NULL);
84 /* Attempt to create directory DIR (aka DIRPATH) with the specified MODE.
85 If CREATED_DIR_P is non-NULL, set *CREATED_DIR_P to non-zero if this
86 function creates DIR and to zero otherwise. Give a diagnostic and
87 return non-zero if DIR cannot be created or cannot be determined to
88 exist already. Use DIRPATH in any diagnostic, not DIR.
89 Note that if DIR already exists, this function will return zero
90 (indicating success) and will set *CREATED_DIR_P to zero. */
93 make_dir(JCR *jcr, const char *dir, const char *dirpath, mode_t mode, int *created_dir_p)
99 Dmsg2(300, "make_dir mode=%o dir=%s\n", mode, dir);
100 created_dir = (mkdir(dir, mode) == 0);
106 /* The mkdir and stat calls below may appear to be reversed.
107 They are not. It is important to call mkdir first and then to
108 call stat (to distinguish the three cases) only if mkdir fails.
109 The alternative to this approach is to `stat' each directory,
110 then to call mkdir if it doesn't exist. But if some other process
111 were to create the directory between the stat & mkdir, the mkdir
112 would fail with EEXIST. */
114 if (stat(dir, &stats)) {
115 Jmsg(jcr, M_ERROR, 0, _("Cannot create directory %s: ERR=%s\n"),
116 dirpath, strerror(save_errno));
118 } else if (!S_ISDIR(stats.st_mode)) {
119 Jmsg(jcr, M_ERROR, 0, _("%s exists but is not a directory\n"), quote(dirpath));
122 /* DIR (aka DIRPATH) already exists and is a directory. */
127 *created_dir_p = created_dir;
133 /* Ensure that the directory ARGPATH exists.
134 Remove any trailing slashes from ARGPATH before calling this function.
136 Create any leading directories that don't already exist, with
137 permissions PARENT_MODE.
139 If the last element of ARGPATH does not exist, create it as
140 a new directory with permissions MODE.
142 If OWNER and GROUP are non-negative, use them to set the UID and GID of
143 any created directories.
145 If VERBOSE_FMT_STRING is nonzero, use it as a printf format
146 string for printing a message after successfully making a directory,
147 with the name of the directory that was just made as an argument.
149 If PRESERVE_EXISTING is non-zero and ARGPATH is an existing directory,
150 then do not attempt to set its permissions and ownership.
152 Return 0 if ARGPATH exists as a directory with the proper
153 ownership and permissions when done, otherwise 1. */
163 int preserve_existing,
164 char *verbose_fmt_string)
169 if (stat(argpath, &stats)) {
171 int tmp_mode; /* Initial perms for leading dirs. */
172 int re_protect; /* Should leading dirs be unwritable? */
175 struct ptr_list *next;
177 struct ptr_list *p, *leading_dirs = NULL;
178 struct saved_cwd cwd;
182 /* Temporarily relax umask in case it's overly restrictive. */
183 mode_t oldmask = umask(0);
185 /* Make a copy of ARGPATH that we can scribble NULs on. */
186 dirpath = (char *)alloca(strlen(argpath) + 1);
187 strcpy (dirpath, argpath);
188 strip_trailing_slashes(dirpath);
190 /* If leading directories shouldn't be writable or executable,
191 or should have set[ug]id or sticky bits set and we are setting
192 their owners, we need to fix their permissions after making them. */
193 if (((parent_mode & WX_USR) != WX_USR)
194 || ((owner != (uid_t)-1 || group != (gid_t)-1)
195 && (parent_mode & (S_ISUID | S_ISGID | S_ISVTX)) != 0)) {
199 tmp_mode = parent_mode;
203 /* If we can record the current working directory, we may be able
204 to do the chdir optimization. */
205 cwd.do_chdir = !save_cwd(&cwd);
207 /* If we've saved the cwd and DIRPATH is an absolute pathname,
208 we must chdir to `/' in order to enable the chdir optimization.
209 So if chdir ("/") fails, turn off the optimization. */
210 if (cwd.do_chdir && *dirpath == '/' && chdir ("/") < 0) {
216 /* Skip over leading slashes. */
217 while (*slash == '/')
221 int newly_created_dir;
224 /* slash points to the leftmost unprocessed component of dirpath. */
225 basename_dir = slash;
227 slash = strchr (slash, '/');
232 /* If we're *not* doing chdir before each mkdir, then we have to refer
233 to the target using the full (multi-component) directory name. */
235 basename_dir = dirpath;
239 fail = make_dir(jcr, basename_dir, dirpath, tmp_mode, &newly_created_dir);
246 if (newly_created_dir) {
247 Dmsg0(300, "newly_created_dir\n");
249 if ((owner != (uid_t)-1 || group != (gid_t)-1)
250 && chown(basename_dir, owner, group)
251 #if defined(AFS) && defined (EPERM)
255 /* Note, if we are restoring as NON-root, this may not be fatal */
256 Jmsg(jcr, M_ERROR, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
257 quote(dirpath), strerror(errno));
259 Dmsg0(300, "Chown done.\n");
262 struct ptr_list *pnew = (struct ptr_list *)
263 alloca(sizeof (struct ptr_list));
264 pnew->dirname_end = slash;
265 pnew->next = leading_dirs;
267 Dmsg0(300, "re_protect\n");
271 /* If we were able to save the initial working directory,
272 then we can use chdir to change into each directory before
273 creating an entry in that directory. This avoids making
274 stat and mkdir process O(n^2) file name components. */
275 if (cwd.do_chdir && chdir(basename_dir) < 0) {
276 Jmsg(jcr, M_ERROR, 0, _("Cannot chdir to directory, %s: ERR=%s\n"),
277 quote(dirpath), strerror(errno));
285 /* Avoid unnecessary calls to `stat' when given
286 pathnames containing multiple adjacent slashes. */
287 while (*slash == '/')
289 } /* end while (1) */
292 basename_dir = dirpath;
295 /* We're done making leading directories.
296 Create the final component of the path. */
298 Dmsg1(300, "Create final component. mode=%o\n", mode);
299 if (make_dir(jcr, basename_dir, dirpath, mode, NULL)) {
305 /* Done creating directories. Restore original umask. */
308 if (owner != (uid_t)-1 || group != (gid_t)-1) {
309 if (chown(basename_dir, owner, group)
315 Jmsg(jcr, M_ERROR, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
316 quote(dirpath), strerror(errno));
320 /* The above chown may have turned off some permission bits in MODE.
321 Another reason we may have to use chmod here is that mkdir(2) is
322 required to honor only the file permission bits. In particular,
323 it need not honor the `special' bits, so if MODE includes any
324 special bits, set them here. */
325 if (mode & ~S_IRWXUGO) {
326 Dmsg1(300, "Final chmod mode=%o\n", mode);
328 if ((mode & ~S_IRWXUGO) && chmod(basename_dir, mode)) {
329 Jmsg(jcr, M_ERROR, 0, _("Cannot change permissions of %s: ERR=%s\n"),
330 quote(dirpath), strerror(errno));
337 /* If the mode for leading directories didn't include owner "wx"
338 privileges, we have to reset their protections to the correct
340 for (p = leading_dirs; p != NULL; p = p->next) {
341 *(p->dirname_end) = '\0';
342 Dmsg2(300, "Reset parent mode=%o dir=%s\n", parent_mode, dirpath);
343 if (chmod(dirpath, parent_mode)) {
344 Jmsg(jcr, M_ERROR, 0, _("Cannot change permissions of %s: ERR=%s\n"),
345 quote (dirpath), strerror(errno));
349 /* We get here if the entire path already exists. */
351 const char *dirpath = argpath;
353 if (!S_ISDIR(stats.st_mode)) {
354 Jmsg(jcr, M_ERROR, 0, _("%s exists but is not a directory\n"), quote(dirpath));
358 if (!preserve_existing) {
359 Dmsg0(300, "Do not preserve existing.\n");
360 /* chown must precede chmod because on some systems,
361 chown clears the set[ug]id bits for non-superusers,
362 resulting in incorrect permissions.
363 On System V, users can give away files with chown and then not
364 be able to chmod them. So don't give files away. */
366 if ((owner != (uid_t)-1 || group != (gid_t)-1)
367 && chown(dirpath, owner, group)
372 Jmsg(jcr, M_ERROR, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
373 quote(dirpath), strerror(errno));
375 if (chmod(dirpath, mode)) {
376 Jmsg(jcr, M_ERROR, 0, _("Cannot change permissions of %s: ERR=%s\n"),
377 quote(dirpath), strerror(errno));
379 Dmsg2(300, "pathexists chmod mode=%o dir=%s\n", mode, dirpath);