CMake/Utilities/cmlibarchive/tar/read.c

/*-
 * Copyright (c) 2003-2007 Tim Kientzle
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "bsdtar_platform.h"
__FBSDID("$FreeBSD: src/usr.bin/tar/read.c,v 1.40 2008/08/21 06:41:14 kientzle Exp $");

#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif
#ifdef HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif

#ifdef HAVE_ERRNO_H
#include <errno.h>
#endif
#ifdef HAVE_GRP_H
#include <grp.h>
#endif
#ifdef HAVE_LIMITS_H
#include <limits.h>
#endif
#ifdef HAVE_PWD_H
#include <pwd.h>
#endif
#include <stdio.h>
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#ifdef HAVE_TIME_H
#include <time.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#include "bsdtar.h"
#include "err.h"

struct progress_data {
    struct bsdtar *bsdtar;
    struct archive *archive;
    struct archive_entry *entry;
};

static void list_item_verbose(struct bsdtar *, FILE *,
            struct archive_entry *);
static void read_archive(struct bsdtar *bsdtar, char mode);

void
tar_mode_t(struct bsdtar *bsdtar)
{
    read_archive(bsdtar, 't');
    if (lafe_unmatched_inclusions_warn(bsdtar->matching, "Not found in archive") != 0)
        bsdtar->return_value = 1;
}

void
tar_mode_x(struct bsdtar *bsdtar)
{
    read_archive(bsdtar, 'x');

    if (lafe_unmatched_inclusions_warn(bsdtar->matching, "Not found in archive") != 0)
        bsdtar->return_value = 1;
}

static void
progress_func(void *cookie)
{
    struct progress_data *progress_data = cookie;
    struct bsdtar *bsdtar = progress_data->bsdtar;
    struct archive *a = progress_data->archive;
    struct archive_entry *entry = progress_data->entry;
    uintmax_t comp, uncomp;

    if (!need_report())
        return;

    if (bsdtar->verbose)
        fprintf(stderr, "\n");
    if (a != NULL) {
        comp = archive_position_compressed(a);
        uncomp = archive_position_uncompressed(a);
        fprintf(stderr,
            "In: %ju bytes, compression %d%%;",
            comp, (int)((uncomp - comp) * 100 / uncomp));
        fprintf(stderr, "  Out: %d files, %ju bytes\n",
            archive_file_count(a), uncomp);
    }
    if (entry != NULL) {
        safe_fprintf(stderr, "Current: %s (%ju bytes)",
            archive_entry_pathname(entry),
            (uintmax_t)archive_entry_size(entry));
        fprintf(stderr, "\n");
    }
}

/*
 * Handle 'x' and 't' modes.
 */
