archival/ar.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini ar implementation for busybox
   4  *
   5  * Copyright (C) 2000 by Glenn McGrath
   6  *
   7  * Based in part on BusyBox tar, Debian dpkg-deb and GNU ar.
   8  *
   9  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  10  *
  11  * Archive creation support:
  12  * Copyright (C) 2010 Nokia Corporation. All rights reserved.
  13  * Written by Alexander Shishkin.
  14  *
  15  * There is no single standard to adhere to so ar may not portable
  16  * between different systems
  17  * http://www.unix-systems.org/single_unix_specification_v2/xcu/ar.html
  18  */
  19
  20 //kbuild:lib-$(CONFIG_AR) += ar.o
  21
  22 //usage:#define ar_trivial_usage
  23 //usage:       "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
  24 //usage:#define ar_full_usage "\n\n"
  25 //usage:       "Extract or list FILES from an ar archive\n"
  26 //usage:     "\n        -o      Preserve original dates"
  27 //usage:     "\n        -p      Extract to stdout"
  28 //usage:     "\n        -t      List"
  29 //usage:     "\n        -x      Extract"
  30 //usage:     "\n        -v      Verbose"
  31
  32 #include "libbb.h"
  33 #include "bb_archive.h"
  34 #include "ar.h"
  35
  36 #if ENABLE_FEATURE_AR_CREATE
  37 /* filter out entries with same names as specified on the command line */
  38 static char FAST_FUNC filter_replaceable(archive_handle_t *handle)
  39 {
  40         if (find_list_entry(handle->accept, handle->file_header->name))
  41                 return EXIT_FAILURE;
  42
  43         return EXIT_SUCCESS;
  44 }
  45
  46 static void output_ar_header(archive_handle_t *handle)
  47 {
  48         /* GNU ar 2.19.51.0.14 creates malformed archives
  49          * if input files are >10G. It also truncates files >4GB
  50          * (uses "size mod 4G"). We abort in this case:
  51          * We could add support for up to 10G files, but this is unlikely to be useful.
  52          * Note that unpacking side limits all fields to "unsigned int" data type,
  53          * and treats "all ones" as an error indicator. Thus max we allow here is UINT_MAX-1.
  54          */
  55         enum {
  56                 /* for 2nd field: mtime */
  57                 MAX11CHARS = UINT_MAX > 0xffffffff ? (unsigned)99999999999 : UINT_MAX-1,
  58                 /* for last field: filesize */
  59                 MAX10CHARS = UINT_MAX > 0xffffffff ? (unsigned)9999999999 : UINT_MAX-1,
  60         };
  61
  62         struct file_header_t *fh = handle->file_header;
  63
  64         if (handle->offset & 1) {
  65                 xwrite(handle->src_fd, "\n", 1);
  66                 handle->offset++;
  67         }
  68
  69         /* Careful! The widths should be exact. Fields must be separated */
  70         if (sizeof(off_t) > 4 && fh->size > (off_t)MAX10CHARS) {
  71                 bb_error_msg_and_die("'%s' is bigger than ar can handle", fh->name);
  72         }
  73         fdprintf(handle->src_fd, "%-16.16s%-12lu%-6u%-6u%-8o%-10"OFF_FMT"u`\n",
  74                         fh->name,
  75                         (sizeof(time_t) > 4 && fh->mtime > MAX11CHARS) ? (long)0 : (long)fh->mtime,
  76                         fh->uid > 99999 ? 0 : (int)fh->uid,
  77                         fh->gid > 99999 ? 0 : (int)fh->gid,
  78                         (int)fh->mode & 07777777,
  79                         fh->size
  80         );
  81
  82         handle->offset += AR_HEADER_LEN;
  83 }
  84
  85 /*
  86  * when replacing files in an existing archive, copy from the
  87  * original archive those files that are to be left intact
  88  */
  89 static void FAST_FUNC copy_data(archive_handle_t *handle)
  90 {
  91         archive_handle_t *out_handle = handle->ar__out;
  92         struct file_header_t *fh = handle->file_header;
  93
  94         out_handle->file_header = fh;
  95         output_ar_header(out_handle);
  96
  97         bb_copyfd_exact_size(handle->src_fd, out_handle->src_fd, fh->size);
  98         out_handle->offset += fh->size;
  99 }
 100
 101 static int write_ar_header(archive_handle_t *handle)
 102 {
 103         char *fn;
 104         char fn_h[17]; /* 15 + "/" + NUL */
 105         struct stat st;
 106         int fd;
 107
 108         fn = llist_pop(&handle->accept);
 109         if (!fn)
 110                 return -1;
 111
 112         xstat(fn, &st);
 113
 114         handle->file_header->mtime = st.st_mtime;
 115         handle->file_header->uid = st.st_uid;
 116         handle->file_header->gid = st.st_gid;
 117         handle->file_header->mode = st.st_mode;
 118         handle->file_header->size = st.st_size;
 119         handle->file_header->name = fn_h;
 120 //TODO: if ENABLE_FEATURE_AR_LONG_FILENAMES...
 121         sprintf(fn_h, "%.15s/", bb_basename(fn));
 122
 123         output_ar_header(handle);
 124
 125         fd = xopen(fn, O_RDONLY);
 126         bb_copyfd_exact_size(fd, handle->src_fd, st.st_size);
 127         close(fd);
 128         handle->offset += st.st_size;
 129
 130         return 0;
 131 }
 132
 133 static int write_ar_archive(archive_handle_t *handle)
 134 {
 135         struct stat st;
 136         archive_handle_t *out_handle;
 137
 138         xfstat(handle->src_fd, &st, handle->ar__name);
 139
 140         /* if archive exists, create a new handle for output.
 141          * we create it in place of the old one.
 142          */
 143         if (st.st_size != 0) {
 144                 out_handle = init_handle();
 145                 xunlink(handle->ar__name);
 146                 out_handle->src_fd = xopen(handle->ar__name, O_WRONLY | O_CREAT | O_TRUNC);
 147                 out_handle->accept = handle->accept;
 148         } else {
 149                 out_handle = handle;
 150         }
 151
 152         handle->ar__out = out_handle;
 153
 154         xwrite(out_handle->src_fd, AR_MAGIC "\n", AR_MAGIC_LEN + 1);
 155         out_handle->offset += AR_MAGIC_LEN + 1;
 156
 157         /* skip to the end of the archive if we have to append stuff */
 158         if (st.st_size != 0) {
 159                 handle->filter = filter_replaceable;
 160                 handle->action_data = copy_data;
 161                 unpack_ar_archive(handle);
 162         }
 163
 164         while (write_ar_header(out_handle) == 0)
 165                 continue;
 166
 167         /* optional, since we exit right after we return */
 168         if (ENABLE_FEATURE_CLEAN_UP) {
 169                 close(handle->src_fd);
 170                 if (out_handle->src_fd != handle->src_fd)
 171                         close(out_handle->src_fd);
 172         }
 173
 174         return EXIT_SUCCESS;
 175 }
 176 #endif /* FEATURE_AR_CREATE */
 177
 178 static void FAST_FUNC header_verbose_list_ar(const file_header_t *file_header)
 179 {
 180         const char *mode = bb_mode_string(file_header->mode);
 181         char *mtime;
 182
 183         mtime = ctime(&file_header->mtime);
 184         mtime[16] = ' ';
 185         memmove(&mtime[17], &mtime[20], 4);
 186         mtime[21] = '\0';
 187         printf("%s %u/%u%7"OFF_FMT"u %s %s\n", &mode[1],
 188                         (int)file_header->uid, (int)file_header->gid,
 189                         file_header->size,
 190                         &mtime[4], file_header->name
 191         );
 192 }
 193
 194 #define AR_OPT_VERBOSE          (1 << 0)
 195 #define AR_OPT_PRESERVE_DATE    (1 << 1)
 196 /* "ar r" implies create, but warns about it. c suppresses warning.
 197  * bbox accepts but ignores it: */
 198 #define AR_OPT_CREATE           (1 << 2)
 199
 200 #define AR_CMD_PRINT            (1 << 3)
 201 #define FIRST_CMD               AR_CMD_PRINT
 202 #define AR_CMD_LIST             (1 << 4)
 203 #define AR_CMD_EXTRACT          (1 << 5)
 204 #define AR_CMD_INSERT           (1 << 6)
 205
 206 int ar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 207 int ar_main(int argc UNUSED_PARAM, char **argv)
 208 {
 209         archive_handle_t *archive_handle;
 210         unsigned opt, t;
 211
 212         archive_handle = init_handle();
 213
 214         /* --: prepend '-' to the first argument if required */
 215         /* -1: at least one param is reqd */
 216         /* one of p,t,x[,r] is required */
 217         opt_complementary = "--:-1:p:t:x"IF_FEATURE_AR_CREATE(":r");
 218         opt = getopt32(argv, "voc""ptx"IF_FEATURE_AR_CREATE("r"));
 219         argv += optind;
 220
 221         t = opt / FIRST_CMD;
 222         if (t & (t-1)) /* more than one of p,t,x[,r] are specified */
 223                 bb_show_usage();
 224
 225         if (opt & AR_CMD_PRINT) {
 226                 archive_handle->action_data = data_extract_to_stdout;
 227         }
 228         if (opt & AR_CMD_LIST) {
 229                 archive_handle->action_header = header_list;
 230         }
 231         if (opt & AR_CMD_EXTRACT) {
 232                 archive_handle->action_data = data_extract_all;
 233         }
 234         if (opt & AR_OPT_PRESERVE_DATE) {
 235                 archive_handle->ah_flags |= ARCHIVE_RESTORE_DATE;
 236         }
 237         if (opt & AR_OPT_VERBOSE) {
 238                 archive_handle->action_header = header_verbose_list_ar;
 239         }
 240 #if ENABLE_FEATURE_AR_CREATE
 241         archive_handle->ar__name = *argv;
 242 #endif
 243         archive_handle->src_fd = xopen(*argv++,
 244                         (opt & AR_CMD_INSERT)
 245                                 ? O_RDWR | O_CREAT
 246                                 : O_RDONLY
 247         );
 248
 249         if (*argv)
 250                 archive_handle->filter = filter_accept_list;
 251         while (*argv) {
 252                 llist_add_to_end(&archive_handle->accept, *argv++);
 253         }
 254
 255 #if ENABLE_FEATURE_AR_CREATE
 256         if (opt & AR_CMD_INSERT)
 257                 return write_ar_archive(archive_handle);
 258 #endif
 259
 260         unpack_ar_archive(archive_handle);
 261
 262         return EXIT_SUCCESS;
 263 }