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' */
73 struct TarHeader { /* byte offset */
74 char name[NAME_SIZE]; /* 0-99 */
75 char mode[8]; /* 100-107 */
76 char uid[8]; /* 108-115 */
77 char gid[8]; /* 116-123 */
78 char size[12]; /* 124-135 */
79 char mtime[12]; /* 136-147 */
80 char chksum[8]; /* 148-155 */
81 char typeflag; /* 156-156 */
82 char linkname[NAME_SIZE]; /* 157-256 */
83 char magic[6]; /* 257-262 */
84 char version[2]; /* 263-264 */
85 char uname[32]; /* 265-296 */
86 char gname[32]; /* 297-328 */
87 char devmajor[8]; /* 329-336 */
88 char devminor[8]; /* 337-344 */
89 char prefix[155]; /* 345-499 */
90 char padding[12]; /* 500-512 (pad to exactly the TAR_BLOCK_SIZE) */
92 typedef struct TarHeader TarHeader;
95 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
96 ** the only functions that deal with the HardLinkInfo structure.
97 ** Even these functions use the xxxHardLinkInfo() functions.
99 typedef struct HardLinkInfo HardLinkInfo;
100 struct HardLinkInfo {
101 HardLinkInfo *next; /* Next entry in list */
102 dev_t dev; /* Device number */
103 ino_t ino; /* Inode number */
104 short linkCount; /* (Hard) Link Count */
105 char name[1]; /* Start of filename (must be last) */
108 /* Some info to be carried along when creating a new tarball */
110 char *fileName; /* File name of the tarball */
111 int tarFd; /* Open-for-write file descriptor
113 struct stat statBuf; /* Stat info for the tarball, letting
114 us know the inode and device that the
115 tarball lives, so we can avoid trying
116 to include the tarball into itself */
117 int verboseFlag; /* Whether to print extra stuff or not */
118 const llist_t *excludeList; /* List of files to not include */
119 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
120 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
122 typedef struct TarBallInfo TarBallInfo;
124 /* A nice enum with all the possible tar file content types */
126 REGTYPE = '0', /* regular file */
127 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
128 LNKTYPE = '1', /* hard link */
129 SYMTYPE = '2', /* symbolic link */
130 CHRTYPE = '3', /* character special */
131 BLKTYPE = '4', /* block special */
132 DIRTYPE = '5', /* directory */
133 FIFOTYPE = '6', /* FIFO special */
134 CONTTYPE = '7', /* reserved */
135 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
136 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
138 typedef enum TarFileType TarFileType;
140 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
141 static inline void addHardLinkInfo(HardLinkInfo ** hlInfoHeadPtr, dev_t dev,
142 ino_t ino, short linkCount,
145 /* Note: hlInfoHeadPtr can never be NULL! */
146 HardLinkInfo *hlInfo;
149 (HardLinkInfo *) xmalloc(sizeof(HardLinkInfo) + strlen(name) + 1);
151 hlInfo->next = *hlInfoHeadPtr;
152 *hlInfoHeadPtr = hlInfo;
155 hlInfo->linkCount = linkCount;
156 strcpy(hlInfo->name, name);
161 static void freeHardLinkInfo(HardLinkInfo ** hlInfoHeadPtr)
163 HardLinkInfo *hlInfo = NULL;
164 HardLinkInfo *hlInfoNext = NULL;
167 hlInfo = *hlInfoHeadPtr;
169 hlInfoNext = hlInfo->next;
173 *hlInfoHeadPtr = NULL;
178 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
179 static inline HardLinkInfo *findHardLinkInfo(HardLinkInfo * hlInfo, dev_t dev,
183 if ((ino == hlInfo->ino) && (dev == hlInfo->dev))
185 hlInfo = hlInfo->next;
190 /* Put an octal string into the specified buffer.
191 * The number is zero and space padded and possibly null padded.
192 * Returns TRUE if successful. */
193 static int putOctal(char *cp, int len, long value)
197 char *tempString = tempBuffer;
199 /* Create a string of the specified length with an initial space,
200 * leading zeroes and the octal number, and a trailing null. */
201 sprintf(tempString, "%0*lo", len - 1, value);
203 /* If the string is too large, suppress the leading space. */
204 tempLength = strlen(tempString) + 1;
205 if (tempLength > len) {
210 /* If the string is still too large, suppress the trailing null. */
211 if (tempLength > len)
214 /* If the string is still too large, fail. */
215 if (tempLength > len)
218 /* Copy the string to the field. */
219 memcpy(cp, tempString, len);
224 /* Write out a tar header for the specified file/directory/whatever */
225 static inline int writeTarHeader(struct TarBallInfo *tbInfo,
226 const char *header_name,
227 const char *real_name, struct stat *statbuf)
230 struct TarHeader header;
231 const unsigned char *cp = (const unsigned char *) &header;
232 ssize_t size = sizeof(struct TarHeader);
234 memset(&header, 0, size);
236 strncpy(header.name, header_name, sizeof(header.name));
238 putOctal(header.mode, sizeof(header.mode), statbuf->st_mode);
239 putOctal(header.uid, sizeof(header.uid), statbuf->st_uid);
240 putOctal(header.gid, sizeof(header.gid), statbuf->st_gid);
241 putOctal(header.size, sizeof(header.size), 0); /* Regular file size is handled later */
242 putOctal(header.mtime, sizeof(header.mtime), statbuf->st_mtime);
243 strncpy(header.magic, TAR_MAGIC TAR_VERSION,
244 TAR_MAGIC_LEN + TAR_VERSION_LEN);
246 /* Enter the user and group names (default to root if it fails) */
247 if (my_getpwuid(header.uname, statbuf->st_uid) == NULL)
248 strcpy(header.uname, "root");
249 if (my_getgrgid(header.gname, statbuf->st_gid) == NULL)
250 strcpy(header.gname, "root");
252 if (tbInfo->hlInfo) {
253 /* This is a hard link */
254 header.typeflag = LNKTYPE;
255 strncpy(header.linkname, tbInfo->hlInfo->name,
256 sizeof(header.linkname));
257 } else if (S_ISLNK(statbuf->st_mode)) {
258 char *lpath = xreadlink(real_name);
260 if (!lpath) /* Already printed err msg inside xreadlink() */
262 header.typeflag = SYMTYPE;
263 strncpy(header.linkname, lpath, sizeof(header.linkname));
265 } else if (S_ISDIR(statbuf->st_mode)) {
266 header.typeflag = DIRTYPE;
267 strncat(header.name, "/", sizeof(header.name));
268 } else if (S_ISCHR(statbuf->st_mode)) {
269 header.typeflag = CHRTYPE;
270 putOctal(header.devmajor, sizeof(header.devmajor),
271 MAJOR(statbuf->st_rdev));
272 putOctal(header.devminor, sizeof(header.devminor),
273 MINOR(statbuf->st_rdev));
274 } else if (S_ISBLK(statbuf->st_mode)) {
275 header.typeflag = BLKTYPE;
276 putOctal(header.devmajor, sizeof(header.devmajor),
277 MAJOR(statbuf->st_rdev));
278 putOctal(header.devminor, sizeof(header.devminor),
279 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 */
303 full_write(tbInfo->tarFd, (char *) &header,
304 sizeof(struct TarHeader))) < 0) {
305 error_msg(io_error, real_name, strerror(errno));
308 /* Pad the header up to the tar block size */
309 for (; size < TAR_BLOCK_SIZE; size++) {
310 write(tbInfo->tarFd, "\0", 1);
312 /* Now do the verbose thing (or not) */
314 if (tbInfo->verboseFlag) {
317 if (tbInfo->verboseFlag == 2) /* If the archive goes to stdout, verbose to stderr */
319 fprintf(vbFd, "%s\n", header.name);
325 # if defined CONFIG_FEATURE_TAR_EXCLUDE
326 static inline int exclude_file(const llist_t *excluded_files, const char *file)
328 if (excluded_files == NULL) {
332 while (excluded_files) {
333 if (excluded_files->data[0] == '/') {
334 if (fnmatch(excluded_files->data, file,
335 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
340 for (p = file; p[0] != '\0'; p++) {
341 if ((p == file || p[-1] == '/') && p[0] != '/' &&
342 fnmatch(excluded_files->data, p,
343 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
347 excluded_files = excluded_files->link;
354 static int writeFileToTarball(const char *fileName, struct stat *statbuf,
357 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
358 const char *header_name;
361 ** Check to see if we are dealing with a hard link.
363 ** Treat the first occurance of a given dev/inode as a file while
364 ** treating any additional occurances as hard links. This is done
365 ** by adding the file information to the HardLinkInfo linked list.
367 tbInfo->hlInfo = NULL;
368 if (statbuf->st_nlink > 1) {
369 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf->st_dev,
371 if (tbInfo->hlInfo == NULL)
372 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf->st_dev,
373 statbuf->st_ino, statbuf->st_nlink, fileName);
376 /* It is against the rules to archive a socket */
377 if (S_ISSOCK(statbuf->st_mode)) {
378 error_msg("%s: socket ignored", fileName);
382 /* It is a bad idea to store the archive we are in the process of creating,
383 * so check the device and inode to be sure that this particular file isn't
385 if (tbInfo->statBuf.st_dev == statbuf->st_dev &&
386 tbInfo->statBuf.st_ino == statbuf->st_ino) {
387 error_msg("%s: file is the archive; skipping", fileName);
391 header_name = fileName;
392 while (header_name[0] == '/') {
393 static int alreadyWarned = FALSE;
395 if (alreadyWarned == FALSE) {
396 error_msg("Removing leading '/' from member names");
397 alreadyWarned = TRUE;
402 if (strlen(fileName) >= NAME_SIZE) {
403 error_msg(name_longer_than_foo, NAME_SIZE);
407 if (header_name[0] == '\0')
410 # if defined CONFIG_FEATURE_TAR_EXCLUDE
411 if (exclude_file(tbInfo->excludeList, header_name)) {
414 # endif /* CONFIG_FEATURE_TAR_EXCLUDE */
416 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
420 /* Now, if the file is a regular file, copy it out to the tarball */
421 if ((tbInfo->hlInfo == NULL)
422 && (S_ISREG(statbuf->st_mode))) {
425 ssize_t size = 0, readSize = 0;
427 /* open the file we want to archive, and make sure all is well */
428 if ((inputFileFd = open(fileName, O_RDONLY)) < 0) {
429 error_msg("%s: Cannot open: %s", fileName, strerror(errno));
433 /* write the file to the archive */
434 while ((size = full_read(inputFileFd, buffer, sizeof(buffer))) > 0) {
435 if (full_write(tbInfo->tarFd, buffer, size) != size) {
436 /* Output file seems to have a problem */
437 error_msg(io_error, fileName, strerror(errno));
443 error_msg(io_error, fileName, strerror(errno));
446 /* Pad the file up to the tar block size */
447 for (; (readSize % TAR_BLOCK_SIZE) != 0; readSize++) {
448 write(tbInfo->tarFd, "\0", 1);
456 static inline int writeTarFile(const char *tarName, const int verboseFlag,
457 const llist_t *include, const llist_t *exclude, const int gzip)
459 #ifdef CONFIG_FEATURE_TAR_GZIP
460 int gzipDataPipe[2] = { -1, -1 };
461 int gzipStatusPipe[2] = { -1, -1 };
465 int errorFlag = FALSE;
467 struct TarBallInfo tbInfo;
469 tbInfo.hlInfoHead = NULL;
471 /* Make sure there is at least one file to tar up. */
472 if (include == NULL) {
473 error_msg_and_die("Cowardly refusing to create an empty archive");
476 /* Open the tar file for writing. */
477 if (tarName == NULL) {
478 tbInfo.tarFd = fileno(stdout);
479 tbInfo.verboseFlag = verboseFlag ? 2 : 0;
481 tbInfo.tarFd = open(tarName, O_WRONLY | O_CREAT | O_TRUNC, 0644);
482 tbInfo.verboseFlag = verboseFlag ? 1 : 0;
485 if (tbInfo.tarFd < 0) {
486 perror_msg("Error opening '%s'", tarName);
487 freeHardLinkInfo(&tbInfo.hlInfoHead);
491 /* Store the stat info for the tarball's file, so
492 * can avoid including the tarball into itself.... */
493 if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
494 error_msg_and_die(io_error, tarName, strerror(errno));
496 #ifdef CONFIG_FEATURE_TAR_GZIP
498 if (socketpair(AF_UNIX, SOCK_STREAM, 0, gzipDataPipe) < 0
499 || pipe(gzipStatusPipe) < 0)
500 perror_msg_and_die("Failed to create gzip pipe");
502 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
507 dup2(gzipDataPipe[0], 0);
508 close(gzipDataPipe[1]);
510 if (tbInfo.tarFd != 1);
511 dup2(tbInfo.tarFd, 1);
513 close(gzipStatusPipe[0]);
514 fcntl(gzipStatusPipe[1], F_SETFD, FD_CLOEXEC); /* close on exec shows sucess */
516 execl("/bin/gzip", "gzip", "-f", 0);
518 write(gzipStatusPipe[1], "", 1);
519 close(gzipStatusPipe[1]);
522 } else if (gzipPid > 0) {
523 close(gzipDataPipe[0]);
524 close(gzipStatusPipe[1]);
529 int n = read(gzipStatusPipe[0], &buf, 1);
532 error_msg_and_die("Could not exec gzip process"); /* socket was not closed => error */
533 else if ((n < 0) && (errno == EAGAIN || errno == EINTR))
534 continue; /* try it again */
537 close(gzipStatusPipe[0]);
539 tbInfo.tarFd = gzipDataPipe[1];
541 perror_msg_and_die("Failed to fork gzip process");
546 tbInfo.excludeList = exclude;
548 /* Read the directory/files and iterate over them one at a time */
550 if (!recursive_action(include->data, TRUE, FALSE, FALSE,
551 writeFileToTarball, writeFileToTarball,
555 include = include->link;
557 /* Write two empty blocks to the end of the archive */
558 for (size = 0; size < (2 * TAR_BLOCK_SIZE); size++) {
559 write(tbInfo.tarFd, "\0", 1);
562 /* To be pedantically correct, we would check if the tarball
563 * is smaller than 20 tar blocks, and pad it if it was smaller,
564 * but that isn't necessary for GNU tar interoperability, and
565 * so is considered a waste of space */
567 /* Hang up the tools, close up shop, head home */
570 error_msg("Error exit delayed from previous errors");
572 freeHardLinkInfo(&tbInfo.hlInfoHead);
574 #ifdef CONFIG_FEATURE_TAR_GZIP
575 if (gzip && gzipPid) {
576 if (waitpid(gzipPid, NULL, 0) == -1)
577 printf("Couldnt wait ?");
583 #endif /* tar_create */
585 #ifdef CONFIG_FEATURE_TAR_EXCLUDE
586 static const llist_t *append_file_list_to_list(const char *filename, const llist_t *list)
588 FILE *src_stream = xfopen(filename, "r");
590 char *line = get_line_from_file(src_stream);
595 list = add_to_list(list, line);
604 int tar_main(int argc, char **argv)
606 #ifdef CONFIG_FEATURE_TAR_GZIP
607 char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
609 archive_handle_t *tar_handle;
611 char *base_dir = NULL;
613 #ifdef CONFIG_FEATURE_TAR_CREATE
614 char *src_filename = NULL;
615 unsigned char tar_create = FALSE;
622 /* Initialise default values */
623 tar_handle = init_handle();
624 tar_handle->src_fd = fileno(stdin);
625 tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS;
627 while ((opt = getopt(argc, argv, "ctxT:X:C:f:Opvz")) != -1) {
629 /* One and only one of these is required */
630 #ifdef CONFIG_FEATURE_TAR_CREATE
636 if ((tar_handle->action_header == header_list) ||
637 (tar_handle->action_header == header_verbose_list)) {
638 tar_handle->action_header = header_verbose_list;
640 tar_handle->action_header = header_list;
644 tar_handle->action_data = data_extract_all;
647 /* These are optional */
648 /* Exclude or Include files listed in <filename> */
649 #ifdef CONFIG_FEATURE_TAR_EXCLUDE
652 append_file_list_to_list(optarg, tar_handle->reject);
656 /* by default a list is an include list */
658 case 'C': /* Change to dir <optarg> */
661 case 'f': /* archive filename */
662 #ifdef CONFIG_FEATURE_TAR_CREATE
663 src_filename = optarg;
665 tar_handle->src_fd = xopen(optarg, O_RDONLY);
667 case 'O': /* To stdout */
668 tar_handle->action_data = data_extract_to_stdout;
671 tar_handle->flags |= ARCHIVE_PRESERVE_DATE;
674 if ((tar_handle->action_header == header_list) ||
675 (tar_handle->action_header == header_verbose_list)) {
676 tar_handle->action_header = header_verbose_list;
678 tar_handle->action_header = header_list;
681 #ifdef CONFIG_FEATURE_TAR_GZIP
683 get_header_ptr = get_header_tar_gz;
686 #ifdef CONFIG_FEATURE_TAR_BZIP2
687 /* Not enabled yet */
689 archive_handle->archive_action = bunzip2;
697 /* Check if we are reading from stdin */
698 if ((argv[optind]) && (*argv[optind] == '-')) {
699 /* Default is to read from stdin, so just skip to next arg */
703 /* Setup an array of filenames to work with */
704 /* TODO: This is the same as in ar, seperate function ? */
705 while (optind < argc) {
706 char absolute_path[PATH_MAX];
708 realpath(argv[optind], absolute_path);
709 tar_handle->accept = add_to_list(tar_handle->accept, absolute_path);
711 #ifdef CONFIG_FEATURE_TAR_EXCLUDE
712 if (tar_handle->reject) {
713 tar_handle->filter = filter_accept_reject_list;
716 tar_handle->filter = filter_accept_list;
719 if ((base_dir) && (chdir(base_dir))) {
720 perror_msg_and_die("Couldnt chdir");
723 #ifdef CONFIG_FEATURE_TAR_CREATE
724 /* create an archive */
725 if (tar_create == TRUE) {
726 int verboseFlag = FALSE;
727 int gzipFlag = FALSE;
729 # ifdef CONFIG_FEATURE_TAR_GZIP
730 if (get_header_ptr == get_header_tar_gz) {
734 if (tar_handle->action_header == header_verbose_list) {
737 writeTarFile(src_filename, verboseFlag, tar_handle->accept,
738 tar_handle->reject, gzipFlag);
741 #ifdef CONFIG_FEATURE_TAR_GZIP
742 if (get_header_ptr == get_header_tar_gz) {
743 get_header_tar_gz(tar_handle);
746 while (get_header_tar(tar_handle) == EXIT_SUCCESS);
748 #ifdef CONFIG_FEATURE_CLEAN_UP
749 if (tar_handle->src_fd != fileno(stdin)) {
750 close(tar_handle->src_fd);
754 return(EXIT_SUCCESS);