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.
28 #include "unarchive.h"
30 /* FIXME: Stop using this non-standard feature */
31 #ifndef FNM_LEADING_DIR
32 #define FNM_LEADING_DIR 0
36 #define block_buf bb_common_bufsiz1
39 #if !ENABLE_FEATURE_TAR_GZIP && !ENABLE_FEATURE_TAR_BZIP2
40 /* Do not pass gzip flag to writeTarFile() */
41 #define writeTarFile(tar_fd, verboseFlag, dereferenceFlag, include, exclude, gzip) \
42 writeTarFile(tar_fd, verboseFlag, dereferenceFlag, include, exclude)
46 #if ENABLE_FEATURE_TAR_CREATE
48 /* Tar file constants */
50 #define TAR_BLOCK_SIZE 512
52 /* POSIX tar Header Block, from POSIX 1003.1-1990 */
54 #define NAME_SIZE_STR "100"
55 typedef struct TarHeader TarHeader;
56 struct TarHeader { /* byte offset */
57 char name[NAME_SIZE]; /* 0-99 */
58 char mode[8]; /* 100-107 */
59 char uid[8]; /* 108-115 */
60 char gid[8]; /* 116-123 */
61 char size[12]; /* 124-135 */
62 char mtime[12]; /* 136-147 */
63 char chksum[8]; /* 148-155 */
64 char typeflag; /* 156-156 */
65 char linkname[NAME_SIZE]; /* 157-256 */
66 /* POSIX: "ustar" NUL "00" */
67 /* GNU tar: "ustar " NUL */
68 /* Normally it's defined as magic[6] followed by
69 * version[2], but we put them together to save code.
71 char magic[8]; /* 257-264 */
72 char uname[32]; /* 265-296 */
73 char gname[32]; /* 297-328 */
74 char devmajor[8]; /* 329-336 */
75 char devminor[8]; /* 337-344 */
76 char prefix[155]; /* 345-499 */
77 char padding[12]; /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */
81 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
82 ** the only functions that deal with the HardLinkInfo structure.
83 ** Even these functions use the xxxHardLinkInfo() functions.
85 typedef struct HardLinkInfo HardLinkInfo;
87 HardLinkInfo *next; /* Next entry in list */
88 dev_t dev; /* Device number */
89 ino_t ino; /* Inode number */
90 short linkCount; /* (Hard) Link Count */
91 char name[1]; /* Start of filename (must be last) */
94 /* Some info to be carried along when creating a new tarball */
95 typedef struct TarBallInfo TarBallInfo;
97 int tarFd; /* Open-for-write file descriptor
99 struct stat statBuf; /* Stat info for the tarball, letting
100 us know the inode and device that the
101 tarball lives, so we can avoid trying
102 to include the tarball into itself */
103 int verboseFlag; /* Whether to print extra stuff or not */
104 const llist_t *excludeList; /* List of files to not include */
105 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
106 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
109 /* A nice enum with all the possible tar file content types */
111 REGTYPE = '0', /* regular file */
112 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
113 LNKTYPE = '1', /* hard link */
114 SYMTYPE = '2', /* symbolic link */
115 CHRTYPE = '3', /* character special */
116 BLKTYPE = '4', /* block special */
117 DIRTYPE = '5', /* directory */
118 FIFOTYPE = '6', /* FIFO special */
119 CONTTYPE = '7', /* reserved */
120 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
121 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
123 typedef enum TarFileType TarFileType;
125 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
126 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
127 struct stat *statbuf,
128 const char *fileName)
130 /* Note: hlInfoHeadPtr can never be NULL! */
131 HardLinkInfo *hlInfo;
133 hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
134 hlInfo->next = *hlInfoHeadPtr;
135 *hlInfoHeadPtr = hlInfo;
136 hlInfo->dev = statbuf->st_dev;
137 hlInfo->ino = statbuf->st_ino;
138 hlInfo->linkCount = statbuf->st_nlink;
139 strcpy(hlInfo->name, fileName);
142 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
144 HardLinkInfo *hlInfo;
145 HardLinkInfo *hlInfoNext;
148 hlInfo = *hlInfoHeadPtr;
150 hlInfoNext = hlInfo->next;
154 *hlInfoHeadPtr = NULL;
158 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
159 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
162 if ((statbuf->st_ino == hlInfo->ino) && (statbuf->st_dev == hlInfo->dev))
164 hlInfo = hlInfo->next;
169 /* Put an octal string into the specified buffer.
170 * The number is zero padded and possibly null terminated.
171 * Stores low-order bits only if whole value does not fit. */
172 static void putOctal(char *cp, int len, off_t value)
174 char tempBuffer[sizeof(off_t)*3+1];
175 char *tempString = tempBuffer;
178 width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
179 tempString += (width - len);
181 /* If string has leading zeroes, we can drop one */
182 /* and field will have trailing '\0' */
183 /* (increases chances of compat with other tars) */
184 if (tempString[0] == '0')
187 /* Copy the string to the field */
188 memcpy(cp, tempString, len);
190 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
192 static void chksum_and_xwrite(int fd, struct TarHeader* hp)
194 /* POSIX says that checksum is done on unsigned bytes
195 * (Sun and HP-UX gets it wrong... more details in
197 const unsigned char *cp;
200 strcpy(hp->magic, "ustar ");
202 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
203 * the header). The checksum field must be filled with blanks for the
204 * calculation. The checksum field is formatted differently from the
205 * other fields: it has 6 digits, a null, then a space -- rather than
206 * digits, followed by a null like the other fields... */
207 memset(hp->chksum, ' ', sizeof(hp->chksum));
208 cp = (const unsigned char *) hp;
211 do { chksum += *cp++; } while (--size);
212 putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
214 /* Now write the header out to disk */
215 xwrite(fd, hp, sizeof(*hp));
218 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
219 static void writeLongname(int fd, int type, const char *name, int dir)
221 static const struct {
222 char mode[8]; /* 100-107 */
223 char uid[8]; /* 108-115 */
224 char gid[8]; /* 116-123 */
225 char size[12]; /* 124-135 */
226 char mtime[12]; /* 136-147 */
234 struct TarHeader header;
237 dir = !!dir; /* normalize: 0/1 */
238 size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
239 /* + dir: account for possible '/' */
241 memset(&header, 0, sizeof(header));
242 strcpy(header.name, "././@LongLink");
243 memcpy(header.mode, prefilled.mode, sizeof(prefilled));
244 PUT_OCTAL(header.size, size);
245 header.typeflag = type;
246 chksum_and_xwrite(fd, &header);
248 /* Write filename[/] and pad the block. */
249 /* dir=0: writes 'name<NUL>', pads */
250 /* dir=1: writes 'name', writes '/<NUL>', pads */
252 xwrite(fd, name, size - dir);
253 xwrite(fd, "/", dir);
254 size = (-size) & (TAR_BLOCK_SIZE-1);
255 memset(&header, 0, size);
256 xwrite(fd, &header, size);
260 /* Write out a tar header for the specified file/directory/whatever */
261 void BUG_tar_header_size(void);
262 static int writeTarHeader(struct TarBallInfo *tbInfo,
263 const char *header_name, const char *fileName, struct stat *statbuf)
265 struct TarHeader header;
267 if (sizeof(header) != 512)
268 BUG_tar_header_size();
270 memset(&header, 0, sizeof(struct TarHeader));
272 strncpy(header.name, header_name, sizeof(header.name));
274 /* POSIX says to mask mode with 07777. */
275 PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
276 PUT_OCTAL(header.uid, statbuf->st_uid);
277 PUT_OCTAL(header.gid, statbuf->st_gid);
278 memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
279 PUT_OCTAL(header.mtime, statbuf->st_mtime);
281 /* Enter the user and group names */
282 safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
283 safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
285 if (tbInfo->hlInfo) {
286 /* This is a hard link */
287 header.typeflag = LNKTYPE;
288 strncpy(header.linkname, tbInfo->hlInfo->name,
289 sizeof(header.linkname));
290 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
291 /* Write out long linkname if needed */
292 if (header.linkname[sizeof(header.linkname)-1])
293 writeLongname(tbInfo->tarFd, GNULONGLINK,
294 tbInfo->hlInfo->name, 0);
296 } else if (S_ISLNK(statbuf->st_mode)) {
297 char *lpath = xmalloc_readlink_or_warn(fileName);
300 header.typeflag = SYMTYPE;
301 strncpy(header.linkname, lpath, sizeof(header.linkname));
302 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
303 /* Write out long linkname if needed */
304 if (header.linkname[sizeof(header.linkname)-1])
305 writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
307 /* If it is larger than 100 bytes, bail out */
308 if (header.linkname[sizeof(header.linkname)-1]) {
310 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
315 } else if (S_ISDIR(statbuf->st_mode)) {
316 header.typeflag = DIRTYPE;
317 /* Append '/' only if there is a space for it */
318 if (!header.name[sizeof(header.name)-1])
319 header.name[strlen(header.name)] = '/';
320 } else if (S_ISCHR(statbuf->st_mode)) {
321 header.typeflag = CHRTYPE;
322 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
323 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
324 } else if (S_ISBLK(statbuf->st_mode)) {
325 header.typeflag = BLKTYPE;
326 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
327 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
328 } else if (S_ISFIFO(statbuf->st_mode)) {
329 header.typeflag = FIFOTYPE;
330 } else if (S_ISREG(statbuf->st_mode)) {
331 if (sizeof(statbuf->st_size) > 4
332 && statbuf->st_size > (off_t)0777777777777LL
334 bb_error_msg_and_die("cannot store file '%s' "
335 "of size %"OFF_FMT"d, aborting",
336 fileName, statbuf->st_size);
338 header.typeflag = REGTYPE;
339 PUT_OCTAL(header.size, statbuf->st_size);
341 bb_error_msg("%s: unknown file type", fileName);
345 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
346 /* Write out long name if needed */
347 /* (we, like GNU tar, output long linkname *before* long name) */
348 if (header.name[sizeof(header.name)-1])
349 writeLongname(tbInfo->tarFd, GNULONGNAME,
350 header_name, S_ISDIR(statbuf->st_mode));
353 /* Now write the header out to disk */
354 chksum_and_xwrite(tbInfo->tarFd, &header);
356 /* Now do the verbose thing (or not) */
357 if (tbInfo->verboseFlag) {
360 if (tbInfo->tarFd == STDOUT_FILENO) /* If the archive goes to stdout, verbose to stderr */
362 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
363 /* We don't have such excesses here: for us "v" == "vv" */
364 /* '/' is probably a GNUism */
365 fprintf(vbFd, "%s%s\n", header_name,
366 S_ISDIR(statbuf->st_mode) ? "/" : "");
372 #if ENABLE_FEATURE_TAR_FROM
373 static int exclude_file(const llist_t *excluded_files, const char *file)
375 while (excluded_files) {
376 if (excluded_files->data[0] == '/') {
377 if (fnmatch(excluded_files->data, file,
378 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
383 for (p = file; p[0] != '\0'; p++) {
384 if ((p == file || p[-1] == '/') && p[0] != '/' &&
385 fnmatch(excluded_files->data, p,
386 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
390 excluded_files = excluded_files->link;
396 #define exclude_file(excluded_files, file) 0
399 static int writeFileToTarball(const char *fileName, struct stat *statbuf,
400 void *userData, int depth ATTRIBUTE_UNUSED)
402 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
403 const char *header_name;
404 int inputFileFd = -1;
406 /* Strip leading '/' (must be before memorizing hardlink's name) */
407 header_name = fileName;
408 while (header_name[0] == '/') {
409 static smallint warned;
412 bb_error_msg("removing leading '/' from member names");
418 if (header_name[0] == '\0')
421 /* It is against the rules to archive a socket */
422 if (S_ISSOCK(statbuf->st_mode)) {
423 bb_error_msg("%s: socket ignored", fileName);
428 * Check to see if we are dealing with a hard link.
430 * Treat the first occurance of a given dev/inode as a file while
431 * treating any additional occurances as hard links. This is done
432 * by adding the file information to the HardLinkInfo linked list.
434 tbInfo->hlInfo = NULL;
435 if (statbuf->st_nlink > 1) {
436 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
437 if (tbInfo->hlInfo == NULL)
438 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
441 /* It is a bad idea to store the archive we are in the process of creating,
442 * so check the device and inode to be sure that this particular file isn't
444 if (tbInfo->statBuf.st_dev == statbuf->st_dev
445 && tbInfo->statBuf.st_ino == statbuf->st_ino
447 bb_error_msg("%s: file is the archive; skipping", fileName);
451 if (exclude_file(tbInfo->excludeList, header_name))
454 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
455 if (strlen(header_name) >= NAME_SIZE) {
456 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
461 /* Is this a regular file? */
462 if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
463 /* open the file we want to archive, and make sure all is well */
464 inputFileFd = open_or_warn(fileName, O_RDONLY);
465 if (inputFileFd < 0) {
470 /* Add an entry to the tarball */
471 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
475 /* If it was a regular file, write out the body */
476 if (inputFileFd >= 0) {
478 /* Write the file to the archive. */
479 /* We record size into header first, */
480 /* and then write out file. If file shrinks in between, */
481 /* tar will be corrupted. So we don't allow for that. */
482 /* NB: GNU tar 1.16 warns and pads with zeroes */
483 /* or even seeks back and updates header */
484 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
486 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
487 ////if (readSize != statbuf->st_size && readSize >= 0) {
488 //// bb_error_msg_and_die("short read from %s, aborting", fileName);
491 /* Check that file did not grow in between? */
492 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
496 /* Pad the file up to the tar block size */
497 /* (a few tricks here in the name of code size) */
498 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
499 memset(block_buf, 0, readSize);
500 xwrite(tbInfo->tarFd, block_buf, readSize);
506 static int writeTarFile(const int tar_fd, const int verboseFlag,
507 const unsigned long dereferenceFlag, const llist_t *include,
508 const llist_t *exclude, const int gzip)
511 int errorFlag = FALSE;
512 struct TarBallInfo tbInfo;
514 tbInfo.hlInfoHead = NULL;
516 fchmod(tar_fd, 0644);
517 tbInfo.tarFd = tar_fd;
518 tbInfo.verboseFlag = verboseFlag;
520 /* Store the stat info for the tarball's file, so
521 * can avoid including the tarball into itself.... */
522 if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
523 bb_perror_msg_and_die("cannot stat tar file");
525 #if ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2
527 #if ENABLE_FEATURE_TAR_GZIP && ENABLE_FEATURE_TAR_BZIP2
528 const char *zip_exec = (gzip == 1) ? "gzip" : "bzip2";
529 #elif ENABLE_FEATURE_TAR_GZIP
530 const char *zip_exec = "gzip";
531 #else /* only ENABLE_FEATURE_TAR_BZIP2 */
532 const char *zip_exec = "bzip2";
534 // On Linux, vfork never unpauses parent early, although standard
535 // allows for that. Do we want to waste bytes checking for it?
536 #define WAIT_FOR_CHILD 0
537 volatile int vfork_exec_errno = 0;
539 struct fd_pair gzipStatusPipe;
541 struct fd_pair gzipDataPipe;
542 xpiped_pair(gzipDataPipe);
544 xpiped_pair(gzipStatusPipe);
547 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
549 #if defined(__GNUC__) && __GNUC__
550 /* Avoid vfork clobbering */
558 bb_perror_msg_and_die("vfork gzip");
562 /* NB: close _first_, then move fds! */
563 close(gzipDataPipe.wr);
565 close(gzipStatusPipe.rd);
566 /* gzipStatusPipe.wr will close only on exec -
567 * parent waits for this close to happen */
568 fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
570 xmove_fd(gzipDataPipe.rd, 0);
571 xmove_fd(tbInfo.tarFd, 1);
572 /* exec gzip/bzip2 program/applet */
573 BB_EXECLP(zip_exec, zip_exec, "-f", NULL);
574 vfork_exec_errno = errno;
579 xmove_fd(gzipDataPipe.wr, tbInfo.tarFd);
580 close(gzipDataPipe.rd);
582 close(gzipStatusPipe.wr);
587 /* Wait until child execs (or fails to) */
588 n = full_read(gzipStatusPipe.rd, &buf, 1);
589 if (n < 0 /* && errno == EAGAIN */)
590 continue; /* try it again */
593 close(gzipStatusPipe.rd);
595 if (vfork_exec_errno) {
596 errno = vfork_exec_errno;
597 bb_perror_msg_and_die("cannot exec %s", zip_exec);
602 tbInfo.excludeList = exclude;
604 /* Read the directory/files and iterate over them one at a time */
606 if (!recursive_action(include->data, ACTION_RECURSE |
607 (dereferenceFlag ? ACTION_FOLLOWLINKS : 0),
608 writeFileToTarball, writeFileToTarball, &tbInfo, 0))
612 include = include->link;
614 /* Write two empty blocks to the end of the archive */
615 memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
616 xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
618 /* To be pedantically correct, we would check if the tarball
619 * is smaller than 20 tar blocks, and pad it if it was smaller,
620 * but that isn't necessary for GNU tar interoperability, and
621 * so is considered a waste of space */
623 /* Close so the child process (if any) will exit */
626 /* Hang up the tools, close up shop, head home */
627 if (ENABLE_FEATURE_CLEAN_UP)
628 freeHardLinkInfo(&tbInfo.hlInfoHead);
631 bb_error_msg("error exit delayed from previous errors");
635 if (safe_waitpid(gzipPid, &status, 0) == -1)
636 bb_perror_msg("waitpid");
637 else if (!WIFEXITED(status) || WEXITSTATUS(status))
638 /* gzip was killed or has exited with nonzero! */
644 int writeTarFile(const int tar_fd, const int verboseFlag,
645 const unsigned long dereferenceFlag, const llist_t *include,
646 const llist_t *exclude, const int gzip);
647 #endif /* FEATURE_TAR_CREATE */
649 #if ENABLE_FEATURE_TAR_FROM
650 static llist_t *append_file_list_to_list(llist_t *list)
656 llist_t *newlist = NULL;
659 src_stream = xfopen(cur->data, "r");
663 while ((line = xmalloc_fgetline(src_stream)) != NULL) {
664 /* kill trailing '/' unless the string is just "/" */
665 char *cp = last_char_is(line, '/');
668 llist_add_to(&newlist, line);
675 #define append_file_list_to_list(x) 0
678 #if ENABLE_FEATURE_TAR_COMPRESS
679 static char get_header_tar_Z(archive_handle_t *archive_handle)
681 /* Can't lseek over pipes */
682 archive_handle->seek = seek_by_read;
684 /* do the decompression, and cleanup */
685 if (xread_char(archive_handle->src_fd) != 0x1f
686 || xread_char(archive_handle->src_fd) != 0x9d
688 bb_error_msg_and_die("invalid magic");
691 archive_handle->src_fd = open_transformer(archive_handle->src_fd, uncompress, "uncompress");
692 archive_handle->offset = 0;
693 while (get_header_tar(archive_handle) == EXIT_SUCCESS)
696 /* Can only do one file at a time */
700 #define get_header_tar_Z NULL
703 #ifdef CHECK_FOR_CHILD_EXITCODE
704 /* Looks like it isn't needed - tar detects malformed (truncated)
705 * archive if e.g. bunzip2 fails */
706 static int child_error;
708 static void handle_SIGCHLD(int status)
710 /* Actually, 'status' is a signo. We reuse it for other needs */
712 /* Wait for any child without blocking */
713 if (wait_any_nohang(&status) < 0)
714 /* wait failed?! I'm confused... */
717 if (WIFEXITED(status) && WEXITSTATUS(status)==0)
718 /* child exited with 0 */
721 if (!WIFSIGNALED(status) && !WIFEXITED(status)) return; */
728 USE_FEATURE_TAR_CREATE( OPTBIT_CREATE ,)
729 USE_FEATURE_TAR_CREATE( OPTBIT_DEREFERENCE ,)
730 USE_FEATURE_TAR_BZIP2( OPTBIT_BZIP2 ,)
731 USE_FEATURE_TAR_LZMA( OPTBIT_LZMA ,)
732 USE_FEATURE_TAR_FROM( OPTBIT_INCLUDE_FROM,)
733 USE_FEATURE_TAR_FROM( OPTBIT_EXCLUDE_FROM,)
734 USE_FEATURE_TAR_GZIP( OPTBIT_GZIP ,)
735 USE_FEATURE_TAR_COMPRESS(OPTBIT_COMPRESS ,)
736 OPTBIT_NOPRESERVE_OWN,
737 OPTBIT_NOPRESERVE_PERM,
738 OPT_TEST = 1 << 0, // t
739 OPT_EXTRACT = 1 << 1, // x
740 OPT_BASEDIR = 1 << 2, // C
741 OPT_TARNAME = 1 << 3, // f
742 OPT_2STDOUT = 1 << 4, // O
744 OPT_VERBOSE = 1 << 6, // v
745 OPT_KEEP_OLD = 1 << 7, // k
746 OPT_CREATE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_CREATE )) + 0, // c
747 OPT_DEREFERENCE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_DEREFERENCE )) + 0, // h
748 OPT_BZIP2 = USE_FEATURE_TAR_BZIP2( (1<<OPTBIT_BZIP2 )) + 0, // j
749 OPT_LZMA = USE_FEATURE_TAR_LZMA( (1<<OPTBIT_LZMA )) + 0, // a
750 OPT_INCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_INCLUDE_FROM)) + 0, // T
751 OPT_EXCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_EXCLUDE_FROM)) + 0, // X
752 OPT_GZIP = USE_FEATURE_TAR_GZIP( (1<<OPTBIT_GZIP )) + 0, // z
753 OPT_COMPRESS = USE_FEATURE_TAR_COMPRESS((1<<OPTBIT_COMPRESS )) + 0, // Z
754 OPT_NOPRESERVE_OWN = 1 << OPTBIT_NOPRESERVE_OWN , // no-same-owner
755 OPT_NOPRESERVE_PERM = 1 << OPTBIT_NOPRESERVE_PERM, // no-same-permissions
757 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
758 static const char tar_longopts[] ALIGN1 =
759 "list\0" No_argument "t"
760 "extract\0" No_argument "x"
761 "directory\0" Required_argument "C"
762 "file\0" Required_argument "f"
763 "to-stdout\0" No_argument "O"
764 "same-permissions\0" No_argument "p"
765 "verbose\0" No_argument "v"
766 "keep-old\0" No_argument "k"
767 # if ENABLE_FEATURE_TAR_CREATE
768 "create\0" No_argument "c"
769 "dereference\0" No_argument "h"
771 # if ENABLE_FEATURE_TAR_BZIP2
772 "bzip2\0" No_argument "j"
774 # if ENABLE_FEATURE_TAR_LZMA
775 "lzma\0" No_argument "a"
777 # if ENABLE_FEATURE_TAR_FROM
778 "files-from\0" Required_argument "T"
779 "exclude-from\0" Required_argument "X"
781 # if ENABLE_FEATURE_TAR_GZIP
782 "gzip\0" No_argument "z"
784 # if ENABLE_FEATURE_TAR_COMPRESS
785 "compress\0" No_argument "Z"
787 "no-same-owner\0" No_argument "\xfd"
788 "no-same-permissions\0" No_argument "\xfe"
789 /* --exclude takes next bit position in option mask, */
790 /* therefore we have to either put it _after_ --no-same-perm */
791 /* or add OPT[BIT]_EXCLUDE before OPT[BIT]_NOPRESERVE_OWN */
792 # if ENABLE_FEATURE_TAR_FROM
793 "exclude\0" Required_argument "\xff"
798 int tar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
799 int tar_main(int argc, char **argv)
801 char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
802 archive_handle_t *tar_handle;
803 char *base_dir = NULL;
804 const char *tar_filename = "-";
807 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
808 llist_t *excludes = NULL;
811 /* Initialise default values */
812 tar_handle = init_handle();
813 tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS
814 | ARCHIVE_PRESERVE_DATE
815 | ARCHIVE_EXTRACT_UNCONDITIONAL;
817 /* Prepend '-' to the first argument if required */
818 opt_complementary = "--:" // first arg is options
819 "tt:vv:" // count -t,-v
820 "?:" // bail out with usage instead of error return
821 "X::T::" // cumulative lists
822 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
823 "\xff::" // cumulative lists for --exclude
825 USE_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
826 USE_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
827 SKIP_FEATURE_TAR_CREATE("t--x:x--t"); // mutually exclusive
828 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
829 applet_long_options = tar_longopts;
833 USE_FEATURE_TAR_CREATE( "ch" )
834 USE_FEATURE_TAR_BZIP2( "j" )
835 USE_FEATURE_TAR_LZMA( "a" )
836 USE_FEATURE_TAR_FROM( "T:X:")
837 USE_FEATURE_TAR_GZIP( "z" )
838 USE_FEATURE_TAR_COMPRESS("Z" )
839 , &base_dir // -C dir
840 , &tar_filename // -f filename
841 USE_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
842 USE_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
843 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
844 , &excludes // --exclude
846 , &verboseFlag // combined count for -t and -v
847 , &verboseFlag // combined count for -t and -v
850 if (verboseFlag) tar_handle->action_header = header_verbose_list;
851 if (verboseFlag == 1) tar_handle->action_header = header_list;
853 if (opt & OPT_EXTRACT)
854 tar_handle->action_data = data_extract_all;
856 if (opt & OPT_2STDOUT)
857 tar_handle->action_data = data_extract_to_stdout;
859 if (opt & OPT_KEEP_OLD)
860 tar_handle->flags &= ~ARCHIVE_EXTRACT_UNCONDITIONAL;
862 if (opt & OPT_NOPRESERVE_OWN)
863 tar_handle->flags |= ARCHIVE_NOPRESERVE_OWN;
865 if (opt & OPT_NOPRESERVE_PERM)
866 tar_handle->flags |= ARCHIVE_NOPRESERVE_PERM;
869 get_header_ptr = get_header_tar_gz;
872 get_header_ptr = get_header_tar_bz2;
875 get_header_ptr = get_header_tar_lzma;
877 if (opt & OPT_COMPRESS)
878 get_header_ptr = get_header_tar_Z;
880 #if ENABLE_FEATURE_TAR_FROM
881 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
882 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
883 /* Append excludes to reject */
885 llist_t *next = excludes->link;
886 excludes->link = tar_handle->reject;
887 tar_handle->reject = excludes;
891 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
894 /* Check if we are reading from stdin */
895 if (argv[optind] && *argv[optind] == '-') {
896 /* Default is to read from stdin, so just skip to next arg */
900 /* Setup an array of filenames to work with */
901 /* TODO: This is the same as in ar, separate function ? */
902 while (optind < argc) {
903 /* kill trailing '/' unless the string is just "/" */
904 char *cp = last_char_is(argv[optind], '/');
905 if (cp > argv[optind])
907 llist_add_to_end(&tar_handle->accept, argv[optind]);
911 if (tar_handle->accept || tar_handle->reject)
912 tar_handle->filter = filter_accept_reject_list;
914 /* Open the tar file */
919 if (opt & OPT_CREATE) {
920 /* Make sure there is at least one file to tar up. */
921 if (tar_handle->accept == NULL)
922 bb_error_msg_and_die("empty archive");
925 /* Mimicking GNU tar 1.15.1: */
926 flags = O_WRONLY|O_CREAT|O_TRUNC;
927 /* was doing unlink; open(O_WRONLY|O_CREAT|O_EXCL); why? */
933 if (LONE_DASH(tar_filename)) {
934 tar_handle->src_fd = fileno(tar_stream);
935 tar_handle->seek = seek_by_read;
937 tar_handle->src_fd = xopen(tar_filename, flags);
944 #ifdef CHECK_FOR_CHILD_EXITCODE
945 /* We need to know whether child (gzip/bzip/etc) exits abnormally */
946 signal(SIGCHLD, handle_SIGCHLD);
949 /* create an archive */
950 if (opt & OPT_CREATE) {
951 #if ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2
953 if (ENABLE_FEATURE_TAR_GZIP && (opt & OPT_GZIP))
955 if (ENABLE_FEATURE_TAR_BZIP2 && (opt & OPT_BZIP2))
958 /* NB: writeTarFile() closes tar_handle->src_fd */
959 return writeTarFile(tar_handle->src_fd, verboseFlag, opt & OPT_DEREFERENCE,
961 tar_handle->reject, zipMode);
964 while (get_header_ptr(tar_handle) == EXIT_SUCCESS)
967 /* Check that every file that should have been extracted was */
968 while (tar_handle->accept) {
969 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
970 && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
972 bb_error_msg_and_die("%s: not found in archive",
973 tar_handle->accept->data);
975 tar_handle->accept = tar_handle->accept->link;
977 if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
978 close(tar_handle->src_fd);