tar: strip leading '/' BEFORE memorizing hardlink's name
[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  *  by Glenn McGrath
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         header_name = fileName;
390         while (header_name[0] == '/') {
391                 static smallint warned;
392
393                 if (!warned) {
394                         bb_error_msg("removing leading '/' from member names");
395                         warned = 1;
396                 }
397                 header_name++;
398         }
399
400         if (header_name[0] == '\0')
401                 return TRUE;
402
403         /*
404          * Check to see if we are dealing with a hard link.
405          * If so -
406          * Treat the first occurance of a given dev/inode as a file while
407          * treating any additional occurances as hard links.  This is done
408          * by adding the file information to the HardLinkInfo linked list.
409          */
410         tbInfo->hlInfo = NULL;
411         if (statbuf->st_nlink > 1) {
412                 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
413                 if (tbInfo->hlInfo == NULL)
414                         addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
415         }
416
417         /* It is against the rules to archive a socket */
418         if (S_ISSOCK(statbuf->st_mode)) {
419                 bb_error_msg("%s: socket ignored", fileName);
420                 return TRUE;
421         }
422
423         /* It is a bad idea to store the archive we are in the process of creating,
424          * so check the device and inode to be sure that this particular file isn't
425          * the new tarball */
426         if (tbInfo->statBuf.st_dev == statbuf->st_dev
427          && tbInfo->statBuf.st_ino == statbuf->st_ino
428         ) {
429                 bb_error_msg("%s: file is the archive; skipping", fileName);
430                 return TRUE;
431         }
432
433         if (exclude_file(tbInfo->excludeList, header_name))
434                 return SKIP;
435
436 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
437         if (strlen(header_name) >= NAME_SIZE) {
438                 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
439                 return TRUE;
440         }
441 #endif
442
443         /* Is this a regular file? */
444         if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
445                 /* open the file we want to archive, and make sure all is well */
446                 inputFileFd = open_or_warn(fileName, O_RDONLY);
447                 if (inputFileFd < 0) {
448                         return FALSE;
449                 }
450         }
451
452         /* Add an entry to the tarball */
453         if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
454                 return FALSE;
455         }
456
457         /* If it was a regular file, write out the body */
458         if (inputFileFd >= 0) {
459                 size_t readSize;
460                 /* Write the file to the archive. */
461                 /* We record size into header first, */
462                 /* and then write out file. If file shrinks in between, */
463                 /* tar will be corrupted. So we don't allow for that. */
464                 /* NB: GNU tar 1.16 warns and pads with zeroes */
465                 /* or even seeks back and updates header */
466                 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
467                 ////off_t readSize;
468                 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
469                 ////if (readSize != statbuf->st_size && readSize >= 0) {
470                 ////    bb_error_msg_and_die("short read from %s, aborting", fileName);
471                 ////}
472
473                 /* Check that file did not grow in between? */
474                 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
475
476                 close(inputFileFd);
477
478                 /* Pad the file up to the tar block size */
479                 /* (a few tricks here in the name of code size) */
480                 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
481                 memset(block_buf, 0, readSize);
482                 xwrite(tbInfo->tarFd, block_buf, readSize);
483         }
484
485         return TRUE;
486 }
487
488 static int writeTarFile(const int tar_fd, const int verboseFlag,
489         const unsigned long dereferenceFlag, const llist_t *include,
490         const llist_t *exclude, const int gzip)
491 {
492         pid_t gzipPid = 0;
493         int errorFlag = FALSE;
494         struct TarBallInfo tbInfo;
495
496         tbInfo.hlInfoHead = NULL;
497
498         fchmod(tar_fd, 0644);
499         tbInfo.tarFd = tar_fd;
500         tbInfo.verboseFlag = verboseFlag;
501
502         /* Store the stat info for the tarball's file, so
503          * can avoid including the tarball into itself....  */
504         if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
505                 bb_perror_msg_and_die("cannot stat tar file");
506
507         if ((ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2) && gzip) {
508 // On Linux, vfork never unpauses parent early, although standard
509 // allows for that. Do we want to waste bytes checking for it?
510 #define WAIT_FOR_CHILD 0
511
512                 volatile int vfork_exec_errno = 0;
513 #if WAIT_FOR_CHILD
514                 struct { int rd; int wr; } gzipStatusPipe;
515 #endif
516                 struct { int rd; int wr; } gzipDataPipe;
517                 const char *zip_exec = (gzip == 1) ? "gzip" : "bzip2";
518
519                 xpipe(&gzipDataPipe.rd);
520 #if WAIT_FOR_CHILD
521                 xpipe(&gzipStatusPipe.rd);
522 #endif
523
524                 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
525
526 #if defined(__GNUC__) && __GNUC__
527                 /* Avoid vfork clobbering */
528                 (void) &include;
529                 (void) &errorFlag;
530                 (void) &zip_exec;
531 #endif
532
533                 gzipPid = vfork();
534                 if (gzipPid < 0)
535                         bb_perror_msg_and_die("vfork gzip");
536
537                 if (gzipPid == 0) {
538                         /* child */
539                         xmove_fd(tbInfo.tarFd, 1);
540                         xmove_fd(gzipDataPipe.rd, 0);
541                         close(gzipDataPipe.wr);
542 #if WAIT_FOR_CHILD
543                         close(gzipStatusPipe.rd);
544                         fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
545 #endif
546                         /* exec gzip/bzip2 program/applet */
547                         BB_EXECLP(zip_exec, zip_exec, "-f", NULL);
548                         vfork_exec_errno = errno;
549                         _exit(1);
550                 }
551
552                 /* parent */
553                 xmove_fd(gzipDataPipe.wr, tbInfo.tarFd);
554                 close(gzipDataPipe.rd);
555 #if WAIT_FOR_CHILD
556                 close(gzipStatusPipe.wr);
557                 while (1) {
558                         char buf;
559                         int n;
560
561                         /* Wait until child execs (or fails to) */
562                         n = full_read(gzipStatusPipe.rd, &buf, 1);
563                         if ((n < 0) && (/*errno == EAGAIN ||*/ errno == EINTR))
564                                 continue;       /* try it again */
565
566                 }
567                 close(gzipStatusPipe.rd);
568 #endif
569                 if (vfork_exec_errno) {
570                         errno = vfork_exec_errno;
571                         bb_perror_msg_and_die("cannot exec %s", zip_exec);
572                 }
573         }
574
575         tbInfo.excludeList = exclude;
576
577         /* Read the directory/files and iterate over them one at a time */
578         while (include) {
579                 if (!recursive_action(include->data, ACTION_RECURSE |
580                                 (dereferenceFlag ? ACTION_FOLLOWLINKS : 0),
581                                 writeFileToTarball, writeFileToTarball, &tbInfo, 0))
582                 {
583                         errorFlag = TRUE;
584                 }
585                 include = include->link;
586         }
587         /* Write two empty blocks to the end of the archive */
588         memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
589         xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
590
591         /* To be pedantically correct, we would check if the tarball
592          * is smaller than 20 tar blocks, and pad it if it was smaller,
593          * but that isn't necessary for GNU tar interoperability, and
594          * so is considered a waste of space */
595
596         /* Close so the child process (if any) will exit */
597         close(tbInfo.tarFd);
598
599         /* Hang up the tools, close up shop, head home */
600         if (ENABLE_FEATURE_CLEAN_UP)
601                 freeHardLinkInfo(&tbInfo.hlInfoHead);
602
603         if (errorFlag)
604                 bb_error_msg("error exit delayed from previous errors");
605
606         if (gzipPid) {
607                 int status;
608                 if (waitpid(gzipPid, &status, 0) == -1)
609                         bb_perror_msg("waitpid");
610                 else if (!WIFEXITED(status) || WEXITSTATUS(status))
611                         /* gzip was killed or has exited with nonzero! */
612                         errorFlag = TRUE;
613         }
614         return errorFlag;
615 }
616 #else
617 int writeTarFile(const int tar_fd, const int verboseFlag,
618         const unsigned long dereferenceFlag, const llist_t *include,
619         const llist_t *exclude, const int gzip);
620 #endif /* FEATURE_TAR_CREATE */
621
622 #if ENABLE_FEATURE_TAR_FROM
623 static llist_t *append_file_list_to_list(llist_t *list)
624 {
625         FILE *src_stream;
626         llist_t *cur = list;
627         llist_t *tmp;
628         char *line;
629         llist_t *newlist = NULL;
630
631         while (cur) {
632                 src_stream = xfopen(cur->data, "r");
633                 tmp = cur;
634                 cur = cur->link;
635                 free(tmp);
636                 while ((line = xmalloc_getline(src_stream)) != NULL) {
637                         /* kill trailing '/' unless the string is just "/" */
638                         char *cp = last_char_is(line, '/');
639                         if (cp > line)
640                                 *cp = '\0';
641                         llist_add_to(&newlist, line);
642                 }
643                 fclose(src_stream);
644         }
645         return newlist;
646 }
647 #else
648 #define append_file_list_to_list(x) 0
649 #endif
650
651 #if ENABLE_FEATURE_TAR_COMPRESS
652 static char get_header_tar_Z(archive_handle_t *archive_handle)
653 {
654         /* Can't lseek over pipes */
655         archive_handle->seek = seek_by_read;
656
657         /* do the decompression, and cleanup */
658         if (xread_char(archive_handle->src_fd) != 0x1f
659          || xread_char(archive_handle->src_fd) != 0x9d
660         ) {
661                 bb_error_msg_and_die("invalid magic");
662         }
663
664         archive_handle->src_fd = open_transformer(archive_handle->src_fd, uncompress, "uncompress", "uncompress", "-cf", "-", NULL);
665         archive_handle->offset = 0;
666         while (get_header_tar(archive_handle) == EXIT_SUCCESS)
667                 continue;
668
669         /* Can only do one file at a time */
670         return EXIT_FAILURE;
671 }
672 #else
673 #define get_header_tar_Z NULL
674 #endif
675
676 #ifdef CHECK_FOR_CHILD_EXITCODE
677 /* Looks like it isn't needed - tar detects malformed (truncated)
678  * archive if e.g. bunzip2 fails */
679 static int child_error;
680
681 static void handle_SIGCHLD(int status)
682 {
683         /* Actually, 'status' is a signo. We reuse it for other needs */
684
685         /* Wait for any child without blocking */
686         if (waitpid(-1, &status, WNOHANG) < 0)
687                 /* wait failed?! I'm confused... */
688                 return;
689
690         if (WIFEXITED(status) && WEXITSTATUS(status)==0)
691                 /* child exited with 0 */
692                 return;
693         /* Cannot happen?
694         if (!WIFSIGNALED(status) && !WIFEXITED(status)) return; */
695         child_error = 1;
696 }
697 #endif
698
699 enum {
700         OPTBIT_KEEP_OLD = 7,
701         USE_FEATURE_TAR_CREATE(  OPTBIT_CREATE      ,)
702         USE_FEATURE_TAR_CREATE(  OPTBIT_DEREFERENCE ,)
703         USE_FEATURE_TAR_BZIP2(   OPTBIT_BZIP2       ,)
704         USE_FEATURE_TAR_LZMA(    OPTBIT_LZMA        ,)
705         USE_FEATURE_TAR_FROM(    OPTBIT_INCLUDE_FROM,)
706         USE_FEATURE_TAR_FROM(    OPTBIT_EXCLUDE_FROM,)
707         USE_FEATURE_TAR_GZIP(    OPTBIT_GZIP        ,)
708         USE_FEATURE_TAR_COMPRESS(OPTBIT_COMPRESS    ,)
709         OPTBIT_NOPRESERVE_OWN,
710         OPTBIT_NOPRESERVE_PERM,
711         OPT_TEST         = 1 << 0, // t
712         OPT_EXTRACT      = 1 << 1, // x
713         OPT_BASEDIR      = 1 << 2, // C
714         OPT_TARNAME      = 1 << 3, // f
715         OPT_2STDOUT      = 1 << 4, // O
716         OPT_P            = 1 << 5, // p
717         OPT_VERBOSE      = 1 << 6, // v
718         OPT_KEEP_OLD     = 1 << 7, // k
719         OPT_CREATE       = USE_FEATURE_TAR_CREATE(  (1<<OPTBIT_CREATE      )) + 0, // c
720         OPT_DEREFERENCE  = USE_FEATURE_TAR_CREATE(  (1<<OPTBIT_DEREFERENCE )) + 0, // h
721         OPT_BZIP2        = USE_FEATURE_TAR_BZIP2(   (1<<OPTBIT_BZIP2       )) + 0, // j
722         OPT_LZMA         = USE_FEATURE_TAR_LZMA(    (1<<OPTBIT_LZMA        )) + 0, // a
723         OPT_INCLUDE_FROM = USE_FEATURE_TAR_FROM(    (1<<OPTBIT_INCLUDE_FROM)) + 0, // T
724         OPT_EXCLUDE_FROM = USE_FEATURE_TAR_FROM(    (1<<OPTBIT_EXCLUDE_FROM)) + 0, // X
725         OPT_GZIP         = USE_FEATURE_TAR_GZIP(    (1<<OPTBIT_GZIP        )) + 0, // z
726         OPT_COMPRESS     = USE_FEATURE_TAR_COMPRESS((1<<OPTBIT_COMPRESS    )) + 0, // Z
727         OPT_NOPRESERVE_OWN  = 1 << OPTBIT_NOPRESERVE_OWN , // no-same-owner
728         OPT_NOPRESERVE_PERM = 1 << OPTBIT_NOPRESERVE_PERM, // no-same-permissions
729 };
730 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
731 static const char tar_longopts[] ALIGN1 =
732         "list\0"                No_argument       "t"
733         "extract\0"             No_argument       "x"
734         "directory\0"           Required_argument "C"
735         "file\0"                Required_argument "f"
736         "to-stdout\0"           No_argument       "O"
737         "same-permissions\0"    No_argument       "p"
738         "verbose\0"             No_argument       "v"
739         "keep-old\0"            No_argument       "k"
740 # if ENABLE_FEATURE_TAR_CREATE
741         "create\0"              No_argument       "c"
742         "dereference\0"         No_argument       "h"
743 # endif
744 # if ENABLE_FEATURE_TAR_BZIP2
745         "bzip2\0"               No_argument       "j"
746 # endif
747 # if ENABLE_FEATURE_TAR_LZMA
748         "lzma\0"                No_argument       "a"
749 # endif
750 # if ENABLE_FEATURE_TAR_FROM
751         "files-from\0"          Required_argument "T"
752         "exclude-from\0"        Required_argument "X"
753 # endif
754 # if ENABLE_FEATURE_TAR_GZIP
755         "gzip\0"                No_argument       "z"
756 # endif
757 # if ENABLE_FEATURE_TAR_COMPRESS
758         "compress\0"            No_argument       "Z"
759 # endif
760         "no-same-owner\0"       No_argument       "\xfd"
761         "no-same-permissions\0" No_argument       "\xfe"
762         /* --exclude takes next bit position in option mask, */
763         /* therefore we have to either put it _after_ --no-same-perm */
764         /* or add OPT[BIT]_EXCLUDE before OPT[BIT]_NOPRESERVE_OWN */
765 # if ENABLE_FEATURE_TAR_FROM
766         "exclude\0"             Required_argument "\xff"
767 # endif
768         ;
769 #endif
770
771 int tar_main(int argc, char **argv);
772 int tar_main(int argc, char **argv)
773 {
774         char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
775         archive_handle_t *tar_handle;
776         char *base_dir = NULL;
777         const char *tar_filename = "-";
778         unsigned opt;
779         int verboseFlag = 0;
780 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
781         llist_t *excludes = NULL;
782 #endif
783
784         /* Initialise default values */
785         tar_handle = init_handle();
786         tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS
787                           | ARCHIVE_PRESERVE_DATE
788                           | ARCHIVE_EXTRACT_UNCONDITIONAL;
789
790         /* Prepend '-' to the first argument if required */
791         opt_complementary = "--:" // first arg is options
792                 "tt:vv:" // count -t,-v
793                 "?:" // bail out with usage instead of error return
794                 "X::T::" // cumulative lists
795 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
796                 "\xff::" // cumulative lists for --exclude
797 #endif
798                 USE_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
799                 USE_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
800                 SKIP_FEATURE_TAR_CREATE("t--x:x--t"); // mutually exclusive
801 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
802         applet_long_options = tar_longopts;
803 #endif
804         opt = getopt32(argv,
805                 "txC:f:Opvk"
806                 USE_FEATURE_TAR_CREATE(  "ch"  )
807                 USE_FEATURE_TAR_BZIP2(   "j"   )
808                 USE_FEATURE_TAR_LZMA(    "a"   )
809                 USE_FEATURE_TAR_FROM(    "T:X:")
810                 USE_FEATURE_TAR_GZIP(    "z"   )
811                 USE_FEATURE_TAR_COMPRESS("Z"   )
812                 , &base_dir // -C dir
813                 , &tar_filename // -f filename
814                 USE_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
815                 USE_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
816 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
817                 , &excludes // --exclude
818 #endif
819                 , &verboseFlag // combined count for -t and -v
820                 , &verboseFlag // combined count for -t and -v
821                 );
822
823         if (verboseFlag) tar_handle->action_header = header_verbose_list;
824         if (verboseFlag == 1) tar_handle->action_header = header_list;
825
826         if (opt & OPT_EXTRACT)
827                 tar_handle->action_data = data_extract_all;
828
829         if (opt & OPT_2STDOUT)
830                 tar_handle->action_data = data_extract_to_stdout;
831
832         if (opt & OPT_KEEP_OLD)
833                 tar_handle->flags &= ~ARCHIVE_EXTRACT_UNCONDITIONAL;
834
835         if (opt & OPT_NOPRESERVE_OWN)
836                 tar_handle->flags |= ARCHIVE_NOPRESERVE_OWN;
837
838         if (opt & OPT_NOPRESERVE_PERM)
839                 tar_handle->flags |= ARCHIVE_NOPRESERVE_PERM;
840
841         if (opt & OPT_GZIP)
842                 get_header_ptr = get_header_tar_gz;
843
844         if (opt & OPT_BZIP2)
845                 get_header_ptr = get_header_tar_bz2;
846
847         if (opt & OPT_LZMA)
848                 get_header_ptr = get_header_tar_lzma;
849
850         if (opt & OPT_COMPRESS)
851                 get_header_ptr = get_header_tar_Z;
852
853 #if ENABLE_FEATURE_TAR_FROM
854         tar_handle->reject = append_file_list_to_list(tar_handle->reject);
855 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
856         /* Append excludes to reject */
857         while (excludes) {
858                 llist_t *next = excludes->link;
859                 excludes->link = tar_handle->reject;
860                 tar_handle->reject = excludes;
861                 excludes = next;
862         }
863 #endif
864         tar_handle->accept = append_file_list_to_list(tar_handle->accept);
865 #endif
866
867         /* Check if we are reading from stdin */
868         if (argv[optind] && *argv[optind] == '-') {
869                 /* Default is to read from stdin, so just skip to next arg */
870                 optind++;
871         }
872
873         /* Setup an array of filenames to work with */
874         /* TODO: This is the same as in ar, separate function ? */
875         while (optind < argc) {
876                 /* kill trailing '/' unless the string is just "/" */
877                 char *cp = last_char_is(argv[optind], '/');
878                 if (cp > argv[optind])
879                         *cp = '\0';
880                 llist_add_to_end(&tar_handle->accept, argv[optind]);
881                 optind++;
882         }
883
884         if (tar_handle->accept || tar_handle->reject)
885                 tar_handle->filter = filter_accept_reject_list;
886
887         /* Open the tar file */
888         {
889                 FILE *tar_stream;
890                 int flags;
891
892                 if (opt & OPT_CREATE) {
893                         /* Make sure there is at least one file to tar up.  */
894                         if (tar_handle->accept == NULL)
895                                 bb_error_msg_and_die("empty archive");
896
897                         tar_stream = stdout;
898                         /* Mimicking GNU tar 1.15.1: */
899                         flags = O_WRONLY|O_CREAT|O_TRUNC;
900                 /* was doing unlink; open(O_WRONLY|O_CREAT|O_EXCL); why? */
901                 } else {
902                         tar_stream = stdin;
903                         flags = O_RDONLY;
904                 }
905
906                 if (LONE_DASH(tar_filename)) {
907                         tar_handle->src_fd = fileno(tar_stream);
908                         tar_handle->seek = seek_by_read;
909                 } else {
910                         tar_handle->src_fd = xopen(tar_filename, flags);
911                 }
912         }
913
914         if (base_dir)
915                 xchdir(base_dir);
916
917 #ifdef CHECK_FOR_CHILD_EXITCODE
918         /* We need to know whether child (gzip/bzip/etc) exits abnormally */
919         signal(SIGCHLD, handle_SIGCHLD);
920 #endif
921
922         /* create an archive */
923         if (opt & OPT_CREATE) {
924                 int zipMode = 0;
925                 if (ENABLE_FEATURE_TAR_GZIP && get_header_ptr == get_header_tar_gz)
926                         zipMode = 1;
927                 if (ENABLE_FEATURE_TAR_BZIP2 && get_header_ptr == get_header_tar_bz2)
928                         zipMode = 2;
929                 /* NB: writeTarFile() closes tar_handle->src_fd */
930                 return writeTarFile(tar_handle->src_fd, verboseFlag, opt & OPT_DEREFERENCE,
931                                 tar_handle->accept,
932                                 tar_handle->reject, zipMode);
933         }
934
935         while (get_header_ptr(tar_handle) == EXIT_SUCCESS)
936                 /* nothing */;
937
938         /* Check that every file that should have been extracted was */
939         while (tar_handle->accept) {
940                 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
941                  && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
942                 ) {
943                         bb_error_msg_and_die("%s: not found in archive",
944                                 tar_handle->accept->data);
945                 }
946                 tar_handle->accept = tar_handle->accept->link;
947         }
948         if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
949                 close(tar_handle->src_fd);
950
951         return EXIT_SUCCESS;
952 }