1 /* vi: set sw=4 ts=4: */
3 * Mini tar implementation for busybox
5 * Modified to use common extraction code used by ar, cpio, dpkg-deb, dpkg
8 * Note, that as of BusyBox-0.43, tar has been completely rewritten from the
9 * ground up. It still has remnants of the old code lying about, but it is
10 * very different now (i.e., cleaner, less global variables, etc.)
12 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
14 * Based in part in the tar implementation in sash
15 * Copyright (c) 1999 by David I. Bell
16 * Permission is granted to use, distribute, or modify this source,
17 * provided that this copyright notice remains intact.
18 * Permission to distribute sash derived code under the GPL has been granted.
20 * Based in part on the tar implementation from busybox-0.28
21 * Copyright (C) 1995 Bruce Perens
23 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
29 #include "unarchive.h"
31 #define block_buf bb_common_bufsiz1
33 #if ENABLE_FEATURE_TAR_CREATE
35 /* Tar file constants */
37 #define TAR_BLOCK_SIZE 512
39 /* POSIX tar Header Block, from POSIX 1003.1-1990 */
41 #define NAME_SIZE_STR "100"
42 typedef struct TarHeader TarHeader;
43 struct TarHeader { /* byte offset */
44 char name[NAME_SIZE]; /* 0-99 */
45 char mode[8]; /* 100-107 */
46 char uid[8]; /* 108-115 */
47 char gid[8]; /* 116-123 */
48 char size[12]; /* 124-135 */
49 char mtime[12]; /* 136-147 */
50 char chksum[8]; /* 148-155 */
51 char typeflag; /* 156-156 */
52 char linkname[NAME_SIZE]; /* 157-256 */
53 /* POSIX: "ustar" NUL "00" */
54 /* GNU tar: "ustar " NUL */
55 /* Normally it's defined as magic[6] followed by
56 * version[2], but we put them together to save code.
58 char magic[8]; /* 257-264 */
59 char uname[32]; /* 265-296 */
60 char gname[32]; /* 297-328 */
61 char devmajor[8]; /* 329-336 */
62 char devminor[8]; /* 337-344 */
63 char prefix[155]; /* 345-499 */
64 char padding[12]; /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */
68 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
69 ** the only functions that deal with the HardLinkInfo structure.
70 ** Even these functions use the xxxHardLinkInfo() functions.
72 typedef struct HardLinkInfo HardLinkInfo;
74 HardLinkInfo *next; /* Next entry in list */
75 dev_t dev; /* Device number */
76 ino_t ino; /* Inode number */
77 short linkCount; /* (Hard) Link Count */
78 char name[1]; /* Start of filename (must be last) */
81 /* Some info to be carried along when creating a new tarball */
82 typedef struct TarBallInfo TarBallInfo;
84 int tarFd; /* Open-for-write file descriptor
86 struct stat statBuf; /* Stat info for the tarball, letting
87 us know the inode and device that the
88 tarball lives, so we can avoid trying
89 to include the tarball into itself */
90 int verboseFlag; /* Whether to print extra stuff or not */
91 const llist_t *excludeList; /* List of files to not include */
92 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
93 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
96 /* A nice enum with all the possible tar file content types */
98 REGTYPE = '0', /* regular file */
99 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
100 LNKTYPE = '1', /* hard link */
101 SYMTYPE = '2', /* symbolic link */
102 CHRTYPE = '3', /* character special */
103 BLKTYPE = '4', /* block special */
104 DIRTYPE = '5', /* directory */
105 FIFOTYPE = '6', /* FIFO special */
106 CONTTYPE = '7', /* reserved */
107 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
108 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
110 typedef enum TarFileType TarFileType;
112 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
113 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
114 struct stat *statbuf,
115 const char *fileName)
117 /* Note: hlInfoHeadPtr can never be NULL! */
118 HardLinkInfo *hlInfo;
120 hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
121 hlInfo->next = *hlInfoHeadPtr;
122 *hlInfoHeadPtr = hlInfo;
123 hlInfo->dev = statbuf->st_dev;
124 hlInfo->ino = statbuf->st_ino;
125 hlInfo->linkCount = statbuf->st_nlink;
126 strcpy(hlInfo->name, fileName);
129 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
131 HardLinkInfo *hlInfo;
132 HardLinkInfo *hlInfoNext;
135 hlInfo = *hlInfoHeadPtr;
137 hlInfoNext = hlInfo->next;
141 *hlInfoHeadPtr = NULL;
145 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
146 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
149 if ((statbuf->st_ino == hlInfo->ino) && (statbuf->st_dev == hlInfo->dev))
151 hlInfo = hlInfo->next;
156 /* Put an octal string into the specified buffer.
157 * The number is zero padded and possibly null terminated.
158 * Stores low-order bits only if whole value does not fit. */
159 static void putOctal(char *cp, int len, off_t value)
161 char tempBuffer[sizeof(off_t)*3+1];
162 char *tempString = tempBuffer;
165 width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
166 tempString += (width - len);
168 /* If string has leading zeroes, we can drop one */
169 /* and field will have trailing '\0' */
170 /* (increases chances of compat with other tars) */
171 if (tempString[0] == '0')
174 /* Copy the string to the field */
175 memcpy(cp, tempString, len);
177 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
179 static void chksum_and_xwrite(int fd, struct TarHeader* hp)
181 /* POSIX says that checksum is done on unsigned bytes
182 * (Sun and HP-UX gets it wrong... more details in
184 const unsigned char *cp;
187 strcpy(hp->magic, "ustar ");
189 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
190 * the header). The checksum field must be filled with blanks for the
191 * calculation. The checksum field is formatted differently from the
192 * other fields: it has 6 digits, a null, then a space -- rather than
193 * digits, followed by a null like the other fields... */
194 memset(hp->chksum, ' ', sizeof(hp->chksum));
195 cp = (const unsigned char *) hp;
198 do { chksum += *cp++; } while (--size);
199 putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
201 /* Now write the header out to disk */
202 xwrite(fd, hp, sizeof(*hp));
205 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
206 static void writeLongname(int fd, int type, const char *name, int dir)
208 static const struct {
209 char mode[8]; /* 100-107 */
210 char uid[8]; /* 108-115 */
211 char gid[8]; /* 116-123 */
212 char size[12]; /* 124-135 */
213 char mtime[12]; /* 136-147 */
221 struct TarHeader header;
224 dir = !!dir; /* normalize: 0/1 */
225 size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
226 /* + dir: account for possible '/' */
228 memset(&header, 0, sizeof(header));
229 strcpy(header.name, "././@LongLink");
230 memcpy(header.mode, prefilled.mode, sizeof(prefilled));
231 PUT_OCTAL(header.size, size);
232 header.typeflag = type;
233 chksum_and_xwrite(fd, &header);
235 /* Write filename[/] and pad the block. */
236 /* dir=0: writes 'name<NUL>', pads */
237 /* dir=1: writes 'name', writes '/<NUL>', pads */
239 xwrite(fd, name, size - dir);
240 xwrite(fd, "/", dir);
241 size = (-size) & (TAR_BLOCK_SIZE-1);
242 memset(&header, 0, size);
243 xwrite(fd, &header, size);
247 /* Write out a tar header for the specified file/directory/whatever */
248 void BUG_tar_header_size(void);
249 static int writeTarHeader(struct TarBallInfo *tbInfo,
250 const char *header_name, const char *fileName, struct stat *statbuf)
252 struct TarHeader header;
254 if (sizeof(header) != 512)
255 BUG_tar_header_size();
257 memset(&header, 0, sizeof(struct TarHeader));
259 strncpy(header.name, header_name, sizeof(header.name));
261 /* POSIX says to mask mode with 07777. */
262 PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
263 PUT_OCTAL(header.uid, statbuf->st_uid);
264 PUT_OCTAL(header.gid, statbuf->st_gid);
265 memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
266 PUT_OCTAL(header.mtime, statbuf->st_mtime);
268 /* Enter the user and group names */
269 safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
270 safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
272 if (tbInfo->hlInfo) {
273 /* This is a hard link */
274 header.typeflag = LNKTYPE;
275 strncpy(header.linkname, tbInfo->hlInfo->name,
276 sizeof(header.linkname));
277 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
278 /* Write out long linkname if needed */
279 if (header.linkname[sizeof(header.linkname)-1])
280 writeLongname(tbInfo->tarFd, GNULONGLINK,
281 tbInfo->hlInfo->name, 0);
283 } else if (S_ISLNK(statbuf->st_mode)) {
284 char *lpath = xmalloc_readlink_or_warn(fileName);
287 header.typeflag = SYMTYPE;
288 strncpy(header.linkname, lpath, sizeof(header.linkname));
289 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
290 /* Write out long linkname if needed */
291 if (header.linkname[sizeof(header.linkname)-1])
292 writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
294 /* If it is larger than 100 bytes, bail out */
295 if (header.linkname[sizeof(header.linkname)-1]) {
297 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
302 } else if (S_ISDIR(statbuf->st_mode)) {
303 header.typeflag = DIRTYPE;
304 /* Append '/' only if there is a space for it */
305 if (!header.name[sizeof(header.name)-1])
306 header.name[strlen(header.name)] = '/';
307 } else if (S_ISCHR(statbuf->st_mode)) {
308 header.typeflag = CHRTYPE;
309 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
310 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
311 } else if (S_ISBLK(statbuf->st_mode)) {
312 header.typeflag = BLKTYPE;
313 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
314 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
315 } else if (S_ISFIFO(statbuf->st_mode)) {
316 header.typeflag = FIFOTYPE;
317 } else if (S_ISREG(statbuf->st_mode)) {
318 if (sizeof(statbuf->st_size) > 4
319 && statbuf->st_size > (off_t)0777777777777LL
321 bb_error_msg_and_die("cannot store file '%s' "
322 "of size %"OFF_FMT"d, aborting",
323 fileName, statbuf->st_size);
325 header.typeflag = REGTYPE;
326 PUT_OCTAL(header.size, statbuf->st_size);
328 bb_error_msg("%s: unknown file type", fileName);
332 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
333 /* Write out long name if needed */
334 /* (we, like GNU tar, output long linkname *before* long name) */
335 if (header.name[sizeof(header.name)-1])
336 writeLongname(tbInfo->tarFd, GNULONGNAME,
337 header_name, S_ISDIR(statbuf->st_mode));
340 /* Now write the header out to disk */
341 chksum_and_xwrite(tbInfo->tarFd, &header);
343 /* Now do the verbose thing (or not) */
344 if (tbInfo->verboseFlag) {
347 if (tbInfo->tarFd == STDOUT_FILENO) /* If the archive goes to stdout, verbose to stderr */
349 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
350 /* We don't have such excesses here: for us "v" == "vv" */
351 /* '/' is probably a GNUism */
352 fprintf(vbFd, "%s%s\n", header_name,
353 S_ISDIR(statbuf->st_mode) ? "/" : "");
359 #if ENABLE_FEATURE_TAR_FROM
360 static int exclude_file(const llist_t *excluded_files, const char *file)
362 while (excluded_files) {
363 if (excluded_files->data[0] == '/') {
364 if (fnmatch(excluded_files->data, file,
365 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
370 for (p = file; p[0] != '\0'; p++) {
371 if ((p == file || p[-1] == '/') && p[0] != '/' &&
372 fnmatch(excluded_files->data, p,
373 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
377 excluded_files = excluded_files->link;
383 #define exclude_file(excluded_files, file) 0
386 static int writeFileToTarball(const char *fileName, struct stat *statbuf,
387 void *userData, int depth ATTRIBUTE_UNUSED)
389 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
390 const char *header_name;
391 int inputFileFd = -1;
393 /* Strip leading '/' (must be before memorizing hardlink's name) */
394 header_name = fileName;
395 while (header_name[0] == '/') {
396 static smallint warned;
399 bb_error_msg("removing leading '/' from member names");
405 if (header_name[0] == '\0')
408 /* It is against the rules to archive a socket */
409 if (S_ISSOCK(statbuf->st_mode)) {
410 bb_error_msg("%s: socket ignored", fileName);
415 * Check to see if we are dealing with a hard link.
417 * Treat the first occurance of a given dev/inode as a file while
418 * treating any additional occurances as hard links. This is done
419 * by adding the file information to the HardLinkInfo linked list.
421 tbInfo->hlInfo = NULL;
422 if (statbuf->st_nlink > 1) {
423 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
424 if (tbInfo->hlInfo == NULL)
425 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
428 /* It is a bad idea to store the archive we are in the process of creating,
429 * so check the device and inode to be sure that this particular file isn't
431 if (tbInfo->statBuf.st_dev == statbuf->st_dev
432 && tbInfo->statBuf.st_ino == statbuf->st_ino
434 bb_error_msg("%s: file is the archive; skipping", fileName);
438 if (exclude_file(tbInfo->excludeList, header_name))
441 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
442 if (strlen(header_name) >= NAME_SIZE) {
443 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
448 /* Is this a regular file? */
449 if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
450 /* open the file we want to archive, and make sure all is well */
451 inputFileFd = open_or_warn(fileName, O_RDONLY);
452 if (inputFileFd < 0) {
457 /* Add an entry to the tarball */
458 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
462 /* If it was a regular file, write out the body */
463 if (inputFileFd >= 0) {
465 /* Write the file to the archive. */
466 /* We record size into header first, */
467 /* and then write out file. If file shrinks in between, */
468 /* tar will be corrupted. So we don't allow for that. */
469 /* NB: GNU tar 1.16 warns and pads with zeroes */
470 /* or even seeks back and updates header */
471 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
473 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
474 ////if (readSize != statbuf->st_size && readSize >= 0) {
475 //// bb_error_msg_and_die("short read from %s, aborting", fileName);
478 /* Check that file did not grow in between? */
479 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
483 /* Pad the file up to the tar block size */
484 /* (a few tricks here in the name of code size) */
485 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
486 memset(block_buf, 0, readSize);
487 xwrite(tbInfo->tarFd, block_buf, readSize);
493 static int writeTarFile(const int tar_fd, const int verboseFlag,
494 const unsigned long dereferenceFlag, const llist_t *include,
495 const llist_t *exclude, const int gzip)
498 int errorFlag = FALSE;
499 struct TarBallInfo tbInfo;
501 tbInfo.hlInfoHead = NULL;
503 fchmod(tar_fd, 0644);
504 tbInfo.tarFd = tar_fd;
505 tbInfo.verboseFlag = verboseFlag;
507 /* Store the stat info for the tarball's file, so
508 * can avoid including the tarball into itself.... */
509 if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
510 bb_perror_msg_and_die("cannot stat tar file");
512 if ((ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2) && gzip) {
513 // On Linux, vfork never unpauses parent early, although standard
514 // allows for that. Do we want to waste bytes checking for it?
515 #define WAIT_FOR_CHILD 0
517 volatile int vfork_exec_errno = 0;
519 struct { int rd; int wr; } gzipStatusPipe;
521 struct { int rd; int wr; } gzipDataPipe;
522 const char *zip_exec = (gzip == 1) ? "gzip" : "bzip2";
524 xpipe(&gzipDataPipe.rd);
526 xpipe(&gzipStatusPipe.rd);
529 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
531 #if defined(__GNUC__) && __GNUC__
532 /* Avoid vfork clobbering */
540 bb_perror_msg_and_die("vfork gzip");
544 xmove_fd(tbInfo.tarFd, 1);
545 xmove_fd(gzipDataPipe.rd, 0);
546 close(gzipDataPipe.wr);
548 close(gzipStatusPipe.rd);
549 fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
551 /* exec gzip/bzip2 program/applet */
552 BB_EXECLP(zip_exec, zip_exec, "-f", NULL);
553 vfork_exec_errno = errno;
558 xmove_fd(gzipDataPipe.wr, tbInfo.tarFd);
559 close(gzipDataPipe.rd);
561 close(gzipStatusPipe.wr);
566 /* Wait until child execs (or fails to) */
567 n = full_read(gzipStatusPipe.rd, &buf, 1);
568 if ((n < 0) && (/*errno == EAGAIN ||*/ errno == EINTR))
569 continue; /* try it again */
572 close(gzipStatusPipe.rd);
574 if (vfork_exec_errno) {
575 errno = vfork_exec_errno;
576 bb_perror_msg_and_die("cannot exec %s", zip_exec);
580 tbInfo.excludeList = exclude;
582 /* Read the directory/files and iterate over them one at a time */
584 if (!recursive_action(include->data, ACTION_RECURSE |
585 (dereferenceFlag ? ACTION_FOLLOWLINKS : 0),
586 writeFileToTarball, writeFileToTarball, &tbInfo, 0))
590 include = include->link;
592 /* Write two empty blocks to the end of the archive */
593 memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
594 xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
596 /* To be pedantically correct, we would check if the tarball
597 * is smaller than 20 tar blocks, and pad it if it was smaller,
598 * but that isn't necessary for GNU tar interoperability, and
599 * so is considered a waste of space */
601 /* Close so the child process (if any) will exit */
604 /* Hang up the tools, close up shop, head home */
605 if (ENABLE_FEATURE_CLEAN_UP)
606 freeHardLinkInfo(&tbInfo.hlInfoHead);
609 bb_error_msg("error exit delayed from previous errors");
613 if (waitpid(gzipPid, &status, 0) == -1)
614 bb_perror_msg("waitpid");
615 else if (!WIFEXITED(status) || WEXITSTATUS(status))
616 /* gzip was killed or has exited with nonzero! */
622 int writeTarFile(const int tar_fd, const int verboseFlag,
623 const unsigned long dereferenceFlag, const llist_t *include,
624 const llist_t *exclude, const int gzip);
625 #endif /* FEATURE_TAR_CREATE */
627 #if ENABLE_FEATURE_TAR_FROM
628 static llist_t *append_file_list_to_list(llist_t *list)
634 llist_t *newlist = NULL;
637 src_stream = xfopen(cur->data, "r");
641 while ((line = xmalloc_getline(src_stream)) != NULL) {
642 /* kill trailing '/' unless the string is just "/" */
643 char *cp = last_char_is(line, '/');
646 llist_add_to(&newlist, line);
653 #define append_file_list_to_list(x) 0
656 #if ENABLE_FEATURE_TAR_COMPRESS
657 static char get_header_tar_Z(archive_handle_t *archive_handle)
659 /* Can't lseek over pipes */
660 archive_handle->seek = seek_by_read;
662 /* do the decompression, and cleanup */
663 if (xread_char(archive_handle->src_fd) != 0x1f
664 || xread_char(archive_handle->src_fd) != 0x9d
666 bb_error_msg_and_die("invalid magic");
669 archive_handle->src_fd = open_transformer(archive_handle->src_fd, uncompress, "uncompress");
670 archive_handle->offset = 0;
671 while (get_header_tar(archive_handle) == EXIT_SUCCESS)
674 /* Can only do one file at a time */
678 #define get_header_tar_Z NULL
681 #ifdef CHECK_FOR_CHILD_EXITCODE
682 /* Looks like it isn't needed - tar detects malformed (truncated)
683 * archive if e.g. bunzip2 fails */
684 static int child_error;
686 static void handle_SIGCHLD(int status)
688 /* Actually, 'status' is a signo. We reuse it for other needs */
690 /* Wait for any child without blocking */
691 if (waitpid(-1, &status, WNOHANG) < 0)
692 /* wait failed?! I'm confused... */
695 if (WIFEXITED(status) && WEXITSTATUS(status)==0)
696 /* child exited with 0 */
699 if (!WIFSIGNALED(status) && !WIFEXITED(status)) return; */
706 USE_FEATURE_TAR_CREATE( OPTBIT_CREATE ,)
707 USE_FEATURE_TAR_CREATE( OPTBIT_DEREFERENCE ,)
708 USE_FEATURE_TAR_BZIP2( OPTBIT_BZIP2 ,)
709 USE_FEATURE_TAR_LZMA( OPTBIT_LZMA ,)
710 USE_FEATURE_TAR_FROM( OPTBIT_INCLUDE_FROM,)
711 USE_FEATURE_TAR_FROM( OPTBIT_EXCLUDE_FROM,)
712 USE_FEATURE_TAR_GZIP( OPTBIT_GZIP ,)
713 USE_FEATURE_TAR_COMPRESS(OPTBIT_COMPRESS ,)
714 OPTBIT_NOPRESERVE_OWN,
715 OPTBIT_NOPRESERVE_PERM,
716 OPT_TEST = 1 << 0, // t
717 OPT_EXTRACT = 1 << 1, // x
718 OPT_BASEDIR = 1 << 2, // C
719 OPT_TARNAME = 1 << 3, // f
720 OPT_2STDOUT = 1 << 4, // O
722 OPT_VERBOSE = 1 << 6, // v
723 OPT_KEEP_OLD = 1 << 7, // k
724 OPT_CREATE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_CREATE )) + 0, // c
725 OPT_DEREFERENCE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_DEREFERENCE )) + 0, // h
726 OPT_BZIP2 = USE_FEATURE_TAR_BZIP2( (1<<OPTBIT_BZIP2 )) + 0, // j
727 OPT_LZMA = USE_FEATURE_TAR_LZMA( (1<<OPTBIT_LZMA )) + 0, // a
728 OPT_INCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_INCLUDE_FROM)) + 0, // T
729 OPT_EXCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_EXCLUDE_FROM)) + 0, // X
730 OPT_GZIP = USE_FEATURE_TAR_GZIP( (1<<OPTBIT_GZIP )) + 0, // z
731 OPT_COMPRESS = USE_FEATURE_TAR_COMPRESS((1<<OPTBIT_COMPRESS )) + 0, // Z
732 OPT_NOPRESERVE_OWN = 1 << OPTBIT_NOPRESERVE_OWN , // no-same-owner
733 OPT_NOPRESERVE_PERM = 1 << OPTBIT_NOPRESERVE_PERM, // no-same-permissions
735 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
736 static const char tar_longopts[] ALIGN1 =
737 "list\0" No_argument "t"
738 "extract\0" No_argument "x"
739 "directory\0" Required_argument "C"
740 "file\0" Required_argument "f"
741 "to-stdout\0" No_argument "O"
742 "same-permissions\0" No_argument "p"
743 "verbose\0" No_argument "v"
744 "keep-old\0" No_argument "k"
745 # if ENABLE_FEATURE_TAR_CREATE
746 "create\0" No_argument "c"
747 "dereference\0" No_argument "h"
749 # if ENABLE_FEATURE_TAR_BZIP2
750 "bzip2\0" No_argument "j"
752 # if ENABLE_FEATURE_TAR_LZMA
753 "lzma\0" No_argument "a"
755 # if ENABLE_FEATURE_TAR_FROM
756 "files-from\0" Required_argument "T"
757 "exclude-from\0" Required_argument "X"
759 # if ENABLE_FEATURE_TAR_GZIP
760 "gzip\0" No_argument "z"
762 # if ENABLE_FEATURE_TAR_COMPRESS
763 "compress\0" No_argument "Z"
765 "no-same-owner\0" No_argument "\xfd"
766 "no-same-permissions\0" No_argument "\xfe"
767 /* --exclude takes next bit position in option mask, */
768 /* therefore we have to either put it _after_ --no-same-perm */
769 /* or add OPT[BIT]_EXCLUDE before OPT[BIT]_NOPRESERVE_OWN */
770 # if ENABLE_FEATURE_TAR_FROM
771 "exclude\0" Required_argument "\xff"
776 int tar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
777 int tar_main(int argc, char **argv)
779 char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
780 archive_handle_t *tar_handle;
781 char *base_dir = NULL;
782 const char *tar_filename = "-";
785 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
786 llist_t *excludes = NULL;
789 /* Initialise default values */
790 tar_handle = init_handle();
791 tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS
792 | ARCHIVE_PRESERVE_DATE
793 | ARCHIVE_EXTRACT_UNCONDITIONAL;
795 /* Prepend '-' to the first argument if required */
796 opt_complementary = "--:" // first arg is options
797 "tt:vv:" // count -t,-v
798 "?:" // bail out with usage instead of error return
799 "X::T::" // cumulative lists
800 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
801 "\xff::" // cumulative lists for --exclude
803 USE_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
804 USE_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
805 SKIP_FEATURE_TAR_CREATE("t--x:x--t"); // mutually exclusive
806 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
807 applet_long_options = tar_longopts;
811 USE_FEATURE_TAR_CREATE( "ch" )
812 USE_FEATURE_TAR_BZIP2( "j" )
813 USE_FEATURE_TAR_LZMA( "a" )
814 USE_FEATURE_TAR_FROM( "T:X:")
815 USE_FEATURE_TAR_GZIP( "z" )
816 USE_FEATURE_TAR_COMPRESS("Z" )
817 , &base_dir // -C dir
818 , &tar_filename // -f filename
819 USE_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
820 USE_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
821 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
822 , &excludes // --exclude
824 , &verboseFlag // combined count for -t and -v
825 , &verboseFlag // combined count for -t and -v
828 if (verboseFlag) tar_handle->action_header = header_verbose_list;
829 if (verboseFlag == 1) tar_handle->action_header = header_list;
831 if (opt & OPT_EXTRACT)
832 tar_handle->action_data = data_extract_all;
834 if (opt & OPT_2STDOUT)
835 tar_handle->action_data = data_extract_to_stdout;
837 if (opt & OPT_KEEP_OLD)
838 tar_handle->flags &= ~ARCHIVE_EXTRACT_UNCONDITIONAL;
840 if (opt & OPT_NOPRESERVE_OWN)
841 tar_handle->flags |= ARCHIVE_NOPRESERVE_OWN;
843 if (opt & OPT_NOPRESERVE_PERM)
844 tar_handle->flags |= ARCHIVE_NOPRESERVE_PERM;
847 get_header_ptr = get_header_tar_gz;
850 get_header_ptr = get_header_tar_bz2;
853 get_header_ptr = get_header_tar_lzma;
855 if (opt & OPT_COMPRESS)
856 get_header_ptr = get_header_tar_Z;
858 #if ENABLE_FEATURE_TAR_FROM
859 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
860 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
861 /* Append excludes to reject */
863 llist_t *next = excludes->link;
864 excludes->link = tar_handle->reject;
865 tar_handle->reject = excludes;
869 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
872 /* Check if we are reading from stdin */
873 if (argv[optind] && *argv[optind] == '-') {
874 /* Default is to read from stdin, so just skip to next arg */
878 /* Setup an array of filenames to work with */
879 /* TODO: This is the same as in ar, separate function ? */
880 while (optind < argc) {
881 /* kill trailing '/' unless the string is just "/" */
882 char *cp = last_char_is(argv[optind], '/');
883 if (cp > argv[optind])
885 llist_add_to_end(&tar_handle->accept, argv[optind]);
889 if (tar_handle->accept || tar_handle->reject)
890 tar_handle->filter = filter_accept_reject_list;
892 /* Open the tar file */
897 if (opt & OPT_CREATE) {
898 /* Make sure there is at least one file to tar up. */
899 if (tar_handle->accept == NULL)
900 bb_error_msg_and_die("empty archive");
903 /* Mimicking GNU tar 1.15.1: */
904 flags = O_WRONLY|O_CREAT|O_TRUNC;
905 /* was doing unlink; open(O_WRONLY|O_CREAT|O_EXCL); why? */
911 if (LONE_DASH(tar_filename)) {
912 tar_handle->src_fd = fileno(tar_stream);
913 tar_handle->seek = seek_by_read;
915 tar_handle->src_fd = xopen(tar_filename, flags);
922 #ifdef CHECK_FOR_CHILD_EXITCODE
923 /* We need to know whether child (gzip/bzip/etc) exits abnormally */
924 signal(SIGCHLD, handle_SIGCHLD);
927 /* create an archive */
928 if (opt & OPT_CREATE) {
930 if (ENABLE_FEATURE_TAR_GZIP && get_header_ptr == get_header_tar_gz)
932 if (ENABLE_FEATURE_TAR_BZIP2 && get_header_ptr == get_header_tar_bz2)
934 /* NB: writeTarFile() closes tar_handle->src_fd */
935 return writeTarFile(tar_handle->src_fd, verboseFlag, opt & OPT_DEREFERENCE,
937 tar_handle->reject, zipMode);
940 while (get_header_ptr(tar_handle) == EXIT_SUCCESS)
943 /* Check that every file that should have been extracted was */
944 while (tar_handle->accept) {
945 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
946 && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
948 bb_error_msg_and_die("%s: not found in archive",
949 tar_handle->accept->data);
951 tar_handle->accept = tar_handle->accept->link;
953 if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
954 close(tar_handle->src_fd);