Initial cut at managing workspaces

Author: rjrudin

src/main/java/com/marklogic/client/qconsole/WorkspaceManager.java

@@ -0,0 +1,24 @@
+package com.marklogic.client.qconsole;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Interface for exporting and importing qconsole workspaces to/from disk.
+ */
+public interface WorkspaceManager {
+
+    /**
+     * @param user
+     * @param workspaceNames
+     * @return a list of files that workspaces for the given user were exported to
+     */
+    public List<File> exportWorkspaces(String user, String... workspaceNames);
+
+    /**
+     * @param user
+     * @param workspaceNames
+     * @return a list of files that workspaces for the given user were imported from
+     */
+    public List<File> importWorkspaces(String user, String... workspaceNames);
+}

src/main/java/com/marklogic/client/qconsole/impl/DefaultWorkspaceManager.java

@@ -0,0 +1,125 @@
+package com.marklogic.client.qconsole.impl;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.eval.EvalResultIterator;
+import com.marklogic.client.helper.LoggingObject;
+import com.marklogic.client.io.DOMHandle;
+import com.marklogic.client.io.FileHandle;
+import com.marklogic.client.io.Format;
+import com.marklogic.client.qconsole.WorkspaceManager;
+import org.springframework.util.FileCopyUtils;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Default implementation that uses the ML Java Client API to manage workspaces. By default, workspaces
+ * will be exported and imported to/from ~/.qconsole/workspaces/(ML username).
+ */
+public class DefaultWorkspaceManager extends LoggingObject implements WorkspaceManager {
+
+    private DatabaseClient client;
+
+    private File baseDir;
+
+    public DefaultWorkspaceManager(DatabaseClient client) {
+        this.client = client;
+    }
+
+    @Override
+    public List<File> exportWorkspaces(String user, String... workspaceNames) {
+        String xquery = "declare namespace qconsole='http://marklogic.com/appservices/qconsole'; " +
+                "declare variable $user external; " +
+                "cts:search(/qconsole:workspace, cts:element-value-query(xs:QName('qconsole:userid'), string(xdmp:user($user))))";
+
+        EvalResultIterator result = client.newServerEval()
+                .addVariable("user", user)
+                .xquery(xquery).eval();
+
+        if (baseDir == null) {
+            baseDir = getDefaultWorkspacesDir();
+        }
+
+        File userDir = new File(baseDir, user);
+        userDir.mkdirs();
+
+        List<File> files = new ArrayList<>();
+
+        while (result.hasNext()) {
+            DOMHandle dom = result.next().get(new DOMHandle());
+            String workspaceId = getWorkspaceId(dom);
+            File f = new File(userDir, workspaceId + ".xml");
+            try {
+                FileCopyUtils.copy(dom.toBuffer(), f);
+                if (logger.isInfoEnabled()) {
+                    logger.info(format("Exported workspace %s to %s", workspaceId, f.getAbsolutePath()));
+                }
+                files.add(f);
+            } catch (IOException ie) {
+                throw new RuntimeException("Unable to write workspace XML to file, workspace ID: " + workspaceId + "; cause: " + ie.getMessage());
+            }
+        }
+
+        return files;
+    }
+
+    protected String getWorkspaceId(DOMHandle dom) {
+        return dom.get().getDocumentElement().getElementsByTagNameNS("http://marklogic.com/appservices/qconsole", "id").item(0).getTextContent();
+    }
+
+    @Override
+    public List<File> importWorkspaces(String user, String... workspaceNames) {
+        if (baseDir == null) {
+            baseDir = getDefaultWorkspacesDir();
+        }
+
+        List<File> files = new ArrayList<>();
+
+        File userDir = new File(baseDir, user);
+        if (!userDir.exists()) {
+            return files;
+        }
+
+        String xquery = "import module namespace amped-qconsole = 'http://marklogic.com/appservices/qconsole/util-amped' at '/MarkLogic/appservices/qconsole/qconsole-amped.xqy'; " +
+                "declare variable $workspace external; " +
+                "declare variable $uri external; " +
+                "amped-qconsole:qconsole-document-insert($uri, $workspace)";
+
+        for (File f : userDir.listFiles()) {
+            if (f.isFile() && f.getName().endsWith(".xml")) {
+                client.newServerEval()
+                        .addVariable("uri", "/workspaces/" + f.getName())
+                        .addVariable("workspace", new FileHandle(f).withFormat(Format.XML))
+                        .xquery(xquery).eval();
+
+                if (logger.isInfoEnabled()) {
+                    logger.info(format("Imported workspace from %s", f.getAbsolutePath()));
+                }
+
+                files.add(f);
+            }
+        }
+
+        return files;
+    }
+
+    /**
+     * Defaults to ~/.qconsole/workspaces.
+     *
+     * @return
+     */
+    protected File getDefaultWorkspacesDir() {
+        File homeDir = new File(System.getProperty("user.home"));
+        File qcDir = new File(homeDir, ".qconsole");
+        File dir = new File(qcDir, "workspaces");
+        dir.mkdirs();
+        return dir;
+    }
+
+
+    public void setBaseDir(File baseDir) {
+        this.baseDir = baseDir;
+    }
+}

src/test/java/com/marklogic/client/qconsole/impl/DefaultWorkspaceManagerDebug.java

@@ -0,0 +1,30 @@
+package com.marklogic.client.qconsole.impl;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.DatabaseClientFactory;
+
+import java.io.IOException;
+
+/**
+ * Debug-style program for manually verifying how DefaultWorkspaceManager works.
+ * <p>
+ * If the content source ID (an appserver ID) is not valid, that's fine - the content source just defaults
+ * to the first app server.
+ * <p>
+ * If the user doesn't exist, that's fine - it just won't be accessible.
+ */
+public class DefaultWorkspaceManagerDebug {
+
+    public static void main(String[] args) throws IOException {
+        DatabaseClient client = DatabaseClientFactory.newClient("localhost", 8000, "App-Services", "admin", "admin", DatabaseClientFactory.Authentication.DIGEST);
+        DefaultWorkspaceManager dwm = new DefaultWorkspaceManager(client);
+        String user = "admin";
+        try {
+            System.out.println(dwm.exportWorkspaces(user));
+            System.out.println(dwm.importWorkspaces(user));
+        } finally {
+            client.release();
+        }
+    }
+
+}