udhcpc: fix a problem with binary-encoded options #2
[oweals/busybox.git] / archival / ar.c
index 1c598fa164654feea3e3d0104d34d99affb57545..88236e878dad92161cb463af40548ce1eb36ac01 100644 (file)
 /* vi: set sw=4 ts=4: */
 /*
- * Mini ar implementation for busybox 
+ * Mini ar implementation for busybox
  *
  * Copyright (C) 2000 by Glenn McGrath
- * Written by Glenn McGrath <bug1@netconnect.com.au> 1 June 2000
- *             
- * Modified 8 August 2000 by Glenn McGrath 
- *  - now uses getopt
- *  - moved copySubFile function to utilities.c
- *  - creates linked list of all headers 
- *  - easily accessable to other busybox functions  
  *
  * Based in part on BusyBox tar, Debian dpkg-deb and GNU ar.
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
+ * Archive creation support:
+ * Copyright (C) 2010 Nokia Corporation. All rights reserved.
+ * Written by Alexander Shishkin.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- * Last modified 25 August 2000
+ * There is no single standard to adhere to so ar may not portable
+ * between different systems
+ * http://www.unix-systems.org/single_unix_specification_v2/xcu/ar.html
  */
-#include <stdio.h>
-#include <fcntl.h>
-#include <errno.h>
-#include <ctype.h>
-#include <time.h>
-#include <utime.h>
-#include <sys/types.h>
-#include "internal.h"
-
-#define BLOCK_SIZE 60
-#define PRESERVE_DATE 1        /* preserve original dates */
-#define VERBOSE       2        /* be verbose */
-#define DISPLAY       4        /* display contents */
-#define EXT_TO_FILE   8        /* extract contents of archive */
-#define EXT_TO_STDOUT 16       /* extract to stdout */
-
-#define BB_DECLARE_EXTERN
-#define bb_need_io_error
-#include "messages.c"
-
-typedef struct rawArHeader {            /* Byte Offset */
-        char name[16];          /*  0-15 */
-        char date[12];          /* 16-27 */
-        char uid[6], gid[6];    /* 28-39 */
-        char mode[8];           /* 40-47 */
-        char size[10];          /* 48-57 */
-        char fmag[2];           /* 58-59 */
-} rawArHeader_t;
-
-typedef struct headerL {
-       char name[16];
-        size_t size;
-        uid_t uid;
-        gid_t gid;
-        mode_t mode;
-        time_t mtime;
-        off_t offset;
-       struct headerL *next;
-} headerL_t;
 
-/*
- * populate linked list with all ar file entries and offset 
- */
-static int parseArArchive(int srcFd, headerL_t *current)
+//usage:#define ar_trivial_usage
+//usage:       "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
+//usage:#define ar_full_usage "\n\n"
+//usage:       "Extract or list FILES from an ar archive\n"
+//usage:     "\n       -o      Preserve original dates"
+//usage:     "\n       -p      Extract to stdout"
+//usage:     "\n       -t      List"
+//usage:     "\n       -x      Extract"
+//usage:     "\n       -v      Verbose"
+
+#include "libbb.h"
+#include "bb_archive.h"
+#include "ar.h"
+
+#if ENABLE_FEATURE_AR_CREATE
+/* filter out entries with same names as specified on the command line */
+static char FAST_FUNC filter_replaceable(archive_handle_t *handle)
 {
-        off_t lastOffset=0, thisOffset=0;
-        char arVersion[8];
-        rawArHeader_t rawArHeader;
-       
-       lseek(srcFd, 0, SEEK_SET);
-        if (fullRead(srcFd, arVersion, 8) <= 0) {
-                errorMsg("Invalid header magic\n");
-                return (FALSE);
-        }
-        if (strncmp(arVersion,"!<arch>",7) != 0) {
-                errorMsg("This doesnt appear to be an ar archive\n");
-                return(FALSE);
-        }
-        while (fullRead(srcFd, (char *) &rawArHeader, 60) == 60) {
-              if ( (rawArHeader.fmag[0] == '`') &&
-                        (rawArHeader.fmag[1] == '\n')) {
-                        sscanf(rawArHeader.name, "%s", current->name);
-                        parse_mode(rawArHeader.mode, &current->mode);
-                        current->mtime = atoi(rawArHeader.date);
-                        current->uid = atoi(rawArHeader.uid);
-                        current->gid = atoi(rawArHeader.gid);
-                        current->size = (size_t) atoi(rawArHeader.size);
-                        current->offset = lseek(srcFd, 0 , SEEK_CUR);
-                       current->next = (headerL_t *) xmalloc(sizeof(headerL_t));
-                       lastOffset = lseek(srcFd, (off_t) current->size, SEEK_CUR);
-                       current = current->next;
-                }
-                else {  /* GNU ar has an extra char after data */
-                       thisOffset=lseek(srcFd, 0, SEEK_CUR);
-                        if ( (thisOffset - lastOffset) > ((off_t) 61) ) 
-                                return(FALSE);
-                       lseek(srcFd, thisOffset - 59, SEEK_SET);
-                }
-        }
-        return(FALSE);
+       if (find_list_entry(handle->accept, handle->file_header->name))
+               return EXIT_FAILURE;
+
+       return EXIT_SUCCESS;
 }
 
