The Unified and Autonomous Development Platform
Fix issue #357 - Able to contribute plugin setting to project
Robin Shend2698e83536d
diff --git a/server-core/src/main/java/io/onedev/server/CoreModule.java b/server-core/src/main/java/io/onedev/server/CoreModule.javaindex 73e19956e3..4a69b239ff 100644--- a/server-core/src/main/java/io/onedev/server/CoreModule.java+++ b/server-core/src/main/java/io/onedev/server/CoreModule.java@@ -292,6 +292,7 @@ import io.onedev.server.web.page.layout.AdministrationSettingContribution;import io.onedev.server.web.page.layout.DefaultMainMenuCustomization;import io.onedev.server.web.page.layout.MainMenuCustomization;import io.onedev.server.web.page.project.blob.render.BlobRendererContribution;+import io.onedev.server.web.page.project.setting.ProjectSettingContribution;import io.onedev.server.web.page.test.TestPage;import io.onedev.server.web.websocket.BuildEventBroadcaster;import io.onedev.server.web.websocket.CodeCommentEventBroadcaster;@@ -520,6 +521,14 @@ public class CoreModule extends AbstractPluginModule {}});+ contribute(ProjectSettingContribution.class, new ProjectSettingContribution() {++ @Override+ public List<Class<? extends Serializable>> getSettingClasses() {+ return new ArrayList<>();+ }++ });}diff --git a/server-core/src/main/java/io/onedev/server/model/Project.java b/server-core/src/main/java/io/onedev/server/model/Project.javaindex ee78dea58a..90c4e9eb06 100644--- a/server-core/src/main/java/io/onedev/server/model/Project.java+++ b/server-core/src/main/java/io/onedev/server/model/Project.java@@ -8,6 +8,7 @@ import java.io.FileOutputStream;import java.io.IOException;import java.io.InputStream;import java.io.OutputStream;+import java.io.Serializable;import java.util.ArrayList;import java.util.Collection;import java.util.Collections;@@ -15,6 +16,7 @@ import java.util.Date;import java.util.HashMap;import java.util.HashSet;import java.util.Iterator;+import java.util.LinkedHashMap;import java.util.List;import java.util.Map;import java.util.Objects;@@ -35,6 +37,7 @@ import javax.persistence.Lob;import javax.persistence.ManyToOne;import javax.persistence.OneToMany;import javax.persistence.Table;+import javax.validation.Validator;import org.apache.commons.lang3.SerializationUtils;import org.eclipse.jgit.api.CreateBranchCommand;@@ -217,6 +220,11 @@ public class Project extends AbstractEntity implements NameAware {@Lob@Column(nullable=false, length=65535)private ArrayList<TagProtection> tagProtections = new ArrayList<>();++ @JsonIgnore+ @Lob+ @Column(nullable=false, length=65535)+ private LinkedHashMap<Class<? extends Serializable>, Serializable> contributedSettings = new LinkedHashMap<>();@Column(nullable=false)private Date createDate = new Date();@@ -1539,4 +1547,25 @@ public class Project extends AbstractEntity implements NameAware {}}+ @Nullable+ @SuppressWarnings("unchecked")+ public <T extends Serializable> T getContributedSetting(Class<T> settingClass) {+ T contributedSetting = (T) contributedSettings.get(settingClass);+ if (contributedSetting == null) {+ try {+ T value = settingClass.newInstance();+ if (OneDev.getInstance(Validator.class).validate(value).isEmpty())+ contributedSetting = value;+ } catch (InstantiationException | IllegalAccessException e) {+ throw new RuntimeException(e);+ }+ }++ return contributedSetting;+ }++ public void setContributedSetting(Class<? extends Serializable> settingClass, @Nullable Serializable setting) {+ contributedSettings.put(settingClass, setting);+ }+}diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/ProjectPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/ProjectPage.javaindex d8b1081fe5..ddc475d75b 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/ProjectPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/project/ProjectPage.java@@ -1,5 +1,6 @@package io.onedev.server.web.page.project;+import java.io.Serializable;import java.util.ArrayList;import java.util.Collection;import java.util.Comparator;@@ -32,6 +33,7 @@ import io.onedev.server.web.avatar.AvatarManager;import io.onedev.server.web.component.floating.FloatingPanel;import io.onedev.server.web.component.link.ViewStateAwarePageLink;import io.onedev.server.web.component.project.info.ProjectInfoPanel;+import io.onedev.server.web.editable.EditableUtils;import io.onedev.server.web.page.layout.LayoutPage;import io.onedev.server.web.page.layout.SidebarMenu;import io.onedev.server.web.page.layout.SidebarMenuItem;@@ -57,6 +59,7 @@ import io.onedev.server.web.page.project.pullrequests.InvalidPullRequestPage;import io.onedev.server.web.page.project.pullrequests.ProjectPullRequestsPage;import io.onedev.server.web.page.project.pullrequests.create.NewPullRequestPage;import io.onedev.server.web.page.project.pullrequests.detail.PullRequestDetailPage;+import io.onedev.server.web.page.project.setting.ProjectSettingContribution;import io.onedev.server.web.page.project.setting.authorization.ProjectAuthorizationsPage;import io.onedev.server.web.page.project.setting.avatar.AvatarEditPage;import io.onedev.server.web.page.project.setting.branchprotection.BranchProtectionsPage;@@ -65,6 +68,7 @@ import io.onedev.server.web.page.project.setting.build.BuildPreservationsPage;import io.onedev.server.web.page.project.setting.build.DefaultFixedIssueFiltersPage;import io.onedev.server.web.page.project.setting.build.JobSecretsPage;import io.onedev.server.web.page.project.setting.general.GeneralProjectSettingPage;+import io.onedev.server.web.page.project.setting.pluginsettings.ContributedProjectSettingPage;import io.onedev.server.web.page.project.setting.tagprotection.TagProtectionsPage;import io.onedev.server.web.page.project.setting.webhook.WebHooksPage;import io.onedev.server.web.page.project.stats.ProjectContribsPage;@@ -231,6 +235,17 @@ public abstract class ProjectPage extends LayoutPage implements ProjectAware {settingMenuItems.add(new SidebarMenuItem.SubMenu(null, "Build Setting", buildSettingMenuItems));settingMenuItems.add(new SidebarMenuItem.Page(null, "Web Hooks",WebHooksPage.class, WebHooksPage.paramsOf(getProject())));++ for (ProjectSettingContribution contribution:OneDev.getExtensions(ProjectSettingContribution.class)) {+ for (Class<? extends Serializable> settingClass: contribution.getSettingClasses()) {+ settingMenuItems.add(new SidebarMenuItem.Page(+ null,+ EditableUtils.getDisplayName(settingClass),+ ContributedProjectSettingPage.class,+ ContributedProjectSettingPage.paramsOf(getProject(), settingClass)));+ }+ }+menuItems.add(new SidebarMenuItem.SubMenu("sliders", "Settings", settingMenuItems));}diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/ProjectSettingContribution.java b/server-core/src/main/java/io/onedev/server/web/page/project/setting/ProjectSettingContribution.javanew file mode 100644index 0000000000..c0e299c587--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/ProjectSettingContribution.java@@ -0,0 +1,13 @@+package io.onedev.server.web.page.project.setting;++import java.io.Serializable;+import java.util.List;++import io.onedev.commons.launcher.loader.ExtensionPoint;++@ExtensionPoint+public interface ProjectSettingContribution {++ List<Class<? extends Serializable>> getSettingClasses();++}diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/pluginsettings/ContributedProjectSettingPage.html b/server-core/src/main/java/io/onedev/server/web/page/project/setting/pluginsettings/ContributedProjectSettingPage.htmlnew file mode 100644index 0000000000..e6d2c988e3--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/pluginsettings/ContributedProjectSettingPage.html@@ -0,0 +1,20 @@+<wicket:extend>+ <div class="card contributed-setting">+ <div class="card-body">+ <wicket:enclosure child="help">+ <div class="text-muted mb-4">+ <wicket:svg href="bulb" class="icon"/> <span wicket:id="help"></span>+ </div>+ </wicket:enclosure>+ <form wicket:id="form" class="leave-confirm">+ <span class="switch switch-sm switch-primary mb-3">+ <label>+ <input wicket:id="enable" type="checkbox" class="enable">+ </label>+ </span>+ <div wicket:id="editor" class="mb-4"></div>+ <input type="submit" class="btn btn-primary dirty-aware mr-1" value="Save Setting">+ </form>+ </div>+ </div>+</wicket:extend>diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/pluginsettings/ContributedProjectSettingPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/setting/pluginsettings/ContributedProjectSettingPage.javanew file mode 100644index 0000000000..9b24977d21--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/pluginsettings/ContributedProjectSettingPage.java@@ -0,0 +1,164 @@+package io.onedev.server.web.page.project.setting.pluginsettings;++import java.io.Serializable;++import javax.annotation.Nullable;+import javax.validation.Validator;++import org.apache.wicket.Component;+import org.apache.wicket.ajax.AjaxRequestTarget;+import org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior;+import org.apache.wicket.markup.html.WebMarkupContainer;+import org.apache.wicket.markup.html.basic.Label;+import org.apache.wicket.markup.html.form.CheckBox;+import org.apache.wicket.markup.html.form.Form;+import org.apache.wicket.model.IModel;+import org.apache.wicket.request.mapper.parameter.PageParameters;++import io.onedev.server.OneDev;+import io.onedev.server.entitymanager.ProjectManager;+import io.onedev.server.model.Project;+import io.onedev.server.web.editable.BeanContext;+import io.onedev.server.web.editable.BeanEditor;+import io.onedev.server.web.editable.EditableUtils;+import io.onedev.server.web.page.project.setting.ProjectSettingContribution;+import io.onedev.server.web.page.project.setting.ProjectSettingPage;++@SuppressWarnings("serial")+public class ContributedProjectSettingPage extends ProjectSettingPage {++ public static final String PARAM_SETTING = "setting";++ private Class<? extends Serializable> settingClass;++ public ContributedProjectSettingPage(PageParameters params) {+ super(params);++ String settingName = params.get(PARAM_SETTING).toString();++ for (ProjectSettingContribution contribution:+ OneDev.getExtensions(ProjectSettingContribution.class)) {+ for (Class<? extends Serializable> each: contribution.getSettingClasses()) {+ if (getSettingName(each).equals(settingName)) {+ settingClass = each;+ break;+ }+ }+ if (settingClass != null)+ break;+ }++ if (settingClass == null)+ throw new RuntimeException("Unexpected setting: " + settingName);+ }++ @Override+ protected void onInitialize() {+ super.onInitialize();++ String help = EditableUtils.getDescription(settingClass);+ if (help != null)+ add(new Label("help", help).setEscapeModelStrings(false));+ else+ add(new WebMarkupContainer("help").setVisible(false));++ Form<?> form = new Form<Void>("form") {++ @Override+ protected void onSubmit() {+ super.onSubmit();++ Component editor = get("editor");+ if (editor instanceof BeanEditor && editor.isVisible())+ getProject().setContributedSetting(settingClass, ((BeanEditor)editor).getModelObject());+ else+ getProject().setContributedSetting(settingClass, null);++ OneDev.getInstance(ProjectManager.class).save(getProject());++ getSession().success("Setting has been saved");++ setResponsePage(ContributedProjectSettingPage.class, paramsOf(getProject(), settingClass));+ }++ };++ form.add(new CheckBox("enable", new IModel<Boolean>() {++ @Override+ public void detach() {+ }++ @Override+ public Boolean getObject() {+ Component beanEditor = form.get("editor");+ return beanEditor != null && beanEditor.isVisible();+ }++ @Override+ public void setObject(Boolean object) {+ Component beanEditor = form.get("editor");+ if (beanEditor instanceof BeanEditor || !object) {+ beanEditor.setVisible(object);+ } else {+ try {+ form.replace(newBeanEditor(settingClass.newInstance()));+ } catch (InstantiationException | IllegalAccessException e) {+ throw new RuntimeException(e);+ }+ }+ }++ }) {++ @Override+ protected void onConfigure() {+ super.onConfigure();+ try {+ setVisible(!OneDev.getInstance(Validator.class).validate(settingClass.newInstance()).isEmpty());+ } catch (InstantiationException | IllegalAccessException e) {+ throw new RuntimeException(e);+ }+ }++ }.add(new AjaxFormComponentUpdatingBehavior("click"){++ @Override+ protected void onUpdate(AjaxRequestTarget target) {+ target.add(form.get("editor"));+ }++ }));++ Serializable setting = getProject().getContributedSetting(settingClass);+ form.add(newBeanEditor(setting));++ add(form);+ }++ private Component newBeanEditor(@Nullable Serializable setting) {+ Component beanEditor;+ if (setting != null)+ beanEditor = BeanContext.edit("editor", setting);+ else+ beanEditor = new WebMarkupContainer("editor").setVisible(false);+ beanEditor.setOutputMarkupPlaceholderTag(true);+ return beanEditor;+ }++ private static String getSettingName(Class<?> settingClass) {+ return EditableUtils.getDisplayName(settingClass).replace(' ', '-').toLowerCase();+ }++ public static PageParameters paramsOf(Project project, Class<?> settingClass) {+ PageParameters params = ProjectSettingPage.paramsOf(project);+ params.add(PARAM_SETTING, getSettingName(settingClass));+ return params;+ }++ @Override+ protected Component newProjectTitle(String componentId) {+ return new Label(componentId, EditableUtils.getDisplayName(settingClass));+ }++}diff --git a/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenModule.java b/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenModule.javaindex 58e77d4068..64922dae14 100644--- a/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenModule.java+++ b/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenModule.java@@ -1,11 +1,15 @@package io.onedev.server.plugin.buildspec.maven;+import java.io.Serializable;+import java.util.List;+import com.google.common.collect.Lists;import io.onedev.commons.launcher.loader.AbstractPluginModule;import io.onedev.server.buildspec.job.JobSuggestion;import io.onedev.server.model.support.administration.GroovyScript;import io.onedev.server.util.script.ScriptContribution;+import io.onedev.server.web.page.project.setting.ProjectSettingContribution;/*** NOTE: Do not forget to rename moduleClass property defined in the pom if you've renamed this class.@@ -31,6 +35,16 @@ public class MavenModule extends AbstractPluginModule {}});++ contribute(ProjectSettingContribution.class, new ProjectSettingContribution() {++ @Override+ public List<Class<? extends Serializable>> getSettingClasses() {+ return Lists.newArrayList(MavenSetting.class);+ }++ });+}}diff --git a/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenSetting.java b/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenSetting.javanew file mode 100644index 0000000000..80b7194ad6--- /dev/null+++ b/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenSetting.java@@ -0,0 +1,26 @@+package io.onedev.server.plugin.buildspec.maven;++import java.io.Serializable;++import org.hibernate.validator.constraints.NotEmpty;++import io.onedev.server.web.editable.annotation.Editable;++@Editable+public class MavenSetting implements Serializable {++ private static final long serialVersionUID = 1L;++ private String mavenPath;++ @Editable+ @NotEmpty+ public String getMavenPath() {+ return mavenPath;+ }++ public void setMavenPath(String mavenPath) {+ this.mavenPath = mavenPath;+ }++}