rename.c 13 KB
Newer Older
Eric Blake's avatar
Eric Blake committed
1
/* Work around rename bugs in some systems.
2

3
   Copyright (C) 2001-2003, 2005-2006, 2009-2010 Free Software Foundation, Inc.
Jim Meyering's avatar
Jim Meyering committed
4

5
   This program is free software: you can redistribute it and/or modify
Jim Meyering's avatar
Jim Meyering committed
6
   it under the terms of the GNU General Public License as published by
7 8
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.
Jim Meyering's avatar
Jim Meyering committed
9 10 11 12 13 14 15

   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
16
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Meyering's avatar
Jim Meyering committed
17

Eric Blake's avatar
Eric Blake committed
18
/* Written by Volker Borchert, Eric Blake.  */
Jim Meyering's avatar
Jim Meyering committed
19

20
#include <config.h>
21 22 23

#include <stdio.h>

24 25
#undef rename

26 27 28 29 30 31
#if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
/* The mingw rename has problems with trailing slashes; it also
   requires use of native Windows calls to allow atomic renames over
   existing files.  */

# include <errno.h>
Eric Blake's avatar
Eric Blake committed
32 33 34 35
# include <stdbool.h>
# include <stdlib.h>
# include <sys/stat.h>
# include <unistd.h>
36

37 38
# define WIN32_LEAN_AND_MEAN
# include <windows.h>
39

Eric Blake's avatar
Eric Blake committed
40 41
# include "dirname.h"

42 43 44 45 46 47 48
/* Rename the file SRC to DST.  This replacement is necessary on
   Windows, on which the system rename function will not replace
   an existing DST.  */