static void
read_archive(struct bsdtar *bsdtar, char mode)
{
    struct progress_data    progress_data;
    FILE             *out;
    struct archive       *a;
    struct archive_entry     *entry;
    const struct stat    *st;
    int           r;

    while (*bsdtar->argv) {
        lafe_include(&bsdtar->matching, *bsdtar->argv);
        bsdtar->argv++;
    }

    if (bsdtar->names_from_file != NULL)
        lafe_include_from_file(&bsdtar->matching,
            bsdtar->names_from_file, bsdtar->option_null);

    a = archive_read_new();
    if (bsdtar->compress_program != NULL)
        archive_read_support_compression_program(a, bsdtar->compress_program);
    else
        archive_read_support_compression_all(a);
    archive_read_support_format_all(a);
    if (ARCHIVE_OK != archive_read_set_options(a, bsdtar->option_options))
        lafe_errc(1, 0, archive_error_string(a));
    if (archive_read_open_file(a, bsdtar->filename,
        bsdtar->bytes_per_block != 0 ? bsdtar->bytes_per_block :
        DEFAULT_BYTES_PER_BLOCK))
        lafe_errc(1, 0, "Error opening archive: %s",
            archive_error_string(a));

    do_chdir(bsdtar);

    if (mode == 'x') {
        /* Set an extract callback so that we can handle SIGINFO. */
        progress_data.bsdtar = bsdtar;
        progress_data.archive = a;
        archive_read_extract_set_progress_callback(a, progress_func,
            &progress_data);
    }

    if (mode == 'x' && bsdtar->option_chroot) {
#if HAVE_CHROOT
        if (chroot(".") != 0)
            lafe_errc(1, errno, "Can't chroot to \".\"");
#else
        lafe_errc(1, 0,
            "chroot isn't supported on this platform");
#endif
    }

    for (;;) {
        /* Support --fast-read option */
        if (bsdtar->option_fast_read &&
            lafe_unmatched_inclusions(bsdtar->matching) == 0)
            break;

        r = archive_read_next_header(a, &entry);
        progress_data.entry = entry;
        if (r == ARCHIVE_EOF)
            break;
        if (r < ARCHIVE_OK)
            lafe_warnc(0, "%s", archive_error_string(a));
        if (r <= ARCHIVE_WARN)
            bsdtar->return_value = 1;
        if (r == ARCHIVE_RETRY) {
            /* Retryable error: try again */
            lafe_warnc(0, "Retrying...");
            continue;
        }
        if (r == ARCHIVE_FATAL)
            break;

        if (bsdtar->option_numeric_owner) {
            archive_entry_set_uname(entry, NULL);
            archive_entry_set_gname(entry, NULL);
        }

        /*
         * Exclude entries that are too old.
         */
        st = archive_entry_stat(entry);
        if (bsdtar->newer_ctime_sec > 0) {
            if (st->st_ctime < bsdtar->newer_ctime_sec)
                continue; /* Too old, skip it. */
            if (st->st_ctime == bsdtar->newer_ctime_sec
                && ARCHIVE_STAT_CTIME_NANOS(st)
                <= bsdtar->newer_ctime_nsec)
                continue; /* Too old, skip it. */
        }
        if (bsdtar->newer_mtime_sec > 0) {
            if (st->st_mtime < bsdtar->newer_mtime_sec)
                continue; /* Too old, skip it. */
            if (st->st_mtime == bsdtar->newer_mtime_sec
                && ARCHIVE_STAT_MTIME_NANOS(st)
                <= bsdtar->newer_mtime_nsec)
                continue; /* Too old, skip it. */
        }

        /*
         * Note that pattern exclusions are checked before
         * pathname rewrites are handled.  This gives more
         * control over exclusions, since rewrites always lose
         * information.  (For example, consider a rewrite
         * s/foo[0-9]/foo/.  If we check exclusions after the
         * rewrite, there would be no way to exclude foo1/bar
         * while allowing foo2/bar.)
         */
        if (lafe_excluded(bsdtar->matching, archive_entry_pathname(entry)))
            continue; /* Excluded by a pattern test. */

        if (mode == 't') {
            /* Perversely, gtar uses -O to mean "send to stderr"
             * when used with -t. */
            out = bsdtar->option_stdout ? stderr : stdout;

            /*
             * TODO: Provide some reasonable way to
             * preview rewrites.  gtar always displays
             * the unedited path in -t output, which means
             * you cannot easily preview rewrites.
             */
            if (bsdtar->verbose < 2)
                safe_fprintf(out, "%s",
                    archive_entry_pathname(entry));
            else
                list_item_verbose(bsdtar, out, entry);
            fflush(out);
            r = archive_read_data_skip(a);
            if (r == ARCHIVE_WARN) {
                fprintf(out, "\n");
                lafe_warnc(0, "%s",
                    archive_error_string(a));
            }
            if (r == ARCHIVE_RETRY) {
                fprintf(out, "\n");
                lafe_warnc(0, "%s",
                    archive_error_string(a));
            }
            if (r == ARCHIVE_FATAL) {
                fprintf(out, "\n");
                lafe_warnc(0, "%s",
                    archive_error_string(a));
                bsdtar->return_value = 1;
                break;
            }
            fprintf(out, "\n");
        } else {
            /* Note: some rewrite failures prevent extraction. */
            if (edit_pathname(bsdtar, entry))
                continue; /* Excluded by a rewrite failure. */

            if (bsdtar->option_interactive &&
                !yes("extract '%s'", archive_entry_pathname(entry)))
                continue;

            /*
             * Format here is from SUSv2, including the
             * deferred '\n'.
             */
            if (bsdtar->verbose) {
                safe_fprintf(stderr, "x %s",
                    archive_entry_pathname(entry));
                fflush(stderr);
            }

            // TODO siginfo_printinfo(bsdtar, 0);

            if (bsdtar->option_stdout)
                r = archive_read_data_into_fd(a, 1);
            else
                r = archive_read_extract(a, entry,
                    bsdtar->extract_flags);
            if (r != ARCHIVE_OK) {
                if (!bsdtar->verbose)
                    safe_fprintf(stderr, "%s",
                        archive_entry_pathname(entry));
                safe_fprintf(stderr, ": %s",
                    archive_error_string(a));
                if (!bsdtar->verbose)
                    fprintf(stderr, "\n");
                bsdtar->return_value = 1;
            }
            if (bsdtar->verbose)
                fprintf(stderr, "\n");
            if (r == ARCHIVE_FATAL)
                break;
        }
    }


    r = archive_read_close(a);
    if (r != ARCHIVE_OK)
        lafe_warnc(0, "%s", archive_error_string(a));
    if (r <= ARCHIVE_WARN)
        bsdtar->return_value = 1;

    if (bsdtar->verbose > 2)
        fprintf(stdout, "Archive Format: %s,  Compression: %s\n",
            archive_format_name(a), archive_compression_name(a));

    archive_read_finish(a);
}


