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:p"))
 185 #else
 186                         (opt = getopt_long(argc, argv, "cxtzvOf:X:p", 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                         case 'p':
 242                                 break;
 243                         default:
 244                                         show_usage();
 245                 }
 246         }
 247
 248         /*
 249          * Do the correct type of action supplying the rest of the
 250          * command line arguments as the list of files to process.
 251          */
 252         if (createFlag == TRUE) {
 253 #ifndef BB_FEATURE_TAR_CREATE
 254                 error_msg_and_die( "This version of tar was not compiled with tar creation support.");
 255 #else
 256 #ifdef BB_FEATURE_TAR_GZIP
 257                 if (unzipFlag==TRUE)
 258                         error_msg_and_die("Creation of compressed not internally support by tar, pipe to busybox gunzip");
 259 #endif
 260                 status = writeTarFile(tarName, verboseFlag, argv + optind, excludeList);
 261 #endif
 262         }
 263         if (listFlag == TRUE || extractFlag == TRUE) {
 264                 int tarFd;
 265                 if (argv[optind])
 266                         extractList = argv + optind;
 267                 /* Open the tar file for reading.  */
 268                 if (!strcmp(tarName, "-"))
 269                         tarFd = fileno(stdin);
 270                 else
 271                         tarFd = open(tarName, O_RDONLY);
 272                 if (tarFd < 0)
 273                         perror_msg_and_die("Error opening '%s'", tarName);
 274
 275 #ifdef BB_FEATURE_TAR_GZIP
 276                 /* unzip tarFd in a seperate process */
 277                 if (unzipFlag == TRUE) {
 278                         comp_file = fdopen(tarFd, "r");
 279                         if ((tarFd = fileno(gz_open(comp_file, &pid))) == EXIT_FAILURE) {
 280                                 error_msg_and_die("Couldnt unzip file");
 281                         }
 282                 }
 283 #endif
 284                 status = readTarFile(tarFd, extractFlag, listFlag, tostdoutFlag,
 285                                         verboseFlag, extractList, excludeList);
 286                 close(tarFd);
 287 #ifdef BB_FEATURE_TAR_GZIP
 288                 if (unzipFlag == TRUE) {
 289                         gz_close(pid);
 290                         fclose(comp_file);
 291                 }
 292 #endif
 293         }
 294
 295         if (status == TRUE)
 296                 return EXIT_SUCCESS;
 297         else
 298                 return EXIT_FAILURE;
 299
 300   flagError:
 301         error_msg_and_die( "Exactly one of 'c', 'x' or 't' must be specified");
 302 }
 303
 304 static void
 305 fixUpPermissions(TarInfo *header)
 306 {
 307         struct utimbuf t;
 308         /* Now set permissions etc. for the new file */
 309         chown(header->name, header->uid, header->gid);
 310         chmod(header->name, header->mode);
 311         /* Reset the time */
 312         t.actime = time(0);
 313         t.modtime = header->mtime;
 314         utime(header->name, &t);
 315 }
 316
 317 static int
 318 tarExtractRegularFile(TarInfo *header, int extractFlag, int tostdoutFlag)
 319 {
 320         size_t  writeSize;
 321         size_t  readSize;
 322         size_t  actualWriteSz;
 323         char    buffer[BUFSIZ];
 324         size_t  size = header->size;
 325         int outFd=fileno(stdout);
 326
 327         /* Open the file to be written, if a file is supposed to be written */
 328         if (extractFlag==TRUE && tostdoutFlag==FALSE) {
 329                 /* Create the path to the file, just in case it isn't there...
 330                  * This should not screw up path permissions or anything. */
 331                 create_path(header->name, 0777);
 332                 if ((outFd=open(header->name, O_CREAT|O_TRUNC|O_WRONLY,
 333                                                 header->mode & ~S_IFMT)) < 0) {
 334                         error_msg(io_error, header->name, strerror(errno));
 335                         return( FALSE);
 336                 }
 337         }
 338
 339         /* Write out the file, if we are supposed to be doing that */
 340         while ( size > 0 ) {
 341                 actualWriteSz=0;
 342                 if ( size > sizeof(buffer) )
 343                         writeSize = readSize = sizeof(buffer);
 344                 else {
 345                         int mod = size % 512;
 346                         if ( mod != 0 )
 347                                 readSize = size + (512 - mod);
 348                         else
 349                                 readSize = size;
 350                         writeSize = size;
 351                 }
 352                 if ( (readSize = full_read(header->tarFd, buffer, readSize)) <= 0 ) {
 353                         /* Tarball seems to have a problem */
 354                         error_msg("Unexpected EOF in archive");
 355                         return( FALSE);
 356                 }
 357                 if ( readSize < writeSize )
 358                         writeSize = readSize;
 359
 360                 /* Write out the file, if we are supposed to be doing that */
 361                 if (extractFlag==TRUE) {
 362
 363                         if ((actualWriteSz=full_write(outFd, buffer, writeSize)) != writeSize ) {
 364                                 /* Output file seems to have a problem */
 365                                 error_msg(io_error, header->name, strerror(errno));
 366                                 return( FALSE);
 367                         }
 368                 } else {
 369                         actualWriteSz=writeSize;
 370                 }
 371
 372                 size -= actualWriteSz;
 373         }
 374
 375         /* Now we are done writing the file out, so try
 376          * and fix up the permissions and whatnot */
 377         if (extractFlag==TRUE && tostdoutFlag==FALSE) {
 378                 close(outFd);
 379                 fixUpPermissions(header);
 380         }
 381         return( TRUE);
 382 }
 383
 384 static int
 385 tarExtractDirectory(TarInfo *header, int extractFlag, int tostdoutFlag)
 386 {
 387         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 388                 return( TRUE);
 389
 390         if (create_path(header->name, header->mode) != TRUE) {
 391                 perror_msg("%s: Cannot mkdir", header->name);
 392                 return( FALSE);
 393         }
 394         /* make the final component, just in case it was
 395          * omitted by create_path() (which will skip the
 396          * directory if it doesn't have a terminating '/') */
 397         if (mkdir(header->name, header->mode) < 0 && errno != EEXIST) {
 398                 perror_msg("%s", header->name);
 399                 return FALSE;
 400         }
 401
 402         fixUpPermissions(header);
 403         return( TRUE);
 404 }
 405
 406 static int
 407 tarExtractHardLink(TarInfo *header, int extractFlag, int tostdoutFlag)
 408 {
 409         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 410                 return( TRUE);
 411
 412         if (link(header->linkname, header->name) < 0) {
 413                 perror_msg("%s: Cannot create hard link to '%s'", header->name,
 414                                 header->linkname);
 415                 return( FALSE);
 416         }
 417
 418         /* Now set permissions etc. for the new directory */
 419         fixUpPermissions(header);
 420         return( TRUE);
 421 }
 422
 423 static int
 424 tarExtractSymLink(TarInfo *header, int extractFlag, int tostdoutFlag)
 425 {
 426         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 427                 return( TRUE);
 428
 429 #ifdef  S_ISLNK
 430         if (symlink(header->linkname, header->name) < 0) {
 431                 perror_msg("%s: Cannot create symlink to '%s'", header->name,
 432                                 header->linkname);
 433                 return( FALSE);
 434         }
 435         /* Try to change ownership of the symlink.
 436          * If libs doesn't support that, don't bother.
 437          * Changing the pointed-to-file is the Wrong Thing(tm).
 438          */
 439 #if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1)
 440         lchown(header->name, header->uid, header->gid);
 441 #endif
 442
 443         /* Do not change permissions or date on symlink,
 444          * since it changes the pointed to file instead.  duh. */
 445 #else
 446         error_msg("%s: Cannot create symlink to '%s': %s",
 447                         header->name, header->linkname,
 448                         "symlinks not supported");
 449 #endif
 450         return( TRUE);
 451 }
 452
 453 static int
 454 tarExtractSpecial(TarInfo *header, int extractFlag, int tostdoutFlag)
 455 {
 456         if (extractFlag==FALSE || tostdoutFlag==TRUE)
 457                 return( TRUE);
 458
 459         if (S_ISCHR(header->mode) || S_ISBLK(header->mode) || S_ISSOCK(header->mode)) {
 460                 if (mknod(header->name, header->mode, makedev(header->devmajor, header->devminor)) < 0) {
 461                         perror_msg("%s: Cannot mknod", header->name);
 462                         return( FALSE);
 463                 }
 464         } else if (S_ISFIFO(header->mode)) {
 465                 if (mkfifo(header->name, header->mode) < 0) {
 466                         perror_msg("%s: Cannot mkfifo", header->name);
 467                         return( FALSE);
 468                 }
 469         }
 470
 471         /* Now set permissions etc. for the new directory */
 472         fixUpPermissions(header);
 473         return( TRUE);
 474 }
 475
 476 /* Parse the tar header and fill in the nice struct with the details */
 477 static int
 478 readTarHeader(struct TarHeader *rawHeader, struct TarInfo *header)
 479 {
 480         int i;
 481         long chksum, sum=0;
 482         unsigned char *s = (unsigned char *)rawHeader;
 483
 484         header->name  = rawHeader->name;
 485         /* Check for and relativify any absolute paths */
 486         if ( *(header->name) == '/' ) {
 487                 static int alreadyWarned=FALSE;
 488
 489                 while (*(header->name) == '/')
 490                         header->name++;
 491
 492                 if (alreadyWarned == FALSE) {
 493                         error_msg("Removing leading '/' from member names");
 494                         alreadyWarned = TRUE;
 495                 }
 496         }
 497
 498         header->mode  = strtol(rawHeader->mode, NULL, 8);
 499         header->uid   = strtol(rawHeader->uid, NULL, 8);
 500         header->gid   = strtol(rawHeader->gid, NULL, 8);
 501         header->size  = strtol(rawHeader->size, NULL, 8);
 502         header->mtime = strtol(rawHeader->mtime, NULL, 8);
 503         chksum = strtol(rawHeader->chksum, NULL, 8);
 504         header->type  = rawHeader->typeflag;
 505         header->linkname  = rawHeader->linkname;
 506         header->devmajor  = strtol(rawHeader->devmajor, NULL, 8);
 507         header->devminor  = strtol(rawHeader->devminor, NULL, 8);
 508
 509         /* Check the checksum */
 510         for (i = sizeof(*rawHeader); i-- != 0;) {
 511                 sum += *s++;
 512         }
 513         /* Remove the effects of the checksum field (replace
 514          * with blanks for the purposes of the checksum) */
 515         s = rawHeader->chksum;
 516         for (i = sizeof(rawHeader->chksum) ; i-- != 0;) {
 517                 sum -= *s++;
 518         }
 519         sum += ' ' * sizeof(rawHeader->chksum);
 520         if (sum == chksum )
 521                 return ( TRUE);
 522         return( FALSE);
 523 }
 524
 525 static int exclude_file(char **excluded_files, const char *file)
 526 {
 527         int i;
 528
 529         if (excluded_files == NULL)
 530                 return 0;
 531
 532         for (i = 0; excluded_files[i] != NULL; i++) {
 533                 if (excluded_files[i][0] == '/') {
 534                         if (fnmatch(excluded_files[i], file,
 535                                                 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
 536                                 return 1;
 537                 } else {
 538                         const char *p;
 539
 540                         for (p = file; p[0] != '\0'; p++) {
 541                                 if ((p == file || p[-1] == '/') && p[0] != '/' &&
 542                                                 fnmatch(excluded_files[i], p,
 543                                                         FNM_PATHNAME | FNM_LEADING_DIR) == 0)
 544                                         return 1;
 545                         }
 546                 }
 547         }
 548
 549         return 0;
 550 }
 551
 552 static int extract_file(char **extract_files, const char *file)
 553 {
 554         int i;
 555
 556         if (extract_files == NULL)
 557                 return 1;
 558
 559         for (i = 0; extract_files[i] != NULL; i++) {
 560                 if (fnmatch(extract_files[i], file, FNM_LEADING_DIR) == 0)
 561                         return 1;
 562         }
 563
 564         return 0;
 565 }
 566
 567 /*
 568  * Read a tar file and extract or list the specified files within it.
 569  * If the list is empty than all files are extracted or listed.
 570  */
 571 static int readTarFile(int tarFd, int extractFlag, int listFlag,
 572                 int tostdoutFlag, int verboseFlag, char** extractList,
 573                 char** excludeList)
 574 {
 575         int status;
 576         int errorFlag=FALSE;
 577         int skipNextHeaderFlag=FALSE;
 578         TarHeader rawHeader;
 579         TarInfo header;
 580
 581         /* Read the tar file, and iterate over it one file at a time */
 582         while ( (status = full_read(tarFd, (char*)&rawHeader, TAR_BLOCK_SIZE)) == TAR_BLOCK_SIZE ) {
 583
 584                 /* Try to read the header */
 585                 if ( readTarHeader(&rawHeader, &header) == FALSE ) {
 586                         if ( *(header.name) == '\0' ) {
 587                                 goto endgame;
 588                         } else {
 589                                 errorFlag=TRUE;
 590                                 error_msg("Bad tar header, skipping");
 591                                 continue;
 592                         }
 593                 }
 594                 if ( *(header.name) == '\0' )
 595                         continue;
 596                 header.tarFd = tarFd;
 597
 598                 /* Skip funky extra GNU headers that precede long files */
 599                 if ( (header.type == GNULONGNAME) || (header.type == GNULONGLINK) ) {
 600                         skipNextHeaderFlag=TRUE;
 601                         if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 602                                 errorFlag = TRUE;
 603                         continue;
 604                 }
 605                 if ( skipNextHeaderFlag == TRUE ) {
 606                         skipNextHeaderFlag=FALSE;
 607                         error_msg(name_longer_than_foo, NAME_SIZE);
 608                         if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 609                                 errorFlag = TRUE;
 610                         continue;
 611                 }
 612
 613 #if defined BB_FEATURE_TAR_EXCLUDE
 614                 if (exclude_file(excludeList, header.name)) {
 615                         /* There are not the droids you're looking for, move along */
 616                         /* If it is a regular file, pretend to extract it with
 617                          * the extractFlag set to FALSE, so the junk in the tarball
 618                          * is properly skipped over */
 619                         if ( header.type==REGTYPE || header.type==REGTYPE0 ) {
 620                                 if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 621                                         errorFlag = TRUE;
 622                         }
 623                         continue;
 624                 }
 625 #endif
 626
 627                 if (!extract_file(extractList, header.name)) {
 628                         /* There are not the droids you're looking for, move along */
 629                         /* If it is a regular file, pretend to extract it with
 630                          * the extractFlag set to FALSE, so the junk in the tarball
 631                          * is properly skipped over */
 632                         if ( header.type==REGTYPE || header.type==REGTYPE0 ) {
 633                                 if (tarExtractRegularFile(&header, FALSE, FALSE) == FALSE)
 634                                         errorFlag = TRUE;
 635                         }
 636                         continue;
 637                 }
 638
 639                 if (listFlag == TRUE) {
 640                         /* Special treatment if the list (-t) flag is on */
 641                         if (verboseFlag == TRUE) {
 642                                 int len, len1;
 643                                 char buf[35];
 644                                 struct tm *tm = localtime (&(header.mtime));
 645
 646                                 len=printf("%s ", mode_string(header.mode));
 647                                 my_getpwuid(buf, header.uid);
 648                                 if (! *buf)
 649                                         len+=printf("%d", header.uid);
 650                                 else
 651                                         len+=printf("%s", buf);
 652                                 my_getgrgid(buf, header.gid);
 653                                 if (! *buf)
 654                                         len+=printf("/%-d ", header.gid);
 655                                 else
 656                                         len+=printf("/%-s ", buf);
 657
 658                                 if (header.type==CHRTYPE || header.type==BLKTYPE) {
 659                                         len1=snprintf(buf, sizeof(buf), "%ld,%-ld ",
 660                                                         header.devmajor, header.devminor);
 661                                 } else {
 662                                         len1=snprintf(buf, sizeof(buf), "%lu ", (long)header.size);
 663                                 }
 664                                 /* Jump through some hoops to make the columns match up */
 665                                 for(;(len+len1)<31;len++)
 666                                         printf(" ");
 667                                 printf(buf);
 668
 669                                 /* Use ISO 8610 time format */
 670                                 if (tm) {
 671                                         printf ("%04d-%02d-%02d %02d:%02d:%02d ",
 672                                                         tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday,
 673                                                         tm->tm_hour, tm->tm_min, tm->tm_sec);
 674                                 }
 675                         }
 676                         printf("%s", header.name);
 677                         if (verboseFlag == TRUE) {
 678                                 if (header.type==LNKTYPE)       /* If this is a link, say so */
 679                                         printf(" link to %s", header.linkname);
 680                                 else if (header.type==SYMTYPE)
 681                                         printf(" -> %s", header.linkname);
 682                         }
 683                         printf("\n");
 684                 }
 685
 686                 /* List contents if we are supposed to do that */
 687                 if (verboseFlag == TRUE && extractFlag == TRUE) {
 688                         /* Now the normal listing */
 689                         FILE *vbFd = stdout;
 690                         if (tostdoutFlag == TRUE)       // If the archive goes to stdout, verbose to stderr
 691                                 vbFd = stderr;
 692                         fprintf(vbFd, "%s\n", header.name);
 693                 }
 694
 695                 /* Remove files if we would overwrite them */
 696                 if (extractFlag == TRUE && tostdoutFlag == FALSE)
 697                         unlink(header.name);
 698
 699                 /* If we got here, we can be certain we have a legitimate
 700                  * header to work with.  So work with it.  */
 701                 switch ( header.type ) {
 702                         case REGTYPE:
 703                         case REGTYPE0:
 704                                 /* If the name ends in a '/' then assume it is
 705                                  * supposed to be a directory, and fall through */
 706                                 if (!last_char_is(header.name,'/')) {
 707                                         if (tarExtractRegularFile(&header, extractFlag, tostdoutFlag)==FALSE)
 708                                                 errorFlag=TRUE;
 709                                         break;
 710                                 }
 711                         case DIRTYPE:
 712                                 if (tarExtractDirectory( &header, extractFlag, tostdoutFlag)==FALSE)
 713                                         errorFlag=TRUE;
 714                                 break;
 715                         case LNKTYPE:
 716                                 if (tarExtractHardLink( &header, extractFlag, tostdoutFlag)==FALSE)
 717                                         errorFlag=TRUE;
 718                                 break;
 719                         case SYMTYPE:
 720                                 if (tarExtractSymLink( &header, extractFlag, tostdoutFlag)==FALSE)
 721                                         errorFlag=TRUE;
 722                                 break;
 723                         case CHRTYPE:
 724                         case BLKTYPE:
 725                         case FIFOTYPE:
 726                                 if (tarExtractSpecial( &header, extractFlag, tostdoutFlag)==FALSE)
 727                                         errorFlag=TRUE;
 728                                 break;
 729 #if 0
 730                         /* Handled earlier */
 731                         case GNULONGNAME:
 732                         case GNULONGLINK:
 733                                 skipNextHeaderFlag=TRUE;
 734                                 break;
 735 #endif
 736                         default:
 737                                 error_msg("Unknown file type '%c' in tar file", header.type);
 738                                 close( tarFd);
 739                                 return( FALSE);
 740                 }
 741         }
 742         close(tarFd);
 743         if (status > 0) {
 744                 /* Bummer - we read a partial header */
 745                 perror_msg("Error reading tar file");
 746                 return ( FALSE);
 747         }
 748         else if (errorFlag==TRUE) {
 749                 error_msg( "Error exit delayed from previous errors");
 750                 return( FALSE);
 751         } else
 752                 return( status);
 753
 754         /* Stuff to do when we are done */
 755 endgame:
 756         close( tarFd);
 757         if ( *(header.name) == '\0' ) {
 758                 if (errorFlag==TRUE)
 759                         error_msg( "Error exit delayed from previous errors");
 760                 else
 761                         return( TRUE);
 762         }
 763         return( FALSE);
 764 }
 765
 766
 767 #ifdef BB_FEATURE_TAR_CREATE
 768
 769 /*
 770 ** writeTarFile(),  writeFileToTarball(), and writeTarHeader() are
 771 ** the only functions that deal with the HardLinkInfo structure.
 772 ** Even these functions use the xxxHardLinkInfo() functions.
 773 */
 774 typedef struct HardLinkInfo HardLinkInfo;
 775 struct HardLinkInfo
 776 {
 777         HardLinkInfo *next;           /* Next entry in list */
 778         dev_t dev;                    /* Device number */
 779         ino_t ino;                    /* Inode number */
 780         short linkCount;              /* (Hard) Link Count */
 781         char name[1];                 /* Start of filename (must be last) */
 782 };
 783
 784 /* Some info to be carried along when creating a new tarball */
 785 struct TarBallInfo
 786 {
 787         char* fileName;               /* File name of the tarball */
 788         int tarFd;                    /* Open-for-write file descriptor
 789                                                                          for the tarball */
 790         struct stat statBuf;          /* Stat info for the tarball, letting
 791                                                                          us know the inode and device that the
 792                                                                          tarball lives, so we can avoid trying
 793                                                                          to include the tarball into itself */
 794         int verboseFlag;              /* Whether to print extra stuff or not */
 795         char** excludeList;           /* List of files to not include */
 796         HardLinkInfo *hlInfoHead;     /* Hard Link Tracking Information */
 797         HardLinkInfo *hlInfo;         /* Hard Link Info for the current file */
 798 };
 799 typedef struct TarBallInfo TarBallInfo;
 800
 801
 802 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
 803 static void
 804 addHardLinkInfo (HardLinkInfo **hlInfoHeadPtr, dev_t dev, ino_t ino,
 805                 short linkCount, const char *name)
 806 {
 807         /* Note: hlInfoHeadPtr can never be NULL! */
 808         HardLinkInfo *hlInfo;
 809
 810         hlInfo = (HardLinkInfo *)xmalloc(sizeof(HardLinkInfo)+strlen(name)+1);
 811         if (hlInfo) {
 812                 hlInfo->next = *hlInfoHeadPtr;
 813                 *hlInfoHeadPtr = hlInfo;
 814                 hlInfo->dev = dev;
 815                 hlInfo->ino = ino;
 816                 hlInfo->linkCount = linkCount;
 817                 strcpy(hlInfo->name, name);
 818         }
 819         return;
 820 }
 821
 822 static void
 823 freeHardLinkInfo (HardLinkInfo **hlInfoHeadPtr)
 824 {
 825         HardLinkInfo *hlInfo = NULL;
 826         HardLinkInfo *hlInfoNext = NULL;
 827
 828         if (hlInfoHeadPtr) {
 829                 hlInfo = *hlInfoHeadPtr;
 830                 while (hlInfo) {
 831                         hlInfoNext = hlInfo->next;
 832                         free(hlInfo);
 833                         hlInfo = hlInfoNext;
 834                 }
 835                 *hlInfoHeadPtr = NULL;
 836         }
 837         return;
 838 }
 839
 840 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
 841 static HardLinkInfo *
 842 findHardLinkInfo (HardLinkInfo *hlInfo, dev_t dev, ino_t ino)
 843 {
 844         while(hlInfo) {
 845                 if ((ino == hlInfo->ino) && (dev == hlInfo->dev))
 846                         break;
 847                 hlInfo = hlInfo->next;
 848         }
 849         return(hlInfo);
 850 }
 851
 852 /* Put an octal string into the specified buffer.
 853  * The number is zero and space padded and possibly null padded.
 854  * Returns TRUE if successful.  */
 855 static int putOctal (char *cp, int len, long value)
 856 {
 857         int tempLength;
 858         char tempBuffer[32];
 859         char *tempString = tempBuffer;
 860
 861         /* Create a string of the specified length with an initial space,
 862          * leading zeroes and the octal number, and a trailing null.  */
 863         sprintf (tempString, "%0*lo", len - 1, value);
 864
 865         /* If the string is too large, suppress the leading space.  */
 866         tempLength = strlen (tempString) + 1;
 867         if (tempLength > len) {
 868                 tempLength--;
 869                 tempString++;
 870         }
 871
 872         /* If the string is still too large, suppress the trailing null.  */
 873         if (tempLength > len)
 874                 tempLength--;
 875
 876         /* If the string is still too large, fail.  */
 877         if (tempLength > len)
 878                 return FALSE;
 879
 880         /* Copy the string to the field.  */
 881         memcpy (cp, tempString, len);
 882
 883         return TRUE;
 884 }
 885
 886 /* Write out a tar header for the specified file/directory/whatever */
 887 static int
 888 writeTarHeader(struct TarBallInfo *tbInfo, const char *header_name,
 889                 const char *real_name, struct stat *statbuf)
 890 {
 891         long chksum=0;
 892         struct TarHeader header;
 893         const unsigned char *cp = (const unsigned char *) &header;
 894         ssize_t size = sizeof(struct TarHeader);
 895
 896         memset( &header, 0, size);
 897
 898         strncpy(header.name, header_name, sizeof(header.name));
 899
 900         putOctal(header.mode, sizeof(header.mode), statbuf->st_mode);
 901         putOctal(header.uid, sizeof(header.uid), statbuf->st_uid);
 902         putOctal(header.gid, sizeof(header.gid), statbuf->st_gid);
 903         putOctal(header.size, sizeof(header.size), 0); /* Regular file size is handled later */
 904         putOctal(header.mtime, sizeof(header.mtime), statbuf->st_mtime);
 905         strncpy(header.magic, TAR_MAGIC TAR_VERSION,
 906                         TAR_MAGIC_LEN + TAR_VERSION_LEN );
 907
 908         /* Enter the user and group names (default to root if it fails) */
 909         my_getpwuid(header.uname, statbuf->st_uid);
 910         if (! *header.uname)
 911                 strcpy(header.uname, "root");
 912         my_getgrgid(header.gname, statbuf->st_gid);
 913         if (! *header.uname)
 914                 strcpy(header.uname, "root");
 915
 916         if (tbInfo->hlInfo) {
 917                 /* This is a hard link */
 918                 header.typeflag = LNKTYPE;
 919                 strncpy(header.linkname, tbInfo->hlInfo->name, sizeof(header.linkname));
 920         } else if (S_ISLNK(statbuf->st_mode)) {
 921                 char *lpath = xreadlink(real_name);
 922                 if (!lpath) /* Already printed err msg inside xreadlink() */
 923                         return ( FALSE);
 924                 header.typeflag  = SYMTYPE;
 925                 strncpy(header.linkname, lpath, sizeof(header.linkname));
 926                 free(lpath);
 927         } else if (S_ISDIR(statbuf->st_mode)) {
 928                 header.typeflag  = DIRTYPE;
 929                 strncat(header.name, "/", sizeof(header.name));
 930         } else if (S_ISCHR(statbuf->st_mode)) {
 931                 header.typeflag  = CHRTYPE;
 932                 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
 933                 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
 934         } else if (S_ISBLK(statbuf->st_mode)) {
 935                 header.typeflag  = BLKTYPE;
 936                 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
 937                 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
 938         } else if (S_ISFIFO(statbuf->st_mode)) {
 939                 header.typeflag  = FIFOTYPE;
 940         } else if (S_ISREG(statbuf->st_mode)) {
 941                 header.typeflag  = REGTYPE;
 942                 putOctal(header.size, sizeof(header.size), statbuf->st_size);
 943         } else {
 944                 error_msg("%s: Unknown file type", real_name);
 945                 return ( FALSE);
 946         }
 947
 948         /* Calculate and store the checksum (i.e., the sum of all of the bytes of
 949          * the header).  The checksum field must be filled with blanks for the
 950          * calculation.  The checksum field is formatted differently from the
 951          * other fields: it has [6] digits, a null, then a space -- rather than
 952          * digits, followed by a null like the other fields... */
 953         memset(header.chksum, ' ', sizeof(header.chksum));
 954         cp = (const unsigned char *) &header;
 955         while (size-- > 0)
 956                 chksum += *cp++;
 957         putOctal(header.chksum, 7, chksum);
 958
 959         /* Now write the header out to disk */
 960         if ((size=full_write(tbInfo->tarFd, (char*)&header, sizeof(struct TarHeader))) < 0) {
 961                 error_msg(io_error, real_name, strerror(errno));
 962                 return ( FALSE);
 963         }
 964         /* Pad the header up to the tar block size */
 965         for (; size<TAR_BLOCK_SIZE; size++) {
 966                 write(tbInfo->tarFd, "\0", 1);
 967         }
 968         /* Now do the verbose thing (or not) */
 969         if (tbInfo->verboseFlag==TRUE) {
 970                 FILE *vbFd = stdout;
 971                 if (tbInfo->tarFd == fileno(stdout))    // If the archive goes to stdout, verbose to stderr
 972                         vbFd = stderr;
 973                 fprintf(vbFd, "%s\n", header.name);
 974         }
 975
 976         return ( TRUE);
 977 }
 978
 979
 980 static int writeFileToTarball(const char *fileName, struct stat *statbuf, void* userData)
 981 {
 982         struct TarBallInfo *tbInfo = (struct TarBallInfo *)userData;
 983         const char *header_name;
 984
 985         /*
 986         ** Check to see if we are dealing with a hard link.
 987         ** If so -
 988         ** Treat the first occurance of a given dev/inode as a file while
 989         ** treating any additional occurances as hard links.  This is done
 990         ** by adding the file information to the HardLinkInfo linked list.
 991         */
 992         tbInfo->hlInfo = NULL;
 993         if (statbuf->st_nlink > 1) {
 994                 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf->st_dev,
 995                                 statbuf->st_ino);
 996                 if (tbInfo->hlInfo == NULL)
 997                         addHardLinkInfo (&tbInfo->hlInfoHead, statbuf->st_dev,
 998                                         statbuf->st_ino, statbuf->st_nlink, fileName);
 999         }
1000
1001         /* It is against the rules to archive a socket */
1002         if (S_ISSOCK(statbuf->st_mode)) {
1003                 error_msg("%s: socket ignored", fileName);
1004                 return( TRUE);
1005         }
1006
1007         /* It is a bad idea to store the archive we are in the process of creating,
1008          * so check the device and inode to be sure that this particular file isn't
1009          * the new tarball */
1010         if (tbInfo->statBuf.st_dev == statbuf->st_dev &&
1011                         tbInfo->statBuf.st_ino == statbuf->st_ino) {
1012                 error_msg("%s: file is the archive; skipping", fileName);
1013                 return( TRUE);
1014         }
1015
1016         header_name = fileName;
1017         while (header_name[0] == '/') {
1018                 static int alreadyWarned=FALSE;
1019                 if (alreadyWarned==FALSE) {
1020                         error_msg("Removing leading '/' from member names");
1021                         alreadyWarned=TRUE;
1022                 }
1023                 header_name++;
1024         }
1025
1026         if (strlen(fileName) >= NAME_SIZE) {
1027                 error_msg(name_longer_than_foo, NAME_SIZE);
1028                 return ( TRUE);
1029         }
1030
1031         if (header_name[0] == '\0')
1032                 return TRUE;
1033
1034 #if defined BB_FEATURE_TAR_EXCLUDE
1035         if (exclude_file(tbInfo->excludeList, header_name)) {
1036                 return SKIP;
1037         }
1038 #endif
1039
1040         if (writeTarHeader(tbInfo, header_name, fileName, statbuf)==FALSE) {
1041                 return( FALSE);
1042         }
1043
1044         /* Now, if the file is a regular file, copy it out to the tarball */
1045         if ((tbInfo->hlInfo == NULL)
1046         &&  (S_ISREG(statbuf->st_mode))) {
1047                 int  inputFileFd;
1048                 char buffer[BUFSIZ];
1049                 ssize_t size=0, readSize=0;
1050
1051                 /* open the file we want to archive, and make sure all is well */
1052                 if ((inputFileFd = open(fileName, O_RDONLY)) < 0) {
1053                         error_msg("%s: Cannot open: %s", fileName, strerror(errno));
1054                         return( FALSE);
1055                 }
1056
1057                 /* write the file to the archive */
1058                 while ( (size = full_read(inputFileFd, buffer, sizeof(buffer))) > 0 ) {
1059                         if (full_write(tbInfo->tarFd, buffer, size) != size ) {
1060                                 /* Output file seems to have a problem */
1061                                 error_msg(io_error, fileName, strerror(errno));
1062                                 return( FALSE);
1063                         }
1064                         readSize+=size;
1065                 }
1066                 if (size == -1) {
1067                         error_msg(io_error, fileName, strerror(errno));
1068                         return( FALSE);
1069                 }
1070                 /* Pad the file up to the tar block size */
1071                 for (; (readSize%TAR_BLOCK_SIZE) != 0; readSize++) {
1072                         write(tbInfo->tarFd, "\0", 1);
1073                 }
1074                 close( inputFileFd);
1075         }
1076
1077         return( TRUE);
1078 }
1079
1080 static int writeTarFile(const char* tarName, int verboseFlag, char **argv,
1081                 char** excludeList)
1082 {
1083         int tarFd=-1;
1084         int errorFlag=FALSE;
1085         ssize_t size;
1086         struct TarBallInfo tbInfo;
1087         tbInfo.verboseFlag = verboseFlag;
1088         tbInfo.hlInfoHead = NULL;
1089
1090         /* Make sure there is at least one file to tar up.  */
1091         if (*argv == NULL)
1092                 error_msg_and_die("Cowardly refusing to create an empty archive");
1093
1094         /* Open the tar file for writing.  */
1095         if (!strcmp(tarName, "-"))
1096                 tbInfo.tarFd = fileno(stdout);
1097         else
1098                 tbInfo.tarFd = open (tarName, O_WRONLY | O_CREAT | O_TRUNC, 0644);
1099         if (tbInfo.tarFd < 0) {
1100                 perror_msg( "Error opening '%s'", tarName);
1101                 freeHardLinkInfo(&tbInfo.hlInfoHead);
1102                 return ( FALSE);
1103         }
1104         tbInfo.excludeList=excludeList;
1105         /* Store the stat info for the tarball's file, so
1106          * can avoid including the tarball into itself....  */
1107         if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
1108                 error_msg_and_die(io_error, tarName, strerror(errno));
1109
1110         /* Read the directory/files and iterate over them one at a time */
1111         while (*argv != NULL) {
1112                 if (recursive_action(*argv++, TRUE, FALSE, FALSE,
1113                                         writeFileToTarball, writeFileToTarball,
1114                                         (void*) &tbInfo) == FALSE) {
1115                         errorFlag = TRUE;
1116                 }
1117         }
1118         /* Write two empty blocks to the end of the archive */
1119         for (size=0; size<(2*TAR_BLOCK_SIZE); size++) {
1120                 write(tbInfo.tarFd, "\0", 1);
1121         }
1122
1123         /* To be pedantically correct, we would check if the tarball
1124          * is smaller than 20 tar blocks, and pad it if it was smaller,
1125          * but that isn't necessary for GNU tar interoperability, and
1126          * so is considered a waste of space */
1127
1128         /* Hang up the tools, close up shop, head home */
1129         close(tarFd);
1130         if (errorFlag == TRUE) {
1131                 error_msg("Error exit delayed from previous errors");
1132                 freeHardLinkInfo(&tbInfo.hlInfoHead);
1133                 return(FALSE);
1134         }
1135         freeHardLinkInfo(&tbInfo.hlInfoHead);
1136         return( TRUE);
1137 }
1138
1139
1140 #endif
1141