1 /* vi: set sw=4 ts=4: */
3 * Common code for gunzip-like applets
5 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
8 #include "bb_archive.h"
10 //kbuild:lib-$(CONFIG_ZCAT) += bbunzip.o
11 //kbuild:lib-$(CONFIG_GUNZIP) += bbunzip.o
12 //kbuild:lib-$(CONFIG_BZCAT) += bbunzip.o
13 //kbuild:lib-$(CONFIG_BUNZIP2) += bbunzip.o
15 /* lzop_main() uses bbunpack(), need this: */
16 //kbuild:lib-$(CONFIG_LZOP) += bbunzip.o
17 //kbuild:lib-$(CONFIG_LZOPCAT) += bbunzip.o
18 //kbuild:lib-$(CONFIG_UNLZOP) += bbunzip.o
19 /* bzip2_main() too: */
20 //kbuild:lib-$(CONFIG_BZIP2) += bbunzip.o
21 /* gzip_main() too: */
22 //kbuild:lib-$(CONFIG_GZIP) += bbunzip.o
24 /* Note: must be kept in sync with archival/lzop.c */
28 /* only some decompressors: */
32 OPT_DECOMPRESS = 1 << 5,
34 SEAMLESS_MAGIC = (1 << 31) * ENABLE_ZCAT * SEAMLESS_COMPRESSION,
38 int open_to_or_warn(int to_fd, const char *filename, int flags, int mode)
40 int fd = open3_or_warn(filename, flags, mode);
48 char* FAST_FUNC append_ext(char *filename, const char *expected_ext)
50 return xasprintf("%s.%s", filename, expected_ext);
53 int FAST_FUNC bbunpack(char **argv,
54 IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(transformer_state_t *xstate),
55 char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
56 const char *expected_ext
60 IF_DESKTOP(long long) int status = 0;
61 char *filename, *new_name;
62 smallint exitcode = 0;
63 transformer_state_t xstate;
66 /* NB: new_name is *maybe* malloc'ed! */
68 filename = *argv; /* can be NULL - 'streaming' bunzip2 */
70 if (filename && LONE_DASH(filename))
75 if (!(option_mask32 & SEAMLESS_MAGIC)) {
76 if (stat(filename, &stat_buf) != 0) {
78 bb_simple_perror_msg(filename);
83 if (open_to_or_warn(STDIN_FILENO, filename, O_RDONLY, 0))
86 /* "clever zcat" with FILE */
87 /* fail_if_not_compressed because zcat refuses uncompressed input */
88 int fd = open_zipped(filename, /*fail_if_not_compressed:*/ 1);
91 xmove_fd(fd, STDIN_FILENO);
94 if (option_mask32 & SEAMLESS_MAGIC) {
95 /* "clever zcat" on stdin */
96 if (setup_unzip_on_fd(STDIN_FILENO, /*fail_if_not_compressed*/ 1))
100 /* Special cases: test, stdout */
101 if (option_mask32 & (OPT_STDOUT|OPT_TEST)) {
102 if (option_mask32 & OPT_TEST)
103 if (open_to_or_warn(STDOUT_FILENO, bb_dev_null, O_WRONLY, 0))
108 /* Open dst if we are going to unpack to file */
110 new_name = make_new_name(filename, expected_ext);
112 bb_error_msg("%s: unknown suffix - ignored", filename);
116 /* -f: overwrite existing output files */
117 if (option_mask32 & OPT_FORCE) {
121 /* O_EXCL: "real" bunzip2 doesn't overwrite files */
122 /* GNU gunzip does not bail out, but goes to next file */
123 if (open_to_or_warn(STDOUT_FILENO, new_name, O_WRONLY | O_CREAT | O_EXCL,
128 /* Check that the input is sane */
129 if (!(option_mask32 & OPT_FORCE) && isatty(STDIN_FILENO)) {
130 bb_error_msg_and_die("compressed data not read from terminal, "
131 "use -f to force it");
134 if (!(option_mask32 & SEAMLESS_MAGIC)) {
135 init_transformer_state(&xstate);
136 /*xstate.signature_skipped = 0; - already is */
137 /*xstate.src_fd = STDIN_FILENO; - already is */
138 xstate.dst_fd = STDOUT_FILENO;
139 status = unpacker(&xstate);
143 if (bb_copyfd_eof(STDIN_FILENO, STDOUT_FILENO) < 0)
144 /* Disk full, tty closed, etc. No point in continuing */
148 if (!(option_mask32 & OPT_STDOUT))
149 xclose(STDOUT_FILENO); /* with error check! */
152 char *del = new_name;
155 unsigned new_name_len;
157 /* TODO: restore other things? */
158 if (xstate.mtime != 0) {
159 struct timeval times[2];
161 times[1].tv_sec = times[0].tv_sec = xstate.mtime;
162 times[1].tv_usec = times[0].tv_usec = 0;
163 /* Note: we closed it first.
164 * On some systems calling utimes
165 * then closing resets the mtime
166 * back to current time. */
167 utimes(new_name, times); /* ignoring errors */
171 new_name_len = strlen(new_name);
172 /* Restore source filename (unless tgz -> tar case) */
173 if (new_name == filename) {
174 new_name_len = strlen(filename);
175 filename[new_name_len] = '.';
177 /* Extreme bloat for gunzip compat */
178 /* Some users do want this info... */
179 if (ENABLE_DESKTOP && (option_mask32 & OPT_VERBOSE)) {
180 unsigned percent = status
181 ? ((uoff_t)stat_buf.st_size * 100u / (unsigned long long)status)
183 fprintf(stderr, "%s: %u%% - replaced with %.*s\n",
186 new_name_len, new_name
189 /* Delete _source_ file */
191 if (option_mask32 & OPT_KEEP) /* ... unless -k */
197 if (new_name != filename)
200 } while (*argv && *++argv);
202 if (option_mask32 & OPT_STDOUT)
203 xclose(STDOUT_FILENO); /* with error check! */
208 #if ENABLE_UNCOMPRESS \
209 || ENABLE_FEATURE_BZIP2_DECOMPRESS \
210 || ENABLE_UNLZMA || ENABLE_LZCAT || ENABLE_LZMA \
211 || ENABLE_UNXZ || ENABLE_XZCAT || ENABLE_XZ
213 char* FAST_FUNC make_new_name_generic(char *filename, const char *expected_ext)
215 char *extension = strrchr(filename, '.');
216 if (!extension || strcmp(extension + 1, expected_ext) != 0) {
217 /* Mimic GNU gunzip - "real" bunzip2 tries to */
218 /* unpack file anyway, to file.out */
228 * Uncompress applet for busybox (c) 2002 Glenn McGrath
230 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
232 //usage:#define uncompress_trivial_usage
233 //usage: "[-cf] [FILE]..."
234 //usage:#define uncompress_full_usage "\n\n"
235 //usage: "Decompress .Z file[s]\n"
236 //usage: "\n -c Write to stdout"
237 //usage: "\n -f Overwrite"
239 //config:config UNCOMPRESS
240 //config: bool "uncompress"
241 //config: default n # ancient
243 //config: uncompress is used to decompress archives created by compress.
244 //config: Not much used anymore, replaced by gzip/gunzip.
246 //applet:IF_UNCOMPRESS(APPLET(uncompress, BB_DIR_BIN, BB_SUID_DROP))
247 //kbuild:lib-$(CONFIG_UNCOMPRESS) += bbunzip.o
248 #if ENABLE_UNCOMPRESS
249 int uncompress_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
250 int uncompress_main(int argc UNUSED_PARAM, char **argv)
252 // (N)compress 4.2.4.4:
253 // -d If given, decompression is done instead
254 // -c Write output on stdout, don't remove original
255 // -b Parameter limits the max number of bits/code
256 // -f Forces output file to be generated
257 // -v Write compression statistics
258 // -V Output vesion and compile options
259 // -r Recursive. If a filename is a directory, descend into it and compress everything
260 getopt32(argv, "cf");
264 return bbunpack(argv, unpack_Z_stream, make_new_name_generic, "Z");
270 * Gzip implementation for busybox
272 * Based on GNU gzip v1.2.4 Copyright (C) 1992-1993 Jean-loup Gailly.
274 * Originally adjusted for busybox by Sven Rudolph <sr1@inf.tu-dresden.de>
275 * based on gzip sources
277 * Adjusted further by Erik Andersen <andersen@codepoet.org> to support files as
278 * well as stdin/stdout, and to generally behave itself wrt command line
281 * General cleanup to better adhere to the style guide and make use of standard
282 * busybox functions by Glenn McGrath
284 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
286 * gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
287 * Copyright (C) 1992-1993 Jean-loup Gailly
288 * The unzip code was written and put in the public domain by Mark Adler.
289 * Portions of the lzw code are derived from the public domain 'compress'
290 * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
291 * Ken Turkowski, Dave Mack and Peter Jannesen.
293 //usage:#define gunzip_trivial_usage
294 //usage: "[-cfkt] [FILE]..."
295 //usage:#define gunzip_full_usage "\n\n"
296 //usage: "Decompress FILEs (or stdin)\n"
297 //usage: "\n -c Write to stdout"
298 //usage: "\n -f Force"
299 //usage: "\n -k Keep input files"
300 //usage: "\n -t Test file integrity"
302 //usage:#define gunzip_example_usage
303 //usage: "$ ls -la /tmp/BusyBox*\n"
304 //usage: "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n"
305 //usage: "$ gunzip /tmp/BusyBox-0.43.tar.gz\n"
306 //usage: "$ ls -la /tmp/BusyBox*\n"
307 //usage: "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
309 //usage:#define zcat_trivial_usage
311 //usage:#define zcat_full_usage "\n\n"
312 //usage: "Decompress to stdout"
314 //config:config GUNZIP
315 //config: bool "gunzip"
317 //config: select FEATURE_GZIP_DECOMPRESS
319 //config: gunzip is used to decompress archives created by gzip.
320 //config: You can use the `-t' option to test the integrity of
321 //config: an archive, without decompressing it.
324 //config: bool "zcat"
326 //config: select FEATURE_GZIP_DECOMPRESS
328 //config: Alias to "gunzip -c".
330 //config:config FEATURE_GUNZIP_LONG_OPTIONS
331 //config: bool "Enable long options"
333 //config: depends on (GUNZIP || ZCAT) && LONG_OPTS
335 //applet:IF_GUNZIP(APPLET(gunzip, BB_DIR_BIN, BB_SUID_DROP))
336 // APPLET_ODDNAME:name main location suid_type help
337 //applet:IF_ZCAT(APPLET_ODDNAME(zcat, gunzip, BB_DIR_BIN, BB_SUID_DROP, zcat))
338 #if ENABLE_FEATURE_GZIP_DECOMPRESS
340 char* FAST_FUNC make_new_name_gunzip(char *filename, const char *expected_ext UNUSED_PARAM)
342 char *extension = strrchr(filename, '.');
348 if (strcmp(extension, "tgz" + 1) == 0
349 #if ENABLE_FEATURE_SEAMLESS_Z
350 || (extension[0] == 'Z' && extension[1] == '\0')
353 extension[-1] = '\0';
354 } else if (strcmp(extension, "tgz") == 0) {
355 filename = xstrdup(filename);
356 extension = strrchr(filename, '.');
365 #if ENABLE_FEATURE_GUNZIP_LONG_OPTIONS
366 static const char gunzip_longopts[] ALIGN1 =
367 "stdout\0" No_argument "c"
368 "to-stdout\0" No_argument "c"
369 "force\0" No_argument "f"
370 "test\0" No_argument "t"
371 "no-name\0" No_argument "n"
376 * Linux kernel build uses gzip -d -n. We accept and ignore it.
379 * gzip: do not save the original file name and time stamp.
380 * (The original name is always saved if the name had to be truncated.)
381 * gunzip: do not restore the original file name/time even if present
382 * (remove only the gzip suffix from the compressed file name).
383 * This option is the default when decompressing.
385 * gzip: always save the original file name and time stamp (this is the default)
386 * gunzip: restore the original file name and time stamp if present.
388 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
389 int gunzip_main(int argc UNUSED_PARAM, char **argv)
391 #if ENABLE_FEATURE_GUNZIP_LONG_OPTIONS
392 applet_long_options = gunzip_longopts;
394 getopt32(argv, "cfkvqdtn");
397 /* If called as zcat...
398 * Normally, "zcat" is just "gunzip -c".
399 * But if seamless magic is enabled, then we are much more clever.
401 if (ENABLE_ZCAT && applet_name[1] == 'c')
402 option_mask32 |= OPT_STDOUT | SEAMLESS_MAGIC;
404 return bbunpack(argv, unpack_gz_stream, make_new_name_gunzip, /*unused:*/ NULL);
406 #endif /* FEATURE_GZIP_DECOMPRESS */
410 * Modified for busybox by Glenn McGrath
411 * Added support output to stdout by Thomas Lundquist <thomasez@zelow.no>
413 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
415 //usage:#define bunzip2_trivial_usage
416 //usage: "[-cfk] [FILE]..."
417 //usage:#define bunzip2_full_usage "\n\n"
418 //usage: "Decompress FILEs (or stdin)\n"
419 //usage: "\n -c Write to stdout"
420 //usage: "\n -f Force"
421 //usage: "\n -k Keep input files"
422 //usage:#define bzcat_trivial_usage
424 //usage:#define bzcat_full_usage "\n\n"
425 //usage: "Decompress to stdout"
427 //config:config BUNZIP2
428 //config: bool "bunzip2"
430 //config: select FEATURE_BZIP2_DECOMPRESS
432 //config: bunzip2 is a compression utility using the Burrows-Wheeler block
433 //config: sorting text compression algorithm, and Huffman coding. Compression
434 //config: is generally considerably better than that achieved by more
435 //config: conventional LZ77/LZ78-based compressors, and approaches the
436 //config: performance of the PPM family of statistical compressors.
438 //config: Unless you have a specific application which requires bunzip2, you
439 //config: should probably say N here.
441 //config:config BZCAT
442 //config: bool "bzcat"
444 //config: select FEATURE_BZIP2_DECOMPRESS
446 //config: Alias to "bunzip2 -c".
448 //applet:IF_BUNZIP2(APPLET(bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP))
449 // APPLET_ODDNAME:name main location suid_type help
450 //applet:IF_BZCAT(APPLET_ODDNAME(bzcat, bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP, bzcat))
451 #if ENABLE_FEATURE_BZIP2_DECOMPRESS || ENABLE_BUNZIP2
452 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
453 int bunzip2_main(int argc UNUSED_PARAM, char **argv)
455 getopt32(argv, "cfkvqdt");
457 if (ENABLE_BZCAT && applet_name[2] == 'c') /* bzcat */
458 option_mask32 |= OPT_STDOUT;
460 return bbunpack(argv, unpack_bz2_stream, make_new_name_generic, "bz2");
466 * Small lzma deflate implementation.
467 * Copyright (C) 2006 Aurelien Jacobs <aurel@gnuage.org>
469 * Based on bunzip.c from busybox
471 * Licensed under GPLv2, see file LICENSE in this source tree.
473 //usage:#define unlzma_trivial_usage
474 //usage: "[-cfk] [FILE]..."
475 //usage:#define unlzma_full_usage "\n\n"
476 //usage: "Decompress FILE (or stdin)\n"
477 //usage: "\n -c Write to stdout"
478 //usage: "\n -f Force"
479 //usage: "\n -k Keep input files"
481 //usage:#define lzma_trivial_usage
482 //usage: "-d [-cfk] [FILE]..."
483 //usage:#define lzma_full_usage "\n\n"
484 //usage: "Decompress FILE (or stdin)\n"
485 //usage: "\n -d Decompress"
486 //usage: "\n -c Write to stdout"
487 //usage: "\n -f Force"
488 //usage: "\n -k Keep input files"
490 //usage:#define lzcat_trivial_usage
492 //usage:#define lzcat_full_usage "\n\n"
493 //usage: "Decompress to stdout"
495 //config:config UNLZMA
496 //config: bool "unlzma"
499 //config: unlzma is a compression utility using the Lempel-Ziv-Markov chain
500 //config: compression algorithm, and range coding. Compression
501 //config: is generally considerably better than that achieved by the bzip2
502 //config: compressors.
504 //config: The BusyBox unlzma applet is limited to decompression only.
505 //config: On an x86 system, this applet adds about 4K.
507 //config:config LZCAT
508 //config: bool "lzcat"
511 //config: unlzma is a compression utility using the Lempel-Ziv-Markov chain
512 //config: compression algorithm, and range coding. Compression
513 //config: is generally considerably better than that achieved by the bzip2
514 //config: compressors.
516 //config: The BusyBox unlzma applet is limited to decompression only.
517 //config: On an x86 system, this applet adds about 4K.
520 //config: bool "lzma -d"
523 //config: Enable this option if you want commands like "lzma -d" to work.
524 //config: IOW: you'll get lzma applet, but it will always require -d option.
526 //config:config FEATURE_LZMA_FAST
527 //config: bool "Optimize for speed"
529 //config: depends on UNLZMA || LZCAT || LZMA
531 //config: This option reduces decompression time by about 25% at the cost of
532 //config: a 1K bigger binary.
534 //applet:IF_UNLZMA(APPLET(unlzma, BB_DIR_USR_BIN, BB_SUID_DROP))
535 // APPLET_ODDNAME:name main location suid_type help
536 //applet:IF_LZCAT(APPLET_ODDNAME(lzcat, unlzma, BB_DIR_USR_BIN, BB_SUID_DROP, lzcat))
537 //applet:IF_LZMA( APPLET_ODDNAME(lzma, unlzma, BB_DIR_USR_BIN, BB_SUID_DROP, lzma))
538 //kbuild:lib-$(CONFIG_UNLZMA) += bbunzip.o
539 //kbuild:lib-$(CONFIG_LZCAT) += bbunzip.o
540 //kbuild:lib-$(CONFIG_LZMA) += bbunzip.o
541 #if ENABLE_UNLZMA || ENABLE_LZCAT || ENABLE_LZMA
542 int unlzma_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
543 int unlzma_main(int argc UNUSED_PARAM, char **argv)
545 IF_LZMA(int opts =) getopt32(argv, "cfkvqdt");
547 /* lzma without -d or -t? */
548 if (applet_name[2] == 'm' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
552 if (ENABLE_LZCAT && applet_name[2] == 'c')
553 option_mask32 |= OPT_STDOUT;
556 return bbunpack(argv, unpack_lzma_stream, make_new_name_generic, "lzma");
561 //usage:#define unxz_trivial_usage
562 //usage: "[-cfk] [FILE]..."
563 //usage:#define unxz_full_usage "\n\n"
564 //usage: "Decompress FILE (or stdin)\n"
565 //usage: "\n -c Write to stdout"
566 //usage: "\n -f Force"
567 //usage: "\n -k Keep input files"
569 //usage:#define xz_trivial_usage
570 //usage: "-d [-cfk] [FILE]..."
571 //usage:#define xz_full_usage "\n\n"
572 //usage: "Decompress FILE (or stdin)\n"
573 //usage: "\n -d Decompress"
574 //usage: "\n -c Write to stdout"
575 //usage: "\n -f Force"
576 //usage: "\n -k Keep input files"
578 //usage:#define xzcat_trivial_usage
580 //usage:#define xzcat_full_usage "\n\n"
581 //usage: "Decompress to stdout"
584 //config: bool "unxz"
587 //config: unxz is a unlzma successor.
589 //config:config XZCAT
590 //config: bool "xzcat"
593 //config: Alias to "unxz -c".
596 //config: bool "xz -d"
599 //config: Enable this option if you want commands like "xz -d" to work.
600 //config: IOW: you'll get xz applet, but it will always require -d option.
602 //applet:IF_UNXZ(APPLET(unxz, BB_DIR_USR_BIN, BB_SUID_DROP))
603 // APPLET_ODDNAME:name main location suid_type help
604 //applet:IF_XZCAT(APPLET_ODDNAME(xzcat, unxz, BB_DIR_USR_BIN, BB_SUID_DROP, xzcat))
605 //applet:IF_XZ( APPLET_ODDNAME(xz, unxz, BB_DIR_USR_BIN, BB_SUID_DROP, xz))
606 //kbuild:lib-$(CONFIG_UNXZ) += bbunzip.o
607 //kbuild:lib-$(CONFIG_XZCAT) += bbunzip.o
608 //kbuild:lib-$(CONFIG_XZ) += bbunzip.o
609 #if ENABLE_UNXZ || ENABLE_XZCAT || ENABLE_XZ
610 int unxz_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
611 int unxz_main(int argc UNUSED_PARAM, char **argv)
613 IF_XZ(int opts =) getopt32(argv, "cfkvqdt");
615 /* xz without -d or -t? */
616 if (applet_name[2] == '\0' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
620 if (ENABLE_XZCAT && applet_name[2] == 'c')
621 option_mask32 |= OPT_STDOUT;
624 return bbunpack(argv, unpack_xz_stream, make_new_name_generic, "xz");