Support for xdot format download for workflows

Mark Robinson · Mark Robinson · commit ca50b9300021 · 2017-03-07T22:04:49.000Z
diff --git a/src/main/java/org/commonwl/viewer/services/GraphVizService.java b/src/main/java/org/commonwl/viewer/services/GraphVizService.java
@@ -0,0 +1,81 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.commonwl.viewer.services;
+
+import com.github.jabbalaci.graphviz.GraphViz;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+
+import java.io.File;
+
+/**
+ * Handles Graphviz rendering from DOT generated by DotWriter
+ */
+@Service
+public class GraphVizService {
+
+    private final String graphvizStorage;
+
+    @Autowired
+    public GraphVizService(@Value("${graphvizStorage}") String graphvizStorage) {
+        this.graphvizStorage = graphvizStorage;
+    }
+
+    /**
+     * Generate a graph in a specified format using GraphViz
+     * @param fileName The name of the file to be generated in the graphvizStorage directory
+     * @param dot The DOT source
+     * @param format The format for the graph to be generated in
+     * @return The file containing the graph
+     */
+    public File getGraph(String fileName, String dot, String format) {
+        // Generate graphviz image if it does not already exist
+        File out = new File(graphvizStorage + "/" + fileName);
+        if (!out.exists()) {
+            GraphViz gv = new GraphViz();
+
+            // Different DPI and transparency for svg files
+            if (format.equals("svg")) {
+                gv.decreaseDpi();
+                gv.decreaseDpi();
+                gv.decreaseDpi();
+                dot = dot.replace("bgcolor = \"#eeeeee\"", "bgcolor = \"transparent\"");
+            }
+
+            gv.writeGraphToFile(gv.getGraph(dot, format, "dot"), out.getAbsolutePath());
+        }
+        return out;
+    }
+
+    /**
+     * Delete the cache of workflow images for a workflow
+     * TODO: Make this more dynamic in some way, either store in workflow object or clear folder
+     * @param workflowID The ID of the workflow used for assuming file locations
+     */
+    public void deleteCache(String workflowID) {
+        File graphvizSvg = new File(graphvizStorage + "/" + workflowID + ".svg");
+        graphvizSvg.delete();
+        File graphvizPng = new File(graphvizStorage + "/" + workflowID + ".png");
+        graphvizPng.delete();
+        File graphvizXdot = new File(graphvizStorage + "/" + workflowID + ".dot");
+        graphvizXdot.delete();
+    }
+}
diff --git a/src/main/java/org/commonwl/viewer/services/WorkflowService.java b/src/main/java/org/commonwl/viewer/services/WorkflowService.java
@@ -40,24 +40,24 @@ public class WorkflowService {
     private final GitHubService githubService;
     private final WorkflowRepository workflowRepository;
     private final ROBundleFactory ROBundleFactory;
+    private final GraphVizService graphVizService;
     private final int cacheDays;
-    private final String graphvizStorage;
     private final int singleFileSizeLimit;
     private final int totalFileSizeLimit;
 
     @Autowired
     public WorkflowService(GitHubService githubService,
                            WorkflowRepository workflowRepository,
                            ROBundleFactory ROBundleFactory,
+                           GraphVizService graphVizService,
                            @Value("${cacheDays}") int cacheDays,
-                           @Value("${graphvizStorage}") String graphvizStorage,
                            @Value("${singleFileSizeLimit}") int singleFileSizeLimit,
                            @Value("${totalFileSizeLimit}") int totalFileSizeLimit) {
         this.githubService = githubService;
         this.workflowRepository = workflowRepository;
         this.ROBundleFactory = ROBundleFactory;
+        this.graphVizService = graphVizService;
         this.cacheDays = cacheDays;
-        this.graphvizStorage = graphvizStorage;
         this.singleFileSizeLimit = singleFileSizeLimit;
         this.totalFileSizeLimit = totalFileSizeLimit;
     }
@@ -128,10 +128,7 @@ public void removeWorkflow(Workflow workflow) {
         }
 
         // Delete cached graphviz images if they exist
-        File graphvizSvg = new File(graphvizStorage + "/" + workflow.getID() + ".svg");
-        graphvizSvg.delete();
-        File graphvizPng = new File(graphvizStorage + "/" + workflow.getID() + ".png");
-        graphvizPng.delete();
+        graphVizService.deleteCache(workflow.getID());
 
         // Remove the workflow from the database
         workflowRepository.delete(workflow);
diff --git a/src/main/java/org/commonwl/viewer/web/WorkflowController.java b/src/main/java/org/commonwl/viewer/web/WorkflowController.java
@@ -19,11 +19,11 @@
 
 package org.commonwl.viewer.web;
 
-import com.github.jabbalaci.graphviz.GraphViz;
 import org.apache.commons.lang.StringUtils;
 import org.commonwl.viewer.domain.GithubDetails;
 import org.commonwl.viewer.domain.Workflow;
 import org.commonwl.viewer.domain.WorkflowForm;
+import org.commonwl.viewer.services.GraphVizService;
 import org.commonwl.viewer.services.WorkflowFormValidator;
 import org.commonwl.viewer.services.WorkflowRepository;
 import org.commonwl.viewer.services.WorkflowService;
@@ -55,6 +55,7 @@ public class WorkflowController {
     private final WorkflowFormValidator workflowFormValidator;
     private final WorkflowService workflowService;
     private final WorkflowRepository workflowRepository;
+    private final GraphVizService graphVizService;
 
     /**
      * Autowired constructor to initialise objects used by the controller
@@ -64,10 +65,12 @@ public class WorkflowController {
     @Autowired
     public WorkflowController(WorkflowFormValidator workflowFormValidator,
                               WorkflowService workflowService,
-                              WorkflowRepository workflowRepository) {
+                              WorkflowRepository workflowRepository,
+                              GraphVizService graphVizService) {
         this.workflowFormValidator = workflowFormValidator;
         this.workflowService = workflowService;
         this.workflowRepository = workflowRepository;
+        this.graphVizService = graphVizService;
     }
 
     /**
@@ -239,29 +242,12 @@ public FileSystemResource downloadROBundle(@PathVariable("workflowID") String wo
                     method = RequestMethod.GET,
                     produces = "image/svg+xml")
     @ResponseBody
-    public FileSystemResource getGraphAsSvg(@Value("${graphvizStorage}") String graphvizStorage,
-                                            @PathVariable("workflowID") String workflowID) throws IOException {
-
-        // Get workflow from database
+    public FileSystemResource getGraphAsSvg(@PathVariable("workflowID") String workflowID) throws IOException {
         Workflow workflowModel = workflowRepository.findOne(workflowID);
-
-        // 404 error if workflow does not exist
         if (workflowModel == null) {
             throw new WorkflowNotFoundException();
         }
-
-        // Generate graphviz image if it does not already exist
-        File out = new File(graphvizStorage + "/" + workflowID + ".svg");
-        if (!out.exists()) {
-            GraphViz gv = new GraphViz();
-            gv.decreaseDpi();
-            gv.decreaseDpi();
-            gv.decreaseDpi();
-            gv.writeGraphToFile(gv.getGraph(workflowModel.getDotGraph()
-                    .replace("bgcolor = \"#eeeeee\"", "bgcolor = \"transparent\""), "svg", "dot"), out.getAbsolutePath());
-        }
-
-        // Output the graph image
+        File out = graphVizService.getGraph(workflowID + ".svg", workflowModel.getDotGraph(), "svg");
         return new FileSystemResource(out);
     }
 
@@ -273,25 +259,29 @@ public FileSystemResource getGraphAsSvg(@Value("${graphvizStorage}") String grap
             method = RequestMethod.GET,
             produces = "image/png")
     @ResponseBody
-    public FileSystemResource getGraphAsPng(@Value("${graphvizStorage}") String graphvizStorage,
-                                            @PathVariable("workflowID") String workflowID) throws IOException {
-
-        // Get workflow from database
+    public FileSystemResource getGraphAsPng(@PathVariable("workflowID") String workflowID) throws IOException {
         Workflow workflowModel = workflowRepository.findOne(workflowID);
-
-        // 404 error if workflow does not exist
         if (workflowModel == null) {
             throw new WorkflowNotFoundException();
         }
+        File out = graphVizService.getGraph(workflowID + ".png", workflowModel.getDotGraph(), "png");
+        return new FileSystemResource(out);
+    }
 
-        // Generate graphviz image if it does not already exist
-        File out = new File(graphvizStorage + "/" + workflowID + ".png");
-        if (!out.exists()) {
-            GraphViz gv = new GraphViz();
-            gv.writeGraphToFile(gv.getGraph(workflowModel.getDotGraph(), "png", "dot"), out.getAbsolutePath());
+    /**
+     * Download a generated DOT graph for a workflow as xdot
+     * @param workflowID The ID of the workflow to download the graph for
+     */
+    @RequestMapping(value = "/workflows/{workflowID}/graph/xdot",
+            method = RequestMethod.GET,
+            produces = "text/vnd.graphviz")
+    @ResponseBody
+    public FileSystemResource getGraphAsXdot(@PathVariable("workflowID") String workflowID) throws IOException {
+        Workflow workflowModel = workflowRepository.findOne(workflowID);
+        if (workflowModel == null) {
+            throw new WorkflowNotFoundException();
         }
-
-        // Output the graph image
+        File out = graphVizService.getGraph(workflowID + ".dot", workflowModel.getDotGraph(), "xdot");
         return new FileSystemResource(out);
     }
 }
diff --git a/src/main/resources/static/css/main.css b/src/main/resources/static/css/main.css
@@ -156,6 +156,15 @@ body {
     margin-bottom: 5px;
 }
 
+#dot {
+    margin-top: 5px;
+    margin-bottom: 10px;
+}
+
+#modalTitle {
+    margin-top: 0;
+}
+
 tr.selected, .table-hover tbody tr.selected:hover td, .table-hover tbody tr.selected:hover th {
     background-color: #b9ffbb !important;
 }
