[libvirt] [PATCH v3 5/8] screenshot: Expose the new API in virsh

[Michal Privoznik]

* tools/virsh.c: Add screenshot command
* tools/virsh.pod: Document new command
---
 tools/virsh.c   |   90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 tools/virsh.pod |    4 ++
 2 files changed, 94 insertions(+), 0 deletions(-)

diff --git a/tools/virsh.c b/tools/virsh.c
index 2b16714..a03c712 100644
--- a/tools/virsh.c
+++ b/tools/virsh.c
@@ -1873,6 +1873,95 @@ cmdDump(vshControl *ctl, const vshCmd *cmd)
     return ret;
 }
 
+static const vshCmdInfo info_screenshot[] = {
+    {"help", N_("take a screenshot of a current domain console and store it "
+                "into a file")},
+    {"desc", N_("screenshot of a current domain console")},
+    {NULL, NULL}
+};
+
+static const vshCmdOptDef opts_screenshot[] = {
+    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
+    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("where to store the screenshot")},
+    {NULL, 0, 0, NULL}
+};
+
+static int cmdScreenshotSink(virStreamPtr st ATTRIBUTE_UNUSED,
+                             const char *bytes, size_t nbytes, void *opaque)
+{
+    int *fd = opaque;
+
+    return safewrite(*fd, bytes, nbytes);
+}
+
+static int
+cmdScreenshot(vshControl *ctl, const vshCmd *cmd) {
+    virDomainPtr dom;
+    const char *name = NULL;
+    const char *file = NULL;
+    int fd = -1;
+    virStreamPtr st = NULL;
+    unsigned int flags = 0; /* currently unused */
+    int ret = false;
+    bool created = true;
+    char *mime = NULL;
+
+    if (!vshConnectionUsability(ctl, ctl->conn))
+        return false;
+
+    if (vshCommandOptString(cmd, "file", &file) < 0) {
+        vshError(ctl, "%s", _("file must not be empty"));
+        return false;
+    }
+
+    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
+        return false;
+
+    if ((fd = open(file, O_WRONLY|O_CREAT|O_EXCL, 0666)) < 0) {
+        created = false;
+        if (errno != EEXIST ||
+            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
+            vshError(ctl, _("cannot create file %s"), file);
+            goto cleanup;
+        }
+    }
+
+    st = virStreamNew(ctl->conn, 0);
+
+    mime = virDomainScreenshot(dom, st, flags);
+    if (mime == NULL) {
+        vshError(ctl, _("could not take a screenshot of %s"), name);
+        goto cleanup;
+    }
+
+    if (virStreamRecvAll(st, cmdScreenshotSink, &fd) < 0) {
+        vshError(ctl, _("could not receive data from domain %s"), name);
+        goto cleanup;
+    }
+
+    if (VIR_CLOSE(fd) < 0) {
+        vshError(ctl, _("cannot close file %s"), file);
+        goto cleanup;
+    }
+
+    if (virStreamFinish(st) < 0) {
+        vshError(ctl, _("cannot close stream on domain %s"), name);
+        goto cleanup;
+    }
+
+    vshPrint(ctl, _("Screenshot saved to %s it's type is %s"), file, mime);
+    ret = true;
+
+cleanup:
+    if (ret == false && created)
+        unlink(file);
+    virDomainFree(dom);
+    if (st)
+        virStreamFree(st);
+    VIR_FORCE_CLOSE(fd);
+    return ret;
+}
+
 /*
  * "resume" command
  */
@@ -10717,6 +10806,7 @@ static const vshCmdDef domManagementCmds[] = {
     {"resume", cmdResume, opts_resume, info_resume},
     {"save", cmdSave, opts_save, info_save},
     {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo},
+    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot},
     {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem},
     {"setmem", cmdSetmem, opts_setmem, info_setmem},
     {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus},
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 2a708f6..56630a5 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -584,6 +584,10 @@ Therefore, -1 is a useful shorthand for 262144.
 B<Note>: The weight and cap parameters are defined only for the
 XEN_CREDIT scheduler and are now I<DEPRECATED>.
 
+=item B<screenshot> I<domain-id> I<imagefilepath>
+
+Takes a screenshot of a current domain console and stores it into a file.
+
 =item B<setmem> I<domain-id> B<kilobytes> optional I<--config> I<--live>
 I<--current>
 
-- 
1.7.5.rc3