The Unified and Autonomous Development Platform
Fix issue #1254 - HTML tag are not escape when displaying job parameter description
Robin Shen3458771d6875
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.java b/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.javaindex a07ef127b3..49efec2bb0 100644--- a/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.java+++ b/server-core/src/main/java/io/onedev/server/buildspec/param/ParamUtils.java@@ -1,36 +1,27 @@package io.onedev.server.buildspec.param;-import java.io.Serializable;-import java.util.ArrayList;-import java.util.Collection;-import java.util.HashMap;-import java.util.HashSet;-import java.util.LinkedHashMap;-import java.util.List;-import java.util.Map;-import java.util.Set;--import javax.annotation.Nullable;-import javax.validation.ValidationException;--import org.apache.commons.codec.DecoderException;-import org.apache.commons.codec.binary.Hex;-import org.apache.commons.lang.SerializationUtils;-import org.slf4j.Logger;-import org.slf4j.LoggerFactory;-import com.google.common.base.Preconditions;-import io.onedev.server.buildspec.job.Job;import io.onedev.server.buildspec.param.spec.ParamSpec;import io.onedev.server.buildspec.param.spec.SecretParam;import io.onedev.server.buildspec.param.supply.ParamSupply;import io.onedev.server.buildspec.param.supply.SpecifiedValues;+import io.onedev.server.buildspecmodel.inputspec.SecretInput;import io.onedev.server.model.Build;import io.onedev.server.model.Project;-import io.onedev.server.buildspecmodel.inputspec.SecretInput;+import io.onedev.server.util.HtmlUtils;import io.onedev.server.web.editable.BeanDescriptor;import io.onedev.server.web.editable.PropertyDescriptor;+import org.apache.commons.codec.DecoderException;+import org.apache.commons.codec.binary.Hex;+import org.apache.commons.lang.SerializationUtils;+import org.slf4j.Logger;+import org.slf4j.LoggerFactory;++import javax.annotation.Nullable;+import javax.validation.ValidationException;+import java.io.Serializable;+import java.util.*;public class ParamUtils {@@ -147,19 +138,20 @@ public class ParamUtils {byte[] bytes = SerializationUtils.serialize((Serializable) paramSpecs);String className = PARAM_BEAN_PREFIX + "_" + Hex.encodeHexString(bytes);- List<ParamSpec> paramSpecsCopy = new ArrayList<>(paramSpecs);- for (int i=0; i<paramSpecsCopy.size(); i++) {- ParamSpec paramSpec = paramSpecsCopy.get(i);+ List<ParamSpec> paramSpecsCopy = new ArrayList<>();+ for (var paramSpec: paramSpecs) {+ ParamSpec paramSpecClone = (ParamSpec) SerializationUtils.clone(paramSpec);+ var description = paramSpecClone.getDescription();+ if (description != null)+ description = HtmlUtils.sanitize(description);if (paramSpec instanceof SecretParam) {- ParamSpec paramSpecClone = (ParamSpec) SerializationUtils.clone(paramSpec);- String description = paramSpecClone.getDescription();if (description == null)description = "";description += String.format("<div style='margin-top: 12px;'><b>Note:</b> Secret less than %d characters "+ "will not be masked in build log</div>", SecretInput.MASK.length());- paramSpecClone.setDescription(description);- paramSpecsCopy.set(i, paramSpecClone);}+ paramSpecClone.setDescription(description);+ paramSpecsCopy.add(paramSpecClone);}return (Class<? extends Serializable>) ParamSpec.defineClass(className, "Parameters", paramSpecsCopy);}diff --git a/server-core/src/main/java/io/onedev/server/buildspec/param/spec/ParamSpec.java b/server-core/src/main/java/io/onedev/server/buildspec/param/spec/ParamSpec.javaindex 0e54d5415e..c454d6c76c 100755--- a/server-core/src/main/java/io/onedev/server/buildspec/param/spec/ParamSpec.java+++ b/server-core/src/main/java/io/onedev/server/buildspec/param/spec/ParamSpec.java@@ -5,6 +5,7 @@ import java.util.List;import javax.annotation.Nullable;import javax.validation.Valid;+import io.onedev.server.annotation.Multiline;import org.apache.wicket.Component;import javax.validation.constraints.NotEmpty;@@ -34,7 +35,8 @@ public abstract class ParamSpec extends InputSpec {super.setName(name);}- @Editable(order=30, placeholder="No description", description="Optionally describes the param")+ @Editable(order=30, placeholder="No description", description="Optionally describes the param. Html tags are accepted.")+ @Multiline@Overridepublic String getDescription() {return super.getDescription();diff --git a/server-core/src/main/java/io/onedev/server/util/HtmlUtils.java b/server-core/src/main/java/io/onedev/server/util/HtmlUtils.javaindex fe53e5fdbd..7c02f2d572 100644--- a/server-core/src/main/java/io/onedev/server/util/HtmlUtils.java+++ b/server-core/src/main/java/io/onedev/server/util/HtmlUtils.java@@ -106,4 +106,8 @@ public class HtmlUtils {return Jsoup.parseBodyFragment(html, "http://localhost/sanitize");}+ public static String sanitize(String html) {+ return sanitize(parse(html)).body().html();+ }+}diff --git a/server-core/src/main/java/io/onedev/server/web/util/SuggestionUtils.java b/server-core/src/main/java/io/onedev/server/web/util/SuggestionUtils.javaindex 56c012d400..0112fce8cf 100644--- a/server-core/src/main/java/io/onedev/server/web/util/SuggestionUtils.java+++ b/server-core/src/main/java/io/onedev/server/web/util/SuggestionUtils.java@@ -224,7 +224,7 @@ public class SuggestionUtils {}if (paramSpecs != null) {for (ParamSpec paramSpec: paramSpecs)- variables.put(VariableInterpolator.PREFIX_PARAM + paramSpec.getName(), paramSpec.getDescription());+ variables.put(VariableInterpolator.PREFIX_PARAM + paramSpec.getName(), null);}for (String propertyName: buildSpec.getPropertyMap().keySet())variables.put(VariableInterpolator.PREFIX_PROPERTY + propertyName, null);