-/*
- * return the headerL_t struct for the specified filename
- */
-static headerL_t *getSubFileHeader(int srcFd, const char filename[16])
+static void output_ar_header(archive_handle_t *handle)
 {
-        headerL_t *list;
-       list = xmalloc(sizeof(headerL_t)); 
-
-        parseArArchive(srcFd, list);
-        while (list->next != NULL) {
-                if (strncmp(list->name, filename, strlen(filename))==0)
-                        return(list);
-                list=list->next;
-        }
-        return(NULL);
+       /* GNU ar 2.19.51.0.14 creates malformed archives
+        * if input files are >10G. It also truncates files >4GB
+        * (uses "size mod 4G"). We abort in this case:
+        * We could add support for up to 10G files, but this is unlikely to be useful.
+        * Note that unpacking side limits all fields to "unsigned int" data type,
+        * and treats "all ones" as an error indicator. Thus max we allow here is UINT_MAX-1.
+        */
+       enum {
+               /* for 2nd field: mtime */
+               MAX11CHARS = UINT_MAX > 0xffffffff ? (unsigned)99999999999 : UINT_MAX-1,
+               /* for last field: filesize */
+               MAX10CHARS = UINT_MAX > 0xffffffff ? (unsigned)9999999999 : UINT_MAX-1,
+       };
+
+       struct file_header_t *fh = handle->file_header;
+
+       if (handle->offset & 1) {
+               xwrite(handle->src_fd, "\n", 1);
+               handle->offset++;
+       }
+
+       /* Careful! The widths should be exact. Fields must be separated */
+       if (sizeof(off_t) > 4 && fh->size > (off_t)MAX10CHARS) {
+               bb_error_msg_and_die("'%s' is bigger than ar can handle", fh->name);
+       }
+       fdprintf(handle->src_fd, "%-16.16s%-12lu%-6u%-6u%-8o%-10"OFF_FMT"u`\n",
+                       fh->name,
+                       (sizeof(time_t) > 4 && fh->mtime > MAX11CHARS) ? (long)0 : (long)fh->mtime,
+                       fh->uid > 99999 ? 0 : (int)fh->uid,
+                       fh->gid > 99999 ? 0 : (int)fh->gid,
+                       (int)fh->mode & 07777777,
+                       fh->size
+       );
+
+       handle->offset += AR_HEADER_LEN;
 }
 
 /*
- * populate linked list with all ar file entries and offset 
+ * when replacing files in an existing archive, copy from the
+ * original archive those files that are to be left intact
  */
