e0d4daff7d93324729317c4373a43c00ab10c13a
[people/mcb30/busybox.git] / archival / tar.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Mini tar implementation for busybox
4  *
5  * Modified to use common extraction code used by ar, cpio, dpkg-deb, dpkg
6  *  Glenn McGrath <bug1@iinet.net.au>
7  *
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.)
11  *
12  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
13  *
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.
19  *
20  * Based in part on the tar implementation from busybox-0.28
21  *  Copyright (C) 1995 Bruce Perens
22  *
23  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
24  */
25
26 #include <fnmatch.h>
27 #include <getopt.h>
28 #include "libbb.h"
29 #include "unarchive.h"
30
31 #define block_buf bb_common_bufsiz1
32
33 #if ENABLE_FEATURE_TAR_CREATE
34
35 /* Tar file constants  */
36
37 #define TAR_BLOCK_SIZE          512
38
39 /* POSIX tar Header Block, from POSIX 1003.1-1990  */
40 #define NAME_SIZE      100
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         char magic[6];            /* 257-262 */
54         char version[2];          /* 263-264 */
55         char uname[32];           /* 265-296 */
56         char gname[32];           /* 297-328 */
57         char devmajor[8];         /* 329-336 */
58         char devminor[8];         /* 337-344 */
59         char prefix[155];         /* 345-499 */
60         char padding[12];         /* 500-512 (pad to exactly the TAR_BLOCK_SIZE) */
61 };
62
63 /*
64 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
65 ** the only functions that deal with the HardLinkInfo structure.
66 ** Even these functions use the xxxHardLinkInfo() functions.
67 */
68 typedef struct HardLinkInfo HardLinkInfo;
69 struct HardLinkInfo {
70         HardLinkInfo *next;     /* Next entry in list */
71         dev_t dev;                      /* Device number */
72         ino_t ino;                      /* Inode number */
73         short linkCount;        /* (Hard) Link Count */
74         char name[1];           /* Start of filename (must be last) */
75 };
76
77 /* Some info to be carried along when creating a new tarball */
78 typedef struct TarBallInfo TarBallInfo;
79 struct TarBallInfo {
80         int tarFd;                              /* Open-for-write file descriptor
81                                                            for the tarball */
82         struct stat statBuf;    /* Stat info for the tarball, letting
83                                                            us know the inode and device that the
84                                                            tarball lives, so we can avoid trying
85                                                            to include the tarball into itself */
86         int verboseFlag;                /* Whether to print extra stuff or not */
87         const llist_t *excludeList;     /* List of files to not include */
88         HardLinkInfo *hlInfoHead;       /* Hard Link Tracking Information */
89         HardLinkInfo *hlInfo;   /* Hard Link Info for the current file */
90 };
91
92 /* A nice enum with all the possible tar file content types */
93 enum TarFileType {
94         REGTYPE = '0',          /* regular file */
95         REGTYPE0 = '\0',        /* regular file (ancient bug compat) */
96         LNKTYPE = '1',          /* hard link */
97         SYMTYPE = '2',          /* symbolic link */
98         CHRTYPE = '3',          /* character special */
99         BLKTYPE = '4',          /* block special */
100         DIRTYPE = '5',          /* directory */
101         FIFOTYPE = '6',         /* FIFO special */
102         CONTTYPE = '7',         /* reserved */
103         GNULONGLINK = 'K',      /* GNU long (>100 chars) link name */
104         GNULONGNAME = 'L',      /* GNU long (>100 chars) file name */
105 };
106 typedef enum TarFileType TarFileType;
107
108 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
109 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
110                                         struct stat *statbuf,
111                                         const char *fileName)
112 {
113         /* Note: hlInfoHeadPtr can never be NULL! */
114         HardLinkInfo *hlInfo;
115
116         hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
117         hlInfo->next = *hlInfoHeadPtr;
118         *hlInfoHeadPtr = hlInfo;
119         hlInfo->dev = statbuf->st_dev;
120         hlInfo->ino = statbuf->st_ino;
121         hlInfo->linkCount = statbuf->st_nlink;
122         strcpy(hlInfo->name, fileName);
123 }
124
125 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
126 {
127         HardLinkInfo *hlInfo;
128         HardLinkInfo *hlInfoNext;
129
130         if (hlInfoHeadPtr) {
131                 hlInfo = *hlInfoHeadPtr;
132                 while (hlInfo) {
133                         hlInfoNext = hlInfo->next;
134                         free(hlInfo);
135                         hlInfo = hlInfoNext;
136                 }
137                 *hlInfoHeadPtr = NULL;
138         }
139 }
140
141 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
142 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
143 {
144         while (hlInfo) {
145                 if ((statbuf->st_ino == hlInfo->ino) && (statbuf->st_dev == hlInfo->dev))
146                         break;
147                 hlInfo = hlInfo->next;
148         }
149         return hlInfo;
150 }
151
152 /* Put an octal string into the specified buffer.
153  * The number is zero padded and possibly null terminated.
154  * Stores low-order bits only if whole value does not fit. */
155 static void putOctal(char *cp, int len, off_t value)
156 {
157         char tempBuffer[sizeof(off_t)*3+1];
158         char *tempString = tempBuffer;
159         int width;
160
161         width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
162         tempString += (width - len);
163
164         /* If string has leading zeroes, we can drop one */
165         /* and field will have trailing '\0' */
166         /* (increases chances of compat with other tars) */
167         if (tempString[0] == '0')
168                 tempString++;
169
170         /* Copy the string to the field */
171         memcpy(cp, tempString, len);
172 }
173 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
174
175 static void chksum_and_xwrite(int fd, struct TarHeader* hp)
176 {
177         /* POSIX says that checksum is done on unsigned bytes
178          * (Sun and HP-UX gets it wrong... more details in
179          * GNU tar source) */
180         const unsigned char *cp;
181         int chksum, size;
182
183         strcpy(hp->magic, "ustar  ");
184
185         /* Calculate and store the checksum (i.e., the sum of all of the bytes of
186          * the header).  The checksum field must be filled with blanks for the
187          * calculation.  The checksum field is formatted differently from the
188          * other fields: it has 6 digits, a null, then a space -- rather than
189          * digits, followed by a null like the other fields... */
190         memset(hp->chksum, ' ', sizeof(hp->chksum));
191         cp = (const unsigned char *) hp;
192         chksum = 0;
193         size = sizeof(*hp);
194         do { chksum += *cp++; } while (--size);
195         putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
196
197         /* Now write the header out to disk */
198         xwrite(fd, hp, sizeof(*hp));
199 }
200
201 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
202 static void writeLongname(int fd, int type, const char *name, int dir)
203 {
204         static const struct {
205                 char mode[8];             /* 100-107 */
206                 char uid[8];              /* 108-115 */
207                 char gid[8];              /* 116-123 */
208                 char size[12];            /* 124-135 */
209                 char mtime[12];           /* 136-147 */
210         } prefilled = {
211                 "0000000",
212                 "0000000",
213                 "0000000",
214                 "00000000000",
215                 "00000000000",
216         };
217         struct TarHeader header;
218         int size;
219
220         dir = !!dir; /* normalize: 0/1 */
221         size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
222         /* + dir: account for possible '/' */
223
224         memset(&header, 0, sizeof(header));
225         strcpy(header.name, "././@LongLink");
226         memcpy(header.mode, prefilled.mode, sizeof(prefilled));
227         PUT_OCTAL(header.size, size);
228         header.typeflag = type;
229         chksum_and_xwrite(fd, &header);
230
231         /* Write filename[/] and pad the block. */
232         /* dir=0: writes 'name<NUL>', pads */
233         /* dir=1: writes 'name', writes '/<NUL>', pads */
234         dir *= 2;
235         xwrite(fd, name, size - dir);
236         xwrite(fd, "/", dir);
237         size = (-size) & (TAR_BLOCK_SIZE-1);
238         memset(&header, 0, size);
239         xwrite(fd, &header, size);
240 }
241 #endif
242
243 /* Write out a tar header for the specified file/directory/whatever */
244 void BUG_tar_header_size(void);
245 static int writeTarHeader(struct TarBallInfo *tbInfo,
246                 const char *header_name, const char *fileName, struct stat *statbuf)
247 {
248         struct TarHeader header;
249
250         if (sizeof(header) != 512)
251                 BUG_tar_header_size();
252
253         memset(&header, 0, sizeof(struct TarHeader));
254
255         strncpy(header.name, header_name, sizeof(header.name));
256
257         /* POSIX says to mask mode with 07777. */
258         PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
259         PUT_OCTAL(header.uid, statbuf->st_uid);
260         PUT_OCTAL(header.gid, statbuf->st_gid);
261         memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
262         PUT_OCTAL(header.mtime, statbuf->st_mtime);
263
264         /* Enter the user and group names */
265         safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
266         safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
267
268         if (tbInfo->hlInfo) {
269                 /* This is a hard link */
270                 header.typeflag = LNKTYPE;
271                 strncpy(header.linkname, tbInfo->hlInfo->name,
272                                 sizeof(header.linkname));
273 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
274                 /* Write out long linkname if needed */
275                 if (header.linkname[sizeof(header.linkname)-1])
276                         writeLongname(tbInfo->tarFd, GNULONGLINK,
277                                         tbInfo->hlInfo->name, 0);
278 #endif
279         } else if (S_ISLNK(statbuf->st_mode)) {
280                 char *lpath = xmalloc_readlink_or_warn(fileName);
281                 if (!lpath)
282                         return FALSE;
283                 header.typeflag = SYMTYPE;
284                 strncpy(header.linkname, lpath, sizeof(header.linkname));
285 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
286                 /* Write out long linkname if needed */
287                 if (header.linkname[sizeof(header.linkname)-1])
288                         writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
289 #else
290                 /* If it is larger than 100 bytes, bail out */
291                 if (header.linkname[sizeof(header.linkname)-1]) {
292                         free(lpath);
293                         bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
294                         return FALSE;
295                 }
296 #endif
297                 free(lpath);
298         } else if (S_ISDIR(statbuf->st_mode)) {
299                 header.typeflag = DIRTYPE;
300                 /* Append '/' only if there is a space for it */
301                 if (!header.name[sizeof(header.name)-1])
302                         header.name[strlen(header.name)] = '/';
303         } else if (S_ISCHR(statbuf->st_mode)) {
304                 header.typeflag = CHRTYPE;
305                 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
306                 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
307         } else if (S_ISBLK(statbuf->st_mode)) {
308                 header.typeflag = BLKTYPE;
309                 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
310                 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
311         } else if (S_ISFIFO(statbuf->st_mode)) {
312                 header.typeflag = FIFOTYPE;
313         } else if (S_ISREG(statbuf->st_mode)) {
314                 if (sizeof(statbuf->st_size) > 4
315                  && statbuf->st_size > (off_t)0777777777777LL
316                 ) {
317                         bb_error_msg_and_die("cannot store file '%s' "
318                                 "of size %"OFF_FMT"d, aborting",
319                                 fileName, statbuf->st_size);
320                 }
321                 header.typeflag = REGTYPE;
322                 PUT_OCTAL(header.size, statbuf->st_size);
323         } else {
324                 bb_error_msg("%s: unknown file type", fileName);
325                 return FALSE;
326         }
327
328 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
329         /* Write out long name if needed */
330         /* (we, like GNU tar, output long linkname *before* long name) */
331         if (header.name[sizeof(header.name)-1])
332                 writeLongname(tbInfo->tarFd, GNULONGNAME,
333                                 header_name, S_ISDIR(statbuf->st_mode));
334 #endif
335
336         /* Now write the header out to disk */
337         chksum_and_xwrite(tbInfo->tarFd, &header);
338
339         /* Now do the verbose thing (or not) */
340         if (tbInfo->verboseFlag) {
341                 FILE *vbFd = stdout;
342
343                 if (tbInfo->tarFd == STDOUT_FILENO)     /* If the archive goes to stdout, verbose to stderr */
344                         vbFd = stderr;
345                 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
346                 /* We don't have such excesses here: for us "v" == "vv" */
347                 /* '/' is probably a GNUism */
348                 fprintf(vbFd, "%s%s\n", header_name,
349                                 S_ISDIR(statbuf->st_mode) ? "/" : "");
350         }
351
352         return TRUE;
353 }
354
355 #if ENABLE_FEATURE_TAR_FROM
356 static int exclude_file(const llist_t *excluded_files, const char *file)
357 {
358         while (excluded_files) {
359                 if (excluded_files->data[0] == '/') {
360                         if (fnmatch(excluded_files->data, file,
361                                                 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
362                                 return 1;
363                 } else {
364                         const char *p;
365
366                         for (p = file; p[0] != '\0'; p++) {
367                                 if ((p == file || p[-1] == '/') && p[0] != '/' &&
368                                         fnmatch(excluded_files->data, p,
369                                                         FNM_PATHNAME | FNM_LEADING_DIR) == 0)
370                                         return 1;
371                         }
372                 }
373                 excluded_files = excluded_files->link;
374         }
375
376         return 0;
377 }
378 #else
379 #define exclude_file(excluded_files, file) 0
380 #endif
381
382 static int writeFileToTarball(const char *fileName, struct stat *statbuf,
383                         void *userData, int depth ATTRIBUTE_UNUSED)
384 {
385         struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
386         const char *header_name;
387         int inputFileFd = -1;
388
389         /*
390          * Check to see if we are dealing with a hard link.
391          * If so -
392          * Treat the first occurance of a given dev/inode as a file while
393          * treating any additional occurances as hard links.  This is done
394          * by adding the file information to the HardLinkInfo linked list.
395          */
396         tbInfo->hlInfo = NULL;
397         if (statbuf->st_nlink > 1) {
398                 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
399                 if (tbInfo->hlInfo == NULL)
400                         addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, fileName);
401         }
402
403         /* It is against the rules to archive a socket */
404         if (S_ISSOCK(statbuf->st_mode)) {
405                 bb_error_msg("%s: socket ignored", fileName);
406                 return TRUE;
407         }
408
409         /* It is a bad idea to store the archive we are in the process of creating,
410          * so check the device and inode to be sure that this particular file isn't
411          * the new tarball */
412         if (tbInfo->statBuf.st_dev == statbuf->st_dev &&
413                 tbInfo->statBuf.st_ino == statbuf->st_ino) {
414                 bb_error_msg("%s: file is the archive; skipping", fileName);
415                 return TRUE;
416         }
417
418         header_name = fileName;
419         while (header_name[0] == '/') {
420                 static smallint warned;
421
422                 if (!warned) {
423                         bb_error_msg("removing leading '/' from member names");
424                         warned = 1;
425                 }
426                 header_name++;
427         }
428
429 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
430         if (strlen(fileName) >= NAME_SIZE) {
431                 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
432                 return TRUE;
433         }
434 #endif
435
436         if (header_name[0] == '\0')
437                 return TRUE;
438
439         if (exclude_file(tbInfo->excludeList, header_name))
440                 return SKIP;
441
442         /* Is this a regular file? */
443         if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
444                 /* open the file we want to archive, and make sure all is well */
445                 inputFileFd = open_or_warn(fileName, O_RDONLY);
446                 if (inputFileFd < 0) {
447                         return FALSE;
448                 }
449         }
450
451         /* Add an entry to the tarball */
452         if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
453                 return FALSE;
454         }
455
456         /* If it was a regular file, write out the body */
457         if (inputFileFd >= 0) {
458                 size_t readSize;
459                 /* Write the file to the archive. */
460                 /* We record size into header first, */
461                 /* and then write out file. If file shrinks in between, */
462                 /* tar will be corrupted. So we don't allow for that. */
463                 /* NB: GNU tar 1.16 warns and pads with zeroes */
464                 /* or even seeks back and updates header */
465                 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
466                 ////off_t readSize;
467                 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
468                 ////if (readSize != statbuf->st_size && readSize >= 0) {
469                 ////    bb_error_msg_and_die("short read from %s, aborting", fileName);
470                 ////}
471
472                 /* Check that file did not grow in between? */
473                 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
474
475                 close(inputFileFd);
476
477                 /* Pad the file up to the tar block size */
478                 /* (a few tricks here in the name of code size) */
479                 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
480                 memset(block_buf, 0, readSize);
481                 xwrite(tbInfo->tarFd, block_buf, readSize);
482         }
483
484         return TRUE;
485 }
486
487 static int writeTarFile(const int tar_fd, const int verboseFlag,
488         const unsigned long dereferenceFlag, const llist_t *include,
489         const llist_t *exclude, const int gzip)
490 {
491         pid_t gzipPid = 0;
492         int errorFlag = FALSE;
493         struct TarBallInfo tbInfo;
494
495         tbInfo.hlInfoHead = NULL;
496
497         fchmod(tar_fd, 0644);
498         tbInfo.tarFd = tar_fd;
499         tbInfo.verboseFlag = verboseFlag;
500
501         /* Store the stat info for the tarball's file, so
502          * can avoid including the tarball into itself....  */
503         if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
504                 bb_perror_msg_and_die("cannot stat tar file");
505
506         if ((ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2) && gzip) {
507 // On Linux, vfork never unpauses parent early, although standard
508 // allows for that. Do we want to waste bytes checking for it?
509 #define WAIT_FOR_CHILD 0
510
511                 volatile int vfork_exec_errno = 0;
512 #if WAIT_FOR_CHILD
513                 struct { int rd; int wr; } gzipStatusPipe;
514 #endif
515                 struct { int rd; int wr; } gzipDataPipe;
516                 const char *zip_exec = (gzip == 1) ? "gzip" : "bzip2";
517
518                 xpipe(&gzipDataPipe.rd);
519 #if WAIT_FOR_CHILD
520                 xpipe(&gzipStatusPipe.rd);
521 #endif
522
523                 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
524
525 #if defined(__GNUC__) && __GNUC__
526                 /* Avoid vfork clobbering */
527                 (void) &include;
528                 (void) &errorFlag;
529                 (void) &zip_exec;
530 #endif
531
532                 gzipPid = vfork();
533                 if (gzipPid < 0)
534                         bb_perror_msg_and_die("vfork gzip");
535
536                 if (gzipPid == 0) {
537                         /* child */
538                         xmove_fd(tbInfo.tarFd, 1);
539                         xmove_fd(gzipDataPipe.rd, 0);
540                         close(gzipDataPipe.wr);
541 #if WAIT_FOR_CHILD
542                         close(gzipStatusPipe.rd);
543                         fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
544 #endif
545                         /* exec gzip/bzip2 program/applet */
546                         BB_EXECLP(zip_exec, zip_exec, "-f", NULL);
547                         vfork_exec_errno = errno;
548                         _exit(1);
549                 }
550
551                 /* parent */
552                 xmove_fd(gzipDataPipe.wr, tbInfo.tarFd);
553                 close(gzipDataPipe.rd);
554 #if WAIT_FOR_CHILD
555                 close(gzipStatusPipe.wr);
556                 while (1) {
557                         char buf;
558                         int n;
559
560                         /* Wait until child execs (or fails to) */
561                         n = full_read(gzipStatusPipe.rd, &buf, 1);
562                         if ((n < 0) && (/*errno == EAGAIN ||*/ errno == EINTR))
563                                 continue;       /* try it again */
564
565                 }
566                 close(gzipStatusPipe.rd);
567 #endif
568                 if (vfork_exec_errno) {
569                         errno = vfork_exec_errno;
570                         bb_perror_msg_and_die("cannot exec %s", zip_exec);
571                 }
572         }
573
574         tbInfo.excludeList = exclude;
575
576         /* Read the directory/files and iterate over them one at a time */
577         while (include) {
578                 if (!recursive_action(include->data, ACTION_RECURSE |
579                                 (dereferenceFlag ? ACTION_FOLLOWLINKS : 0),
580                                 writeFileToTarball, writeFileToTarball, &tbInfo, 0))
581                 {
582                         errorFlag = TRUE;
583                 }
584                 include = include->link;
585         }
586         /* Write two empty blocks to the end of the archive */
587         memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
588         xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
589
590         /* To be pedantically correct, we would check if the tarball
591          * is smaller than 20 tar blocks, and pad it if it was smaller,
592          * but that isn't necessary for GNU tar interoperability, and
593          * so is considered a waste of space */
594
595         /* Close so the child process (if any) will exit */
596         close(tbInfo.tarFd);
597
598         /* Hang up the tools, close up shop, head home */
599         if (ENABLE_FEATURE_CLEAN_UP)
600                 freeHardLinkInfo(&tbInfo.hlInfoHead);
601
602         if (errorFlag)
603                 bb_error_msg("error exit delayed from previous errors");
604
605         if (gzipPid) {
606                 int status;
607                 if (waitpid(gzipPid, &status, 0) == -1)
608                         bb_perror_msg("waitpid");
609                 else if (!WIFEXITED(status) || WEXITSTATUS(status))
610                         /* gzip was killed or has exited with nonzero! */
611                         errorFlag = TRUE;
612         }
613         return errorFlag;
614 }
615 #else
616 int writeTarFile(const int tar_fd, const int verboseFlag,
617         const unsigned long dereferenceFlag, const llist_t *include,
618         const llist_t *exclude, const int gzip);
619 #endif /* FEATURE_TAR_CREATE */
620
621 #if ENABLE_FEATURE_TAR_FROM
622 static llist_t *append_file_list_to_list(llist_t *list)
623 {
624         FILE *src_stream;
625         llist_t *cur = list;
626         llist_t *tmp;
627         char *line;
628         llist_t *newlist = NULL;
629
630         while (cur) {
631                 src_stream = xfopen(cur->data, "r");
632                 tmp = cur;
633                 cur = cur->link;
634                 free(tmp);
635                 while ((line = xmalloc_getline(src_stream)) != NULL) {
636                         /* kill trailing '/' unless the string is just "/" */
637                         char *cp = last_char_is(line, '/');
638                         if (cp > line)
639                                 *cp = '\0';
640                         llist_add_to(&newlist, line);
641                 }
642                 fclose(src_stream);
643         }
644         return newlist;
645 }
646 #else
647 #define append_file_list_to_list(x) 0
648 #endif
649
650 #if ENABLE_FEATURE_TAR_COMPRESS
651 static char get_header_tar_Z(archive_handle_t *archive_handle)
652 {
653         /* Can't lseek over pipes */
654         archive_handle->seek = seek_by_read;
655
656         /* do the decompression, and cleanup */
657         if (xread_char(archive_handle->src_fd) != 0x1f
658          || xread_char(archive_handle->src_fd) != 0x9d
659         ) {
660                 bb_error_msg_and_die("invalid magic");
661         }
662
663         archive_handle->src_fd = open_transformer(archive_handle->src_fd, uncompress, "uncompress", "uncompress", "-cf", "-", NULL);
664         archive_handle->offset = 0;
665         while (get_header_tar(archive_handle) == EXIT_SUCCESS)
666                 /* nothing */;
667
668         /* Can only do one file at a time */
669         return EXIT_FAILURE;
670 }
671 #else
672 #define get_header_tar_Z NULL
673 #endif
674
675 #ifdef CHECK_FOR_CHILD_EXITCODE
676 /* Looks like it isn't needed - tar detects malformed (truncated)
677  * archive if e.g. bunzip2 fails */
678 static int child_error;
679
680 static void handle_SIGCHLD(int status)
681 {
682         /* Actually, 'status' is a signo. We reuse it for other needs */
683
684         /* Wait for any child without blocking */
685         if (waitpid(-1, &status, WNOHANG) < 0)
686                 /* wait failed?! I'm confused... */
687                 return;
688
689         if (WIFEXITED(status) && WEXITSTATUS(status)==0)
690                 /* child exited with 0 */
691                 return;
692         /* Cannot happen?
693         if (!WIFSIGNALED(status) && !WIFEXITED(status)) return; */
694         child_error = 1;
695 }
696 #endif
697
698 enum {
699         OPTBIT_KEEP_OLD = 7,
700         USE_FEATURE_TAR_CREATE(  OPTBIT_CREATE      ,)
701         USE_FEATURE_TAR_CREATE(  OPTBIT_DEREFERENCE ,)
702         USE_FEATURE_TAR_BZIP2(   OPTBIT_BZIP2       ,)
703         USE_FEATURE_TAR_LZMA(    OPTBIT_LZMA        ,)
704         USE_FEATURE_TAR_FROM(    OPTBIT_INCLUDE_FROM,)
705         USE_FEATURE_TAR_FROM(    OPTBIT_EXCLUDE_FROM,)
706         USE_FEATURE_TAR_GZIP(    OPTBIT_GZIP        ,)
707         USE_FEATURE_TAR_COMPRESS(OPTBIT_COMPRESS    ,)
708         OPTBIT_NOPRESERVE_OWN,
709         OPTBIT_NOPRESERVE_PERM,
710         OPT_TEST         = 1 << 0, // t
711         OPT_EXTRACT      = 1 << 1, // x
712         OPT_BASEDIR      = 1 << 2, // C
713         OPT_TARNAME      = 1 << 3, // f
714         OPT_2STDOUT      = 1 << 4, // O
715         OPT_P            = 1 << 5, // p
716         OPT_VERBOSE      = 1 << 6, // v
717         OPT_KEEP_OLD     = 1 << 7, // k
718         OPT_CREATE       = USE_FEATURE_TAR_CREATE(  (1<<OPTBIT_CREATE      )) + 0, // c
719         OPT_DEREFERENCE  = USE_FEATURE_TAR_CREATE(  (1<<OPTBIT_DEREFERENCE )) + 0, // h
720         OPT_BZIP2        = USE_FEATURE_TAR_BZIP2(   (1<<OPTBIT_BZIP2       )) + 0, // j
721         OPT_LZMA         = USE_FEATURE_TAR_LZMA(    (1<<OPTBIT_LZMA        )) + 0, // a
722         OPT_INCLUDE_FROM = USE_FEATURE_TAR_FROM(    (1<<OPTBIT_INCLUDE_FROM)) + 0, // T
723         OPT_EXCLUDE_FROM = USE_FEATURE_TAR_FROM(    (1<<OPTBIT_EXCLUDE_FROM)) + 0, // X
724         OPT_GZIP         = USE_FEATURE_TAR_GZIP(    (1<<OPTBIT_GZIP        )) + 0, // z
725         OPT_COMPRESS     = USE_FEATURE_TAR_COMPRESS((1<<OPTBIT_COMPRESS    )) + 0, // Z
726         OPT_NOPRESERVE_OWN  = 1 << OPTBIT_NOPRESERVE_OWN , // no-same-owner
727         OPT_NOPRESERVE_PERM = 1 << OPTBIT_NOPRESERVE_PERM, // no-same-permissions
728 };
729 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
730 static const char tar_longopts[] ALIGN1 =
731         "list\0"                No_argument       "t"
732         "extract\0"             No_argument       "x"
733         "directory\0"           Required_argument "C"
734         "file\0"                Required_argument "f"
735         "to-stdout\0"           No_argument       "O"
736         "same-permissions\0"    No_argument       "p"
737         "verbose\0"             No_argument       "v"
738         "keep-old\0"            No_argument       "k"
739 # if ENABLE_FEATURE_TAR_CREATE
740         "create\0"              No_argument       "c"
741         "dereference\0"         No_argument       "h"
742 # endif
743 # if ENABLE_FEATURE_TAR_BZIP2
744         "bzip2\0"               No_argument       "j"
745 # endif
746 # if ENABLE_FEATURE_TAR_LZMA
747         "lzma\0"                No_argument       "a"
748 # endif
749 # if ENABLE_FEATURE_TAR_FROM
750         "files-from\0"          Required_argument "T"
751         "exclude-from\0"        Required_argument "X"
752 # endif
753 # if ENABLE_FEATURE_TAR_GZIP
754         "gzip\0"                No_argument       "z"
755 # endif
756 # if ENABLE_FEATURE_TAR_COMPRESS
757         "compress\0"            No_argument       "Z"
758 # endif
759         "no-same-owner\0"       No_argument       "\xfd"
760         "no-same-permissions\0" No_argument       "\xfe"
761         /* --exclude takes next bit position in option mask, */
762         /* therefore we have to either put it _after_ --no-same-perm */
763         /* or add OPT[BIT]_EXCLUDE before OPT[BIT]_NOPRESERVE_OWN */
764 # if ENABLE_FEATURE_TAR_FROM
765         "exclude\0"             Required_argument "\xff"
766 # endif
767         ;
768 #endif
769
770 int tar_main(int argc, char **argv);
771 int tar_main(int argc, char **argv)
772 {
773         char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
774         archive_handle_t *tar_handle;
775         char *base_dir = NULL;
776         const char *tar_filename = "-";
777         unsigned opt;
778         int verboseFlag = 0;
779 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
780         llist_t *excludes = NULL;
781 #endif
782
783         /* Initialise default values */
784         tar_handle = init_handle();
785         tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS
786                           | ARCHIVE_PRESERVE_DATE
787                           | ARCHIVE_EXTRACT_UNCONDITIONAL;
788
789         /* Prepend '-' to the first argument if required */
790         opt_complementary = "--:" // first arg is options
791                 "tt:vv:" // count -t,-v
792                 "?:" // bail out with usage instead of error return
793                 "X::T::" // cumulative lists
794 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
795                 "\xff::" // cumulative lists for --exclude
796 #endif
797                 USE_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
798                 USE_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
799                 SKIP_FEATURE_TAR_CREATE("t--x:x--t"); // mutually exclusive
800 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
801         applet_long_options = tar_longopts;
802 #endif
803         opt = getopt32(argv,
804                 "txC:f:Opvk"
805                 USE_FEATURE_TAR_CREATE(  "ch"  )
806                 USE_FEATURE_TAR_BZIP2(   "j"   )
807                 USE_FEATURE_TAR_LZMA(    "a"   )
808                 USE_FEATURE_TAR_FROM(    "T:X:")
809                 USE_FEATURE_TAR_GZIP(    "z"   )
810                 USE_FEATURE_TAR_COMPRESS("Z"   )
811                 , &base_dir // -C dir
812                 , &tar_filename // -f filename
813                 USE_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
814                 USE_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
815 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
816                 , &excludes // --exclude
817 #endif
818                 , &verboseFlag // combined count for -t and -v
819                 , &verboseFlag // combined count for -t and -v
820                 );
821
822         if (verboseFlag) tar_handle->action_header = header_verbose_list;
823         if (verboseFlag == 1) tar_handle->action_header = header_list;
824
825         if (opt & OPT_EXTRACT)
826                 tar_handle->action_data = data_extract_all;
827
828         if (opt & OPT_2STDOUT)
829                 tar_handle->action_data = data_extract_to_stdout;
830
831         if (opt & OPT_KEEP_OLD)
832                 tar_handle->flags &= ~ARCHIVE_EXTRACT_UNCONDITIONAL;
833
834         if (opt & OPT_NOPRESERVE_OWN)
835                 tar_handle->flags |= ARCHIVE_NOPRESERVE_OWN;
836
837         if (opt & OPT_NOPRESERVE_PERM)
838                 tar_handle->flags |= ARCHIVE_NOPRESERVE_PERM;
839
840         if (opt & OPT_GZIP)
841                 get_header_ptr = get_header_tar_gz;
842
843         if (opt & OPT_BZIP2)
844                 get_header_ptr = get_header_tar_bz2;
845
846         if (opt & OPT_LZMA)
847                 get_header_ptr = get_header_tar_lzma;
848
849         if (opt & OPT_COMPRESS)
850                 get_header_ptr = get_header_tar_Z;
851
852 #if ENABLE_FEATURE_TAR_FROM
853         tar_handle->reject = append_file_list_to_list(tar_handle->reject);
854 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
855         /* Append excludes to reject */
856         while (excludes) {
857                 llist_t *next = excludes->link;
858                 excludes->link = tar_handle->reject;
859                 tar_handle->reject = excludes;
860                 excludes = next;
861         }
862 #endif
863         tar_handle->accept = append_file_list_to_list(tar_handle->accept);
864 #endif
865
866         /* Check if we are reading from stdin */
867         if (argv[optind] && *argv[optind] == '-') {
868                 /* Default is to read from stdin, so just skip to next arg */
869                 optind++;
870         }
871
872         /* Setup an array of filenames to work with */
873         /* TODO: This is the same as in ar, separate function ? */
874         while (optind < argc) {
875                 /* kill trailing '/' unless the string is just "/" */
876                 char *cp = last_char_is(argv[optind], '/');
877                 if (cp > argv[optind])
878                         *cp = '\0';
879                 llist_add_to_end(&tar_handle->accept, argv[optind]);
880                 optind++;
881         }
882
883         if (tar_handle->accept || tar_handle->reject)
884                 tar_handle->filter = filter_accept_reject_list;
885
886         /* Open the tar file */
887         {
888                 FILE *tar_stream;
889                 int flags;
890
891                 if (opt & OPT_CREATE) {
892                         /* Make sure there is at least one file to tar up.  */
893                         if (tar_handle->accept == NULL)
894                                 bb_error_msg_and_die("empty archive");
895
896                         tar_stream = stdout;
897                         /* Mimicking GNU tar 1.15.1: */
898                         flags = O_WRONLY|O_CREAT|O_TRUNC;
899                 /* was doing unlink; open(O_WRONLY|O_CREAT|O_EXCL); why? */
900                 } else {
901                         tar_stream = stdin;
902                         flags = O_RDONLY;
903                 }
904
905                 if (LONE_DASH(tar_filename)) {
906                         tar_handle->src_fd = fileno(tar_stream);
907                         tar_handle->seek = seek_by_read;
908                 } else {
909                         tar_handle->src_fd = xopen(tar_filename, flags);
910                 }
911         }
912
913         if (base_dir)
914                 xchdir(base_dir);
915
916 #ifdef CHECK_FOR_CHILD_EXITCODE
917         /* We need to know whether child (gzip/bzip/etc) exits abnormally */
918         signal(SIGCHLD, handle_SIGCHLD);
919 #endif
920
921         /* create an archive */
922         if (opt & OPT_CREATE) {
923                 int zipMode = 0;
924                 if (ENABLE_FEATURE_TAR_GZIP && get_header_ptr == get_header_tar_gz)
925                         zipMode = 1;
926                 if (ENABLE_FEATURE_TAR_BZIP2 && get_header_ptr == get_header_tar_bz2)
927                         zipMode = 2;
928                 /* NB: writeTarFile() closes tar_handle->src_fd */
929                 return writeTarFile(tar_handle->src_fd, verboseFlag, opt & OPT_DEREFERENCE,
930                                 tar_handle->accept,
931                                 tar_handle->reject, zipMode);
932         }
933
934         while (get_header_ptr(tar_handle) == EXIT_SUCCESS)
935                 /* nothing */;
936
937         /* Check that every file that should have been extracted was */
938         while (tar_handle->accept) {
939                 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
940                  && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
941                 ) {
942                         bb_error_msg_and_die("%s: not found in archive",
943                                 tar_handle->accept->data);
944                 }
945                 tar_handle->accept = tar_handle->accept->link;
946         }
947         if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
948                 close(tar_handle->src_fd);
949
950         return EXIT_SUCCESS;
951 }