pointless whitespace/comment fixes, no code changes
[oweals/busybox.git] / archival / cpio.c
index ebe911a96f3add32000229cef3e7cdca5b7d3fb9..11b22e4781ea06693fb214d268120311f26020a1 100644 (file)
 #include "libbb.h"
 #include "unarchive.h"
 
+/* GNU cpio 2.9 --help (abridged):
+
+ Modes:
+  -t, --list                 List the archive
+  -i, --extract              Extract files from an archive
+  -o, --create               Create the archive
+  -p, --pass-through         Copy-pass mode [was ist das?!]
+
+ Options valid in any mode:
+      --block-size=SIZE      I/O block size = SIZE * 512 bytes
+  -B                         I/O block size = 5120 bytes
+  -c                         Use the old portable (ASCII) archive format
+  -C, --io-size=NUMBER       I/O block size in bytes
+  -f, --nonmatching          Only copy files that do not match given pattern
+  -F, --file=FILE            Use FILE instead of standard input or output
+  -H, --format=FORMAT        Use given archive FORMAT
+  -M, --message=STRING       Print STRING when the end of a volume of the
+                             backup media is reached
+  -n, --numeric-uid-gid      If -v, show numeric UID and GID
+      --quiet                Do not print the number of blocks copied
+      --rsh-command=COMMAND  Use remote COMMAND instead of rsh
+  -v, --verbose              Verbosely list the files processed
+  -V, --dot                  Print a "." for each file processed
+  -W, --warning=FLAG         Control warning display: 'none','truncate','all';
+                             multiple options accumulate
+
+ Options valid only in --extract mode:
+  -b, --swap                 Swap both halfwords of words and bytes of
+                             halfwords in the data (equivalent to -sS)
+  -r, --rename               Interactively rename files
+  -s, --swap-bytes           Swap the bytes of each halfword in the files
+  -S, --swap-halfwords       Swap the halfwords of each word (4 bytes)
+      --to-stdout            Extract files to standard output
+  -E, --pattern-file=FILE    Read additional patterns specifying filenames to
+                             extract or list from FILE
+      --only-verify-crc      Verify CRC's, don't actually extract the files
+
+ Options valid only in --create mode:
+  -A, --append               Append to an existing archive
+  -O FILE                    File to use instead of standard output
+
+ Options valid only in --pass-through mode:
+  -l, --link                 Link files instead of copying them, when possible
+
+ Options valid in --extract and --create modes:
+      --absolute-filenames   Do not strip file system prefix components from
+                             the file names
+      --no-absolute-filenames Create all files relative to the current dir
+
+ Options valid in --create and --pass-through modes:
+  -0, --null                 A list of filenames is terminated by a NUL
+  -a, --reset-access-time    Reset the access times of files after reading them
+  -I FILE                    File to use instead of standard input
+  -L, --dereference          Dereference symbolic links (copy the files
+                             that they point to instead of copying the links)
+  -R, --owner=[USER][:.][GROUP] Set owner of created files
+
+ Options valid in --extract and --pass-through modes:
+  -d, --make-directories     Create leading directories where needed
+  -m, --preserve-modification-time  Retain mtime when creating files
+      --no-preserve-owner    Do not change the ownership of the files
+      --sparse               Write files with blocks of zeros as sparse files
+  -u, --unconditional        Replace all files unconditionally
+ */
+enum {
+       CPIO_OPT_EXTRACT            = (1 << 0),
+       CPIO_OPT_TEST               = (1 << 1),
+       CPIO_OPT_NUL_TERMINATED     = (1 << 2),
+       CPIO_OPT_UNCONDITIONAL      = (1 << 3),
+       CPIO_OPT_VERBOSE            = (1 << 4),
+       CPIO_OPT_CREATE_LEADING_DIR = (1 << 5),
+       CPIO_OPT_PRESERVE_MTIME     = (1 << 6),
+       CPIO_OPT_DEREF              = (1 << 7),
+       CPIO_OPT_FILE               = (1 << 8),
+       CPIO_OPT_CREATE             = (1 << 9) * ENABLE_FEATURE_CPIO_O,
+       CPIO_OPT_FORMAT             = (1 << 10) * ENABLE_FEATURE_CPIO_O,
+       CPIO_OPT_PASSTHROUGH        = (1 << 11) * ENABLE_FEATURE_CPIO_P,
+};
+
+#define OPTION_STR "it0uvdmLF:"
+
 #if ENABLE_FEATURE_CPIO_O
 static off_t cpio_pad4(off_t size)
 {
@@ -30,6 +111,7 @@ static off_t cpio_pad4(off_t size)
  * It's ok to exit instead of return. */
 static int cpio_o(void)
 {
+       static const char trailer[] ALIGN1 = "TRAILER!!!";
        struct name_s {
                struct name_s *next;
                char name[1];
@@ -48,7 +130,9 @@ static int cpio_o(void)
                char *line;
                struct stat st;
 
-               line = xmalloc_fgetline(stdin);
+               line = (option_mask32 & CPIO_OPT_NUL_TERMINATED)
+                               ? bb_get_chunk_from_file(stdin, NULL)
+                               : xmalloc_fgetline(stdin);
 
                if (line) {
                        /* Strip leading "./[./]..." from the filename */
@@ -61,7 +145,10 @@ static int cpio_o(void)
                                free(line);
                                continue;
                        }
-                       if (lstat(name, &st)) {
+                       if ((option_mask32 & CPIO_OPT_DEREF)
+                                       ? stat(name, &st)
+                                       : lstat(name, &st)
+                       ) {
  abort_cpio_o:
                                bb_simple_perror_msg_and_die(name);
                        }
@@ -119,7 +206,7 @@ static int cpio_o(void)
                        } else {
                                /* If no (more) hardlinks to output,
                                 * output "trailer" entry */
-                               name = "TRAILER!!!";
+                               name = trailer;
                                /* st.st_size == 0 is a must, but for uniformity
                                 * in the output, we zero out everything */
                                memset(&st, 0, sizeof(st));
@@ -167,7 +254,7 @@ static int cpio_o(void)
                }
 
                if (!line) {
-                       if (links)
+                       if (name != trailer)
                                goto next_link;
                        /* TODO: GNU cpio pads trailer to 512 bytes, do we want that? */
                        return EXIT_SUCCESS;
@@ -178,71 +265,6 @@ static int cpio_o(void)
 }
 #endif
 
-/* GNU cpio 2.9 --help (abridged):
-
- Modes:
-  -i, --extract              Extract files from an archive
-  -o, --create               Create the archive
-  -p, --pass-through         Copy-pass mode [was ist das?!]
-  -t, --list                 List the archive
-
- Options valid in any mode:
-      --block-size=SIZE      I/O block size = SIZE * 512 bytes
-  -B                         I/O block size = 5120 bytes
-  -c                         Use the old portable (ASCII) archive format
-  -C, --io-size=NUMBER       I/O block size in bytes
-  -f, --nonmatching          Only copy files that do not match given pattern
-  -F, --file=FILE            Use FILE instead of standard input or output
-  -H, --format=FORMAT        Use given archive FORMAT
-  -M, --message=STRING       Print STRING when the end of a volume of the
-                             backup media is reached
-  -n, --numeric-uid-gid      If -v, show numeric UID and GID
-      --quiet                Do not print the number of blocks copied
-      --rsh-command=COMMAND  Use remote COMMAND instead of rsh
-  -v, --verbose              Verbosely list the files processed
-  -V, --dot                  Print a "." for each file processed
-  -W, --warning=FLAG         Control warning display: 'none','truncate','all';
-                             multiple options accumulate
-
- Options valid only in --extract mode:
-  -b, --swap                 Swap both halfwords of words and bytes of
-                             halfwords in the data (equivalent to -sS)
-  -r, --rename               Interactively rename files
-  -s, --swap-bytes           Swap the bytes of each halfword in the files
-  -S, --swap-halfwords       Swap the halfwords of each word (4 bytes)
-      --to-stdout            Extract files to standard output
-  -E, --pattern-file=FILE    Read additional patterns specifying filenames to
-                             extract or list from FILE
-      --only-verify-crc      Verify CRC's, don't actually extract the files
-
- Options valid only in --create mode:
-  -A, --append               Append to an existing archive
-  -O FILE                    File to use instead of standard output
-
- Options valid only in --pass-through mode:
-  -l, --link                 Link files instead of copying them, when possible
-
- Options valid in --extract and --create modes:
-      --absolute-filenames   Do not strip file system prefix components from
-                             the file names
-      --no-absolute-filenames Create all files relative to the current dir
-
- Options valid in --create and --pass-through modes:
-  -0, --null                 A list of filenames is terminated by a NUL
-  -a, --reset-access-time    Reset the access times of files after reading them
-  -I FILE                    File to use instead of standard input
-  -L, --dereference          Dereference symbolic links (copy the files
-                             that they point to instead of copying the links)
-  -R, --owner=[USER][:.][GROUP] Set owner of created files
-
- Options valid in --extract and --pass-through modes:
-  -d, --make-directories     Create leading directories where needed
-  -m, --preserve-modification-time  Retain mtime when creating files
-      --no-preserve-owner    Do not change the ownership of the files
-      --sparse               Write files with blocks of zeros as sparse files
-  -u, --unconditional        Replace all files unconditionally
- */
-
 int cpio_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 int cpio_main(int argc UNUSED_PARAM, char **argv)
 {
@@ -250,17 +272,6 @@ int cpio_main(int argc UNUSED_PARAM, char **argv)
        char *cpio_filename;
        USE_FEATURE_CPIO_O(const char *cpio_fmt = "";)
        unsigned opt;
-       enum {
-               CPIO_OPT_EXTRACT            = (1 << 0),
-               CPIO_OPT_TEST               = (1 << 1),
-               CPIO_OPT_UNCONDITIONAL      = (1 << 2),
-               CPIO_OPT_VERBOSE            = (1 << 3),
-               CPIO_OPT_FILE               = (1 << 4),
-               CPIO_OPT_CREATE_LEADING_DIR = (1 << 5),
-               CPIO_OPT_PRESERVE_MTIME     = (1 << 6),
-               CPIO_OPT_CREATE             = (1 << 7),
-               CPIO_OPT_FORMAT             = (1 << 8),
-       };
 
 #if ENABLE_GETOPT_LONG
        applet_long_options =
@@ -269,35 +280,86 @@ int cpio_main(int argc UNUSED_PARAM, char **argv)
 #if ENABLE_FEATURE_CPIO_O
                "create\0"       No_argument       "o"
                "format\0"       Required_argument "H"
+#if ENABLE_FEATURE_CPIO_P
+               "pass-through\0" No_argument       "p"
+#endif
 #endif
                ;
 #endif
 
-       /* Initialize */
-       archive_handle = init_handle();
-       archive_handle->src_fd = STDIN_FILENO;
-       archive_handle->seek = seek_by_read;
-       archive_handle->ah_flags = ARCHIVE_EXTRACT_NEWER;
+       /* As of now we do not enforce this: */
+       /* -i,-t,-o,-p are mutually exclusive */
+       /* -u,-d,-m make sense only with -i or -p */
+       /* -L makes sense only with -o or -p */
 
-#if ENABLE_FEATURE_CPIO_O
-       opt = getopt32(argv, "ituvF:dmoH:", &cpio_filename, &cpio_fmt);
+#if !ENABLE_FEATURE_CPIO_O
+       opt = getopt32(argv, OPTION_STR, &cpio_filename);
+#else
+       opt = getopt32(argv, OPTION_STR "oH:" USE_FEATURE_CPIO_P("p"), &cpio_filename, &cpio_fmt);
+       if (opt & CPIO_OPT_PASSTHROUGH) {
+               pid_t pid;
+               struct fd_pair pp;
 
+               if (argv[optind] == NULL)
+                       bb_show_usage();
+               if (opt & CPIO_OPT_CREATE_LEADING_DIR)
+                       mkdir(argv[optind], 0777);
+               /* Crude existence check:
+                * close(xopen(argv[optind], O_RDONLY | O_DIRECTORY));
+                * We can also xopen, fstat, IS_DIR, later fchdir.
+                * This would check for existence earlier and cleaner.
+                * As it stands now, if we fail xchdir later,
+                * child dies on EPIPE, unless it caught
+                * a diffrerent problem earlier.
+                * This is good enough for now.
+                */
+#if !BB_MMU
+               pp.rd = 3;
+               pp.wr = 4;
+               if (!re_execed) {
+                       close(3);
+                       close(4);
+                       xpiped_pair(pp);
+               }
+#else
+               xpiped_pair(pp);
+#endif
+               pid = fork_or_rexec(argv);
+               if (pid == 0) { /* child */
+                       close(pp.rd);
+                       xmove_fd(pp.wr, STDOUT_FILENO);
+                       goto dump;
+               }
+               /* parent */
+               xchdir(argv[optind++]);
+               close(pp.wr);
+               xmove_fd(pp.rd, STDIN_FILENO);
+               opt &= ~CPIO_OPT_PASSTHROUGH;
+               opt |= CPIO_OPT_EXTRACT;
+               goto skip;
+       }
+       /* -o */
        if (opt & CPIO_OPT_CREATE) {
-               if (*cpio_fmt != 'n')
+               if (*cpio_fmt != 'n') /* we _require_ "-H newc" */
                        bb_show_usage();
                if (opt & CPIO_OPT_FILE) {
                        fclose(stdout);
-                       stdout = fopen(cpio_filename, "w");
+                       stdout = fopen_for_write(cpio_filename);
                        /* Paranoia: I don't trust libc that much */
                        xdup2(fileno(stdout), STDOUT_FILENO);
                }
+ dump:
                return cpio_o();
        }
-#else
-       opt = getopt32(argv, "ituvF:dm", &cpio_filename);
+ skip:
 #endif
        argv += optind;
 
+       archive_handle = init_handle();
+       archive_handle->src_fd = STDIN_FILENO;
+       archive_handle->seek = seek_by_read;
+       archive_handle->ah_flags = ARCHIVE_EXTRACT_NEWER;
+
        /* One of either extract or test options must be given */
        if ((opt & (CPIO_OPT_TEST | CPIO_OPT_EXTRACT)) == 0) {
                bb_show_usage();
@@ -305,9 +367,7 @@ int cpio_main(int argc UNUSED_PARAM, char **argv)
 
        if (opt & CPIO_OPT_TEST) {
                /* if both extract and test options are given, ignore extract option */
-               if (opt & CPIO_OPT_EXTRACT) {
-                       opt &= ~CPIO_OPT_EXTRACT;
-               }
+               opt &= ~CPIO_OPT_EXTRACT;
                archive_handle->action_header = header_list;
        }
        if (opt & CPIO_OPT_EXTRACT) {
@@ -341,8 +401,13 @@ int cpio_main(int argc UNUSED_PARAM, char **argv)
                argv++;
        }
 
+       /* see get_header_cpio */
+       archive_handle->ah_priv[2] = (void*) ~(ptrdiff_t)0;
        while (get_header_cpio(archive_handle) == EXIT_SUCCESS)
                continue;
 
+       if (archive_handle->ah_priv[2] != (void*) ~(ptrdiff_t)0)
+               printf("%lu blocks\n", (unsigned long)(ptrdiff_t)(archive_handle->ah_priv[2]));
+
        return EXIT_SUCCESS;
 }