Patch from Dennis Vlasenko to add the option to compress help text.
[oweals/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 <fcntl.h>
27 #include <getopt.h>
28 #include <search.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <fnmatch.h>
33 #include <string.h>
34 #include <errno.h>
35 #include <signal.h>
36 #include <sys/wait.h>
37 #include <sys/socket.h>
38 #include <sys/sysmacros.h>     /* major() and minor() */
39 #include "unarchive.h"
40 #include "busybox.h"
41
42 #ifdef CONFIG_FEATURE_TAR_CREATE
43
44 /* Tar file constants  */
45 # define TAR_MAGIC          "ustar"     /* ustar and a null */
46 # define TAR_VERSION        "  "        /* Be compatible with GNU tar format */
47
48 #define TAR_BLOCK_SIZE          512
49 #define TAR_MAGIC_LEN           6
50 #define TAR_VERSION_LEN         2
51
52 /* POSIX tar Header Block, from POSIX 1003.1-1990  */
53 #define NAME_SIZE                       100
54 struct TarHeader {              /* byte offset */
55         char name[NAME_SIZE];   /*   0-99 */
56         char mode[8];           /* 100-107 */
57         char uid[8];            /* 108-115 */
58         char gid[8];            /* 116-123 */
59         char size[12];          /* 124-135 */
60         char mtime[12];         /* 136-147 */
61         char chksum[8];         /* 148-155 */
62         char typeflag;          /* 156-156 */
63         char linkname[NAME_SIZE];       /* 157-256 */
64         char magic[6];          /* 257-262 */
65         char version[2];        /* 263-264 */
66         char uname[32];         /* 265-296 */
67         char gname[32];         /* 297-328 */
68         char devmajor[8];       /* 329-336 */
69         char devminor[8];       /* 337-344 */
70         char prefix[155];       /* 345-499 */
71         char padding[12];       /* 500-512 (pad to exactly the TAR_BLOCK_SIZE) */
72 };
73 typedef struct TarHeader TarHeader;
74
75 /*
76 ** writeTarFile(),  writeFileToTarball(), and writeTarHeader() are
77 ** the only functions that deal with the HardLinkInfo structure.
78 ** Even these functions use the xxxHardLinkInfo() functions.
79 */
80 typedef struct HardLinkInfo HardLinkInfo;
81 struct HardLinkInfo {
82         HardLinkInfo *next;     /* Next entry in list */
83         dev_t dev;                      /* Device number */
84         ino_t ino;                      /* Inode number */
85         short linkCount;        /* (Hard) Link Count */
86         char name[1];           /* Start of filename (must be last) */
87 };
88
89 /* Some info to be carried along when creating a new tarball */
90 struct TarBallInfo {
91         char *fileName;                 /* File name of the tarball */
92         int tarFd;                              /* Open-for-write file descriptor
93                                                            for the tarball */
94         struct stat statBuf;    /* Stat info for the tarball, letting
95                                                            us know the inode and device that the
96                                                            tarball lives, so we can avoid trying
97                                                            to include the tarball into itself */
98         int verboseFlag;                /* Whether to print extra stuff or not */
99         const llist_t *excludeList;     /* List of files to not include */
100         HardLinkInfo *hlInfoHead;       /* Hard Link Tracking Information */
101         HardLinkInfo *hlInfo;   /* Hard Link Info for the current file */
102 };
103 typedef struct TarBallInfo TarBallInfo;
104
105 /* A nice enum with all the possible tar file content types */
106 enum TarFileType {
107         REGTYPE = '0',          /* regular file */
108         REGTYPE0 = '\0',        /* regular file (ancient bug compat) */
109         LNKTYPE = '1',          /* hard link */
110         SYMTYPE = '2',          /* symbolic link */
111         CHRTYPE = '3',          /* character special */
112         BLKTYPE = '4',          /* block special */
113         DIRTYPE = '5',          /* directory */
114         FIFOTYPE = '6',         /* FIFO special */
115         CONTTYPE = '7',         /* reserved */
116         GNULONGLINK = 'K',      /* GNU long (>100 chars) link name */
117         GNULONGNAME = 'L',      /* GNU long (>100 chars) file name */
118 };
119 typedef enum TarFileType TarFileType;
120
121 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
122 static inline void addHardLinkInfo(HardLinkInfo ** hlInfoHeadPtr,
123                                         struct stat *statbuf,
124                                         const char *name)
125 {
126         /* Note: hlInfoHeadPtr can never be NULL! */
127         HardLinkInfo *hlInfo;
128
129         hlInfo = (HardLinkInfo *) xmalloc(sizeof(HardLinkInfo) + strlen(name));
130         hlInfo->next = *hlInfoHeadPtr;
131         *hlInfoHeadPtr = hlInfo;
132         hlInfo->dev = statbuf->st_dev;
133         hlInfo->ino = statbuf->st_ino;
134         hlInfo->linkCount = statbuf->st_nlink;
135         strcpy(hlInfo->name, name);
136 }
137
138 static void freeHardLinkInfo(HardLinkInfo ** hlInfoHeadPtr)
139 {
140         HardLinkInfo *hlInfo = NULL;
141         HardLinkInfo *hlInfoNext = NULL;
142
143         if (hlInfoHeadPtr) {
144                 hlInfo = *hlInfoHeadPtr;
145                 while (hlInfo) {
146                         hlInfoNext = hlInfo->next;
147                         free(hlInfo);
148                         hlInfo = hlInfoNext;
149                 }
150                 *hlInfoHeadPtr = NULL;
151         }
152         return;
153 }
154
155 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
156 static inline HardLinkInfo *findHardLinkInfo(HardLinkInfo * hlInfo, struct stat *statbuf)
157 {
158         while (hlInfo) {
159                 if ((statbuf->st_ino == hlInfo->ino) && (statbuf->st_dev == hlInfo->dev))
160                         break;
161                 hlInfo = hlInfo->next;
162         }
163         return (hlInfo);
164 }
165
166 /* Put an octal string into the specified buffer.
167  * The number is zero and space padded and possibly null padded.
168  * Returns TRUE if successful.  */
169 static int putOctal(char *cp, int len, long value)
170 {
171         int tempLength;
172         char tempBuffer[32];
173         char *tempString = tempBuffer;
174
175         /* Create a string of the specified length with an initial space,
176          * leading zeroes and the octal number, and a trailing null.  */
177         sprintf(tempString, "%0*lo", len - 1, value);
178
179         /* If the string is too large, suppress the leading space.  */
180         tempLength = strlen(tempString) + 1;
181         if (tempLength > len) {
182                 tempLength--;
183                 tempString++;
184         }
185
186         /* If the string is still too large, suppress the trailing null.  */
187         if (tempLength > len)
188                 tempLength--;
189
190         /* If the string is still too large, fail.  */
191         if (tempLength > len)
192                 return FALSE;
193
194         /* Copy the string to the field.  */
195         memcpy(cp, tempString, len);
196
197         return TRUE;
198 }
199
200 /* Write out a tar header for the specified file/directory/whatever */
201 static inline int writeTarHeader(struct TarBallInfo *tbInfo,
202                 const char *header_name, const char *real_name, struct stat *statbuf)
203 {
204         long chksum = 0;
205         struct TarHeader header;
206         const unsigned char *cp = (const unsigned char *) &header;
207         ssize_t size = sizeof(struct TarHeader);
208
209         memset(&header, 0, size);
210
211         strncpy(header.name, header_name, sizeof(header.name));
212
213         putOctal(header.mode, sizeof(header.mode), statbuf->st_mode);
214         putOctal(header.uid, sizeof(header.uid), statbuf->st_uid);
215         putOctal(header.gid, sizeof(header.gid), statbuf->st_gid);
216         putOctal(header.size, sizeof(header.size), 0);  /* Regular file size is handled later */
217         putOctal(header.mtime, sizeof(header.mtime), statbuf->st_mtime);
218         strncpy(header.magic, TAR_MAGIC TAR_VERSION,
219                         TAR_MAGIC_LEN + TAR_VERSION_LEN);
220
221         /* Enter the user and group names (default to root if it fails) */
222         if (bb_getpwuid(header.uname, statbuf->st_uid, sizeof(header.uname)) == NULL)
223                 strcpy(header.uname, "root");
224         if (bb_getgrgid(header.gname, statbuf->st_gid, sizeof(header.gname)) == NULL)
225                 strcpy(header.gname, "root");
226
227         if (tbInfo->hlInfo) {
228                 /* This is a hard link */
229                 header.typeflag = LNKTYPE;
230                 strncpy(header.linkname, tbInfo->hlInfo->name,
231                                 sizeof(header.linkname));
232         } else if (S_ISLNK(statbuf->st_mode)) {
233                 char *lpath = xreadlink(real_name);
234
235                 if (!lpath)             /* Already printed err msg inside xreadlink() */
236                         return (FALSE);
237                 header.typeflag = SYMTYPE;
238                 strncpy(header.linkname, lpath, sizeof(header.linkname));
239                 free(lpath);
240         } else if (S_ISDIR(statbuf->st_mode)) {
241                 header.typeflag = DIRTYPE;
242                 strncat(header.name, "/", sizeof(header.name));
243         } else if (S_ISCHR(statbuf->st_mode)) {
244                 header.typeflag = CHRTYPE;
245                 putOctal(header.devmajor, sizeof(header.devmajor),
246                                  major(statbuf->st_rdev));
247                 putOctal(header.devminor, sizeof(header.devminor),
248                                  minor(statbuf->st_rdev));
249         } else if (S_ISBLK(statbuf->st_mode)) {
250                 header.typeflag = BLKTYPE;
251                 putOctal(header.devmajor, sizeof(header.devmajor),
252                                  major(statbuf->st_rdev));
253                 putOctal(header.devminor, sizeof(header.devminor),
254                                  minor(statbuf->st_rdev));
255         } else if (S_ISFIFO(statbuf->st_mode)) {
256                 header.typeflag = FIFOTYPE;
257         } else if (S_ISREG(statbuf->st_mode)) {
258                 header.typeflag = REGTYPE;
259                 putOctal(header.size, sizeof(header.size), statbuf->st_size);
260         } else {
261                 bb_error_msg("%s: Unknown file type", real_name);
262                 return (FALSE);
263         }
264
265         /* Calculate and store the checksum (i.e., the sum of all of the bytes of
266          * the header).  The checksum field must be filled with blanks for the
267          * calculation.  The checksum field is formatted differently from the
268          * other fields: it has [6] digits, a null, then a space -- rather than
269          * digits, followed by a null like the other fields... */
270         memset(header.chksum, ' ', sizeof(header.chksum));
271         cp = (const unsigned char *) &header;
272         while (size-- > 0)
273                 chksum += *cp++;
274         putOctal(header.chksum, 7, chksum);
275
276         /* Now write the header out to disk */
277         if ((size =
278                  bb_full_write(tbInfo->tarFd, (char *) &header,
279                                         sizeof(struct TarHeader))) < 0) {
280                 bb_error_msg(bb_msg_io_error, real_name);
281                 return (FALSE);
282         }
283         /* Pad the header up to the tar block size */
284         for (; size < TAR_BLOCK_SIZE; size++) {
285                 write(tbInfo->tarFd, "\0", 1);
286         }
287         /* Now do the verbose thing (or not) */
288
289         if (tbInfo->verboseFlag) {
290                 FILE *vbFd = stdout;
291
292                 if (tbInfo->tarFd == STDOUT_FILENO)     /* If the archive goes to stdout, verbose to stderr */
293                         vbFd = stderr;
294
295                 fprintf(vbFd, "%s\n", header.name);
296         }
297
298         return (TRUE);
299 }
300
301 # ifdef CONFIG_FEATURE_TAR_FROM
302 static inline int exclude_file(const llist_t *excluded_files, const char *file)
303 {
304         while (excluded_files) {
305                 if (excluded_files->data[0] == '/') {
306                         if (fnmatch(excluded_files->data, file,
307                                                 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
308                                 return 1;
309                 } else {
310                         const char *p;
311
312                         for (p = file; p[0] != '\0'; p++) {
313                                 if ((p == file || p[-1] == '/') && p[0] != '/' &&
314                                         fnmatch(excluded_files->data, p,
315                                                         FNM_PATHNAME | FNM_LEADING_DIR) == 0)
316                                         return 1;
317                         }
318                 }
319                 excluded_files = excluded_files->link;
320         }
321
322         return 0;
323 }
324 # else
325 #define exclude_file(excluded_files, file) 0
326 # endif
327
328 static int writeFileToTarball(const char *fileName, struct stat *statbuf,
329                                                           void *userData)
330 {
331         struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
332         const char *header_name;
333         int inputFileFd = -1;
334
335         /*
336            ** Check to see if we are dealing with a hard link.
337            ** If so -
338            ** Treat the first occurance of a given dev/inode as a file while
339            ** treating any additional occurances as hard links.  This is done
340            ** by adding the file information to the HardLinkInfo linked list.
341          */
342         tbInfo->hlInfo = NULL;
343         if (statbuf->st_nlink > 1) {
344                 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
345                 if (tbInfo->hlInfo == NULL)
346                         addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, fileName);
347         }
348
349         /* It is against the rules to archive a socket */
350         if (S_ISSOCK(statbuf->st_mode)) {
351                 bb_error_msg("%s: socket ignored", fileName);
352                 return (TRUE);
353         }
354
355         /* It is a bad idea to store the archive we are in the process of creating,
356          * so check the device and inode to be sure that this particular file isn't
357          * the new tarball */
358         if (tbInfo->statBuf.st_dev == statbuf->st_dev &&
359                 tbInfo->statBuf.st_ino == statbuf->st_ino) {
360                 bb_error_msg("%s: file is the archive; skipping", fileName);
361                 return (TRUE);
362         }
363
364         header_name = fileName;
365         while (header_name[0] == '/') {
366                 static int alreadyWarned = FALSE;
367
368                 if (alreadyWarned == FALSE) {
369                         bb_error_msg("Removing leading '/' from member names");
370                         alreadyWarned = TRUE;
371                 }
372                 header_name++;
373         }
374
375         if (strlen(fileName) >= NAME_SIZE) {
376                 bb_error_msg(bb_msg_name_longer_than_foo, NAME_SIZE);
377                 return (TRUE);
378         }
379
380         if (header_name[0] == '\0')
381                 return TRUE;
382
383         if (ENABLE_FEATURE_TAR_FROM &&
384                         exclude_file(tbInfo->excludeList, header_name)) {
385                 return SKIP;
386         }
387
388         /* Is this a regular file? */
389         if ((tbInfo->hlInfo == NULL) && (S_ISREG(statbuf->st_mode))) {
390
391                 /* open the file we want to archive, and make sure all is well */
392                 if ((inputFileFd = open(fileName, O_RDONLY)) < 0) {
393                         bb_perror_msg("%s: Cannot open", fileName);
394                         return (FALSE);
395                 }
396         }
397
398         /* Add an entry to the tarball */
399         if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
400                 return (FALSE);
401         }
402
403         /* If it was a regular file, write out the body */
404         if (inputFileFd >= 0 ) {
405                 ssize_t readSize = 0;
406
407                 /* write the file to the archive */
408                 readSize = bb_copyfd_eof(inputFileFd, tbInfo->tarFd);
409                 close(inputFileFd);
410
411                 /* Pad the file up to the tar block size */
412                 for (; (readSize % TAR_BLOCK_SIZE) != 0; readSize++)
413                         write(tbInfo->tarFd, "\0", 1);
414         }
415
416         return (TRUE);
417 }
418
419 static inline int writeTarFile(const int tar_fd, const int verboseFlag,
420         const unsigned long dereferenceFlag, const llist_t *include,
421         const llist_t *exclude, const int gzip)
422 {
423         pid_t gzipPid = 0;
424
425         int errorFlag = FALSE;
426         ssize_t size;
427         struct TarBallInfo tbInfo;
428
429         tbInfo.hlInfoHead = NULL;
430
431         fchmod(tar_fd, 0644);
432         tbInfo.tarFd = tar_fd;
433         tbInfo.verboseFlag = verboseFlag;
434
435         /* Store the stat info for the tarball's file, so
436          * can avoid including the tarball into itself....  */
437         if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
438                 bb_perror_msg_and_die("Couldnt stat tar file");
439
440         if ((ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2) && gzip) {
441                 int gzipDataPipe[2] = { -1, -1 };
442                 int gzipStatusPipe[2] = { -1, -1 };
443                 volatile int vfork_exec_errno = 0;
444                 char *zip_exec = (gzip == 1) ? "gzip" : "bzip2";
445
446
447                 if (pipe(gzipDataPipe) < 0 || pipe(gzipStatusPipe) < 0)
448                         bb_perror_msg_and_die("create pipe");
449
450                 signal(SIGPIPE, SIG_IGN);       /* we only want EPIPE on errors */
451
452 # if __GNUC__
453                         /* Avoid vfork clobbering */
454                         (void) &include;
455                         (void) &errorFlag;
456                         (void) &zip_exec;
457 # endif
458
459                 gzipPid = vfork();
460
461                 if (gzipPid == 0) {
462                         dup2(gzipDataPipe[0], 0);
463                         close(gzipDataPipe[1]);
464
465                         if (tbInfo.tarFd != 1)
466                                 dup2(tbInfo.tarFd, 1);
467
468                         close(gzipStatusPipe[0]);
469                         fcntl(gzipStatusPipe[1], F_SETFD, FD_CLOEXEC);  /* close on exec shows success */
470
471                         execlp(zip_exec, zip_exec, "-f", NULL);
472                         vfork_exec_errno = errno;
473
474                         close(gzipStatusPipe[1]);
475                         exit(-1);
476                 } else if (gzipPid > 0) {
477                         close(gzipDataPipe[0]);
478                         close(gzipStatusPipe[1]);
479
480                         while (1) {
481                                 char buf;
482
483                                 int n = bb_full_read(gzipStatusPipe[0], &buf, 1);
484
485                                 if (n == 0 && vfork_exec_errno != 0) {
486                                         errno = vfork_exec_errno;
487                                         bb_perror_msg_and_die("Could not exec %s", zip_exec);
488                                 } else if ((n < 0) && (errno == EAGAIN || errno == EINTR))
489                                         continue;       /* try it again */
490                                 break;
491                         }
492                         close(gzipStatusPipe[0]);
493
494                         tbInfo.tarFd = gzipDataPipe[1];
495                 } else bb_perror_msg_and_die("vfork gzip");
496         }
497
498         tbInfo.excludeList = exclude;
499
500         /* Read the directory/files and iterate over them one at a time */
501         while (include) {
502                 if (!recursive_action(include->data, TRUE, dereferenceFlag,
503                                 FALSE, writeFileToTarball, writeFileToTarball, &tbInfo))
504                 {
505                         errorFlag = TRUE;
506                 }
507                 include = include->link;
508         }
509         /* Write two empty blocks to the end of the archive */
510         for (size = 0; size < (2 * TAR_BLOCK_SIZE); size++)
511                 write(tbInfo.tarFd, "\0", 1);
512
513         /* To be pedantically correct, we would check if the tarball
514          * is smaller than 20 tar blocks, and pad it if it was smaller,
515          * but that isn't necessary for GNU tar interoperability, and
516          * so is considered a waste of space */
517
518         /* Close so the child process (if any) will exit */
519         close(tbInfo.tarFd);
520
521         /* Hang up the tools, close up shop, head home */
522         if (ENABLE_FEATURE_CLEAN_UP)
523                 freeHardLinkInfo(&tbInfo.hlInfoHead);
524
525         if (errorFlag)
526                 bb_error_msg("Error exit delayed from previous errors");
527
528         if (gzipPid && waitpid(gzipPid, NULL, 0)==-1)
529                 bb_error_msg("Couldnt wait");
530
531         return !errorFlag;
532 }
533 #else
534 int writeTarFile(const int tar_fd, const int verboseFlag,
535         const unsigned long dereferenceFlag, const llist_t *include,
536         const llist_t *exclude, const int gzip);
537 #endif  /* tar_create */
538
539 #ifdef CONFIG_FEATURE_TAR_FROM
540 static llist_t *append_file_list_to_list(llist_t *list)
541 {
542         FILE *src_stream;
543         llist_t *cur = list;
544         llist_t *tmp;
545         char *line;
546         llist_t *newlist = NULL;
547
548         while (cur) {
549                 src_stream = bb_xfopen(cur->data, "r");
550                 tmp = cur;
551                 cur = cur->link;
552                 free(tmp);
553                 while ((line = bb_get_chomped_line_from_file(src_stream)) != NULL)
554                                 newlist = llist_add_to(newlist, line);
555                 fclose(src_stream);
556         }
557         return newlist;
558 }
559 #else
560 #define append_file_list_to_list(x)     0
561 #endif
562
563 #ifdef CONFIG_FEATURE_TAR_COMPRESS
564 static char get_header_tar_Z(archive_handle_t *archive_handle)
565 {
566         /* Cant lseek over pipe's */
567         archive_handle->seek = seek_by_char;
568
569         /* do the decompression, and cleanup */
570         if (bb_xread_char(archive_handle->src_fd) != 0x1f ||
571                 bb_xread_char(archive_handle->src_fd) != 0x9d)
572         {
573                 bb_error_msg_and_die("Invalid magic");
574         }
575
576         archive_handle->src_fd = open_transformer(archive_handle->src_fd, uncompress);
577         archive_handle->offset = 0;
578         while (get_header_tar(archive_handle) == EXIT_SUCCESS);
579
580         /* Can only do one file at a time */
581         return(EXIT_FAILURE);
582 }
583 #else
584 #define get_header_tar_Z        0
585 #endif
586
587 #define CTX_TEST                          (1 << 0)
588 #define CTX_EXTRACT                       (1 << 1)
589 #define TAR_OPT_BASEDIR                   (1 << 2)
590 #define TAR_OPT_TARNAME                   (1 << 3)
591 #define TAR_OPT_2STDOUT                   (1 << 4)
592 #define TAR_OPT_P                         (1 << 5)
593 #define TAR_OPT_VERBOSE                   (1 << 6)
594 #define TAR_OPT_KEEP_OLD                  (1 << 7)
595
596 #define TAR_OPT_AFTER_START               8
597
598 #define CTX_CREATE                        (1 << (TAR_OPT_AFTER_START))
599 #define TAR_OPT_DEREFERENCE               (1 << (TAR_OPT_AFTER_START + 1))
600 #ifdef CONFIG_FEATURE_TAR_CREATE
601 # define TAR_OPT_STR_CREATE               "ch"
602 # define TAR_OPT_AFTER_CREATE             TAR_OPT_AFTER_START + 2
603 #else
604 # define TAR_OPT_STR_CREATE               ""
605 # define TAR_OPT_AFTER_CREATE             TAR_OPT_AFTER_START
606 #endif
607
608 #define TAR_OPT_BZIP2                     (1 << (TAR_OPT_AFTER_CREATE))
609 #ifdef CONFIG_FEATURE_TAR_BZIP2
610 # define TAR_OPT_STR_BZIP2                "j"
611 # define TAR_OPT_AFTER_BZIP2              TAR_OPT_AFTER_CREATE + 1
612 #else
613 # define TAR_OPT_STR_BZIP2                ""
614 # define TAR_OPT_AFTER_BZIP2              TAR_OPT_AFTER_CREATE
615 #endif
616
617 #define TAR_OPT_LZMA                      (1 << (TAR_OPT_AFTER_BZIP2))
618 #ifdef CONFIG_FEATURE_TAR_LZMA
619 # define TAR_OPT_STR_LZMA                 "a"
620 # define TAR_OPT_AFTER_LZMA               TAR_OPT_AFTER_BZIP2 + 1
621 #else
622 # define TAR_OPT_STR_LZMA                 ""
623 # define TAR_OPT_AFTER_LZMA               TAR_OPT_AFTER_BZIP2
624 #endif
625
626 #define TAR_OPT_INCLUDE_FROM              (1 << (TAR_OPT_AFTER_LZMA))
627 #define TAR_OPT_EXCLUDE_FROM              (1 << (TAR_OPT_AFTER_LZMA + 1))
628 #ifdef CONFIG_FEATURE_TAR_FROM
629 # define TAR_OPT_STR_FROM                 "T:X:"
630 # define TAR_OPT_AFTER_FROM               TAR_OPT_AFTER_LZMA + 2
631 #else
632 # define TAR_OPT_STR_FROM                 ""
633 # define TAR_OPT_AFTER_FROM               TAR_OPT_AFTER_LZMA
634 #endif
635
636 #define TAR_OPT_GZIP                      (1 << (TAR_OPT_AFTER_FROM))
637 #ifdef CONFIG_FEATURE_TAR_GZIP
638 # define TAR_OPT_STR_GZIP                 "z"
639 # define TAR_OPT_AFTER_GZIP               TAR_OPT_AFTER_FROM + 1
640 #else
641 # define TAR_OPT_STR_GZIP                 ""
642 # define TAR_OPT_AFTER_GZIP               TAR_OPT_AFTER_FROM
643 #endif
644
645 #define TAR_OPT_UNCOMPRESS                (1 << (TAR_OPT_AFTER_GZIP))
646 #ifdef CONFIG_FEATURE_TAR_COMPRESS
647 # define TAR_OPT_STR_COMPRESS             "Z"
648 # define TAR_OPT_AFTER_COMPRESS           TAR_OPT_AFTER_GZIP + 1
649 #else
650 # define TAR_OPT_STR_COMPRESS             ""
651 # define TAR_OPT_AFTER_COMPRESS           TAR_OPT_AFTER_GZIP
652 #endif
653
654 #define TAR_OPT_NOPRESERVE_OWN            (1 << (TAR_OPT_AFTER_COMPRESS))
655 #define TAR_OPT_NOPRESERVE_PERM           (1 << (TAR_OPT_AFTER_COMPRESS + 1))
656 #define TAR_OPT_STR_NOPRESERVE            "\203\213"
657 #define TAR_OPT_AFTER_NOPRESERVE          TAR_OPT_AFTER_COMPRESS + 2
658
659 static const char tar_options[]="txC:f:Opvk" \
660         TAR_OPT_STR_CREATE \
661         TAR_OPT_STR_BZIP2 \
662         TAR_OPT_STR_LZMA \
663         TAR_OPT_STR_FROM \
664         TAR_OPT_STR_GZIP \
665         TAR_OPT_STR_COMPRESS \
666         TAR_OPT_STR_NOPRESERVE;
667
668 #ifdef CONFIG_FEATURE_TAR_LONG_OPTIONS
669 static const struct option tar_long_options[] = {
670         { "list",                               0,      NULL,   't' },
671         { "extract",                    0,      NULL,   'x' },
672         { "directory",                  1,      NULL,   'C' },
673         { "file",                               1,      NULL,   'f' },
674         { "to-stdout",                  0,      NULL,   'O' },
675         { "same-permissions",   0,      NULL,   'p' },
676         { "verbose",                    0,      NULL,   'v' },
677         { "keep-old",                   0,      NULL,   'k' },
678         { "no-same-owner",              0,      NULL,   '\203' },
679         { "no-same-permissions",0,      NULL,   '\213' },
680 # ifdef CONFIG_FEATURE_TAR_CREATE
681         { "create",                             0,      NULL,   'c' },
682         { "dereference",                0,      NULL,   'h' },
683 # endif
684 # ifdef CONFIG_FEATURE_TAR_BZIP2
685         { "bzip2",                              0,      NULL,   'j' },
686 # endif
687 # ifdef CONFIG_FEATURE_TAR_LZMA
688         { "lzma",                               0,      NULL,   'a' },
689 # endif
690 # ifdef CONFIG_FEATURE_TAR_FROM
691         { "files-from",                 1,      NULL,   'T' },
692         { "exclude-from",               1,      NULL,   'X' },
693         { "exclude",                    1,      NULL,   '\n' },
694 # endif
695 # ifdef CONFIG_FEATURE_TAR_GZIP
696         { "gzip",                               0,      NULL,   'z' },
697 # endif
698 # ifdef CONFIG_FEATURE_TAR_COMPRESS
699         { "compress",                   0,      NULL,   'Z' },
700 # endif
701         { 0,                                    0, 0, 0 }
702 };
703 #else
704 #define tar_long_options        0
705 #endif
706
707 int tar_main(int argc, char **argv)
708 {
709         char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
710         archive_handle_t *tar_handle;
711         char *base_dir = NULL;
712         const char *tar_filename = "-";
713         unsigned long opt;
714         llist_t *excludes = NULL;
715
716         /* Initialise default values */
717         tar_handle = init_handle();
718         tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS | ARCHIVE_PRESERVE_DATE | ARCHIVE_EXTRACT_UNCONDITIONAL;
719
720         /* Prepend '-' to the first argument if required */
721         bb_opt_complementally = ENABLE_FEATURE_TAR_CREATE ?
722                 "--:X::T::\n::c:t:x:?:c--tx:t--cx:x--ct" :
723                 "--:X::T::\n::t:x:?:t--x:x--t";
724         if (ENABLE_FEATURE_TAR_LONG_OPTIONS)
725                 bb_applet_long_options = tar_long_options;
726         opt = bb_getopt_ulflags(argc, argv, tar_options,
727                                 &base_dir,      /* Change to dir <optarg> */
728                                 &tar_filename /* archive filename */
729 #ifdef CONFIG_FEATURE_TAR_FROM
730                                 , &(tar_handle->accept),
731                                 &(tar_handle->reject),
732                                 &excludes
733 #endif
734                                 );
735
736         if (opt & CTX_TEST) {
737                 if ((tar_handle->action_header == header_list) ||
738                         (tar_handle->action_header == header_verbose_list))
739                 {
740                                 tar_handle->action_header = header_verbose_list;
741                 } else tar_handle->action_header = header_list;
742         }
743         if((opt & CTX_EXTRACT) && tar_handle->action_data != data_extract_to_stdout)
744                 tar_handle->action_data = data_extract_all;
745
746         if (opt & TAR_OPT_2STDOUT)
747                 tar_handle->action_data = data_extract_to_stdout;
748
749         if (opt & TAR_OPT_VERBOSE) {
750                 if ((tar_handle->action_header == header_list) ||
751                         (tar_handle->action_header == header_verbose_list))
752                 {
753                         tar_handle->action_header = header_verbose_list;
754                 } else
755                         tar_handle->action_header = header_list;
756         }
757         if (opt & TAR_OPT_KEEP_OLD)
758                 tar_handle->flags &= ~ARCHIVE_EXTRACT_UNCONDITIONAL;
759
760         if (opt & TAR_OPT_NOPRESERVE_OWN)
761                 tar_handle->flags |= ARCHIVE_NOPRESERVE_OWN;
762
763         if (opt & TAR_OPT_NOPRESERVE_PERM)
764                 tar_handle->flags |= ARCHIVE_NOPRESERVE_PERM;
765
766         if (ENABLE_FEATURE_TAR_GZIP && (opt & TAR_OPT_GZIP))
767                 get_header_ptr = get_header_tar_gz;
768
769         if (ENABLE_FEATURE_TAR_BZIP2 && (opt & TAR_OPT_BZIP2))
770                 get_header_ptr = get_header_tar_bz2;
771
772         if (ENABLE_FEATURE_TAR_LZMA && (opt & TAR_OPT_LZMA))
773                 get_header_ptr = get_header_tar_lzma;
774
775         if (ENABLE_FEATURE_TAR_COMPRESS && (opt & TAR_OPT_UNCOMPRESS))
776                 get_header_ptr = get_header_tar_Z;
777
778         if (ENABLE_FEATURE_TAR_FROM) {
779                 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
780                 /* Append excludes to reject */
781                 while (excludes) {
782                         llist_t *temp = excludes->link;
783                         excludes->link = tar_handle->reject;
784                         tar_handle->reject = excludes;
785                         excludes = temp;
786                 }
787                 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
788         }
789
790         /* Check if we are reading from stdin */
791         if (argv[optind] && *argv[optind] == '-') {
792                 /* Default is to read from stdin, so just skip to next arg */
793                 optind++;
794         }
795
796         /* Setup an array of filenames to work with */
797         /* TODO: This is the same as in ar, separate function ? */
798         while (optind < argc) {
799                 char *filename_ptr = last_char_is(argv[optind], '/');
800                 if (filename_ptr > argv[optind])
801                         *filename_ptr = '\0';
802
803                 tar_handle->accept = llist_add_to(tar_handle->accept, argv[optind]);
804                 optind++;
805         }
806
807         if ((tar_handle->accept) || (tar_handle->reject))
808                 tar_handle->filter = filter_accept_reject_list;
809
810         /* Open the tar file */
811         {
812                 FILE *tar_stream;
813                 int flags;
814
815                 if (ENABLE_FEATURE_TAR_CREATE && (opt & CTX_CREATE)) {
816                         /* Make sure there is at least one file to tar up.  */
817                         if (tar_handle->accept == NULL)
818                                 bb_error_msg_and_die("empty archive");
819
820                         tar_stream = stdout;
821                         flags = O_WRONLY | O_CREAT | O_EXCL;
822                         unlink(tar_filename);
823                 } else {
824                         tar_stream = stdin;
825                         flags = O_RDONLY;
826                 }
827
828                 if ((tar_filename[0] == '-') && (tar_filename[1] == '\0')) {
829                         tar_handle->src_fd = fileno(tar_stream);
830                         tar_handle->seek = seek_by_char;
831                 } else {
832                         tar_handle->src_fd = bb_xopen(tar_filename, flags);
833                 }
834         }
835
836         if (base_dir)
837                 bb_xchdir(base_dir);
838
839         /* create an archive */
840         if (ENABLE_FEATURE_TAR_CREATE && (opt & CTX_CREATE)) {
841                 int verboseFlag = FALSE;
842                 int zipMode = 0;
843
844                 if (ENABLE_FEATURE_TAR_GZIP && get_header_ptr == get_header_tar_gz)
845                         zipMode = 1;
846                 if (ENABLE_FEATURE_TAR_BZIP2 && get_header_ptr == get_header_tar_bz2)
847                         zipMode = 2;
848
849                 if ((tar_handle->action_header == header_list) ||
850                                 (tar_handle->action_header == header_verbose_list))
851                 {
852                         verboseFlag = TRUE;
853                 }
854                 writeTarFile(tar_handle->src_fd, verboseFlag, opt & TAR_OPT_DEREFERENCE,
855                                 tar_handle->accept,
856                         tar_handle->reject, zipMode);
857         } else {
858                 while (get_header_ptr(tar_handle) == EXIT_SUCCESS);
859
860                 /* Check that every file that should have been extracted was */
861                 while (tar_handle->accept) {
862                         if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
863                                 && !find_list_entry(tar_handle->passed, tar_handle->accept->data))
864                         {
865                                 bb_error_msg_and_die("%s: Not found in archive", tar_handle->accept->data);
866                         }
867                         tar_handle->accept = tar_handle->accept->link;
868                 }
869         }
870
871         if (ENABLE_FEATURE_CLEAN_UP && tar_handle->src_fd != STDIN_FILENO)
872                 close(tar_handle->src_fd);
873
874         return(EXIT_SUCCESS);
875 }