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 /* return non-zero if path is absolute or zero if relative. */
136 isAbsolute(const char *path)
138 #if defined(HAVE_CYGWIN) || defined(WIN32)
139 return path[1] == ':' || *path == '/' || *path == '\\'; /* drivespec:/blah is absolute */
145 /* Ensure that the directory ARGPATH exists.
146 Remove any trailing slashes from ARGPATH before calling this function.
148 Create any leading directories that don't already exist, with
149 permissions PARENT_MODE.
151 If the last element of ARGPATH does not exist, create it as
152 a new directory with permissions MODE.
154 If OWNER and GROUP are non-negative, use them to set the UID and GID of
155 any created directories.
157 If VERBOSE_FMT_STRING is nonzero, use it as a printf format
158 string for printing a message after successfully making a directory,
159 with the name of the directory that was just made as an argument.
161 If PRESERVE_EXISTING is non-zero and ARGPATH is an existing directory,
162 then do not attempt to set its permissions and ownership.
164 Return 0 if ARGPATH exists as a directory with the proper
165 ownership and permissions when done, otherwise 1. */
175 int preserve_existing,
176 char *verbose_fmt_string)
181 if (stat(argpath, &stats)) {
183 int tmp_mode; /* Initial perms for leading dirs. */
184 int re_protect; /* Should leading dirs be unwritable? */
187 struct ptr_list *next;
189 struct ptr_list *p, *leading_dirs = NULL;
190 struct saved_cwd cwd;
194 /* Temporarily relax umask in case it's overly restrictive. */
195 mode_t oldmask = umask(0);
197 /* Make a copy of ARGPATH that we can scribble NULs on. */
198 dirpath = (char *)alloca(strlen(argpath) + 1);
199 strcpy (dirpath, argpath);
200 strip_trailing_slashes(dirpath);
202 /* If leading directories shouldn't be writable or executable,
203 or should have set[ug]id or sticky bits set and we are setting
204 their owners, we need to fix their permissions after making them. */
205 if (((parent_mode & WX_USR) != WX_USR)
206 || ((owner != (uid_t)-1 || group != (gid_t)-1)
207 && (parent_mode & (S_ISUID | S_ISGID | S_ISVTX)) != 0)) {
211 tmp_mode = parent_mode;
215 #if defined(HAVE_CYGWIN)
216 /* Because of silly Win32 security, we allow everything */
217 tmp_mode = S_IRWXUGO;
221 /* If we can record the current working directory, we may be able
222 to do the chdir optimization. */
223 cwd.do_chdir = !save_cwd(&cwd);
225 /* If we've saved the cwd and DIRPATH is an absolute pathname,
226 we must chdir to `/' in order to enable the chdir optimization.
227 So if chdir ("/") fails, turn off the optimization. */
228 if (cwd.do_chdir && isAbsolute(dirpath) && (chdir("/") < 0)) {
234 /* Skip over leading slashes. */
235 while (*slash == '/')
239 int newly_created_dir;
242 /* slash points to the leftmost unprocessed component of dirpath. */
243 basename_dir = slash;
245 slash = strchr (slash, '/');
250 /* If we're *not* doing chdir before each mkdir, then we have to refer
251 to the target using the full (multi-component) directory name. */
253 basename_dir = dirpath;
257 fail = make_dir(jcr, basename_dir, dirpath, tmp_mode, &newly_created_dir);
264 if (newly_created_dir) {
265 Dmsg0(300, "newly_created_dir\n");
267 if ((owner != (uid_t)-1 || group != (gid_t)-1)
268 && chown(basename_dir, owner, group)
269 #if defined(AFS) && defined (EPERM)
273 /* Note, if we are restoring as NON-root, this may not be fatal */
274 Jmsg(jcr, M_ERROR, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
275 quote(dirpath), strerror(errno));
277 Dmsg0(300, "Chown done.\n");
280 struct ptr_list *pnew = (struct ptr_list *)
281 alloca(sizeof (struct ptr_list));
282 pnew->dirname_end = slash;
283 pnew->next = leading_dirs;
285 Dmsg0(300, "re_protect\n");
289 /* If we were able to save the initial working directory,
290 then we can use chdir to change into each directory before
291 creating an entry in that directory. This avoids making
292 stat and mkdir process O(n^2) file name components. */
293 if (cwd.do_chdir && chdir(basename_dir) < 0) {
294 Jmsg(jcr, M_ERROR, 0, _("Cannot chdir to directory, %s: ERR=%s\n"),
295 quote(dirpath), strerror(errno));
303 /* Avoid unnecessary calls to `stat' when given
304 pathnames containing multiple adjacent slashes. */
305 while (*slash == '/')
307 } /* end while (1) */
310 basename_dir = dirpath;
313 /* We're done making leading directories.
314 Create the final component of the path. */
316 Dmsg1(300, "Create final component. mode=%o\n", mode);
317 if (make_dir(jcr, basename_dir, dirpath, mode, NULL)) {
323 /* Done creating directories. Restore original umask. */
326 if (owner != (uid_t)-1 || group != (gid_t)-1) {
327 if (chown(basename_dir, owner, group)
333 Jmsg(jcr, M_WARNING, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
334 quote(dirpath), strerror(errno));
338 /* The above chown may have turned off some permission bits in MODE.
339 Another reason we may have to use chmod here is that mkdir(2) is
340 required to honor only the file permission bits. In particular,
341 it need not honor the `special' bits, so if MODE includes any
342 special bits, set them here. */
343 if (mode & ~S_IRWXUGO) {
344 Dmsg1(300, "Final chmod mode=%o\n", mode);
346 if ((mode & ~S_IRWXUGO) && chmod(basename_dir, mode)) {
347 Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
348 quote(dirpath), strerror(errno));
355 /* If the mode for leading directories didn't include owner "wx"
356 privileges, we have to reset their protections to the correct
358 for (p = leading_dirs; p != NULL; p = p->next) {
359 *(p->dirname_end) = '\0';
360 Dmsg2(300, "Reset parent mode=%o dir=%s\n", parent_mode, dirpath);
361 if (chmod(dirpath, parent_mode)) {
362 Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
363 quote(dirpath), strerror(errno));
367 /* We get here if the entire path already exists. */
369 const char *dirpath = argpath;
371 if (!S_ISDIR(stats.st_mode)) {
372 Jmsg(jcr, M_ERROR, 0, _("%s exists but is not a directory\n"), quote(dirpath));
376 if (!preserve_existing) {
377 Dmsg0(300, "Do not preserve existing.\n");
378 /* chown must precede chmod because on some systems,
379 chown clears the set[ug]id bits for non-superusers,
380 resulting in incorrect permissions.
381 On System V, users can give away files with chown and then not
382 be able to chmod them. So don't give files away. */
384 if ((owner != (uid_t)-1 || group != (gid_t)-1)
385 && chown(dirpath, owner, group)
390 Jmsg(jcr, M_WARNING, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
391 quote(dirpath), strerror(errno));
393 if (chmod(dirpath, mode)) {
394 Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
395 quote(dirpath), strerror(errno));
397 Dmsg2(300, "pathexists chmod mode=%o dir=%s\n", mode, dirpath);