usr.bin/tar/read.c

   1 /*-
   2  * Copyright (c) 2003-2007 Tim Kientzle
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include "bsdtar_platform.h"
  27 __FBSDID("$FreeBSD$");
  28
  29 #ifdef HAVE_SYS_TYPES_H
  30 #include <sys/types.h>
  31 #endif
  32 #ifdef MAJOR_IN_MKDEV
  33 #include <sys/mkdev.h>
  34 #elif defined(MAJOR_IN_SYSMACROS)
  35 #include <sys/sysmacros.h>
  36 #endif
  37 #ifdef HAVE_SYS_PARAM_H
  38 #include <sys/param.h>
  39 #endif
  40 #ifdef HAVE_SYS_STAT_H
  41 #include <sys/stat.h>
  42 #endif
  43
  44 #ifdef HAVE_ERRNO_H
  45 #include <errno.h>
  46 #endif
  47 #ifdef HAVE_GRP_H
  48 #include <grp.h>
  49 #endif
  50 #ifdef HAVE_LIMITS_H
  51 #include <limits.h>
  52 #endif
  53 #ifdef HAVE_PWD_H
  54 #include <pwd.h>
  55 #endif
  56 #include <stdio.h>
  57 #ifdef HAVE_STDLIB_H
  58 #include <stdlib.h>
  59 #endif
  60 #ifdef HAVE_STRING_H
  61 #include <string.h>
  62 #endif
  63 #ifdef HAVE_TIME_H
  64 #include <time.h>
  65 #endif
  66 #ifdef HAVE_UNISTD_H
  67 #include <unistd.h>
  68 #endif
  69
  70 #include "bsdtar.h"
  71
  72 static void     list_item_verbose(struct bsdtar *, FILE *,
  73                     struct archive_entry *);
  74 static void     read_archive(struct bsdtar *bsdtar, char mode);
  75
  76 void
  77 tar_mode_t(struct bsdtar *bsdtar)
  78 {
  79         read_archive(bsdtar, 't');
  80         unmatched_inclusions_warn(bsdtar, "Not found in archive");
  81 }
  82
  83 void
  84 tar_mode_x(struct bsdtar *bsdtar)
  85 {
  86         /* We want to catch SIGINFO and SIGUSR1. */
  87         siginfo_init(bsdtar);
  88
  89         read_archive(bsdtar, 'x');
  90
  91         unmatched_inclusions_warn(bsdtar, "Not found in archive");
  92         /* Restore old SIGINFO + SIGUSR1 handlers. */
  93         siginfo_done(bsdtar);
  94 }
  95
  96 static void
  97 progress_func(void * cookie)
  98 {
  99         struct bsdtar * bsdtar = cookie;
 100
 101         siginfo_printinfo(bsdtar, 0);
 102 }
 103
 104 /*
 105  * Handle 'x' and 't' modes.
 106  */
 107 static void
 108 read_archive(struct bsdtar *bsdtar, char mode)
 109 {
 110         FILE                     *out;
 111         struct archive           *a;
 112         struct archive_entry     *entry;
 113         const struct stat        *st;
 114         int                       r;
 115
 116         while (*bsdtar->argv) {
 117                 include(bsdtar, *bsdtar->argv);
 118                 bsdtar->argv++;
 119         }
 120
 121         if (bsdtar->names_from_file != NULL)
 122                 include_from_file(bsdtar, bsdtar->names_from_file);
 123
 124         a = archive_read_new();
 125         if (bsdtar->compress_program != NULL)
 126                 archive_read_support_compression_program(a, bsdtar->compress_program);
 127         else
 128                 archive_read_support_compression_all(a);
 129         archive_read_support_format_all(a);
 130         if (archive_read_open_file(a, bsdtar->filename,
 131             bsdtar->bytes_per_block != 0 ? bsdtar->bytes_per_block :
 132             DEFAULT_BYTES_PER_BLOCK))
 133                 bsdtar_errc(bsdtar, 1, 0, "Error opening archive: %s",
 134                     archive_error_string(a));
 135
 136         do_chdir(bsdtar);
 137
 138         if (mode == 'x') {
 139                 /* Set an extract callback so that we can handle SIGINFO. */
 140                 archive_read_extract_set_progress_callback(a, progress_func,
 141                     bsdtar);
 142         }
 143
 144         if (mode == 'x' && bsdtar->option_chroot) {
 145 #if HAVE_CHROOT
 146                 if (chroot(".") != 0)
 147                         bsdtar_errc(bsdtar, 1, errno, "Can't chroot to \".\"");
 148 #else
 149                 bsdtar_errc(bsdtar, 1, 0,
 150                     "chroot isn't supported on this platform");
 151 #endif
 152         }
 153
 154         for (;;) {
 155                 /* Support --fast-read option */
 156                 if (bsdtar->option_fast_read &&
 157                     unmatched_inclusions(bsdtar) == 0)
 158                         break;
 159
 160                 r = archive_read_next_header(a, &entry);
 161                 if (r == ARCHIVE_EOF)
 162                         break;
 163                 if (r < ARCHIVE_OK)
 164                         bsdtar_warnc(bsdtar, 0, "%s", archive_error_string(a));
 165                 if (r <= ARCHIVE_WARN)
 166                         bsdtar->return_value = 1;
 167                 if (r == ARCHIVE_RETRY) {
 168                         /* Retryable error: try again */
 169                         bsdtar_warnc(bsdtar, 0, "Retrying...");
 170                         continue;
 171                 }
 172                 if (r == ARCHIVE_FATAL)
 173                         break;
 174
 175                 if (bsdtar->option_numeric_owner) {
 176                         archive_entry_set_uname(entry, NULL);
 177                         archive_entry_set_gname(entry, NULL);
 178                 }
 179
 180                 /*
 181                  * Exclude entries that are too old.
 182                  */
 183                 st = archive_entry_stat(entry);
 184                 if (bsdtar->newer_ctime_sec > 0) {
 185                         if (st->st_ctime < bsdtar->newer_ctime_sec)
 186                                 continue; /* Too old, skip it. */
 187                         if (st->st_ctime == bsdtar->newer_ctime_sec
 188                             && ARCHIVE_STAT_CTIME_NANOS(st)
 189                             <= bsdtar->newer_ctime_nsec)
 190                                 continue; /* Too old, skip it. */
 191                 }
 192                 if (bsdtar->newer_mtime_sec > 0) {
 193                         if (st->st_mtime < bsdtar->newer_mtime_sec)
 194                                 continue; /* Too old, skip it. */
 195                         if (st->st_mtime == bsdtar->newer_mtime_sec
 196                             && ARCHIVE_STAT_MTIME_NANOS(st)
 197                             <= bsdtar->newer_mtime_nsec)
 198                                 continue; /* Too old, skip it. */
 199                 }
 200
 201                 /*
 202                  * Note that pattern exclusions are checked before
 203                  * pathname rewrites are handled.  This gives more
 204                  * control over exclusions, since rewrites always lose
 205                  * information.  (For example, consider a rewrite
 206                  * s/foo[0-9]/foo/.  If we check exclusions after the
 207                  * rewrite, there would be no way to exclude foo1/bar
 208                  * while allowing foo2/bar.)
 209                  */
 210                 if (excluded(bsdtar, archive_entry_pathname(entry)))
 211                         continue; /* Excluded by a pattern test. */
 212
 213                 if (mode == 't') {
 214                         /* Perversely, gtar uses -O to mean "send to stderr"
 215                          * when used with -t. */
 216                         out = bsdtar->option_stdout ? stderr : stdout;
 217
 218                         /*
 219                          * TODO: Provide some reasonable way to
 220                          * preview rewrites.  gtar always displays
 221                          * the unedited path in -t output, which means
 222                          * you cannot easily preview rewrites.
 223                          */
 224                         if (bsdtar->verbose < 2)
 225                                 safe_fprintf(out, "%s",
 226                                     archive_entry_pathname(entry));
 227                         else
 228                                 list_item_verbose(bsdtar, out, entry);
 229                         fflush(out);
 230                         r = archive_read_data_skip(a);
 231                         if (r == ARCHIVE_WARN) {
 232                                 fprintf(out, "\n");
 233                                 bsdtar_warnc(bsdtar, 0, "%s",
 234                                     archive_error_string(a));
 235                         }
 236                         if (r == ARCHIVE_RETRY) {
 237                                 fprintf(out, "\n");
 238                                 bsdtar_warnc(bsdtar, 0, "%s",
 239                                     archive_error_string(a));
 240                         }
 241                         if (r == ARCHIVE_FATAL) {
 242                                 fprintf(out, "\n");
 243                                 bsdtar_warnc(bsdtar, 0, "%s",
 244                                     archive_error_string(a));
 245                                 bsdtar->return_value = 1;
 246                                 break;
 247                         }
 248                         fprintf(out, "\n");
 249                 } else {
 250                         /* Note: some rewrite failures prevent extraction. */
 251                         if (edit_pathname(bsdtar, entry))
 252                                 continue; /* Excluded by a rewrite failure. */
 253
 254                         if (bsdtar->option_interactive &&
 255                             !yes("extract '%s'", archive_entry_pathname(entry)))
 256                                 continue;
 257
 258                         /*
 259                          * Format here is from SUSv2, including the
 260                          * deferred '\n'.
 261                          */
 262                         if (bsdtar->verbose) {
 263                                 safe_fprintf(stderr, "x %s",
 264                                     archive_entry_pathname(entry));
 265                                 fflush(stderr);
 266                         }
 267
 268                         /* Tell the SIGINFO-handler code what we're doing. */
 269                         siginfo_setinfo(bsdtar, "extracting",
 270                             archive_entry_pathname(entry), 0);
 271                         siginfo_printinfo(bsdtar, 0);
 272
 273                         if (bsdtar->option_stdout)
 274                                 r = archive_read_data_into_fd(a, 1);
 275                         else
 276                                 r = archive_read_extract(a, entry,
 277                                     bsdtar->extract_flags);
 278                         if (r != ARCHIVE_OK) {
 279                                 if (!bsdtar->verbose)
 280                                         safe_fprintf(stderr, "%s",
 281                                             archive_entry_pathname(entry));
 282                                 safe_fprintf(stderr, ": %s",
 283                                     archive_error_string(a));
 284                                 if (!bsdtar->verbose)
 285                                         fprintf(stderr, "\n");
 286                                 bsdtar->return_value = 1;
 287                         }
 288                         if (bsdtar->verbose)
 289                                 fprintf(stderr, "\n");
 290                         if (r == ARCHIVE_FATAL)
 291                                 break;
 292                 }
 293         }
 294
 295         if (bsdtar->verbose > 2)
 296                 fprintf(stdout, "Archive Format: %s,  Compression: %s\n",
 297                     archive_format_name(a), archive_compression_name(a));
 298
 299         archive_read_finish(a);
 300 }
 301
 302
 303 /*
 304  * Display information about the current file.
 305  *
 306  * The format here roughly duplicates the output of 'ls -l'.
 307  * This is based on SUSv2, where 'tar tv' is documented as
 308  * listing additional information in an "unspecified format,"
 309  * and 'pax -l' is documented as using the same format as 'ls -l'.
 310  */
 311 static void
 312 list_item_verbose(struct bsdtar *bsdtar, FILE *out, struct archive_entry *entry)
 313 {
 314         const struct stat       *st;
 315         char                     tmp[100];
 316         size_t                   w;
 317         const char              *p;
 318         const char              *fmt;
 319         time_t                   tim;
 320         static time_t            now;
 321
 322         st = archive_entry_stat(entry);
 323
 324         /*
 325          * We avoid collecting the entire list in memory at once by
 326          * listing things as we see them.  However, that also means we can't
 327          * just pre-compute the field widths.  Instead, we start with guesses
 328          * and just widen them as necessary.  These numbers are completely
 329          * arbitrary.
 330          */
 331         if (!bsdtar->u_width) {
 332                 bsdtar->u_width = 6;
 333                 bsdtar->gs_width = 13;
 334         }
 335         if (!now)
 336                 time(&now);
 337         fprintf(out, "%s %d ",
 338             archive_entry_strmode(entry),
 339             (int)(st->st_nlink));
 340
 341         /* Use uname if it's present, else uid. */
 342         p = archive_entry_uname(entry);
 343         if ((p == NULL) || (*p == '\0')) {
 344                 sprintf(tmp, "%lu ", (unsigned long)st->st_uid);
 345                 p = tmp;
 346         }
 347         w = strlen(p);
 348         if (w > bsdtar->u_width)
 349                 bsdtar->u_width = w;
 350         fprintf(out, "%-*s ", (int)bsdtar->u_width, p);
 351
 352         /* Use gname if it's present, else gid. */
 353         p = archive_entry_gname(entry);
 354         if (p != NULL && p[0] != '\0') {
 355                 fprintf(out, "%s", p);
 356                 w = strlen(p);
 357         } else {
 358                 sprintf(tmp, "%lu", (unsigned long)st->st_gid);
 359                 w = strlen(tmp);
 360                 fprintf(out, "%s", tmp);
 361         }
 362
 363         /*
 364          * Print device number or file size, right-aligned so as to make
 365          * total width of group and devnum/filesize fields be gs_width.
 366          * If gs_width is too small, grow it.
 367          */
 368         if (S_ISCHR(st->st_mode) || S_ISBLK(st->st_mode)) {
 369                 sprintf(tmp, "%lu,%lu",
 370                     (unsigned long)major(st->st_rdev),
 371                     (unsigned long)minor(st->st_rdev)); /* ls(1) also casts here. */
 372         } else {
 373                 /*
 374                  * Note the use of platform-dependent macros to format
 375                  * the filesize here.  We need the format string and the
 376                  * corresponding type for the cast.
 377                  */
 378                 sprintf(tmp, BSDTAR_FILESIZE_PRINTF,
 379                     (BSDTAR_FILESIZE_TYPE)st->st_size);
 380         }
 381         if (w + strlen(tmp) >= bsdtar->gs_width)
 382                 bsdtar->gs_width = w+strlen(tmp)+1;
 383         fprintf(out, "%*s", (int)(bsdtar->gs_width - w), tmp);
 384
 385         /* Format the time using 'ls -l' conventions. */
 386         tim = (time_t)st->st_mtime;
 387         if (abs(tim - now) > (365/2)*86400)
 388                 fmt = bsdtar->day_first ? "%e %b  %Y" : "%b %e  %Y";
 389         else
 390                 fmt = bsdtar->day_first ? "%e %b %H:%M" : "%b %e %H:%M";
 391         strftime(tmp, sizeof(tmp), fmt, localtime(&tim));
 392         fprintf(out, " %s ", tmp);
 393         safe_fprintf(out, "%s", archive_entry_pathname(entry));
 394
 395         /* Extra information for links. */
 396         if (archive_entry_hardlink(entry)) /* Hard link */
 397                 safe_fprintf(out, " link to %s",
 398                     archive_entry_hardlink(entry));
 399         else if (S_ISLNK(st->st_mode)) /* Symbolic link */
 400                 safe_fprintf(out, " -> %s", archive_entry_symlink(entry));
 401 }