1 /* gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
3 Copyright (C) 1999, 2001-2002, 2006-2007, 2009-2010 Free Software
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"
88 # ifndef _D_EXACT_NAMLEN
89 # define _D_EXACT_NAMLEN(dp) strlen ((dp)->d_name)
94 # define CLOSEDIR(d) (closedir(d), 0)
96 # define CLOSEDIR(d) closedir(d)
100 # include <utimens.h>
103 #define RW_USER (S_IRUSR | S_IWUSR) /* creation mode for open() */
106 # define MAX_PATH_LEN 1024 /* max pathname length */
118 off_t lseek OF((int fd, off_t offset, int whence));
122 #define OFF_T_MIN (~ (off_t) 0 << (sizeof (off_t) * CHAR_BIT - 1))
126 #define OFF_T_MAX (~ (off_t) 0 - OFF_T_MIN)
129 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
132 # define SA_NOCLDSTOP 0
133 # define sigprocmask(how, set, oset) /* empty */
134 # define sigset_t int
135 # if ! HAVE_SIGINTERRUPT
136 # define siginterrupt(sig, flag) /* empty */
140 #ifndef HAVE_WORKING_O_NOFOLLOW
141 # define HAVE_WORKING_O_NOFOLLOW 0
145 # define ELOOP EINVAL
148 /* Separator for file name parts (see shorten_name()) */
149 #ifdef NO_MULTIPLE_DOTS
150 # define PART_SEP "-"
152 # define PART_SEP "."
157 DECLARE(uch, inbuf, INBUFSIZ +INBUF_EXTRA);
158 DECLARE(uch, outbuf, OUTBUFSIZ+OUTBUF_EXTRA);
159 DECLARE(ush, d_buf, DIST_BUFSIZE);
160 DECLARE(uch, window, 2L*WSIZE);
162 DECLARE(ush, tab_prefix, 1L<<BITS);
164 DECLARE(ush, tab_prefix0, 1L<<(BITS-1));
165 DECLARE(ush, tab_prefix1, 1L<<(BITS-1));
168 /* local variables */
170 int ascii = 0; /* convert end-of-lines to local OS conventions */
171 int to_stdout = 0; /* output to stdout (-c) */
172 int decompress = 0; /* decompress (-d) */
173 int force = 0; /* don't ask questions, compress links (-f) */
174 int no_name = -1; /* don't save or restore the original file name */
175 int no_time = -1; /* don't save or restore the original file time */
176 int recursive = 0; /* recurse through directories (-r) */
177 int list = 0; /* list the file contents (-l) */
178 int verbose = 0; /* be verbose (-v) */
179 int quiet = 0; /* be very quiet (-q) */
180 int do_lzw = 0; /* generate output compatible with old compress (-Z) */
181 int test = 0; /* test .gz file integrity */
182 int foreground = 0; /* set if program run in foreground */
183 char *program_name; /* program name */
184 int maxbits = BITS; /* max bits per code for LZW */
185 int method = DEFLATED;/* compression method */
186 int level = 6; /* compression level */
187 int exit_code = OK; /* program exit code */
188 int save_orig_name; /* set if original name must be saved */
189 int last_member; /* set for .zip and .Z files */
190 int part_nb; /* number of parts in .gz file */
191 struct timespec time_stamp; /* original time stamp (modification time) */
192 off_t ifile_size; /* input file size, -1 for devices (debug only) */
193 char *env; /* contents of GZIP env variable */
194 char **args = NULL; /* argv pointer if GZIP env variable defined */
195 char const *z_suffix; /* default suffix (can be set with --suffix) */
196 size_t z_len; /* strlen(z_suffix) */
198 /* The set of signals that are caught. */
199 static sigset_t caught_signals;
201 /* If nonzero then exit with status WARNING, rather than with the usual
202 signal status, on receipt of a signal with this value. This
203 suppresses a "Broken Pipe" message with some shells. */
204 static int volatile exiting_signal;
206 /* If nonnegative, close this file descriptor and unlink ofname on error. */
207 static int volatile remove_ofname_fd = -1;
209 off_t bytes_in; /* number of input bytes */
210 off_t bytes_out; /* number of output bytes */
211 off_t total_in; /* input bytes for all files */
212 off_t total_out; /* output bytes for all files */
213 char ifname[MAX_PATH_LEN]; /* input file name */
214 char ofname[MAX_PATH_LEN]; /* output file name */
215 struct stat istat; /* status for input file */
216 int ifd; /* input file descriptor */
217 int ofd; /* output file descriptor */
218 unsigned insize; /* valid bytes in inbuf */
219 unsigned inptr; /* index of next byte to be processed in inbuf */
220 unsigned outcnt; /* bytes in output buffer */
221 int rsync = 0; /* make ryncable chunks */
223 static int handled_sig[] =
225 /* SIGINT must be first, as 'foreground' depends on it. */
247 struct option longopts[] =
249 /* { name has_arg *flag val } */
250 {"ascii", 0, 0, 'a'}, /* ascii text mode */
251 {"to-stdout", 0, 0, 'c'}, /* write output on standard output */
252 {"stdout", 0, 0, 'c'}, /* write output on standard output */
253 {"decompress", 0, 0, 'd'}, /* decompress */
254 {"uncompress", 0, 0, 'd'}, /* decompress */
255 /* {"encrypt", 0, 0, 'e'}, encrypt */
256 {"force", 0, 0, 'f'}, /* force overwrite of output file */
257 {"help", 0, 0, 'h'}, /* give help */
258 /* {"pkzip", 0, 0, 'k'}, force output in pkzip format */
259 {"list", 0, 0, 'l'}, /* list .gz file contents */
260 {"license", 0, 0, 'L'}, /* display software license */
261 {"no-name", 0, 0, 'n'}, /* don't save or restore original name & time */
262 {"name", 0, 0, 'N'}, /* save or restore original name & time */
263 {"quiet", 0, 0, 'q'}, /* quiet mode */
264 {"silent", 0, 0, 'q'}, /* quiet mode */
265 {"recursive", 0, 0, 'r'}, /* recurse through directories */
266 {"suffix", 1, 0, 'S'}, /* use given suffix instead of .gz */
267 {"test", 0, 0, 't'}, /* test compressed file integrity */
268 {"no-time", 0, 0, 'T'}, /* don't save or restore the time stamp */
269 {"verbose", 0, 0, 'v'}, /* verbose mode */
270 {"version", 0, 0, 'V'}, /* display version number */
271 {"fast", 0, 0, '1'}, /* compress faster */
272 {"best", 0, 0, '9'}, /* compress better */
273 {"lzw", 0, 0, 'Z'}, /* make output compatible with old compress */
274 {"bits", 1, 0, 'b'}, /* max number of bits per code (implies -Z) */
275 {"rsyncable", 0, 0, 'R'}, /* make rsync-friendly archive */
279 /* local functions */
281 local void try_help OF((void)) ATTRIBUTE_NORETURN;
282 local void help OF((void));
283 local void license OF((void));
284 local void version OF((void));
285 local int input_eof OF((void));
286 local void treat_stdin OF((void));
287 local void treat_file OF((char *iname));
288 local int create_outfile OF((void));
289 local char *get_suffix OF((char *name));
290 local int open_input_file OF((char *iname, struct stat *sbuf));
291 local int make_ofname OF((void));
292 local void shorten_name OF((char *name));
293 local int get_method OF((int in));
294 local void do_list OF((int ifd, int method));
295 local int check_ofname OF((void));
296 local void copy_stat OF((struct stat *ifstat));
297 local void install_signal_handlers OF((void));
298 local void remove_output_file OF((void));
299 local RETSIGTYPE abort_gzip_signal OF((int));
300 local void do_exit OF((int exitcode)) ATTRIBUTE_NORETURN;
301 int main OF((int argc, char **argv));
302 int (*work) OF((int infile, int outfile)) = zip; /* function to call */
305 local void treat_dir OF((int fd, char *dir));
308 #define strequ(s1, s2) (strcmp((s1),(s2)) == 0)
313 fprintf (stderr, "Try `%s --help' for more information.\n",
318 /* ======================================================================== */
321 static char const* const help_msg[] = {
322 "Compress or uncompress FILEs (by default, compress FILES in-place).",
324 "Mandatory arguments to long options are mandatory for short options too.",
327 " -a, --ascii ascii text; convert end-of-line using local conventions",
329 " -c, --stdout write on standard output, keep original files unchanged",
330 " -d, --decompress decompress",
331 /* -e, --encrypt encrypt */
332 " -f, --force force overwrite of output file and compress links",
333 " -h, --help give this help",
334 /* -k, --pkzip force output in pkzip format */
335 " -l, --list list compressed file contents",
336 " -L, --license display software license",
338 " -m, --no-time do not save or restore the original modification time",
339 " -M, --time save or restore the original modification time",
341 " -n, --no-name do not save or restore the original name and time stamp",
342 " -N, --name save or restore the original name and time stamp",
343 " -q, --quiet suppress all warnings",
345 " -r, --recursive operate recursively on directories",
347 " -S, --suffix=SUF use suffix SUF on compressed files",
348 " -t, --test test compressed file integrity",
349 " -v, --verbose verbose mode",
350 " -V, --version display version number",
351 " -1, --fast compress faster",
352 " -9, --best compress better",
354 " -Z, --lzw produce output compatible with old compress",
355 " -b, --bits=BITS max number of bits per code (implies -Z)",
357 " --rsyncable Make rsync-friendly archive",
359 "With no FILE, or when FILE is -, read standard input.",
361 "Report bugs to <bug-gzip@gnu.org>.",
363 char const *const *p = help_msg;
365 printf ("Usage: %s [OPTION]... [FILE]...\n", program_name);
366 while (*p) printf ("%s\n", *p++);
369 /* ======================================================================== */
372 char const *const *p = license_msg;
374 printf ("%s %s\n", program_name, VERSION);
375 while (*p) printf ("%s\n", *p++);
378 /* ======================================================================== */
383 printf ("Written by Jean-loup Gailly.\n");
386 local void progerror (char const *string)
389 fprintf (stderr, "%s: ", program_name);
395 /* ======================================================================== */
396 int main (int argc, char **argv)
398 int file_count; /* number of files to process */
399 size_t proglen; /* length of program_name */
400 int optc; /* current option */
402 EXPAND(argc, argv); /* wild card expansion if necessary */
404 program_name = gzip_base_name (argv[0]);
405 proglen = strlen (program_name);
407 atexit (close_stdin);
409 /* Suppress .exe for MSDOS, OS/2 and VMS: */
410 if (4 < proglen && strequ (program_name + proglen - 4, ".exe"))
411 program_name[proglen - 4] = '\0';
413 /* Add options in GZIP environment variable if there is one */
414 env = add_envopt(&argc, &argv, OPTIONS_VAR);
415 if (env != NULL) args = argv;
418 # define GNU_STANDARD 1
421 /* For compatibility with old compress, use program name as an option.
422 * Unless you compile with -DGNU_STANDARD=0, this program will behave as
423 * gzip even if it is invoked under the name gunzip or zcat.
425 * Systems which do not support links can still use -d or -dc.
426 * Ignore an .exe extension for MSDOS, OS/2 and VMS.
428 if (strncmp (program_name, "un", 2) == 0 /* ungzip, uncompress */
429 || strncmp (program_name, "gun", 3) == 0) /* gunzip */
431 else if (strequ (program_name + 1, "cat") /* zcat, pcat, gcat */
432 || strequ (program_name, "gzcat")) /* gzcat */
433 decompress = to_stdout = 1;
437 z_len = strlen(z_suffix);
439 while ((optc = getopt_long (argc, argv, "ab:cdfhH?lLmMnNqrS:tvVZ123456789",
440 longopts, (int *)0)) != -1) {
445 maxbits = atoi(optarg);
446 for (; *optarg; optarg++)
447 if (! ('0' <= *optarg && *optarg <= '9'))
449 fprintf (stderr, "%s: -b operand is not an integer\n",
455 to_stdout = 1; break;
457 decompress = 1; break;
461 help(); do_exit(OK); break;
463 list = decompress = to_stdout = 1; break;
465 license(); do_exit(OK); break;
466 case 'm': /* undocumented, may change later */
468 case 'M': /* undocumented, may change later */
471 no_name = no_time = 1; break;
473 no_name = no_time = 0; break;
475 quiet = 1; verbose = 0; break;
478 fprintf (stderr, "%s: -r not supported on this system\n",
489 #ifdef NO_MULTIPLE_DOTS
490 if (*optarg == '.') optarg++;
492 z_len = strlen(optarg);
496 test = decompress = to_stdout = 1;
499 verbose++; quiet = 0; break;
501 version(); do_exit(OK); break;
506 fprintf(stderr, "%s: -Z not supported in this version\n",
511 case '1': case '2': case '3': case '4':
512 case '5': case '6': case '7': case '8': case '9':
516 /* Error message already emitted by getopt_long. */
519 } /* loop on all arguments */
521 /* By default, save name and timestamp on compression but do not
522 * restore them on decompression.
524 if (no_time < 0) no_time = decompress;
525 if (no_name < 0) no_name = decompress;
527 file_count = argc - optind;
531 if (ascii && !quiet) {
532 fprintf(stderr, "%s: option --ascii ignored on this system\n",
536 if ((z_len == 0 && !decompress) || z_len > MAX_SUFFIX) {
537 fprintf(stderr, "%s: incorrect suffix '%s'\n",
538 program_name, z_suffix);
541 if (do_lzw && !decompress) work = lzw;
543 /* Allocate all global buffers (for DYN_ALLOC option) */
544 ALLOC(uch, inbuf, INBUFSIZ +INBUF_EXTRA);
545 ALLOC(uch, outbuf, OUTBUFSIZ+OUTBUF_EXTRA);
546 ALLOC(ush, d_buf, DIST_BUFSIZE);
547 ALLOC(uch, window, 2L*WSIZE);
549 ALLOC(ush, tab_prefix, 1L<<BITS);
551 ALLOC(ush, tab_prefix0, 1L<<(BITS-1));
552 ALLOC(ush, tab_prefix1, 1L<<(BITS-1));
555 exiting_signal = quiet ? SIGPIPE : 0;
556 install_signal_handlers ();
558 /* And get to work */
559 if (file_count != 0) {
560 if (to_stdout && !test && !list && (!decompress || !ascii)) {
561 SET_BINARY_MODE(fileno(stdout));
563 while (optind < argc) {
564 treat_file(argv[optind++]);
566 } else { /* Standard input */
569 if (list && !quiet && file_count > 1) {
570 do_list(-1, -1); /* print totals */
573 return exit_code; /* just to avoid lint warning */
576 /* Return nonzero when at end of file on input. */
580 if (!decompress || last_member)
585 if (insize != INBUFSIZ || fill_inbuf (1) == EOF)
588 /* Unget the char that fill_inbuf got. */
595 /* ========================================================================
596 * Compress or decompress stdin
598 local void treat_stdin()
600 if (!force && !list &&
601 isatty(fileno((FILE *)(decompress ? stdin : stdout)))) {
602 /* Do not send compressed data to the terminal or read it from
603 * the terminal. We get here when user invoked the program
604 * without parameters, so be helpful. According to the GNU standards:
606 * If there is one behavior you think is most useful when the output
607 * is to a terminal, and another that you think is most useful when
608 * the output is a file or a pipe, then it is usually best to make
609 * the default behavior the one that is useful with output to a
610 * terminal, and have an option for the other behavior.
612 * Here we use the --force option to get the other behavior.
615 "%s: compressed data not %s a terminal. Use -f to force %scompression.\n",
616 program_name, decompress ? "read from" : "written to",
617 decompress ? "de" : "");
618 fprintf (stderr, "For help, type: %s -h\n", program_name);
622 if (decompress || !ascii) {
623 SET_BINARY_MODE(fileno(stdin));
625 if (!test && !list && (!decompress || !ascii)) {
626 SET_BINARY_MODE(fileno(stdout));
628 strcpy(ifname, "stdin");
629 strcpy(ofname, "stdout");
631 /* Get the file's time stamp and size. */
632 if (fstat (fileno (stdin), &istat) != 0)
634 progerror ("standard input");
637 ifile_size = S_ISREG (istat.st_mode) ? istat.st_size : -1;
638 time_stamp.tv_nsec = -1;
639 if (!no_time || list)
640 time_stamp = get_stat_mtime (&istat);
642 clear_bufs(); /* clear input and output buffers */
648 method = get_method(ifd);
650 do_exit(exit_code); /* error message already emitted */
654 do_list(ifd, method);
658 /* Actually do the compression/decompression. Loop over zipped members.
661 if ((*work)(fileno(stdin), fileno(stdout)) != OK) return;
666 method = get_method(ifd);
667 if (method < 0) return; /* error message already emitted */
668 bytes_out = 0; /* required for length check */
673 fprintf(stderr, " OK\n");
675 } else if (!decompress) {
676 display_ratio(bytes_in-(bytes_out-header_bytes), bytes_in, stderr);
677 fprintf(stderr, "\n");
678 #ifdef DISPLAY_STDIN_RATIO
680 display_ratio(bytes_out-(bytes_in-header_bytes), bytes_out,stderr);
681 fprintf(stderr, "\n");
687 /* ========================================================================
688 * Compress or decompress the given file
690 local void treat_file(iname)
693 /* Accept "-" as synonym for stdin */
694 if (strequ(iname, "-")) {
695 int cflag = to_stdout;
701 /* Check if the input file is present, set ifname and istat: */
702 ifd = open_input_file (iname, &istat);
706 /* If the input name is that of a directory, recurse or ignore: */
707 if (S_ISDIR(istat.st_mode)) {
710 treat_dir (ifd, iname);
711 /* Warning: ifname is now garbage */
716 WARN ((stderr, "%s: %s is a directory -- ignored\n",
717 program_name, ifname));
723 if (! S_ISREG (istat.st_mode))
726 "%s: %s is not a directory or a regular file - ignored\n",
727 program_name, ifname));
731 if (istat.st_mode & S_ISUID)
733 WARN ((stderr, "%s: %s is set-user-ID on execution - ignored\n",
734 program_name, ifname));
738 if (istat.st_mode & S_ISGID)
740 WARN ((stderr, "%s: %s is set-group-ID on execution - ignored\n",
741 program_name, ifname));
748 if (istat.st_mode & S_ISVTX)
751 "%s: %s has the sticky bit set - file ignored\n",
752 program_name, ifname));
756 if (2 <= istat.st_nlink)
758 WARN ((stderr, "%s: %s has %lu other link%c -- unchanged\n",
759 program_name, ifname,
760 (unsigned long int) istat.st_nlink - 1,
761 istat.st_nlink == 2 ? ' ' : 's'));
768 ifile_size = S_ISREG (istat.st_mode) ? istat.st_size : -1;
769 time_stamp.tv_nsec = -1;
770 if (!no_time || list)
771 time_stamp = get_stat_mtime (&istat);
773 /* Generate output file name. For -r and (-t or -l), skip files
774 * without a valid gzip suffix (check done in make_ofname).
776 if (to_stdout && !list && !test) {
777 strcpy(ofname, "stdout");
779 } else if (make_ofname() != OK) {
784 clear_bufs(); /* clear input and output buffers */
788 method = get_method(ifd); /* updates ofname if original given */
791 return; /* error message already emitted */
795 do_list(ifd, method);
796 if (close (ifd) != 0)
801 /* If compressing to a file, check if ofname is not ambiguous
802 * because the operating system truncates names. Otherwise, generate
803 * a new ofname and save the original name in the compressed file.
806 ofd = fileno(stdout);
807 /* Keep remove_ofname_fd negative. */
809 if (create_outfile() != OK) return;
811 if (!decompress && save_orig_name && !verbose && !quiet) {
812 fprintf(stderr, "%s: %s compressed to %s\n",
813 program_name, ifname, ofname);
816 /* Keep the name even if not truncated except with --no-name: */
817 if (!save_orig_name) save_orig_name = !no_name;
820 fprintf(stderr, "%s:\t", ifname);
823 /* Actually do the compression/decompression. Loop over zipped members.
826 if ((*work)(ifd, ofd) != OK) {
827 method = -1; /* force cleanup */
834 method = get_method(ifd);
835 if (method < 0) break; /* error message already emitted */
836 bytes_out = 0; /* required for length check */
839 if (close (ifd) != 0)
848 if (close (ofd) != 0)
851 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
852 remove_ofname_fd = -1;
853 unlink_errno = xunlink (ifname) == 0 ? 0 : errno;
854 sigprocmask (SIG_SETMASK, &oldset, NULL);
858 WARN ((stderr, "%s: ", program_name));
861 errno = unlink_errno;
869 remove_output_file ();
873 /* Display statistics */
876 fprintf(stderr, " OK");
877 } else if (decompress) {
878 display_ratio(bytes_out-(bytes_in-header_bytes), bytes_out,stderr);
880 display_ratio(bytes_in-(bytes_out-header_bytes), bytes_in, stderr);
882 if (!test && !to_stdout) {
883 fprintf(stderr, " -- replaced with %s", ofname);
885 fprintf(stderr, "\n");
889 /* ========================================================================
890 * Create the output file. Return OK or ERROR.
891 * Try several times if necessary to avoid truncating the z_suffix. For
892 * example, do not create a compressed file of name "1234567890123."
893 * Sets save_orig_name to true if the file name has been truncated.
894 * IN assertions: the input file has already been open (ifd is set) and
895 * ofname has already been updated if there was an original name.
896 * OUT assertions: ifd and ofd are closed in case of error.
898 local int create_outfile()
900 int name_shortened = 0;
901 int flags = (O_WRONLY | O_CREAT | O_EXCL
902 | (ascii && decompress ? 0 : O_BINARY));
909 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
910 remove_ofname_fd = ofd = OPEN (ofname, flags, RW_USER);
912 sigprocmask (SIG_SETMASK, &oldset, NULL);
921 shorten_name (ofname);
927 if (check_ofname () != OK)
941 if (name_shortened && decompress)
943 /* name might be too long if an original name was saved */
944 WARN ((stderr, "%s: %s: warning, name truncated\n",
945 program_name, ofname));
951 /* ========================================================================
952 * Return a pointer to the 'z' suffix of a file name, or NULL. For all
953 * systems, ".gz", ".z", ".Z", ".taz", ".tgz", "-gz", "-z" and "_z" are
954 * accepted suffixes, in addition to the value of the --suffix option.
955 * ".tgz" is a useful convention for tar.z files on systems limited
956 * to 3 characters extensions. On such systems, ".?z" and ".??z" are
957 * also accepted suffixes. For Unix, we do not want to accept any
958 * .??z suffix as indicating a compressed file; some people use .xyz
959 * to denote volume data.
960 * On systems allowing multiple versions of the same file (such as VMS),
961 * this function removes any version suffix in the given name.
963 local char *get_suffix(name)
967 char suffix[MAX_SUFFIX+3]; /* last chars of name, forced to lower case */
968 static char const *known_suffixes[] =
969 {NULL, ".gz", ".z", ".taz", ".tgz", "-gz", "-z", "_z",
974 char const **suf = known_suffixes;
977 if (strequ(z_suffix, "z")) suf++; /* check long suffixes first */
980 /* strip a version number from the file name */
982 char *v = strrchr(name, SUFFIX_SEP);
983 if (v != NULL) *v = '\0';
987 if (nlen <= MAX_SUFFIX+2) {
988 strcpy(suffix, name);
990 strcpy(suffix, name+nlen-MAX_SUFFIX-2);
993 slen = strlen(suffix);
995 int s = strlen(*suf);
996 if (slen > s && suffix[slen-s-1] != PATH_SEP
997 && strequ(suffix + slen - s, *suf)) {
1000 } while (*++suf != NULL);
1006 /* Open file NAME with the given flags and mode and store its status
1007 into *ST. Return a file descriptor to the newly opened file, or -1
1008 (setting errno) on failure. */
1010 open_and_stat (char *name, int flags, mode_t mode, struct stat *st)
1014 /* Refuse to follow symbolic links unless -c or -f. */
1015 if (!to_stdout && !force)
1017 if (HAVE_WORKING_O_NOFOLLOW)
1018 flags |= O_NOFOLLOW;
1021 #if HAVE_LSTAT || defined lstat
1022 if (lstat (name, st) != 0)
1024 else if (S_ISLNK (st->st_mode))
1033 fd = OPEN (name, flags, mode);
1034 if (0 <= fd && fstat (fd, st) != 0)
1045 /* ========================================================================
1046 * Set ifname to the input file name (with a suffix appended if necessary)
1047 * and istat to its stats. For decompression, if no file exists with the
1048 * original name, try adding successively z_suffix, .gz, .z, -z and .Z.
1049 * For MSDOS, we try only z_suffix and z.
1050 * Return an open file descriptor or -1.
1053 open_input_file (iname, sbuf)
1057 int ilen; /* strlen(ifname) */
1058 int z_suffix_errno = 0;
1059 static char const *suffixes[] = {NULL, ".gz", ".z", "-z", ".Z", NULL};
1060 char const **suf = suffixes;
1062 #ifdef NO_MULTIPLE_DOTS
1063 char *dot; /* pointer to ifname extension, or NULL */
1066 int open_flags = (O_RDONLY | O_NONBLOCK | O_NOCTTY
1067 | (ascii && !decompress ? 0 : O_BINARY));
1071 if (sizeof ifname - 1 <= strlen (iname))
1074 strcpy(ifname, iname);
1076 /* If input file exists, return OK. */
1077 fd = open_and_stat (ifname, open_flags, RW_USER, sbuf);
1081 if (!decompress || errno != ENOENT) {
1085 /* file.ext doesn't exist, try adding a suffix (after removing any
1086 * version number for VMS).
1088 s = get_suffix(ifname);
1090 progerror(ifname); /* ifname already has z suffix and does not exist */
1093 #ifdef NO_MULTIPLE_DOTS
1094 dot = strrchr(ifname, '.');
1096 strcat(ifname, ".");
1097 dot = strrchr(ifname, '.');
1100 ilen = strlen(ifname);
1101 if (strequ(z_suffix, ".gz")) suf++;
1103 /* Search for all suffixes */
1105 char const *s0 = s = *suf;
1106 strcpy (ifname, iname);
1107 #ifdef NO_MULTIPLE_DOTS
1109 if (*dot == '\0') strcpy (dot, ".");
1111 #ifdef MAX_EXT_CHARS
1112 if (MAX_EXT_CHARS < strlen (s) + strlen (dot + 1))
1113 dot[MAX_EXT_CHARS + 1 - strlen (s)] = '\0';
1115 if (sizeof ifname <= ilen + strlen (s))
1118 fd = open_and_stat (ifname, open_flags, RW_USER, sbuf);
1121 if (errno != ENOENT)
1126 if (strequ (s0, z_suffix))
1127 z_suffix_errno = errno;
1128 } while (*++suf != NULL);
1130 /* No suffix found, complain using z_suffix: */
1131 strcpy(ifname, iname);
1132 #ifdef NO_MULTIPLE_DOTS
1133 if (*dot == '\0') strcpy(dot, ".");
1135 #ifdef MAX_EXT_CHARS
1136 if (MAX_EXT_CHARS < z_len + strlen (dot + 1))
1137 dot[MAX_EXT_CHARS + 1 - z_len] = '\0';
1139 strcat(ifname, z_suffix);
1140 errno = z_suffix_errno;
1145 fprintf (stderr, "%s: %s: file name too long\n", program_name, iname);
1150 /* ========================================================================
1151 * Generate ofname given ifname. Return OK, or WARNING if file must be skipped.
1152 * Sets save_orig_name to true if the file name has been truncated.
1154 local int make_ofname()
1156 char *suff; /* ofname z suffix */
1158 strcpy(ofname, ifname);
1159 /* strip a version number if any and get the gzip suffix if present: */
1160 suff = get_suffix(ofname);
1164 /* With -t or -l, try all files (even without .gz suffix)
1165 * except with -r (behave as with just -dr).
1167 if (!recursive && (list || test)) return OK;
1169 /* Avoid annoying messages with -r */
1170 if (verbose || (!recursive && !quiet)) {
1171 WARN((stderr,"%s: %s: unknown suffix -- ignored\n",
1172 program_name, ifname));
1176 /* Make a special case for .tgz and .taz: */
1178 if (strequ(suff, ".tgz") || strequ(suff, ".taz")) {
1179 strcpy(suff, ".tar");
1181 *suff = '\0'; /* strip the z suffix */
1183 /* ofname might be changed later if infile contains an original name */
1185 } else if (suff && ! force) {
1186 /* Avoid annoying messages with -r (see treat_dir()) */
1187 if (verbose || (!recursive && !quiet)) {
1188 /* Don't use WARN, as it affects exit status. */
1189 fprintf (stderr, "%s: %s already has %s suffix -- unchanged\n",
1190 program_name, ifname, suff);
1196 #ifdef NO_MULTIPLE_DOTS
1197 suff = strrchr(ofname, '.');
1199 if (sizeof ofname <= strlen (ofname) + 1)
1201 strcat(ofname, ".");
1202 # ifdef MAX_EXT_CHARS
1203 if (strequ(z_suffix, "z")) {
1204 if (sizeof ofname <= strlen (ofname) + 2)
1206 strcat(ofname, "gz"); /* enough room */
1209 /* On the Atari and some versions of MSDOS,
1210 * ENAMETOOLONG does not work correctly. So we
1211 * must truncate here.
1213 } else if (strlen(suff)-1 + z_len > MAX_SUFFIX) {
1214 suff[MAX_SUFFIX+1-z_len] = '\0';
1218 #endif /* NO_MULTIPLE_DOTS */
1219 if (sizeof ofname <= strlen (ofname) + z_len)
1221 strcat(ofname, z_suffix);
1223 } /* decompress ? */
1227 WARN ((stderr, "%s: %s: file name too long\n", program_name, ifname));
1232 /* ========================================================================
1233 * Check the magic number of the input file and update ofname if an
1234 * original name was given and to_stdout is not set.
1235 * Return the compression method, -1 for error, -2 for warning.
1236 * Set inptr to the offset of the next byte to be processed.
1237 * Updates time_stamp if there is one and --no-time is not used.
1238 * This function may be called repeatedly for an input file consisting
1239 * of several contiguous gzip'ed members.
1240 * IN assertions: there is at least one remaining compressed member.
1241 * If the member is a zip file, it must be the only one.
1243 local int get_method(in)
1244 int in; /* input file descriptor */
1246 uch flags; /* compression flags */
1247 char magic[2]; /* magic header */
1248 int imagic1; /* like magic[1], but can represent EOF */
1249 ulg stamp; /* time stamp */
1251 /* If --force and --stdout, zcat == cat, so do not complain about
1252 * premature end of file: use try_byte instead of get_byte.
1254 if (force && to_stdout) {
1255 magic[0] = (char)try_byte();
1256 imagic1 = try_byte ();
1257 magic[1] = (char) imagic1;
1258 /* If try_byte returned EOF, magic[1] == (char) EOF. */
1260 magic[0] = (char)get_byte();
1262 magic[1] = (char)get_byte();
1263 imagic1 = 0; /* avoid lint warning */
1265 imagic1 = try_byte ();
1266 magic[1] = (char) imagic1;
1269 method = -1; /* unknown yet */
1270 part_nb++; /* number of parts in gzip file */
1272 last_member = RECORD_IO;
1273 /* assume multiple members in gzip file except for record oriented I/O */
1275 if (memcmp(magic, GZIP_MAGIC, 2) == 0
1276 || memcmp(magic, OLD_GZIP_MAGIC, 2) == 0) {
1278 method = (int)get_byte();
1279 if (method != DEFLATED) {
1281 "%s: %s: unknown method %d -- not supported\n",
1282 program_name, ifname, method);
1287 flags = (uch)get_byte();
1289 if ((flags & ENCRYPTED) != 0) {
1291 "%s: %s is encrypted -- not supported\n",
1292 program_name, ifname);
1296 if ((flags & CONTINUATION) != 0) {
1298 "%s: %s is a multi-part gzip file -- not supported\n",
1299 program_name, ifname);
1301 if (force <= 1) return -1;
1303 if ((flags & RESERVED) != 0) {
1305 "%s: %s has flags 0x%x -- not supported\n",
1306 program_name, ifname, flags);
1308 if (force <= 1) return -1;
1310 stamp = (ulg)get_byte();
1311 stamp |= ((ulg)get_byte()) << 8;
1312 stamp |= ((ulg)get_byte()) << 16;
1313 stamp |= ((ulg)get_byte()) << 24;
1314 if (stamp != 0 && !no_time)
1316 time_stamp.tv_sec = stamp;
1317 time_stamp.tv_nsec = 0;
1320 (void)get_byte(); /* Ignore extra flags for the moment */
1321 (void)get_byte(); /* Ignore OS type for the moment */
1323 if ((flags & CONTINUATION) != 0) {
1324 unsigned part = (unsigned)get_byte();
1325 part |= ((unsigned)get_byte())<<8;
1327 fprintf(stderr,"%s: %s: part number %u\n",
1328 program_name, ifname, part);
1331 if ((flags & EXTRA_FIELD) != 0) {
1332 unsigned len = (unsigned)get_byte();
1333 len |= ((unsigned)get_byte())<<8;
1335 fprintf(stderr,"%s: %s: extra field of %u bytes ignored\n",
1336 program_name, ifname, len);
1338 while (len--) (void)get_byte();
1341 /* Get original file name if it was truncated */
1342 if ((flags & ORIG_NAME) != 0) {
1343 if (no_name || (to_stdout && !list) || part_nb > 1) {
1344 /* Discard the old name */
1345 char c; /* dummy used for NeXTstep 3.0 cc optimizer bug */
1346 do {c=get_byte();} while (c != 0);
1348 /* Copy the base name. Keep a directory prefix intact. */
1349 char *p = gzip_base_name (ofname);
1352 *p = (char)get_char();
1353 if (*p++ == '\0') break;
1354 if (p >= ofname+sizeof(ofname)) {
1355 gzip_error ("corrupted input -- file name too large");
1358 p = gzip_base_name (base);
1359 memmove (base, p, strlen (p) + 1);
1360 /* If necessary, adapt the name to local OS conventions: */
1362 MAKE_LEGAL_NAME(base);
1363 if (base) list=0; /* avoid warning about unused variable */
1365 } /* no_name || to_stdout */
1368 /* Discard file comment if any */
1369 if ((flags & COMMENT) != 0) {
1370 while (get_char() != 0) /* null */ ;
1373 header_bytes = inptr + 2*sizeof(long); /* include crc and size */
1376 } else if (memcmp(magic, PKZIP_MAGIC, 2) == 0 && inptr == 2
1377 && memcmp((char*)inbuf, PKZIP_MAGIC, 4) == 0) {
1378 /* To simplify the code, we support a zip file when alone only.
1379 * We are thus guaranteed that the entire local header fits in inbuf.
1383 if (check_zipfile(in) != OK) return -1;
1384 /* check_zipfile may get ofname from the local header */
1387 } else if (memcmp(magic, PACK_MAGIC, 2) == 0) {
1391 } else if (memcmp(magic, LZW_MAGIC, 2) == 0) {
1393 method = COMPRESSED;
1396 } else if (memcmp(magic, LZH_MAGIC, 2) == 0) {
1401 } else if (force && to_stdout && !list) { /* pass input unchanged */
1407 if (method >= 0) return method;
1410 fprintf (stderr, "\n%s: %s: not in gzip format\n",
1411 program_name, ifname);
1418 for (inbyte = imagic1; inbyte == 0; inbyte = try_byte ())
1423 WARN ((stderr, "\n%s: %s: decompression OK, trailing zero bytes ignored\n",
1424 program_name, ifname));
1429 WARN((stderr, "\n%s: %s: decompression OK, trailing garbage ignored\n",
1430 program_name, ifname));
1435 /* ========================================================================
1436 * Display the characteristics of the compressed file.
1437 * If the given method is < 0, display the accumulated totals.
1438 * IN assertions: time_stamp, header_bytes and ifile_size are initialized.
1440 local void do_list(ifd, method)
1441 int ifd; /* input file descriptor */
1442 int method; /* compression method */
1444 ulg crc; /* original crc */
1445 static int first_time = 1;
1446 static char const *const methods[MAX_METHODS] = {
1451 "", "", "", "", /* 4 to 7 reserved */
1453 int positive_off_t_width = 1;
1456 for (o = OFF_T_MAX; 9 < o; o /= 10) {
1457 positive_off_t_width++;
1460 if (first_time && method >= 0) {
1463 printf("method crc date time ");
1466 printf("%*.*s %*.*s ratio uncompressed_name\n",
1467 positive_off_t_width, positive_off_t_width, "compressed",
1468 positive_off_t_width, positive_off_t_width, "uncompressed");
1470 } else if (method < 0) {
1471 if (total_in <= 0 || total_out <= 0) return;
1475 if (verbose || !quiet) {
1476 fprint_off(stdout, total_in, positive_off_t_width);
1478 fprint_off(stdout, total_out, positive_off_t_width);
1481 display_ratio(total_out-(total_in-header_bytes), total_out, stdout);
1482 /* header_bytes is not meaningful but used to ensure the same
1483 * ratio if there is a single file.
1485 printf(" (totals)\n");
1488 crc = (ulg)~0; /* unknown */
1490 bytes_in = ifile_size;
1493 if (method == DEFLATED && !last_member) {
1494 /* Get the crc and uncompressed size for gzip'ed (not zip'ed) files.
1495 * If the lseek fails, we could use read() to get to the end, but
1496 * --list is used to get quick results.
1497 * Use "gunzip < foo.gz | wc -c" to get the uncompressed size if
1498 * you are not concerned about speed.
1500 bytes_in = lseek(ifd, (off_t)(-8), SEEK_END);
1501 if (bytes_in != -1L) {
1504 if (read(ifd, (char*)buf, sizeof(buf)) != sizeof(buf)) {
1508 bytes_out = LG(buf+4);
1511 #endif /* RECORD_IO */
1514 struct tm *tm = localtime (&time_stamp.tv_sec);
1515 printf ("%5s %08lx ", methods[method], crc);
1517 printf ("%s%3d %02d:%02d ",
1518 ("Jan\0Feb\0Mar\0Apr\0May\0Jun\0Jul\0Aug\0Sep\0Oct\0Nov\0Dec"
1520 tm->tm_mday, tm->tm_hour, tm->tm_min);
1522 printf ("??? ?? ??:?? ");
1524 fprint_off(stdout, bytes_in, positive_off_t_width);
1526 fprint_off(stdout, bytes_out, positive_off_t_width);
1528 if (bytes_in == -1L) {
1530 bytes_in = bytes_out = header_bytes = 0;
1531 } else if (total_in >= 0) {
1532 total_in += bytes_in;
1534 if (bytes_out == -1L) {
1536 bytes_in = bytes_out = header_bytes = 0;
1537 } else if (total_out >= 0) {
1538 total_out += bytes_out;
1540 display_ratio(bytes_out-(bytes_in-header_bytes), bytes_out, stdout);
1541 printf(" %s\n", ofname);
1544 /* ========================================================================
1545 * Shorten the given name by one character, or replace a .tar extension
1546 * with .tgz. Truncate the last part of the name which is longer than
1547 * MIN_PART characters: 1234.678.012.gz -> 123.678.012.gz. If the name
1548 * has only parts shorter than MIN_PART truncate the longest part.
1549 * For decompression, just remove the last character of the name.
1551 * IN assertion: for compression, the suffix of the given name is z_suffix.
1553 local void shorten_name(name)
1556 int len; /* length of name without z_suffix */
1557 char *trunc = NULL; /* character to be truncated */
1558 int plen; /* current part length */
1559 int min_part = MIN_PART; /* current minimum part length */
1565 gzip_error ("name too short");
1569 p = get_suffix(name);
1571 gzip_error ("can't recover suffix\n");
1575 /* compress 1234567890.tar to 1234567890.tgz */
1576 if (len > 4 && strequ(p-4, ".tar")) {
1577 strcpy(p-4, ".tgz");
1580 /* Try keeping short extensions intact:
1581 * 1234.678.012.gz -> 123.678.012.gz
1584 p = strrchr(name, PATH_SEP);
1587 plen = strcspn(p, PART_SEP);
1589 if (plen > min_part) trunc = p-1;
1592 } while (trunc == NULL && --min_part != 0);
1594 if (trunc != NULL) {
1596 trunc[0] = trunc[1];
1600 trunc = strrchr(name, PART_SEP[0]);
1602 gzip_error ("internal error in shorten_name");
1603 if (trunc[1] == '\0') trunc--; /* force truncation */
1605 strcpy(trunc, z_suffix);
1608 /* ========================================================================
1609 * The compressed file already exists, so ask for confirmation.
1610 * Return ERROR if the file must be skipped.
1612 local int check_ofname()
1614 /* Ask permission to overwrite the existing file */
1617 fprintf (stderr, "%s: %s already exists;", program_name, ofname);
1618 if (foreground && isatty(fileno(stdin))) {
1619 fprintf(stderr, " do you wish to overwrite (y or n)? ");
1624 fprintf(stderr, "\tnot overwritten\n");
1625 if (exit_code == OK) exit_code = WARNING;
1629 if (xunlink (ofname)) {
1637 /* ========================================================================
1638 * Copy modes, times, ownership from input file to output file.
1639 * IN assertion: to_stdout is false.
1641 local void copy_stat(ifstat)
1642 struct stat *ifstat;
1644 mode_t mode = ifstat->st_mode & S_IRWXUGO;
1648 struct timespec timespec[2];
1649 timespec[0] = get_stat_atime (ifstat);
1650 timespec[1] = get_stat_mtime (ifstat);
1652 if (decompress && 0 <= time_stamp.tv_nsec
1653 && ! (timespec[1].tv_sec == time_stamp.tv_sec
1654 && timespec[1].tv_nsec == time_stamp.tv_nsec))
1656 timespec[1] = time_stamp;
1658 fprintf(stderr, "%s: time stamp restored\n", ofname);
1662 if (gl_futimens (ofd, ofname, timespec) != 0)
1665 WARN ((stderr, "%s: ", program_name));
1675 /* Copy ownership */
1677 ignore_value (fchown (ofd, ifstat->st_uid, ifstat->st_gid));
1679 ignore_value (chown (ofname, ifstat->st_uid, ifstat->st_gid));
1683 /* Copy the protection modes */
1685 r = fchmod (ofd, mode);
1687 r = chmod (ofname, mode);
1691 WARN ((stderr, "%s: ", program_name));
1701 /* ========================================================================
1702 * Recurse through the given directory. This code is taken from ncompress.
1704 local void treat_dir (fd, dir)
1710 char nbuf[MAX_PATH_LEN];
1713 dirp = fdopendir (fd);
1721 ** WARNING: the following algorithm could occasionally cause
1722 ** compress to produce error warnings of the form "<filename>.gz
1723 ** already has .gz suffix - ignored". This occurs when the
1724 ** .gz output file is inserted into the directory below
1725 ** readdir's current pointer.
1726 ** These warnings are harmless but annoying, so they are suppressed
1727 ** with option -r (except when -v is on). An alternative
1728 ** to allowing this would be to store the entire directory
1729 ** list in memory, then compress the entries in the stored
1730 ** list. Given the depth-first recursive algorithm used here,
1731 ** this could use up a tremendous amount of memory. I don't
1732 ** think it's worth it. -- Dave Mack
1733 ** (An other alternative might be two passes to avoid depth-first.)
1736 while ((errno = 0, dp = readdir(dirp)) != NULL) {
1738 if (strequ(dp->d_name,".") || strequ(dp->d_name,"..")) {
1742 if (len + _D_EXACT_NAMLEN (dp) + 1 < MAX_PATH_LEN - 1) {
1744 if (len != 0 /* dir = "" means current dir on Amiga */
1746 && dir[len-1] != PATH_SEP2
1749 && dir[len-1] != PATH_SEP3
1752 nbuf[len++] = PATH_SEP;
1754 strcpy(nbuf+len, dp->d_name);
1757 fprintf(stderr,"%s: %s/%s: pathname too long\n",
1758 program_name, dir, dp->d_name);
1764 if (CLOSEDIR(dirp) != 0)
1767 #endif /* ! NO_DIR */
1769 /* Make sure signals get handled properly. */
1772 install_signal_handlers ()
1774 int nsigs = sizeof handled_sig / sizeof handled_sig[0];
1778 struct sigaction act;
1780 sigemptyset (&caught_signals);
1781 for (i = 0; i < nsigs; i++)
1783 sigaction (handled_sig[i], NULL, &act);
1784 if (act.sa_handler != SIG_IGN)
1785 sigaddset (&caught_signals, handled_sig[i]);
1788 act.sa_handler = abort_gzip_signal;
1789 act.sa_mask = caught_signals;
1792 for (i = 0; i < nsigs; i++)
1793 if (sigismember (&caught_signals, handled_sig[i]))
1797 sigaction (handled_sig[i], &act, NULL);
1800 for (i = 0; i < nsigs; i++)
1801 if (signal (handled_sig[i], SIG_IGN) != SIG_IGN)
1805 signal (handled_sig[i], abort_gzip_signal);
1806 siginterrupt (handled_sig[i], 1);
1811 /* ========================================================================
1812 * Free all dynamically allocated variables and exit with the given code.
1814 local void do_exit(exitcode)
1817 static int in_exit = 0;
1819 if (in_exit) exit(exitcode);
1838 /* ========================================================================
1839 * Close and unlink the output file.
1842 remove_output_file ()
1847 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1848 fd = remove_ofname_fd;
1851 remove_ofname_fd = -1;
1855 sigprocmask (SIG_SETMASK, &oldset, NULL);
1858 /* ========================================================================
1864 remove_output_file ();
1868 /* ========================================================================
1872 abort_gzip_signal (sig)
1876 signal (sig, SIG_IGN);
1877 remove_output_file ();
1878 if (sig == exiting_signal)
1880 signal (sig, SIG_DFL);