/*
 * Display information about the current file.
 *
 * The format here roughly duplicates the output of 'ls -l'.
 * This is based on SUSv2, where 'tar tv' is documented as
 * listing additional information in an "unspecified format,"
 * and 'pax -l' is documented as using the same format as 'ls -l'.
 */
static void
list_item_verbose(struct bsdtar *bsdtar, FILE *out, struct archive_entry *entry)
{
    char             tmp[100];
    size_t           w;
    const char      *p;
    const char      *fmt;
    time_t           tim;
    static time_t        now;

    /*
     * We avoid collecting the entire list in memory at once by
     * listing things as we see them.  However, that also means we can't
     * just pre-compute the field widths.  Instead, we start with guesses
     * and just widen them as necessary.  These numbers are completely
     * arbitrary.
     */
    if (!bsdtar->u_width) {
        bsdtar->u_width = 6;
        bsdtar->gs_width = 13;
    }
    if (!now)
        time(&now);
    fprintf(out, "%s %d ",
        archive_entry_strmode(entry),
        archive_entry_nlink(entry));

    /* Use uname if it's present, else uid. */
    p = archive_entry_uname(entry);
    if ((p == NULL) || (*p == '\0')) {
        sprintf(tmp, "%lu ",
            (unsigned long)archive_entry_uid(entry));
        p = tmp;
    }
    w = strlen(p);
    if (w > bsdtar->u_width)
        bsdtar->u_width = w;
    fprintf(out, "%-*s ", (int)bsdtar->u_width, p);

    /* Use gname if it's present, else gid. */
    p = archive_entry_gname(entry);
    if (p != NULL && p[0] != '\0') {
        fprintf(out, "%s", p);
        w = strlen(p);
    } else {
        sprintf(tmp, "%lu",
            (unsigned long)archive_entry_gid(entry));
        w = strlen(tmp);
        fprintf(out, "%s", tmp);
    }

    /*
     * Print device number or file size, right-aligned so as to make
     * total width of group and devnum/filesize fields be gs_width.
     * If gs_width is too small, grow it.
     */
    if (archive_entry_filetype(entry) == AE_IFCHR
        || archive_entry_filetype(entry) == AE_IFBLK) {
        sprintf(tmp, "%lu,%lu",
            (unsigned long)archive_entry_rdevmajor(entry),
            (unsigned long)archive_entry_rdevminor(entry));
    } else {
        /*
         * Note the use of platform-dependent macros to format
         * the filesize here.  We need the format string and the
         * corresponding type for the cast.
         */
        sprintf(tmp, BSDTAR_FILESIZE_PRINTF,
            (BSDTAR_FILESIZE_TYPE)archive_entry_size(entry));
    }
    if (w + strlen(tmp) >= bsdtar->gs_width)
        bsdtar->gs_width = w+strlen(tmp)+1;
    fprintf(out, "%*s", (int)(bsdtar->gs_width - w), tmp);

    /* Format the time using 'ls -l' conventions. */
    tim = archive_entry_mtime(entry);
#define HALF_YEAR (time_t)365 * 86400 / 2
#if defined(_WIN32) && !defined(__CYGWIN__)
#define DAY_FMT  "%d"  /* Windows' strftime function does not support %e format. */
#else
#define DAY_FMT  "%e"  /* Day number without leading zeros */
#endif
    if (tim < now - HALF_YEAR || tim > now + HALF_YEAR)
        fmt = bsdtar->day_first ? DAY_FMT " %b  %Y" : "%b " DAY_FMT "  %Y";
    else
        fmt = bsdtar->day_first ? DAY_FMT " %b %H:%M" : "%b " DAY_FMT " %H:%M";
    strftime(tmp, sizeof(tmp), fmt, localtime(&tim));
    fprintf(out, " %s ", tmp);
    safe_fprintf(out, "%s", archive_entry_pathname(entry));

    /* Extra information for links. */
    if (archive_entry_hardlink(entry)) /* Hard link */
        safe_fprintf(out, " link to %s",
            archive_entry_hardlink(entry));
    else if (archive_entry_symlink(entry)) /* Symbolic link */
        safe_fprintf(out, " -> %s", archive_entry_symlink(entry));
}