archival/tar.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini tar implementation for busybox
   4  *
   5  * Note, that as of BusyBox-0.43, tar has been completely rewritten from the
   6  * ground up.  It still has remnents of the old code lying about, but it is
   7  * very different now (i.e. cleaner, less global variables, etc)
   8  *
   9  * Copyright (C) 1999,2000,2001 by Lineo, inc.
  10  * Written by Erik Andersen <andersen@lineo.com>, <andersee@debian.org>
  11  *
  12  * Based in part in the tar implementation in sash
  13  *  Copyright (c) 1999 by David I. Bell
  14  *  Permission is granted to use, distribute, or modify this source,
  15  *  provided that this copyright notice remains intact.
  16  *  Permission to distribute sash derived code under the GPL has been granted.
  17  *
  18  * Based in part on the tar implementation from busybox-0.28
  19  *  Copyright (C) 1995 Bruce Perens
  20  *  This is free software under the GNU General Public License.
  21  *
  22  * This program is free software; you can redistribute it and/or modify
  23  * it under the terms of the GNU General Public License as published by
  24  * the Free Software Foundation; either version 2 of the License, or
  25  * (at your option) any later version.
  26  *
  27  * This program is distributed in the hope that it will be useful,
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  30  * General Public License for more details.
  31  *
  32  * You should have received a copy of the GNU General Public License
  33  * along with this program; if not, write to the Free Software
  34  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  35  *
  36  */
  37
  38
  39 #include <stdio.h>
  40 #include <dirent.h>
  41 #include <errno.h>
  42 #include <fcntl.h>
  43 #include <signal.h>
  44 #include <time.h>
  45 #include <utime.h>
  46 #include <sys/types.h>
  47 #include <sys/sysmacros.h>
  48 #include <getopt.h>
  49 #include <fnmatch.h>
  50 #include <string.h>
  51 #include <stdlib.h>
  52 #include <unistd.h>
  53 #include "busybox.h"
  54
  55 /* Tar file constants  */
  56 #ifndef MAJOR
  57 #define MAJOR(dev) (((dev)>>8)&0xff)
  58 #define MINOR(dev) ((dev)&0xff)
  59 #endif
  60
  61 enum { NAME_SIZE = 100 }; /* because gcc won't let me use 'static const int' */
  62
  63 /* POSIX tar Header Block, from POSIX 1003.1-1990  */
  64 struct TarHeader
  65 {
  66                                 /* byte offset */
  67         char name[NAME_SIZE];         /*   0-99 */
  68         char mode[8];                 /* 100-107 */
  69         char uid[8];                  /* 108-115 */
  70         char gid[8];                  /* 116-123 */
  71         char size[12];                /* 124-135 */
  72         char mtime[12];               /* 136-147 */
  73         char chksum[8];               /* 148-155 */
  74         char typeflag;                /* 156-156 */
  75         char linkname[NAME_SIZE];     /* 157-256 */
  76         char magic[6];                /* 257-262 */
  77         char version[2];              /* 263-264 */
  78         char uname[32];               /* 265-296 */
  79         char gname[32];               /* 297-328 */
  80         char devmajor[8];             /* 329-336 */
  81         char devminor[8];             /* 337-344 */
  82         char prefix[155];             /* 345-499 */
  83         char padding[12];             /* 500-512 (pad to exactly the TAR_BLOCK_SIZE) */
  84 };
  85 typedef struct TarHeader TarHeader;
  86
  87
  88 /* A few useful constants */
  89 #define TAR_MAGIC          "ustar"        /* ustar and a null */
  90 #define TAR_VERSION        "  "           /* Be compatable with GNU tar format */
  91 static const int TAR_MAGIC_LEN = 6;
  92 static const int TAR_VERSION_LEN = 2;
  93 static const int TAR_BLOCK_SIZE = 512;
  94
  95 /* A nice enum with all the possible tar file content types */
  96 enum TarFileType
  97 {
  98         REGTYPE  = '0',            /* regular file */
  99         REGTYPE0 = '\0',           /* regular file (ancient bug compat)*/
 100         LNKTYPE  = '1',            /* hard link */
 101         SYMTYPE  = '2',            /* symbolic link */
 102         CHRTYPE  = '3',            /* character special */
 103         BLKTYPE  = '4',            /* block special */
 104         DIRTYPE  = '5',            /* directory */
 105         FIFOTYPE = '6',            /* FIFO special */
 106         CONTTYPE = '7',            /* reserved */
 107         GNULONGLINK = 'K',         /* GNU long (>100 chars) link name */
 108         GNULONGNAME = 'L',         /* GNU long (>100 chars) file name */
 109 };
 110 typedef enum TarFileType TarFileType;
 111
 112 /* This struct ignores magic, non-numeric user name,
 113  * non-numeric group name, and the checksum, since
 114  * these are all ignored by BusyBox tar. */
 115 struct TarInfo
 116 {
 117         int              tarFd;          /* An open file descriptor for reading from the tarball */
 118         char *           name;           /* File name */
 119         mode_t           mode;           /* Unix mode, including device bits. */
 120         uid_t            uid;            /* Numeric UID */
 121         gid_t            gid;            /* Numeric GID */
 122         size_t           size;           /* Size of file */
 123         time_t           mtime;          /* Last-modified time */
 124         enum TarFileType type;           /* Regular, directory, link, etc */
 125         char *           linkname;       /* Name for symbolic and hard links */
 126         long             devmajor;       /* Major number for special device */
 127         long             devminor;       /* Minor number for special device */
 128 };
 129 typedef struct TarInfo TarInfo;
 130
 131 /* Local procedures to restore files from a tar file.  */
 132 static int readTarFile(int tarFd, int extractFlag, int listFlag,
 133                 int tostdoutFlag, int verboseFlag, char** extractList,
 134                 char** excludeList);
 135
 136 #ifdef BB_FEATURE_TAR_CREATE
 137 /* Local procedures to save files into a tar file.  */
 138 static int writeTarFile(const char* tarName, int verboseFlag, char **argv,
 139                 char** excludeList);
 140 #endif
 141
 142 #if defined BB_FEATURE_TAR_EXCLUDE
 143 static struct option longopts[] = {
 144         { "exclude", 1, NULL, 'e' },
 145         { NULL, 0, NULL, 0 }
 146 };
 147 #endif
 148
 149 extern int tar_main(int argc, char **argv)
 150 {
 151         char** excludeList=NULL;
 152         char** extractList=NULL;
 153         const char *tarName="-";
 154 #if defined BB_FEATURE_TAR_EXCLUDE
 155         int excludeListSize=0;
 156         FILE *fileList;
 157         char file[256];
 158 #endif
 159 #if defined BB_FEATURE_TAR_GZIP
 160         FILE *comp_file = NULL;
 161         int unzipFlag    = FALSE;
 162 #endif
 163         int listFlag     = FALSE;
 164         int extractFlag  = FALSE;
 165         int createFlag   = FALSE;
 166         int verboseFlag  = FALSE;
 167         int tostdoutFlag = FALSE;
 168         int status       = FALSE;
 169         int opt;
 170         pid_t pid;
 171
 172         if (argc <= 1)
 173                 show_usage();
 174
 175         if (argv[1][0] != '-') {
 176                 char *tmp = xmalloc(strlen(argv[1]) + 2);
 177                 tmp[0] = '-';
 178                 strcpy(tmp + 1, argv[1]);
 179                 argv[1] = tmp;
 180         }
 181
 182         while (
 183 #ifndef BB_FEATURE_TAR_EXCLUDE
 184                         (opt = getopt(argc, argv, "cxtzvOf:"))
 185 #else
 186                         (opt = getopt_long(argc, argv, "cxtzvOf:X:", longopts, NULL))
 187 #endif
 188                         > 0) {
 189                 switch (opt) {
 190                         case 'c':
 191                                 if (extractFlag == TRUE || listFlag == TRUE)
 192                                         goto flagError;
 193                                 createFlag = TRUE;
 194                                 break;
 195                         case 'x':
 196                                 if (listFlag == TRUE || createFlag == TRUE)
 197                                         goto flagError;
 198                                 extractFlag = TRUE;
 199                                 break;
 200                         case 't':
 201                                 if (extractFlag == TRUE || createFlag == TRUE)
 202                                         goto flagError;
 203                                 listFlag = TRUE;
 204                                 break;
 205 #ifdef BB_FEATURE_TAR_GZIP
 206                         case 'z':
 207                                 unzipFlag = TRUE;
 208                                 break;
 209 #endif
 210                         case 'v':
 211                                 verboseFlag = TRUE;
 212                                 break;
 213                         case 'O':
 214                                 tostdoutFlag = TRUE;
 215                                 break;
 216                         case 'f':
 217                                 if (*tarName != '-')
 218                                         error_msg_and_die( "Only one 'f' option allowed");
 219                                 tarName = optarg;
 220                                 break;
 221 #if defined BB_FEATURE_TAR_EXCLUDE
 222                         case 'e':
 223                                 excludeList=xrealloc( excludeList,
 224                                                 sizeof(char *) * (excludeListSize+2));
 225                                 excludeList[excludeListSize] = optarg;
 226                                 /* Tack a NULL onto the end of the list */
 227                                 excludeList[++excludeListSize] = NULL;
 228                         case 'X':
 229                                 fileList = xfopen(optarg, "r");
 230                                 while (fgets(file, sizeof(file), fileList) != NULL) {
 231                                         excludeList = xrealloc(excludeList,
 232                                                         sizeof(char *) * (excludeListSize+2));
 233                                         chomp(file);
 234                                         excludeList[excludeListSize] = xstrdup(file);
 235                                         /* Tack a NULL onto the end of the list */
 236                                         excludeList[++excludeListSize] = NULL;
 237                                 }
 238                                 fclose(fileList);
 239                                 break;
 240 #endif
 241                                 default:
 242                                         show_usage();
 243                 }
 244         }
 245
 246         /*
 247          * Do the correct type of action supplying the rest of the
 248          * command line arguments as the list of files to process.
 249          */
 250         if (createFlag == TRUE) {
 251 #ifndef BB_FEATURE_TAR_CREATE
 252                 error_msg_and_die( "This version of tar was not compiled with tar creation support.");
 253 #else
 254 #ifdef BB_FEATURE_TAR_GZIP
 255                 if (unzipFlag==TRUE)
 256                         error_msg_and_die("Creation of compressed not internally support by tar, pipe to busybox gunzip");
 257 #endif
 258                 status = writeTarFile(tarName, verboseFlag, argv + optind, excludeList);
 259 #endif
 260         }
 261         if (listFlag == TRUE || extractFlag == TRUE) {
 262                 int tarFd;
 263                 if (argv[optind])
 264                         extractList = argv + optind;
 265                 /* Open the tar file for reading.  */
 266                 if (!strcmp(tarName, "-"))
 267                         tarFd = fileno(stdin);
 268                 else
 269                         tarFd = open(tarName, O_RDONLY);
 270                 if (tarFd < 0)
 271                         perror_msg_and_die("Error opening '%s'", tarName);
 272
 273 #ifdef BB_FEATURE_TAR_GZIP
 274                 /* unzip tarFd in a seperate process */
 275                 if (unzipFlag == TRUE) {
 276                         comp_file = fdopen(tarFd, "r");
 277                         if ((tarFd = gz_open(comp_file, &pid)) == EXIT_FAILURE) {
 278                                 error_msg_and_die("Couldnt unzip file");
 279                         }
 280                 }
 281 #endif
 282                 status = readTarFile(tarFd, extractFlag, listFlag, tostdoutFlag,
 283                                         verboseFlag, extractList, excludeList);
 284                 close(tarFd);
 285 #ifdef BB_FEATURE_TAR_GZIP
 286                 if (unzipFlag == TRUE) {
 287                         gz_close(pid);
 288                         fclose(comp_file);
 289                 }
 290 #endif
 291         }
 292
 293         if (status == TRUE)
 294                 return EXIT_SUCCESS;
 295         else
 296                 return EXIT_FAILURE;
 297
 298   flagError:
 299         error_msg_and_die( "Exactly one of 'c', 'x' or 't' must be specified");
 300 }
 301
 302 static void
 303 fixUpPermissions(TarInfo *header)
 304 {
 305         struct utimbuf t;
 306         /* Now set permissions etc for the new file */
 307         chown(header->name, header->uid, header->gid);
 308         chmod(header->name, header->mode);
 309         /* Reset the time */
 310         t.actime = time(0);
 311         t.modtime = header->mtime;
 312         utime(header->name, &t);
 313 }
 314
 315 static int
 316 tarExtractRegularFile(TarInfo *header, int extractFlag, int tostdoutFlag)
 317 {
 318         size_t  writeSize;
 319         size_t  readSize;
 320         size_t  actualWriteSz;
 321         char    buffer[BUFSIZ];
 322         size_t  size = header->size;
 323         int outFd=fileno(stdout);
 324
 325         /* Open the file to be written, if a file is supposed to be written */
 326         if (extractFlag==TRUE && tostdoutFlag==FALSE) {
 327                 /* Create the path to the file, just in case it isn't there...
 328                  * This should not screw up path permissions or anything. */
 329                 create_path(header->name, 0777);
 330                 if ((outFd=open(header->name, O_CREAT|O_TRUNC|O_WRONLY,
 331                                                 header->mode & ~S_IFMT)) < 0) {
 332                         error_msg(io_error, header->name, strerror(errno));
 333                         return( FALSE);
 334                 }
 335         }
 336
 337         /* Write out the file, if we are supposed to be doing that */
 338         while ( size > 0 ) {
 339                 actualWriteSz=0;
 340                 if ( size > sizeof(buffer) )
 341                         writeSize = readSize = sizeof(buffer);
 342                 else {
 343                         int mod = size % 512;
 344                         if ( mod != 0 )
 345                                 readSize = size + (512 - mod);
 346                         else
 347                                 readSize = size;
 348                         writeSize = size;
 349                 }
 350                 if ( (readSize = full_read(header->tarFd, buffer, readSize)) <= 0 ) {
 351                         /* Tarball seems to have a problem */
 352                         error_msg("Unexpected EOF in archive");
 353                         return( FALSE);
 354                 }
 355                 if ( readSize < writeSize )
 356                         writeSize = readSize;
 357
 358                 /* Write out the file, if we are supposed to be doing that */
 359                 if (extractFlag==TRUE) {
 360
 361                         if ((actualWriteSz=full_write(outFd, buffer, writeSize)) != writeSize ) {
 362                                 /* Output file seems to have a problem */
 363                                 error_msg(io_error, header->name, strerror(errno));
 364                                 return( FALSE);
 365                         }
 366                 } else {
 367                         actualWriteSz=writeSize;
 368                 }
 369
 370                 size -= actualWriteSz;
 371         }
 372
 373         /* Now we are done writing the file out, so try
 374          * and fix up the permissions and whatnot */
 375         if (extractFlag==TRUE && tostdoutFlag==FALSE) {
 376                 close(outFd);
 377                 fixUpPermissions(header);
 378         }
 379         return( TRUE);
 380 }
 381
 382 static int
 383 tarExtractDirectory(TarInfo *header, int extractFlag, int tostdoutFlag)
 384 {
 385
 386         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 387                 return( TRUE);
 388
 389         if (create_path(header->name, header->mode) != TRUE) {
 390                 perror_msg("%s: Cannot mkdir", header->name);
 391                 return( FALSE);
 392         }
 393         /* make the final component, just in case it was
 394          * omitted by create_path() (which will skip the
 395          * directory if it doesn't have a terminating '/') */
 396         if (mkdir(header->name, header->mode) < 0 && errno != EEXIST) {
 397                 perror_msg("%s", header->name);
 398                 return FALSE;
 399         }
 400
 401         fixUpPermissions(header);
 402         return( TRUE);
 403 }
 404
 405 static int
 406 tarExtractHardLink(TarInfo *header, int extractFlag, int tostdoutFlag)
 407 {
 408         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 409                 return( TRUE);
 410
 411         if (link(header->linkname, header->name) < 0) {
 412                 perror_msg("%s: Cannot create hard link to '%s'", header->name,
 413                                 header->linkname);
 414                 return( FALSE);
 415         }
 416
 417         /* Now set permissions etc for the new directory */
 418         fixUpPermissions(header);
 419         return( TRUE);
 420 }
 421
 422 static int
 423 tarExtractSymLink(TarInfo *header, int extractFlag, int tostdoutFlag)
 424 {
 425         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 426                 return( TRUE);
 427
 428 #ifdef  S_ISLNK
 429         if (symlink(header->linkname, header->name) < 0) {
 430                 perror_msg("%s: Cannot create symlink to '%s'", header->name,
 431                                 header->linkname);
 432                 return( FALSE);
 433         }
 434         /* Try to change ownership of the symlink.
 435          * If libs doesn't support that, don't bother.
 436          * Changing the pointed-to-file is the Wrong Thing(tm).
 437          */
 438 #if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1)
 439         lchown(header->name, header->uid, header->gid);
 440 #endif
 441
 442         /* Do not change permissions or date on symlink,
 443          * since it changes the pointed to file instead.  duh. */
 444 #else
 445         error_msg("%s: Cannot create symlink to '%s': %s",
 446                         header->name, header->linkname,
 447                         "symlinks not supported");
 448 #endif
 449         return( TRUE);
 450 }
 451
 452 static int
 453 tarExtractSpecial(TarInfo *header, int extractFlag, int tostdoutFlag)
 454 {
 455         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 456                 return( TRUE);
 457
 458         if (S_ISCHR(header->mode) || S_ISBLK(header->mode) || S_ISSOCK(header->mode)) {
 459                 if (mknod(header->name, header->mode, makedev(header->devmajor, header->devminor)) < 0) {
 460                         perror_msg("%s: Cannot mknod", header->name);
 461                         return( FALSE);
 462                 }
 463         } else if (S_ISFIFO(header->mode)) {
 464                 if (mkfifo(header->name, header->mode) < 0) {
 465                         perror_msg("%s: Cannot mkfifo", header->name);
 466                         return( FALSE);
 467                 }
 468         }
 469
 470         /* Now set permissions etc for the new directory */
 471         fixUpPermissions(header);
 472         return( TRUE);
 473 }
 474
 475 /* Parse the tar header and fill in the nice struct with the details */
 476 static int
 477 readTarHeader(struct TarHeader *rawHeader, struct TarInfo *header)
 478 {
 479         int i;
 480         long chksum, sum=0;
 481         unsigned char *s = (unsigned char *)rawHeader;
 482
 483         header->name  = rawHeader->name;
 484         /* Check for and relativify any absolute paths */
 485         if ( *(header->name) == '/' ) {
 486                 static int alreadyWarned=FALSE;
 487
 488                 while (*(header->name) == '/')
 489                         ++*(header->name);
 490
 491                 if (alreadyWarned == FALSE) {
 492                         error_msg("Removing leading '/' from member names");
 493                         alreadyWarned = TRUE;
 494                 }
 495         }
 496
 497         header->mode  = strtol(rawHeader->mode, NULL, 8);
 498         header->uid   = strtol(rawHeader->uid, NULL, 8);
 499         header->gid   = strtol(rawHeader->gid, NULL, 8);
 500         header->size  = strtol(rawHeader->size, NULL, 8);
 501         header->mtime = strtol(rawHeader->mtime, NULL, 8);
 502         chksum = strtol(rawHeader->chksum, NULL, 8);
 503         header->type  = rawHeader->typeflag;
 504         header->linkname  = rawHeader->linkname;
 505         header->devmajor  = strtol(rawHeader->devmajor, NULL, 8);
 506         header->devminor  = strtol(rawHeader->devminor, NULL, 8);
 507
 508         /* Check the checksum */
 509         for (i = sizeof(*rawHeader); i-- != 0;) {
 510                 sum += *s++;
 511         }
 512         /* Remove the effects of the checksum field (replace
 513          * with blanks for the purposes of the checksum) */
 514         s = rawHeader->chksum;
 515         for (i = sizeof(rawHeader->chksum) ; i-- != 0;) {
 516                 sum -= *s++;
 517         }
 518         sum += ' ' * sizeof(rawHeader->chksum);
 519         if (sum == chksum )
 520                 return ( TRUE);
 521         return( FALSE);
 522 }
 523
 524 static int exclude_file(char **excluded_files, const char *file)
 525 {
 526         int i;
 527
 528         if (excluded_files == NULL)
 529                 return 0;
 530
 531         for (i = 0; excluded_files[i] != NULL; i++) {
 532                 if (excluded_files[i][0] == '/') {
 533                         if (fnmatch(excluded_files[i], file,
 534                                                 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
 535                                 return 1;
 536                 } else {
 537                         const char *p;
 538
 539                         for (p = file; p[0] != '\0'; p++) {
 540                                 if ((p == file || p[-1] == '/') && p[0] != '/' &&
 541                                                 fnmatch(excluded_files[i], p,
 542                                                         FNM_PATHNAME | FNM_LEADING_DIR) == 0)
 543                                         return 1;
 544                         }
 545                 }
 546         }
 547
 548         return 0;
 549 }
 550
 551 static int extract_file(char **extract_files, const char *file)
 552 {
 553         int i;
 554
 555         if (extract_files == NULL)
 556                 return 1;
 557
 558         for (i = 0; extract_files[i] != NULL; i++) {
 559                 if (fnmatch(extract_files[i], file, FNM_LEADING_DIR) == 0)
 560                         return 1;
 561         }
 562
 563         return 0;
 564 }
 565
 566 /*
 567  * Read a tar file and extract or list the specified files within it.
 568  * If the list is empty than all files are extracted or listed.
 569  */
 570 static int readTarFile(int tarFd, int extractFlag, int listFlag,
 571                 int tostdoutFlag, int verboseFlag, char** extractList,
 572                 char** excludeList)
 573 {
 574         int status;
 575         int errorFlag=FALSE;
 576         int skipNextHeaderFlag=FALSE;
 577         TarHeader rawHeader;
 578         TarInfo header;
 579
 580         /* Set the umask for this process so it doesn't
 581          * screw up permission setting for us later. */
 582         umask(0);
 583
 584         /* Read the tar file, and iterate over it one file at a time */
 585         while ( (status = full_read(tarFd, (char*)&rawHeader, TAR_BLOCK_SIZE)) == TAR_BLOCK_SIZE ) {
 586
 587                 /* Try to read the header */
 588                 if ( readTarHeader(&rawHeader, &header) == FALSE ) {
 589                         if ( *(header.name) == '\0' ) {
 590                                 goto endgame;
 591                         } else {
 592                                 errorFlag=TRUE;
 593                                 error_msg("Bad tar header, skipping");
 594                                 continue;
 595                         }
 596                 }
 597                 if ( *(header.name) == '\0' )
 598                         continue;
 599                 header.tarFd = tarFd;
 600
 601                 /* Skip funky extra GNU headers that precede long files */
 602                 if ( (header.type == GNULONGNAME) || (header.type == GNULONGLINK) ) {
 603                         skipNextHeaderFlag=TRUE;
 604                         if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 605                                 errorFlag = TRUE;
 606                         continue;
 607                 }
 608                 if ( skipNextHeaderFlag == TRUE ) {
 609                         skipNextHeaderFlag=FALSE;
 610                         error_msg(name_longer_than_foo, NAME_SIZE);
 611                         if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 612                                 errorFlag = TRUE;
 613                         continue;
 614                 }
 615
 616 #if defined BB_FEATURE_TAR_EXCLUDE
 617                 if (exclude_file(excludeList, header.name)) {
 618                         /* There are not the droids you're looking for, move along */
 619                         /* If it is a regular file, pretend to extract it with
 620                          * the extractFlag set to FALSE, so the junk in the tarball
 621                          * is properly skipped over */
 622                         if ( header.type==REGTYPE || header.type==REGTYPE0 ) {
 623                                 if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 624                                         errorFlag = TRUE;
 625                         }
 626                         continue;
 627                 }
 628 #endif
 629
 630                 if (!extract_file(extractList, header.name)) {
 631                         /* There are not the droids you're looking for, move along */
 632                         /* If it is a regular file, pretend to extract it with
 633                          * the extractFlag set to FALSE, so the junk in the tarball
 634                          * is properly skipped over */
 635                         if ( header.type==REGTYPE || header.type==REGTYPE0 ) {
 636                                 if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 637                                         errorFlag = TRUE;
 638                         }
 639                         continue;
 640                 }
 641
 642                 if (listFlag == TRUE) {
 643                         /* Special treatment if the list (-t) flag is on */
 644                         if (verboseFlag == TRUE) {
 645                                 int len, len1;
 646                                 char buf[35];
 647                                 struct tm *tm = localtime (&(header.mtime));
 648
 649                                 len=printf("%s ", mode_string(header.mode));
 650                                 my_getpwuid(buf, header.uid);
 651                                 if (! *buf)
 652                                         len+=printf("%d", header.uid);
 653                                 else
 654                                         len+=printf("%s", buf);
 655                                 my_getgrgid(buf, header.gid);
 656                                 if (! *buf)
 657                                         len+=printf("/%-d ", header.gid);
 658                                 else
 659                                         len+=printf("/%-s ", buf);
 660
 661                                 if (header.type==CHRTYPE || header.type==BLKTYPE) {
 662                                         len1=snprintf(buf, sizeof(buf), "%ld,%-ld ",
 663                                                         header.devmajor, header.devminor);
 664                                 } else {
 665                                         len1=snprintf(buf, sizeof(buf), "%lu ", (long)header.size);
 666                                 }
 667                                 /* Jump through some hoops to make the columns match up */
 668                                 for(;(len+len1)<31;len++)
 669                                         printf(" ");
 670                                 printf(buf);
 671
 672                                 /* Use ISO 8610 time format */
 673                                 if (tm) {
 674                                         printf ("%04d-%02d-%02d %02d:%02d:%02d ",
 675                                                         tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday,
 676                                                         tm->tm_hour, tm->tm_min, tm->tm_sec);
 677                                 }
 678                         }
 679                         printf("%s", header.name);
 680                         if (verboseFlag == TRUE) {
 681                                 if (header.type==LNKTYPE)       /* If this is a link, say so */
 682                                         printf(" link to %s", header.linkname);
 683                                 else if (header.type==SYMTYPE)
 684                                         printf(" -> %s", header.linkname);
 685                         }
 686                         printf("\n");
 687                 }
 688
 689                 /* List contents if we are supposed to do that */
 690                 if (verboseFlag == TRUE && extractFlag == TRUE) {
 691                         /* Now the normal listing */
 692                         FILE *vbFd = stdout;
 693                         if (tostdoutFlag == TRUE)       // If the archive goes to stdout, verbose to stderr
 694                                 vbFd = stderr;
 695                         fprintf(vbFd, "%s\n", header.name);
 696                 }
 697
 698                 /* Remove files if we would overwrite them */
 699                 if (extractFlag == TRUE && tostdoutFlag == FALSE)
 700                         unlink(header.name);
 701
 702                 /* If we got here, we can be certain we have a legitimate
 703                  * header to work with.  So work with it.  */
 704                 switch ( header.type ) {
 705                         case REGTYPE:
 706                         case REGTYPE0:
 707                                 /* If the name ends in a '/' then assume it is
 708                                  * supposed to be a directory, and fall through */
 709                                 if (!last_char_is(header.name,'/')) {
 710                                         if (tarExtractRegularFile(&header, extractFlag, tostdoutFlag)==FALSE)
 711                                                 errorFlag=TRUE;
 712                                         break;
 713                                 }
 714                         case DIRTYPE:
 715                                 if (tarExtractDirectory( &header, extractFlag, tostdoutFlag)==FALSE)
 716                                         errorFlag=TRUE;
 717                                 break;
 718                         case LNKTYPE:
 719                                 if (tarExtractHardLink( &header, extractFlag, tostdoutFlag)==FALSE)
 720                                         errorFlag=TRUE;
 721                                 break;
 722                         case SYMTYPE:
 723                                 if (tarExtractSymLink( &header, extractFlag, tostdoutFlag)==FALSE)
 724                                         errorFlag=TRUE;
 725                                 break;
 726                         case CHRTYPE:
 727                         case BLKTYPE:
 728                         case FIFOTYPE:
 729                                 if (tarExtractSpecial( &header, extractFlag, tostdoutFlag)==FALSE)
 730                                         errorFlag=TRUE;
 731                                 break;
 732 #if 0
 733                         /* Handled earlier */
 734                         case GNULONGNAME:
 735                         case GNULONGLINK:
 736                                 skipNextHeaderFlag=TRUE;
 737                                 break;
 738 #endif
 739                         default:
 740                                 error_msg("Unknown file type '%c' in tar file", header.type);
 741                                 close( tarFd);
 742                                 return( FALSE);
 743                 }
 744         }
 745         close(tarFd);
 746         if (status > 0) {
 747                 /* Bummer - we read a partial header */
 748                 perror_msg("Error reading tar file");
 749                 return ( FALSE);
 750         }
 751         else if (errorFlag==TRUE) {
 752                 error_msg( "Error exit delayed from previous errors");
 753                 return( FALSE);
 754         } else
 755                 return( status);
 756
 757         /* Stuff to do when we are done */
 758 endgame:
 759         close( tarFd);
 760         if ( *(header.name) == '\0' ) {
 761                 if (errorFlag==TRUE)
 762                         error_msg( "Error exit delayed from previous errors");
 763                 else
 764                         return( TRUE);
 765         }
 766         return( FALSE);
 767 }
 768
 769
 770 #ifdef BB_FEATURE_TAR_CREATE
 771
 772 /*
 773 ** writeTarFile(),  writeFileToTarball(), and writeTarHeader() are
 774 ** the only functions that deal with the HardLinkInfo structure.
 775 ** Even these functions use the xxxHardLinkInfo() functions.
 776 */
 777 typedef struct HardLinkInfo HardLinkInfo;
 778 struct HardLinkInfo
 779 {
 780         HardLinkInfo *next;           /* Next entry in list */
 781         dev_t dev;                    /* Device number */
 782         ino_t ino;                    /* Inode number */
 783         short linkCount;              /* (Hard) Link Count */
 784         char name[1];                 /* Start of filename (must be last) */
 785 };
 786
 787 /* Some info to be carried along when creating a new tarball */
 788 struct TarBallInfo
 789 {
 790         char* fileName;               /* File name of the tarball */
 791         int tarFd;                    /* Open-for-write file descriptor
 792                                                                          for the tarball */
 793         struct stat statBuf;          /* Stat info for the tarball, letting
 794                                                                          us know the inode and device that the
 795                                                                          tarball lives, so we can avoid trying
 796                                                                          to include the tarball into itself */
 797         int verboseFlag;              /* Whether to print extra stuff or not */
 798         char** excludeList;           /* List of files to not include */
 799         HardLinkInfo *hlInfoHead;     /* Hard Link Tracking Information */
 800         HardLinkInfo *hlInfo;         /* Hard Link Info for the current file */
 801 };
 802 typedef struct TarBallInfo TarBallInfo;
 803
 804
 805 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
 806 static void
 807 addHardLinkInfo (HardLinkInfo **hlInfoHeadPtr, dev_t dev, ino_t ino,
 808                 short linkCount, const char *name)
 809 {
 810         /* Note: hlInfoHeadPtr can never be NULL! */
 811         HardLinkInfo *hlInfo;
 812
 813         hlInfo = (HardLinkInfo *)xmalloc(sizeof(HardLinkInfo)+strlen(name)+1);
 814         if (hlInfo) {
 815                 hlInfo->next = *hlInfoHeadPtr;
 816                 *hlInfoHeadPtr = hlInfo;
 817                 hlInfo->dev = dev;
 818                 hlInfo->ino = ino;
 819                 hlInfo->linkCount = linkCount;
 820                 strcpy(hlInfo->name, name);
 821         }
 822         return;
 823 }
 824
 825 static void
 826 freeHardLinkInfo (HardLinkInfo **hlInfoHeadPtr)
 827 {
 828         HardLinkInfo *hlInfo = NULL;
 829         HardLinkInfo *hlInfoNext = NULL;
 830
 831         if (hlInfoHeadPtr) {
 832                 hlInfo = *hlInfoHeadPtr;
 833                 while (hlInfo) {
 834                         hlInfoNext = hlInfo->next;
 835                         free(hlInfo);
 836                         hlInfo = hlInfoNext;
 837                 }
 838                 *hlInfoHeadPtr = NULL;
 839         }
 840         return;
 841 }
 842
 843 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
 844 static HardLinkInfo *
 845 findHardLinkInfo (HardLinkInfo *hlInfo, dev_t dev, ino_t ino)
 846 {
 847         while(hlInfo) {
 848                 if ((ino == hlInfo->ino) && (dev == hlInfo->dev))
 849                         break;
 850                 hlInfo = hlInfo->next;
 851         }
 852         return(hlInfo);
 853 }
 854
 855 /* Put an octal string into the specified buffer.
 856  * The number is zero and space padded and possibly null padded.
 857  * Returns TRUE if successful.  */
 858 static int putOctal (char *cp, int len, long value)
 859 {
 860         int tempLength;
 861         char tempBuffer[32];
 862         char *tempString = tempBuffer;
 863
 864         /* Create a string of the specified length with an initial space,
 865          * leading zeroes and the octal number, and a trailing null.  */
 866         sprintf (tempString, "%0*lo", len - 1, value);
 867
 868         /* If the string is too large, suppress the leading space.  */
 869         tempLength = strlen (tempString) + 1;
 870         if (tempLength > len) {
 871                 tempLength--;
 872                 tempString++;
 873         }
 874
 875         /* If the string is still too large, suppress the trailing null.  */
 876         if (tempLength > len)
 877                 tempLength--;
 878
 879         /* If the string is still too large, fail.  */
 880         if (tempLength > len)
 881                 return FALSE;
 882
 883         /* Copy the string to the field.  */
 884         memcpy (cp, tempString, len);
 885
 886         return TRUE;
 887 }
 888
 889 /* Write out a tar header for the specified file/directory/whatever */
 890 static int
 891 writeTarHeader(struct TarBallInfo *tbInfo, const char *header_name,
 892                 const char *real_name, struct stat *statbuf)
 893 {
 894         long chksum=0;
 895         struct TarHeader header;
 896         const unsigned char *cp = (const unsigned char *) &header;
 897         ssize_t size = sizeof(struct TarHeader);
 898
 899         memset( &header, 0, size);
 900
 901         strncpy(header.name, header_name, sizeof(header.name));
 902
 903         putOctal(header.mode, sizeof(header.mode), statbuf->st_mode);
 904         putOctal(header.uid, sizeof(header.uid), statbuf->st_uid);
 905         putOctal(header.gid, sizeof(header.gid), statbuf->st_gid);
 906         putOctal(header.size, sizeof(header.size), 0); /* Regular file size is handled later */
 907         putOctal(header.mtime, sizeof(header.mtime), statbuf->st_mtime);
 908         strncpy(header.magic, TAR_MAGIC TAR_VERSION,
 909                         TAR_MAGIC_LEN + TAR_VERSION_LEN );
 910
 911         /* Enter the user and group names (default to root if it fails) */
 912         my_getpwuid(header.uname, statbuf->st_uid);
 913         if (! *header.uname)
 914                 strcpy(header.uname, "root");
 915         my_getgrgid(header.gname, statbuf->st_gid);
 916         if (! *header.uname)
 917                 strcpy(header.uname, "root");
 918
 919         if (tbInfo->hlInfo) {
 920                 /* This is a hard link */
 921                 header.typeflag = LNKTYPE;
 922                 strncpy(header.linkname, tbInfo->hlInfo->name, sizeof(header.linkname));
 923         } else if (S_ISLNK(statbuf->st_mode)) {
 924                 char *lpath = xreadlink(real_name);
 925                 if (!lpath) /* Already printed err msg inside xreadlink() */
 926                         return ( FALSE);
 927                 header.typeflag  = SYMTYPE;
 928                 strncpy(header.linkname, lpath, sizeof(header.linkname));
 929                 free(lpath);
 930         } else if (S_ISDIR(statbuf->st_mode)) {
 931                 header.typeflag  = DIRTYPE;
 932                 strncat(header.name, "/", sizeof(header.name));
 933         } else if (S_ISCHR(statbuf->st_mode)) {
 934                 header.typeflag  = CHRTYPE;
 935                 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
 936                 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
 937         } else if (S_ISBLK(statbuf->st_mode)) {
 938                 header.typeflag  = BLKTYPE;
 939                 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
 940                 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
 941         } else if (S_ISFIFO(statbuf->st_mode)) {
 942                 header.typeflag  = FIFOTYPE;
 943         } else if (S_ISREG(statbuf->st_mode)) {
 944                 header.typeflag  = REGTYPE;
 945                 putOctal(header.size, sizeof(header.size), statbuf->st_size);
 946         } else {
 947                 error_msg("%s: Unknown file type", real_name);
 948                 return ( FALSE);
 949         }
 950
 951         /* Calculate and store the checksum (i.e. the sum of all of the bytes of
 952          * the header).  The checksum field must be filled with blanks for the
 953          * calculation.  The checksum field is formatted differently from the
 954          * other fields: it has [6] digits, a null, then a space -- rather than
 955          * digits, followed by a null like the other fields... */
 956         memset(header.chksum, ' ', sizeof(header.chksum));
 957         cp = (const unsigned char *) &header;
 958         while (size-- > 0)
 959                 chksum += *cp++;
 960         putOctal(header.chksum, 7, chksum);
 961
 962         /* Now write the header out to disk */
 963         if ((size=full_write(tbInfo->tarFd, (char*)&header, sizeof(struct TarHeader))) < 0) {
 964                 error_msg(io_error, real_name, strerror(errno));
 965                 return ( FALSE);
 966         }
 967         /* Pad the header up to the tar block size */
 968         for (; size<TAR_BLOCK_SIZE; size++) {
 969                 write(tbInfo->tarFd, "\0", 1);
 970         }
 971         /* Now do the verbose thing (or not) */
 972         if (tbInfo->verboseFlag==TRUE) {
 973                 FILE *vbFd = stdout;
 974                 if (tbInfo->tarFd == fileno(stdout))    // If the archive goes to stdout, verbose to stderr
 975                         vbFd = stderr;
 976                 fprintf(vbFd, "%s\n", header.name);
 977         }
 978
 979         return ( TRUE);
 980 }
 981
 982
 983 static int writeFileToTarball(const char *fileName, struct stat *statbuf, void* userData)
 984 {
 985         struct TarBallInfo *tbInfo = (struct TarBallInfo *)userData;
 986         const char *header_name;
 987
 988         /*
 989         ** Check to see if we are dealing with a hard link.
 990         ** If so -
 991         ** Treat the first occurance of a given dev/inode as a file while
 992         ** treating any additional occurances as hard links.  This is done
 993         ** by adding the file information to the HardLinkInfo linked list.
 994         */
 995         tbInfo->hlInfo = NULL;
 996         if (statbuf->st_nlink > 1) {
 997                 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf->st_dev,
 998                                 statbuf->st_ino);
 999                 if (tbInfo->hlInfo == NULL)
1000                         addHardLinkInfo (&tbInfo->hlInfoHead, statbuf->st_dev,
1001                                         statbuf->st_ino, statbuf->st_nlink, fileName);
1002         }
1003
1004         /* It is against the rules to archive a socket */
1005         if (S_ISSOCK(statbuf->st_mode)) {
1006                 error_msg("%s: socket ignored", fileName);
1007                 return( TRUE);
1008         }
1009
1010         /* It is a bad idea to store the archive we are in the process of creating,
1011          * so check the device and inode to be sure that this particular file isn't
1012          * the new tarball */
1013         if (tbInfo->statBuf.st_dev == statbuf->st_dev &&
1014                         tbInfo->statBuf.st_ino == statbuf->st_ino) {
1015                 error_msg("%s: file is the archive; skipping", fileName);
1016                 return( TRUE);
1017         }
1018
1019         header_name = fileName;
1020         while (header_name[0] == '/') {
1021                 static int alreadyWarned=FALSE;
1022                 if (alreadyWarned==FALSE) {
1023                         error_msg("Removing leading '/' from member names");
1024                         alreadyWarned=TRUE;
1025                 }
1026                 header_name++;
1027         }
1028
1029         if (strlen(fileName) >= NAME_SIZE) {
1030                 error_msg(name_longer_than_foo, NAME_SIZE);
1031                 return ( TRUE);
1032         }
1033
1034         if (header_name[0] == '\0')
1035                 return TRUE;
1036
1037 #if defined BB_FEATURE_TAR_EXCLUDE
1038         if (exclude_file(tbInfo->excludeList, header_name)) {
1039                 return SKIP;
1040         }
1041 #endif
1042
1043         if (writeTarHeader(tbInfo, header_name, fileName, statbuf)==FALSE) {
1044                 return( FALSE);
1045         }
1046
1047         /* Now, if the file is a regular file, copy it out to the tarball */
1048         if ((tbInfo->hlInfo == NULL)
1049         &&  (S_ISREG(statbuf->st_mode))) {
1050                 int  inputFileFd;
1051                 char buffer[BUFSIZ];
1052                 ssize_t size=0, readSize=0;
1053
1054                 /* open the file we want to archive, and make sure all is well */
1055                 if ((inputFileFd = open(fileName, O_RDONLY)) < 0) {
1056                         error_msg("%s: Cannot open: %s", fileName, strerror(errno));
1057                         return( FALSE);
1058                 }
1059
1060                 /* write the file to the archive */
1061                 while ( (size = full_read(inputFileFd, buffer, sizeof(buffer))) > 0 ) {
1062                         if (full_write(tbInfo->tarFd, buffer, size) != size ) {
1063                                 /* Output file seems to have a problem */
1064                                 error_msg(io_error, fileName, strerror(errno));
1065                                 return( FALSE);
1066                         }
1067                         readSize+=size;
1068                 }
1069                 if (size == -1) {
1070                         error_msg(io_error, fileName, strerror(errno));
1071                         return( FALSE);
1072                 }
1073                 /* Pad the file up to the tar block size */
1074                 for (; (readSize%TAR_BLOCK_SIZE) != 0; readSize++) {
1075                         write(tbInfo->tarFd, "\0", 1);
1076                 }
1077                 close( inputFileFd);
1078         }
1079
1080         return( TRUE);
1081 }
1082
1083 static int writeTarFile(const char* tarName, int verboseFlag, char **argv,
1084                 char** excludeList)
1085 {
1086         int tarFd=-1;
1087         int errorFlag=FALSE;
1088         ssize_t size;
1089         struct TarBallInfo tbInfo;
1090         tbInfo.verboseFlag = verboseFlag;
1091         tbInfo.hlInfoHead = NULL;
1092
1093         /* Make sure there is at least one file to tar up.  */
1094         if (*argv == NULL)
1095                 error_msg_and_die("Cowardly refusing to create an empty archive");
1096
1097         /* Open the tar file for writing.  */
1098         if (!strcmp(tarName, "-"))
1099                 tbInfo.tarFd = fileno(stdout);
1100         else
1101                 tbInfo.tarFd = open (tarName, O_WRONLY | O_CREAT | O_TRUNC, 0644);
1102         if (tbInfo.tarFd < 0) {
1103                 perror_msg( "Error opening '%s'", tarName);
1104                 freeHardLinkInfo(&tbInfo.hlInfoHead);
1105                 return ( FALSE);
1106         }
1107         tbInfo.excludeList=excludeList;
1108         /* Store the stat info for the tarball's file, so
1109          * can avoid including the tarball into itself....  */
1110         if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
1111                 error_msg_and_die(io_error, tarName, strerror(errno));
1112
1113         /* Set the umask for this process so it doesn't
1114          * screw up permission setting for us later. */
1115         umask(0);
1116
1117         /* Read the directory/files and iterate over them one at a time */
1118         while (*argv != NULL) {
1119                 if (recursive_action(*argv++, TRUE, FALSE, FALSE,
1120                                         writeFileToTarball, writeFileToTarball,
1121                                         (void*) &tbInfo) == FALSE) {
1122                         errorFlag = TRUE;
1123                 }
1124         }
1125         /* Write two empty blocks to the end of the archive */
1126         for (size=0; size<(2*TAR_BLOCK_SIZE); size++) {
1127                 write(tbInfo.tarFd, "\0", 1);
1128         }
1129
1130         /* To be pedantically correct, we would check if the tarball
1131          * is smaller than 20 tar blocks, and pad it if it was smaller,
1132          * but that isn't necessary for GNU tar interoperability, and
1133          * so is considered a waste of space */
1134
1135         /* Hang up the tools, close up shop, head home */
1136         close(tarFd);
1137         if (errorFlag == TRUE) {
1138                 error_msg("Error exit delayed from previous errors");
1139                 freeHardLinkInfo(&tbInfo.hlInfoHead);
1140                 return(FALSE);
1141         }
1142         freeHardLinkInfo(&tbInfo.hlInfoHead);
1143         return( TRUE);
1144 }
1145
1146
1147 #endif
1148