-static int displayEntry(int srcFd, const char filename[16], int funct)
+static void FAST_FUNC copy_data(archive_handle_t *handle)
 {
-       headerL_t *file;
+       archive_handle_t *out_handle = handle->ar__out;
+       struct file_header_t *fh = handle->file_header;
 
-       if ((file = getSubFileHeader(srcFd, filename)) == NULL)
-               return(FALSE);
-       if ((funct & VERBOSE) == VERBOSE) {
-               printf("%s %d/%d %8d %s ", modeString(file->mode), file->uid, file->gid, file->size, timeString(file->mtime));
+       out_handle->file_header = fh;
+       output_ar_header(out_handle);
+
+       bb_copyfd_exact_size(handle->src_fd, out_handle->src_fd, fh->size);
+       out_handle->offset += fh->size;
+}
+
+static int write_ar_header(archive_handle_t *handle)
+{
+       char *fn;
+       char fn_h[17]; /* 15 + "/" + NUL */
+       struct stat st;
+       int fd;
+
+       fn = llist_pop(&handle->accept);
+       if (!fn)
+               return -1;
+
+       xstat(fn, &st);
+
+       handle->file_header->mtime = st.st_mtime;
+       handle->file_header->uid = st.st_uid;
+       handle->file_header->gid = st.st_gid;
+       handle->file_header->mode = st.st_mode;
+       handle->file_header->size = st.st_size;
+       handle->file_header->name = fn_h;
+//TODO: if ENABLE_FEATURE_AR_LONG_FILENAMES...
+       sprintf(fn_h, "%.15s/", bb_basename(fn));
+
+       output_ar_header(handle);
+
+       fd = xopen(fn, O_RDONLY);
+       bb_copyfd_exact_size(fd, handle->src_fd, st.st_size);
+       close(fd);
+       handle->offset += st.st_size;
+
+       return 0;
+}
+
+static int write_ar_archive(archive_handle_t *handle)
+{
+       struct stat st;
+       archive_handle_t *out_handle;
+
+       xfstat(handle->src_fd, &st, handle->ar__name);
+
+       /* if archive exists, create a new handle for output.
+        * we create it in place of the old one.
+        */
+       if (st.st_size != 0) {
+               out_handle = init_handle();
+               xunlink(handle->ar__name);
+               out_handle->src_fd = xopen(handle->ar__name, O_WRONLY | O_CREAT | O_TRUNC);
+               out_handle->accept = handle->accept;
+       } else {
+               out_handle = handle;
        }
-       printf("%s\n", file->name);
-       return(TRUE);
+
+       handle->ar__out = out_handle;
+
+       xwrite(out_handle->src_fd, AR_MAGIC "\n", AR_MAGIC_LEN + 1);
+       out_handle->offset += AR_MAGIC_LEN + 1;
+
+       /* skip to the end of the archive if we have to append stuff */
+       if (st.st_size != 0) {
+               handle->filter = filter_replaceable;
+               handle->action_data = copy_data;
+               unpack_ar_archive(handle);
+       }
+
+       while (write_ar_header(out_handle) == 0)
+               continue;
+
+       /* optional, since we exit right after we return */
+       if (ENABLE_FEATURE_CLEAN_UP) {
+               close(handle->src_fd);
+               if (out_handle->src_fd != handle->src_fd)
+                       close(out_handle->src_fd);
+       }
+
+       return EXIT_SUCCESS;
 }
+#endif /* FEATURE_AR_CREATE */
 
-static int extractAr(int srcFd, int dstFd, const char filename[16])
+static void FAST_FUNC header_verbose_list_ar(const file_header_t *file_header)
 {
-        headerL_t *file;
-        if ( (file = getSubFileHeader(srcFd, filename)) == NULL)
-               return(FALSE);
-       lseek(srcFd, file->offset, SEEK_SET);
-       if (copySubFile(srcFd, dstFd, (size_t) file->size) == TRUE)
-               return(TRUE);   
-       return(FALSE);
+       const char *mode = bb_mode_string(file_header->mode);
+       char *mtime;
+
+       mtime = ctime(&file_header->mtime);
+       mtime[16] = ' ';
+       memmove(&mtime[17], &mtime[20], 4);
+       mtime[21] = '\0';
+       printf("%s %u/%u%7"OFF_FMT"u %s %s\n", &mode[1],
+                       (int)file_header->uid, (int)file_header->gid,
+                       file_header->size,
+                       &mtime[4], file_header->name
+       );
 }
 
-extern int ar_main(int argc, char **argv)
+#define AR_OPT_VERBOSE          (1 << 0)
+#define AR_OPT_PRESERVE_DATE    (1 << 1)
+/* "ar r" implies create, but warns about it. c suppresses warning.
+ * bbox accepts but ignores it: */
+#define AR_OPT_CREATE           (1 << 2)
+
+#define AR_CMD_PRINT            (1 << 3)
+#define FIRST_CMD               AR_CMD_PRINT
+#define AR_CMD_LIST             (1 << 4)
+#define AR_CMD_EXTRACT          (1 << 5)
+#define AR_CMD_INSERT           (1 << 6)
+
+int ar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
+int ar_main(int argc UNUSED_PARAM, char **argv)
 {
-        int funct = 0, opt=0;
-       int srcFd=0, dstFd=0;
-       while ((opt = getopt(argc, argv, "ovt:p:x:")) != -1) {
-               switch (opt) {
-               case 'o':
-                       funct = funct | PRESERVE_DATE;
-                       break;
-               case 'v':
-                       funct = funct | VERBOSE;
-                       break;
-               case 't':
-                       funct = funct | DISPLAY;
-               case 'x':
-                       if (opt=='x') {
-                               funct = funct | EXT_TO_FILE;
-                        }
-               case 'p':
-                       if (opt=='p') {
-                               funct = funct | EXT_TO_STDOUT;
-                       }
-                       /* following is common to 't','x' and 'p' */
-                        if (optarg == NULL) {
-                                printf("expected a filename\n");
-                                return(FALSE);
-                        }
-                       if ( (srcFd = open(optarg, O_RDONLY)) < 0) {
-                               errorMsg("Cannot read %s\n", optarg);
-                               return (FALSE);
-                       }
-                       break;
-               default:
-                       usage(ar_usage);
-               }
+       archive_handle_t *archive_handle;
+       unsigned opt, t;
+
+       archive_handle = init_handle();
+
+       /* --: prepend '-' to the first argument if required */
+       /* -1: at least one param is reqd */
+       /* one of p,t,x[,r] is required */
+       opt_complementary = "--:-1:p:t:x"IF_FEATURE_AR_CREATE(":r");
+       opt = getopt32(argv, "voc""ptx"IF_FEATURE_AR_CREATE("r"));
+       argv += optind;
+
+       t = opt / FIRST_CMD;
+       if (t & (t-1)) /* more than one of p,t,x[,r] are specified */
+               bb_show_usage();
+
+       if (opt & AR_CMD_PRINT) {
+               archive_handle->action_data = data_extract_to_stdout;
+       }
+       if (opt & AR_CMD_LIST) {
+               archive_handle->action_header = header_list;
+       }
+       if (opt & AR_CMD_EXTRACT) {
+               archive_handle->action_data = data_extract_all;
+       }
+       if (opt & AR_OPT_PRESERVE_DATE) {
+               archive_handle->ah_flags |= ARCHIVE_RESTORE_DATE;
        }
-        /* check options not just preserve_dates and/or verbose */  
-       if (funct < 4) {
-                usage(ar_usage);
-                return(FALSE);
-        }
-       
-       /* find files to extract */
-       if (optind<argc)
-               for(; optind < argc; optind++) {
-                       if ( (funct & EXT_TO_FILE) == EXT_TO_FILE) {
-                               dstFd = open(argv[optind], O_WRONLY | O_CREAT);
-                               extractAr(srcFd, dstFd, argv[optind]);
-                       }
-                       if ( (funct & EXT_TO_STDOUT) == EXT_TO_STDOUT)  
-                               extractAr(srcFd, fileno(stdout), argv[optind]); 
-                       if ( (funct & DISPLAY) == DISPLAY)
-                               displayEntry(srcFd, argv[optind], funct);
-               }
-       return (TRUE);
+       if (opt & AR_OPT_VERBOSE) {
+               archive_handle->action_header = header_verbose_list_ar;
+       }
+#if ENABLE_FEATURE_AR_CREATE
+       archive_handle->ar__name = *argv;
+#endif
+       archive_handle->src_fd = xopen(*argv++,
+                       (opt & AR_CMD_INSERT)
+                               ? O_RDWR | O_CREAT
+                               : O_RDONLY
+       );
+
+       if (*argv)
+               archive_handle->filter = filter_accept_list;
+       while (*argv) {
+               llist_add_to_end(&archive_handle->accept, *argv++);
+       }
+
+#if ENABLE_FEATURE_AR_CREATE
+       if (opt & AR_CMD_INSERT)
+               return write_ar_archive(archive_handle);
+#endif
+
+       unpack_ar_archive(archive_handle);
+
+       return EXIT_SUCCESS;
 }