Bump to version 1.22.1
[platform/upstream/busybox.git] / 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 //config:config UNCOMPRESS
219 //config:       bool "uncompress"
220 //config:       default n
221 //config:       help
222 //config:         uncompress is used to decompress archives created by compress.
223 //config:         Not much used anymore, replaced by gzip/gunzip.
224
225 //applet:IF_UNCOMPRESS(APPLET(uncompress, BB_DIR_BIN, BB_SUID_DROP))
226 //kbuild:lib-$(CONFIG_UNCOMPRESS) += bbunzip.o
227 #if ENABLE_UNCOMPRESS
228 static
229 IF_DESKTOP(long long) int FAST_FUNC unpack_uncompress(transformer_aux_data_t *aux)
230 {
231         return unpack_Z_stream(aux, STDIN_FILENO, STDOUT_FILENO);
232 }
233 int uncompress_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
234 int uncompress_main(int argc UNUSED_PARAM, char **argv)
235 {
236         getopt32(argv, "cf");
237         argv += optind;
238
239         return bbunpack(argv, unpack_uncompress, make_new_name_generic, "Z");
240 }
241 #endif
242
243
244 /*
245  * Gzip implementation for busybox
246  *
247  * Based on GNU gzip v1.2.4 Copyright (C) 1992-1993 Jean-loup Gailly.
248  *
249  * Originally adjusted for busybox by Sven Rudolph <sr1@inf.tu-dresden.de>
250  * based on gzip sources
251  *
252  * Adjusted further by Erik Andersen <andersen@codepoet.org> to support files as
253  * well as stdin/stdout, and to generally behave itself wrt command line
254  * handling.
255  *
256  * General cleanup to better adhere to the style guide and make use of standard
257  * busybox functions by Glenn McGrath
258  *
259  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
260  *
261  * gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
262  * Copyright (C) 1992-1993 Jean-loup Gailly
263  * The unzip code was written and put in the public domain by Mark Adler.
264  * Portions of the lzw code are derived from the public domain 'compress'
265  * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
266  * Ken Turkowski, Dave Mack and Peter Jannesen.
267  */
268 //usage:#define gunzip_trivial_usage
269 //usage:       "[-cft] [FILE]..."
270 //usage:#define gunzip_full_usage "\n\n"
271 //usage:       "Decompress FILEs (or stdin)\n"
272 //usage:     "\n        -c      Write to stdout"
273 //usage:     "\n        -f      Force"
274 //usage:     "\n        -t      Test file integrity"
275 //usage:
276 //usage:#define gunzip_example_usage
277 //usage:       "$ ls -la /tmp/BusyBox*\n"
278 //usage:       "-rw-rw-r--    1 andersen andersen   557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n"
279 //usage:       "$ gunzip /tmp/BusyBox-0.43.tar.gz\n"
280 //usage:       "$ ls -la /tmp/BusyBox*\n"
281 //usage:       "-rw-rw-r--    1 andersen andersen  1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
282 //usage:
283 //usage:#define zcat_trivial_usage
284 //usage:       "[FILE]..."
285 //usage:#define zcat_full_usage "\n\n"
286 //usage:       "Decompress to stdout"
287
288 //config:config GUNZIP
289 //config:       bool "gunzip"
290 //config:       default y
291 //config:       help
292 //config:         gunzip is used to decompress archives created by gzip.
293 //config:         You can use the `-t' option to test the integrity of
294 //config:         an archive, without decompressing it.
295
296 //applet:IF_GUNZIP(APPLET(gunzip, BB_DIR_BIN, BB_SUID_DROP))
297 //applet:IF_GUNZIP(APPLET_ODDNAME(zcat, gunzip, BB_DIR_BIN, BB_SUID_DROP, zcat))
298 //kbuild:lib-$(CONFIG_GZIP) += bbunzip.o
299 //kbuild:lib-$(CONFIG_GUNZIP) += bbunzip.o
300 #if ENABLE_GUNZIP
301 static
302 char* FAST_FUNC make_new_name_gunzip(char *filename, const char *expected_ext UNUSED_PARAM)
303 {
304         char *extension = strrchr(filename, '.');
305
306         if (!extension)
307                 return NULL;
308
309         extension++;
310         if (strcmp(extension, "tgz" + 1) == 0
311 #if ENABLE_FEATURE_SEAMLESS_Z
312          || (extension[0] == 'Z' && extension[1] == '\0')
313 #endif
314         ) {
315                 extension[-1] = '\0';
316         } else if (strcmp(extension, "tgz") == 0) {
317                 filename = xstrdup(filename);
318                 extension = strrchr(filename, '.');
319                 extension[2] = 'a';
320                 extension[3] = 'r';
321         } else {
322                 return NULL;
323         }
324         return filename;
325 }
326 static
327 IF_DESKTOP(long long) int FAST_FUNC unpack_gunzip(transformer_aux_data_t *aux)
328 {
329         return unpack_gz_stream(aux, STDIN_FILENO, STDOUT_FILENO);
330 }
331 /*
332  * Linux kernel build uses gzip -d -n. We accept and ignore it.
333  * Man page says:
334  * -n --no-name
335  * gzip: do not save the original file name and time stamp.
336  * (The original name is always saved if the name had to be truncated.)
337  * gunzip: do not restore the original file name/time even if present
338  * (remove only the gzip suffix from the compressed file name).
339  * This option is the default when decompressing.
340  * -N --name
341  * gzip: always save the original file name and time stamp (this is the default)
342  * gunzip: restore the original file name and time stamp if present.
343  */
344 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
345 int gunzip_main(int argc UNUSED_PARAM, char **argv)
346 {
347         getopt32(argv, "cfvqdtn");
348         argv += optind;
349
350         /* If called as zcat...
351          * Normally, "zcat" is just "gunzip -c".
352          * But if seamless magic is enabled, then we are much more clever.
353          */
354         if (applet_name[1] == 'c')
355                 option_mask32 |= OPT_STDOUT | SEAMLESS_MAGIC;
356
357         return bbunpack(argv, unpack_gunzip, make_new_name_gunzip, /*unused:*/ NULL);
358 }
359 #endif
360
361
362 /*
363  * Modified for busybox by Glenn McGrath
364  * Added support output to stdout by Thomas Lundquist <thomasez@zelow.no>
365  *
366  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
367  */
368 //usage:#define bunzip2_trivial_usage
369 //usage:       "[-cf] [FILE]..."
370 //usage:#define bunzip2_full_usage "\n\n"
371 //usage:       "Decompress FILEs (or stdin)\n"
372 //usage:     "\n        -c      Write to stdout"
373 //usage:     "\n        -f      Force"
374 //usage:#define bzcat_trivial_usage
375 //usage:       "[FILE]..."
376 //usage:#define bzcat_full_usage "\n\n"
377 //usage:       "Decompress to stdout"
378
379 //config:config BUNZIP2
380 //config:       bool "bunzip2"
381 //config:       default y
382 //config:       help
383 //config:         bunzip2 is a compression utility using the Burrows-Wheeler block
384 //config:         sorting text compression algorithm, and Huffman coding. Compression
385 //config:         is generally considerably better than that achieved by more
386 //config:         conventional LZ77/LZ78-based compressors, and approaches the
387 //config:         performance of the PPM family of statistical compressors.
388 //config:
389 //config:         Unless you have a specific application which requires bunzip2, you
390 //config:         should probably say N here.
391
392 //applet:IF_BUNZIP2(APPLET(bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP))
393 //applet:IF_BUNZIP2(APPLET_ODDNAME(bzcat, bunzip2, BB_DIR_USR_BIN, BB_SUID_DROP, bzcat))
394 //kbuild:lib-$(CONFIG_BZIP2) += bbunzip.o
395 //kbuild:lib-$(CONFIG_BUNZIP2) += bbunzip.o
396 #if ENABLE_BUNZIP2
397 static
398 IF_DESKTOP(long long) int FAST_FUNC unpack_bunzip2(transformer_aux_data_t *aux)
399 {
400         return unpack_bz2_stream(aux, STDIN_FILENO, STDOUT_FILENO);
401 }
402 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
403 int bunzip2_main(int argc UNUSED_PARAM, char **argv)
404 {
405         getopt32(argv, "cfvqdt");
406         argv += optind;
407         if (applet_name[2] == 'c') /* bzcat */
408                 option_mask32 |= OPT_STDOUT;
409
410         return bbunpack(argv, unpack_bunzip2, make_new_name_generic, "bz2");
411 }
412 #endif
413
414
415 /*
416  * Small lzma deflate implementation.
417  * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
418  *
419  * Based on bunzip.c from busybox
420  *
421  * Licensed under GPLv2, see file LICENSE in this source tree.
422  */
423 //usage:#define unlzma_trivial_usage
424 //usage:       "[-cf] [FILE]..."
425 //usage:#define unlzma_full_usage "\n\n"
426 //usage:       "Decompress FILE (or stdin)\n"
427 //usage:     "\n        -c      Write to stdout"
428 //usage:     "\n        -f      Force"
429 //usage:
430 //usage:#define lzma_trivial_usage
431 //usage:       "-d [-cf] [FILE]..."
432 //usage:#define lzma_full_usage "\n\n"
433 //usage:       "Decompress FILE (or stdin)\n"
434 //usage:     "\n        -d      Decompress"
435 //usage:     "\n        -c      Write to stdout"
436 //usage:     "\n        -f      Force"
437 //usage:
438 //usage:#define lzcat_trivial_usage
439 //usage:       "[FILE]..."
440 //usage:#define lzcat_full_usage "\n\n"
441 //usage:       "Decompress to stdout"
442 //usage:
443 //usage:#define unxz_trivial_usage
444 //usage:       "[-cf] [FILE]..."
445 //usage:#define unxz_full_usage "\n\n"
446 //usage:       "Decompress FILE (or stdin)\n"
447 //usage:     "\n        -c      Write to stdout"
448 //usage:     "\n        -f      Force"
449 //usage:
450 //usage:#define xz_trivial_usage
451 //usage:       "-d [-cf] [FILE]..."
452 //usage:#define xz_full_usage "\n\n"
453 //usage:       "Decompress FILE (or stdin)\n"
454 //usage:     "\n        -d      Decompress"
455 //usage:     "\n        -c      Write to stdout"
456 //usage:     "\n        -f      Force"
457 //usage:
458 //usage:#define xzcat_trivial_usage
459 //usage:       "[FILE]..."
460 //usage:#define xzcat_full_usage "\n\n"
461 //usage:       "Decompress to stdout"
462
463 //config:config UNLZMA
464 //config:       bool "unlzma"
465 //config:       default y
466 //config:       help
467 //config:         unlzma is a compression utility using the Lempel-Ziv-Markov chain
468 //config:         compression algorithm, and range coding. Compression
469 //config:         is generally considerably better than that achieved by the bzip2
470 //config:         compressors.
471 //config:
472 //config:         The BusyBox unlzma applet is limited to decompression only.
473 //config:         On an x86 system, this applet adds about 4K.
474 //config:
475 //config:config FEATURE_LZMA_FAST
476 //config:       bool "Optimize unlzma for speed"
477 //config:       default n
478 //config:       depends on UNLZMA
479 //config:       help
480 //config:         This option reduces decompression time by about 25% at the cost of
481 //config:         a 1K bigger binary.
482 //config:
483 //config:config LZMA
484 //config:       bool "Provide lzma alias which supports only unpacking"
485 //config:       default y
486 //config:       depends on UNLZMA
487 //config:       help
488 //config:         Enable this option if you want commands like "lzma -d" to work.
489 //config:         IOW: you'll get lzma applet, but it will always require -d option.
490
491 //applet:IF_UNLZMA(APPLET(unlzma, BB_DIR_USR_BIN, BB_SUID_DROP))
492 //applet:IF_UNLZMA(APPLET_ODDNAME(lzcat, unlzma, BB_DIR_USR_BIN, BB_SUID_DROP, lzcat))
493 //applet:IF_LZMA(APPLET_ODDNAME(lzma, unlzma, BB_DIR_USR_BIN, BB_SUID_DROP, lzma))
494 //kbuild:lib-$(CONFIG_UNLZMA) += bbunzip.o
495 #if ENABLE_UNLZMA
496 static
497 IF_DESKTOP(long long) int FAST_FUNC unpack_unlzma(transformer_aux_data_t *aux)
498 {
499         return unpack_lzma_stream(aux, STDIN_FILENO, STDOUT_FILENO);
500 }
501 int unlzma_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
502 int unlzma_main(int argc UNUSED_PARAM, char **argv)
503 {
504         IF_LZMA(int opts =) getopt32(argv, "cfvqdt");
505 # if ENABLE_LZMA
506         /* lzma without -d or -t? */
507         if (applet_name[2] == 'm' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
508                 bb_show_usage();
509 # endif
510         /* lzcat? */
511         if (applet_name[2] == 'c')
512                 option_mask32 |= OPT_STDOUT;
513
514         argv += optind;
515         return bbunpack(argv, unpack_unlzma, make_new_name_generic, "lzma");
516 }
517 #endif
518
519
520 //config:config UNXZ
521 //config:       bool "unxz"
522 //config:       default y
523 //config:       help
524 //config:         unxz is a unlzma successor.
525 //config:
526 //config:config XZ
527 //config:       bool "Provide xz alias which supports only unpacking"
528 //config:       default y
529 //config:       depends on UNXZ
530 //config:       help
531 //config:         Enable this option if you want commands like "xz -d" to work.
532 //config:         IOW: you'll get xz applet, but it will always require -d option.
533
534 //applet:IF_UNXZ(APPLET(unxz, BB_DIR_USR_BIN, BB_SUID_DROP))
535 //applet:IF_UNXZ(APPLET_ODDNAME(xzcat, unxz, BB_DIR_USR_BIN, BB_SUID_DROP, xzcat))
536 //applet:IF_XZ(APPLET_ODDNAME(xz, unxz, BB_DIR_USR_BIN, BB_SUID_DROP, xz))
537 //kbuild:lib-$(CONFIG_UNXZ) += bbunzip.o
538 #if ENABLE_UNXZ
539 static
540 IF_DESKTOP(long long) int FAST_FUNC unpack_unxz(transformer_aux_data_t *aux)
541 {
542         return unpack_xz_stream(aux, STDIN_FILENO, STDOUT_FILENO);
543 }
544 int unxz_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
545 int unxz_main(int argc UNUSED_PARAM, char **argv)
546 {
547         IF_XZ(int opts =) getopt32(argv, "cfvqdt");
548 # if ENABLE_XZ
549         /* xz without -d or -t? */
550         if (applet_name[2] == '\0' && !(opts & (OPT_DECOMPRESS|OPT_TEST)))
551                 bb_show_usage();
552 # endif
553         /* xzcat? */
554         if (applet_name[2] == 'c')
555                 option_mask32 |= OPT_STDOUT;
556
557         argv += optind;
558         return bbunpack(argv, unpack_unxz, make_new_name_generic, "xz");
559 }
560 #endif