git.sur5r.net Git - bacula/bacula/blob - bacula/src/findlib/makepath.c

   1 /* makepath.c -- Ensure that a directory path exists.
   2
   3    Copyright (C) 1990, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
   4
   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)
   8    any later version.
   9
  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.
  14
  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.  */
  18
  19 /* Written by David MacKenzie <djm@gnu.ai.mit.edu> and Jim Meyering.  */
  20
  21 /*
  22  *   Modified by Kern Sibbald for use in Bacula, December 2000
  23  *
  24  *   Version $Id$
  25  */
  26
  27 #include "bacula.h"
  28 #include "jcr.h"
  29 #include "save-cwd.h"
  30
  31
  32 #if !defined(S_ISDIR) && defined(S_IFDIR)
  33 # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
  34 #endif
  35
  36 #ifndef S_IRWXUGO
  37 # define S_IRWXUGO (S_IRWXU | S_IRWXG | S_IRWXO)
  38 #endif
  39
  40
  41 #ifndef S_ISUID
  42 # define S_ISUID 04000
  43 #endif
  44 #ifndef S_ISGID
  45 # define S_ISGID 02000
  46 #endif
  47 #ifndef S_ISVTX
  48 # define S_ISVTX 01000
  49 #endif
  50 #ifndef S_IRUSR
  51 # define S_IRUSR 0200
  52 #endif
  53 #ifndef S_IWUSR
  54 # define S_IWUSR 0200
  55 #endif
  56 #ifndef S_IXUSR
  57 # define S_IXUSR 0100
  58 #endif
  59
  60 #ifndef S_IRWXU
  61 # define S_IRWXU (S_IRUSR | S_IWUSR | S_IXUSR)
  62 #endif
  63
  64 #define WX_USR (S_IWUSR | S_IXUSR)
  65
  66 #define quote(path) path
  67
  68 extern void strip_trailing_slashes();
  69
  70 static int
  71 cleanup(struct saved_cwd *cwd)
  72 {
  73    if (cwd->do_chdir) {
  74       int _fail = restore_cwd(cwd, NULL, NULL);
  75       free_cwd(cwd);
  76       if (_fail) {
  77          return 1;
  78       }
  79    }
  80    return 0;
  81 }
  82
  83
  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.  */
  91
  92 static int
  93 make_dir(JCR *jcr, const char *dir, const char *dirpath, mode_t mode, int *created_dir_p)
  94 {
  95   int fail = 0;
  96   int created_dir;
  97   int save_errno;
  98
  99   Dmsg2(300, "make_dir mode=%o dir=%s\n", mode, dir);
 100   created_dir = (mkdir(dir, mode) == 0);
 101   save_errno = errno;
 102
 103   if (!created_dir) {
 104       struct stat stats;
 105
 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.  */
 113
 114       if (stat(dir, &stats)) {
 115           berrno be;
 116           be.set_errno(save_errno);
 117           Jmsg(jcr, M_ERROR, 0, _("Cannot create directory %s: ERR=%s\n"),
 118                   dirpath, be.strerror());
 119           fail = 1;
 120       } else if (!S_ISDIR(stats.st_mode)) {
 121           Jmsg(jcr, M_ERROR, 0, _("%s exists but is not a directory\n"), quote(dirpath));
 122           fail = 1;
 123       } else {
 124           /* DIR (aka DIRPATH) already exists and is a directory. */
 125       }
 126   }
 127
 128   if (created_dir_p) {
 129      *created_dir_p = created_dir;
 130   }
 131
 132   return fail;
 133 }
 134
 135 /* return non-zero if path is absolute or zero if relative. */
 136 int
 137 isAbsolute(const char *path)
 138 {
 139 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
 140     return path[1] == ':' || *path == '/' || *path == '\\';     /* drivespec:/blah is absolute */
 141 #else
 142     return *path == '/';
 143 #endif
 144 }
 145
 146 /* Ensure that the directory ARGPATH exists.
 147    Remove any trailing slashes from ARGPATH before calling this function.
 148
 149    Create any leading directories that don't already exist, with
 150    permissions PARENT_MODE.
 151
 152    If the last element of ARGPATH does not exist, create it as
 153    a new directory with permissions MODE.
 154
 155    If OWNER and GROUP are non-negative, use them to set the UID and GID of
 156    any created directories.
 157
 158    If VERBOSE_FMT_STRING is nonzero, use it as a printf format
 159    string for printing a message after successfully making a directory,
 160    with the name of the directory that was just made as an argument.
 161
 162    If PRESERVE_EXISTING is non-zero and ARGPATH is an existing directory,
 163    then do not attempt to set its permissions and ownership.
 164
 165    Return 0 if ARGPATH exists as a directory with the proper
 166    ownership and permissions when done, otherwise 1.  */
 167
 168 int
 169 make_path(
 170            JCR *jcr,
 171            const char *argpath,
 172            int mode,
 173            int parent_mode,
 174            uid_t owner,
 175            gid_t group,
 176            int preserve_existing,
 177            char *verbose_fmt_string)
 178 {
 179   struct stat stats;
 180   int retval = 0;
 181
 182   if (stat(argpath, &stats)) {
 183       char *slash;
 184       int tmp_mode;             /* Initial perms for leading dirs.  */
 185       int re_protect;           /* Should leading dirs be unwritable? */
 186       struct ptr_list {
 187         char *dirname_end;
 188         struct ptr_list *next;
 189       };
 190       struct ptr_list *p, *leading_dirs = NULL;
 191       struct saved_cwd cwd;
 192       char *basename_dir;
 193       char *dirpath;
 194
 195       /* Temporarily relax umask in case it's overly restrictive.  */
 196       mode_t oldmask = umask(0);
 197
 198       /* Make a copy of ARGPATH that we can scribble NULs on.  */
 199       dirpath = (char *)alloca(strlen(argpath) + 1);
 200       strcpy (dirpath, argpath);
 201       strip_trailing_slashes(dirpath);
 202
 203       /* If leading directories shouldn't be writable or executable,
 204          or should have set[ug]id or sticky bits set and we are setting
 205          their owners, we need to fix their permissions after making them.  */
 206       if (((parent_mode & WX_USR) != WX_USR)
 207           || ((owner != (uid_t)-1 || group != (gid_t)-1)
 208               && (parent_mode & (S_ISUID | S_ISGID | S_ISVTX)) != 0)) {
 209          tmp_mode = S_IRWXU;
 210          re_protect = 1;
 211       } else {
 212          tmp_mode = parent_mode;
 213          re_protect = 0;
 214       }
 215
 216 #if defined(HAVE_CYGWIN)
 217       /* Because of silly Win32 security, we allow everything */
 218       tmp_mode = S_IRWXUGO;
 219       re_protect = 0;
 220 #endif
 221
 222       /* If we can record the current working directory, we may be able
 223          to do the chdir optimization.  */
 224       cwd.do_chdir = !save_cwd(&cwd);
 225
 226       /* If we've saved the cwd and DIRPATH is an absolute pathname,
 227          we must chdir to `/' in order to enable the chdir optimization.
 228          So if chdir ("/") fails, turn off the optimization.  */
 229       if (cwd.do_chdir && isAbsolute(dirpath) && (chdir("/") < 0)) {
 230          cwd.do_chdir = 0;
 231       }
 232
 233       slash = dirpath;
 234
 235       /* Skip over leading slashes.  */
 236       while (*slash == '/')
 237          slash++;
 238
 239       while (1) {
 240           int newly_created_dir;
 241           int fail;
 242
 243           /* slash points to the leftmost unprocessed component of dirpath.  */
 244           basename_dir = slash;
 245
 246           slash = strchr (slash, '/');
 247           if (slash == NULL) {
 248              break;
 249           }
 250
 251           /* If we're *not* doing chdir before each mkdir, then we have to refer
 252              to the target using the full (multi-component) directory name.  */
 253           if (!cwd.do_chdir) {
 254              basename_dir = dirpath;
 255           }
 256
 257           *slash = '\0';
 258           fail = make_dir(jcr, basename_dir, dirpath, tmp_mode, &newly_created_dir);
 259           if (fail) {
 260               umask(oldmask);
 261               cleanup(&cwd);
 262               return 1;
 263           }
 264
 265           if (newly_created_dir) {
 266               Dmsg0(300, "newly_created_dir\n");
 267
 268               if ((owner != (uid_t)-1 || group != (gid_t)-1)
 269                   && chown(basename_dir, owner, group)
 270 #if defined(AFS) && defined (EPERM)
 271                   && errno != EPERM
 272 #endif
 273                   ) {
 274                  /* Note, if we are restoring as NON-root, this may not be fatal */
 275                  berrno be;
 276                  Jmsg(jcr, M_ERROR, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
 277                       quote(dirpath), be.strerror());
 278               }
 279               Dmsg0(300, "Chown done.\n");
 280
 281               if (re_protect) {
 282                  struct ptr_list *pnew = (struct ptr_list *)
 283                     alloca(sizeof (struct ptr_list));
 284                  pnew->dirname_end = slash;
 285                  pnew->next = leading_dirs;
 286                  leading_dirs = pnew;
 287                  Dmsg0(300, "re_protect\n");
 288               }
 289           }
 290
 291           /* If we were able to save the initial working directory,
 292              then we can use chdir to change into each directory before
 293              creating an entry in that directory.  This avoids making
 294              stat and mkdir process O(n^2) file name components.  */
 295           if (cwd.do_chdir && chdir(basename_dir) < 0) {
 296               berrno be;
 297               Jmsg(jcr, M_ERROR, 0, _("Cannot chdir to directory, %s: ERR=%s\n"),
 298                      quote(dirpath), be.strerror());
 299               umask(oldmask);
 300               cleanup(&cwd);
 301               return 1;
 302           }
 303
 304           *slash++ = '/';
 305
 306           /* Avoid unnecessary calls to `stat' when given
 307              pathnames containing multiple adjacent slashes.  */
 308           while (*slash == '/')
 309              slash++;
 310       } /* end while (1) */
 311
 312       if (!cwd.do_chdir) {
 313          basename_dir = dirpath;
 314       }
 315
 316       /* We're done making leading directories.
 317          Create the final component of the path.  */
 318
 319       Dmsg1(300, "Create final component. mode=%o\n", mode);
 320       if (make_dir(jcr, basename_dir, dirpath, mode, NULL)) {
 321           umask(oldmask);
 322           cleanup(&cwd);
 323           return 1;
 324       }
 325
 326       /* Done creating directories.  Restore original umask.  */
 327       umask(oldmask);
 328
 329       if (owner != (uid_t)-1 || group != (gid_t)-1) {
 330           if (chown(basename_dir, owner, group)
 331 #ifdef AFS
 332               && errno != EPERM
 333 #endif
 334               )
 335             {
 336               berrno be;
 337               Jmsg(jcr, M_WARNING, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
 338                      quote(dirpath), be.strerror());
 339             }
 340       }
 341
 342       /* The above chown may have turned off some permission bits in MODE.
 343          Another reason we may have to use chmod here is that mkdir(2) is
 344          required to honor only the file permission bits.  In particular,
 345          it need not honor the `special' bits, so if MODE includes any
 346          special bits, set them here.  */
 347       if (mode & ~S_IRWXUGO) {
 348          Dmsg1(300, "Final chmod mode=%o\n", mode);
 349       }
 350       if ((mode & ~S_IRWXUGO) && chmod(basename_dir, mode)) {
 351           berrno be;
 352           Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
 353              quote(dirpath), be.strerror());
 354       }
 355
 356      if (cleanup(&cwd)) {
 357         return 1;
 358      }
 359
 360       /* If the mode for leading directories didn't include owner "wx"
 361          privileges, we have to reset their protections to the correct
 362          value.  */
 363       for (p = leading_dirs; p != NULL; p = p->next) {
 364           *(p->dirname_end) = '\0';
 365           Dmsg2(300, "Reset parent mode=%o dir=%s\n", parent_mode, dirpath);
 366           if (chmod(dirpath, parent_mode)) {
 367               berrno be;
 368               Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
 369                      quote(dirpath), be.strerror());
 370           }
 371       }
 372   } else {
 373       /* We get here if the entire path already exists.  */
 374
 375       const char *dirpath = argpath;
 376
 377       if (!S_ISDIR(stats.st_mode)) {
 378           Jmsg(jcr, M_ERROR, 0, _("%s exists but is not a directory\n"), quote(dirpath));
 379           return 1;
 380       }
 381
 382       if (!preserve_existing) {
 383           Dmsg0(300, "Do not preserve existing.\n");
 384           /* chown must precede chmod because on some systems,
 385              chown clears the set[ug]id bits for non-superusers,
 386              resulting in incorrect permissions.
 387              On System V, users can give away files with chown and then not
 388              be able to chmod them.  So don't give files away.  */
 389
 390           if ((owner != (uid_t)-1 || group != (gid_t)-1)
 391               && chown(dirpath, owner, group)
 392 #ifdef AFS
 393               && errno != EPERM
 394 #endif
 395               ) {
 396               berrno be;
 397               Jmsg(jcr, M_WARNING, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
 398                      quote(dirpath), be.strerror());
 399             }
 400           if (chmod(dirpath, mode)) {
 401               berrno be;
 402               Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
 403                                  quote(dirpath), be.strerror());
 404           }
 405           Dmsg2(300, "pathexists chmod mode=%o dir=%s\n", mode, dirpath);
 406       }
 407   }
 408   return retval;
 409 }