int
rpl_rename (char const *src, char const *dst)
{
  int error;
Eric Blake's avatar
Eric Blake committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
  size_t src_len = strlen (src);
  size_t dst_len = strlen (dst);
  char *src_base = last_component (src);
  char *dst_base = last_component (dst);
  bool src_slash;
  bool dst_slash;
  bool dst_exists;
  struct stat src_st;
  struct stat dst_st;

  /* Filter out dot as last component.  */
  if (!src_len || !dst_len)
    {
      errno = ENOENT;
      return -1;
    }
  if (*src_base == '.')
    {
      size_t len = base_len (src_base);
      if (len == 1 || (len == 2 && src_base[1] == '.'))
        {
          errno = EINVAL;
          return -1;
        }
    }
  if (*dst_base == '.')
    {
      size_t len = base_len (dst_base);
      if (len == 1 || (len == 2 && dst_base[1] == '.'))
        {
          errno = EINVAL;
          return -1;
        }
    }

  /* Presence of a trailing slash requires directory semantics.  If
     the source does not exist, or if the destination cannot be turned
     into a directory, give up now.  Otherwise, strip trailing slashes
     before calling rename.  There are no symlinks on mingw, so stat
     works instead of lstat.  */
  src_slash = ISSLASH (src[src_len - 1]);
  dst_slash = ISSLASH (dst[dst_len - 1]);
  if (stat (src, &src_st))
    return -1;
  if (stat (dst, &dst_st))
    {
      if (errno != ENOENT || (!S_ISDIR (src_st.st_mode) && dst_slash))
        return -1;
      dst_exists = false;
    }
  else
    {
      if (S_ISDIR (dst_st.st_mode) != S_ISDIR (src_st.st_mode))
102 103 104 105
        {
          errno = S_ISDIR (dst_st.st_mode) ? EISDIR : ENOTDIR;
          return -1;
        }
Eric Blake's avatar
Eric Blake committed
106 107 108 109 110 111 112 113 114
      dst_exists = true;
    }

  /* There are no symlinks, so if a file existed with a trailing
     slash, it must be a directory, and we don't have to worry about
     stripping strip trailing slash.  However, mingw refuses to
     replace an existing empty directory, so we have to help it out.
     And canonicalize_file_name is not yet ported to mingw; however,
     for directories, getcwd works as a viable alternative.  Ensure
115 116 117 118
     that we can get back to where we started before using it; later
     attempts to return are fatal.  Note that we can end up losing a
     directory if rename then fails, but it was empty, so not much
     damage was done.  */
Eric Blake's avatar
Eric Blake committed
119 120 121 122 123
  if (dst_exists && S_ISDIR (dst_st.st_mode))
    {
      char *cwd = getcwd (NULL, 0);
      char *src_temp;
      char *dst_temp;
124
      if (!cwd || chdir (cwd))
Eric Blake's avatar
Eric Blake committed
125 126 127 128 129 130 131 132 133
        return -1;
      if (IS_ABSOLUTE_FILE_NAME (src))
        {
          dst_temp = chdir (dst) ? NULL : getcwd (NULL, 0);
          src_temp = chdir (src) ? NULL : getcwd (NULL, 0);
        }
      else
        {
          src_temp = chdir (src) ? NULL : getcwd (NULL, 0);
134 135
          if (!IS_ABSOLUTE_FILE_NAME (dst) && chdir (cwd))
            abort ();
Eric Blake's avatar
Eric Blake committed
136 137
          dst_temp = chdir (dst) ? NULL : getcwd (NULL, 0);
        }
138 139
      if (chdir (cwd))
        abort ();
Eric Blake's avatar
Eric Blake committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
      free (cwd);
      if (!src_temp || !dst_temp)
        {
          free (src_temp);
          free (dst_temp);
          errno = ENOMEM;
          return -1;
        }
      src_len = strlen (src_temp);
      if (strncmp (src_temp, dst_temp, src_len) == 0
          && (ISSLASH (dst_temp[src_len]) || dst_temp[src_len] == '\0'))
        {
          error = dst_temp[src_len];
          free (src_temp);
          free (dst_temp);
          if (error)
            {
              errno = EINVAL;
              return -1;
            }
          return 0;
        }
      if (rmdir (dst))
        {
          error = errno;
          free (src_temp);
          free (dst_temp);
          errno = error;
          return -1;
        }
      free (src_temp);
      free (dst_temp);
    }
173

Eric Blake's avatar
Eric Blake committed
174 175 176 177
  /* MoveFileEx works if SRC is a directory without any flags, but
     fails with MOVEFILE_REPLACE_EXISTING, so try without flags first.
     Thankfully, MoveFileEx handles hard links correctly, even though
     rename() does not.  */
178 179 180 181
  if (MoveFileEx (src, dst, 0))
    return 0;

  /* Retry with MOVEFILE_REPLACE_EXISTING if the move failed
Eric Blake's avatar
Eric Blake committed
182
     due to the destination already existing.  */
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
  error = GetLastError ();
  if (error == ERROR_FILE_EXISTS || error == ERROR_ALREADY_EXISTS)
    {
      if (MoveFileEx (src, dst, MOVEFILE_REPLACE_EXISTING))
        return 0;

      error = GetLastError ();
    }

  switch (error)
    {
    case ERROR_FILE_NOT_FOUND:
    case ERROR_PATH_NOT_FOUND:
    case ERROR_BAD_PATHNAME:
    case ERROR_DIRECTORY:
      errno = ENOENT;
      break;

    case ERROR_ACCESS_DENIED:
    case ERROR_SHARING_VIOLATION:
      errno = EACCES;
      break;

    case ERROR_OUTOFMEMORY:
      errno = ENOMEM;
      break;

    case ERROR_CURRENT_DIRECTORY:
      errno = EBUSY;
      break;

    case ERROR_NOT_SAME_DEVICE:
      errno = EXDEV;
      break;

    case ERROR_WRITE_PROTECT:
      errno = EROFS;
      break;

    case ERROR_WRITE_FAULT:
    case ERROR_READ_FAULT:
    case ERROR_GEN_FAILURE:
      errno = EIO;
      break;

    case ERROR_HANDLE_DISK_FULL:
    case ERROR_DISK_FULL:
    case ERROR_DISK_TOO_FRAGMENTED:
      errno = ENOSPC;
      break;

    case ERROR_FILE_EXISTS:
    case ERROR_ALREADY_EXISTS:
      errno = EEXIST;
      break;

    case ERROR_BUFFER_OVERFLOW:
    case ERROR_FILENAME_EXCED_RANGE:
      errno = ENAMETOOLONG;
      break;

    case ERROR_INVALID_NAME:
    case ERROR_DELETE_PENDING:
      errno = EPERM;        /* ? */
      break;

249
# ifndef ERROR_FILE_TOO_LARGE
Eric Blake's avatar
Eric Blake committed
250
/* This value is documented but not defined in all versions of windows.h.  */
251 252
#  define ERROR_FILE_TOO_LARGE 223
# endif
253 254 255 256 257 258 259 260 261 262 263
    case ERROR_FILE_TOO_LARGE:
      errno = EFBIG;
      break;

    default:
      errno = EINVAL;
      break;
    }

  return -1;
}
264

