smbclient/tar: add verbose mode

A verbose mode got lost with the introduction of libarchive support.

The verbose mode is optional, default is quiet mode.

The output format is close to the verbose output format of POSIX tar
implementations and should be good parsable.

BUG: https://bugzilla.samba.org/show_bug.cgi?id=11642

Signed-off-by: Bjoern Jacke <bjacke@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>

diff --git a/docs-xml/manpages/smbclient.1.xml b/docs-xml/manpages/smbclient.1.xml
index ab62c12f36e3beef99fa5e060125aa14e2b048ba..0f556a874db143a91cfbcd5e714cd4e965447f65 100644 (file)
--- a/docs-xml/manpages/smbclient.1.xml
+++ b/docs-xml/manpages/smbclient.1.xml
@@ -69,7 +69,7 @@
                <arg choice="opt">-R &lt;name resolve order&gt;</arg>
                <arg choice="opt">-s &lt;smb config file&gt;</arg>
                <arg choice="opt">-t &lt;per-operation timeout in seconds&gt;</arg>
-               <arg choice="opt">-T&lt;c|x&gt;IXFqgbNan</arg>
+               <arg choice="opt">-T&lt;c|x&gt;IXFvgbNan</arg>
                <arg choice="opt">-k</arg>
        </cmdsynopsis>
 </refsynopsisdiv>
@@ -413,8 +413,9 @@
                        files that have the archive bit set. Useful only with the
                        <parameter>c</parameter> flag. </para></listitem>
 
-                       <listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing
-                       diagnostics as it works.  This is the same as tarmode quiet.
+                       <listitem><para><parameter>v</parameter> - Verbose. Makes tar
+                       print out the files being processed. By default tar is not verbose.
+                       This is the same as tarmode verbose.
                        </para></listitem>
 
                        <listitem><para><parameter>r</parameter> - Use wildcard
@@ -1102,7 +1103,7 @@
                </varlistentry>
 
                <varlistentry>
-               <term>tarmode &lt;full|inc|reset|noreset|system|nosystem|hidden|nohidden&gt;</term>
+               <term>tarmode &lt;full|inc|reset|noreset|system|nosystem|hidden|nohidden|verbose|noverbose&gt;</term>
                <listitem><para>Changes tar's behavior with regard to DOS
                attributes. There are 4 modes which can be turned on or
                off.</para>

diff --git a/source3/client/client.c b/source3/client/client.c
index cca88bd7893e5c0b33ee182ff13b822cf0273b62..29754806e63c69af3efeee5e98b96ee56b0b2e4f 100644 (file)
--- a/source3/client/client.c
+++ b/source3/client/client.c
@@ -5619,7 +5619,7 @@ static struct {
   {"scopy",cmd_scopy,"<src> <dest> server-side copy file",{COMPL_REMOTE,COMPL_REMOTE}},
   {"stat",cmd_stat,"<file name> Do a UNIX extensions stat call on a file",{COMPL_REMOTE,COMPL_NONE}},
   {"symlink",cmd_symlink,"<oldname> <newname> create a UNIX symlink",{COMPL_REMOTE,COMPL_REMOTE}},
-  {"tar",cmd_tar,"tar <c|x>[IXFqbgNan] current directory to/from <file name>",{COMPL_NONE,COMPL_NONE}},
+  {"tar",cmd_tar,"tar <c|x>[IXFvbgNan] current directory to/from <file name>",{COMPL_NONE,COMPL_NONE}},
   {"tarmode",cmd_tarmode,"<full|inc|reset|noreset> tar's behaviour towards archive bits",{COMPL_NONE,COMPL_NONE}},
   {"timeout",cmd_timeout,"timeout <number> - set the per-operation timeout in seconds (default 20)",{COMPL_NONE,COMPL_NONE}},
   {"translate",cmd_translate,"toggle text translation for printing",{COMPL_NONE,COMPL_NONE}},
@@ -6416,7 +6416,7 @@ int main(int argc,char *argv[])
                        .arg        = NULL,
                        .val        = 'T',
                        .descrip    = "Command line tar",
-                       .argDescrip = "<c|x>IXFqgbNan",
+                       .argDescrip = "<c|x>IXFvgbNan",
                },
                {
                        .longName   = "directory",

diff --git a/source3/client/clitar.c b/source3/client/clitar.c
index b598bde4ee807d632688afc17d5362d3ccd2f0a3..0307584663ed3ba328ba04baa457115882d5d420 100644 (file)
--- a/source3/client/clitar.c
+++ b/source3/client/clitar.c
@@ -153,6 +153,10 @@ struct tar {
 
        /* archive handle */
        struct archive *archive;
+
+       /* counters */
+       uint64_t numdir;
+       uint64_t numfile;
 };
 
 /**
@@ -211,8 +215,7 @@ static int make_remote_path(const char *full_path);
 static int max_token (const char *str);
 static NTSTATUS is_subpath(const char *sub, const char *full,
                           bool *_subpath_match);
-
-/**
+ /*
  * tar_get_ctx - retrieve global tar context handle
  */
 struct tar *tar_get_ctx()
@@ -285,10 +288,8 @@ int cmd_tarmode(void)
                {"nosystem",  &tar_ctx.mode.system,      false},
                {"hidden",    &tar_ctx.mode.hidden,      true },
                {"nohidden",  &tar_ctx.mode.hidden,      false},
-               {"verbose",   &tar_ctx.mode.verbose,     true },
-               {"noquiet",   &tar_ctx.mode.verbose,     true },
-               {"quiet",     &tar_ctx.mode.verbose,     false},
-               {"noverbose", &tar_ctx.mode.verbose,     false},
+               {"verbose",   &tar_ctx.mode.verbose,     false},
+               {"noverbose", &tar_ctx.mode.verbose,     true },
        };
 
        ctx = talloc_new(NULL);
