2 * Copyright (c) 2003-2007 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include "bsdtar_platform.h"
27 __FBSDID("$FreeBSD: src/usr.bin/tar/util.c,v 1.16 2007/03/11 10:36:42 kientzle Exp $");
29 #ifdef HAVE_SYS_STAT_H
32 #ifdef HAVE_SYS_TYPES_H
33 #include <sys/types.h> /* Linux doesn't define mode_t, etc. in sys/stat.h. */
52 static void bsdtar_vwarnc(struct bsdtar
*, int code
,
53 const char *fmt
, va_list ap
);
56 * Print a string, taking care with any non-printable characters.
60 safe_fprintf(FILE *f
, const char *fmt
, ...)
72 /* Use a stack-allocated buffer if we can, for speed and safety. */
74 buff_length
= sizeof(buff_stack
);
78 length
= vsnprintf(buff
, buff_length
, fmt
, ap
);
80 /* If the result is too large, allocate a buffer on the heap. */
81 if (length
>= buff_length
) {
82 buff_length
= length
+1;
83 buff_heap
= malloc(buff_length
);
84 /* Failsafe: use the truncated string if malloc fails. */
85 if (buff_heap
!= NULL
) {
88 length
= vsnprintf(buff
, buff_length
, fmt
, ap
);
93 /* Write data, expanding unprintable characters. */
97 unsigned char c
= *p
++;
99 if (isprint(c
) && c
!= '\\')
102 copy_buff
[i
++] = '\\';
104 case '\a': copy_buff
[i
++] = 'a'; break;
105 case '\b': copy_buff
[i
++] = 'b'; break;
106 case '\f': copy_buff
[i
++] = 'f'; break;
107 case '\n': copy_buff
[i
++] = 'n'; break;
109 /* On some platforms, \n and \r are the same. */
110 case '\r': copy_buff
[i
++] = 'r'; break;
112 case '\t': copy_buff
[i
++] = 't'; break;
113 case '\v': copy_buff
[i
++] = 'v'; break;
114 case '\\': copy_buff
[i
++] = '\\'; break;
116 sprintf(copy_buff
+ i
, "%03o", c
);
121 /* If our temp buffer is full, dump it and keep going. */
122 if (i
> (sizeof(copy_buff
) - 8)) {
123 copy_buff
[i
++] = '\0';
124 fprintf(f
, "%s", copy_buff
);
128 copy_buff
[i
++] = '\0';
129 fprintf(f
, "%s", copy_buff
);
131 /* If we allocated a heap-based buffer, free it now. */
132 if (buff_heap
!= NULL
)
137 bsdtar_vwarnc(struct bsdtar
*bsdtar
, int code
, const char *fmt
, va_list ap
)
139 fprintf(stderr
, "%s: ", bsdtar
->progname
);
140 vfprintf(stderr
, fmt
, ap
);
142 fprintf(stderr
, ": %s", strerror(code
));
143 fprintf(stderr
, "\n");
147 bsdtar_warnc(struct bsdtar
*bsdtar
, int code
, const char *fmt
, ...)
152 bsdtar_vwarnc(bsdtar
, code
, fmt
, ap
);
157 bsdtar_errc(struct bsdtar
*bsdtar
, int eval
, int code
, const char *fmt
, ...)
162 bsdtar_vwarnc(bsdtar
, code
, fmt
, ap
);
168 yes(const char *fmt
, ...)
176 vfprintf(stderr
, fmt
, ap
);
178 fprintf(stderr
, " (y/N)? ");
181 l
= read(2, buff
, sizeof(buff
));
186 for (p
= buff
; *p
!= '\0'; p
++) {
187 if (isspace(0xff & (int)*p
))
203 bsdtar_strmode(struct archive_entry
*entry
, char *bp
)
205 static const char *perms
= "?rwxrwxrwx ";
206 static const mode_t permbits
[] =
207 { S_IRUSR
, S_IWUSR
, S_IXUSR
, S_IRGRP
, S_IWGRP
, S_IXGRP
,
208 S_IROTH
, S_IWOTH
, S_IXOTH
};
212 /* Fill in a default string, then selectively override. */
215 mode
= archive_entry_mode(entry
);
216 switch (mode
& S_IFMT
) {
217 case S_IFREG
: bp
[0] = '-'; break;
218 case S_IFBLK
: bp
[0] = 'b'; break;
219 case S_IFCHR
: bp
[0] = 'c'; break;
220 case S_IFDIR
: bp
[0] = 'd'; break;
221 case S_IFLNK
: bp
[0] = 'l'; break;
222 case S_IFSOCK
: bp
[0] = 's'; break;
224 case S_IFIFO
: bp
[0] = 'p'; break;
227 case S_IFWHT
: bp
[0] = 'w'; break;
231 for (i
= 0; i
< 9; i
++)
232 if (!(mode
& permbits
[i
]))
235 if (mode
& S_ISUID
) {
236 if (mode
& S_IXUSR
) bp
[3] = 's';
239 if (mode
& S_ISGID
) {
240 if (mode
& S_IXGRP
) bp
[6] = 's';
243 if (mode
& S_ISVTX
) {
244 if (mode
& S_IXOTH
) bp
[9] = 't';
247 if (archive_entry_acl_count(entry
, ARCHIVE_ENTRY_ACL_TYPE_ACCESS
))
253 * Read lines from file and do something with each one. If option_null
254 * is set, lines are terminated with zero bytes; otherwise, they're
255 * terminated with newlines.
257 * This uses a self-sizing buffer to handle arbitrarily-long lines.
258 * If the "process" function returns non-zero for any line, this
259 * function will return non-zero after attempting to process all
263 process_lines(struct bsdtar
*bsdtar
, const char *pathname
,
264 int (*process
)(struct bsdtar
*, const char *))
267 char *buff
, *buff_end
, *line_start
, *line_end
, *p
;
268 size_t buff_length
, bytes_read
, bytes_wanted
;
272 separator
= bsdtar
->option_null
? '\0' : '\n';
275 if (strcmp(pathname
, "-") == 0)
278 f
= fopen(pathname
, "r");
280 bsdtar_errc(bsdtar
, 1, errno
, "Couldn't open %s", pathname
);
282 buff
= malloc(buff_length
);
284 bsdtar_errc(bsdtar
, 1, ENOMEM
, "Can't read %s", pathname
);
285 line_start
= line_end
= buff_end
= buff
;
287 /* Get some more data into the buffer. */
288 bytes_wanted
= buff
+ buff_length
- buff_end
;
289 bytes_read
= fread(buff_end
, 1, bytes_wanted
, f
);
290 buff_end
+= bytes_read
;
291 /* Process all complete lines in the buffer. */
292 while (line_end
< buff_end
) {
293 if (*line_end
== separator
) {
295 if ((*process
)(bsdtar
, line_start
) != 0)
297 line_start
= line_end
+ 1;
298 line_end
= line_start
;
305 bsdtar_errc(bsdtar
, 1, errno
,
306 "Can't read %s", pathname
);
307 if (line_start
> buff
) {
308 /* Move a leftover fractional line to the beginning. */
309 memmove(buff
, line_start
, buff_end
- line_start
);
310 buff_end
-= line_start
- buff
;
311 line_end
-= line_start
- buff
;
314 /* Line is too big; enlarge the buffer. */
315 p
= realloc(buff
, buff_length
*= 2);
317 bsdtar_errc(bsdtar
, 1, ENOMEM
,
318 "Line too long in %s", pathname
);
319 buff_end
= p
+ (buff_end
- buff
);
320 line_end
= p
+ (line_end
- buff
);
321 line_start
= buff
= p
;
324 /* At end-of-file, handle the final line. */
325 if (line_end
> line_start
) {
327 if ((*process
)(bsdtar
, line_start
) != 0)
337 * The logic here for -C <dir> attempts to avoid
338 * chdir() as long as possible. For example:
339 * "-C /foo -C /bar file" needs chdir("/bar") but not chdir("/foo")
340 * "-C /foo -C bar file" needs chdir("/foo/bar")
341 * "-C /foo -C bar /file1" does not need chdir()
342 * "-C /foo -C bar /file1 file2" needs chdir("/foo/bar") before file2
344 * The only correct way to handle this is to record a "pending" chdir
345 * request and combine multiple requests intelligently until we
346 * need to process a non-absolute file. set_chdir() adds the new dir
347 * to the pending list; do_chdir() actually executes any pending chdir.
349 * This way, programs that build tar command lines don't have to worry
350 * about -C with non-existent directories; such requests will only
351 * fail if the directory must be accessed.
354 set_chdir(struct bsdtar
*bsdtar
, const char *newdir
)
356 if (newdir
[0] == '/') {
357 /* The -C /foo -C /bar case; dump first one. */
358 free(bsdtar
->pending_chdir
);
359 bsdtar
->pending_chdir
= NULL
;
361 if (bsdtar
->pending_chdir
== NULL
)
362 /* Easy case: no previously-saved dir. */
363 bsdtar
->pending_chdir
= strdup(newdir
);
365 /* The -C /foo -C bar case; concatenate */
366 char *old_pending
= bsdtar
->pending_chdir
;
367 size_t old_len
= strlen(old_pending
);
368 bsdtar
->pending_chdir
= malloc(old_len
+ strlen(newdir
) + 2);
369 if (old_pending
[old_len
- 1] == '/')
370 old_pending
[old_len
- 1] = '\0';
371 if (bsdtar
->pending_chdir
!= NULL
)
372 sprintf(bsdtar
->pending_chdir
, "%s/%s",
373 old_pending
, newdir
);
376 if (bsdtar
->pending_chdir
== NULL
)
377 bsdtar_errc(bsdtar
, 1, errno
, "No memory");
381 do_chdir(struct bsdtar
*bsdtar
)
383 if (bsdtar
->pending_chdir
== NULL
)
386 if (chdir(bsdtar
->pending_chdir
) != 0) {
387 bsdtar_errc(bsdtar
, 1, 0, "could not chdir to '%s'\n",
388 bsdtar
->pending_chdir
);
390 free(bsdtar
->pending_chdir
);
391 bsdtar
->pending_chdir
= NULL
;
395 * Handle --strip-components and any future path-rewriting options.
396 * Returns non-zero if the pathname should not be extracted.
398 * TODO: Support pax-style regex path rewrites.
401 edit_pathname(struct bsdtar
*bsdtar
, struct archive_entry
*entry
)
403 const char *name
= archive_entry_pathname(entry
);
405 /* Strip leading dir names as per --strip-components option. */
406 if (bsdtar
->strip_components
> 0) {
407 int r
= bsdtar
->strip_components
;
408 const char *p
= name
;
417 /* Path is too short, skip it. */
423 /* Strip redundant leading '/' characters. */
424 while (name
[0] == '/' && name
[1] == '/')
427 /* Strip leading '/' unless user has asked us not to. */
428 if (name
[0] == '/' && !bsdtar
->option_absolute_paths
) {
429 /* Generate a warning the first time this happens. */
430 if (!bsdtar
->warned_lead_slash
) {
431 bsdtar_warnc(bsdtar
, 0,
432 "Removing leading '/' from member names");
433 bsdtar
->warned_lead_slash
= 1;
436 /* Special case: Stripping leading '/' from "/" yields ".". */
441 /* Safely replace name in archive_entry. */
442 if (name
!= archive_entry_pathname(entry
)) {
443 char *q
= strdup(name
);
444 archive_entry_copy_pathname(entry
, q
);
451 * Like strcmp(), but try to be a little more aware of the fact that
452 * we're comparing two paths.
454 * TODO: Make this better, so that "./a//b/./c" == "a/b/c"
457 pathcmp(const char *a
, const char *b
)
459 if (a
[0] == '.' && a
[1] == '/' && a
[2] != '\0')
461 if (b
[0] == '.' && b
[1] == '/' && b
[2] != '\0')
463 return (strcmp(a
, b
));