1 /* Miscellaneous functions, not really specific to GNU tar.
3 Copyright (C) 1988, 1992, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
4 2003 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 2, 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 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
26 static void call_arg_fatal (char const *, char const *)
27 __attribute__ ((noreturn
));
29 /* Handling strings. */
31 /* Assign STRING to a copy of VALUE if not zero, or to zero. If
32 STRING was nonzero, it is freed first. */
34 assign_string (char **string
, const char *value
)
38 *string
= value
? xstrdup (value
) : 0;
41 /* Allocate a copy of the string quoted as in C, and returns that. If
42 the string does not have to be quoted, it returns a null pointer.
43 The allocated copy should normally be freed with free() after the
44 caller is done with it.
46 This is used in one context only: generating the directory file in
47 incremental dumps. The quoted string is not intended for human
48 consumption; it is intended only for unquote_string. The quoting
49 is locale-independent, so that users needn't worry about locale
50 when reading directory files. This means that we can't use
51 quotearg, as quotearg is locale-dependent and is meant for human
54 quote_copy_string (const char *string
)
56 const char *source
= string
;
57 char *destination
= 0;
63 int character
= *source
++;
70 size_t length
= (source
- string
) - 1;
73 buffer
= xmalloc (length
+ 2 + 2 * strlen (source
) + 1);
74 memcpy (buffer
, string
, length
);
75 destination
= buffer
+ length
;
77 *destination
++ = '\\';
78 *destination
++ = character
== '\\' ? '\\' : 'n';
83 *destination
++ = character
;
95 /* Takes a quoted C string (like those produced by quote_copy_string)
96 and turns it back into the un-quoted original. This is done in
97 place. Returns 0 only if the string was not properly quoted, but
98 completes the unquoting anyway.
100 This is used for reading the saved directory file in incremental
101 dumps. It is used for decoding old `N' records (demangling names).
102 But also, it is used for decoding file arguments, would they come
103 from the shell or a -T file, and for decoding the --exclude
106 unquote_string (char *string
)
109 char *source
= string
;
110 char *destination
= string
;
112 /* Escape sequences other than \\ and \n are no longer generated by
113 quote_copy_string, but accept them for backwards compatibility,
114 and also because unquote_string is used for purposes other than
115 parsing the output of quote_copy_string. */
122 *destination
++ = '\\';
127 *destination
++ = '\n';
132 *destination
++ = '\t';
137 *destination
++ = '\f';
142 *destination
++ = '\b';
147 *destination
++ = '\r';
152 *destination
++ = 0177;
165 int value
= *source
++ - '0';
167 if (*source
< '0' || *source
> '7')
169 *destination
++ = value
;
172 value
= value
* 8 + *source
++ - '0';
173 if (*source
< '0' || *source
> '7')
175 *destination
++ = value
;
178 value
= value
* 8 + *source
++ - '0';
179 *destination
++ = value
;
185 *destination
++ = '\\';
187 *destination
++ = *source
++;
190 else if (source
!= destination
)
191 *destination
++ = *source
++;
193 source
++, destination
++;
195 if (source
!= destination
)
202 /* Saved names in case backup needs to be undone. */
203 static char *before_backup_name
;
204 static char *after_backup_name
;
206 /* Return 1 if PATH is obviously "." or "/". */
208 must_be_dot_or_slash (char const *path
)
210 path
+= FILESYSTEM_PREFIX_LEN (path
);
212 if (ISSLASH (path
[0]))
215 if (ISSLASH (path
[1]))
217 else if (path
[1] == '.' && ISSLASH (path
[2 + (path
[2] == '.')]))
218 path
+= 2 + (path
[2] == '.');
224 while (path
[0] == '.' && ISSLASH (path
[1]))
227 while (ISSLASH (*path
))
231 return ! path
[0] || (path
[0] == '.' && ! path
[1]);
235 /* Some implementations of rmdir let you remove '.' or '/'.
236 Report an error with errno set to zero for obvious cases of this;
237 otherwise call rmdir. */
239 safer_rmdir (const char *path
)
241 if (must_be_dot_or_slash (path
))
250 /* Remove PATH, returning 1 on success. If PATH is a directory, then
251 if OPTION is RECURSIVE_REMOVE_OPTION is set remove PATH
252 recursively; otherwise, remove it only if it is empty. If PATH is
253 a directory that cannot be removed (e.g., because it is nonempty)
254 and if OPTION is WANT_DIRECTORY_REMOVE_OPTION, then return -1.
255 Return 0 on error, with errno set; if PATH is obviously the working
256 directory return zero with errno set to zero. */
258 remove_any_file (const char *path
, enum remove_option option
)
260 /* Try unlink first if we are not root, as this saves us a system
261 call in the common case where we're removing a non-directory. */
264 if (unlink (path
) == 0)
267 /* POSIX 1003.1-2001 requires EPERM when attempting to unlink a
268 directory without appropriate privileges, but many Linux
269 kernels return the more-sensible EISDIR. */
270 if (errno
!= EPERM
&& errno
!= EISDIR
)
274 if (safer_rmdir (path
) == 0)
280 return we_are_root
&& unlink (path
) == 0;
284 #if defined ENOTEMPTY && ENOTEMPTY != EEXIST
289 case ORDINARY_REMOVE_OPTION
:
292 case WANT_DIRECTORY_REMOVE_OPTION
:
295 case RECURSIVE_REMOVE_OPTION
:
297 char *directory
= savedir (path
);
304 for (entry
= directory
;
305 (entrylen
= strlen (entry
)) != 0;
306 entry
+= entrylen
+ 1)
308 char *path_buffer
= new_name (path
, entry
);
309 int r
= remove_any_file (path_buffer
, 1);
322 return safer_rmdir (path
) == 0;
331 /* Check if PATH already exists and make a backup of it right now.
332 Return success (nonzero) only if the backup in either unneeded, or
333 successful. For now, directories are considered to never need
334 backup. If ARCHIVE is nonzero, this is the archive and so, we do
335 not have to backup block or character devices, nor remote entities. */
337 maybe_backup_file (const char *path
, int archive
)
339 struct stat file_stat
;
341 /* Check if we really need to backup the file. */
343 if (archive
&& _remdev (path
))
346 if (stat (path
, &file_stat
))
355 if (S_ISDIR (file_stat
.st_mode
))
358 if (archive
&& (S_ISBLK (file_stat
.st_mode
) || S_ISCHR (file_stat
.st_mode
)))
361 assign_string (&before_backup_name
, path
);
363 /* A run situation may exist between Emacs or other GNU programs trying to
364 make a backup for the same file simultaneously. If theoretically
365 possible, real problems are unlikely. Doing any better would require a
366 convention, GNU-wide, for all programs doing backups. */
368 assign_string (&after_backup_name
, 0);
369 after_backup_name
= find_backup_file_name (path
, backup_type
);
370 if (! after_backup_name
)
373 if (rename (before_backup_name
, after_backup_name
) == 0)
376 fprintf (stdlis
, _("Renaming %s to %s\n"),
377 quote_n (0, before_backup_name
),
378 quote_n (1, after_backup_name
));
383 /* The backup operation failed. */
385 ERROR ((0, e
, _("%s: Cannot rename to %s"),
386 quotearg_colon (before_backup_name
),
387 quote_n (1, after_backup_name
)));
388 assign_string (&after_backup_name
, 0);
393 /* Try to restore the recently backed up file to its original name.
394 This is usually only needed after a failed extraction. */
396 undo_last_backup (void)
398 if (after_backup_name
)
400 if (rename (after_backup_name
, before_backup_name
) != 0)
403 ERROR ((0, e
, _("%s: Cannot rename to %s"),
404 quotearg_colon (after_backup_name
),
405 quote_n (1, before_backup_name
)));
408 fprintf (stdlis
, _("Renaming %s back to %s\n"),
409 quote_n (0, after_backup_name
),
410 quote_n (1, before_backup_name
));
411 assign_string (&after_backup_name
, 0);
415 /* Depending on DEREF, apply either stat or lstat to (NAME, BUF). */
417 deref_stat (bool deref
, char const *name
, struct stat
*buf
)
419 return deref
? stat (name
, buf
) : lstat (name
, buf
);
422 /* A description of a working directory. */
427 struct saved_cwd saved_cwd
;
430 /* A vector of chdir targets. wd[0] is the initial working directory. */
431 static struct wd
*wd
;
433 /* The number of working directories in the vector. */
436 /* The allocated size of the vector. */
437 static size_t wd_alloc
;
439 /* DIR is the operand of a -C option; add it to vector of chdir targets,
440 and return the index of its location. */
442 chdir_arg (char const *dir
)
446 wd_alloc
= 2 * (wd_alloc
+ 1);
447 wd
= xrealloc (wd
, sizeof *wd
* wd_alloc
);
456 /* Optimize the common special case of the working directory,
457 or the working directory as a prefix. */
460 while (dir
[0] == '.' && ISSLASH (dir
[1]))
461 for (dir
+= 2; ISSLASH (*dir
); dir
++)
463 if (! dir
[dir
[0] == '.'])
472 /* Change to directory I. If I is 0, change to the initial working
473 directory; otherwise, I must be a value returned by chdir_arg. */
481 struct wd
*prev
= &wd
[previous
];
482 struct wd
*curr
= &wd
[i
];
487 if (save_cwd (&prev
->saved_cwd
) != 0)
488 FATAL_ERROR ((0, 0, _("Cannot save working directory")));
493 if (restore_cwd (&curr
->saved_cwd
))
494 FATAL_ERROR ((0, 0, _("Cannot change working directory")));
498 if (i
&& ! ISSLASH (curr
->name
[0]))
500 if (chdir (curr
->name
) != 0)
501 chdir_fatal (curr
->name
);
508 /* Decode MODE from its binary form in a stat structure, and encode it
509 into a 9-byte string STRING, terminated with a NUL. */
512 decode_mode (mode_t mode
, char *string
)
514 *string
++ = mode
& S_IRUSR
? 'r' : '-';
515 *string
++ = mode
& S_IWUSR
? 'w' : '-';
516 *string
++ = (mode
& S_ISUID
517 ? (mode
& S_IXUSR
? 's' : 'S')
518 : (mode
& S_IXUSR
? 'x' : '-'));
519 *string
++ = mode
& S_IRGRP
? 'r' : '-';
520 *string
++ = mode
& S_IWGRP
? 'w' : '-';
521 *string
++ = (mode
& S_ISGID
522 ? (mode
& S_IXGRP
? 's' : 'S')
523 : (mode
& S_IXGRP
? 'x' : '-'));
524 *string
++ = mode
& S_IROTH
? 'r' : '-';
525 *string
++ = mode
& S_IWOTH
? 'w' : '-';
526 *string
++ = (mode
& S_ISVTX
527 ? (mode
& S_IXOTH
? 't' : 'T')
528 : (mode
& S_IXOTH
? 'x' : '-'));
532 /* Report an error associated with the system call CALL and the
533 optional name NAME. */
535 call_arg_error (char const *call
, char const *name
)
538 ERROR ((0, e
, _("%s: Cannot %s"), quotearg_colon (name
), call
));
541 /* Report a fatal error associated with the system call CALL and
542 the optional file name NAME. */
544 call_arg_fatal (char const *call
, char const *name
)
547 FATAL_ERROR ((0, e
, _("%s: Cannot %s"), quotearg_colon (name
), call
));
550 /* Report a warning associated with the system call CALL and
551 the optional file name NAME. */
553 call_arg_warn (char const *call
, char const *name
)
556 WARN ((0, e
, _("%s: Warning: Cannot %s"), quotearg_colon (name
), call
));
560 chdir_fatal (char const *name
)
562 call_arg_fatal ("chdir", name
);
566 chmod_error_details (char const *name
, mode_t mode
)
570 decode_mode (mode
, buf
);
571 ERROR ((0, e
, _("%s: Cannot change mode to %s"),
572 quotearg_colon (name
), buf
));
576 chown_error_details (char const *name
, uid_t uid
, gid_t gid
)
579 ERROR ((0, e
, _("%s: Cannot change ownership to uid %lu, gid %lu"),
580 quotearg_colon (name
), (unsigned long) uid
, (unsigned long) gid
));
584 close_error (char const *name
)
586 call_arg_error ("close", name
);
590 close_fatal (char const *name
)
592 call_arg_fatal ("close", name
);
596 close_warn (char const *name
)
598 call_arg_warn ("close", name
);
602 exec_fatal (char const *name
)
604 call_arg_fatal ("exec", name
);
608 link_error (char const *target
, char const *source
)
611 ERROR ((0, e
, _("%s: Cannot hard link to %s"),
612 quotearg_colon (source
), quote_n (1, target
)));
616 mkdir_error (char const *name
)
618 call_arg_error ("mkdir", name
);
622 mkfifo_error (char const *name
)
624 call_arg_error ("mkfifo", name
);
628 mknod_error (char const *name
)
630 call_arg_error ("mknod", name
);
634 open_error (char const *name
)
636 call_arg_error ("open", name
);
640 open_fatal (char const *name
)
642 call_arg_fatal ("open", name
);
646 open_warn (char const *name
)
648 call_arg_warn ("open", name
);
652 read_error (char const *name
)
654 call_arg_error ("read", name
);
658 read_error_details (char const *name
, off_t offset
, size_t size
)
660 char buf
[UINTMAX_STRSIZE_BOUND
];
663 ngettext ("%s: Read error at byte %s, reading %lu byte",
664 "%s: Read error at byte %s, reading %lu bytes",
666 quotearg_colon (name
), STRINGIFY_BIGINT (offset
, buf
),
667 (unsigned long) size
));
671 read_warn_details (char const *name
, off_t offset
, size_t size
)
673 char buf
[UINTMAX_STRSIZE_BOUND
];
676 ngettext ("%s: Warning: Read error at byte %s, reading %lu byte",
677 "%s: Warning: Read error at byte %s, reading %lu bytes",
679 quotearg_colon (name
), STRINGIFY_BIGINT (offset
, buf
),
680 (unsigned long) size
));
684 read_fatal (char const *name
)
686 call_arg_fatal ("read", name
);
690 read_fatal_details (char const *name
, off_t offset
, size_t size
)
692 char buf
[UINTMAX_STRSIZE_BOUND
];
695 ngettext ("%s: Read error at byte %s, reading %lu byte",
696 "%s: Read error at byte %s, reading %lu bytes",
698 quotearg_colon (name
), STRINGIFY_BIGINT (offset
, buf
),
699 (unsigned long) size
));
703 readlink_error (char const *name
)
705 call_arg_error ("readlink", name
);
709 readlink_warn (char const *name
)
711 call_arg_warn ("readlink", name
);
715 savedir_error (char const *name
)
717 call_arg_error ("savedir", name
);
721 savedir_warn (char const *name
)
723 call_arg_warn ("savedir", name
);
727 seek_error (char const *name
)
729 call_arg_error ("seek", name
);
733 seek_error_details (char const *name
, off_t offset
)
735 char buf
[UINTMAX_STRSIZE_BOUND
];
737 ERROR ((0, e
, _("%s: Cannot seek to %s"),
738 quotearg_colon (name
),
739 STRINGIFY_BIGINT (offset
, buf
)));
743 seek_warn (char const *name
)
745 call_arg_warn ("seek", name
);
749 seek_warn_details (char const *name
, off_t offset
)
751 char buf
[UINTMAX_STRSIZE_BOUND
];
753 WARN ((0, e
, _("%s: Warning: Cannot seek to %s"),
754 quotearg_colon (name
),
755 STRINGIFY_BIGINT (offset
, buf
)));
759 symlink_error (char const *contents
, char const *name
)
762 ERROR ((0, e
, _("%s: Cannot create symlink to %s"),
763 quotearg_colon (name
), quote_n (1, contents
)));
767 stat_error (char const *name
)
769 call_arg_error ("stat", name
);
773 stat_warn (char const *name
)
775 call_arg_warn ("stat", name
);
779 truncate_error (char const *name
)
781 call_arg_error ("truncate", name
);
785 truncate_warn (char const *name
)
787 call_arg_warn ("truncate", name
);
791 unlink_error (char const *name
)
793 call_arg_error ("unlink", name
);
797 utime_error (char const *name
)
799 call_arg_error ("utime", name
);
803 waitpid_error (char const *name
)
805 call_arg_error ("waitpid", name
);
809 write_error (char const *name
)
811 call_arg_error ("write", name
);
815 write_error_details (char const *name
, ssize_t status
, size_t size
)
821 ngettext ("%s: Wrote only %lu of %lu byte",
822 "%s: Wrote only %lu of %lu bytes",
824 name
, (unsigned long) status
, (unsigned long) record_size
));
828 write_fatal (char const *name
)
830 call_arg_fatal ("write", name
);
834 write_fatal_details (char const *name
, ssize_t status
, size_t size
)
836 write_error_details (name
, status
, size
);
841 /* Fork, aborting if unsuccessful. */
847 call_arg_fatal ("fork", _("child process"));
851 /* Create a pipe, aborting if unsuccessful. */
856 call_arg_fatal ("pipe", _("interprocess channel"));
859 /* Return an unambiguous printable representation, allocated in slot N,
860 for NAME, suitable for diagnostics. */
862 quote_n (int n
, char const *name
)
864 return quotearg_n_style (n
, locale_quoting_style
, name
);
867 /* Return an unambiguous printable representation of NAME, suitable
870 quote (char const *name
)
872 return quote_n (0, name
);