@@ -313,7 +314,7 @@ int cmd_tarmode(void)
                                tar_ctx.mode.system      ? "system"      : "nosystem",
                                tar_ctx.mode.hidden      ? "hidden"      : "nohidden",
                                tar_ctx.mode.reset       ? "reset"       : "noreset",
-                               tar_ctx.mode.verbose     ? "verbose"     : "quiet"));
+                               tar_ctx.mode.verbose     ? "verbose"     : "noverbose"));
 
        talloc_free(ctx);
        return 0;
@@ -342,7 +343,7 @@ int cmd_tar(void)
 
        ok = next_token_talloc(ctx, &cmd_ptr, &buf, NULL);
        if (!ok) {
-               DBG(0, ("tar <c|x>[IXFbganN] [options] <tar file> [path list]\n"));
+               d_printf("tar <c|x>[IXFbgvanN] [options] <tar file> [path list]\n");
                err = 1;
                goto out;
        }
@@ -517,7 +518,7 @@ int tar_parse_args(struct tar* t,
                        break;
 
                        /* verbose */
-               case 'q':
+               case 'v':
                        t->mode.verbose = true;
                        break;
 
@@ -642,11 +643,16 @@ static int tar_create(struct tar* t)
        int err = 0;
        NTSTATUS status;
        const char *mask;
+       struct timespec tp_start, tp_end;
        TALLOC_CTX *ctx = talloc_new(NULL);
        if (ctx == NULL) {
                return 1;
        }
 
+       clock_gettime_mono(&tp_start);
+
+       t->numfile = 0;
+       t->numdir = 0;
        t->archive = archive_write_new();
 
        if (!t->mode.dry) {
@@ -713,8 +719,14 @@ static int tar_create(struct tar* t)
                }
        }
 
+       clock_gettime_mono(&tp_end);
+       d_printf("tar: dumped %"PRIu64" files and %"PRIu64" directories\n",
+                t->numfile, t->numdir);
+       d_printf("Total bytes written: %"PRIu64" (%.1f MiB/s)\n",
+               t->total_size,
+               t->total_size/timespec_elapsed2(&tp_start, &tp_end)/1024/1024);
+
 out_close:
