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