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