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_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_WIN32)
 217       /* chdir can fail if permissions are sufficiently restricted since I don't think
 218          backup/restore security rights affect ChangeWorkingDirectory */
 219       cwd.do_chdir = 0;
 220
 221       /* Validate drive letter */
 222       if (dirpath[1] == ':') {
 223          char drive[4] = "X:\\";
 224
 225          drive[0] = dirpath[0];
 226
 227          UINT drive_type = GetDriveType(drive);
 228
 229          if (drive_type == DRIVE_UNKNOWN || drive_type == DRIVE_NO_ROOT_DIR) {
 230             Jmsg(jcr, M_ERROR, 0, _("%c: is not a valid drive\n"), dirpath[0]);
 231             return 1;
 232          }
 233
 234          if (dirpath[2] == '\0') {
 235             return 0;
 236          }
 237
 238          slash = &dirpath[3];
 239       } else {
 240          slash = dirpath;
 241       }
 242 #else
 243       /* If we can record the current working directory, we may be able
 244          to do the chdir optimization.  */
 245       cwd.do_chdir = !save_cwd(&cwd);
 246
 247       slash = dirpath;
 248 #endif
 249
 250       /* If we've saved the cwd and DIRPATH is an absolute pathname,
 251          we must chdir to `/' in order to enable the chdir optimization.
 252          So if chdir ("/") fails, turn off the optimization.  */
 253       if (cwd.do_chdir && isAbsolute(dirpath) && (chdir("/") < 0)) {
 254          cwd.do_chdir = 0;
 255       }
 256
 257       /* Skip over leading slashes.  */
 258 #if defined(HAVE_WIN32)
 259       while (*slash == '/' || *slash == '\\')
 260          slash++;
 261 #else
 262       while (*slash == '/')
 263          slash++;
 264 #endif
 265       while (1) {
 266           int newly_created_dir;
 267           int fail;
 268
 269           /* slash points to the leftmost unprocessed component of dirpath.  */
 270           basename_dir = slash;
 271
 272 #if defined(HAVE_WIN32)
 273           slash = strpbrk(slash, ":/\\");
 274           if (slash == NULL) {
 275              break;
 276           }
 277 #else
 278           slash = strchr (slash, '/');
 279           if (slash == NULL) {
 280              break;
 281           }
 282 #endif
 283
 284           /* If we're *not* doing chdir before each mkdir, then we have to refer
 285              to the target using the full (multi-component) directory name.  */
 286           if (!cwd.do_chdir) {
 287              basename_dir = dirpath;
 288           }
 289
 290           *slash = '\0';
 291           fail = make_dir(jcr, basename_dir, dirpath, tmp_mode, &newly_created_dir);
 292           if (fail) {
 293               umask(oldmask);
 294               cleanup(&cwd);
 295               return 1;
 296           }
 297
 298           if (newly_created_dir) {
 299               Dmsg0(300, "newly_created_dir\n");
 300
 301               if ((owner != (uid_t)-1 || group != (gid_t)-1)
 302                   && chown(basename_dir, owner, group)
 303 #if defined(AFS) && defined (EPERM)
 304                   && errno != EPERM
 305 #endif
 306                   ) {
 307                  /* Note, if we are restoring as NON-root, this may not be fatal */
 308                  berrno be;
 309                  Jmsg(jcr, M_ERROR, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
 310                       quote(dirpath), be.strerror());
 311               }
 312               Dmsg0(300, "Chown done.\n");
 313
 314               if (re_protect) {
 315                  struct ptr_list *pnew = (struct ptr_list *)
 316                     alloca(sizeof (struct ptr_list));
 317                  pnew->dirname_end = slash;
 318                  pnew->next = leading_dirs;
 319                  leading_dirs = pnew;
 320                  Dmsg0(300, "re_protect\n");
 321               }
 322           }
 323
 324           /* If we were able to save the initial working directory,
 325              then we can use chdir to change into each directory before
 326              creating an entry in that directory.  This avoids making
 327              stat and mkdir process O(n^2) file name components.  */
 328           if (cwd.do_chdir && chdir(basename_dir) < 0) {
 329               berrno be;
 330               Jmsg(jcr, M_ERROR, 0, _("Cannot chdir to directory, %s: ERR=%s\n"),
 331                      quote(dirpath), be.strerror());
 332               umask(oldmask);
 333               cleanup(&cwd);
 334               return 1;
 335           }
 336
 337           *slash++ = '/';
 338
 339           /* Avoid unnecessary calls to `stat' when given
 340              pathnames containing multiple adjacent slashes.  */
 341 #if defined(HAVE_WIN32)
 342          while (*slash == '/' || *slash == '\\')
 343             slash++;
 344 #else
 345          while (*slash == '/')
 346             slash++;
 347 #endif
 348       } /* end while (1) */
 349
 350       if (!cwd.do_chdir) {
 351          basename_dir = dirpath;
 352       }
 353
 354       /* We're done making leading directories.
 355          Create the final component of the path.  */
 356
 357       Dmsg1(300, "Create final component. mode=%o\n", mode);
 358       if (make_dir(jcr, basename_dir, dirpath, mode, NULL)) {
 359           umask(oldmask);
 360           cleanup(&cwd);
 361           return 1;
 362       }
 363
 364       /* Done creating directories.  Restore original umask.  */
 365       umask(oldmask);
 366
 367       if (owner != (uid_t)-1 || group != (gid_t)-1) {
 368           if (chown(basename_dir, owner, group)
 369 #ifdef AFS
 370               && errno != EPERM
 371 #endif
 372               )
 373             {
 374               berrno be;
 375               Jmsg(jcr, M_WARNING, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
 376                      quote(dirpath), be.strerror());
 377             }
 378       }
 379
 380       /* The above chown may have turned off some permission bits in MODE.
 381          Another reason we may have to use chmod here is that mkdir(2) is
 382          required to honor only the file permission bits.  In particular,
 383          it need not honor the `special' bits, so if MODE includes any
 384          special bits, set them here.  */
 385       if (mode & ~S_IRWXUGO) {
 386          Dmsg1(300, "Final chmod mode=%o\n", mode);
 387       }
 388       if ((mode & ~S_IRWXUGO) && chmod(basename_dir, mode)) {
 389           berrno be;
 390           Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
 391              quote(dirpath), be.strerror());
 392       }
 393
 394      if (cleanup(&cwd)) {
 395         return 1;
 396      }
 397
 398       /* If the mode for leading directories didn't include owner "wx"
 399          privileges, we have to reset their protections to the correct
 400          value.  */
 401       for (p = leading_dirs; p != NULL; p = p->next) {
 402           *(p->dirname_end) = '\0';
 403           Dmsg2(300, "Reset parent mode=%o dir=%s\n", parent_mode, dirpath);
 404           if (chmod(dirpath, parent_mode)) {
 405               berrno be;
 406               Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
 407                      quote(dirpath), be.strerror());
 408           }
 409       }
 410   } else {
 411       /* We get here if the entire path already exists.  */
 412
 413       const char *dirpath = argpath;
 414
 415       if (!S_ISDIR(stats.st_mode)) {
 416           Jmsg(jcr, M_ERROR, 0, _("%s exists but is not a directory\n"), quote(dirpath));
 417           return 1;
 418       }
 419
 420       if (!preserve_existing) {
 421           Dmsg0(300, "Do not preserve existing.\n");
 422           /* chown must precede chmod because on some systems,
 423              chown clears the set[ug]id bits for non-superusers,
 424              resulting in incorrect permissions.
 425              On System V, users can give away files with chown and then not
 426              be able to chmod them.  So don't give files away.  */
 427
 428           if ((owner != (uid_t)-1 || group != (gid_t)-1)
 429               && chown(dirpath, owner, group)
 430 #ifdef AFS
 431               && errno != EPERM
 432 #endif
 433               ) {
 434               berrno be;
 435               Jmsg(jcr, M_WARNING, 0, _("Cannot change owner and/or group of %s: ERR=%s\n"),
 436                      quote(dirpath), be.strerror());
 437             }
 438           if (chmod(dirpath, mode)) {
 439               berrno be;
 440               Jmsg(jcr, M_WARNING, 0, _("Cannot change permissions of %s: ERR=%s\n"),
 441                                  quote(dirpath), be.strerror());
 442           }
 443           Dmsg2(300, "pathexists chmod mode=%o dir=%s\n", mode, dirpath);
 444       }
 445   }
 446   return retval;
 447 }