265 266
#else /* ! W32 platform */

267 268 269 270 271
# include <errno.h>
# include <stdio.h>
# include <stdlib.h>
# include <string.h>
# include <sys/stat.h>
272
# include <unistd.h>
273

274 275
# include "dirname.h"
# include "same-inode.h"
Jim Meyering's avatar
Jim Meyering committed
276

Eric Blake's avatar
Eric Blake committed
277
/* Rename the file SRC to DST, fixing any trailing slash bugs.  */
Jim Meyering's avatar
Jim Meyering committed
278 279

int
Paul Eggert's avatar
Paul Eggert committed
280
rpl_rename (char const *src, char const *dst)
Jim Meyering's avatar
Jim Meyering committed
281
{
Eric Blake's avatar
Eric Blake committed
282 283 284 285 286 287
  size_t src_len = strlen (src);
  size_t dst_len = strlen (dst);
  char *src_temp = (char *) src;
  char *dst_temp = (char *) dst;
  bool src_slash;
  bool dst_slash;
288
  bool dst_exists;
Eric Blake's avatar
Eric Blake committed
289 290 291 292 293 294 295 296
  int ret_val = -1;
  int rename_errno = ENOTDIR;
  struct stat src_st;
  struct stat dst_st;

  if (!src_len || !dst_len)
    return rename (src, dst); /* Let strace see the ENOENT failure.  */

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
# if RENAME_DEST_EXISTS_BUG
  {
    char *src_base = last_component (src);
    char *dst_base = last_component (dst);
    if (*src_base == '.')
      {
        size_t len = base_len (src_base);
        if (len == 1 || (len == 2 && src_base[1] == '.'))
          {
            errno = EINVAL;
            return -1;
          }
      }
    if (*dst_base == '.')
      {
        size_t len = base_len (dst_base);
        if (len == 1 || (len == 2 && dst_base[1] == '.'))
          {
            errno = EINVAL;
            return -1;
          }
      }
  }
# endif /* RENAME_DEST_EXISTS_BUG */

Eric Blake's avatar
Eric Blake committed
322 323
  src_slash = src[src_len - 1] == '/';
  dst_slash = dst[dst_len - 1] == '/';
324

325
# if !RENAME_HARD_LINK_BUG && !RENAME_DEST_EXISTS_BUG
326 327
  /* If there are no trailing slashes, then trust the native
     implementation unless we also suspect issues with hard link
328
     detection or file/directory conflicts.  */
Eric Blake's avatar
Eric Blake committed
329 330
  if (!src_slash && !dst_slash)
    return rename (src, dst);
331
# endif /* !RENAME_HARD_LINK_BUG && !RENAME_DEST_EXISTS_BUG */
Eric Blake's avatar
Eric Blake committed
332 333 334 335 336 337 338 339 340

  /* Presence of a trailing slash requires directory semantics.  If
     the source does not exist, or if the destination cannot be turned
     into a directory, give up now.  Otherwise, strip trailing slashes
     before calling rename.  */
  if (lstat (src, &src_st))
    return -1;
  if (lstat (dst, &dst_st))
    {
341
      if (errno != ENOENT || (!S_ISDIR (src_st.st_mode) && dst_slash))
Eric Blake's avatar
Eric Blake committed
342
        return -1;
343
      dst_exists = false;
Eric Blake's avatar
Eric Blake committed
344
    }
345
  else
Eric Blake's avatar
Eric Blake committed
346
    {
347
      if (S_ISDIR (dst_st.st_mode) != S_ISDIR (src_st.st_mode))
348 349 350 351
        {
          errno = S_ISDIR (dst_st.st_mode) ? EISDIR : ENOTDIR;
          return -1;
        }
352
# if RENAME_HARD_LINK_BUG
353
      if (SAME_INODE (src_st, dst_st))
354
        return 0;
355 356
# endif /* RENAME_HARD_LINK_BUG */
      dst_exists = true;
Eric Blake's avatar
Eric Blake committed
357
    }
Jim Meyering's avatar
Jim Meyering committed
358

359 360
# if (RENAME_TRAILING_SLASH_SOURCE_BUG || RENAME_DEST_EXISTS_BUG        \
      || RENAME_HARD_LINK_BUG)
