blob: a43cc1dffa87f230ada949f0b857638a9ec69d5d [file] [log] [blame]
Eric Andersen86ab8a32000-06-02 03:21:42 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Mini ar implementation for busybox
4 *
5 * Copyright (C) 2000 by Glenn McGrath
6 * Written by Glenn McGrath <bug1@netconnect.com.au> 1 June 2000
7 *
8 * Based in part on BusyBox tar, Debian dpkg-deb and GNU ar.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
Eric Andersen852ff132000-06-16 04:56:40 +000024 * Last modified 10 June 2000
Eric Andersen86ab8a32000-06-02 03:21:42 +000025 */
26
27
28#include <stdio.h>
29#include <fcntl.h>
30#include <errno.h>
31#include <ctype.h>
Eric Andersen852ff132000-06-16 04:56:40 +000032#include <time.h>
33#include <utime.h>
34#include <sys/types.h>
Eric Andersen86ab8a32000-06-02 03:21:42 +000035#include "internal.h"
36
37#define AR_BLOCK_SIZE 60
Eric Andersen57ebebf2000-07-05 17:21:58 +000038#define AR_PRESERVE_DATE 1 /* preserve original dates */
39#define AR_VERBOSE 2 /* be verbose */
40#define AR_DISPLAY 4 /* display contents */
41#define AR_EXT_TO_FILE 8 /* extract contents of archive */
42#define AR_EXT_TO_STDOUT 16 /* extract to stdout */
Eric Andersen852ff132000-06-16 04:56:40 +000043
Eric Andersen86ab8a32000-06-02 03:21:42 +000044#define BB_DECLARE_EXTERN
45#define bb_need_io_error
46#include "messages.c"
47
48struct ArHeader { /* Byte Offset */
49 char ar_name[16]; /* 0-15 */
50 char ar_date[12]; /* 16-27 */
51 char ar_uid[6], ar_gid[6]; /* 28-39 */
52 char ar_mode[8]; /* 40-47 */
53 char ar_size[10]; /* 48-57 */
54 char ar_fmag[2]; /* 58-59 */
55};
56typedef struct ArHeader ArHeader;
57
58struct ArInfo {
59 char name[17]; /* File name */
60 time_t date; /* long int, No of seconds since epoch */
61 uid_t uid; /* unsigned int, Numeric UID */
62 gid_t gid; /* unsigned int, Numeric GID */
63 mode_t mode; /* unsigned int, Unix mode */
64 size_t size; /* int, Size of the file */
65};
66typedef struct ArInfo ArInfo;
67
68static const char ar_usage[] = "ar [optxvV] archive [filenames] \n"
69#ifndef BB_FEATURE_TRIVIAL_HELP
70 "\nExtract or list files from an ar archive.\n\n"
71 "Options:\n"
72 "\to\t\tpreserve original dates\n"
73 "\tp\t\textract to stdout\n"
74 "\tt\t\tlist\n"
75 "\tx\t\textract\n"
76 "\tv\t\tverbosely list files processed\n"
77#endif
78 ;
79
Eric Andersen852ff132000-06-16 04:56:40 +000080/*
81 * Display details of a file, verbosly if funct=2
82 */
83static void displayEntry(struct ArInfo *entry, int funct)
Eric Andersen86ab8a32000-06-02 03:21:42 +000084{
85 /* TODO convert mode to string */
Eric Andersen852ff132000-06-16 04:56:40 +000086 if ((funct & AR_VERBOSE) == AR_VERBOSE)
87 printf("%i %i/%i %8i %s ", entry->mode, entry->uid, entry->gid,
Eric Andersen86ab8a32000-06-02 03:21:42 +000088 entry->size, timeString(entry->date));
89 printf("%s\n", entry->name);
90}
91
Eric Andersen852ff132000-06-16 04:56:40 +000092/* this is from tar.c remove later*/
93static long getOctal(const char *cp, int size)
94{
95 long val = 0;
96
97 for(;(size > 0) && (*cp == ' '); cp++, size--);
98 if ((size == 0) || !isOctal(*cp))
99 return -1;
100 for(; (size > 0) && isOctal(*cp); size--) {
101 val = val * 8 + *cp++ - '0';
102 }
103 for (;(size > 0) && (*cp == ' '); cp++, size--);
104 if ((size > 0) && *cp)
105 return -1;
106 return val;
107}
108
109/*
110 * Converts from the char based struct to a new struct with stricter types
111 */
112static int processArHeader(struct ArHeader *rawHeader, struct ArInfo *header)
Eric Andersen86ab8a32000-06-02 03:21:42 +0000113{
114 int count2;
115 int count;
Eric Andersen852ff132000-06-16 04:56:40 +0000116
117 /* check end of header marker is valid */
118 if ((rawHeader->ar_fmag[0]!='`') || (rawHeader->ar_fmag[1]!='\n'))
119 return(FALSE);
Eric Andersen86ab8a32000-06-02 03:21:42 +0000120
Eric Andersen852ff132000-06-16 04:56:40 +0000121 /* convert filename */
Eric Andersen86ab8a32000-06-02 03:21:42 +0000122 for (count = 0; count < 16; count++) {
Eric Andersen852ff132000-06-16 04:56:40 +0000123 /* allow spaces in filename except at the end */
Eric Andersen86ab8a32000-06-02 03:21:42 +0000124 if (rawHeader->ar_name[count] == ' ') {
125 for (count2 = count; count2 < 16; count2++)
126 if (!isspace(rawHeader->ar_name[count2]))
127 break;
128 if (count2 >= 16)
129 break;
130 }
Eric Andersen852ff132000-06-16 04:56:40 +0000131 /* GNU ar uses '/' as an end of filename marker */
Eric Andersen86ab8a32000-06-02 03:21:42 +0000132 if (rawHeader->ar_name[count] == '/')
133 break;
134 header->name[count] = rawHeader->ar_name[count];
135 }
136 header->name[count] = '\0';
137 header->date = atoi(rawHeader->ar_date);
138 header->uid = atoi(rawHeader->ar_uid);
139 header->gid = atoi(rawHeader->ar_gid);
Eric Andersen852ff132000-06-16 04:56:40 +0000140 header->mode = getOctal(rawHeader->ar_mode, sizeof(rawHeader->ar_mode));
Eric Andersen86ab8a32000-06-02 03:21:42 +0000141 header->size = atoi(rawHeader->ar_size);
142 return (TRUE);
143}
144
145/*
146 * Copy size bytes from current position if srcFd to current position in dstFd
Eric Andersen852ff132000-06-16 04:56:40 +0000147 * taken from tarExtractRegularFile in tar.c, remove later
Eric Andersen86ab8a32000-06-02 03:21:42 +0000148 */
149static int copySubFile(int srcFd, int dstFd, int copySize)
150{
151 int readSize, writeSize, doneSize;
152 char buffer[BUFSIZ];
153
154 while (copySize > 0) {
155 if (copySize > BUFSIZ)
156 readSize = BUFSIZ;
157 else
158 readSize = copySize;
159 writeSize = fullRead(srcFd, buffer, readSize);
160 if (writeSize <= 0) {
Matt Kraaibe84cd42000-07-12 17:02:35 +0000161 errorMsg(io_error, "copySubFile", strerror(errno));
Eric Andersen86ab8a32000-06-02 03:21:42 +0000162 return (FALSE);
163 }
164 doneSize = fullWrite(dstFd, buffer, writeSize);
165 if (doneSize <= 0) {
Matt Kraaibe84cd42000-07-12 17:02:35 +0000166 errorMsg(io_error, "copySubFile", strerror(errno));
Eric Andersen86ab8a32000-06-02 03:21:42 +0000167 return (FALSE);
168 }
169 copySize -= doneSize;
170 }
171 return (TRUE);
172}
173
174/*
Eric Andersen852ff132000-06-16 04:56:40 +0000175 * Extract the file described in ArInfo to the specified path
176 * set the new files uid, gid and mode
Eric Andersen86ab8a32000-06-02 03:21:42 +0000177 */
Eric Andersen852ff132000-06-16 04:56:40 +0000178static int extractToFile(struct ArInfo *file, int funct, int srcFd, const char *path)
Eric Andersen86ab8a32000-06-02 03:21:42 +0000179{
180 int dstFd, temp;
181 struct stat tmpStat;
182 char *pathname = NULL;
Eric Andersen852ff132000-06-16 04:56:40 +0000183 struct utimbuf newtime;
184
Eric Andersen86ab8a32000-06-02 03:21:42 +0000185 if ((temp = isDirectory(path, TRUE, &tmpStat)) != TRUE) {
186 if (!createPath(path, 0777)) {
187 fatalError("Cannot extract to specified path");
188 return (FALSE);
189 }
190 }
191 temp = (strlen(path) + 16);
192 pathname = (char *) xmalloc(temp);
193 pathname = strcpy(pathname, path);
Eric Andersen852ff132000-06-16 04:56:40 +0000194 pathname = strcat(pathname, file->name);
Eric Andersen86ab8a32000-06-02 03:21:42 +0000195 dstFd = device_open(pathname, O_WRONLY | O_CREAT);
Eric Andersen852ff132000-06-16 04:56:40 +0000196 temp = copySubFile(srcFd, dstFd, file->size);
197 fchown(dstFd, file->uid, file->gid);
198 fchmod(dstFd, file->mode);
Eric Andersen86ab8a32000-06-02 03:21:42 +0000199 close(dstFd);
Eric Andersen852ff132000-06-16 04:56:40 +0000200 if ((funct&AR_PRESERVE_DATE)==AR_PRESERVE_DATE)
201 newtime.modtime=file->date;
202 else
203 newtime.modtime=time(0);
204 newtime.actime=time(0);
205 temp = utime(pathname, &newtime);
Eric Andersen86ab8a32000-06-02 03:21:42 +0000206 return (TRUE);
207}
208
Eric Andersen852ff132000-06-16 04:56:40 +0000209/*
210 * Return a file descriptor for the specified file and do error checks
211 */
212static int getArFd(char *filename)
Eric Andersen86ab8a32000-06-02 03:21:42 +0000213{
Eric Andersen852ff132000-06-16 04:56:40 +0000214 int arFd;
215 char arVersion[8];
216
217 arFd = open(filename, O_RDONLY);
218 if (arFd < 0) {
219 errorMsg("Error opening '%s': %s\n", filename, strerror(errno));
220 return (FALSE);
221 }
222 if (fullRead(arFd, arVersion, 8) <= 0) {
Matt Kraaibe84cd42000-07-12 17:02:35 +0000223 errorMsg( "Unexpected EOF in archive\n");
Eric Andersen852ff132000-06-16 04:56:40 +0000224 return (FALSE);
225 }
226 if (strncmp(arVersion,"!<arch>",7) != 0) {
227 errorMsg("ar header fails check ");
228 return(FALSE);
229 }
230 return arFd;
231}
232
233/*
234 * Step through the ar file and process it one entry at a time
235 * fileList[0] is the name of the ar archive
236 * fileList[1] and up are filenames to extract from the archive
237 * funct contains flags to specify the actions to be performed
238 */
239static int readArFile(char *fileList[16], int fileListSize, int funct)
240{
241 int arFd, status, extFileFlag, i, lastOffset=0;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000242 ArHeader rawArHeader;
243 ArInfo arEntry;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000244
Eric Andersen852ff132000-06-16 04:56:40 +0000245 /* open the ar archive */
246 arFd=getArFd(fileList[0]);
247
248 /* read the first header, then loop until ono more headers */
Eric Andersen86ab8a32000-06-02 03:21:42 +0000249 while ((status = fullRead(arFd, (char *) &rawArHeader, AR_BLOCK_SIZE))
250 == AR_BLOCK_SIZE) {
Eric Andersen86ab8a32000-06-02 03:21:42 +0000251
Eric Andersen852ff132000-06-16 04:56:40 +0000252 /* check the header is valid, if not try reading the header
253 agian with an offset of 1, needed as some ar archive end
254 with a '\n' which isnt counted in specified file size */
255 if ((status=processArHeader(&rawArHeader, &arEntry))==FALSE ) {
256 if ((i=lseek(arFd, 0, SEEK_CUR))==(lastOffset+60))
257 lseek(arFd, lastOffset+1, SEEK_SET);
258 else
259 return(FALSE);
260 }
261 else {
262 extFileFlag=0;
263
264 if (funct&AR_DISPLAY)
265 displayEntry(&arEntry, funct);
266
267 /* check file was specified to be extracted only if
268 some file were specified */
269 if ((funct&AR_EXT_TO_FILE) || (funct&AR_EXT_TO_STDOUT)){
270 if (fileListSize==1)
271 extFileFlag=1;
272 else {
273 for( i=1; i<=fileListSize; i++)
274 if ((status=(strcmp(fileList[i],arEntry.name)))==0)
275 extFileFlag=1;
276 }
Eric Andersen86ab8a32000-06-02 03:21:42 +0000277 }
Eric Andersen852ff132000-06-16 04:56:40 +0000278 if (extFileFlag==1) {
279 if (funct&AR_EXT_TO_FILE)
280 extractToFile(&arEntry, funct, arFd, "./");
281 else
282 copySubFile(arFd,fileno(stdout),arEntry.size);
283 }
284 else
285 lseek(arFd, arEntry.size, SEEK_CUR);
286 lastOffset=lseek(arFd, 0, SEEK_CUR);
287 } /* if processArHeader */
288 } /* while */
289 return (TRUE);
Eric Andersen86ab8a32000-06-02 03:21:42 +0000290}
291
292extern int ar_main(int argc, char **argv)
293{
Eric Andersen852ff132000-06-16 04:56:40 +0000294 int funct = 0, ret=0, i=0;
295 char *fileList[16], c, *opt_ptr;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000296
297 if (argc < 2)
298 usage(ar_usage);
299
300 opt_ptr = argv[1];
301 if (*opt_ptr == '-')
302 ++opt_ptr;
303 while ((c = *opt_ptr++) != '\0') {
304 switch (c) {
Eric Andersen57ebebf2000-07-05 17:21:58 +0000305 case 'o':
306 funct = funct | AR_PRESERVE_DATE;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000307 break;
Eric Andersen57ebebf2000-07-05 17:21:58 +0000308 case 'v':
309 funct = funct | AR_VERBOSE;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000310 break;
Eric Andersen57ebebf2000-07-05 17:21:58 +0000311 case 't':
312 funct = funct | AR_DISPLAY;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000313 break;
Eric Andersen57ebebf2000-07-05 17:21:58 +0000314 case 'x':
315 funct = funct | AR_EXT_TO_FILE;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000316 break;
Eric Andersen57ebebf2000-07-05 17:21:58 +0000317 case 'p':
318 funct = funct | AR_EXT_TO_STDOUT;
Eric Andersen86ab8a32000-06-02 03:21:42 +0000319 break;
320 default:
321 usage(ar_usage);
322 }
323 }
Eric Andersen852ff132000-06-16 04:56:40 +0000324
325 for(i=0; i<(argc-2); i++)
326 fileList[i]=argv[i+2];
327
Eric Andersen86ab8a32000-06-02 03:21:42 +0000328 if (funct > 3)
Eric Andersen852ff132000-06-16 04:56:40 +0000329 ret = readArFile(fileList, (argc-2), funct);
330
Eric Andersen86ab8a32000-06-02 03:21:42 +0000331 return (ret);
332}