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