Eric Blake's avatar
Eric Blake committed
361 362 363 364
  /* If the only bug was that a trailing slash was allowed on a
     non-existing file destination, as in Solaris 10, then we've
     already covered that situation.  But if there is any problem with
     a trailing slash on an existing source or destination, as in
365
     Solaris 9, or if a directory can overwrite a symlink, as on
366 367 368 369
     Cygwin 1.5, or if directories cannot be created with trailing
     slash, as on NetBSD 1.6, then we must strip the offending slash
     and check that we have not encountered a symlink instead of a
     directory.
Eric Blake's avatar
Eric Blake committed
370 371 372 373 374 375 376 377 378 379 380

     Stripping a trailing slash interferes with POSIX semantics, where
     rename behavior on a symlink with a trailing slash operates on
     the corresponding target directory.  We prefer the GNU semantics
     of rejecting any use of a symlink with trailing slash, but do not
     enforce them, since Solaris 10 is able to obey POSIX semantics
     and there might be clients expecting it, as counter-intuitive as
     those semantics are.

     Technically, we could also follow the POSIX behavior by chasing a
     readlink trail, but that is harder to implement.  */
Eric Blake's avatar
Eric Blake committed
381
  if (src_slash)
Jim Meyering's avatar
Jim Meyering committed
382
    {
Eric Blake's avatar
Eric Blake committed
383 384 385 386 387 388 389
      src_temp = strdup (src);
      if (!src_temp)
        {
          /* Rather than rely on strdup-posix, we set errno ourselves.  */
          rename_errno = ENOMEM;
          goto out;
        }
390
      strip_trailing_slashes (src_temp);
Eric Blake's avatar
Eric Blake committed
391 392 393 394 395 396 397
      if (lstat (src_temp, &src_st))
        {
          rename_errno = errno;
          goto out;
        }
      if (S_ISLNK (src_st.st_mode))
        goto out;
Jim Meyering's avatar
Jim Meyering committed
398
    }
Eric Blake's avatar
Eric Blake committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
  if (dst_slash)
    {
      dst_temp = strdup (dst);
      if (!dst_temp)
        {
          rename_errno = ENOMEM;
          goto out;
        }
      strip_trailing_slashes (dst_temp);
      if (lstat (dst_temp, &dst_st))
        {
          if (errno != ENOENT)
            {
              rename_errno = errno;
              goto out;
            }
        }
      else if (S_ISLNK (dst_st.st_mode))
        goto out;
    }
419 420 421 422 423 424 425 426
# endif /* RENAME_TRAILING_SLASH_SOURCE_BUG || RENAME_DEST_EXISTS_BUG
           || RENAME_HARD_LINK_BUG */

# if RENAME_DEST_EXISTS_BUG
  /* Cygwin 1.5 sometimes behaves oddly when moving a non-empty
     directory on top of an empty one (the old directory name can
     reappear if the new directory tree is removed).  Work around this
     by removing the target first, but don't remove the target if it
427 428 429
     is a subdirectory of the source.  Note that we can end up losing
     a directory if rename then fails, but it was empty, so not much
     damage was done.  */
430 431
  if (dst_exists && S_ISDIR (dst_st.st_mode))
    {
432 433 434 435 436
      if (src_st.st_dev != dst_st.st_dev)
        {
          rename_errno = EXDEV;
          goto out;
        }
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
      if (src_temp != src)
        free (src_temp);
      src_temp = canonicalize_file_name (src);
      if (dst_temp != dst)
        free (dst_temp);
      dst_temp = canonicalize_file_name (dst);
      if (!src_temp || !dst_temp)
        {
          rename_errno = ENOMEM;
          goto out;
        }
      src_len = strlen (src_temp);
      if (strncmp (src_temp, dst_temp, src_len) == 0
          && dst_temp[src_len] == '/')
        {
          rename_errno = EINVAL;
          goto out;
        }
      if (rmdir (dst))
        {
          rename_errno = errno;
          goto out;
        }
    }
# endif /* RENAME_DEST_EXISTS_BUG */
Eric Blake's avatar
Eric Blake committed
462

Eric Blake's avatar
Eric Blake committed
463 464 465
  ret_val = rename (src_temp, dst_temp);
  rename_errno = errno;
 out:
Paul Eggert's avatar
Paul Eggert committed
466
  if (src_temp != src)
Jim Meyering's avatar
Jim Meyering committed
467
    free (src_temp);
Eric Blake's avatar
Eric Blake committed
468 469 470
  if (dst_temp != dst)
    free (dst_temp);
  errno = rename_errno;
471
  return ret_val;
Jim Meyering's avatar
Jim Meyering committed
472
}
473
#endif /* ! W32 platform */