91baa2ddba8deee891e3eef3cddad3fedb2d058f
[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 pretty
7  * different (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 "internal.h"
40 #define BB_DECLARE_EXTERN
41 #define bb_need_io_error
42 #include "messages.c"
43 #include <stdio.h>
44 #include <dirent.h>
45 #include <errno.h>
46 #include <fcntl.h>
47 #include <signal.h>
48 #include <time.h>
49 #include <utime.h>
50 #include <sys/types.h>
51 #include <sys/sysmacros.h>
52 #include <sys/param.h>                  /* for PATH_MAX */
53
54
55 #ifdef BB_FEATURE_TAR_CREATE
56
57 static const char tar_usage[] =
58         "tar -[cxtvOf] [tarFileName] [FILE] ...\n\n"
59         "Create, extract, or list files from a tar file.  Note that\n"
60         "this version of tar packs hard links as separate files.\n\n"
61         "Options:\n"
62
63         "\tc=create, x=extract, t=list contents, v=verbose,\n"
64         "\tO=extract to stdout, f=tarfile or \"-\" for stdin\n";
65
66 #else
67
68 static const char tar_usage[] =
69         "tar -[xtvOf] [tarFileName] [FILE] ...\n\n"
70         "Extract, or list files stored in a tar file.  This\n"
71         "version of tar does not support creation of tar files.\n\n"
72         "Options:\n"
73
74         "\tx=extract, t=list contents, v=verbose,\n"
75         "\tO=extract to stdout, f=tarfile or \"-\" for stdin\n";
76
77 #endif
78
79
80 /* Tar file constants  */
81 #ifndef MAJOR
82 #define MAJOR(dev) (((dev)>>8)&0xff)
83 #define MINOR(dev) ((dev)&0xff)
84 #endif
85
86
87 /* POSIX tar Header Block, from POSIX 1003.1-1990  */
88 struct TarHeader
89 {
90                                 /* byte offset */
91         char name[100];               /*   0 */
92         char mode[8];                 /* 100 */
93         char uid[8];                  /* 108 */
94         char gid[8];                  /* 116 */
95         char size[12];                /* 124 */
96         char mtime[12];               /* 136 */
97         char chksum[8];               /* 148 */
98         char typeflag;                /* 156 */
99         char linkname[100];           /* 157 */
100         char magic[6];                /* 257 */
101         char version[2];              /* 263 */
102         char uname[32];               /* 265 */
103         char gname[32];               /* 297 */
104         char devmajor[8];             /* 329 */
105         char devminor[8];             /* 337 */
106         char prefix[155];             /* 345 */
107         /* padding                       500 */
108 };
109 typedef struct TarHeader TarHeader;
110
111
112 /* A few useful constants */
113 #define TAR_MAGIC          "ustar"        /* ustar and a null */
114 //#define TAR_VERSION      "00"           /* 00 and no null */
115 #define TAR_VERSION        "  "           /* Be compatable with old GNU format */
116 #define TAR_MAGIC_LEN       6
117 #define TAR_VERSION_LEN     2
118 #define TAR_BLOCK_SIZE      512
119
120 /* A nice enum with all the possible tar file content types */
121 enum TarFileType 
122 {
123         REGTYPE  = '0',            /* regular file */
124         REGTYPE0 = '\0',           /* regular file (ancient bug compat)*/
125         LNKTYPE  = '1',            /* hard link */
126         SYMTYPE  = '2',            /* symbolic link */
127         CHRTYPE  = '3',            /* character special */
128         BLKTYPE  = '4',            /* block special */
129         DIRTYPE  = '5',            /* directory */
130         FIFOTYPE = '6',            /* FIFO special */
131         CONTTYPE = '7',            /* reserved */
132 };
133 typedef enum TarFileType TarFileType;
134
135 /* This struct ignores magic, non-numeric user name, 
136  * non-numeric group name, and the checksum, since
137  * these are all ignored by BusyBox tar. */ 
138 struct TarInfo
139 {
140         int              tarFd;          /* An open file descriptor for reading from the tarball */
141         char *           name;           /* File name */
142         mode_t           mode;           /* Unix mode, including device bits. */
143         uid_t            uid;            /* Numeric UID */
144         gid_t            gid;            /* Numeric GID */
145         size_t           size;           /* Size of file */
146         time_t           mtime;          /* Last-modified time */
147         enum TarFileType type;           /* Regular, directory, link, etc */
148         char *           linkname;       /* Name for symbolic and hard links */
149         long             devmajor;       /* Major number for special device */
150         long             devminor;       /* Minor number for special device */
151 };
152 typedef struct TarInfo TarInfo;
153
154 /* Static data  */
155 static const unsigned long TarChecksumOffset = (const unsigned long)&(((TarHeader *)0)->chksum);
156
157
158 /* Local procedures to restore files from a tar file.  */
159 static int readTarFile(const char* tarName, int extractFlag, int listFlag, 
160                 int tostdoutFlag, int verboseFlag);
161
162
163
164 #ifdef BB_FEATURE_TAR_CREATE
165 /* Local procedures to save files into a tar file.  */
166 static int writeTarFile(const char* tarName, int tostdoutFlag, 
167                 int verboseFlag, int argc, char **argv);
168 static int putOctal(char *cp, int len, long value);
169
170 #endif
171
172
173 extern int tar_main(int argc, char **argv)
174 {
175         const char *tarName=NULL;
176         const char *options;
177         int listFlag     = FALSE;
178         int extractFlag  = FALSE;
179         int createFlag   = FALSE;
180         int verboseFlag  = FALSE;
181         int tostdoutFlag = FALSE;
182
183         argc--;
184         argv++;
185
186         if (argc < 1)
187                 usage(tar_usage);
188
189         /* Parse options  */
190         if (**argv == '-')
191                 options = (*argv++) + 1;
192         else
193                 options = (*argv++);
194         argc--;
195
196         for (; *options; options++) {
197                 switch (*options) {
198                 case 'f':
199                         if (tarName != NULL)
200                                 fatalError( "Only one 'f' option allowed\n");
201
202                         tarName = *argv++;
203                         if (tarName == NULL)
204                                 fatalError( "Option requires an argument: No file specified\n");
205                         argc--;
206
207                         break;
208
209                 case 't':
210                         if (extractFlag == TRUE || createFlag == TRUE)
211                                 goto flagError;
212                         listFlag = TRUE;
213                         break;
214
215                 case 'x':
216                         if (listFlag == TRUE || createFlag == TRUE)
217                                 goto flagError;
218                         extractFlag = TRUE;
219                         break;
220                 case 'c':
221                         if (extractFlag == TRUE || listFlag == TRUE)
222                                 goto flagError;
223                         createFlag = TRUE;
224                         break;
225
226                 case 'v':
227                         verboseFlag = TRUE;
228                         break;
229
230                 case 'O':
231                         tostdoutFlag = TRUE;
232                         tarName = "-";
233                         break;
234
235                 case '-':
236                         usage(tar_usage);
237                         break;
238
239                 default:
240                         fatalError( "Unknown tar flag '%c'\n" 
241                                         "Try `tar --help' for more information\n", *options);
242                 }
243         }
244
245         /* 
246          * Do the correct type of action supplying the rest of the
247          * command line arguments as the list of files to process.
248          */
249         if (createFlag == TRUE) {
250 #ifndef BB_FEATURE_TAR_CREATE
251                 fatalError( "This version of tar was not compiled with tar creation support.\n");
252 #else
253                 exit(writeTarFile(tarName, tostdoutFlag, verboseFlag, argc, argv));
254 #endif
255         } else {
256                 exit(readTarFile(tarName, extractFlag, listFlag, tostdoutFlag, verboseFlag));
257         }
258
259   flagError:
260         fatalError( "Exactly one of 'c', 'x' or 't' must be specified\n");
261 }
262                                         
263 static void
264 fixUpPermissions(TarInfo *header)
265 {
266         struct utimbuf t;
267         /* Now set permissions etc for the new file */
268         chown(header->name, header->uid, header->gid);
269         chmod(header->name, header->mode);
270         /* Reset the time */
271         t.actime = time(0);
272         t.modtime = header->mtime;
273         utime(header->name, &t);
274 }
275                                 
276 static int
277 tarExtractRegularFile(TarInfo *header, int extractFlag, int tostdoutFlag)
278 {
279         size_t  writeSize;
280         size_t  readSize;
281         size_t  actualWriteSz;
282         char    buffer[BUFSIZ];
283         size_t  size = header->size;
284         int outFd=fileno(stdout);
285
286         /* Open the file to be written, if a file is supposed to be written */
287         if (extractFlag==TRUE && tostdoutFlag==FALSE) {
288                 if ((outFd=open(header->name, O_CREAT|O_TRUNC|O_WRONLY, header->mode & ~S_IFMT)) < 0)
289                         errorMsg(io_error, header->name, strerror(errno)); 
290                 /* Create the path to the file, just in case it isn't there...
291                  * This should not screw up path permissions or anything. */
292                 createPath(header->name, 0777);
293         }
294
295         /* Write out the file, if we are supposed to be doing that */
296         while ( size > 0 ) {
297                 actualWriteSz=0;
298                 if ( size > sizeof(buffer) )
299                         writeSize = readSize = sizeof(buffer);
300                 else {
301                         int mod = size % 512;
302                         if ( mod != 0 )
303                                 readSize = size + (512 - mod);
304                         else
305                                 readSize = size;
306                         writeSize = size;
307                 }
308                 if ( (readSize = fullRead(header->tarFd, buffer, readSize)) <= 0 ) {
309                         /* Tarball seems to have a problem */
310                         errorMsg("tar: Unexpected EOF in archive\n"); 
311                         return( FALSE);
312                 }
313                 if ( readSize < writeSize )
314                         writeSize = readSize;
315
316                 /* Write out the file, if we are supposed to be doing that */
317                 if (extractFlag==TRUE) {
318
319                         if ((actualWriteSz=fullWrite(outFd, buffer, writeSize)) != writeSize ) {
320                                 /* Output file seems to have a problem */
321                                 errorMsg(io_error, header->name, strerror(errno)); 
322                                 return( FALSE);
323                         }
324                 }
325
326                 size -= actualWriteSz;
327         }
328
329         /* Now we are done writing the file out, so try 
330          * and fix up the permissions and whatnot */
331         if (extractFlag==TRUE && tostdoutFlag==FALSE) {
332                 close(outFd);
333                 fixUpPermissions(header);
334         }
335         return( TRUE);
336 }
337
338 static int
339 tarExtractDirectory(TarInfo *header, int extractFlag, int tostdoutFlag)
340 {
341
342         if (extractFlag==FALSE || tostdoutFlag==TRUE)
343                 return( TRUE);
344
345         if (createPath(header->name, header->mode) != TRUE) {
346                 errorMsg("tar: %s: Cannot mkdir: %s\n", 
347                                 header->name, strerror(errno)); 
348                 return( FALSE);
349         }
350         /* make the final component, just in case it was
351          * omitted by createPath() (which will skip the
352          * directory if it doesn't have a terminating '/') */
353         if (mkdir(header->name, header->mode) == 0) {
354                 fixUpPermissions(header);
355         }
356         return( TRUE);
357 }
358
359 static int
360 tarExtractHardLink(TarInfo *header, int extractFlag, int tostdoutFlag)
361 {
362         if (extractFlag==FALSE || tostdoutFlag==TRUE)
363                 return( TRUE);
364
365         if (link(header->linkname, header->name) < 0) {
366                 errorMsg("tar: %s: Cannot create hard link to '%s': %s\n", 
367                                 header->name, header->linkname, strerror(errno)); 
368                 return( FALSE);
369         }
370
371         /* Now set permissions etc for the new directory */
372         fixUpPermissions(header);
373         return( TRUE);
374 }
375
376 static int
377 tarExtractSymLink(TarInfo *header, int extractFlag, int tostdoutFlag)
378 {
379         if (extractFlag==FALSE || tostdoutFlag==TRUE)
380                 return( TRUE);
381
382 #ifdef  S_ISLNK
383         if (symlink(header->linkname, header->name) < 0) {
384                 errorMsg("tar: %s: Cannot create symlink to '%s': %s\n", 
385                                 header->name, header->linkname, strerror(errno)); 
386                 return( FALSE);
387         }
388         /* Try to change ownership of the symlink.
389          * If libs doesn't support that, don't bother.
390          * Changing the pointed-to-file is the Wrong Thing(tm).
391          */
392 #if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1)
393         lchown(header->name, header->uid, header->gid);
394 #endif
395
396         /* Do not change permissions or date on symlink,
397          * since it changes the pointed to file instead.  duh. */
398 #else
399         errorMsg("tar: %s: Cannot create symlink to '%s': %s\n", 
400                         header->name, header->linkname, 
401                         "symlinks not supported"); 
402 #endif
403         return( TRUE);
404 }
405
406 static int
407 tarExtractSpecial(TarInfo *header, int extractFlag, int tostdoutFlag)
408 {
409         if (extractFlag==FALSE || tostdoutFlag==TRUE)
410                 return( TRUE);
411
412         if (S_ISCHR(header->mode) || S_ISBLK(header->mode) || S_ISSOCK(header->mode)) {
413                 if (mknod(header->name, header->mode, makedev(header->devmajor, header->devminor)) < 0) {
414                         errorMsg("tar: %s: Cannot mknod: %s\n",
415                                 header->name, strerror(errno)); 
416                         return( FALSE);
417                 }
418         } else if (S_ISFIFO(header->mode)) {
419                 if (mkfifo(header->name, header->mode) < 0) {
420                         errorMsg("tar: %s: Cannot mkfifo: %s\n",
421                                 header->name, strerror(errno)); 
422                         return( FALSE);
423                 }
424         }
425
426         /* Now set permissions etc for the new directory */
427         fixUpPermissions(header);
428         return( TRUE);
429 }
430
431 /* Read an octal value in a field of the specified width, with optional
432  * spaces on both sides of the number and with an optional null character
433  * at the end.  Returns -1 on an illegal format.  */
434 static long getOctal(const char *cp, int size)
435 {
436         long val = 0;
437
438         for(;(size > 0) && (*cp == ' '); cp++, size--);
439         if ((size == 0) || !isOctal(*cp))
440                 return -1;
441         for(; (size > 0) && isOctal(*cp); size--) {
442                 val = val * 8 + *cp++ - '0';
443         }
444         for (;(size > 0) && (*cp == ' '); cp++, size--);
445         if ((size > 0) && *cp)
446                 return -1;
447         return val;
448 }
449
450
451 /* Parse the tar header and fill in the nice struct with the details */
452 static int
453 readTarHeader(struct TarHeader *rawHeader, struct TarInfo *header)
454 {
455         int i;
456         long chksum, sum;
457         unsigned char *s = (unsigned char *)rawHeader;
458
459         header->name  = rawHeader->name;
460         header->mode  = getOctal(rawHeader->mode, sizeof(rawHeader->mode));
461         header->uid   =  getOctal(rawHeader->uid, sizeof(rawHeader->uid));
462         header->gid   =  getOctal(rawHeader->gid, sizeof(rawHeader->gid));
463         header->size  = getOctal(rawHeader->size, sizeof(rawHeader->size));
464         header->mtime = getOctal(rawHeader->mtime, sizeof(rawHeader->mtime));
465         chksum = getOctal(rawHeader->chksum, sizeof(rawHeader->chksum));
466         header->type  = rawHeader->typeflag;
467         header->linkname  = rawHeader->linkname;
468         header->devmajor  = getOctal(rawHeader->devmajor, sizeof(rawHeader->devmajor));
469         header->devminor  = getOctal(rawHeader->devminor, sizeof(rawHeader->devminor));
470
471         /* Check the checksum */
472         sum = ' ' * sizeof(rawHeader->chksum);
473         for ( i = TarChecksumOffset; i > 0; i-- )
474                 sum += *s++;
475         s += sizeof(rawHeader->chksum);       
476         for ( i = (512 - TarChecksumOffset - sizeof(rawHeader->chksum)); i > 0; i-- )
477                 sum += *s++;
478         if (sum == chksum )
479                 return ( TRUE);
480         return( FALSE);
481 }
482
483
484 /*
485  * Read a tar file and extract or list the specified files within it.
486  * If the list is empty than all files are extracted or listed.
487  */
488 static int readTarFile(const char* tarName, int extractFlag, int listFlag, 
489                 int tostdoutFlag, int verboseFlag)
490 {
491         int status, tarFd=0;
492         int errorFlag=FALSE;
493         TarHeader rawHeader;
494         TarInfo header;
495         int alreadyWarned=FALSE;
496         //int skipFileFlag=FALSE;
497
498         /* Open the tar file for reading.  */
499         if (!strcmp(tarName, "-"))
500                 tarFd = fileno(stdin);
501         else
502                 tarFd = open(tarName, O_RDONLY);
503         if (tarFd < 0) {
504                 errorMsg( "Error opening '%s': %s\n", tarName, strerror(errno));
505                 return ( FALSE);
506         }
507
508         /* Set the umask for this process so it doesn't 
509          * screw up permission setting for us later. */
510         umask(0);
511
512         /* Read the tar file, and iterate over it one file at a time */
513         while ( (status = fullRead(tarFd, (char*)&rawHeader, TAR_BLOCK_SIZE)) == TAR_BLOCK_SIZE ) {
514
515                 /* First, try to read the header */
516                 if ( readTarHeader(&rawHeader, &header) == FALSE ) {
517                         close( tarFd);
518                         if ( *(header.name) == '\0' ) {
519                                 goto endgame;
520                         } else {
521                                 errorFlag=TRUE;
522                                 errorMsg("Bad tar header, skipping\n");
523                                 continue;
524                         }
525                 }
526                 if ( *(header.name) == '\0' )
527                                 goto endgame;
528
529                 /* Check for and relativify any absolute paths */
530                 if ( *(header.name) == '/' ) {
531
532                         while (*(header.name) == '/')
533                                 ++*(header.name);
534
535                         if (alreadyWarned == FALSE) {
536                                 errorMsg("Absolute path detected, removing leading slashes\n");
537                                 alreadyWarned = TRUE;
538                         }
539                 }
540
541                 /* Special treatment if the list (-t) flag is on */
542                 if (verboseFlag == TRUE && extractFlag == FALSE) {
543                         int len, len1;
544                         char buf[35];
545                         struct tm *tm = localtime (&(header.mtime));
546
547                         len=printf("%s ", modeString(header.mode));
548                         memset(buf, 0, 8*sizeof(char));
549                         my_getpwuid(buf, header.uid);
550                         if (! *buf)
551                                 len+=printf("%d", header.uid);
552                         else
553                                 len+=printf("%s", buf);
554                         memset(buf, 0, 8*sizeof(char));
555                         my_getgrgid(buf, header.gid);
556                         if (! *buf)
557                                 len+=printf("/%-d ", header.gid);
558                         else
559                                 len+=printf("/%-s ", buf);
560
561                         if (header.type==CHRTYPE || header.type==BLKTYPE) {
562                                 len1=snprintf(buf, sizeof(buf), "%ld,%-ld ", 
563                                                 header.devmajor, header.devminor);
564                         } else {
565                                 len1=snprintf(buf, sizeof(buf), "%d ", header.size);
566                         }
567                         /* Jump through some hoops to make the columns match up */
568                         for(;(len+len1)<31;len++)
569                                 printf(" ");
570                         printf(buf);
571
572                         /* Use ISO 8610 time format */
573                         if (tm) { 
574                                 printf ("%04d-%02d-%02d %02d:%02d:%02d ", 
575                                                 tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday, 
576                                                 tm->tm_hour, tm->tm_min, tm->tm_sec);
577                         }
578                 }
579                 /* List contents if we are supposed to do that */
580                 if (verboseFlag == TRUE || listFlag == TRUE) {
581                         /* Now the normal listing */
582                         printf("%s", header.name);
583                 }
584                 if (verboseFlag == TRUE && listFlag == TRUE) {
585                         /* If this is a link, say so */
586                         if (header.type==LNKTYPE)
587                                 printf(" link to %s", header.linkname);
588                         else if (header.type==SYMTYPE)
589                                 printf(" -> %s", header.linkname);
590                 }
591                 if (verboseFlag == TRUE || listFlag == TRUE) {
592                         printf("\n");
593                 }
594
595 #if 0
596                 /* See if we want to restore this file or not */
597                 skipFileFlag=FALSE;
598                 if (wantFileName(outName) == FALSE) {
599                         skipFileFlag = TRUE;
600                 }
601 #endif
602                 /* Remove any clutter lying in our way */
603                 unlink( header.name);
604
605                 /* If we got here, we can be certain we have a legitimate 
606                  * header to work with.  So work with it.  */
607                 switch ( header.type ) {
608                         case REGTYPE:
609                         case REGTYPE0:
610                                 /* If the name ends in a '/' then assume it is
611                                  * supposed to be a directory, and fall through */
612                                 if (header.name[strlen(header.name)-1] != '/') {
613                                         if (tarExtractRegularFile(&header, extractFlag, tostdoutFlag)==FALSE)
614                                                 errorFlag=TRUE;
615                                         break;
616                                 }
617                         case DIRTYPE:
618                                 if (tarExtractDirectory( &header, extractFlag, tostdoutFlag)==FALSE)
619                                         errorFlag=TRUE;
620                                 break;
621                         case LNKTYPE:
622                                 if (tarExtractHardLink( &header, extractFlag, tostdoutFlag)==FALSE)
623                                         errorFlag=TRUE;
624                                 break;
625                         case SYMTYPE:
626                                 if (tarExtractSymLink( &header, extractFlag, tostdoutFlag)==FALSE)
627                                         errorFlag=TRUE;
628                                 break;
629                         case CHRTYPE:
630                         case BLKTYPE:
631                         case FIFOTYPE:
632                                 if (tarExtractSpecial( &header, extractFlag, tostdoutFlag)==FALSE)
633                                         errorFlag=TRUE;
634                                 break;
635                         default:
636                                 close( tarFd);
637                                 return( FALSE);
638                 }
639         }
640         close(tarFd);
641         if (status > 0) {
642                 /* Bummer - we read a partial header */
643                 errorMsg( "Error reading '%s': %s\n", tarName, strerror(errno));
644                 return ( FALSE);
645         }
646         else if (errorFlag==TRUE) {
647                 errorMsg( "tar: Error exit delayed from previous errors\n");
648                 return( FALSE);
649         } else 
650                 return( status);
651
652         /* Stuff to do when we are done */
653 endgame:
654         close( tarFd);
655         if ( *(header.name) == '\0' ) {
656                 if (errorFlag==TRUE)
657                         errorMsg( "tar: Error exit delayed from previous errors\n");
658                 else
659                         return( TRUE);
660         } 
661         return( FALSE);
662 }
663
664
665 #ifdef BB_FEATURE_TAR_CREATE
666
667 /* Some info to be carried along when creating a new tarball */
668 struct TarBallInfo
669 {
670         char* fileName;               /* File name of the tarball */
671         int tarFd;                    /* Open-for-write file descriptor
672                                                                          for the tarball */
673         struct stat statBuf;          /* Stat info for the tarball, letting
674                                                                          us know the inode and device that the
675                                                                          tarball lives, so we can avoid trying 
676                                                                          to include the tarball into itself */
677         int verboseFlag;              /* Whether to print extra stuff or not */
678 };
679 typedef struct TarBallInfo TarBallInfo;
680
681
682 /* Put an octal string into the specified buffer.
683  * The number is zero and space padded and possibly null padded.
684  * Returns TRUE if successful.  */ 
685 static int putOctal (char *cp, int len, long value)
686 {
687         int tempLength;
688         char tempBuffer[32];
689         char *tempString = tempBuffer;
690
691         /* Create a string of the specified length with an initial space,
692          * leading zeroes and the octal number, and a trailing null.  */
693         sprintf (tempString, "%0*lo", len - 1, value);
694
695         /* If the string is too large, suppress the leading space.  */
696         tempLength = strlen (tempString) + 1;
697         if (tempLength > len) {
698                 tempLength--;
699                 tempString++;
700         }
701
702         /* If the string is still too large, suppress the trailing null.  */
703         if (tempLength > len)
704                 tempLength--;
705
706         /* If the string is still too large, fail.  */
707         if (tempLength > len)
708                 return FALSE;
709
710         /* Copy the string to the field.  */
711         memcpy (cp, tempString, len);
712
713         return TRUE;
714 }
715
716 /* Write out a tar header for the specified file/directory/whatever */
717 static int
718 writeTarHeader(struct TarBallInfo *tbInfo, const char *fileName, struct stat *statbuf)
719 {
720         long chksum=0;
721         struct TarHeader header;
722         const unsigned char *cp = (const unsigned char *) &header;
723         ssize_t size = sizeof(struct TarHeader);
724
725         memset( &header, 0, size);
726
727         if (*fileName=='/') {
728                 static int alreadyWarned=FALSE;
729                 if (alreadyWarned==FALSE) {
730                         errorMsg("tar: Removing leading '/' from member names\n");
731                         alreadyWarned=TRUE;
732                 }
733                 strcpy(header.name, fileName+1); 
734         }
735         else {
736                 strcpy(header.name, fileName); 
737         }
738         putOctal(header.mode, sizeof(header.mode), statbuf->st_mode);
739         putOctal(header.uid, sizeof(header.uid), statbuf->st_uid);
740         putOctal(header.gid, sizeof(header.gid), statbuf->st_gid);
741         putOctal(header.size, sizeof(header.size), 0); /* Regular file size is handled later */
742         putOctal(header.mtime, sizeof(header.mtime), statbuf->st_mtime);
743         strncpy(header.magic, TAR_MAGIC TAR_VERSION, 
744                         TAR_MAGIC_LEN + TAR_VERSION_LEN );
745
746         my_getpwuid(header.uname, statbuf->st_uid);
747         /* Put some sort of sane fallback in place... */
748         if (! *header.uname)
749                 strncpy(header.uname, "root", 5);
750         my_getgrgid(header.gname, statbuf->st_gid);
751         if (! *header.uname)
752                 strncpy(header.uname, "root", 5);
753
754         // FIXME: (or most likely not) I break Hard Links
755         if (S_ISLNK(statbuf->st_mode)) {
756                 char buffer[BUFSIZ];
757                 header.typeflag  = SYMTYPE;
758                 if ( readlink(fileName, buffer, sizeof(buffer) - 1) < 0) {
759                         errorMsg("Error reading symlink '%s': %s\n", header.name, strerror(errno));
760                         return ( FALSE);
761                 }
762                 strncpy(header.linkname, buffer, sizeof(header.linkname)); 
763         } else if (S_ISDIR(statbuf->st_mode)) {
764                 header.typeflag  = DIRTYPE;
765                 strncat(header.name, "/", sizeof(header.name)); 
766         } else if (S_ISCHR(statbuf->st_mode)) {
767                 header.typeflag  = CHRTYPE;
768                 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
769                 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
770         } else if (S_ISBLK(statbuf->st_mode)) {
771                 header.typeflag  = BLKTYPE;
772                 putOctal(header.devmajor, sizeof(header.devmajor), MAJOR(statbuf->st_rdev));
773                 putOctal(header.devminor, sizeof(header.devminor), MINOR(statbuf->st_rdev));
774         } else if (S_ISFIFO(statbuf->st_mode)) {
775                 header.typeflag  = FIFOTYPE;
776         } else if (S_ISREG(statbuf->st_mode)) {
777                 header.typeflag  = REGTYPE;
778                 putOctal(header.size, sizeof(header.size), statbuf->st_size);
779         } else {
780                 errorMsg("tar: %s: Unknown file type\n", fileName);
781                 return ( FALSE);
782         }
783
784         /* Calculate and store the checksum (i.e. the sum of all of the bytes of
785          * the header).  The checksum field must be filled with blanks for the
786          * calculation.  The checksum field is formatted differently from the
787          * other fields: it has [6] digits, a null, then a space -- rather than
788          * digits, followed by a null like the other fields... */
789         memset(header.chksum, ' ', sizeof(header.chksum));
790         cp = (const unsigned char *) &header;
791         while (size-- > 0)
792                 chksum += *cp++;
793         putOctal(header.chksum, 7, chksum);
794         
795         /* Now write the header out to disk */
796         if ((size=fullWrite(tbInfo->tarFd, (char*)&header, sizeof(struct TarHeader))) < 0) {
797                 errorMsg(io_error, fileName, strerror(errno)); 
798                 return ( FALSE);
799         }
800         /* Pad the header up to the tar block size */
801         for (; size<TAR_BLOCK_SIZE; size++) {
802                 write(tbInfo->tarFd, "\0", 1);
803         }
804         /* Now do the verbose thing (or not) */
805         if (tbInfo->verboseFlag==TRUE)
806                 fprintf(stdout, "%s\n", header.name);
807
808         return ( TRUE);
809 }
810
811
812 static int writeFileToTarball(const char *fileName, struct stat *statbuf, void* userData)
813 {
814         struct TarBallInfo *tbInfo = (struct TarBallInfo *)userData;
815
816         /* It is against the rules to archive a socket */
817         if (S_ISSOCK(statbuf->st_mode)) {
818                 errorMsg("tar: %s: socket ignored\n", fileName);
819                 return( TRUE);
820         }
821
822         /* It is a bad idea to store the archive we are in the process of creating,
823          * so check the device and inode to be sure that this particular file isn't
824          * the new tarball */
825         if (tbInfo->statBuf.st_dev == statbuf->st_dev &&
826                         tbInfo->statBuf.st_ino == statbuf->st_ino) {
827                 errorMsg("tar: %s: file is the archive; skipping\n", fileName);
828                 return( TRUE);
829         }
830
831         if (writeTarHeader(tbInfo, fileName, statbuf)==FALSE) {
832                 return( FALSE);
833         } 
834
835         /* Now, if the file is a regular file, copy it out to the tarball */
836         if (S_ISREG(statbuf->st_mode)) {
837                 int  inputFileFd;
838                 char buffer[BUFSIZ];
839                 ssize_t size=0, readSize=0;
840
841                 /* open the file we want to archive, and make sure all is well */
842                 if ((inputFileFd = open(fileName, O_RDONLY)) < 0) {
843                         errorMsg("tar: %s: Cannot open: %s\n", fileName, strerror(errno));
844                         return( FALSE);
845                 }
846                 
847                 /* write the file to the archive */
848                 while ( (size = fullRead(inputFileFd, buffer, sizeof(buffer))) > 0 ) {
849                         if (fullWrite(tbInfo->tarFd, buffer, size) != size ) {
850                                 /* Output file seems to have a problem */
851                                 errorMsg(io_error, fileName, strerror(errno)); 
852                                 return( FALSE);
853                         }
854                         readSize+=size;
855                 }
856                 if (size == -1) {
857                         errorMsg(io_error, fileName, strerror(errno)); 
858                         return( FALSE);
859                 }
860                 /* Pad the file up to the tar block size */
861                 for (; (readSize%TAR_BLOCK_SIZE) != 0; readSize++) {
862                         write(tbInfo->tarFd, "\0", 1);
863                 }
864                 close( inputFileFd);
865         }
866
867         return( TRUE);
868 }
869
870 static int writeTarFile(const char* tarName, int tostdoutFlag, 
871                 int verboseFlag, int argc, char **argv)
872 {
873         int tarFd=-1;
874         int errorFlag=FALSE;
875         ssize_t size;
876         //int skipFileFlag=FALSE;
877         struct TarBallInfo tbInfo;
878         tbInfo.verboseFlag = verboseFlag;
879
880         /* Make sure there is at least one file to tar up.  */
881         if (argc <= 0)
882                 fatalError("tar: Cowardly refusing to create an empty archive\n");
883
884         /* Open the tar file for writing.  */
885         if (tostdoutFlag == TRUE)
886                 tbInfo.tarFd = fileno(stdout);
887         else
888                 tbInfo.tarFd = open (tarName, O_WRONLY | O_CREAT | O_TRUNC, 0644);
889         if (tbInfo.tarFd < 0) {
890                 errorMsg( "tar: Error opening '%s': %s\n", tarName, strerror(errno));
891                 return ( FALSE);
892         }
893         /* Store the stat info for the tarball's file, so
894          * can avoid including the tarball into itself....  */
895         if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
896                 fatalError(io_error, tarName, strerror(errno)); 
897
898         /* Set the umask for this process so it doesn't 
899          * screw up permission setting for us later. */
900         umask(0);
901
902         /* Read the directory/files and iterate over them one at a time */
903         while (argc-- > 0) {
904                 if (recursiveAction(*argv++, TRUE, FALSE, FALSE,
905                                         writeFileToTarball, writeFileToTarball, 
906                                         (void*) &tbInfo) == FALSE) {
907                         errorFlag = TRUE;
908                 }
909         }
910         /* Write two empty blocks to the end of the archive */
911         for (size=0; size<(2*TAR_BLOCK_SIZE); size++) {
912                 write(tbInfo.tarFd, "\0", 1);
913         }
914         /* Hang up the tools, close up shop, head home */
915         close(tarFd);
916         if (errorFlag == TRUE) {
917                 errorMsg("tar: Error exit delayed from previous errors\n");
918                 return(FALSE);
919         }
920         return( TRUE);
921 }
922
923
924 #endif
925