summaryrefslogtreecommitdiff
path: root/archival/bbunzip.c (plain)
blob: 60a837e2262d6cc10c2fea3700b1be583cd06ca9
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//kbuild:lib-$(CONFIG_LZOPCAT) += bbunzip.o
13//kbuild:lib-$(CONFIG_UNLZOP) += bbunzip.o
14/* bzip2_main() too: */
15//kbuild:lib-$(CONFIG_BZIP2) += bbunzip.o
16/* gzip_main() too: */
17//kbuild:lib-$(CONFIG_GZIP) += bbunzip.o
18
19/* Note: must be kept in sync with archival/lzop.c */
20enum {
21 OPT_STDOUT = 1 << 0,
22 OPT_FORCE = 1 << 1,
23 /* only some decompressors: */
24 OPT_VERBOSE = 1 << 2,
25 OPT_QUIET = 1 << 3,
26 OPT_DECOMPRESS = 1 << 4,
27 OPT_TEST = 1 << 5,
28 SEAMLESS_MAGIC = (1 << 31) * SEAMLESS_COMPRESSION,
29};
30
31static
32int open_to_or_warn(int to_fd, const char *filename, int flags, int mode)
33{
34 int fd = open3_or_warn(filename, flags, mode);
35 if (fd < 0) {
36 return 1;
37 }
38 xmove_fd(fd, to_fd);
39 return 0;
40}
41
42char* FAST_FUNC append_ext(char *filename, const char *expected_ext)
43{
44 return xasprintf("%s.%s", filename, expected_ext);
45}
46
47int FAST_FUNC bbunpack(char **argv,
48 IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(transformer_state_t *xstate),
49 char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
50 const char *expected_ext
51)
52{
53 struct stat stat_buf;
54 IF_DESKTOP(long long) int status = 0;
55 char *filename, *new_name;
56 smallint exitcode = 0;
57 transformer_state_t xstate;
58
59 do {
60 /* NB: new_name is *maybe* malloc'ed! */
61 new_name = NULL;
62 filename = *argv; /* can be NULL - 'streaming' bunzip2 */
63
64 if (filename && LONE_DASH(filename))
65 filename = NULL;
66
67 /* Open src */
68 if (filename) {
69 if (!(option_mask32 & SEAMLESS_MAGIC)) {
70 if (stat(filename, &stat_buf) != 0) {
71 err_name:
72 bb_simple_perror_msg(filename);
73 err:
74 exitcode = 1;
75 goto free_name;
76 }
77 if (open_to_or_warn(STDIN_FILENO, filename, O_RDONLY, 0))
78 goto err;
79 } else {
80 /* "clever zcat" with FILE */
81 /* fail_if_not_compressed because zcat refuses uncompressed input */
82 int fd = open_zipped(filename, /*fail_if_not_compressed:*/ 1);
83 if (fd < 0)
84 goto err_name;
85 xmove_fd(fd, STDIN_FILENO);
86 }
87 } else
88 if (option_mask32 & SEAMLESS_MAGIC) {
89 /* "clever zcat" on stdin */
90 if (setup_unzip_on_fd(STDIN_FILENO, /*fail_if_not_compressed*/ 1))
91 goto err;
92 }
93
94 /* Special cases: test, stdout */
95 if (option_mask32 & (OPT_STDOUT|OPT_TEST)) {
96 if (option_mask32 & OPT_TEST)
97 if (open_to_or_warn(STDOUT_FILENO, bb_dev_null, O_WRONLY, 0))
98 xfunc_die();
99 filename = NULL;
100 }
101
102 /* Open dst if we are going to unpack to file */
103 if (filename) {
104 new_name = make_new_name(filename, expected_ext);
105 if (!new_name) {
106 bb_error_msg("%s: unknown suffix - ignored", filename);
107 goto err;
108 }
109
110 /* -f: overwrite existing output files */
111 if (option_mask32 & OPT_FORCE) {
112 unlink(new_name);
113 }
114
115 /* O_EXCL: "real" bunzip2 doesn't overwrite files */
116 /* GNU gunzip does not bail out, but goes to next file */
117 if (open_to_or_warn(STDOUT_FILENO, new_name, O_WRONLY | O_CREAT | O_EXCL,
118 stat_buf.st_mode))
119 goto err;
120 }
121
122 /* Check that the input is sane */
123 if (!(option_mask32 & OPT_FORCE) && isatty(STDIN_FILENO)) {
124 bb_error_msg_and_die("compressed data not read from terminal, "
125 "use -f to force it");
126 }
127
128 if (!(option_mask32 & SEAMLESS_MAGIC)) {
129 init_transformer_state(&xstate);
130 xstate.signature_skipped = 0;
131 /*xstate.src_fd = STDIN_FILENO; - already is */
132 xstate.dst_fd = STDOUT_FILENO;
133 status = unpacker(&xstate);
134 if (status < 0)
135 exitcode = 1;
136 } else {
137 if (bb_copyfd_eof(STDIN_FILENO, STDOUT_FILENO) < 0)
138 /* Disk full, tty closed, etc. No point in continuing */
139 xfunc_die();
140 }
141
142 if (!(option_mask32 & OPT_STDOUT))
143 xclose(STDOUT_FILENO); /* with error check! */
144
145 if (filename) {
146 char *del = new_name;
147
148 if (status >= 0) {
149 unsigned new_name_len;
150
151 /* TODO: restore other things? */
152 if (xstate.mtime != 0) {
153 struct timeval times[2];
154
155 times[1].tv_sec = times[0].tv_sec = xstate.mtime;
156 times[1].tv_usec = times[0].tv_usec = 0;
157 /* Note: we closed it first.
158 * On some systems calling utimes
159 * then closing resets the mtime
160 * back to current time. */
161 utimes(new_name, times); /* ignoring errors */
162 }
163
164 if (ENABLE_DESKTOP)
165 new_name_len = strlen(new_name);
166 /* Restore source filename (unless tgz -> tar case) */
167 if (new_name == filename) {
168 new_name_len = strlen(filename);
169 filename[new_name_len] = '.';
170 }
171 /* Extreme bloat for gunzip compat */
172 /* Some users do want this info... */
173 if (ENABLE_DESKTOP && (option_mask32 & OPT_VERBOSE)) {
174 unsigned percent = status
175 ? ((uoff_t)stat_buf.st_size * 100u / (unsigned long long)status)
176 : 0;
177 fprintf(stderr, "%s: %u%% - replaced with %.*s\n",
178 filename,
179 100u - percent,
180 new_name_len, new_name
181 );
182 }
183 /* Delete _source_ file */
184 del = filename;
185 }
186 xunlink(del);
187 free_name:
188 if (new_name != filename)
189 free(new_name);
190 }
191 } while (*argv && *++argv);
192
193 if (option_mask32 & OPT_STDOUT)
194 xclose(STDOUT_FILENO); /* with error check! */
195
196 return exitcode;
197}
198
199#if ENABLE_UNCOMPRESS \
200 || ENABLE_BUNZIP2 || ENABLE_BZCAT \
201 || ENABLE_UNLZMA || ENABLE_LZCAT || ENABLE_LZMA \
202 || ENABLE_UNXZ || ENABLE_XZCAT || ENABLE_XZ
203static
204char* FAST_FUNC make_new_name_generic(char *filename, const char *expected_ext)
205{
206 char *extension = strrchr(filename, '.');
207 if (!extension || strcmp(extension + 1, expected_ext) != 0) {
208 /* Mimic GNU gunzip - "real" bunzip2 tries to */
209 /* unpack file anyway, to file.out */
210 return NULL;
211 }
212 *extension = '\0';
213 return filename;
214}
215#endif
216
217
218/*
219 * Uncompress applet for busybox (c) 2002 Glenn McGrath
220 *
221 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
222 */
223//usage:#define uncompress_trivial_usage
224//usage: "[-cf] [FILE]..."
225//usage:#define uncompress_full_usage "\n\n"
226//usage: "Decompress .Z file[s]\n"
227//usage: "\n -c Write to stdout"
228//usage: "\n -f Overwrite"
229
230//config:config UNCOMPRESS
231//config: bool "uncompress"
232//config: default n # ancient
233//config: help
234//config: uncompress is used to decompress archives created by compress.
235//config: Not much used anymore, replaced by gzip/gunzip.
236
237//applet:IF_UNCOMPRESS(APPLET(uncompress, BB_DIR_BIN, BB_SUID_DROP))
238//kbuild:lib-$(CONFIG_UNCOMPRESS) += bbunzip.o
239#if ENABLE_UNCOMPRESS
240int uncompress_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
241int uncompress_main(int argc UNUSED_PARAM, char **argv)
242{
243 getopt32(argv, "cf");
244 argv += optind;
245
246 return bbunpack(argv, unpack_Z_stream, make_new_name_generic, "Z");
247}
248#endif
249
250
251/*
252 * Gzip implementation for busybox
253 *
254 * Based on GNU gzip v1.2.4 Copyright (C) 1992-1993 Jean-loup Gailly.
255 *
256 * Originally adjusted for busybox by Sven Rudolph <sr1@inf.tu-dresden.de>
257 * based on gzip sources
258 *
259 * Adjusted further by Erik Andersen <andersen@codepoet.org> to support files as
260 * well as stdin/stdout, and to generally behave itself wrt command line
261 * handling.
262 *
263 * General cleanup to better adhere to the style guide and make use of standard
264 * busybox functions by Glenn McGrath
265 *
266 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
267 *
268 * gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
269 * Copyright (C) 1992-1993 Jean-loup Gailly
270 * The unzip code was written and put in the public domain by Mark Adler.
271 * Portions of the lzw code are derived from the public domain 'compress'
272 * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
273 * Ken Turkowski, Dave Mack and Peter Jannesen.
274 */
275//usage:#define gunzip_trivial_usage
276//usage: "[-cft] [FILE]..."
277//usage:#define gunzip_full_usage "\n\n"
278//usage: "Decompress FILEs (or stdin)\n"
279//usage: "\n -c Write to stdout"
280//usage: "\n -f Force"
281//usage: "\n -t Test file integrity"
282//usage:
283//usage:#define gunzip_example_usage
284//usage: "$ ls -la /tmp/BusyBox*\n"
285//usage: "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n"
286//usage: "$ gunzip /tmp/BusyBox-0.43.tar.gz\n"
287//usage: "$ ls -la /tmp/BusyBox*\n"
288//usage: "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
289//usage:
290//usage:#define zcat_trivial_usage
291//usage: "[FILE]..."
292//usage:#define zcat_full_usage "\n\n"
293//usage: "Decompress to stdout"
294
295//config:config GUNZIP
296//config: bool "gunzip"
297//config: default y
298//config: help
299//config: gunzip is used to decompress archives created by gzip.
300//config: You can use the `-t' option to test the integrity of
301//config: an archive, without decompressing it.
302//config:
303//config:config ZCAT
304//config: bool "zcat"
305//config: default y
306//config: help
307//config: Alias to "gunzip -c".
308//config:
309//config:config FEATURE_GUNZIP_LONG_OPTIONS
310//config: bool "Enable long options"
311//config: default y
312//config: depends on (GUNZIP || ZCAT) && LONG_OPTS
313//config: help
314//config: Enable use of long options.
315
316//applet:IF_GUNZIP(APPLET(gunzip, BB_DIR_BIN, BB_SUID_DROP))
317//applet:IF_ZCAT(APPLET_ODDNAME(zcat, gunzip, BB_DIR_BIN, BB_SUID_DROP, zcat))
318//kbuild:lib-$(CONFIG_GUNZIP) += bbunzip.o
319//kbuild:lib-$(CONFIG_ZCAT) += bbunzip.o
320#if ENABLE_GUNZIP || ENABLE_ZCAT
321static
322char* FAST_FUNC make_new_name_gunzip(char *filename, const char *expected_ext UNUSED_PARAM)
323{
324 char *extension = strrchr(filename, '.');
325
326 if (!extension)
327 return NULL;
328
329 extension++;
330 if (strcmp(extension, "tgz" + 1) == 0
331#if ENABLE_FEATURE_SEAMLESS_Z
332 || (extension[0] == 'Z' && extension[1] == '\0')
333#endif
334 ) {
335 extension[-1] = '\0';
336 } else if (strcmp(extension, "tgz") == 0) {
337 filename = xstrdup(filename);
338 extension = strrchr(filename, '.');
339 extension[2] = 'a';
340 extension[3] = 'r';
341 } else {
342 return NULL;
343 }
344 return filename;
345}
346
347#if ENABLE_FEATURE_GUNZIP_LONG_OPTIONS
348static const char gunzip_longopts[] ALIGN1 =
349 "stdout\0" No_argument "c"
350 "to-stdout\0" No_argument "c"
351 "force\0" No_argument "f"
352 "test\0" No_argument "t"
353 "no-name\0" No_argument "n"
354 ;
355#endif
356
357/*
358 * Linux kernel build uses gzip -d -n. We accept and ignore it.
359 * Man page says:
360 * -n --no-name
361 * gzip: do not save the original file name and time stamp.
362 * (The original name is always saved if the name had to be truncated.)
363 * gunzip: do not restore the original file name/time even if present
364 * (remove only the gzip suffix from the compressed file name).
365 * This option is the default when decompressing.
366 * -N --name
367 * gzip: always save the original file name and time stamp (this is the default)
368 * gunzip: restore the original file name and time stamp if present.
369 */
370int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
371int gunzip_main(int argc UNUSED_PARAM, char **argv)
372{
373#if ENABLE_FEATURE_GUNZIP_LONG_OPTIONS
374 applet_long_options = gunzip_longopts;
375#endif
376 getopt32(argv, "cfvqdtn");
377 argv += optind;
378
379 /* If called as zcat...
380 * Normally, "zcat" is just "gunzip -c".
381 * But if seamless magic is enabled, then we are much more clever.
382 */
383 if (ENABLE_ZCAT && applet_name[1] == 'c')
384 option_mask32 |= OPT_STDOUT | SEAMLESS_MAGIC;
385
386 return bbunpack(argv, unpack_gz_stream, make_new_name_gunzip, /*unused:*/ NULL);
387}
388#endif
389
390
391/*
392 * Modified for busybox by Glenn McGrath
393 * Added support output to stdout by Thomas Lundquist <thomasez@zelow.no>
394 *
395 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
396 */
397//usage:#define bunzip2_trivial_usage
398//usage: "[-cf] [FILE]..."
399//usage:#define bunzip2_full_usage "\n\n"
400//usage: "Decompress FILEs (or stdin)\n"
401//usage: "\n -c Write to stdout"
402//usage: "\n -f Force"
403//usage:#define bzcat_trivial_usage
404//usage: "[FILE]..."
405//usage:#define bzcat_full_usage "\n\n"
406//usage: "Decompress to stdout"
407
408//config:config BUNZIP2
409//config: bool "bunzip2"
410//config: default y
411//config: help
412//config: bunzip2 is a compression utility using the Burrows-Wheeler block
413//config: sorting text compression algorithm, and Huffman coding. Compression
414//config: is generally considerably better than that achieved by more
415//config: conventional LZ77/LZ78-based compressors, and approaches the
416//config: performance of the PPM family of statistical compressors.
417//config:
418//config: Unless you have a specific application which requires bunzip2, you
419//config: should probably say N here.
420//config:
421//config:config BZCAT
422//config: bool "bzcat"
423//config: default y
424//config: help
425//config: Alias to "bunzip2 -c".
426
427//applet:IF_BUNZIP2(APPLET(bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP))
428//applet:IF_BZCAT(APPLET_ODDNAME(bzcat, bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP, bzcat))
429//kbuild:lib-$(CONFIG_BUNZIP2) += bbunzip.o
430//kbuild:lib-$(CONFIG_BZCAT) += bbunzip.o
431#if ENABLE_BUNZIP2 || ENABLE_BZCAT
432int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
433int bunzip2_main(int argc UNUSED_PARAM, char **argv)
434{
435 getopt32(argv, "cfvqdt");
436 argv += optind;
437 if (ENABLE_BZCAT && applet_name[2] == 'c') /* bzcat */
438 option_mask32 |= OPT_STDOUT;
439
440 return bbunpack(argv, unpack_bz2_stream, make_new_name_generic, "bz2");
441}
442#endif
443
444
445/*
446 * Small lzma deflate implementation.
447 * Copyright (C) 2006 Aurelien Jacobs <aurel@gnuage.org>
448 *
449 * Based on bunzip.c from busybox
450 *
451 * Licensed under GPLv2, see file LICENSE in this source tree.
452 */
453//usage:#define unlzma_trivial_usage
454//usage: "[-cf] [FILE]..."
455//usage:#define unlzma_full_usage "\n\n"
456//usage: "Decompress FILE (or stdin)\n"
457//usage: "\n -c Write to stdout"
458//usage: "\n -f Force"
459//usage:
460//usage:#define lzma_trivial_usage
461//usage: "-d [-cf] [FILE]..."
462//usage:#define lzma_full_usage "\n\n"
463//usage: "Decompress FILE (or stdin)\n"
464//usage: "\n -d Decompress"
465//usage: "\n -c Write to stdout"
466//usage: "\n -f Force"
467//usage:
468//usage:#define lzcat_trivial_usage
469//usage: "[FILE]..."
470//usage:#define lzcat_full_usage "\n\n"
471//usage: "Decompress to stdout"
472//usage:
473//usage:#define unxz_trivial_usage
474//usage: "[-cf] [FILE]..."
475//usage:#define unxz_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:
480//usage:#define xz_trivial_usage
481//usage: "-d [-cf] [FILE]..."
482//usage:#define xz_full_usage "\n\n"
483//usage: "Decompress FILE (or stdin)\n"
484//usage: "\n -d Decompress"
485//usage: "\n -c Write to stdout"
486//usage: "\n -f Force"
487//usage:
488//usage:#define xzcat_trivial_usage
489//usage: "[FILE]..."
490//usage:#define xzcat_full_usage "\n\n"
491//usage: "Decompress to stdout"
492
493//config:config UNLZMA
494//config: bool "unlzma"
495//config: default y
496//config: help
497//config: unlzma is a compression utility using the Lempel-Ziv-Markov chain
498//config: compression algorithm, and range coding. Compression
499//config: is generally considerably better than that achieved by the bzip2
500//config: compressors.
501//config:
502//config: The BusyBox unlzma applet is limited to decompression only.
503//config: On an x86 system, this applet adds about 4K.
504//config:
505//config:config LZCAT
506//config: bool "lzcat"
507//config: default y
508//config: help
509//config: unlzma is a compression utility using the Lempel-Ziv-Markov chain
510//config: compression algorithm, and range coding. Compression
511//config: is generally considerably better than that achieved by the bzip2
512//config: compressors.
513//config:
514//config: The BusyBox unlzma applet is limited to decompression only.
515//config: On an x86 system, this applet adds about 4K.
516//config:
517//config:config LZMA
518//config: bool "lzma -d"
519//config: default y
520//config: help
521//config: Enable this option if you want commands like "lzma -d" to work.
522//config: IOW: you'll get lzma applet, but it will always require -d option.
523//config:
524//config:config FEATURE_LZMA_FAST
525//config: bool "Optimize unlzma for speed"
526//config: default n
527//config: depends on UNLZMA || LZCAT || LZMA
528//config: help
529//config: This option reduces decompression time by about 25% at the cost of
530//config: a 1K bigger binary.
531
532//applet:IF_UNLZMA(APPLET(unlzma, BB_DIR_USR_BIN, BB_SUID_DROP))
533//applet:IF_LZCAT(APPLET_ODDNAME(lzcat, unlzma, BB_DIR_USR_BIN, BB_SUID_DROP, lzcat))
534//applet:IF_LZMA(APPLET_ODDNAME(lzma, unlzma, BB_DIR_USR_BIN, BB_SUID_DROP, lzma))
535//kbuild:lib-$(CONFIG_UNLZMA) += bbunzip.o
536//kbuild:lib-$(CONFIG_LZCAT) += bbunzip.o
537//kbuild:lib-$(CONFIG_LZMA) += bbunzip.o
538#if ENABLE_UNLZMA || ENABLE_LZCAT || ENABLE_LZMA
539int unlzma_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
540int unlzma_main(int argc UNUSED_PARAM, char **argv)
541{
542 IF_LZMA(int opts =) getopt32(argv, "cfvqdt");
543# if ENABLE_LZMA
544 /* lzma without -d or -t? */
545 if (applet_name[2] == 'm' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
546 bb_show_usage();
547# endif
548 /* lzcat? */
549 if (ENABLE_LZCAT && applet_name[2] == 'c')
550 option_mask32 |= OPT_STDOUT;
551
552 argv += optind;
553 return bbunpack(argv, unpack_lzma_stream, make_new_name_generic, "lzma");
554}
555#endif
556
557
558//config:config UNXZ
559//config: bool "unxz"
560//config: default y
561//config: help
562//config: unxz is a unlzma successor.
563//config:
564//config:config XZCAT
565//config: bool "xzcat"
566//config: default y
567//config: help
568//config: Alias to "unxz -c".
569//config:
570//config:config XZ
571//config: bool "xz -d"
572//config: default y
573//config: help
574//config: Enable this option if you want commands like "xz -d" to work.
575//config: IOW: you'll get xz applet, but it will always require -d option.
576
577//applet:IF_UNXZ(APPLET(unxz, BB_DIR_USR_BIN, BB_SUID_DROP))
578//applet:IF_XZCAT(APPLET_ODDNAME(xzcat, unxz, BB_DIR_USR_BIN, BB_SUID_DROP, xzcat))
579//applet:IF_XZ(APPLET_ODDNAME(xz, unxz, BB_DIR_USR_BIN, BB_SUID_DROP, xz))
580//kbuild:lib-$(CONFIG_UNXZ) += bbunzip.o
581//kbuild:lib-$(CONFIG_XZCAT) += bbunzip.o
582//kbuild:lib-$(CONFIG_XZ) += bbunzip.o
583#if ENABLE_UNXZ || ENABLE_XZCAT || ENABLE_XZ
584int unxz_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
585int unxz_main(int argc UNUSED_PARAM, char **argv)
586{
587 IF_XZ(int opts =) getopt32(argv, "cfvqdt");
588# if ENABLE_XZ
589 /* xz without -d or -t? */
590 if (applet_name[2] == '\0' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
591 bb_show_usage();
592# endif
593 /* xzcat? */
594 if (ENABLE_XZCAT && applet_name[2] == 'c')
595 option_mask32 |= OPT_STDOUT;
596
597 argv += optind;
598 return bbunpack(argv, unpack_xz_stream, make_new_name_generic, "xz");
599}
600#endif
601