1 /* vi: set sw=4 ts=4: */
3 * Mini tar implementation for busybox
5 * Modifed to use common extraction code used by ar, cpio, dpkg-deb, dpkg
6 * Glenn McGrath <bug1@optushome.com.au>
8 * Note, that as of BusyBox-0.43, tar has been completely rewritten from the
9 * ground up. It still has remnents of the old code lying about, but it is
10 * very different now (i.e., cleaner, less global variables, etc.)
12 * Copyright (C) 1999,2000 by Lineo, inc. and Erik Andersen
13 * Copyright (C) 1999-2002 by Erik Andersen <andersee@debian.org>
15 * Based in part in the tar implementation in sash
16 * Copyright (c) 1999 by David I. Bell
17 * Permission is granted to use, distribute, or modify this source,
18 * provided that this copyright notice remains intact.
19 * Permission to distribute sash derived code under the GPL has been granted.
21 * Based in part on the tar implementation from busybox-0.28
22 * Copyright (C) 1995 Bruce Perens
23 * This is free software under the GNU General Public License.
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
33 * General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
52 #include <sys/socket.h>
53 #include "unarchive.h"
56 #ifdef CONFIG_FEATURE_TAR_CREATE
58 /* Tar file constants */
59 # define TAR_MAGIC "ustar" /* ustar and a null */
60 # define TAR_VERSION " " /* Be compatable with GNU tar format */
63 # define MAJOR(dev) (((dev)>>8)&0xff)
64 # define MINOR(dev) ((dev)&0xff)
67 static const int TAR_BLOCK_SIZE = 512;
68 static const int TAR_MAGIC_LEN = 6;
69 static const int TAR_VERSION_LEN = 2;
71 /* POSIX tar Header Block, from POSIX 1003.1-1990 */
72 enum { NAME_SIZE = 100 }; /* because gcc won't let me use 'static const int' */
75 char name[NAME_SIZE]; /* 0-99 */
76 char mode[8]; /* 100-107 */
77 char uid[8]; /* 108-115 */
78 char gid[8]; /* 116-123 */
79 char size[12]; /* 124-135 */
80 char mtime[12]; /* 136-147 */
81 char chksum[8]; /* 148-155 */
82 char typeflag; /* 156-156 */
83 char linkname[NAME_SIZE]; /* 157-256 */
84 char magic[6]; /* 257-262 */
85 char version[2]; /* 263-264 */
86 char uname[32]; /* 265-296 */
87 char gname[32]; /* 297-328 */
88 char devmajor[8]; /* 329-336 */
89 char devminor[8]; /* 337-344 */
90 char prefix[155]; /* 345-499 */
91 char padding[12]; /* 500-512 (pad to exactly the TAR_BLOCK_SIZE) */
93 typedef struct TarHeader TarHeader;
96 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
97 ** the only functions that deal with the HardLinkInfo structure.
98 ** Even these functions use the xxxHardLinkInfo() functions.
100 typedef struct HardLinkInfo HardLinkInfo;
103 HardLinkInfo *next; /* Next entry in list */
104 dev_t dev; /* Device number */
105 ino_t ino; /* Inode number */
106 short linkCount; /* (Hard) Link Count */
107 char name[1]; /* Start of filename (must be last) */
110 /* Some info to be carried along when creating a new tarball */
113 char* fileName; /* File name of the tarball */
114 int tarFd; /* Open-for-write file descriptor
116 struct stat statBuf; /* Stat info for the tarball, letting
117 us know the inode and device that the
118 tarball lives, so we can avoid trying
119 to include the tarball into itself */
120 int verboseFlag; /* Whether to print extra stuff or not */
121 char** excludeList; /* List of files to not include */
122 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
123 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
125 typedef struct TarBallInfo TarBallInfo;
127 /* A nice enum with all the possible tar file content types */
130 REGTYPE = '0', /* regular file */
131 REGTYPE0 = '\0', /* regular file (ancient bug compat)*/
132 LNKTYPE = '1', /* hard link */
133 SYMTYPE = '2', /* symbolic link */
134 CHRTYPE = '3', /* character special */
135 BLKTYPE = '4', /* block special */
136 DIRTYPE = '5', /* directory */
137 FIFOTYPE = '6', /* FIFO special */
138 CONTTYPE = '7', /* reserved */
139 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
140 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
142 typedef enum TarFileType TarFileType;
144 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
146 addHardLinkInfo (HardLinkInfo **hlInfoHeadPtr, dev_t dev, ino_t ino,
147 short linkCount, const char *name)
149 /* Note: hlInfoHeadPtr can never be NULL! */
150 HardLinkInfo *hlInfo;
152 hlInfo = (HardLinkInfo *)xmalloc(sizeof(HardLinkInfo)+strlen(name)+1);
154 hlInfo->next = *hlInfoHeadPtr;
155 *hlInfoHeadPtr = hlInfo;
158 hlInfo->linkCount = linkCount;
159 strcpy(hlInfo->name, name);
165 freeHardLinkInfo (HardLinkInfo **hlInfoHeadPtr)
167 HardLinkInfo *hlInfo = NULL;
168 HardLinkInfo *hlInfoNext = NULL;
171 hlInfo = *hlInfoHeadPtr;
173 hlInfoNext = hlInfo->next;
177 *hlInfoHeadPtr = NULL;
182 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
183 static HardLinkInfo *
184 findHardLinkInfo (HardLinkInfo *hlInfo, dev_t dev, ino_t ino)
187 if ((ino == hlInfo->ino) && (dev == hlInfo->dev))
189 hlInfo = hlInfo->next;
194 /* Put an octal string into the specified buffer.
195 * The number is zero and space padded and possibly null padded.
196 * Returns TRUE if successful. */
197 static int putOctal (char *cp, int len, long value)
201 char *tempString = tempBuffer;
203 /* Create a string of the specified length with an initial space,
204 * leading zeroes and the octal number, and a trailing null. */
205 sprintf (tempString, "%0*lo", len - 1, value);
207 /* If the string is too large, suppress the leading space. */
208 tempLength = strlen (tempString) + 1;
209 if (tempLength > len) {
214 /* If the string is still too large, suppress the trailing null. */
215 if (tempLength > len)
218 /* If the string is still too large, fail. */
219 if (tempLength > len)
222 /* Copy the string to the field. */
223 memcpy (cp, tempString, len);
228 /* Write out a tar header for the specified file/directory/whatever */
230 writeTarHeader(struct TarBallInfo *tbInfo, const char *header_name,
231 const char *real_name, struct stat *statbuf)
234 struct TarHeader header;
235 const unsigned char *cp = (const unsigned char *) &header;
236 ssize_t size = sizeof(struct TarHeader);
238 memset( &header, 0, size);
240 strncpy(header.name, header_name, sizeof(header.name));
242 putOctal(header.mode, sizeof(header.mode), statbuf->st_mode);
243 putOctal(header.uid, sizeof(header.uid), statbuf->st_uid);
244 putOctal(header.gid, sizeof(header.gid), statbuf->st_gid);
245 putOctal(header.size, sizeof(header.size), 0); /* Regular file size is handled later */
246 putOctal(header.mtime, sizeof(header.mtime), statbuf->st_mtime);
247 strncpy(header.magic, TAR_MAGIC TAR_VERSION,
248 TAR_MAGIC_LEN + TAR_VERSION_LEN );
250 /* Enter the user and group names (default to root if it fails) */
251 my_getpwuid(header.uname, statbuf->st_uid);
253 strcpy(header.uname, "root");
254 my_getgrgid(header.gname, statbuf->st_gid);
256 strcpy(header.uname, "root");
258 if (tbInfo->hlInfo) {
259 /* This is a hard link */
260 header.typeflag = LNKTYPE;
261 strncpy(header.linkname, tbInfo->hlInfo->name, sizeof(header.linkname));
262 } else if (S_ISLNK(statbuf->st_mode)) {
263 char *lpath = xreadlink(real_name);
264 if (!lpath) /* Already printed err msg inside xreadlink() */
266 header.typeflag = SYMTYPE;
267 strncpy(header.linkname, lpath, sizeof(header.linkname));
269 } else if (S_ISDIR(statbuf->st_mode)) {
270 header.typeflag = DIRTYPE;
271 strncat(header.name, "/", sizeof(header.name));
272 } else if (S_ISCHR(statbuf->st_mode)) {
273 header.typeflag = CHRTYPE;
274 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
275 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
276 } else if (S_ISBLK(statbuf->st_mode)) {
277 header.typeflag = BLKTYPE;
278 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
279 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
280 } else if (S_ISFIFO(statbuf->st_mode)) {
281 header.typeflag = FIFOTYPE;
282 } else if (S_ISREG(statbuf->st_mode)) {
283 header.typeflag = REGTYPE;
284 putOctal(header.size, sizeof(header.size), statbuf->st_size);
286 error_msg("%s: Unknown file type", real_name);
290 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
291 * the header). The checksum field must be filled with blanks for the
292 * calculation. The checksum field is formatted differently from the
293 * other fields: it has [6] digits, a null, then a space -- rather than
294 * digits, followed by a null like the other fields... */
295 memset(header.chksum, ' ', sizeof(header.chksum));
296 cp = (const unsigned char *) &header;
299 putOctal(header.chksum, 7, chksum);
301 /* Now write the header out to disk */
302 if ((size=full_write(tbInfo->tarFd, (char*)&header, sizeof(struct TarHeader))) < 0) {
303 error_msg(io_error, real_name, strerror(errno));
306 /* Pad the header up to the tar block size */
307 for (; size<TAR_BLOCK_SIZE; size++) {
308 write(tbInfo->tarFd, "\0", 1);
310 /* Now do the verbose thing (or not) */
312 if (tbInfo->verboseFlag) {
314 if (tbInfo->verboseFlag == 2) // If the archive goes to stdout, verbose to stderr
316 fprintf(vbFd, "%s\n", header.name);
322 # if defined CONFIG_FEATURE_TAR_EXCLUDE
323 static int exclude_file(char **excluded_files, const char *file)
327 if (excluded_files == NULL)
330 for (i = 0; excluded_files[i] != NULL; i++) {
331 if (excluded_files[i][0] == '/') {
332 if (fnmatch(excluded_files[i], file,
333 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
338 for (p = file; p[0] != '\0'; p++) {
339 if ((p == file || p[-1] == '/') && p[0] != '/' &&
340 fnmatch(excluded_files[i], p,
341 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
351 static int writeFileToTarball(const char *fileName, struct stat *statbuf, void* userData)
353 struct TarBallInfo *tbInfo = (struct TarBallInfo *)userData;
354 const char *header_name;
357 ** Check to see if we are dealing with a hard link.
359 ** Treat the first occurance of a given dev/inode as a file while
360 ** treating any additional occurances as hard links. This is done
361 ** by adding the file information to the HardLinkInfo linked list.
363 tbInfo->hlInfo = NULL;
364 if (statbuf->st_nlink > 1) {
365 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf->st_dev,
367 if (tbInfo->hlInfo == NULL)
368 addHardLinkInfo (&tbInfo->hlInfoHead, statbuf->st_dev,
369 statbuf->st_ino, statbuf->st_nlink, fileName);
372 /* It is against the rules to archive a socket */
373 if (S_ISSOCK(statbuf->st_mode)) {
374 error_msg("%s: socket ignored", fileName);
378 /* It is a bad idea to store the archive we are in the process of creating,
379 * so check the device and inode to be sure that this particular file isn't
381 if (tbInfo->statBuf.st_dev == statbuf->st_dev &&
382 tbInfo->statBuf.st_ino == statbuf->st_ino) {
383 error_msg("%s: file is the archive; skipping", fileName);
387 header_name = fileName;
388 while (header_name[0] == '/') {
389 static int alreadyWarned=FALSE;
390 if (alreadyWarned==FALSE) {
391 error_msg("Removing leading '/' from member names");
397 if (strlen(fileName) >= NAME_SIZE) {
398 error_msg(name_longer_than_foo, NAME_SIZE);
402 if (header_name[0] == '\0')
405 # if defined CONFIG_FEATURE_TAR_EXCLUDE
406 if (exclude_file(tbInfo->excludeList, header_name)) {
409 # endif //CONFIG_FEATURE_TAR_EXCLUDE
411 if (writeTarHeader(tbInfo, header_name, fileName, statbuf)==FALSE) {
415 /* Now, if the file is a regular file, copy it out to the tarball */
416 if ((tbInfo->hlInfo == NULL)
417 && (S_ISREG(statbuf->st_mode))) {
420 ssize_t size=0, readSize=0;
422 /* open the file we want to archive, and make sure all is well */
423 if ((inputFileFd = open(fileName, O_RDONLY)) < 0) {
424 error_msg("%s: Cannot open: %s", fileName, strerror(errno));
428 /* write the file to the archive */
429 while ( (size = full_read(inputFileFd, buffer, sizeof(buffer))) > 0 ) {
430 if (full_write(tbInfo->tarFd, buffer, size) != size ) {
431 /* Output file seems to have a problem */
432 error_msg(io_error, fileName, strerror(errno));
438 error_msg(io_error, fileName, strerror(errno));
441 /* Pad the file up to the tar block size */
442 for (; (readSize%TAR_BLOCK_SIZE) != 0; readSize++) {
443 write(tbInfo->tarFd, "\0", 1);
451 static int writeTarFile(const char* tarName, int verboseFlag, char **argv,
452 char** excludeList, int gzip)
454 #ifdef CONFIG_FEATURE_TAR_GZIP
455 int gzipDataPipe [2] = { -1, -1 };
456 int gzipStatusPipe [2] = { -1, -1 };
462 struct TarBallInfo tbInfo;
463 tbInfo.hlInfoHead = NULL;
465 /* Make sure there is at least one file to tar up. */
467 error_msg_and_die("Cowardly refusing to create an empty archive");
469 /* Open the tar file for writing. */
470 if (tarName == NULL) {
471 tbInfo.tarFd = fileno(stdout);
472 tbInfo.verboseFlag = verboseFlag ? 2 : 0;
475 tbInfo.tarFd = open (tarName, O_WRONLY | O_CREAT | O_TRUNC, 0644);
476 tbInfo.verboseFlag = verboseFlag ? 1 : 0;
479 if (tbInfo.tarFd < 0) {
480 perror_msg( "Error opening '%s'", tarName);
481 freeHardLinkInfo(&tbInfo.hlInfoHead);
485 /* Store the stat info for the tarball's file, so
486 * can avoid including the tarball into itself.... */
487 if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
488 error_msg_and_die(io_error, tarName, strerror(errno));
490 #ifdef CONFIG_FEATURE_TAR_GZIP
492 if ( socketpair ( AF_UNIX, SOCK_STREAM, 0, gzipDataPipe ) < 0 || pipe ( gzipStatusPipe ) < 0 )
493 perror_msg_and_die ( "Failed to create gzip pipe" );
495 signal ( SIGPIPE, SIG_IGN ); // we only want EPIPE on errors
499 if ( gzipPid == 0 ) {
500 dup2 ( gzipDataPipe [0], 0 );
501 close ( gzipDataPipe [1] );
503 if ( tbInfo. tarFd != 1 );
504 dup2 ( tbInfo. tarFd, 1 );
506 close ( gzipStatusPipe [0] );
507 fcntl( gzipStatusPipe [1], F_SETFD, FD_CLOEXEC ); // close on exec shows sucess
509 execl ( "/bin/gzip", "gzip", "-f", 0 );
511 write ( gzipStatusPipe [1], "", 1 );
512 close ( gzipStatusPipe [1] );
516 else if ( gzipPid > 0 ) {
517 close ( gzipDataPipe [0] );
518 close ( gzipStatusPipe [1] );
523 int n = read ( gzipStatusPipe [0], &buf, 1 );
525 error_msg_and_die ( "Could not exec gzip process" ); // socket was not closed => error
526 else if (( n < 0 ) && ( errno==EAGAIN || errno==EINTR ))
527 continue; // try it again
530 close ( gzipStatusPipe [0] );
532 tbInfo. tarFd = gzipDataPipe [1];
535 perror_msg_and_die ( "Failed to fork gzip process" );
540 tbInfo.excludeList=excludeList;
542 /* Read the directory/files and iterate over them one at a time */
543 while (*argv != NULL) {
544 if (! recursive_action(*argv++, TRUE, FALSE, FALSE,
545 writeFileToTarball, writeFileToTarball,
550 /* Write two empty blocks to the end of the archive */
551 for (size=0; size<(2*TAR_BLOCK_SIZE); size++) {
552 write(tbInfo.tarFd, "\0", 1);
555 /* To be pedantically correct, we would check if the tarball
556 * is smaller than 20 tar blocks, and pad it if it was smaller,
557 * but that isn't necessary for GNU tar interoperability, and
558 * so is considered a waste of space */
560 /* Hang up the tools, close up shop, head home */
563 error_msg("Error exit delayed from previous errors");
565 freeHardLinkInfo(&tbInfo.hlInfoHead);
567 #ifdef CONFIG_FEATURE_TAR_GZIP
568 if ( gzip && gzipPid ) {
569 if ( waitpid ( gzipPid, NULL, 0 ) == -1 )
570 printf ( "Couldnt wait ?" );
578 void append_file_to_list(const char *new_name, char ***list, int *list_count)
580 *list = realloc(*list, sizeof(char *) * (*list_count + 2));
581 (*list)[*list_count] = xstrdup(new_name);
583 (*list)[*list_count] = NULL;
586 void append_file_list_to_list(char *filename, char ***name_list, int *num_of_entries)
591 src_stream = xfopen(filename, "r");
592 while ((line = get_line_from_file(src_stream)) != NULL) {
594 append_file_to_list(line, name_list, num_of_entries);
600 #ifdef CONFIG_FEATURE_TAR_EXCLUDE
602 * Create a list of names that are in the include list AND NOT in the exclude lists
604 char **list_and_not_list(char **include_list, char **exclude_list)
606 char **new_include_list = NULL;
607 int new_include_count = 0;
608 int include_count = 0;
611 if (include_list == NULL) {
615 while (include_list[include_count] != NULL) {
618 while (exclude_list[exclude_count] != NULL) {
619 if (strcmp(include_list[include_count], exclude_list[exclude_count]) == 0) {
627 new_include_list = realloc(new_include_list, sizeof(char *) * (include_count + 2));
628 new_include_list[new_include_count] = include_list[include_count];
631 free(include_list[include_count]);
635 new_include_list[new_include_count] = NULL;
636 return(new_include_list);
640 int tar_main(int argc, char **argv)
643 /* This is optional */
645 /* Require one and only one of these */
651 FILE *src_stream = NULL;
652 FILE *uncompressed_stream = NULL;
653 char **include_list = NULL;
654 char **exclude_list = NULL;
655 char *src_filename = NULL;
656 char *dst_prefix = NULL;
658 unsigned short untar_funct = 0;
659 unsigned short untar_funct_required = 0;
660 unsigned short extract_function = 0;
661 int include_list_count = 0;
662 #ifdef CONFIG_FEATURE_TAR_EXCLUDE
663 int exclude_list_count = 0;
665 #ifdef CONFIG_FEATURE_TAR_GZIP
674 /* Prepend '-' to the first argument if required */
675 if (argv[1][0] != '-') {
676 char *tmp = xmalloc(strlen(argv[1]) + 2);
678 strcpy(tmp + 1, argv[1]);
682 while ((opt = getopt(argc, argv, "ctxT:X:C:f:Opvz")) != -1) {
685 /* One and only one of these is required */
687 untar_funct_required |= untar_create;
690 untar_funct_required |= untar_list;
691 extract_function |= extract_list |extract_unconditional;
694 untar_funct_required |= untar_extract;
695 extract_function |= (extract_all_to_fs | extract_unconditional | extract_create_leading_dirs);
698 /* These are optional */
699 /* Exclude or Include files listed in <filename>*/
700 #ifdef CONFIG_FEATURE_TAR_EXCLUDE
702 append_file_list_to_list(optarg, &exclude_list, &exclude_list_count);
706 // by default a list is an include list
707 append_file_list_to_list(optarg, &include_list, &include_list_count);
710 case 'C': // Change to dir <optarg>
711 /* Make sure dst_prefix ends in a '/' */
712 dst_prefix = concat_path_file(optarg, "/");
714 case 'f': // archive filename
715 if (strcmp(optarg, "-") == 0) {
718 src_filename = xstrdup(optarg);
722 extract_function |= extract_to_stdout;
727 extract_function |= extract_verbose_list;
729 #ifdef CONFIG_FEATURE_TAR_GZIP
731 untar_funct |= untar_unzip;
739 /* Make sure the valid arguments were passed */
740 if (untar_funct_required == 0) {
741 error_msg_and_die("You must specify one of the `-ctx' options");
743 if ((untar_funct_required != untar_create) &&
744 (untar_funct_required != untar_extract) &&
745 (untar_funct_required != untar_list)) {
746 error_msg_and_die("You may not specify more than one `ctx' option.");
748 untar_funct |= untar_funct_required;
750 /* Setup an array of filenames to work with */
751 while (optind < argc) {
752 append_file_to_list(argv[optind], &include_list, &include_list_count);
755 if (extract_function & (extract_list | extract_all_to_fs)) {
756 if (dst_prefix == NULL) {
757 dst_prefix = xstrdup("./");
760 /* Setup the source of the tar data */
761 if (src_filename != NULL) {
762 src_stream = xfopen(src_filename, "r");
766 #ifdef CONFIG_FEATURE_TAR_GZIP
767 /* Get a binary tree of all the tar file headers */
768 if (untar_funct & untar_unzip) {
769 uncompressed_stream = gz_open(src_stream, &gunzip_pid);
771 #endif // CONFIG_FEATURE_TAR_GZIP
772 uncompressed_stream = src_stream;
774 /* extract or list archive */
775 unarchive(uncompressed_stream, stdout, &get_header_tar, extract_function, dst_prefix, include_list, exclude_list);
776 fclose(uncompressed_stream);
778 #ifdef CONFIG_FEATURE_TAR_CREATE
779 /* create an archive */
780 else if (untar_funct & untar_create) {
781 int verboseFlag = FALSE;
782 int gzipFlag = FALSE;
784 #ifdef CONFIG_FEATURE_TAR_GZIP
785 if (untar_funct & untar_unzip)
788 #endif // CONFIG_FEATURE_TAR_GZIP
789 if (extract_function & extract_verbose_list)
792 writeTarFile(src_filename, verboseFlag, include_list, exclude_list, gzipFlag);
794 #endif // CONFIG_FEATURE_TAR_CREATE
797 #ifdef CONFIG_FEATURE_TAR_GZIP
798 if ( !( untar_funct & untar_create ) && ( untar_funct & untar_unzip )) {
801 gz_close(gunzip_pid);
803 #endif // CONFIG_FEATURE_TAR_GZIP
804 #ifdef CONFIG_FEATURE_CLEAN_UP
809 return(EXIT_SUCCESS);