-       DBG(0, ("Total bytes received: %" PRIu64 "\n", t->total_size));
 
        if (!t->mode.dry) {
                r = archive_write_close(t->archive);
@@ -823,8 +835,11 @@ static NTSTATUS get_file_callback(struct cli_state *cli,
 {
        NTSTATUS status = NT_STATUS_OK;
        char *remote_name;
+       char *old_dir = NULL;
+       char *new_dir = NULL;
        const char *initial_dir = client_get_cur_dir();
        bool skip = false;
+       bool isdir;
        int rc;
        TALLOC_CTX *ctx = talloc_new(NULL);
        if (ctx == NULL) {
@@ -846,7 +861,19 @@ static NTSTATUS get_file_callback(struct cli_state *cli,
                goto out;
        }
 
-       status = tar_create_skip_path(&tar_ctx, remote_name, finfo, &skip);
+       isdir = finfo->mode & FILE_ATTRIBUTE_DIRECTORY;
+       if (isdir) {
+               old_dir = talloc_strdup(ctx, initial_dir);
+               new_dir = talloc_asprintf(ctx, "%s\\", remote_name);
+               if ((old_dir == NULL) || (new_dir == NULL)) {
+                       status = NT_STATUS_NO_MEMORY;
+                       goto out;
+               }
+       }
+
+       status = tar_create_skip_path(&tar_ctx,
+                                     isdir ? new_dir : remote_name,
+                                     finfo, &skip);
        if (!NT_STATUS_IS_OK(status)) {
                goto out;
        }
@@ -857,18 +884,8 @@ static NTSTATUS get_file_callback(struct cli_state *cli,
                goto out;
        }
 
-       if (finfo->mode & FILE_ATTRIBUTE_DIRECTORY) {
-               char *old_dir;
-               char *new_dir;
+       if (isdir) {
                char *mask;
-
-               old_dir = talloc_strdup(ctx, initial_dir);
-               new_dir = talloc_asprintf(ctx, "%s%s\\",
-                                         initial_dir, finfo->name);
-               if ((old_dir == NULL) || (new_dir == NULL)) {
-                       status = NT_STATUS_NO_MEMORY;
-                       goto out;
-               }
                mask = talloc_asprintf(ctx, "%s*", new_dir);
                if (mask == NULL) {
                        status = NT_STATUS_NO_MEMORY;
@@ -889,6 +906,7 @@ static NTSTATUS get_file_callback(struct cli_state *cli,
                client_set_cur_dir(new_dir);
                do_list(mask, TAR_DO_LIST_ATTR, get_file_callback, false, true);
                client_set_cur_dir(old_dir);
+               tar_ctx.numdir++;
        } else {
                rc = tar_get_file(&tar_ctx, remote_name, finfo);
                if (rc != 0) {
@@ -922,6 +940,7 @@ static int tar_get_file(struct tar *t,
        int err = 0, r;
        const bool isdir = finfo->mode & FILE_ATTRIBUTE_DIRECTORY;
        TALLOC_CTX *ctx = talloc_new(NULL);
+
        if (ctx == NULL) {
                return 1;
        }
@@ -969,25 +988,39 @@ static int tar_get_file(struct tar *t,
 
        archive_entry_set_size(entry, (int64_t)finfo->size);
 
-       r = archive_write_header(t->archive, entry);
-       if (r != ARCHIVE_OK) {
-               DBG(0, ("Fatal: %s\n", archive_error_string(t->archive)));
-               err = 1;
-               goto out_entry;
-       }
-
        if (isdir) {
+               /* It's a directory just write a header */
+               r = archive_write_header(t->archive, entry);
+               if (r != ARCHIVE_OK) {
+                       DBG(0, ("Fatal: %s\n", archive_error_string(t->archive)));
+                       err = 1;
+               }
+               if (t->mode.verbose) {
+                       d_printf("a %s\\\n", full_dos_path);
+               }
                DBG(5, ("get_file skip dir %s\n", full_dos_path));
                goto out_entry;
        }
 
        status = cli_open(cli, full_dos_path, O_RDONLY, DENY_NONE, &remote_fd);
        if (!NT_STATUS_IS_OK(status)) {
-               DBG(0,("%s opening remote file %s\n",
-                                       nt_errstr(status), full_dos_path));
+               d_printf("%s opening remote file %s\n",
+                                       nt_errstr(status), full_dos_path);
+               goto out_entry;
+       }
+
+       /* don't make tar file entry until after the file is open */
+       r = archive_write_header(t->archive, entry);
+       if (r != ARCHIVE_OK) {
+               DBG(0, ("Fatal: %s\n", archive_error_string(t->archive)));
+               err = 1;
                goto out_entry;
        }
 
+       if (t->mode.verbose) {
+               d_printf("a %s\n", full_dos_path);
+       }
+
        do {
                status = cli_read(cli, remote_fd, buf, off, sizeof(buf), &len);
                if (!NT_STATUS_IS_OK(status)) {
@@ -1007,6 +1040,7 @@ static int tar_get_file(struct tar *t,
                }
 
        } while (off < finfo->size);
+       t->numfile++;
 
 out_close:
        cli_close(cli, remote_fd);
@@ -1074,9 +1108,12 @@ static int tar_extract(struct tar *t)
                        DBG(5, ("--- %s\n", archive_entry_pathname(entry)));
                        continue;
                }
-
                DBG(5, ("+++ %s\n", archive_entry_pathname(entry)));
 
+               if (t->mode.verbose) {
+                       d_printf("x %s\n", archive_entry_pathname(entry));
+               }
+
                rc = tar_send_file(t, entry);
                if (rc != 0) {
                        err = 1;