diff --git a/src/main/resources/static/js/workflow.js b/src/main/resources/static/js/workflow.js
@@ -191,7 +191,7 @@ require(['jquery', 'bootstrap.modal'],
         $('#download-dot').click(function (event) {
             // Generate download link src
             var dotGraph = $("#dot").val();
-            var src = "data:text/plain;charset=utf-8," + encodeURIComponent(dotGraph);
+            var src = "data:text/vnd.graphviz;charset=utf-8," + encodeURIComponent(dotGraph);
 
             // Set hidden download link href to contents and click it
             var downloadLink = $("#download-link-dot");
diff --git a/src/main/resources/templates/workflow.html b/src/main/resources/templates/workflow.html
@@ -44,8 +44,7 @@
                 <h4 class="modal-title" id="dotGraphLabel">Workflow DOT Graph</h4>
             </div>
             <div class="modal-body">
-                <a id="download-link-dot" href="" download="workflow.dot"></a>
-                <button id="download-dot" class="btn btn-primary" type="button">Download as .dot File</button>
+                <h4 id="modalTitle">Dot File Source:</h4>
 <textarea id="dot" class="form-control" rows="15" th:field="${workflow.dotGraph}">
 digraph G {
     graph [
@@ -96,6 +95,9 @@ <h4 class="modal-title" id="dotGraphLabel">Workflow DOT Graph</h4>
     input3->step3->output3;
 }
 </textarea>
+                <a id="download-link-dot" href="" download="workflow.dot"></a>
+                <button id="download-dot" class="btn btn-primary" type="button">Download dot File</button>
+                <a th:href="@{'/workflows/' + ${workflow.id} + '/graph/xdot'}" href="#" download="graph.dot" class="btn btn-primary" type="button">Download xdot File</a>
             </div>
         </div>
     </div>
