1 /* gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
3 Copyright (C) 1999, 2001-2002, 2006-2007, 2009 Free Software Foundation,
5 Copyright (C) 1992-1993 Jean-loup Gailly
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software Foundation,
19 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
22 * The unzip code was written and put in the public domain by Mark Adler.
23 * Portions of the lzw code are derived from the public domain 'compress'
24 * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
25 * Ken Turkowski, Dave Mack and Peter Jannesen.
27 * See the license_msg below and the file COPYING for the software license.
28 * See the file algorithm.doc for the compression algorithms and file formats.
31 static char const *const license_msg[] = {
32 "Copyright (C) 2007 Free Software Foundation, Inc.",
33 "Copyright (C) 1993 Jean-loup Gailly.",
34 "This is free software. You may redistribute copies of it under the terms of",
35 "the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.",
36 "There is NO WARRANTY, to the extent permitted by law.",
39 /* Compress files with zip algorithm and 'compress' interface.
40 * See help() function below for all options.
42 * file.gz: compressed file with same mode, owner, and utimes
43 * or stdout with -c option or if stdin used as input.
44 * If the output file name had to be truncated, the original name is kept
45 * in the compressed file.
46 * On MSDOS, file.tmp -> file.tmz. On VMS, file.tmp -> file.tmp-gz.
48 * Using gz on MSDOS would create too many file name conflicts. For
49 * example, foo.txt -> foo.tgz (.tgz must be reserved as shorthand for
50 * tar.gz). Similarly, foo.dir and foo.doc would both be mapped to foo.dgz.
51 * I also considered 12345678.txt -> 12345txt.gz but this truncates the name
52 * too heavily. There is no ideal solution given the MSDOS 8+3 limitation.
54 * For the meaning of all compilation flags, see comments in Makefile.in.
59 #include <sys/types.h>
70 #include "fcntl-safer.h"
72 #include "ignore-value.h"
73 #include "stat-time.h"
89 #if defined STDC_HEADERS || defined HAVE_STDLIB_H
100 # ifndef _D_EXACT_NAMLEN
101 # define _D_EXACT_NAMLEN(dp) strlen ((dp)->d_name)
106 # define CLOSEDIR(d) (closedir(d), 0)
108 # define CLOSEDIR(d) closedir(d)
112 # include <utimens.h>
115 #define RW_USER (S_IRUSR | S_IWUSR) /* creation mode for open() */
118 # define MAX_PATH_LEN 1024 /* max pathname length */
130 off_t lseek OF((int fd, off_t offset, int whence));
134 #define OFF_T_MIN (~ (off_t) 0 << (sizeof (off_t) * CHAR_BIT - 1))
138 #define OFF_T_MAX (~ (off_t) 0 - OFF_T_MIN)
141 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
144 # define SA_NOCLDSTOP 0
145 # define sigprocmask(how, set, oset) /* empty */
146 # define sigset_t int
147 # if ! HAVE_SIGINTERRUPT
148 # define siginterrupt(sig, flag) /* empty */
152 #ifndef HAVE_WORKING_O_NOFOLLOW
153 # define HAVE_WORKING_O_NOFOLLOW 0
157 # define ELOOP EINVAL
160 /* Separator for file name parts (see shorten_name()) */
161 #ifdef NO_MULTIPLE_DOTS
162 # define PART_SEP "-"
164 # define PART_SEP "."
169 DECLARE(uch, inbuf, INBUFSIZ +INBUF_EXTRA);
170 DECLARE(uch, outbuf, OUTBUFSIZ+OUTBUF_EXTRA);
171 DECLARE(ush, d_buf, DIST_BUFSIZE);
172 DECLARE(uch, window, 2L*WSIZE);
174 DECLARE(ush, tab_prefix, 1L<<BITS);
176 DECLARE(ush, tab_prefix0, 1L<<(BITS-1));
177 DECLARE(ush, tab_prefix1, 1L<<(BITS-1));
180 /* local variables */
182 int ascii = 0; /* convert end-of-lines to local OS conventions */
183 int to_stdout = 0; /* output to stdout (-c) */
184 int decompress = 0; /* decompress (-d) */
185 int force = 0; /* don't ask questions, compress links (-f) */
186 int no_name = -1; /* don't save or restore the original file name */
187 int no_time = -1; /* don't save or restore the original file time */
188 int recursive = 0; /* recurse through directories (-r) */
189 int list = 0; /* list the file contents (-l) */
190 int verbose = 0; /* be verbose (-v) */
191 int quiet = 0; /* be very quiet (-q) */
192 int do_lzw = 0; /* generate output compatible with old compress (-Z) */
193 int test = 0; /* test .gz file integrity */
194 int foreground = 0; /* set if program run in foreground */
195 char *program_name; /* program name */
196 int maxbits = BITS; /* max bits per code for LZW */
197 int method = DEFLATED;/* compression method */
198 int level = 6; /* compression level */
199 int exit_code = OK; /* program exit code */
200 int save_orig_name; /* set if original name must be saved */
201 int last_member; /* set for .zip and .Z files */
202 int part_nb; /* number of parts in .gz file */
203 struct timespec time_stamp; /* original time stamp (modification time) */
204 off_t ifile_size; /* input file size, -1 for devices (debug only) */
205 char *env; /* contents of GZIP env variable */
206 char **args = NULL; /* argv pointer if GZIP env variable defined */
207 char const *z_suffix; /* default suffix (can be set with --suffix) */
208 size_t z_len; /* strlen(z_suffix) */
210 /* The set of signals that are caught. */
211 static sigset_t caught_signals;
213 /* If nonzero then exit with status WARNING, rather than with the usual
214 signal status, on receipt of a signal with this value. This
215 suppresses a "Broken Pipe" message with some shells. */
216 static int volatile exiting_signal;
218 /* If nonnegative, close this file descriptor and unlink ofname on error. */
219 static int volatile remove_ofname_fd = -1;
221 off_t bytes_in; /* number of input bytes */
222 off_t bytes_out; /* number of output bytes */
223 off_t total_in; /* input bytes for all files */
224 off_t total_out; /* output bytes for all files */
225 char ifname[MAX_PATH_LEN]; /* input file name */
226 char ofname[MAX_PATH_LEN]; /* output file name */
227 struct stat istat; /* status for input file */
228 int ifd; /* input file descriptor */
229 int ofd; /* output file descriptor */
230 unsigned insize; /* valid bytes in inbuf */
231 unsigned inptr; /* index of next byte to be processed in inbuf */
232 unsigned outcnt; /* bytes in output buffer */
234 static int handled_sig[] =
236 /* SIGINT must be first, as 'foreground' depends on it. */
258 struct option longopts[] =
260 /* { name has_arg *flag val } */
261 {"ascii", 0, 0, 'a'}, /* ascii text mode */
262 {"to-stdout", 0, 0, 'c'}, /* write output on standard output */
263 {"stdout", 0, 0, 'c'}, /* write output on standard output */
264 {"decompress", 0, 0, 'd'}, /* decompress */
265 {"uncompress", 0, 0, 'd'}, /* decompress */
266 /* {"encrypt", 0, 0, 'e'}, encrypt */
267 {"force", 0, 0, 'f'}, /* force overwrite of output file */
268 {"help", 0, 0, 'h'}, /* give help */
269 /* {"pkzip", 0, 0, 'k'}, force output in pkzip format */
270 {"list", 0, 0, 'l'}, /* list .gz file contents */
271 {"license", 0, 0, 'L'}, /* display software license */
272 {"no-name", 0, 0, 'n'}, /* don't save or restore original name & time */
273 {"name", 0, 0, 'N'}, /* save or restore original name & time */
274 {"quiet", 0, 0, 'q'}, /* quiet mode */
275 {"silent", 0, 0, 'q'}, /* quiet mode */
276 {"recursive", 0, 0, 'r'}, /* recurse through directories */
277 {"suffix", 1, 0, 'S'}, /* use given suffix instead of .gz */
278 {"test", 0, 0, 't'}, /* test compressed file integrity */
279 {"no-time", 0, 0, 'T'}, /* don't save or restore the time stamp */
280 {"verbose", 0, 0, 'v'}, /* verbose mode */
281 {"version", 0, 0, 'V'}, /* display version number */
282 {"fast", 0, 0, '1'}, /* compress faster */
283 {"best", 0, 0, '9'}, /* compress better */
284 {"lzw", 0, 0, 'Z'}, /* make output compatible with old compress */
285 {"bits", 1, 0, 'b'}, /* max number of bits per code (implies -Z) */
289 /* local functions */
291 local void try_help OF((void)) ATTRIBUTE_NORETURN;
292 local void help OF((void));
293 local void license OF((void));
294 local void version OF((void));
295 local int input_eof OF((void));
296 local void treat_stdin OF((void));
297 local void treat_file OF((char *iname));
298 local int create_outfile OF((void));
299 local char *get_suffix OF((char *name));
300 local int open_input_file OF((char *iname, struct stat *sbuf));
301 local int make_ofname OF((void));
302 local void shorten_name OF((char *name));
303 local int get_method OF((int in));
304 local void do_list OF((int ifd, int method));
305 local int check_ofname OF((void));
306 local void copy_stat OF((struct stat *ifstat));
307 local void install_signal_handlers OF((void));
308 local void remove_output_file OF((void));
309 local RETSIGTYPE abort_gzip_signal OF((int));
310 local void do_exit OF((int exitcode)) ATTRIBUTE_NORETURN;
311 int main OF((int argc, char **argv));
312 int (*work) OF((int infile, int outfile)) = zip; /* function to call */
315 local void treat_dir OF((int fd, char *dir));
318 #define strequ(s1, s2) (strcmp((s1),(s2)) == 0)
323 fprintf (stderr, "Try `%s --help' for more information.\n",
328 /* ======================================================================== */
331 static char const* const help_msg[] = {
332 "Compress or uncompress FILEs (by default, compress FILES in-place).",
334 "Mandatory arguments to long options are mandatory for short options too.",
337 " -a, --ascii ascii text; convert end-of-line using local conventions",
339 " -c, --stdout write on standard output, keep original files unchanged",
340 " -d, --decompress decompress",
341 /* -e, --encrypt encrypt */
342 " -f, --force force overwrite of output file and compress links",
343 " -h, --help give this help",
344 /* -k, --pkzip force output in pkzip format */
345 " -l, --list list compressed file contents",
346 " -L, --license display software license",
348 " -m, --no-time do not save or restore the original modification time",
349 " -M, --time save or restore the original modification time",
351 " -n, --no-name do not save or restore the original name and time stamp",
352 " -N, --name save or restore the original name and time stamp",
353 " -q, --quiet suppress all warnings",
355 " -r, --recursive operate recursively on directories",
357 " -S, --suffix=SUF use suffix SUF on compressed files",
358 " -t, --test test compressed file integrity",
359 " -v, --verbose verbose mode",
360 " -V, --version display version number",
361 " -1, --fast compress faster",
362 " -9, --best compress better",
364 " -Z, --lzw produce output compatible with old compress",
365 " -b, --bits=BITS max number of bits per code (implies -Z)",
368 "With no FILE, or when FILE is -, read standard input.",
370 "Report bugs to <bug-gzip@gnu.org>.",
372 char const *const *p = help_msg;
374 printf ("Usage: %s [OPTION]... [FILE]...\n", program_name);
375 while (*p) printf ("%s\n", *p++);
378 /* ======================================================================== */
381 char const *const *p = license_msg;
383 printf ("%s %s\n", program_name, VERSION);
384 while (*p) printf ("%s\n", *p++);
387 /* ======================================================================== */
392 printf ("Written by Jean-loup Gailly.\n");
395 local void progerror (char const *string)
398 fprintf (stderr, "%s: ", program_name);
404 /* ======================================================================== */
405 int main (int argc, char **argv)
407 int file_count; /* number of files to process */
408 size_t proglen; /* length of program_name */
409 int optc; /* current option */
411 EXPAND(argc, argv); /* wild card expansion if necessary */
413 program_name = gzip_base_name (argv[0]);
414 proglen = strlen (program_name);
416 atexit (close_stdin);
418 /* Suppress .exe for MSDOS, OS/2 and VMS: */
419 if (4 < proglen && strequ (program_name + proglen - 4, ".exe"))
420 program_name[proglen - 4] = '\0';
422 /* Add options in GZIP environment variable if there is one */
423 env = add_envopt(&argc, &argv, OPTIONS_VAR);
424 if (env != NULL) args = argv;
427 # define GNU_STANDARD 1
430 /* For compatibility with old compress, use program name as an option.
431 * Unless you compile with -DGNU_STANDARD=0, this program will behave as
432 * gzip even if it is invoked under the name gunzip or zcat.
434 * Systems which do not support links can still use -d or -dc.
435 * Ignore an .exe extension for MSDOS, OS/2 and VMS.
437 if (strncmp (program_name, "un", 2) == 0 /* ungzip, uncompress */
438 || strncmp (program_name, "gun", 3) == 0) /* gunzip */
440 else if (strequ (program_name + 1, "cat") /* zcat, pcat, gcat */
441 || strequ (program_name, "gzcat")) /* gzcat */
442 decompress = to_stdout = 1;
446 z_len = strlen(z_suffix);
448 while ((optc = getopt_long (argc, argv, "ab:cdfhH?lLmMnNqrS:tvVZ123456789",
449 longopts, (int *)0)) != -1) {
454 maxbits = atoi(optarg);
455 for (; *optarg; optarg++)
456 if (! ('0' <= *optarg && *optarg <= '9'))
458 fprintf (stderr, "%s: -b operand is not an integer\n",
464 to_stdout = 1; break;
466 decompress = 1; break;
470 help(); do_exit(OK); break;
472 list = decompress = to_stdout = 1; break;
474 license(); do_exit(OK); break;
475 case 'm': /* undocumented, may change later */
477 case 'M': /* undocumented, may change later */
480 no_name = no_time = 1; break;
482 no_name = no_time = 0; break;
484 quiet = 1; verbose = 0; break;
487 fprintf (stderr, "%s: -r not supported on this system\n",
495 #ifdef NO_MULTIPLE_DOTS
496 if (*optarg == '.') optarg++;
498 z_len = strlen(optarg);
502 test = decompress = to_stdout = 1;
505 verbose++; quiet = 0; break;
507 version(); do_exit(OK); break;
512 fprintf(stderr, "%s: -Z not supported in this version\n",
517 case '1': case '2': case '3': case '4':
518 case '5': case '6': case '7': case '8': case '9':
522 /* Error message already emitted by getopt_long. */
525 } /* loop on all arguments */
527 /* By default, save name and timestamp on compression but do not
528 * restore them on decompression.
530 if (no_time < 0) no_time = decompress;
531 if (no_name < 0) no_name = decompress;
533 file_count = argc - optind;
537 if (ascii && !quiet) {
538 fprintf(stderr, "%s: option --ascii ignored on this system\n",
542 if ((z_len == 0 && !decompress) || z_len > MAX_SUFFIX) {
543 fprintf(stderr, "%s: incorrect suffix '%s'\n",
544 program_name, z_suffix);
547 if (do_lzw && !decompress) work = lzw;
549 /* Allocate all global buffers (for DYN_ALLOC option) */
550 ALLOC(uch, inbuf, INBUFSIZ +INBUF_EXTRA);
551 ALLOC(uch, outbuf, OUTBUFSIZ+OUTBUF_EXTRA);
552 ALLOC(ush, d_buf, DIST_BUFSIZE);
553 ALLOC(uch, window, 2L*WSIZE);
555 ALLOC(ush, tab_prefix, 1L<<BITS);
557 ALLOC(ush, tab_prefix0, 1L<<(BITS-1));
558 ALLOC(ush, tab_prefix1, 1L<<(BITS-1));
561 exiting_signal = quiet ? SIGPIPE : 0;
562 install_signal_handlers ();
564 /* And get to work */
565 if (file_count != 0) {
566 if (to_stdout && !test && !list && (!decompress || !ascii)) {
567 SET_BINARY_MODE(fileno(stdout));
569 while (optind < argc) {
570 treat_file(argv[optind++]);
572 } else { /* Standard input */
575 if (list && !quiet && file_count > 1) {
576 do_list(-1, -1); /* print totals */
579 return exit_code; /* just to avoid lint warning */
582 /* Return nonzero when at end of file on input. */
586 if (!decompress || last_member)
591 if (insize != INBUFSIZ || fill_inbuf (1) == EOF)
594 /* Unget the char that fill_inbuf got. */
601 /* ========================================================================
602 * Compress or decompress stdin
604 local void treat_stdin()
606 if (!force && !list &&
607 isatty(fileno((FILE *)(decompress ? stdin : stdout)))) {
608 /* Do not send compressed data to the terminal or read it from
609 * the terminal. We get here when user invoked the program
610 * without parameters, so be helpful. According to the GNU standards:
612 * If there is one behavior you think is most useful when the output
613 * is to a terminal, and another that you think is most useful when
614 * the output is a file or a pipe, then it is usually best to make
615 * the default behavior the one that is useful with output to a
616 * terminal, and have an option for the other behavior.
618 * Here we use the --force option to get the other behavior.
621 "%s: compressed data not %s a terminal. Use -f to force %scompression.\n",
622 program_name, decompress ? "read from" : "written to",
623 decompress ? "de" : "");
624 fprintf (stderr, "For help, type: %s -h\n", program_name);
628 if (decompress || !ascii) {
629 SET_BINARY_MODE(fileno(stdin));
631 if (!test && !list && (!decompress || !ascii)) {
632 SET_BINARY_MODE(fileno(stdout));
634 strcpy(ifname, "stdin");
635 strcpy(ofname, "stdout");
637 /* Get the file's time stamp and size. */
638 if (fstat (fileno (stdin), &istat) != 0)
640 progerror ("standard input");
643 ifile_size = S_ISREG (istat.st_mode) ? istat.st_size : -1;
644 time_stamp.tv_nsec = -1;
645 if (!no_time || list)
646 time_stamp = get_stat_mtime (&istat);
648 clear_bufs(); /* clear input and output buffers */
654 method = get_method(ifd);
656 do_exit(exit_code); /* error message already emitted */
660 do_list(ifd, method);
664 /* Actually do the compression/decompression. Loop over zipped members.
667 if ((*work)(fileno(stdin), fileno(stdout)) != OK) return;
672 method = get_method(ifd);
673 if (method < 0) return; /* error message already emitted */
674 bytes_out = 0; /* required for length check */
679 fprintf(stderr, " OK\n");
681 } else if (!decompress) {
682 display_ratio(bytes_in-(bytes_out-header_bytes), bytes_in, stderr);
683 fprintf(stderr, "\n");
684 #ifdef DISPLAY_STDIN_RATIO
686 display_ratio(bytes_out-(bytes_in-header_bytes), bytes_out,stderr);
687 fprintf(stderr, "\n");
693 /* ========================================================================
694 * Compress or decompress the given file
696 local void treat_file(iname)
699 /* Accept "-" as synonym for stdin */
700 if (strequ(iname, "-")) {
701 int cflag = to_stdout;
707 /* Check if the input file is present, set ifname and istat: */
708 ifd = open_input_file (iname, &istat);
712 /* If the input name is that of a directory, recurse or ignore: */
713 if (S_ISDIR(istat.st_mode)) {
716 treat_dir (ifd, iname);
717 /* Warning: ifname is now garbage */
722 WARN ((stderr, "%s: %s is a directory -- ignored\n",
723 program_name, ifname));
729 if (! S_ISREG (istat.st_mode))
732 "%s: %s is not a directory or a regular file - ignored\n",
733 program_name, ifname));
737 if (istat.st_mode & S_ISUID)
739 WARN ((stderr, "%s: %s is set-user-ID on execution - ignored\n",
740 program_name, ifname));
744 if (istat.st_mode & S_ISGID)
746 WARN ((stderr, "%s: %s is set-group-ID on execution - ignored\n",
747 program_name, ifname));
754 if (istat.st_mode & S_ISVTX)
757 "%s: %s has the sticky bit set - file ignored\n",
758 program_name, ifname));
762 if (2 <= istat.st_nlink)
764 WARN ((stderr, "%s: %s has %lu other link%c -- unchanged\n",
765 program_name, ifname,
766 (unsigned long int) istat.st_nlink - 1,
767 istat.st_nlink == 2 ? ' ' : 's'));
774 ifile_size = S_ISREG (istat.st_mode) ? istat.st_size : -1;
775 time_stamp.tv_nsec = -1;
776 if (!no_time || list)
777 time_stamp = get_stat_mtime (&istat);
779 /* Generate output file name. For -r and (-t or -l), skip files
780 * without a valid gzip suffix (check done in make_ofname).
782 if (to_stdout && !list && !test) {
783 strcpy(ofname, "stdout");
785 } else if (make_ofname() != OK) {
790 clear_bufs(); /* clear input and output buffers */
794 method = get_method(ifd); /* updates ofname if original given */
797 return; /* error message already emitted */
801 do_list(ifd, method);
802 if (close (ifd) != 0)
807 /* If compressing to a file, check if ofname is not ambiguous
808 * because the operating system truncates names. Otherwise, generate
809 * a new ofname and save the original name in the compressed file.
812 ofd = fileno(stdout);
813 /* Keep remove_ofname_fd negative. */
815 if (create_outfile() != OK) return;
817 if (!decompress && save_orig_name && !verbose && !quiet) {
818 fprintf(stderr, "%s: %s compressed to %s\n",
819 program_name, ifname, ofname);
822 /* Keep the name even if not truncated except with --no-name: */
823 if (!save_orig_name) save_orig_name = !no_name;
826 fprintf(stderr, "%s:\t", ifname);
829 /* Actually do the compression/decompression. Loop over zipped members.
832 if ((*work)(ifd, ofd) != OK) {
833 method = -1; /* force cleanup */
840 method = get_method(ifd);
841 if (method < 0) break; /* error message already emitted */
842 bytes_out = 0; /* required for length check */
845 if (close (ifd) != 0)
854 if (close (ofd) != 0)
857 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
858 remove_ofname_fd = -1;
859 unlink_errno = xunlink (ifname) == 0 ? 0 : errno;
860 sigprocmask (SIG_SETMASK, &oldset, NULL);
864 WARN ((stderr, "%s: ", program_name));
867 errno = unlink_errno;
875 remove_output_file ();
879 /* Display statistics */
882 fprintf(stderr, " OK");
883 } else if (decompress) {
884 display_ratio(bytes_out-(bytes_in-header_bytes), bytes_out,stderr);
886 display_ratio(bytes_in-(bytes_out-header_bytes), bytes_in, stderr);
888 if (!test && !to_stdout) {
889 fprintf(stderr, " -- replaced with %s", ofname);
891 fprintf(stderr, "\n");
895 /* ========================================================================
896 * Create the output file. Return OK or ERROR.
897 * Try several times if necessary to avoid truncating the z_suffix. For
898 * example, do not create a compressed file of name "1234567890123."
899 * Sets save_orig_name to true if the file name has been truncated.
900 * IN assertions: the input file has already been open (ifd is set) and
901 * ofname has already been updated if there was an original name.
902 * OUT assertions: ifd and ofd are closed in case of error.
904 local int create_outfile()
906 int name_shortened = 0;
907 int flags = (O_WRONLY | O_CREAT | O_EXCL
908 | (ascii && decompress ? 0 : O_BINARY));
915 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
916 remove_ofname_fd = ofd = OPEN (ofname, flags, RW_USER);
918 sigprocmask (SIG_SETMASK, &oldset, NULL);
927 shorten_name (ofname);
933 if (check_ofname () != OK)
947 if (name_shortened && decompress)
949 /* name might be too long if an original name was saved */
950 WARN ((stderr, "%s: %s: warning, name truncated\n",
951 program_name, ofname));
957 /* ========================================================================
958 * Return a pointer to the 'z' suffix of a file name, or NULL. For all
959 * systems, ".gz", ".z", ".Z", ".taz", ".tgz", "-gz", "-z" and "_z" are
960 * accepted suffixes, in addition to the value of the --suffix option.
961 * ".tgz" is a useful convention for tar.z files on systems limited
962 * to 3 characters extensions. On such systems, ".?z" and ".??z" are
963 * also accepted suffixes. For Unix, we do not want to accept any
964 * .??z suffix as indicating a compressed file; some people use .xyz
965 * to denote volume data.
966 * On systems allowing multiple versions of the same file (such as VMS),
967 * this function removes any version suffix in the given name.
969 local char *get_suffix(name)
973 char suffix[MAX_SUFFIX+3]; /* last chars of name, forced to lower case */
974 static char const *known_suffixes[] =
975 {NULL, ".gz", ".z", ".taz", ".tgz", "-gz", "-z", "_z",
980 char const **suf = known_suffixes;
983 if (strequ(z_suffix, "z")) suf++; /* check long suffixes first */
986 /* strip a version number from the file name */
988 char *v = strrchr(name, SUFFIX_SEP);
989 if (v != NULL) *v = '\0';
993 if (nlen <= MAX_SUFFIX+2) {
994 strcpy(suffix, name);
996 strcpy(suffix, name+nlen-MAX_SUFFIX-2);
999 slen = strlen(suffix);
1001 int s = strlen(*suf);
1002 if (slen > s && suffix[slen-s-1] != PATH_SEP
1003 && strequ(suffix + slen - s, *suf)) {
1006 } while (*++suf != NULL);
1012 /* Open file NAME with the given flags and mode and store its status
1013 into *ST. Return a file descriptor to the newly opened file, or -1
1014 (setting errno) on failure. */
1016 open_and_stat (char *name, int flags, mode_t mode, struct stat *st)
1020 /* Refuse to follow symbolic links unless -c or -f. */
1021 if (!to_stdout && !force)
1023 if (HAVE_WORKING_O_NOFOLLOW)
1024 flags |= O_NOFOLLOW;
1027 #if HAVE_LSTAT || defined lstat
1028 if (lstat (name, st) != 0)
1030 else if (S_ISLNK (st->st_mode))
1039 fd = OPEN (name, flags, mode);
1040 if (0 <= fd && fstat (fd, st) != 0)
1051 /* ========================================================================
1052 * Set ifname to the input file name (with a suffix appended if necessary)
1053 * and istat to its stats. For decompression, if no file exists with the
1054 * original name, try adding successively z_suffix, .gz, .z, -z and .Z.
1055 * For MSDOS, we try only z_suffix and z.
1056 * Return an open file descriptor or -1.
1059 open_input_file (iname, sbuf)
1063 int ilen; /* strlen(ifname) */
1064 int z_suffix_errno = 0;
1065 static char const *suffixes[] = {NULL, ".gz", ".z", "-z", ".Z", NULL};
1066 char const **suf = suffixes;
1068 #ifdef NO_MULTIPLE_DOTS
1069 char *dot; /* pointer to ifname extension, or NULL */
1072 int open_flags = (O_RDONLY | O_NONBLOCK | O_NOCTTY
1073 | (ascii && !decompress ? 0 : O_BINARY));
1077 if (sizeof ifname - 1 <= strlen (iname))
1080 strcpy(ifname, iname);
1082 /* If input file exists, return OK. */
1083 fd = open_and_stat (ifname, open_flags, RW_USER, sbuf);
1087 if (!decompress || errno != ENOENT) {
1091 /* file.ext doesn't exist, try adding a suffix (after removing any
1092 * version number for VMS).
1094 s = get_suffix(ifname);
1096 progerror(ifname); /* ifname already has z suffix and does not exist */
1099 #ifdef NO_MULTIPLE_DOTS
1100 dot = strrchr(ifname, '.');
1102 strcat(ifname, ".");
1103 dot = strrchr(ifname, '.');
1106 ilen = strlen(ifname);
1107 if (strequ(z_suffix, ".gz")) suf++;
1109 /* Search for all suffixes */
1111 char const *s0 = s = *suf;
1112 strcpy (ifname, iname);
1113 #ifdef NO_MULTIPLE_DOTS
1115 if (*dot == '\0') strcpy (dot, ".");
1117 #ifdef MAX_EXT_CHARS
1118 if (MAX_EXT_CHARS < strlen (s) + strlen (dot + 1))
1119 dot[MAX_EXT_CHARS + 1 - strlen (s)] = '\0';
1121 if (sizeof ifname <= ilen + strlen (s))
1124 fd = open_and_stat (ifname, open_flags, RW_USER, sbuf);
1127 if (errno != ENOENT)
1132 if (strequ (s0, z_suffix))
1133 z_suffix_errno = errno;
1134 } while (*++suf != NULL);
1136 /* No suffix found, complain using z_suffix: */
1137 strcpy(ifname, iname);
1138 #ifdef NO_MULTIPLE_DOTS
1139 if (*dot == '\0') strcpy(dot, ".");
1141 #ifdef MAX_EXT_CHARS
1142 if (MAX_EXT_CHARS < z_len + strlen (dot + 1))
1143 dot[MAX_EXT_CHARS + 1 - z_len] = '\0';
1145 strcat(ifname, z_suffix);
1146 errno = z_suffix_errno;
1151 fprintf (stderr, "%s: %s: file name too long\n", program_name, iname);
1156 /* ========================================================================
1157 * Generate ofname given ifname. Return OK, or WARNING if file must be skipped.
1158 * Sets save_orig_name to true if the file name has been truncated.
1160 local int make_ofname()
1162 char *suff; /* ofname z suffix */
1164 strcpy(ofname, ifname);
1165 /* strip a version number if any and get the gzip suffix if present: */
1166 suff = get_suffix(ofname);
1170 /* With -t or -l, try all files (even without .gz suffix)
1171 * except with -r (behave as with just -dr).
1173 if (!recursive && (list || test)) return OK;
1175 /* Avoid annoying messages with -r */
1176 if (verbose || (!recursive && !quiet)) {
1177 WARN((stderr,"%s: %s: unknown suffix -- ignored\n",
1178 program_name, ifname));
1182 /* Make a special case for .tgz and .taz: */
1184 if (strequ(suff, ".tgz") || strequ(suff, ".taz")) {
1185 strcpy(suff, ".tar");
1187 *suff = '\0'; /* strip the z suffix */
1189 /* ofname might be changed later if infile contains an original name */
1191 } else if (suff && ! force) {
1192 /* Avoid annoying messages with -r (see treat_dir()) */
1193 if (verbose || (!recursive && !quiet)) {
1194 /* Don't use WARN, as it affects exit status. */
1195 fprintf (stderr, "%s: %s already has %s suffix -- unchanged\n",
1196 program_name, ifname, suff);
1202 #ifdef NO_MULTIPLE_DOTS
1203 suff = strrchr(ofname, '.');
1205 if (sizeof ofname <= strlen (ofname) + 1)
1207 strcat(ofname, ".");
1208 # ifdef MAX_EXT_CHARS
1209 if (strequ(z_suffix, "z")) {
1210 if (sizeof ofname <= strlen (ofname) + 2)
1212 strcat(ofname, "gz"); /* enough room */
1215 /* On the Atari and some versions of MSDOS,
1216 * ENAMETOOLONG does not work correctly. So we
1217 * must truncate here.
1219 } else if (strlen(suff)-1 + z_len > MAX_SUFFIX) {
1220 suff[MAX_SUFFIX+1-z_len] = '\0';
1224 #endif /* NO_MULTIPLE_DOTS */
1225 if (sizeof ofname <= strlen (ofname) + z_len)
1227 strcat(ofname, z_suffix);
1229 } /* decompress ? */
1233 WARN ((stderr, "%s: %s: file name too long\n", program_name, ifname));
1238 /* ========================================================================
1239 * Check the magic number of the input file and update ofname if an
1240 * original name was given and to_stdout is not set.
1241 * Return the compression method, -1 for error, -2 for warning.
1242 * Set inptr to the offset of the next byte to be processed.
1243 * Updates time_stamp if there is one and --no-time is not used.
1244 * This function may be called repeatedly for an input file consisting
1245 * of several contiguous gzip'ed members.
1246 * IN assertions: there is at least one remaining compressed member.
1247 * If the member is a zip file, it must be the only one.
1249 local int get_method(in)
1250 int in; /* input file descriptor */
1252 uch flags; /* compression flags */
1253 char magic[2]; /* magic header */
1254 int imagic1; /* like magic[1], but can represent EOF */
1255 ulg stamp; /* time stamp */
1257 /* If --force and --stdout, zcat == cat, so do not complain about
1258 * premature end of file: use try_byte instead of get_byte.
1260 if (force && to_stdout) {
1261 magic[0] = (char)try_byte();
1262 imagic1 = try_byte ();
1263 magic[1] = (char) imagic1;
1264 /* If try_byte returned EOF, magic[1] == (char) EOF. */
1266 magic[0] = (char)get_byte();
1268 magic[1] = (char)get_byte();
1269 imagic1 = 0; /* avoid lint warning */
1271 imagic1 = try_byte ();
1272 magic[1] = (char) imagic1;
1275 method = -1; /* unknown yet */
1276 part_nb++; /* number of parts in gzip file */
1278 last_member = RECORD_IO;
1279 /* assume multiple members in gzip file except for record oriented I/O */
1281 if (memcmp(magic, GZIP_MAGIC, 2) == 0
1282 || memcmp(magic, OLD_GZIP_MAGIC, 2) == 0) {
1284 method = (int)get_byte();
1285 if (method != DEFLATED) {
1287 "%s: %s: unknown method %d -- not supported\n",
1288 program_name, ifname, method);
1293 flags = (uch)get_byte();
1295 if ((flags & ENCRYPTED) != 0) {
1297 "%s: %s is encrypted -- not supported\n",
1298 program_name, ifname);
1302 if ((flags & CONTINUATION) != 0) {
1304 "%s: %s is a multi-part gzip file -- not supported\n",
1305 program_name, ifname);
1307 if (force <= 1) return -1;
1309 if ((flags & RESERVED) != 0) {
1311 "%s: %s has flags 0x%x -- not supported\n",
1312 program_name, ifname, flags);
1314 if (force <= 1) return -1;
1316 stamp = (ulg)get_byte();
1317 stamp |= ((ulg)get_byte()) << 8;
1318 stamp |= ((ulg)get_byte()) << 16;
1319 stamp |= ((ulg)get_byte()) << 24;
1320 if (stamp != 0 && !no_time)
1322 time_stamp.tv_sec = stamp;
1323 time_stamp.tv_nsec = 0;
1326 (void)get_byte(); /* Ignore extra flags for the moment */
1327 (void)get_byte(); /* Ignore OS type for the moment */
1329 if ((flags & CONTINUATION) != 0) {
1330 unsigned part = (unsigned)get_byte();
1331 part |= ((unsigned)get_byte())<<8;
1333 fprintf(stderr,"%s: %s: part number %u\n",
1334 program_name, ifname, part);
1337 if ((flags & EXTRA_FIELD) != 0) {
1338 unsigned len = (unsigned)get_byte();
1339 len |= ((unsigned)get_byte())<<8;
1341 fprintf(stderr,"%s: %s: extra field of %u bytes ignored\n",
1342 program_name, ifname, len);
1344 while (len--) (void)get_byte();
1347 /* Get original file name if it was truncated */
1348 if ((flags & ORIG_NAME) != 0) {
1349 if (no_name || (to_stdout && !list) || part_nb > 1) {
1350 /* Discard the old name */
1351 char c; /* dummy used for NeXTstep 3.0 cc optimizer bug */
1352 do {c=get_byte();} while (c != 0);
1354 /* Copy the base name. Keep a directory prefix intact. */
1355 char *p = gzip_base_name (ofname);
1358 *p = (char)get_char();
1359 if (*p++ == '\0') break;
1360 if (p >= ofname+sizeof(ofname)) {
1361 gzip_error ("corrupted input -- file name too large");
1364 p = gzip_base_name (base);
1365 memmove (base, p, strlen (p) + 1);
1366 /* If necessary, adapt the name to local OS conventions: */
1368 MAKE_LEGAL_NAME(base);
1369 if (base) list=0; /* avoid warning about unused variable */
1371 } /* no_name || to_stdout */
1374 /* Discard file comment if any */
1375 if ((flags & COMMENT) != 0) {
1376 while (get_char() != 0) /* null */ ;
1379 header_bytes = inptr + 2*sizeof(long); /* include crc and size */
1382 } else if (memcmp(magic, PKZIP_MAGIC, 2) == 0 && inptr == 2
1383 && memcmp((char*)inbuf, PKZIP_MAGIC, 4) == 0) {
1384 /* To simplify the code, we support a zip file when alone only.
1385 * We are thus guaranteed that the entire local header fits in inbuf.
1389 if (check_zipfile(in) != OK) return -1;
1390 /* check_zipfile may get ofname from the local header */
1393 } else if (memcmp(magic, PACK_MAGIC, 2) == 0) {
1397 } else if (memcmp(magic, LZW_MAGIC, 2) == 0) {
1399 method = COMPRESSED;
1402 } else if (memcmp(magic, LZH_MAGIC, 2) == 0) {
1407 } else if (force && to_stdout && !list) { /* pass input unchanged */
1413 if (method >= 0) return method;
1416 fprintf (stderr, "\n%s: %s: not in gzip format\n",
1417 program_name, ifname);
1424 for (inbyte = imagic1; inbyte == 0; inbyte = try_byte ())
1429 WARN ((stderr, "\n%s: %s: decompression OK, trailing zero bytes ignored\n",
1430 program_name, ifname));
1435 WARN((stderr, "\n%s: %s: decompression OK, trailing garbage ignored\n",
1436 program_name, ifname));
1441 /* ========================================================================
1442 * Display the characteristics of the compressed file.
1443 * If the given method is < 0, display the accumulated totals.
1444 * IN assertions: time_stamp, header_bytes and ifile_size are initialized.
1446 local void do_list(ifd, method)
1447 int ifd; /* input file descriptor */
1448 int method; /* compression method */
1450 ulg crc; /* original crc */
1451 static int first_time = 1;
1452 static char const *const methods[MAX_METHODS] = {
1457 "", "", "", "", /* 4 to 7 reserved */
1459 int positive_off_t_width = 1;
1462 for (o = OFF_T_MAX; 9 < o; o /= 10) {
1463 positive_off_t_width++;
1466 if (first_time && method >= 0) {
1469 printf("method crc date time ");
1472 printf("%*.*s %*.*s ratio uncompressed_name\n",
1473 positive_off_t_width, positive_off_t_width, "compressed",
1474 positive_off_t_width, positive_off_t_width, "uncompressed");
1476 } else if (method < 0) {
1477 if (total_in <= 0 || total_out <= 0) return;
1481 if (verbose || !quiet) {
1482 fprint_off(stdout, total_in, positive_off_t_width);
1484 fprint_off(stdout, total_out, positive_off_t_width);
1487 display_ratio(total_out-(total_in-header_bytes), total_out, stdout);
1488 /* header_bytes is not meaningful but used to ensure the same
1489 * ratio if there is a single file.
1491 printf(" (totals)\n");
1494 crc = (ulg)~0; /* unknown */
1496 bytes_in = ifile_size;
1499 if (method == DEFLATED && !last_member) {
1500 /* Get the crc and uncompressed size for gzip'ed (not zip'ed) files.
1501 * If the lseek fails, we could use read() to get to the end, but
1502 * --list is used to get quick results.
1503 * Use "gunzip < foo.gz | wc -c" to get the uncompressed size if
1504 * you are not concerned about speed.
1506 bytes_in = lseek(ifd, (off_t)(-8), SEEK_END);
1507 if (bytes_in != -1L) {
1510 if (read(ifd, (char*)buf, sizeof(buf)) != sizeof(buf)) {
1514 bytes_out = LG(buf+4);
1517 #endif /* RECORD_IO */
1520 struct tm *tm = localtime (&time_stamp.tv_sec);
1521 printf ("%5s %08lx ", methods[method], crc);
1523 printf ("%s%3d %02d:%02d ",
1524 ("Jan\0Feb\0Mar\0Apr\0May\0Jun\0Jul\0Aug\0Sep\0Oct\0Nov\0Dec"
1526 tm->tm_mday, tm->tm_hour, tm->tm_min);
1528 printf ("??? ?? ??:?? ");
1530 fprint_off(stdout, bytes_in, positive_off_t_width);
1532 fprint_off(stdout, bytes_out, positive_off_t_width);
1534 if (bytes_in == -1L) {
1536 bytes_in = bytes_out = header_bytes = 0;
1537 } else if (total_in >= 0) {
1538 total_in += bytes_in;
1540 if (bytes_out == -1L) {
1542 bytes_in = bytes_out = header_bytes = 0;
1543 } else if (total_out >= 0) {
1544 total_out += bytes_out;
1546 display_ratio(bytes_out-(bytes_in-header_bytes), bytes_out, stdout);
1547 printf(" %s\n", ofname);
1550 /* ========================================================================
1551 * Shorten the given name by one character, or replace a .tar extension
1552 * with .tgz. Truncate the last part of the name which is longer than
1553 * MIN_PART characters: 1234.678.012.gz -> 123.678.012.gz. If the name
1554 * has only parts shorter than MIN_PART truncate the longest part.
1555 * For decompression, just remove the last character of the name.
1557 * IN assertion: for compression, the suffix of the given name is z_suffix.
1559 local void shorten_name(name)
1562 int len; /* length of name without z_suffix */
1563 char *trunc = NULL; /* character to be truncated */
1564 int plen; /* current part length */
1565 int min_part = MIN_PART; /* current minimum part length */
1571 gzip_error ("name too short");
1575 p = get_suffix(name);
1577 gzip_error ("can't recover suffix\n");
1581 /* compress 1234567890.tar to 1234567890.tgz */
1582 if (len > 4 && strequ(p-4, ".tar")) {
1583 strcpy(p-4, ".tgz");
1586 /* Try keeping short extensions intact:
1587 * 1234.678.012.gz -> 123.678.012.gz
1590 p = strrchr(name, PATH_SEP);
1593 plen = strcspn(p, PART_SEP);
1595 if (plen > min_part) trunc = p-1;
1598 } while (trunc == NULL && --min_part != 0);
1600 if (trunc != NULL) {
1602 trunc[0] = trunc[1];
1606 trunc = strrchr(name, PART_SEP[0]);
1608 gzip_error ("internal error in shorten_name");
1609 if (trunc[1] == '\0') trunc--; /* force truncation */
1611 strcpy(trunc, z_suffix);
1614 /* ========================================================================
1615 * The compressed file already exists, so ask for confirmation.
1616 * Return ERROR if the file must be skipped.
1618 local int check_ofname()
1620 /* Ask permission to overwrite the existing file */
1623 fprintf (stderr, "%s: %s already exists;", program_name, ofname);
1624 if (foreground && isatty(fileno(stdin))) {
1625 fprintf(stderr, " do you wish to overwrite (y or n)? ");
1630 fprintf(stderr, "\tnot overwritten\n");
1631 if (exit_code == OK) exit_code = WARNING;
1635 if (xunlink (ofname)) {
1643 /* ========================================================================
1644 * Copy modes, times, ownership from input file to output file.
1645 * IN assertion: to_stdout is false.
1647 local void copy_stat(ifstat)
1648 struct stat *ifstat;
1650 mode_t mode = ifstat->st_mode & S_IRWXUGO;
1654 struct timespec timespec[2];
1655 timespec[0] = get_stat_atime (ifstat);
1656 timespec[1] = get_stat_mtime (ifstat);
1658 if (decompress && 0 <= time_stamp.tv_nsec
1659 && ! (timespec[1].tv_sec == time_stamp.tv_sec
1660 && timespec[1].tv_nsec == time_stamp.tv_nsec))
1662 timespec[1] = time_stamp;
1664 fprintf(stderr, "%s: time stamp restored\n", ofname);
1668 if (gl_futimens (ofd, ofname, timespec) != 0)
1671 WARN ((stderr, "%s: ", program_name));
1681 /* Copy ownership */
1683 ignore_value (fchown (ofd, ifstat->st_uid, ifstat->st_gid));
1685 ignore_value (chown (ofname, ifstat->st_uid, ifstat->st_gid));
1689 /* Copy the protection modes */
1691 r = fchmod (ofd, mode);
1693 r = chmod (ofname, mode);
1697 WARN ((stderr, "%s: ", program_name));
1707 /* ========================================================================
1708 * Recurse through the given directory. This code is taken from ncompress.
1710 local void treat_dir (fd, dir)
1716 char nbuf[MAX_PATH_LEN];
1719 dirp = fdopendir (fd);
1727 ** WARNING: the following algorithm could occasionally cause
1728 ** compress to produce error warnings of the form "<filename>.gz
1729 ** already has .gz suffix - ignored". This occurs when the
1730 ** .gz output file is inserted into the directory below
1731 ** readdir's current pointer.
1732 ** These warnings are harmless but annoying, so they are suppressed
1733 ** with option -r (except when -v is on). An alternative
1734 ** to allowing this would be to store the entire directory
1735 ** list in memory, then compress the entries in the stored
1736 ** list. Given the depth-first recursive algorithm used here,
1737 ** this could use up a tremendous amount of memory. I don't
1738 ** think it's worth it. -- Dave Mack
1739 ** (An other alternative might be two passes to avoid depth-first.)
1742 while ((errno = 0, dp = readdir(dirp)) != NULL) {
1744 if (strequ(dp->d_name,".") || strequ(dp->d_name,"..")) {
1748 if (len + _D_EXACT_NAMLEN (dp) + 1 < MAX_PATH_LEN - 1) {
1750 if (len != 0 /* dir = "" means current dir on Amiga */
1752 && dir[len-1] != PATH_SEP2
1755 && dir[len-1] != PATH_SEP3
1758 nbuf[len++] = PATH_SEP;
1760 strcpy(nbuf+len, dp->d_name);
1763 fprintf(stderr,"%s: %s/%s: pathname too long\n",
1764 program_name, dir, dp->d_name);
1770 if (CLOSEDIR(dirp) != 0)
1773 #endif /* ! NO_DIR */
1775 /* Make sure signals get handled properly. */
1778 install_signal_handlers ()
1780 int nsigs = sizeof handled_sig / sizeof handled_sig[0];
1784 struct sigaction act;
1786 sigemptyset (&caught_signals);
1787 for (i = 0; i < nsigs; i++)
1789 sigaction (handled_sig[i], NULL, &act);
1790 if (act.sa_handler != SIG_IGN)
1791 sigaddset (&caught_signals, handled_sig[i]);
1794 act.sa_handler = abort_gzip_signal;
1795 act.sa_mask = caught_signals;
1798 for (i = 0; i < nsigs; i++)
1799 if (sigismember (&caught_signals, handled_sig[i]))
1803 sigaction (handled_sig[i], &act, NULL);
1806 for (i = 0; i < nsigs; i++)
1807 if (signal (handled_sig[i], SIG_IGN) != SIG_IGN)
1811 signal (handled_sig[i], abort_gzip_signal);
1812 siginterrupt (handled_sig[i], 1);
1817 /* ========================================================================
1818 * Free all dynamically allocated variables and exit with the given code.
1820 local void do_exit(exitcode)
1823 static int in_exit = 0;
1825 if (in_exit) exit(exitcode);
1844 /* ========================================================================
1845 * Close and unlink the output file.
1848 remove_output_file ()
1853 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1854 fd = remove_ofname_fd;
1857 remove_ofname_fd = -1;
1861 sigprocmask (SIG_SETMASK, &oldset, NULL);
1864 /* ========================================================================
1870 remove_output_file ();
1874 /* ========================================================================
1878 abort_gzip_signal (sig)
1882 signal (sig, SIG_IGN);
1883 remove_output_file ();
1884 if (sig == exiting_signal)
1886 signal (sig, SIG_DFL);