Dark, but not Dark (System), theme support (#654)

* Dark theme support

* fixup

* Apply method restrictions

* Make theme-manager optional

Author: basil

plugin/pom.xml

@@ -180,6 +180,17 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.jenkins.plugins</groupId>
+            <artifactId>theme-manager</artifactId>
+            <optional>true</optional>
+            <exclusions>
+                <exclusion>
+                    <groupId>io.jenkins.blueocean</groupId>
+                    <artifactId>blueocean-web</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>scm-api</artifactId>

plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowDefinition.java

@@ -37,12 +37,16 @@
 import net.sf.json.JSONObject;
 import org.apache.commons.lang.StringUtils;
 import org.jenkinsci.plugins.workflow.cps.persistence.PersistIn;
+import org.jenkinsci.plugins.workflow.cps.replay.ReplayAction;
+import org.jenkinsci.plugins.workflow.cps.view.ThemeUtil;
 import org.jenkinsci.plugins.workflow.flow.DurabilityHintProvider;
 import org.jenkinsci.plugins.workflow.flow.FlowDefinition;
 import org.jenkinsci.plugins.workflow.flow.FlowDefinitionDescriptor;
 import org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint;
 import org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner;
 import org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.DoNotUse;
 import org.kohsuke.stapler.AncestorInPath;
 import org.kohsuke.stapler.DataBoundConstructor;
 
@@ -180,4 +184,10 @@ public JSON doCheckScriptCompile(@AncestorInPath Item job, @QueryParameter Strin
         }
 
     }
+
+    /** @see ReplayAction#getTheme */
+    @Restricted(DoNotUse.class)
+    /* accessible to Jelly */ public String getTheme() {
+        return ThemeUtil.getTheme();
+    }
 }

plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/replay/ReplayAction.java

@@ -70,6 +70,7 @@
 import org.acegisecurity.AccessDeniedException;
 import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
 import org.jenkinsci.plugins.workflow.cps.CpsFlowExecution;
+import org.jenkinsci.plugins.workflow.cps.view.ThemeUtil;
 import org.jenkinsci.plugins.workflow.flow.FlowExecution;
 import org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner;
 import org.kohsuke.accmod.Restricted;
@@ -199,6 +200,12 @@ private ReplayAction(Run run) {
         return run;
     }
 
+    /** @see CpsFlowDefinition#getTheme */
+    @Restricted(DoNotUse.class)
+    /* accessible to Jelly */ public String getTheme() {
+        return ThemeUtil.getTheme();
+    }
+
     @Restricted(DoNotUse.class)
     @RequirePOST
     public void doRun(StaplerRequest req, StaplerResponse rsp) throws ServletException, IOException {

plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/view/ThemeUtil.java

@@ -0,0 +1,25 @@
+package org.jenkinsci.plugins.workflow.cps.view;
+
+import io.jenkins.plugins.thememanager.Theme;
+import io.jenkins.plugins.thememanager.ThemeManagerPageDecorator;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+
+@Restricted(NoExternalUse.class)
+public final class ThemeUtil {
+
+    private ThemeUtil() {
+        // Suppress default constructor for noninstantiability
+        throw new AssertionError();
+    }
+
+    public static String getTheme() {
+        try {
+            Theme theme = ThemeManagerPageDecorator.get().findTheme();
+            return theme.getProperty("ace-editor", "theme").orElse("tomorrow");
+        } catch (LinkageError e) {
+            // Optional plugin not installed
+            return "tomorrow";
+        }
+    }
+}

plugin/src/main/js/workflow-editor.js

@@ -10,6 +10,7 @@ import ace from "ace-builds/src-noconflict/ace";
 import "ace-builds/src-noconflict/ext-language_tools";
 import "ace-builds/src-noconflict/mode-groovy";
 import "ace-builds/src-noconflict/theme-tomorrow";
+import "ace-builds/src-noconflict/theme-tomorrow_night";
 
 // Import custom snippets
 import "./snippets/workflow";
@@ -45,7 +46,8 @@ var editorIdCounter = 0;
                 snippetManager.register(snippets, 'groovy');
 
                     editor.session.setMode("ace/mode/groovy");
-                    editor.setTheme("ace/theme/tomorrow");
+                    var theme = aceContainer.attr("theme") === "tomorrow_night" ? "tomorrow_night" : "tomorrow";
+                    editor.setTheme("ace/theme/" + theme);
                     editor.setAutoScrollEditorIntoView(true);
                     editor.setOption("minLines", 20);
                     // enable autocompletion and snippets

plugin/src/main/resources/org/jenkinsci/plugins/workflow/cps/CpsFlowDefinition/config.jelly

@@ -26,7 +26,7 @@
 <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form" xmlns:st="jelly:stapler" xmlns:wfe="/org/jenkinsci/plugins/workflow/editor">
   <input type="hidden" name="oldScript" value="${instance.script}"/>
   <f:entry title="${%Script}" field="script">
-    <wfe:workflow-editor />
+    <wfe:workflow-editor theme="${instance.theme}" />
   </f:entry>
   <f:entry field="sandbox">
     <f:checkbox title="${%Use Groovy Sandbox}" default="true"/>

plugin/src/main/resources/org/jenkinsci/plugins/workflow/cps/replay/ReplayAction/index.jelly

@@ -13,11 +13,11 @@
                         </p>
                         <f:form action="run" method="POST" name="config">
                             <f:entry field="mainScript" title="${%Main Script}">
-                                <wfe:workflow-editor script="${it.originalScript}" checkUrl="${rootURL}/${it.owner.url}${it.urlName}/checkScript" checkDependsOn=""/>
+                                <wfe:workflow-editor script="${it.originalScript}" theme="${it.theme}" checkUrl="${rootURL}/${it.owner.url}${it.urlName}/checkScript" checkDependsOn=""/>
                             </f:entry>
                             <j:forEach var="loadedScript" items="${it.originalLoadedScripts.entrySet()}">
                                 <f:entry field="${loadedScript.key.replace('.', '_')}" title="${loadedScript.key}">
-                                    <wfe:workflow-editor script="${loadedScript.value}" checkUrl="${rootURL}/${it.owner.url}${it.urlName}/checkScript" checkDependsOn=""/>
+                                    <wfe:workflow-editor script="${loadedScript.value}" theme="${it.theme}" checkUrl="${rootURL}/${it.owner.url}${it.urlName}/checkScript" checkDependsOn=""/>
                                 </f:entry>
                             </j:forEach>
                             <f:block>

plugin/src/main/resources/org/jenkinsci/plugins/workflow/editor/workflow-editor.jelly

@@ -5,6 +5,9 @@
         <st:attribute name="script">
             The script.
         </st:attribute>
+        <st:attribute name="theme">
+            The ACE editor theme.
+        </st:attribute>
     </st:documentation>
     <j:choose>
         <j:when test="${h.isUnitTest}">
@@ -14,7 +17,7 @@
         <j:otherwise>
             <div class="workflow-editor-wrapper" style="display: none; position: relative">
                 <f:textarea value="${script}" checkMethod="post" checkUrl="${attrs.checkUrl}" checkDependsOn="${attrs.checkDependsOn}"/>
-                <div class="pane-frame editor" style="height: 250px;" samplesUrl="${rootURL}/workflow-cps-samples/"/>
+                <div class="pane-frame editor" style="height: 250px;" samplesUrl="${rootURL}/workflow-cps-samples/" theme="${theme ?: 'tomorrow'}"/>
             </div>
             <st:adjunct includes="org.jenkinsci.plugins.workflow.cps.workflow-editor"/>
         </j:otherwise>