Skip to content

The Unified and Autonomous Development Platform

Syntax highlight for job commands

robin shenf75cbadeae39
diff --git a/core/src/main/java/io/onedev/server/ci/job/Job.java b/core/src/main/java/io/onedev/server/ci/job/Job.java
index 3d698b98cb..464a0a26db 100644
--- a/core/src/main/java/io/onedev/server/ci/job/Job.java
+++ b/core/src/main/java/io/onedev/server/ci/job/Job.java
@@ -1,240 +1,240 @@
-package io.onedev.server.ci.job;
-
-import java.io.Serializable;
-import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import javax.validation.ConstraintValidatorContext;
-
-import org.hibernate.validator.constraints.NotEmpty;
-
-import io.onedev.server.ci.JobDependency;
-import io.onedev.server.ci.job.cache.JobCache;
-import io.onedev.server.ci.job.log.LogLevel;
-import io.onedev.server.ci.job.trigger.JobTrigger;
-import io.onedev.server.event.ProjectEvent;
-import io.onedev.server.util.inputspec.InputSpec;
-import io.onedev.server.util.validation.Validatable;
-import io.onedev.server.util.validation.annotation.ClassValidating;
-import io.onedev.server.web.editable.annotation.Editable;
-import io.onedev.server.web.editable.annotation.Horizontal;
-import io.onedev.server.web.editable.annotation.Multiline;
-
-@Editable
-@Horizontal
-@ClassValidating
-public class Job implements Serializable, Validatable {
-
- private static final long serialVersionUID = 1L;
-
- public static final String SELECTION_PREFIX = "jobs/";
-
- private String name;
-
- private List<InputSpec> paramSpecs = new ArrayList<>();
-
- private String environment;
-
- private String commands;
-
- private boolean cloneSource = true;
-
- private List<JobDependency> dependencies = new ArrayList<>();
-
- private List<JobOutcome> outcomes = new ArrayList<>();
-
- private List<JobTrigger> triggers = new ArrayList<>();
-
- private List<JobCache> caches = new ArrayList<>();
-
- private long timeout = 3600;
-
- private LogLevel logLevel = LogLevel.INFO;
-
- private transient Map<String, InputSpec> paramSpecMap;
-
- @Editable(order=100, description="Specify name of the job")
- @NotEmpty
- public String getName() {
- return name;
- }
-
- public void setName(String name) {
- this.name = name;
- }
-
- @Editable(order=105, name="Parameter Specs", description="Define parameter specifications of the job")
- public List<InputSpec> getParamSpecs() {
- return paramSpecs;
- }
-
- public void setParamSpecs(List<InputSpec> paramSpecs) {
- this.paramSpecs = paramSpecs;
- }
-
- @Editable(order=110, description="Specify the environment to run the command. Environment will be interpretated "
- + "by underlying job executor. For instance, a docker executor will treat it as a docker image, and an "
- + "agent executor will treat it as labels to match agents")
- @NotEmpty
- public String getEnvironment() {
- return environment;
- }
-
- public void setEnvironment(String environment) {
- this.environment = environment;
- }
-
- @Editable(order=120, description="Specify commands to execute in above environment, with one command per line. "
- + "For Windows based environments, commands will be interpretated by PowerShell, and for Unix/Linux "
- + "based environments, commands will be interpretated by shell")
- @Multiline
- @NotEmpty
- public String getCommands() {
- return commands;
- }
-
- public void setCommands(String commands) {
- this.commands = commands;
- }
-
- @Editable(order=130, description="Whether or not to clone the source code. If enabled, the repository will be "
- + "cloned into job workspace")
- public boolean isCloneSource() {
- return cloneSource;
- }
-
- public void setCloneSource(boolean cloneSource) {
- this.cloneSource = cloneSource;
- }
-
- @Editable(name="Dependency Jobs", order=140, description="Job dependencies determines the order and "
- + "concurrency when run different jobs")
- public List<JobDependency> getDependencies() {
- return dependencies;
- }
-
- public void setDependencies(List<JobDependency> dependencies) {
- this.dependencies = dependencies;
- }
-
- @Editable(order=200, description="Specify job outcomes")
- public List<JobOutcome> getOutcomes() {
- return outcomes;
- }
-
- public void setOutcomes(List<JobOutcome> outcomes) {
- this.outcomes = outcomes;
- }
-
- @Editable(order=500, description="Use triggers to run the job automatically under certain conditions")
- public List<JobTrigger> getTriggers() {
- return triggers;
- }
-
- public void setTriggers(List<JobTrigger> triggers) {
- this.triggers = triggers;
- }
-
- @Editable(order=10100, group="More Settings", description="Cache specific paths to speed up job execution. For instance for node.js "
- + "projects, you may cache the <tt>node_modules</tt> folder to avoid downloading node modules for "
- + "subsequent job executions. Note that cache is considered as a best-effort approach and your "
- + "build script should always consider that cache might not be available")
- public List<JobCache> getCaches() {
- return caches;
- }
-
- public void setCaches(List<JobCache> caches) {
- this.caches = caches;
- }
-
- @Editable(order=10200, group="More Settings", description="Specify timeout in seconds")
- public long getTimeout() {
- return timeout;
- }
-
- public void setTimeout(long timeout) {
- this.timeout = timeout;
- }
-
- @Editable(order=10300, group="More Settings")
- public LogLevel getLogLevel() {
- return logLevel;
- }
-
- public void setLogLevel(LogLevel logLevel) {
- this.logLevel = logLevel;
- }
-
- public JobTrigger getMatchedTrigger(ProjectEvent event) {
- for (JobTrigger trigger: getTriggers()) {
- if (trigger.matches(event, this))
- return trigger;
- }
- return null;
- }
-
- @Override
- public boolean isValid(ConstraintValidatorContext context) {
- Set<String> keys = new HashSet<>();
- Set<String> paths = new HashSet<>();
-
- boolean isValid = true;
- for (JobCache cache: caches) {
- if (keys.contains(cache.getKey())) {
- isValid = false;
- context.buildConstraintViolationWithTemplate("Duplicate key: " + cache.getKey())
- .addPropertyNode("caches").addConstraintViolation();
- } else {
- keys.add(cache.getKey());
- }
- if (paths.contains(cache.getPath())) {
- isValid = false;
- context.buildConstraintViolationWithTemplate("Duplicate path: " + cache.getPath())
- .addPropertyNode("caches").addConstraintViolation();
- } else {
- paths.add(cache.getPath());
- }
- }
-
- Set<String> dependencyJobs = new HashSet<>();
- for (JobDependency dependency: dependencies) {
- if (dependencyJobs.contains(dependency.getJobName())) {
- isValid = false;
- context.buildConstraintViolationWithTemplate("Duplicate dependency: " + dependency.getJobName())
- .addPropertyNode("dependencies").addConstraintViolation();
- } else {
- dependencyJobs.add(dependency.getJobName());
- }
- }
-
- Set<String> paramSpecNames = new HashSet<>();
- for (InputSpec paramSpec: paramSpecs) {
- if (paramSpecNames.contains(paramSpec.getName())) {
- isValid = false;
- context.buildConstraintViolationWithTemplate("Duplicate parameter spec: " + paramSpec.getName())
- .addPropertyNode("paramSpecs").addConstraintViolation();
- } else {
- paramSpecNames.add(paramSpec.getName());
- }
- }
-
- if (!isValid)
- context.disableDefaultConstraintViolation();
-
- return isValid;
- }
-
- public Map<String, InputSpec> getParamSpecMap() {
- if (paramSpecMap == null) {
- paramSpecMap = new LinkedHashMap<>();
- for (InputSpec paramSpec: getParamSpecs())
- paramSpecMap.put(paramSpec.getName(), paramSpec);
- }
- return paramSpecMap;
- }
-
-}
+package io.onedev.server.ci.job;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.validation.ConstraintValidatorContext;
+
+import org.hibernate.validator.constraints.NotEmpty;
+
+import io.onedev.server.ci.JobDependency;
+import io.onedev.server.ci.job.cache.JobCache;
+import io.onedev.server.ci.job.log.LogLevel;
+import io.onedev.server.ci.job.trigger.JobTrigger;
+import io.onedev.server.event.ProjectEvent;
+import io.onedev.server.util.inputspec.InputSpec;
+import io.onedev.server.util.validation.Validatable;
+import io.onedev.server.util.validation.annotation.ClassValidating;
+import io.onedev.server.web.editable.annotation.Editable;
+import io.onedev.server.web.editable.annotation.Horizontal;
+import io.onedev.server.web.editable.annotation.Script;
+
+@Editable
+@Horizontal
+@ClassValidating
+public class Job implements Serializable, Validatable {
+
+ private static final long serialVersionUID = 1L;
+
+ public static final String SELECTION_PREFIX = "jobs/";
+
+ private String name;
+
+ private List<InputSpec> paramSpecs = new ArrayList<>();
+
+ private String environment;
+
+ private String commands;
+
+ private boolean cloneSource = true;
+
+ private List<JobDependency> dependencies = new ArrayList<>();
+
+ private List<JobOutcome> outcomes = new ArrayList<>();
+
+ private List<JobTrigger> triggers = new ArrayList<>();
+
+ private List<JobCache> caches = new ArrayList<>();
+
+ private long timeout = 3600;
+
+ private LogLevel logLevel = LogLevel.INFO;
+
+ private transient Map<String, InputSpec> paramSpecMap;
+
+ @Editable(order=100, description="Specify name of the job")
+ @NotEmpty
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ @Editable(order=105, name="Parameter Specs", description="Define parameter specifications of the job")
+ public List<InputSpec> getParamSpecs() {
+ return paramSpecs;
+ }
+
+ public void setParamSpecs(List<InputSpec> paramSpecs) {
+ this.paramSpecs = paramSpecs;
+ }
+
+ @Editable(order=110, description="Specify the environment to run the command. Environment will be interpretated "
+ + "by underlying job executor. For instance, a docker executor will treat it as a docker image, and an "
+ + "agent executor will treat it as labels to match agents")
+ @NotEmpty
+ public String getEnvironment() {
+ return environment;
+ }
+
+ public void setEnvironment(String environment) {
+ this.environment = environment;
+ }
+
+ @Editable(order=120, description="Specify commands to execute in above environment, with one command per line. "
+ + "For Windows based environments, commands will be interpretated by PowerShell, and for Unix/Linux "
+ + "based environments, commands will be interpretated by shell")
+ @Script(Script.SHELL)
+ @NotEmpty
+ public String getCommands() {
+ return commands;
+ }
+
+ public void setCommands(String commands) {
+ this.commands = commands;
+ }
+
+ @Editable(order=130, description="Whether or not to clone the source code. If enabled, the repository will be "
+ + "cloned into job workspace")
+ public boolean isCloneSource() {
+ return cloneSource;
+ }
+
+ public void setCloneSource(boolean cloneSource) {
+ this.cloneSource = cloneSource;
+ }
+
+ @Editable(name="Dependency Jobs", order=140, description="Job dependencies determines the order and "
+ + "concurrency when run different jobs")
+ public List<JobDependency> getDependencies() {
+ return dependencies;
+ }
+
+ public void setDependencies(List<JobDependency> dependencies) {
+ this.dependencies = dependencies;
+ }
+
+ @Editable(order=200, description="Specify job outcomes")
+ public List<JobOutcome> getOutcomes() {
+ return outcomes;
+ }
+
+ public void setOutcomes(List<JobOutcome> outcomes) {
+ this.outcomes = outcomes;
+ }
+
+ @Editable(order=500, description="Use triggers to run the job automatically under certain conditions")
+ public List<JobTrigger> getTriggers() {
+ return triggers;
+ }
+
+ public void setTriggers(List<JobTrigger> triggers) {
+ this.triggers = triggers;
+ }
+
+ @Editable(order=10100, group="More Settings", description="Cache specific paths to speed up job execution. For instance for node.js "
+ + "projects, you may cache the <tt>node_modules</tt> folder to avoid downloading node modules for "
+ + "subsequent job executions. Note that cache is considered as a best-effort approach and your "
+ + "build script should always consider that cache might not be available")
+ public List<JobCache> getCaches() {
+ return caches;
+ }
+
+ public void setCaches(List<JobCache> caches) {
+ this.caches = caches;
+ }
+
+ @Editable(order=10200, group="More Settings", description="Specify timeout in seconds")
+ public long getTimeout() {
+ return timeout;
+ }
+
+ public void setTimeout(long timeout) {
+ this.timeout = timeout;
+ }
+
+ @Editable(order=10300, group="More Settings")
+ public LogLevel getLogLevel() {
+ return logLevel;
+ }
+
+ public void setLogLevel(LogLevel logLevel) {
+ this.logLevel = logLevel;
+ }
+
+ public JobTrigger getMatchedTrigger(ProjectEvent event) {
+ for (JobTrigger trigger: getTriggers()) {
+ if (trigger.matches(event, this))
+ return trigger;
+ }
+ return null;
+ }
+
+ @Override
+ public boolean isValid(ConstraintValidatorContext context) {
+ Set<String> keys = new HashSet<>();
+ Set<String> paths = new HashSet<>();
+
+ boolean isValid = true;
+ for (JobCache cache: caches) {
+ if (keys.contains(cache.getKey())) {
+ isValid = false;
+ context.buildConstraintViolationWithTemplate("Duplicate key: " + cache.getKey())
+ .addPropertyNode("caches").addConstraintViolation();
+ } else {
+ keys.add(cache.getKey());
+ }
+ if (paths.contains(cache.getPath())) {
+ isValid = false;
+ context.buildConstraintViolationWithTemplate("Duplicate path: " + cache.getPath())
+ .addPropertyNode("caches").addConstraintViolation();
+ } else {
+ paths.add(cache.getPath());
+ }
+ }
+
+ Set<String> dependencyJobs = new HashSet<>();
+ for (JobDependency dependency: dependencies) {
+ if (dependencyJobs.contains(dependency.getJobName())) {
+ isValid = false;
+ context.buildConstraintViolationWithTemplate("Duplicate dependency: " + dependency.getJobName())
+ .addPropertyNode("dependencies").addConstraintViolation();
+ } else {
+ dependencyJobs.add(dependency.getJobName());
+ }
+ }
+
+ Set<String> paramSpecNames = new HashSet<>();
+ for (InputSpec paramSpec: paramSpecs) {
+ if (paramSpecNames.contains(paramSpec.getName())) {
+ isValid = false;
+ context.buildConstraintViolationWithTemplate("Duplicate parameter spec: " + paramSpec.getName())
+ .addPropertyNode("paramSpecs").addConstraintViolation();
+ } else {
+ paramSpecNames.add(paramSpec.getName());
+ }
+ }
+
+ if (!isValid)
+ context.disableDefaultConstraintViolation();
+
+ return isValid;
+ }
+
+ public Map<String, InputSpec> getParamSpecMap() {
+ if (paramSpecMap == null) {
+ paramSpecMap = new LinkedHashMap<>();
+ for (InputSpec paramSpec: getParamSpecs())
+ paramSpecMap.put(paramSpec.getName(), paramSpec);
+ }
+ return paramSpecMap;
+ }
+
+}
diff --git a/core/src/main/java/io/onedev/server/ci/job/param/ScriptingValues.java b/core/src/main/java/io/onedev/server/ci/job/param/ScriptingValues.java
index bad87991a6..e8307e9f65 100644
--- a/core/src/main/java/io/onedev/server/ci/job/param/ScriptingValues.java
+++ b/core/src/main/java/io/onedev/server/ci/job/param/ScriptingValues.java
@@ -28,7 +28,7 @@ public class ScriptingValues implements ValuesProvider {
@Editable
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
public String getScript() {
return script;
}
@@ -45,7 +45,7 @@ public class ScriptingValues implements ValuesProvider {
return true;
ScriptingValues otherScriptingValues = (ScriptingValues) other;
return new EqualsBuilder()
- .append(script, otherScriptingValues.getValues())
+ .append(script, otherScriptingValues.script)
.isEquals();
}
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/booleaninput/defaultvalueprovider/ScriptingDefaultValue.java b/core/src/main/java/io/onedev/server/util/inputspec/booleaninput/defaultvalueprovider/ScriptingDefaultValue.java
index f4b2614c82..91aa78f5ed 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/booleaninput/defaultvalueprovider/ScriptingDefaultValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/booleaninput/defaultvalueprovider/ScriptingDefaultValue.java
@@ -18,7 +18,7 @@ public class ScriptingDefaultValue implements DefaultValueProvider {
@Editable(description="Groovy script to be evaluated. It should return a <i>boolean</i> value. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/choiceprovider/ScriptingChoices.java b/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/choiceprovider/ScriptingChoices.java
index cb97a526fd..d3cd786b74 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/choiceprovider/ScriptingChoices.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/choiceprovider/ScriptingChoices.java
@@ -26,7 +26,7 @@ public class ScriptingChoices extends ChoiceProvider {
+ "<code>return [\"Successful\":\"#00ff00\", \"Failed\":\"#ff0000\"]</code>, "
+ "Use <tt>null</tt> if the value does not have a color. Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
public String getScript() {
return script;
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultmultivalueprovider/ScriptingDefaultMultiValue.java b/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultmultivalueprovider/ScriptingDefaultMultiValue.java
index 023f23f36d..ae8d570acb 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultmultivalueprovider/ScriptingDefaultMultiValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultmultivalueprovider/ScriptingDefaultMultiValue.java
@@ -20,7 +20,7 @@ public class ScriptingDefaultMultiValue implements DefaultMultiValueProvider {
@Editable(description="Groovy script to be evaluated. It should return list of string. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultvalueprovider/ScriptingDefaultValue.java b/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultvalueprovider/ScriptingDefaultValue.java
index 7ef6ce3f68..29813b25b4 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultvalueprovider/ScriptingDefaultValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/choiceinput/defaultvalueprovider/ScriptingDefaultValue.java
@@ -18,7 +18,7 @@ public class ScriptingDefaultValue implements DefaultValueProvider {
@Editable(description="Groovy script to be evaluated. It should return a <i>string</i> value. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/dateinput/defaultvalueprovider/ScriptingDefaultValue.java b/core/src/main/java/io/onedev/server/util/inputspec/dateinput/defaultvalueprovider/ScriptingDefaultValue.java
index d54ccbff61..5bd2e66418 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/dateinput/defaultvalueprovider/ScriptingDefaultValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/dateinput/defaultvalueprovider/ScriptingDefaultValue.java
@@ -20,7 +20,7 @@ public class ScriptingDefaultValue implements DefaultValueProvider {
@Editable(description="Groovy script to be evaluated. It should return a <i>Date</i> value. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/choiceprovider/ScriptingChoices.java b/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/choiceprovider/ScriptingChoices.java
index 4859a81f5b..c9bb64c381 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/choiceprovider/ScriptingChoices.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/choiceprovider/ScriptingChoices.java
@@ -28,7 +28,7 @@ public class ScriptingChoices implements ChoiceProvider {
@Editable(description="Groovy script to be evaluated. The return value should be a list of group facade object to be used as choices. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java b/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java
index 3f3b22c297..6874d5729c 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/groupchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java
@@ -18,7 +18,7 @@ public class ScriptingDefaultValue implements DefaultValueProvider {
@Editable(description="Groovy script to be evaluated. It should return name of a group. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/numberinput/defaultvalueprovider/ScriptingDefaultValue.java b/core/src/main/java/io/onedev/server/util/inputspec/numberinput/defaultvalueprovider/ScriptingDefaultValue.java
index 3997a18666..a499e075e4 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/numberinput/defaultvalueprovider/ScriptingDefaultValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/numberinput/defaultvalueprovider/ScriptingDefaultValue.java
@@ -18,7 +18,7 @@ public class ScriptingDefaultValue implements DefaultValueProvider {
@Editable(description="Groovy script to be evaluated. It should return a <i>Integer</i> value. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/textinput/defaultvalueprovider/ScriptingDefaultValue.java b/core/src/main/java/io/onedev/server/util/inputspec/textinput/defaultvalueprovider/ScriptingDefaultValue.java
index 34834d5f99..219a8d0589 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/textinput/defaultvalueprovider/ScriptingDefaultValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/textinput/defaultvalueprovider/ScriptingDefaultValue.java
@@ -18,7 +18,7 @@ public class ScriptingDefaultValue implements DefaultValueProvider {
@Editable(description="Groovy script to be evaluated. It should return a <i>String</i> value. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/choiceprovider/ScriptingChoices.java b/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/choiceprovider/ScriptingChoices.java
index 16d125d86b..0aae4fb5b6 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/choiceprovider/ScriptingChoices.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/choiceprovider/ScriptingChoices.java
@@ -28,7 +28,7 @@ public class ScriptingChoices implements ChoiceProvider {
@Editable(description="Groovy script to be evaluated. The return value should be a list of user facade object to be used as choices. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java b/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java
index f88438ebb8..c8cb69608e 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/userchoiceinput/defaultvalueprovider/ScriptingDefaultValue.java
@@ -18,7 +18,7 @@ public class ScriptingDefaultValue implements DefaultValueProvider {
@Editable(description="Groovy script to be evaluated. It should return login name of an user. "
+ "Check <a href='$docRoot/Scripting' target='_blank'>scripting help</a> for details")
@NotEmpty
- @Script
+ @Script(Script.GROOVY)
@OmitName
@Multiline
public String getScript() {
diff --git a/core/src/main/java/io/onedev/server/web/asset/codemirror/codemirror.js b/core/src/main/java/io/onedev/server/web/asset/codemirror/codemirror.js
index 13350db92c..cb531cb9c1 100644
--- a/core/src/main/java/io/onedev/server/web/asset/codemirror/codemirror.js
+++ b/core/src/main/java/io/onedev/server/web/asset/codemirror/codemirror.js
@@ -27,16 +27,23 @@ onedev.server.codemirror = {
cm.scrollTo(null, (top+bottom-clientHeight)/2);
}
},
- setMode: function(cm, filePath) {
+ setModeByName: function(cm, modeName) {
+ var modeInfo = CodeMirror.findModeByName(modeName);
+ if (modeInfo)
+ onedev.server.codemirror.setMode(cm, modeInfo);
+ },
+ setModeByFileName: function(cm, fileName) {
var modeInfo = CodeMirror.findModeByFileName(filePath);
- if (modeInfo) {
- // specify mode via mime does not work for gfm (github flavored markdown)
- if (modeInfo.mode === "gfm")
- cm.setOption("mode", "gfm");
- else
- cm.setOption("mode", modeInfo.mime);
- CodeMirror.autoLoadMode(cm, modeInfo.mode);
- }
+ if (modeInfo)
+ onedev.server.codemirror.setMode(cm, modeInfo);
+ },
+ setMode: function(cm, modeInfo) {
+ // specify mode via mime does not work for gfm (github flavored markdown)
+ if (modeInfo.mode === "gfm")
+ cm.setOption("mode", "gfm");
+ else
+ cm.setOption("mode", modeInfo.mime);
+ CodeMirror.autoLoadMode(cm, modeInfo.mode);
},
getViewState: function(cm) {
var cursor = cm.getCursor();
diff --git a/core/src/main/java/io/onedev/server/web/editable/annotation/Script.java b/core/src/main/java/io/onedev/server/web/editable/annotation/Script.java
index 13d2880533..520f88d479 100644
--- a/core/src/main/java/io/onedev/server/web/editable/annotation/Script.java
+++ b/core/src/main/java/io/onedev/server/web/editable/annotation/Script.java
@@ -16,4 +16,10 @@ import java.lang.annotation.Target;
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Script {
+
+ String GROOVY = "Groovy";
+
+ String SHELL = "Shell";
+
+ String value();
}
\ No newline at end of file
diff --git a/core/src/main/java/io/onedev/server/web/editable/script/ScriptEditSupport.java b/core/src/main/java/io/onedev/server/web/editable/script/ScriptEditSupport.java
index af4fa527aa..052ebc4f9f 100644
--- a/core/src/main/java/io/onedev/server/web/editable/script/ScriptEditSupport.java
+++ b/core/src/main/java/io/onedev/server/web/editable/script/ScriptEditSupport.java
@@ -19,7 +19,8 @@ public class ScriptEditSupport implements EditSupport {
@Override
public PropertyContext<?> getEditContext(PropertyDescriptor descriptor) {
Class<?> propertyClass = descriptor.getPropertyGetter().getReturnType();
- if (descriptor.getPropertyGetter().getAnnotation(Script.class) != null) {
+ Script annotation = descriptor.getPropertyGetter().getAnnotation(Script.class);
+ if (annotation != null) {
Preconditions.checkState(propertyClass == String.class,
"@Code annotation should only be applied to a string property");
return new PropertyContext<String>(descriptor) {
@@ -31,7 +32,7 @@ public class ScriptEditSupport implements EditSupport {
@Override
protected Component newContent(String id, PropertyDescriptor propertyDescriptor) {
if (model.getObject() != null) {
- return new ScriptPropertyViewer(id, model.getObject());
+ return new ScriptPropertyViewer(id, model.getObject(), annotation.value());
} else {
return new EmptyValueLabel(id, propertyDescriptor.getPropertyGetter());
}
@@ -42,7 +43,7 @@ public class ScriptEditSupport implements EditSupport {
@Override
public PropertyEditor<String> renderForEdit(String componentId, IModel<String> model) {
- return new ScriptPropertyEditor(componentId, descriptor, model);
+ return new ScriptPropertyEditor(componentId, descriptor, model, annotation.value());
}
};
diff --git a/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyEditor.java b/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyEditor.java
index 2bc652c417..c2d8af0e8d 100644
--- a/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyEditor.java
+++ b/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyEditor.java
@@ -19,10 +19,13 @@ import io.onedev.server.web.editable.PropertyEditor;
@SuppressWarnings("serial")
public class ScriptPropertyEditor extends PropertyEditor<String> {
+ private final String modeName;
+
private TextArea<String> input;
- public ScriptPropertyEditor(String id, PropertyDescriptor propertyDescriptor, IModel<String> propertyModel) {
+ public ScriptPropertyEditor(String id, PropertyDescriptor propertyDescriptor, IModel<String> propertyModel, String modeName) {
super(id, propertyDescriptor, propertyModel);
+ this.modeName = modeName;
}
@Override
@@ -61,7 +64,8 @@ public class ScriptPropertyEditor extends PropertyEditor<String> {
super.renderHead(response);
response.render(JavaScriptHeaderItem.forReference(new ScriptSupportResourceReference()));
- String script = String.format("onedev.server.scriptSupport.onEditorDomReady('%s');", input.getMarkupId());
+ String script = String.format("onedev.server.scriptSupport.onEditorDomReady('%s', '%s');",
+ input.getMarkupId(), modeName);
response.render(OnLoadHeaderItem.forScript(script));
}
diff --git a/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyViewer.java b/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyViewer.java
index 26d59f2c7f..3b7bb67ad3 100644
--- a/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyViewer.java
+++ b/core/src/main/java/io/onedev/server/web/editable/script/ScriptPropertyViewer.java
@@ -12,11 +12,14 @@ public class ScriptPropertyViewer extends Panel {
private final String script;
+ private final String modeName;
+
private TextArea<String> input;
- public ScriptPropertyViewer(String id, String script) {
+ public ScriptPropertyViewer(String id, String script, String modeName) {
super(id);
+ this.modeName = modeName;
this.script = script;
}
@@ -35,7 +38,8 @@ public class ScriptPropertyViewer extends Panel {
super.renderHead(response);
response.render(JavaScriptHeaderItem.forReference(new ScriptSupportResourceReference()));
- String script = String.format("onedev.server.scriptSupport.onViewerDomReady('%s');", input.getMarkupId());
+ String script = String.format("onedev.server.scriptSupport.onViewerDomReady('%s', '%s');",
+ input.getMarkupId(), modeName);
response.render(OnLoadHeaderItem.forScript(script));
}
diff --git a/core/src/main/java/io/onedev/server/web/editable/script/script-support.js b/core/src/main/java/io/onedev/server/web/editable/script/script-support.js
index d8314d568c..0a86b5df59 100644
--- a/core/src/main/java/io/onedev/server/web/editable/script/script-support.js
+++ b/core/src/main/java/io/onedev/server/web/editable/script/script-support.js
@@ -1,5 +1,5 @@
onedev.server.scriptSupport = {
- onEditorDomReady: function(inputId) {
+ onEditorDomReady: function(inputId, modeName) {
var cm = CodeMirror.fromTextArea(document.getElementById(inputId), {
indentWithTabs: true,
indentUnit: 4,
@@ -14,7 +14,7 @@ onedev.server.scriptSupport = {
gutters: ["CodeMirror-linenumbers", "CodeMirror-foldgutter"],
highlightIdentifiers: {delay: 500}
});
- onedev.server.codemirror.setMode(cm, ".groovy");
+ onedev.server.codemirror.setModeByName(cm, modeName);
var $input = $("#" + inputId);
cm.on("change", function() {
@@ -22,7 +22,7 @@ onedev.server.scriptSupport = {
onedev.server.form.markDirty($input.closest("form"));
});
},
- onViewerDomReady: function(inputId) {
+ onViewerDomReady: function(inputId, modeName) {
var cm = CodeMirror.fromTextArea(document.getElementById(inputId), {
readOnly: true,
indentWithTabs: true,
@@ -37,6 +37,6 @@ onedev.server.scriptSupport = {
gutters: ["CodeMirror-linenumbers", "CodeMirror-foldgutter"],
highlightIdentifiers: {delay: 500}
});
- onedev.server.codemirror.setMode(cm, ".groovy");
+ onedev.server.codemirror.setModeByName(cm, modeName);
}
}
\ No newline at end of file
diff --git a/core/src/main/java/io/onedev/server/web/page/project/blob/render/edit/plain/plain-edit.js b/core/src/main/java/io/onedev/server/web/page/project/blob/render/edit/plain/plain-edit.js
index b1e2f35c45..ca7e132313 100644
--- a/core/src/main/java/io/onedev/server/web/page/project/blob/render/edit/plain/plain-edit.js
+++ b/core/src/main/java/io/onedev/server/web/page/project/blob/render/edit/plain/plain-edit.js
@@ -20,7 +20,7 @@ onedev.server.plainEdit = {
highlightIdentifiers: {delay: 500}
});
- onedev.server.codemirror.setMode(cm, fileName);
+ onedev.server.codemirror.setModeByFileName(cm, fileName);
/*
* AreYouSure can not track dirty correctly for CodeMirror generated
diff --git a/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-edit.js b/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-edit.js
index 7f531e85b9..04f22ccbc5 100644
--- a/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-edit.js
+++ b/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-edit.js
@@ -23,7 +23,7 @@ onedev.server.sourceEdit = {
highlightIdentifiers: {delay: 500}
});
- onedev.server.codemirror.setMode(cm, filePath);
+ onedev.server.codemirror.setModeByFileName(cm, filePath);
/*
* AreYouSure can not track dirty correctly for CodeMirror generated
diff --git a/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js b/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js
index 0e27e4f359..d2375148be 100644
--- a/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js
+++ b/core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/source/source-view.js
@@ -23,7 +23,7 @@ onedev.server.sourceView = {
gutters: ["CodeMirror-linenumbers", "CodeMirror-foldgutter"]
});
- onedev.server.codemirror.setMode(cm, filePath);
+ onedev.server.codemirror.setModeByFileName(cm, filePath);
$sourceView.data("callback", callback);
$sourceView.data("blameMessageCallback", blameMessageCallback);