Skip to content

The Unified and Autonomous Development Platform

Fix issue #1345 - Step to run commands via SSH and copy files via SCP

Robin Shen279b4306feef
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/SCPCommandStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/SCPCommandStep.java
new file mode 100644
index 0000000000..8079bc9d4b
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/SCPCommandStep.java
@@ -0,0 +1,104 @@
+package io.onedev.server.buildspec.step;
+
+import io.onedev.commons.utils.StringUtils;
+import io.onedev.server.annotation.ChoiceProvider;
+import io.onedev.server.annotation.Editable;
+import io.onedev.server.annotation.Interpolative;
+import io.onedev.server.buildspec.step.commandinterpreter.DefaultInterpreter;
+import io.onedev.server.buildspec.step.commandinterpreter.Interpreter;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+
+import javax.validation.constraints.NotEmpty;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static com.google.common.collect.Lists.newArrayList;
+
+@Editable(order=135, name="Copy Files with SCP", description = "" +
+ "This step can only be executed by a docker aware executor. It runs under <a href='https://docs.onedev.io/concepts#job-workspace' target='_blank'>job workspace</a>")
+public class SCPCommandStep extends CommandStep {
+
+ private static final long serialVersionUID = 1L;
+
+ private String privateKeySecret;
+
+ private String source;
+
+ private String target;
+
+ @Editable(order=200, description="Specify a secret to be used as private key for SSH authentication")
+ @ChoiceProvider("getPrivateKeySecretChoices")
+ @NotEmpty
+ public String getPrivateKeySecret() {
+ return privateKeySecret;
+ }
+
+ public void setPrivateKeySecret(String privateKeySecret) {
+ this.privateKeySecret = privateKeySecret;
+ }
+
+ private static List<String> getPrivateKeySecretChoices() {
+ return Project.get().getHierarchyJobSecrets()
+ .stream().map(it->it.getName()).collect(Collectors.toList());
+ }
+
+ @Editable(order=300, description = "Specify source param for SCP command, for instance <code>app.tar.gz</code>")
+ @Interpolative(variableSuggester="suggestVariables")
+ @NotEmpty
+ public String getSource() {
+ return source;
+ }
+
+ public void setSource(String source) {
+ this.source = source;
+ }
+
+ @Editable(order=400, description = "Specify target param for SCP command, for instance <code>user@host:/app</code>")
+ @Interpolative(variableSuggester="suggestVariables")
+ @NotEmpty
+ public String getTarget() {
+ return target;
+ }
+
+ public void setTarget(String target) {
+ this.target = target;
+ }
+
+ @Editable
+ @Override
+ public boolean isRunInContainer() {
+ return true;
+ }
+
+ @Editable
+ @Override
+ public String getImage() {
+ return "1dev/ssh-client";
+ }
+
+ @Override
+ public boolean isUseTTY() {
+ return false;
+ }
+
+ @Override
+ public Interpreter getInterpreter() {
+ return new DefaultInterpreter() {
+ @Override
+ public List<String> getCommands() {
+ var commands = newArrayList(
+ "mkdir /root/.ssh",
+ "cat <<EOF>> /root/.ssh/id_rsa");
+ var privateKey = Build.get().getJobSecretAuthorizationContext().getSecretValue(getPrivateKeySecret());
+ commands.addAll(StringUtils.splitToLines(privateKey));
+ commands.addAll(newArrayList(
+ "EOF",
+ "chmod 600 /root/.ssh/id_rsa",
+ "scp -o StrictHostKeyChecking=no " + getSource() + " " + getTarget()));
+ return commands;
+ }
+ };
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/SSHCommandStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/SSHCommandStep.java
new file mode 100644
index 0000000000..479e79fe16
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/SSHCommandStep.java
@@ -0,0 +1,130 @@
+package io.onedev.server.buildspec.step;
+
+import com.google.common.collect.Lists;
+import io.onedev.commons.codeassist.InputSuggestion;
+import io.onedev.commons.utils.StringUtils;
+import io.onedev.server.annotation.ChoiceProvider;
+import io.onedev.server.annotation.Code;
+import io.onedev.server.annotation.Editable;
+import io.onedev.server.annotation.Interpolative;
+import io.onedev.server.buildspec.BuildSpec;
+import io.onedev.server.buildspec.step.commandinterpreter.DefaultInterpreter;
+import io.onedev.server.buildspec.step.commandinterpreter.Interpreter;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.Size;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static com.google.common.collect.Lists.newArrayList;
+
+@Editable(order=125, name="Execute Commands via SSH", description = "" +
+ "This step can only be executed by a docker aware executor")
+public class SSHCommandStep extends CommandStep {
+
+ private static final long serialVersionUID = 1L;
+
+ private String remoteMachine;
+
+ private String userName;
+
+ private String privateKeySecret;
+
+ private List<String> commands;
+
+ @Editable(order=100, description = "Host name or ip address of remote machine to run commands via SSH")
+ @Interpolative(variableSuggester="suggestVariables")
+ @NotEmpty
+ public String getRemoteMachine() {
+ return remoteMachine;
+ }
+
+ public void setRemoteMachine(String remoteMachine) {
+ this.remoteMachine = remoteMachine;
+ }
+
+ @Editable(order=150, description = "Specify user name of above machine for SSH authentication")
+ @Interpolative(variableSuggester="suggestVariables")
+ @NotEmpty
+ public String getUserName() {
+ return userName;
+ }
+
+ public void setUserName(String userName) {
+ this.userName = userName;
+ }
+
+ @Editable(order=200, description="Specify a secret to be used as private key of above user " +
+ "for SSH authentication")
+ @ChoiceProvider("getPrivateKeySecretChoices")
+ @NotEmpty
+ public String getPrivateKeySecret() {
+ return privateKeySecret;
+ }
+
+ public void setPrivateKeySecret(String privateKeySecret) {
+ this.privateKeySecret = privateKeySecret;
+ }
+
+ private static List<String> getPrivateKeySecretChoices() {
+ return Project.get().getHierarchyJobSecrets()
+ .stream().map(it->it.getName()).collect(Collectors.toList());
+ }
+
+ @Editable(order=300, description="Specify commands to be executed on remote machine")
+ @Interpolative
+ @Code(language=Code.SHELL, variableProvider="suggestVariables")
+ @Size(min=1, message="may not be empty")
+ public List<String> getCommands() {
+ return commands;
+ }
+
+ public void setCommands(List<String> commands) {
+ this.commands = commands;
+ }
+
+ @Editable
+ @Override
+ public boolean isRunInContainer() {
+ return true;
+ }
+
+ @Editable
+ @Override
+ public String getImage() {
+ return "1dev/ssh-client";
+ }
+
+ @Override
+ public boolean isUseTTY() {
+ return false;
+ }
+
+ @Override
+ public Interpreter getInterpreter() {
+ return new DefaultInterpreter() {
+ @Override
+ public List<String> getCommands() {
+ var commands = newArrayList(
+ "mkdir /root/.ssh",
+ "cat <<EOF>> /root/.ssh/id_rsa");
+ var privateKey = Build.get().getJobSecretAuthorizationContext().getSecretValue(getPrivateKeySecret());
+ commands.addAll(StringUtils.splitToLines(privateKey));
+ commands.addAll(newArrayList(
+ "EOF",
+ "chmod 600 /root/.ssh/id_rsa",
+ "ssh -o StrictHostKeyChecking=no " + getUserName() + "@" + getRemoteMachine() + " << EOF"));
+ commands.addAll(SSHCommandStep.this.getCommands());
+ commands.add("EOF");
+ return commands;
+ }
+ };
+ }
+
+ static List<InputSuggestion> suggestCommandVariables(String matchWith) {
+ return BuildSpec.suggestVariables(matchWith, false, false, true);
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/component/build/list/BuildListPanel.java b/server-core/src/main/java/io/onedev/server/web/component/build/list/BuildListPanel.java
index cb00de51f7..30ba1122d7 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/build/list/BuildListPanel.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/build/list/BuildListPanel.java
@@ -1057,7 +1057,7 @@ public abstract class BuildListPanel extends Panel {
@Override
public String getCssClass() {
- return "branch-tag d-none d-lg-table-cell";
+ return "on-behalf-of d-none d-lg-table-cell";
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/web/component/typeselect/TypeSelectPanel.java b/server-core/src/main/java/io/onedev/server/web/component/typeselect/TypeSelectPanel.java
index fa4e85c680..6790a762bb 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/typeselect/TypeSelectPanel.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/typeselect/TypeSelectPanel.java
@@ -1,359 +1,359 @@
-package io.onedev.server.web.component.typeselect;
-
-import java.io.Serializable;
-import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Set;
-
-import org.apache.commons.lang3.builder.EqualsBuilder;
-import org.apache.commons.lang3.builder.HashCodeBuilder;
-import org.apache.wicket.Component;
-import org.apache.wicket.ajax.AjaxChannel;
-import org.apache.wicket.ajax.AjaxRequestTarget;
-import org.apache.wicket.ajax.attributes.AjaxRequestAttributes;
-import org.apache.wicket.ajax.markup.html.AjaxLink;
-import org.apache.wicket.behavior.AttributeAppender;
-import org.apache.wicket.extensions.markup.html.repeater.tree.ITreeProvider;
-import org.apache.wicket.extensions.markup.html.repeater.tree.NestedTree;
-import org.apache.wicket.extensions.markup.html.repeater.tree.theme.HumanTheme;
-import org.apache.wicket.markup.head.CssHeaderItem;
-import org.apache.wicket.markup.head.IHeaderResponse;
-import org.apache.wicket.markup.head.JavaScriptHeaderItem;
-import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
-import org.apache.wicket.markup.html.WebMarkupContainer;
-import org.apache.wicket.markup.html.basic.Label;
-import org.apache.wicket.markup.html.form.TextField;
-import org.apache.wicket.markup.html.panel.Fragment;
-import org.apache.wicket.markup.html.panel.Panel;
-import org.apache.wicket.model.IModel;
-import org.apache.wicket.model.Model;
-
-import io.onedev.commons.loader.AppLoader;
-import io.onedev.commons.loader.ImplementationRegistry;
-import io.onedev.commons.utils.StringUtils;
-import io.onedev.server.util.ReflectionUtils;
-import io.onedev.server.util.Similarities;
-import io.onedev.server.web.asset.selectbytyping.SelectByTypingResourceReference;
-import io.onedev.server.web.behavior.OnTypingDoneBehavior;
-import io.onedev.server.web.component.link.ViewStateAwareAjaxLink;
-import io.onedev.server.web.editable.EditableUtils;
-
-@SuppressWarnings("serial")
-public abstract class TypeSelectPanel<T extends Serializable> extends Panel {
-
- private final List<Class<? extends T>> types;
-
- @SuppressWarnings("unchecked")
- public TypeSelectPanel(String id) {
- super(id);
-
- List<Class<?>> typeArguments = ReflectionUtils.getTypeArguments(TypeSelectPanel.class, getClass());
- Class<? extends T> baseType = (Class<T>) typeArguments.get(0);
-
- ImplementationRegistry registry = AppLoader.getInstance(ImplementationRegistry.class);
- types = new ArrayList<>(registry.getImplementations(baseType));
- EditableUtils.sortAnnotatedElements(types);
- }
-
- @Override
- protected void onInitialize() {
- super.onInitialize();
-
- TextField<String> searchField = new TextField<>("input", Model.of(""));
- add(searchField);
-
- searchField.add(new OnTypingDoneBehavior(100) {
-
- @Override
- protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {
- super.updateAjaxAttributes(attributes);
- attributes.setChannel(new AjaxChannel("type-choice", AjaxChannel.Type.DROP));
- }
-
- @Override
- protected void onTypingDone(AjaxRequestTarget target) {
- String searchInput = StringUtils.trimToNull(searchField.getInput());
-
- List<TreeNode> nodes = getNodes();
-
- NestedTree<TreeNode> tree;
- if (searchInput != null) {
- List<TreeNode> similarNodes = new Similarities<TreeNode>(nodes) {
-
- @Override
- protected double getSimilarScore(TreeNode item) {
- String fullName = item.getName();
- if (item instanceof TypeNode) {
- TypeNode<?> typeNode = (TypeNode<?>) item;
- String groupName = EditableUtils.getGroup(typeNode.type);
- if (groupName != null)
- fullName = groupName + "/" + fullName;
- }
- return Similarities.getSimilarScore(
- StringUtils.deleteWhitespace(fullName),
- StringUtils.deleteWhitespace(searchInput));
- }
-
- };
-
- List<TreeNode> filteredNodes = new ArrayList<>();
-
- Set<String> addedGroups = new HashSet<>();
- for (TreeNode matchNode: similarNodes) {
- if (matchNode instanceof TypeNode) {
- @SuppressWarnings("unchecked")
- TypeNode<T> currentNode = (TypeNode<T>) matchNode;
- filteredNodes.add(currentNode);
- String group = EditableUtils.getGroup(currentNode.type);
- if (group != null && addedGroups.add(group))
- filteredNodes.add(new GroupNode(group));
- }
- }
- tree = newTree(filteredNodes, new HashSet<>(filteredNodes));
- } else {
- tree = newTree(nodes, new HashSet<>());
- }
-
- replace(tree);
- target.add(tree);
- }
-
- });
-
- add(newTree(getNodes(), new HashSet<>()));
- setOutputMarkupId(true);
- }
-
- @SuppressWarnings({ "rawtypes", "unchecked" })
- private List<TreeNode> getNodes() {
- List<TreeNode> nodes = new ArrayList<>();
-
- Set<String> addedGroups = new HashSet<>();
- for (Class<? extends T> type: types) {
- String group = EditableUtils.getGroup(type);
- if (group != null && addedGroups.add(group))
- nodes.add(new GroupNode(group));
- nodes.add(new TypeNode(type));
- }
-
- return nodes;
- }
-
- protected List<TreeNode> getChildNodes(List<TreeNode> nodes, TreeNode parentNode) {
- List<TreeNode> childNodes = new ArrayList<>();
- if (parentNode == null) {
- for (TreeNode node: nodes) {
- if (node instanceof GroupNode) {
- childNodes.add(node);
- } else {
- @SuppressWarnings("unchecked")
- TypeNode<T> typeNode = (TypeNode<T>) node;
- if (EditableUtils.getGroup(typeNode.type) == null)
- childNodes.add(node);
- }
- }
- } else {
- for (TreeNode node: nodes) {
- if (node instanceof TypeNode) {
- @SuppressWarnings("unchecked")
- TypeNode<T> typeNode = (TypeNode<T>) node;
- if (parentNode.getName().equals(EditableUtils.getGroup(typeNode.type)))
- childNodes.add(node);
- }
- }
- }
- return childNodes;
- }
-
- private NestedTree<TreeNode> newTree(List<TreeNode> nodes, Set<TreeNode> state) {
- NestedTree<TreeNode> tree = new NestedTree<TreeNode>("content", new ITreeProvider<TreeNode>() {
-
- @Override
- public void detach() {
- }
-
- @Override
- public Iterator<? extends TreeNode> getRoots() {
- return getChildNodes(nodes, null).iterator();
- }
-
- @Override
- public boolean hasChildren(TreeNode node) {
- return node instanceof GroupNode;
- }
-
- @Override
- public Iterator<? extends TreeNode> getChildren(TreeNode node) {
- return getChildNodes(nodes, node).iterator();
- }
-
- @Override
- public IModel<TreeNode> model(TreeNode object) {
- return Model.of(object);
- }
-
- }, Model.ofSet(state)) {
-
- @Override
- protected void onInitialize() {
- super.onInitialize();
- add(new HumanTheme());
- }
-
- @Override
- protected Component newContentComponent(String id, IModel<TreeNode> nodeModel) {
- TreeNode node = nodeModel.getObject();
-
- if (node instanceof GroupNode) {
- Fragment fragment = new Fragment(id, "groupNodeFrag", TypeSelectPanel.this);
-
- AjaxLink<Void> link = new ViewStateAwareAjaxLink<Void>("link") {
-
- @Override
- public void onClick(AjaxRequestTarget target) {
- if (getState(node) == State.COLLAPSED)
- expand(node);
- else
- collapse(node);
- }
-
- };
- link.add(new Label("label", node.getName()));
- fragment.add(link);
-
- return fragment;
- } else {
- Fragment fragment = new Fragment(id, "typeNodeFrag", TypeSelectPanel.this);
-
- @SuppressWarnings("unchecked")
- TypeNode<T> typeNode = (TypeNode<T>) node;
- AjaxLink<Void> link = new ViewStateAwareAjaxLink<Void>("link") {
-
- @Override
- public void onClick(AjaxRequestTarget target) {
- onSelect(target, typeNode.type);
- }
-
- };
- link.add(new Label("label", EditableUtils.getDisplayName(typeNode.type)));
-
- for (TreeNode each: nodes) {
- if (each instanceof TypeNode) {
- if (node.equals(each))
- link.add(AttributeAppender.append("class", "active"));
- break;
- }
- }
- fragment.add(link);
-
- String description = StringUtils.trimToNull(StringUtils.substringBefore(
- EditableUtils.getDescription(typeNode.type), "."));
- if (description != null)
- link.add(new Label("description", description).setEscapeModelStrings(false));
- else
- link.add(new WebMarkupContainer("description").setVisible(false));
-
- return fragment;
- }
- }
-
- };
-
- tree.setOutputMarkupId(true);
-
- return tree;
- }
-
- @Override
- public void renderHead(IHeaderResponse response) {
- super.renderHead(response);
-
- response.render(CssHeaderItem.forReference(new TypeSelectCssResourceReference()));
- response.render(JavaScriptHeaderItem.forReference(new SelectByTypingResourceReference()));
-
- String script = String.format("$('#%s>.type-select>input').selectByTyping('#%s>.type-select>div');",
- getMarkupId(), getMarkupId());
- response.render(OnDomReadyHeaderItem.forScript(script));
- }
-
- protected abstract void onSelect(AjaxRequestTarget target, Class<? extends T> type);
-
- private static interface TreeNode extends Serializable {
-
- String getName();
-
- }
-
- private static class GroupNode implements TreeNode {
-
- private final String name;
-
- public GroupNode(String name) {
- this.name = name;
- }
-
- @Override
- public String getName() {
- return name;
- }
-
- @Override
- public boolean equals(Object other) {
- if (this == other) {
- return true;
- } else if (other instanceof GroupNode) {
- GroupNode otherNode = (GroupNode) other;
- return new EqualsBuilder().append(getName(), otherNode.getName()).isEquals();
- } else {
- return false;
- }
- }
-
- @Override
- public int hashCode() {
- if (getName() == null)
- return super.hashCode();
- else
- return new HashCodeBuilder(17, 37).append(getName()).toHashCode();
- }
-
- }
-
- private static class TypeNode<T> implements TreeNode {
-
- private final Class<T> type;
-
- public TypeNode(Class<T> type) {
- this.type = type;
- }
-
- @Override
- public String getName() {
- return EditableUtils.getDisplayName(type);
- }
-
- @Override
- public boolean equals(Object other) {
- if (this == other) {
- return true;
- } else if (other instanceof TypeNode) {
- @SuppressWarnings("unchecked")
- TypeNode<T> otherNode = (TypeNode<T>) other;
- return new EqualsBuilder().append(type, otherNode.type).isEquals();
- } else {
- return false;
- }
- }
-
- @Override
- public int hashCode() {
- if (getName() == null)
- return super.hashCode();
- else
- return new HashCodeBuilder(17, 37).append(type).toHashCode();
- }
-
- }
-}
+package io.onedev.server.web.component.typeselect;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Set;
+
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+import org.apache.wicket.Component;
+import org.apache.wicket.ajax.AjaxChannel;
+import org.apache.wicket.ajax.AjaxRequestTarget;
+import org.apache.wicket.ajax.attributes.AjaxRequestAttributes;
+import org.apache.wicket.ajax.markup.html.AjaxLink;
+import org.apache.wicket.behavior.AttributeAppender;
+import org.apache.wicket.extensions.markup.html.repeater.tree.ITreeProvider;
+import org.apache.wicket.extensions.markup.html.repeater.tree.NestedTree;
+import org.apache.wicket.extensions.markup.html.repeater.tree.theme.HumanTheme;
+import org.apache.wicket.markup.head.CssHeaderItem;
+import org.apache.wicket.markup.head.IHeaderResponse;
+import org.apache.wicket.markup.head.JavaScriptHeaderItem;
+import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
+import org.apache.wicket.markup.html.WebMarkupContainer;
+import org.apache.wicket.markup.html.basic.Label;
+import org.apache.wicket.markup.html.form.TextField;
+import org.apache.wicket.markup.html.panel.Fragment;
+import org.apache.wicket.markup.html.panel.Panel;
+import org.apache.wicket.model.IModel;
+import org.apache.wicket.model.Model;
+
+import io.onedev.commons.loader.AppLoader;
+import io.onedev.commons.loader.ImplementationRegistry;
+import io.onedev.commons.utils.StringUtils;
+import io.onedev.server.util.ReflectionUtils;
+import io.onedev.server.util.Similarities;
+import io.onedev.server.web.asset.selectbytyping.SelectByTypingResourceReference;
+import io.onedev.server.web.behavior.OnTypingDoneBehavior;
+import io.onedev.server.web.component.link.ViewStateAwareAjaxLink;
+import io.onedev.server.web.editable.EditableUtils;
+
+@SuppressWarnings("serial")
+public abstract class TypeSelectPanel<T extends Serializable> extends Panel {
+
+ private final List<Class<? extends T>> types;
+
+ @SuppressWarnings("unchecked")
+ public TypeSelectPanel(String id) {
+ super(id);
+
+ List<Class<?>> typeArguments = ReflectionUtils.getTypeArguments(TypeSelectPanel.class, getClass());
+ Class<? extends T> baseType = (Class<T>) typeArguments.get(0);
+
+ ImplementationRegistry registry = AppLoader.getInstance(ImplementationRegistry.class);
+ types = new ArrayList<>(registry.getImplementations(baseType));
+ EditableUtils.sortAnnotatedElements(types);
+ }
+
+ @Override
+ protected void onInitialize() {
+ super.onInitialize();
+
+ TextField<String> searchField = new TextField<>("input", Model.of(""));
+ add(searchField);
+
+ searchField.add(new OnTypingDoneBehavior(100) {
+
+ @Override
+ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {
+ super.updateAjaxAttributes(attributes);
+ attributes.setChannel(new AjaxChannel("type-choice", AjaxChannel.Type.DROP));
+ }
+
+ @Override
+ protected void onTypingDone(AjaxRequestTarget target) {
+ String searchInput = StringUtils.trimToNull(searchField.getInput());
+
+ List<TreeNode> nodes = getNodes();
+
+ NestedTree<TreeNode> tree;
+ if (searchInput != null) {
+ List<TreeNode> similarNodes = new Similarities<TreeNode>(nodes) {
+
+ @Override
+ protected double getSimilarScore(TreeNode item) {
+ String fullName = item.getName();
+ if (item instanceof TypeNode) {
+ TypeNode<?> typeNode = (TypeNode<?>) item;
+ String groupName = EditableUtils.getGroup(typeNode.type);
+ if (groupName != null)
+ fullName = groupName + "/" + fullName;
+ }
+ return Similarities.getSimilarScore(
+ StringUtils.deleteWhitespace(fullName),
+ StringUtils.deleteWhitespace(searchInput));
+ }
+
+ };
+
+ List<TreeNode> filteredNodes = new ArrayList<>();
+
+ Set<String> addedGroups = new HashSet<>();
+ for (TreeNode matchNode: similarNodes) {
+ if (matchNode instanceof TypeNode) {
+ @SuppressWarnings("unchecked")
+ TypeNode<T> currentNode = (TypeNode<T>) matchNode;
+ filteredNodes.add(currentNode);
+ String group = EditableUtils.getGroup(currentNode.type);
+ if (group != null && addedGroups.add(group))
+ filteredNodes.add(new GroupNode(group));
+ }
+ }
+ tree = newTree(filteredNodes, new HashSet<>(filteredNodes));
+ } else {
+ tree = newTree(nodes, new HashSet<>());
+ }
+
+ replace(tree);
+ target.add(tree);
+ }
+
+ });
+
+ add(newTree(getNodes(), new HashSet<>()));
+ setOutputMarkupId(true);
+ }
+
+ @SuppressWarnings({ "rawtypes", "unchecked" })
+ private List<TreeNode> getNodes() {
+ List<TreeNode> nodes = new ArrayList<>();
+
+ Set<String> addedGroups = new HashSet<>();
+ for (Class<? extends T> type: types) {
+ String group = EditableUtils.getGroup(type);
+ if (group != null && addedGroups.add(group))
+ nodes.add(new GroupNode(group));
+ nodes.add(new TypeNode(type));
+ }
+
+ return nodes;
+ }
+
+ protected List<TreeNode> getChildNodes(List<TreeNode> nodes, TreeNode parentNode) {
+ List<TreeNode> childNodes = new ArrayList<>();
+ if (parentNode == null) {
+ for (TreeNode node: nodes) {
+ if (node instanceof GroupNode) {
+ childNodes.add(node);
+ } else {
+ @SuppressWarnings("unchecked")
+ TypeNode<T> typeNode = (TypeNode<T>) node;
+ if (EditableUtils.getGroup(typeNode.type) == null)
+ childNodes.add(node);
+ }
+ }
+ } else {
+ for (TreeNode node: nodes) {
+ if (node instanceof TypeNode) {
+ @SuppressWarnings("unchecked")
+ TypeNode<T> typeNode = (TypeNode<T>) node;
+ if (parentNode.getName().equals(EditableUtils.getGroup(typeNode.type)))
+ childNodes.add(node);
+ }
+ }
+ }
+ return childNodes;
+ }
+
+ private NestedTree<TreeNode> newTree(List<TreeNode> nodes, Set<TreeNode> state) {
+ NestedTree<TreeNode> tree = new NestedTree<TreeNode>("content", new ITreeProvider<TreeNode>() {
+
+ @Override
+ public void detach() {
+ }
+
+ @Override
+ public Iterator<? extends TreeNode> getRoots() {
+ return getChildNodes(nodes, null).iterator();
+ }
+
+ @Override
+ public boolean hasChildren(TreeNode node) {
+ return node instanceof GroupNode;
+ }
+
+ @Override
+ public Iterator<? extends TreeNode> getChildren(TreeNode node) {
+ return getChildNodes(nodes, node).iterator();
+ }
+
+ @Override
+ public IModel<TreeNode> model(TreeNode object) {
+ return Model.of(object);
+ }
+
+ }, Model.ofSet(state)) {
+
+ @Override
+ protected void onInitialize() {
+ super.onInitialize();
+ add(new HumanTheme());
+ }
+
+ @Override
+ protected Component newContentComponent(String id, IModel<TreeNode> nodeModel) {
+ TreeNode node = nodeModel.getObject();
+
+ if (node instanceof GroupNode) {
+ Fragment fragment = new Fragment(id, "groupNodeFrag", TypeSelectPanel.this);
+
+ AjaxLink<Void> link = new ViewStateAwareAjaxLink<Void>("link") {
+
+ @Override
+ public void onClick(AjaxRequestTarget target) {
+ if (getState(node) == State.COLLAPSED)
+ expand(node);
+ else
+ collapse(node);
+ }
+
+ };
+ link.add(new Label("label", node.getName()));
+ fragment.add(link);
+
+ return fragment;
+ } else {
+ Fragment fragment = new Fragment(id, "typeNodeFrag", TypeSelectPanel.this);
+
+ @SuppressWarnings("unchecked")
+ TypeNode<T> typeNode = (TypeNode<T>) node;
+ AjaxLink<Void> link = new ViewStateAwareAjaxLink<Void>("link") {
+
+ @Override
+ public void onClick(AjaxRequestTarget target) {
+ onSelect(target, typeNode.type);
+ }
+
+ };
+ link.add(new Label("label", EditableUtils.getDisplayName(typeNode.type)));
+
+ for (TreeNode each: nodes) {
+ if (each instanceof TypeNode) {
+ if (node.equals(each))
+ link.add(AttributeAppender.append("class", "active"));
+ break;
+ }
+ }
+ fragment.add(link);
+
+ String description = StringUtils.trimToNull(StringUtils.substringBefore(
+ EditableUtils.getDescription(typeNode.type), "."));
+ if (description != null)
+ link.add(new Label("description", description).setEscapeModelStrings(false));
+ else
+ link.add(new WebMarkupContainer("description").setVisible(false));
+
+ return fragment;
+ }
+ }
+
+ };
+
+ tree.setOutputMarkupId(true);
+
+ return tree;
+ }
+
+ @Override
+ public void renderHead(IHeaderResponse response) {
+ super.renderHead(response);
+
+ response.render(CssHeaderItem.forReference(new TypeSelectCssResourceReference()));
+ response.render(JavaScriptHeaderItem.forReference(new SelectByTypingResourceReference()));
+
+ String script = String.format("$('#%s>.type-select>input').selectByTyping('#%s>.type-select>div');",
+ getMarkupId(), getMarkupId());
+ response.render(OnDomReadyHeaderItem.forScript(script));
+ }
+
+ protected abstract void onSelect(AjaxRequestTarget target, Class<? extends T> type);
+
+ private static interface TreeNode extends Serializable {
+
+ String getName();
+
+ }
+
+ private static class GroupNode implements TreeNode {
+
+ private final String name;
+
+ public GroupNode(String name) {
+ this.name = name;
+ }
+
+ @Override
+ public String getName() {
+ return name;
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ if (this == other) {
+ return true;
+ } else if (other instanceof GroupNode) {
+ GroupNode otherNode = (GroupNode) other;
+ return new EqualsBuilder().append(getName(), otherNode.getName()).isEquals();
+ } else {
+ return false;
+ }
+ }
+
+ @Override
+ public int hashCode() {
+ if (getName() == null)
+ return super.hashCode();
+ else
+ return new HashCodeBuilder(17, 37).append(getName()).toHashCode();
+ }
+
+ }
+
+ private static class TypeNode<T> implements TreeNode {
+
+ private final Class<T> type;
+
+ public TypeNode(Class<T> type) {
+ this.type = type;
+ }
+
+ @Override
+ public String getName() {
+ return EditableUtils.getDisplayName(type);
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ if (this == other) {
+ return true;
+ } else if (other instanceof TypeNode) {
+ @SuppressWarnings("unchecked")
+ TypeNode<T> otherNode = (TypeNode<T>) other;
+ return new EqualsBuilder().append(type, otherNode.type).isEquals();
+ } else {
+ return false;
+ }
+ }
+
+ @Override
+ public int hashCode() {
+ if (getName() == null)
+ return super.hashCode();
+ else
+ return new HashCodeBuilder(17, 37).append(type).toHashCode();
+ }
+
+ }
+}