archival/bbunzip.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Common code for gunzip-like applets
   4  *
   5  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   6  */
   7 #include "libbb.h"
   8 #include "bb_archive.h"
   9
  10 /* lzop_main() uses bbunpack(), need this: */
  11 //kbuild:lib-$(CONFIG_LZOP) += bbunzip.o
  12
  13 /* Note: must be kept in sync with archival/lzop.c */
  14 enum {
  15         OPT_STDOUT     = 1 << 0,
  16         OPT_FORCE      = 1 << 1,
  17         /* only some decompressors: */
  18         OPT_VERBOSE    = 1 << 2,
  19         OPT_QUIET      = 1 << 3,
  20         OPT_DECOMPRESS = 1 << 4,
  21         OPT_TEST       = 1 << 5,
  22         SEAMLESS_MAGIC = (1 << 31) * SEAMLESS_COMPRESSION,
  23 };
  24
  25 static
  26 int open_to_or_warn(int to_fd, const char *filename, int flags, int mode)
  27 {
  28         int fd = open3_or_warn(filename, flags, mode);
  29         if (fd < 0) {
  30                 return 1;
  31         }
  32         xmove_fd(fd, to_fd);
  33         return 0;
  34 }
  35
  36 char* FAST_FUNC append_ext(char *filename, const char *expected_ext)
  37 {
  38         return xasprintf("%s.%s", filename, expected_ext);
  39 }
  40
  41 int FAST_FUNC bbunpack(char **argv,
  42         IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(transformer_aux_data_t *aux),
  43         char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
  44         const char *expected_ext
  45 )
  46 {
  47         struct stat stat_buf;
  48         IF_DESKTOP(long long) int status = 0;
  49         char *filename, *new_name;
  50         smallint exitcode = 0;
  51         transformer_aux_data_t aux;
  52
  53         do {
  54                 /* NB: new_name is *maybe* malloc'ed! */
  55                 new_name = NULL;
  56                 filename = *argv; /* can be NULL - 'streaming' bunzip2 */
  57
  58                 if (filename && LONE_DASH(filename))
  59                         filename = NULL;
  60
  61                 /* Open src */
  62                 if (filename) {
  63                         if (!(option_mask32 & SEAMLESS_MAGIC)) {
  64                                 if (stat(filename, &stat_buf) != 0) {
  65  err_name:
  66                                         bb_simple_perror_msg(filename);
  67  err:
  68                                         exitcode = 1;
  69                                         goto free_name;
  70                                 }
  71                                 if (open_to_or_warn(STDIN_FILENO, filename, O_RDONLY, 0))
  72                                         goto err;
  73                         } else {
  74                                 /* "clever zcat" with FILE */
  75                                 int fd = open_zipped(filename);
  76                                 if (fd < 0)
  77                                         goto err_name;
  78                                 xmove_fd(fd, STDIN_FILENO);
  79                         }
  80                 } else
  81                 if (option_mask32 & SEAMLESS_MAGIC) {
  82                         /* "clever zcat" on stdin */
  83                         if (setup_unzip_on_fd(STDIN_FILENO, /*fail_if_not_detected*/ 0))
  84                                 goto err;
  85                 }
  86
  87                 /* Special cases: test, stdout */
  88                 if (option_mask32 & (OPT_STDOUT|OPT_TEST)) {
  89                         if (option_mask32 & OPT_TEST)
  90                                 if (open_to_or_warn(STDOUT_FILENO, bb_dev_null, O_WRONLY, 0))
  91                                         xfunc_die();
  92                         filename = NULL;
  93                 }
  94
  95                 /* Open dst if we are going to unpack to file */
  96                 if (filename) {
  97                         new_name = make_new_name(filename, expected_ext);
  98                         if (!new_name) {
  99                                 bb_error_msg("%s: unknown suffix - ignored", filename);
 100                                 goto err;
 101                         }
 102
 103                         /* -f: overwrite existing output files */
 104                         if (option_mask32 & OPT_FORCE) {
 105                                 unlink(new_name);
 106                         }
 107
 108                         /* O_EXCL: "real" bunzip2 doesn't overwrite files */
 109                         /* GNU gunzip does not bail out, but goes to next file */
 110                         if (open_to_or_warn(STDOUT_FILENO, new_name, O_WRONLY | O_CREAT | O_EXCL,
 111                                         stat_buf.st_mode))
 112                                 goto err;
 113                 }
 114
 115                 /* Check that the input is sane */
 116                 if (!(option_mask32 & OPT_FORCE) && isatty(STDIN_FILENO)) {
 117                         bb_error_msg_and_die("compressed data not read from terminal, "
 118                                         "use -f to force it");
 119                 }
 120
 121                 if (!(option_mask32 & SEAMLESS_MAGIC)) {
 122                         init_transformer_aux_data(&aux);
 123                         aux.check_signature = 1;
 124                         status = unpacker(&aux);
 125                         if (status < 0)
 126                                 exitcode = 1;
 127                 } else {
 128                         if (bb_copyfd_eof(STDIN_FILENO, STDOUT_FILENO) < 0)
 129                                 /* Disk full, tty closed, etc. No point in continuing */
 130                                 xfunc_die();
 131                 }
 132
 133                 if (!(option_mask32 & OPT_STDOUT))
 134                         xclose(STDOUT_FILENO); /* with error check! */
 135
 136                 if (filename) {
 137                         char *del = new_name;
 138
 139                         if (status >= 0) {
 140                                 unsigned new_name_len;
 141
 142                                 /* TODO: restore other things? */
 143                                 if (aux.mtime != 0) {
 144                                         struct timeval times[2];
 145
 146                                         times[1].tv_sec = times[0].tv_sec = aux.mtime;
 147                                         times[1].tv_usec = times[0].tv_usec = 0;
 148                                         /* Note: we closed it first.
 149                                          * On some systems calling utimes
 150                                          * then closing resets the mtime
 151                                          * back to current time. */
 152                                         utimes(new_name, times); /* ignoring errors */
 153                                 }
 154
 155                                 if (ENABLE_DESKTOP)
 156                                         new_name_len = strlen(new_name);
 157                                 /* Restore source filename (unless tgz -> tar case) */
 158                                 if (new_name == filename) {
 159                                         new_name_len = strlen(filename);
 160                                         filename[new_name_len] = '.';
 161                                 }
 162                                 /* Extreme bloat for gunzip compat */
 163                                 /* Some users do want this info... */
 164                                 if (ENABLE_DESKTOP && (option_mask32 & OPT_VERBOSE)) {
 165                                         unsigned percent = status
 166                                                 ? ((uoff_t)stat_buf.st_size * 100u / (unsigned long long)status)
 167                                                 : 0;
 168                                         fprintf(stderr, "%s: %u%% - replaced with %.*s\n",
 169                                                 filename,
 170                                                 100u - percent,
 171                                                 new_name_len, new_name
 172                                         );
 173                                 }
 174                                 /* Delete _source_ file */
 175                                 del = filename;
 176                         }
 177                         xunlink(del);
 178  free_name:
 179                         if (new_name != filename)
 180                                 free(new_name);
 181                 }
 182         } while (*argv && *++argv);
 183
 184         if (option_mask32 & OPT_STDOUT)
 185                 xclose(STDOUT_FILENO); /* with error check! */
 186
 187         return exitcode;
 188 }
 189
 190 #if ENABLE_UNCOMPRESS || ENABLE_BUNZIP2 || ENABLE_UNLZMA || ENABLE_UNXZ
 191 static
 192 char* FAST_FUNC make_new_name_generic(char *filename, const char *expected_ext)
 193 {
 194         char *extension = strrchr(filename, '.');
 195         if (!extension || strcmp(extension + 1, expected_ext) != 0) {
 196                 /* Mimic GNU gunzip - "real" bunzip2 tries to */
 197                 /* unpack file anyway, to file.out */
 198                 return NULL;
 199         }
 200         *extension = '\0';
 201         return filename;
 202 }
 203 #endif
 204
 205
 206 /*
 207  * Uncompress applet for busybox (c) 2002 Glenn McGrath
 208  *
 209  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
 210  */
 211 //usage:#define uncompress_trivial_usage
 212 //usage:       "[-cf] [FILE]..."
 213 //usage:#define uncompress_full_usage "\n\n"
 214 //usage:       "Decompress .Z file[s]\n"
 215 //usage:     "\n        -c      Write to stdout"
 216 //usage:     "\n        -f      Overwrite"
 217
 218 //kbuild:lib-$(CONFIG_UNCOMPRESS) += bbunzip.o
 219 #if ENABLE_UNCOMPRESS
 220 static
 221 IF_DESKTOP(long long) int FAST_FUNC unpack_uncompress(transformer_aux_data_t *aux)
 222 {
 223         return unpack_Z_stream(aux, STDIN_FILENO, STDOUT_FILENO);
 224 }
 225 int uncompress_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 226 int uncompress_main(int argc UNUSED_PARAM, char **argv)
 227 {
 228         getopt32(argv, "cf");
 229         argv += optind;
 230
 231         return bbunpack(argv, unpack_uncompress, make_new_name_generic, "Z");
 232 }
 233 #endif
 234
 235
 236 /*
 237  * Gzip implementation for busybox
 238  *
 239  * Based on GNU gzip v1.2.4 Copyright (C) 1992-1993 Jean-loup Gailly.
 240  *
 241  * Originally adjusted for busybox by Sven Rudolph <sr1@inf.tu-dresden.de>
 242  * based on gzip sources
 243  *
 244  * Adjusted further by Erik Andersen <andersen@codepoet.org> to support files as
 245  * well as stdin/stdout, and to generally behave itself wrt command line
 246  * handling.
 247  *
 248  * General cleanup to better adhere to the style guide and make use of standard
 249  * busybox functions by Glenn McGrath
 250  *
 251  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
 252  *
 253  * gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
 254  * Copyright (C) 1992-1993 Jean-loup Gailly
 255  * The unzip code was written and put in the public domain by Mark Adler.
 256  * Portions of the lzw code are derived from the public domain 'compress'
 257  * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
 258  * Ken Turkowski, Dave Mack and Peter Jannesen.
 259  *
 260  * See the license_msg below and the file COPYING for the software license.
 261  * See the file algorithm.doc for the compression algorithms and file formats.
 262  */
 263 //usage:#define gunzip_trivial_usage
 264 //usage:       "[-cft] [FILE]..."
 265 //usage:#define gunzip_full_usage "\n\n"
 266 //usage:       "Decompress FILEs (or stdin)\n"
 267 //usage:     "\n        -c      Write to stdout"
 268 //usage:     "\n        -f      Force"
 269 //usage:     "\n        -t      Test file integrity"
 270 //usage:
 271 //usage:#define gunzip_example_usage
 272 //usage:       "$ ls -la /tmp/BusyBox*\n"
 273 //usage:       "-rw-rw-r--    1 andersen andersen   557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n"
 274 //usage:       "$ gunzip /tmp/BusyBox-0.43.tar.gz\n"
 275 //usage:       "$ ls -la /tmp/BusyBox*\n"
 276 //usage:       "-rw-rw-r--    1 andersen andersen  1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
 277 //usage:
 278 //usage:#define zcat_trivial_usage
 279 //usage:       "[FILE]..."
 280 //usage:#define zcat_full_usage "\n\n"
 281 //usage:       "Decompress to stdout"
 282
 283 //kbuild:lib-$(CONFIG_GZIP) += bbunzip.o
 284 //kbuild:lib-$(CONFIG_GUNZIP) += bbunzip.o
 285 #if ENABLE_GUNZIP
 286 static
 287 char* FAST_FUNC make_new_name_gunzip(char *filename, const char *expected_ext UNUSED_PARAM)
 288 {
 289         char *extension = strrchr(filename, '.');
 290
 291         if (!extension)
 292                 return NULL;
 293
 294         extension++;
 295         if (strcmp(extension, "tgz" + 1) == 0
 296 #if ENABLE_FEATURE_SEAMLESS_Z
 297          || (extension[0] == 'Z' && extension[1] == '\0')
 298 #endif
 299         ) {
 300                 extension[-1] = '\0';
 301         } else if (strcmp(extension, "tgz") == 0) {
 302                 filename = xstrdup(filename);
 303                 extension = strrchr(filename, '.');
 304                 extension[2] = 'a';
 305                 extension[3] = 'r';
 306         } else {
 307                 return NULL;
 308         }
 309         return filename;
 310 }
 311 static
 312 IF_DESKTOP(long long) int FAST_FUNC unpack_gunzip(transformer_aux_data_t *aux)
 313 {
 314         return unpack_gz_stream(aux, STDIN_FILENO, STDOUT_FILENO);
 315 }
 316 /*
 317  * Linux kernel build uses gzip -d -n. We accept and ignore it.
 318  * Man page says:
 319  * -n --no-name
 320  * gzip: do not save the original file name and time stamp.
 321  * (The original name is always saved if the name had to be truncated.)
 322  * gunzip: do not restore the original file name/time even if present
 323  * (remove only the gzip suffix from the compressed file name).
 324  * This option is the default when decompressing.
 325  * -N --name
 326  * gzip: always save the original file name and time stamp (this is the default)
 327  * gunzip: restore the original file name and time stamp if present.
 328  */
 329 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 330 int gunzip_main(int argc UNUSED_PARAM, char **argv)
 331 {
 332         getopt32(argv, "cfvqdtn");
 333         argv += optind;
 334
 335         /* If called as zcat...
 336          * Normally, "zcat" is just "gunzip -c".
 337          * But if seamless magic is enabled, then we are much more clever.
 338          */
 339         if (applet_name[1] == 'c')
 340                 option_mask32 |= OPT_STDOUT | SEAMLESS_MAGIC;
 341
 342         return bbunpack(argv, unpack_gunzip, make_new_name_gunzip, /*unused:*/ NULL);
 343 }
 344 #endif
 345
 346
 347 /*
 348  * Modified for busybox by Glenn McGrath
 349  * Added support output to stdout by Thomas Lundquist <thomasez@zelow.no>
 350  *
 351  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
 352  */
 353 //usage:#define bunzip2_trivial_usage
 354 //usage:       "[-cf] [FILE]..."
 355 //usage:#define bunzip2_full_usage "\n\n"
 356 //usage:       "Decompress FILEs (or stdin)\n"
 357 //usage:     "\n        -c      Write to stdout"
 358 //usage:     "\n        -f      Force"
 359 //usage:#define bzcat_trivial_usage
 360 //usage:       "[FILE]..."
 361 //usage:#define bzcat_full_usage "\n\n"
 362 //usage:       "Decompress to stdout"
 363
 364 //applet:IF_BUNZIP2(APPLET(bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP))
 365 //applet:IF_BUNZIP2(APPLET_ODDNAME(bzcat, bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP, bzcat))
 366 //kbuild:lib-$(CONFIG_BZIP2) += bbunzip.o
 367 //kbuild:lib-$(CONFIG_BUNZIP2) += bbunzip.o
 368 #if ENABLE_BUNZIP2
 369 static
 370 IF_DESKTOP(long long) int FAST_FUNC unpack_bunzip2(transformer_aux_data_t *aux)
 371 {
 372         return unpack_bz2_stream(aux, STDIN_FILENO, STDOUT_FILENO);
 373 }
 374 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 375 int bunzip2_main(int argc UNUSED_PARAM, char **argv)
 376 {
 377         getopt32(argv, "cfvqdt");
 378         argv += optind;
 379         if (applet_name[2] == 'c') /* bzcat */
 380                 option_mask32 |= OPT_STDOUT;
 381
 382         return bbunpack(argv, unpack_bunzip2, make_new_name_generic, "bz2");
 383 }
 384 #endif
 385
 386
 387 /*
 388  * Small lzma deflate implementation.
 389  * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 390  *
 391  * Based on bunzip.c from busybox
 392  *
 393  * Licensed under GPLv2, see file LICENSE in this source tree.
 394  */
 395 //usage:#define unlzma_trivial_usage
 396 //usage:       "[-cf] [FILE]..."
 397 //usage:#define unlzma_full_usage "\n\n"
 398 //usage:       "Decompress FILE (or stdin)\n"
 399 //usage:     "\n        -c      Write to stdout"
 400 //usage:     "\n        -f      Force"
 401 //usage:
 402 //usage:#define lzma_trivial_usage
 403 //usage:       "-d [-cf] [FILE]..."
 404 //usage:#define lzma_full_usage "\n\n"
 405 //usage:       "Decompress FILE (or stdin)\n"
 406 //usage:     "\n        -d      Decompress"
 407 //usage:     "\n        -c      Write to stdout"
 408 //usage:     "\n        -f      Force"
 409 //usage:
 410 //usage:#define lzcat_trivial_usage
 411 //usage:       "[FILE]..."
 412 //usage:#define lzcat_full_usage "\n\n"
 413 //usage:       "Decompress to stdout"
 414 //usage:
 415 //usage:#define unxz_trivial_usage
 416 //usage:       "[-cf] [FILE]..."
 417 //usage:#define unxz_full_usage "\n\n"
 418 //usage:       "Decompress FILE (or stdin)\n"
 419 //usage:     "\n        -c      Write to stdout"
 420 //usage:     "\n        -f      Force"
 421 //usage:
 422 //usage:#define xz_trivial_usage
 423 //usage:       "-d [-cf] [FILE]..."
 424 //usage:#define xz_full_usage "\n\n"
 425 //usage:       "Decompress FILE (or stdin)\n"
 426 //usage:     "\n        -d      Decompress"
 427 //usage:     "\n        -c      Write to stdout"
 428 //usage:     "\n        -f      Force"
 429 //usage:
 430 //usage:#define xzcat_trivial_usage
 431 //usage:       "[FILE]..."
 432 //usage:#define xzcat_full_usage "\n\n"
 433 //usage:       "Decompress to stdout"
 434
 435 //kbuild:lib-$(CONFIG_UNLZMA) += bbunzip.o
 436 #if ENABLE_UNLZMA
 437 static
 438 IF_DESKTOP(long long) int FAST_FUNC unpack_unlzma(transformer_aux_data_t *aux)
 439 {
 440         return unpack_lzma_stream(aux, STDIN_FILENO, STDOUT_FILENO);
 441 }
 442 int unlzma_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 443 int unlzma_main(int argc UNUSED_PARAM, char **argv)
 444 {
 445         IF_LZMA(int opts =) getopt32(argv, "cfvqdt");
 446 # if ENABLE_LZMA
 447         /* lzma without -d or -t? */
 448         if (applet_name[2] == 'm' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
 449                 bb_show_usage();
 450 # endif
 451         /* lzcat? */
 452         if (applet_name[2] == 'c')
 453                 option_mask32 |= OPT_STDOUT;
 454
 455         argv += optind;
 456         return bbunpack(argv, unpack_unlzma, make_new_name_generic, "lzma");
 457 }
 458 #endif
 459
 460
 461 //kbuild:lib-$(CONFIG_UNXZ) += bbunzip.o
 462 #if ENABLE_UNXZ
 463 static
 464 IF_DESKTOP(long long) int FAST_FUNC unpack_unxz(transformer_aux_data_t *aux)
 465 {
 466         return unpack_xz_stream(aux, STDIN_FILENO, STDOUT_FILENO);
 467 }
 468 int unxz_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 469 int unxz_main(int argc UNUSED_PARAM, char **argv)
 470 {
 471         IF_XZ(int opts =) getopt32(argv, "cfvqdt");
 472 # if ENABLE_XZ
 473         /* xz without -d or -t? */
 474         if (applet_name[2] == '\0' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
 475                 bb_show_usage();
 476 # endif
 477         /* xzcat? */
 478         if (applet_name[2] == 'c')
 479                 option_mask32 |= OPT_STDOUT;
 480
 481         argv += optind;
 482         return bbunpack(argv, unpack_unxz, make_new_name_generic, "xz");
 483 }
 484 #endif