1 /* Miscellaneous functions, not really specific to GNU tar.
3 Copyright (C) 1988, 1992, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004, 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any later
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14 Public License for more details.
16 You should have received a copy of the GNU General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
26 #include <unlinkdir.h>
28 #include <canonicalize.h>
34 # include <sys/filio.h>
38 /* Handling strings. */
40 /* Assign STRING to a copy of VALUE if not zero, or to zero. If
41 STRING was nonzero, it is freed first. */
43 assign_string (char **string
, const char *value
)
47 *string
= value
? xstrdup (value
) : 0;
50 /* Allocate a copy of the string quoted as in C, and returns that. If
51 the string does not have to be quoted, it returns a null pointer.
52 The allocated copy should normally be freed with free() after the
53 caller is done with it.
55 This is used in one context only: generating the directory file in
56 incremental dumps. The quoted string is not intended for human
57 consumption; it is intended only for unquote_string. The quoting
58 is locale-independent, so that users needn't worry about locale
59 when reading directory files. This means that we can't use
60 quotearg, as quotearg is locale-dependent and is meant for human
63 quote_copy_string (const char *string
)
65 const char *source
= string
;
66 char *destination
= 0;
72 int character
= *source
++;
79 size_t length
= (source
- string
) - 1;
82 buffer
= xmalloc (length
+ 2 + 2 * strlen (source
) + 1);
83 memcpy (buffer
, string
, length
);
84 destination
= buffer
+ length
;
86 *destination
++ = '\\';
87 *destination
++ = character
== '\\' ? '\\' : 'n';
92 *destination
++ = character
;
104 /* Takes a quoted C string (like those produced by quote_copy_string)
105 and turns it back into the un-quoted original. This is done in
106 place. Returns 0 only if the string was not properly quoted, but
107 completes the unquoting anyway.
109 This is used for reading the saved directory file in incremental
110 dumps. It is used for decoding old `N' records (demangling names).
111 But also, it is used for decoding file arguments, would they come
112 from the shell or a -T file, and for decoding the --exclude
115 unquote_string (char *string
)
118 char *source
= string
;
119 char *destination
= string
;
121 /* Escape sequences other than \\ and \n are no longer generated by
122 quote_copy_string, but accept them for backwards compatibility,
123 and also because unquote_string is used for purposes other than
124 parsing the output of quote_copy_string. */
131 *destination
++ = '\\';
136 *destination
++ = '\a';
141 *destination
++ = '\b';
146 *destination
++ = '\f';
151 *destination
++ = '\n';
156 *destination
++ = '\r';
161 *destination
++ = '\t';
166 *destination
++ = '\v';
171 *destination
++ = 0177;
184 int value
= *source
++ - '0';
186 if (*source
< '0' || *source
> '7')
188 *destination
++ = value
;
191 value
= value
* 8 + *source
++ - '0';
192 if (*source
< '0' || *source
> '7')
194 *destination
++ = value
;
197 value
= value
* 8 + *source
++ - '0';
198 *destination
++ = value
;
204 *destination
++ = '\\';
206 *destination
++ = *source
++;
209 else if (source
!= destination
)
210 *destination
++ = *source
++;
212 source
++, destination
++;
214 if (source
!= destination
)
219 /* Zap trailing slashes. */
221 zap_slashes (char *name
)
225 if (!name
|| *name
== 0)
227 q
= name
+ strlen (name
) - 1;
228 while (q
> name
&& ISSLASH (*q
))
234 normalize_filename (const char *name
)
236 return zap_slashes (canonicalize_filename_mode (name
, CAN_MISSING
));
241 replace_prefix (char **pname
, const char *samp
, size_t slen
,
242 const char *repl
, size_t rlen
)
245 size_t nlen
= strlen (name
);
246 if (nlen
> slen
&& memcmp (name
, samp
, slen
) == 0 && ISSLASH (name
[slen
]))
250 name
= xrealloc (name
, nlen
- slen
+ rlen
+ 1);
253 memmove (name
+ rlen
, name
+ slen
, nlen
- slen
+ 1);
254 memcpy (name
, repl
, rlen
);
259 /* Handling numbers. */
261 /* Output fraction and trailing digits appropriate for a nanoseconds
262 count equal to NS, but don't output unnecessary '.' or trailing
266 code_ns_fraction (int ns
, char *p
)
285 p
[--i
] = '0' + ns
% 10;
294 code_timespec (struct timespec t
, char sbuf
[TIMESPEC_STRSIZE_BOUND
])
299 bool negative
= s
< 0;
301 if (negative
&& ns
!= 0)
307 np
= umaxtostr (negative
? - (uintmax_t) s
: (uintmax_t) s
, sbuf
+ 1);
310 code_ns_fraction (ns
, sbuf
+ UINTMAX_STRSIZE_BOUND
);
316 /* Saved names in case backup needs to be undone. */
317 static char *before_backup_name
;
318 static char *after_backup_name
;
320 /* Return 1 if FILE_NAME is obviously "." or "/". */
322 must_be_dot_or_slash (char const *file_name
)
324 file_name
+= FILE_SYSTEM_PREFIX_LEN (file_name
);
326 if (ISSLASH (file_name
[0]))
329 if (ISSLASH (file_name
[1]))
331 else if (file_name
[1] == '.'
332 && ISSLASH (file_name
[2 + (file_name
[2] == '.')]))
333 file_name
+= 2 + (file_name
[2] == '.');
335 return ! file_name
[1];
339 while (file_name
[0] == '.' && ISSLASH (file_name
[1]))
342 while (ISSLASH (*file_name
))
346 return ! file_name
[0] || (file_name
[0] == '.' && ! file_name
[1]);
350 /* Some implementations of rmdir let you remove '.' or '/'.
351 Report an error with errno set to zero for obvious cases of this;
352 otherwise call rmdir. */
354 safer_rmdir (const char *file_name
)
356 if (must_be_dot_or_slash (file_name
))
362 return rmdir (file_name
);
365 /* Remove FILE_NAME, returning 1 on success. If FILE_NAME is a directory,
366 then if OPTION is RECURSIVE_REMOVE_OPTION is set remove FILE_NAME
367 recursively; otherwise, remove it only if it is empty. If FILE_NAME is
368 a directory that cannot be removed (e.g., because it is nonempty)
369 and if OPTION is WANT_DIRECTORY_REMOVE_OPTION, then return -1.
370 Return 0 on error, with errno set; if FILE_NAME is obviously the working
371 directory return zero with errno set to zero. */
373 remove_any_file (const char *file_name
, enum remove_option option
)
375 /* Try unlink first if we cannot unlink directories, as this saves
376 us a system call in the common case where we're removing a
378 bool try_unlink_first
= cannot_unlink_dir ();
380 if (try_unlink_first
)
382 if (unlink (file_name
) == 0)
385 /* POSIX 1003.1-2001 requires EPERM when attempting to unlink a
386 directory without appropriate privileges, but many Linux
387 kernels return the more-sensible EISDIR. */
388 if (errno
!= EPERM
&& errno
!= EISDIR
)
392 if (safer_rmdir (file_name
) == 0)
398 return !try_unlink_first
&& unlink (file_name
) == 0;
402 #if defined ENOTEMPTY && ENOTEMPTY != EEXIST
407 case ORDINARY_REMOVE_OPTION
:
410 case WANT_DIRECTORY_REMOVE_OPTION
:
413 case RECURSIVE_REMOVE_OPTION
:
415 char *directory
= savedir (file_name
);
422 for (entry
= directory
;
423 (entrylen
= strlen (entry
)) != 0;
424 entry
+= entrylen
+ 1)
426 char *file_name_buffer
= new_name (file_name
, entry
);
427 int r
= remove_any_file (file_name_buffer
,
428 RECURSIVE_REMOVE_OPTION
);
430 free (file_name_buffer
);
441 return safer_rmdir (file_name
) == 0;
450 /* Check if FILE_NAME already exists and make a backup of it right now.
451 Return success (nonzero) only if the backup is either unneeded, or
452 successful. For now, directories are considered to never need
453 backup. If THIS_IS_THE_ARCHIVE is nonzero, this is the archive and
454 so, we do not have to backup block or character devices, nor remote
457 maybe_backup_file (const char *file_name
, bool this_is_the_archive
)
459 struct stat file_stat
;
461 assign_string (&before_backup_name
, file_name
);
463 /* A run situation may exist between Emacs or other GNU programs trying to
464 make a backup for the same file simultaneously. If theoretically
465 possible, real problems are unlikely. Doing any better would require a
466 convention, GNU-wide, for all programs doing backups. */
468 assign_string (&after_backup_name
, 0);
470 /* Check if we really need to backup the file. */
472 if (this_is_the_archive
&& _remdev (file_name
))
475 if (stat (file_name
, &file_stat
))
480 stat_error (file_name
);
484 if (S_ISDIR (file_stat
.st_mode
))
487 if (this_is_the_archive
488 && (S_ISBLK (file_stat
.st_mode
) || S_ISCHR (file_stat
.st_mode
)))
491 after_backup_name
= find_backup_file_name (file_name
, backup_type
);
492 if (! after_backup_name
)
495 if (rename (before_backup_name
, after_backup_name
) == 0)
498 fprintf (stdlis
, _("Renaming %s to %s\n"),
499 quote_n (0, before_backup_name
),
500 quote_n (1, after_backup_name
));
505 /* The backup operation failed. */
507 ERROR ((0, e
, _("%s: Cannot rename to %s"),
508 quotearg_colon (before_backup_name
),
509 quote_n (1, after_backup_name
)));
510 assign_string (&after_backup_name
, 0);
515 /* Try to restore the recently backed up file to its original name.
516 This is usually only needed after a failed extraction. */
518 undo_last_backup (void)
520 if (after_backup_name
)
522 if (rename (after_backup_name
, before_backup_name
) != 0)
525 ERROR ((0, e
, _("%s: Cannot rename to %s"),
526 quotearg_colon (after_backup_name
),
527 quote_n (1, before_backup_name
)));
530 fprintf (stdlis
, _("Renaming %s back to %s\n"),
531 quote_n (0, after_backup_name
),
532 quote_n (1, before_backup_name
));
533 assign_string (&after_backup_name
, 0);
537 /* Depending on DEREF, apply either stat or lstat to (NAME, BUF). */
539 deref_stat (bool deref
, char const *name
, struct stat
*buf
)
541 return deref
? stat (name
, buf
) : lstat (name
, buf
);
544 /* Set FD's (i.e., FILE's) access time to TIMESPEC[0]. If that's not
545 possible to do by itself, set its access and data modification
546 times to TIMESPEC[0] and TIMESPEC[1], respectively. */
548 set_file_atime (int fd
, char const *file
, struct timespec
const timespec
[2])
553 struct timeval timeval
;
554 timeval
.tv_sec
= timespec
[0].tv_sec
;
555 timeval
.tv_usec
= timespec
[0].tv_nsec
/ 1000;
556 if (ioctl (fd
, _FIOSATIME
, &timeval
) == 0)
561 return gl_futimens (fd
, file
, timespec
);
564 /* A description of a working directory. */
569 struct saved_cwd saved_cwd
;
572 /* A vector of chdir targets. wd[0] is the initial working directory. */
573 static struct wd
*wd
;
575 /* The number of working directories in the vector. */
576 static size_t wd_count
;
578 /* The allocated size of the vector. */
579 static size_t wd_alloc
;
589 /* DIR is the operand of a -C option; add it to vector of chdir targets,
590 and return the index of its location. */
592 chdir_arg (char const *dir
)
594 if (wd_count
== wd_alloc
)
599 wd
= xmalloc (sizeof *wd
* wd_alloc
);
602 wd
= x2nrealloc (wd
, &wd_alloc
, sizeof *wd
);
606 wd
[wd_count
].name
= ".";
607 wd
[wd_count
].saved
= 0;
612 /* Optimize the common special case of the working directory,
613 or the working directory as a prefix. */
616 while (dir
[0] == '.' && ISSLASH (dir
[1]))
617 for (dir
+= 2; ISSLASH (*dir
); dir
++)
619 if (! dir
[dir
[0] == '.'])
623 wd
[wd_count
].name
= dir
;
624 wd
[wd_count
].saved
= 0;
628 /* Change to directory I. If I is 0, change to the initial working
629 directory; otherwise, I must be a value returned by chdir_arg. */
637 struct wd
*prev
= &wd
[previous
];
638 struct wd
*curr
= &wd
[i
];
644 if (save_cwd (&prev
->saved_cwd
) != 0)
646 else if (0 <= prev
->saved_cwd
.desc
)
648 /* Make sure we still have at least one descriptor available. */
649 int fd1
= prev
->saved_cwd
.desc
;
653 else if (errno
== EMFILE
)
655 /* Force restore_cwd to use chdir_long. */
657 prev
->saved_cwd
.desc
= -1;
658 prev
->saved_cwd
.name
= xgetcwd ();
665 FATAL_ERROR ((0, err
, _("Cannot save working directory")));
670 if (restore_cwd (&curr
->saved_cwd
))
671 FATAL_ERROR ((0, 0, _("Cannot change working directory")));
675 if (i
&& ! ISSLASH (curr
->name
[0]))
677 if (chdir (curr
->name
) != 0)
678 chdir_fatal (curr
->name
);
686 close_diag (char const *name
)
688 if (ignore_failed_read_option
)
695 open_diag (char const *name
)
697 if (ignore_failed_read_option
)
704 read_diag_details (char const *name
, off_t offset
, size_t size
)
706 if (ignore_failed_read_option
)
707 read_warn_details (name
, offset
, size
);
709 read_error_details (name
, offset
, size
);
713 readlink_diag (char const *name
)
715 if (ignore_failed_read_option
)
716 readlink_warn (name
);
718 readlink_error (name
);
722 savedir_diag (char const *name
)
724 if (ignore_failed_read_option
)
727 savedir_error (name
);
731 seek_diag_details (char const *name
, off_t offset
)
733 if (ignore_failed_read_option
)
734 seek_warn_details (name
, offset
);
736 seek_error_details (name
, offset
);
740 stat_diag (char const *name
)
742 if (ignore_failed_read_option
)
749 file_removed_diag (const char *name
, bool top_level
,
750 void (*diagfn
) (char const *name
))
752 if (!top_level
&& errno
== ENOENT
)
754 WARNOPT (WARN_FILE_REMOVED
,
755 (0, 0, _("%s: File removed before we read it"),
756 quotearg_colon (name
)));
757 set_exit_status (TAREXIT_DIFFERS
);
764 dir_removed_diag (const char *name
, bool top_level
,
765 void (*diagfn
) (char const *name
))
767 if (!top_level
&& errno
== ENOENT
)
769 WARNOPT (WARN_FILE_REMOVED
,
770 (0, 0, _("%s: Directory removed before we read it"),
771 quotearg_colon (name
)));
772 set_exit_status (TAREXIT_DIFFERS
);
779 write_fatal_details (char const *name
, ssize_t status
, size_t size
)
781 write_error_details (name
, status
, size
);
785 /* Fork, aborting if unsuccessful. */
791 call_arg_fatal ("fork", _("child process"));
795 /* Create a pipe, aborting if unsuccessful. */
800 call_arg_fatal ("pipe", _("interprocess channel"));
803 /* Return PTR, aligned upward to the next multiple of ALIGNMENT.
804 ALIGNMENT must be nonzero. The caller must arrange for ((char *)
805 PTR) through ((char *) PTR + ALIGNMENT - 1) to be addressable
809 ptr_align (void *ptr
, size_t alignment
)
812 char *p1
= p0
+ alignment
- 1;
813 return p1
- (size_t) p1
% alignment
;
816 /* Return the address of a page-aligned buffer of at least SIZE bytes.
817 The caller should free *PTR when done with the buffer. */
820 page_aligned_alloc (void **ptr
, size_t size
)
822 size_t alignment
= getpagesize ();
823 size_t size1
= size
+ alignment
;
826 *ptr
= xmalloc (size1
);
827 return ptr_align (*ptr
, alignment
);
834 char *buffer
; /* directory, `/', and directory member */
835 size_t buffer_size
; /* allocated size of name_buffer */
836 size_t dir_length
; /* length of directory part in buffer */
840 namebuf_create (const char *dir
)
842 namebuf_t buf
= xmalloc (sizeof (*buf
));
843 buf
->buffer_size
= strlen (dir
) + 2;
844 buf
->buffer
= xmalloc (buf
->buffer_size
);
845 strcpy (buf
->buffer
, dir
);
846 buf
->dir_length
= strlen (buf
->buffer
);
847 if (!ISSLASH (buf
->buffer
[buf
->dir_length
- 1]))
848 buf
->buffer
[buf
->dir_length
++] = DIRECTORY_SEPARATOR
;
853 namebuf_free (namebuf_t buf
)
860 namebuf_name (namebuf_t buf
, const char *name
)
862 size_t len
= strlen (name
);
863 while (buf
->dir_length
+ len
+ 1 >= buf
->buffer_size
)
864 buf
->buffer
= x2realloc (buf
->buffer
, &buf
->buffer_size
);
865 strcpy (buf
->buffer
+ buf
->dir_length
, name
);