Skip to content

The Unified and Autonomous Development Platform

feat: Refactor wiki management and enhance folder structure

Robin Shen0ea4bd086357
diff --git a/server-core/src/main/java/io/onedev/server/annotation/Wiki.java b/server-core/src/main/java/io/onedev/server/annotation/Wiki.java
new file mode 100644
index 0000000000..314c0c510a
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/annotation/Wiki.java
@@ -0,0 +1,11 @@
+package io.onedev.server.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.FIELD})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Wiki {
+}
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.java
index e724d599fa..aaea88785f 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
@@ -1,6 +1,8 @@
package io.onedev.server.model;
-import io.onedev.server.model.support.WikiSetting;
+import io.onedev.server.model.support.wiki.WikiFolder;
+import io.onedev.server.model.support.wiki.WikiSetting;
+import io.onedev.server.model.support.wiki.SpecifiedPath;
import static io.onedev.commons.utils.match.WildcardUtils.matchPath;
import static io.onedev.server.model.Project.PROP_NAME;
@@ -1062,7 +1064,9 @@ public class Project extends AbstractEntity implements LabelSupport<ProjectLabel
this.codeManagement = codeManagement;
}
- @Editable(order=275, description="Whether or not to enable wiki management for the project")
+ @Editable(order=275, description="""
+ Whether or not to enable wiki management for the project. Wiki pages
+ are accessible to all users with access to the project""")
@DependsOn(property="codeManagement")
public boolean isWikiManagement() {
return wikiManagement;
@@ -1169,12 +1173,12 @@ public class Project extends AbstractEntity implements LabelSupport<ProjectLabel
this.wikiSetting = wikiSetting;
}
- public String getWikiFolder() {
+ public WikiFolder getWikiFolder() {
for (Project current = this; current != null; current = current.getParent()) {
if (current.getWikiSetting().getFolder() != null)
return current.getWikiSetting().getFolder();
}
- return "wiki";
+ return new SpecifiedPath();
}
public CodeAnalysisSetting getCodeAnalysisSetting() {
diff --git a/server-core/src/main/java/io/onedev/server/model/support/WikiSetting.java b/server-core/src/main/java/io/onedev/server/model/support/WikiSetting.java
deleted file mode 100644
index 7a27c1f737..0000000000
--- a/server-core/src/main/java/io/onedev/server/model/support/WikiSetting.java
+++ /dev/null
@@ -1,26 +0,0 @@
-package io.onedev.server.model.support;
-
-import io.onedev.server.annotation.Editable;
-import io.onedev.server.annotation.Path;
-import org.jspecify.annotations.Nullable;
-
-import java.io.Serializable;
-
-@Editable
-public class WikiSetting implements Serializable {
- private static final long serialVersionUID = 1L;
- private String folder;
-
- @Editable(name="Wiki Folder", placeholder="Inherit from parent", rootPlaceholder="wiki",
- description="Repository folder containing Markdown wiki pages. Leave empty to inherit from parent (defaults to wiki). "
- + "Use Home.md for the home page and _Sidebar.md for the sidebar")
- @Path(Path.Type.RELATIVE)
- @Nullable
- public String getFolder() {
- return folder;
- }
-
- public void setFolder(@Nullable String folder) {
- this.folder = folder;
- }
-}
diff --git a/server-core/src/main/java/io/onedev/server/model/support/wiki/RepositoryRoot.java b/server-core/src/main/java/io/onedev/server/model/support/wiki/RepositoryRoot.java
new file mode 100644
index 0000000000..fc2d5b045e
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/model/support/wiki/RepositoryRoot.java
@@ -0,0 +1,18 @@
+package io.onedev.server.model.support.wiki;
+
+import org.jspecify.annotations.Nullable;
+
+import io.onedev.server.annotation.Editable;
+
+@Editable(name="Repository Root")
+public class RepositoryRoot implements WikiFolder {
+
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ @Nullable
+ public String getPath() {
+ return null;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/model/support/wiki/SpecifiedPath.java b/server-core/src/main/java/io/onedev/server/model/support/wiki/SpecifiedPath.java
new file mode 100644
index 0000000000..52d7341fa6
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/model/support/wiki/SpecifiedPath.java
@@ -0,0 +1,27 @@
+package io.onedev.server.model.support.wiki;
+
+import javax.validation.constraints.NotEmpty;
+
+import io.onedev.server.annotation.Editable;
+import io.onedev.server.annotation.Path;
+
+@Editable(name="Specified Path")
+public class SpecifiedPath implements WikiFolder {
+
+ private static final long serialVersionUID = 1L;
+
+ private String path = "wiki";
+
+ @Override
+ @Editable
+ @Path(Path.Type.RELATIVE)
+ @NotEmpty
+ public String getPath() {
+ return path;
+ }
+
+ public void setPath(String path) {
+ this.path = path;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiFolder.java b/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiFolder.java
new file mode 100644
index 0000000000..4d15ac2800
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiFolder.java
@@ -0,0 +1,15 @@
+package io.onedev.server.model.support.wiki;
+
+import java.io.Serializable;
+
+import org.jspecify.annotations.Nullable;
+
+import io.onedev.server.annotation.Editable;
+
+@Editable
+public interface WikiFolder extends Serializable {
+
+ @Nullable
+ String getPath();
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiSetting.java b/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiSetting.java
new file mode 100644
index 0000000000..82ff53b1c9
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiSetting.java
@@ -0,0 +1,26 @@
+package io.onedev.server.model.support.wiki;
+
+import io.onedev.server.annotation.Editable;
+
+import javax.validation.Valid;
+import org.jspecify.annotations.Nullable;
+
+import java.io.Serializable;
+
+@Editable
+public class WikiSetting implements Serializable {
+ private static final long serialVersionUID = 1L;
+ private WikiFolder folder;
+
+ @Editable(name="Wiki Folder", placeholder="Inherit from parent", rootPlaceholder="Use folder 'wiki'",
+ description="Repository root or specified folder containing Markdown wiki pages. Leave empty to inherit from parent (defaults to wiki)")
+ @Valid
+ public WikiFolder getFolder() {
+ return folder;
+ }
+
+ public void setFolder(@Nullable WikiFolder folder) {
+ this.folder = folder;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/ProjectResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/ProjectResource.java
index 5babb87b08..628acc27ee 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/ProjectResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/ProjectResource.java
@@ -1,7 +1,5 @@
package io.onedev.server.rest.resource;
-import io.onedev.server.model.support.WikiSetting;
-
import static io.onedev.server.util.DateUtils.parseISO8601Date;
import static io.onedev.server.util.DateUtils.toLocalDate;
import static java.time.ZoneId.systemDefault;
@@ -63,6 +61,7 @@ import io.onedev.server.model.support.code.TagProtection;
import io.onedev.server.model.support.issue.ProjectIssueSetting;
import io.onedev.server.model.support.pack.ProjectPackSetting;
import io.onedev.server.model.support.pullrequest.ProjectPullRequestSetting;
+import io.onedev.server.model.support.wiki.WikiSetting;
import io.onedev.server.model.support.workspace.ProjectWorkspaceSetting;
import io.onedev.server.persistence.dao.EntityCriteria;
import io.onedev.server.rest.annotation.Api;
diff --git a/server-core/src/main/java/io/onedev/server/security/SecurityUtils.java b/server-core/src/main/java/io/onedev/server/security/SecurityUtils.java
index 0af2768059..f5da706bc0 100644
--- a/server-core/src/main/java/io/onedev/server/security/SecurityUtils.java
+++ b/server-core/src/main/java/io/onedev/server/security/SecurityUtils.java
@@ -3,6 +3,8 @@ package io.onedev.server.security;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Collectors.toSet;
+import io.onedev.server.web.util.WikiUtils;
+
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
@@ -297,7 +299,7 @@ public class SecurityUtils extends org.apache.shiro.SecurityUtils {
public static boolean canReadFile(Subject subject, Project project, String file) {
return canReadCode(subject, project)
|| project.isWikiManagement()
- && file.startsWith(project.getWikiFolder() + "/")
+ && WikiUtils.isUnderFolder(project.getWikiFolder().getPath(), file)
&& canAccessProject(subject, project);
}
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentEditSupport.java b/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiEditSupport.java
similarity index 53%
rename from server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentEditSupport.java
rename to server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiEditSupport.java
index 0ec9667e41..48cb5e5e85 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentEditSupport.java
+++ b/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiEditSupport.java
@@ -1,39 +1,36 @@
package io.onedev.server.web.editable.wiki;
-import java.nio.charset.StandardCharsets;
-
import org.apache.wicket.Component;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
+import io.onedev.server.annotation.Wiki;
import io.onedev.server.web.component.markdown.MarkdownViewer;
import io.onedev.server.web.editable.EditSupport;
import io.onedev.server.web.editable.PropertyContext;
import io.onedev.server.web.editable.PropertyDescriptor;
import io.onedev.server.web.editable.PropertyEditor;
import io.onedev.server.web.editable.PropertyViewer;
-import io.onedev.server.web.page.project.wiki.WikiPageBean;
-/** Retains repository-aware Markdown editing inside the standard bean editor. */
-public class WikiPageContentEditSupport implements EditSupport {
+public class WikiEditSupport implements EditSupport {
@Override
public PropertyContext<?> getEditContext(PropertyDescriptor descriptor) {
- if (descriptor.getBeanClass() != WikiPageBean.class || !descriptor.getPropertyName().equals("content"))
+ if (descriptor.getPropertyGetter().getReturnType() != String.class
+ || descriptor.getPropertyGetter().getAnnotation(Wiki.class) == null)
return null;
- return new PropertyContext<byte[]>(descriptor) {
+ return new PropertyContext<String>(descriptor) {
@Override
- public PropertyEditor<byte[]> renderForEdit(String id, IModel<byte[]> model) {
- return new WikiPageContentPropertyEditor(id, descriptor, model);
+ public PropertyEditor<String> renderForEdit(String id, IModel<String> model) {
+ return new WikiPropertyEditor(id, descriptor, model);
}
@Override
- public PropertyViewer renderForView(String id, IModel<byte[]> model) {
+ public PropertyViewer renderForView(String id, IModel<String> model) {
return new PropertyViewer(id, descriptor) {
@Override
protected Component newContent(String id, PropertyDescriptor descriptor) {
- return new MarkdownViewer(id, Model.of(model.getObject() != null
- ? new String(model.getObject(), StandardCharsets.UTF_8) : ""), null);
+ return new MarkdownViewer(id, Model.of(model.getObject()), null);
}
};
}
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentPropertyEditor.html b/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPropertyEditor.html
similarity index 100%
rename from server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentPropertyEditor.html
rename to server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPropertyEditor.html
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentPropertyEditor.java b/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPropertyEditor.java
similarity index 60%
rename from server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentPropertyEditor.java
rename to server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPropertyEditor.java
index 1b38678315..c03aa40724 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPageContentPropertyEditor.java
+++ b/server-core/src/main/java/io/onedev/server/web/editable/wiki/WikiPropertyEditor.java
@@ -1,5 +1,7 @@
package io.onedev.server.web.editable.wiki;
+import java.nio.charset.StandardCharsets;
+
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
@@ -8,24 +10,26 @@ import io.onedev.server.web.editable.PropertyDescriptor;
import io.onedev.server.web.editable.PropertyEditor;
import io.onedev.server.web.page.project.wiki.ProjectWikiPage;
-public class WikiPageContentPropertyEditor extends PropertyEditor<byte[]> {
+public class WikiPropertyEditor extends PropertyEditor<String> {
private BlobMarkdownEditor input;
- public WikiPageContentPropertyEditor(String id, PropertyDescriptor descriptor, IModel<byte[]> model) {
+ public WikiPropertyEditor(String id, PropertyDescriptor descriptor, IModel<String> model) {
super(id, descriptor, model);
}
@Override
protected void onInitialize() {
super.onInitialize();
- input = findParent(ProjectWikiPage.class).newContentEditor("input", Model.of(getModelObject()));
+ String content = getModelObject();
+ input = findParent(ProjectWikiPage.class).newContentEditor("input", Model.of(
+ content != null ? content.getBytes(StandardCharsets.UTF_8) : new byte[0]));
add(input);
}
@Override
- protected byte[] convertInputToValue() {
- return input.getConvertedInput();
+ protected String convertInputToValue() {
+ return new String(input.getConvertedInput(), StandardCharsets.UTF_8);
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/wiki/WikiSettingPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/setting/wiki/WikiSettingPage.java
index bb52fd6f4d..eaa614b069 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/setting/wiki/WikiSettingPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/wiki/WikiSettingPage.java
@@ -13,7 +13,7 @@ import io.onedev.server.OneDev;
import io.onedev.server.data.migration.VersionedXmlDoc;
import io.onedev.server.service.ProjectService;
import io.onedev.server.model.Project;
-import io.onedev.server.model.support.WikiSetting;
+import io.onedev.server.model.support.wiki.WikiSetting;
import io.onedev.server.security.SecurityUtils;
import io.onedev.server.web.component.link.ViewStateAwarePageLink;
import io.onedev.server.web.editable.BeanContext;
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.html b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.html
index f406fe9ed5..30831121c7 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.html
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.html
@@ -32,8 +32,13 @@
</div>
<div wicket:id="view" class="wiki-view flex-grow-1 d-flex overflow-hidden">
<main class="wiki-content flex-grow-1 overflow-auto p-4">
+ <wicket:enclosure>
+ <div class="alert alert-notice alert-light-warning">
+ <wicket:t>Home page not found</wicket:t>
+ <a wicket:id="addHome" class="ml-2" t:data-tippy-content="Add home page" t:aria-label="Add home page"><wicket:svg href="plus" class="icon"></wicket:svg></a>
+ </div>
+ </wicket:enclosure>
<div wicket:id="body"></div>
- <a wicket:id="addHome" class="d-inline-block mt-3"><wicket:t>Add Home page</wicket:t></a>
</main>
<aside wicket:id="navigation" class="wiki-navigation markdown-outline side need-width">
<div class="ui-resizable-handle ui-resizable-w flex-shrink-0"></div>
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java
index 58274d7398..ed5573ea39 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java
@@ -10,11 +10,11 @@ import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.lang3.SerializationUtils;
-import javax.validation.ConstraintValidatorContext;
import org.apache.shiro.authz.UnauthorizedException;
import org.apache.wicket.AttributeModifier;
@@ -43,6 +43,7 @@ import org.apache.wicket.model.IModel;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.eclipse.jgit.lib.FileMode;
+import org.jspecify.annotations.Nullable;
import org.eclipse.jgit.lib.ObjectId;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Element;
@@ -99,7 +100,7 @@ import io.onedev.server.web.editable.BeanEditor;
public class ProjectWikiPage extends ProjectPage {
private String revision;
private String page;
- private final String folder;
+ private final @Nullable String folder;
private final boolean editing;
private final boolean creating;
private String returnPage;
@@ -129,7 +130,7 @@ public class ProjectWikiPage extends ProjectPage {
}
revision = revisionAndPath.getRevision();
page = revisionAndPath.getPath() != null ? revisionAndPath.getPath() : "Home";
- folder = getProject().getWikiFolder();
+ folder = getProject().getWikiFolder().getPath();
WikiUtils.pagePath(folder, page);
editing = params.get("edit").toBoolean(false);
creating = params.get("new").toBoolean(false);
@@ -288,16 +289,16 @@ public class ProjectWikiPage extends ProjectPage {
});
wiki.add(view);
- var bean = new WikiPageBean();
+ var bean = new WikiEditBean();
bean.setName(creating ? getPageParameters().get("initial-name").toString("") : page);
- bean.setContent((creating || content == null ? "" : content).getBytes(StandardCharsets.UTF_8));
+ bean.setContent(creating || content == null ? "" : content);
pageEditor = BeanContext.edit("editor", bean);
Form<Void> form = new Form<>("form");
form.add(pageEditor);
form.add(new Button("save") {
@Override
public void onSubmit() {
- save(form, bean.getName(), new String(bean.getContent(), StandardCharsets.UTF_8),
+ save(form, bean.getName(), bean.getContent(),
bean.getCommitMessage(), false, content != null);
}
});
@@ -309,9 +310,9 @@ public class ProjectWikiPage extends ProjectPage {
}
private String getEditedPageName() {
- var bean = (WikiPageBean) pageEditor.getConvertedInput();
+ var bean = (WikiEditBean) pageEditor.getConvertedInput();
if (bean == null)
- bean = (WikiPageBean) pageEditor.getModelObject();
+ bean = (WikiEditBean) pageEditor.getModelObject();
return bean.getName();
}
@@ -413,7 +414,7 @@ public class ProjectWikiPage extends ProjectPage {
@Override
public void onSelect(AjaxRequestTarget target, String selectedPath, boolean image, String label) {
- if (!image && selectedPath.startsWith(folder + "/") && selectedPath.endsWith(".md")) {
+ if (!image && WikiUtils.isUnderFolder(folder, selectedPath) && selectedPath.endsWith(".md")) {
insertText(target, WikiUtils.pageReference(folder, getEditorPath(), selectedPath, label));
} else {
var ident = new BlobIdent(revision, selectedPath, FileMode.REGULAR_FILE.getBits());
@@ -435,32 +436,20 @@ public class ProjectWikiPage extends ProjectPage {
return defaultCommitMessage(name, false, !creating && read(page) != null);
}
- public boolean validatePage(WikiPageBean bean, ConstraintValidatorContext context) {
- String name = bean.getName();
- if (name == null || name.isBlank())
- return true; // The name property's constraint supplies this error.
- name = name.trim().replace(' ', '-');
- if (PathValidator.checkPath(io.onedev.server.annotation.Path.Type.RELATIVE, name) != null)
- return true;
- boolean valid = true;
- if ((creating || !name.equals(page)) && commitId != null
- && getProject().getBlob(new BlobIdent(commitId.name(), WikiUtils.pagePath(folder, name)), false) != null) {
- context.disableDefaultConstraintViolation();
- context.buildConstraintViolationWithTemplate(_T("A page with this name already exists."))
- .addPropertyNode("name").addConstraintViolation();
- valid = false;
- }
- String message = bean.getCommitMessage();
- if (message == null || message.isBlank())
- message = getDefaultPageCommitMessage(name);
- String error = getProject().getBranchProtection(revision != null ? revision : "main", SecurityUtils.getAuthUser())
- .checkCommitMessage(message, false);
- if (error != null) {
- context.disableDefaultConstraintViolation();
- context.buildConstraintViolationWithTemplate(error).addPropertyNode("commitMessage").addConstraintViolation();
- valid = false;
- }
- return valid;
+ String getRevision() {
+ return revision;
+ }
+
+ String getPageName() {
+ return page;
+ }
+
+ boolean isCreating() {
+ return creating;
+ }
+
+ ObjectId getCommitId() {
+ return commitId;
}
private WebMarkupContainer newActions(String path, String content) {
@@ -762,14 +751,15 @@ public class ProjectWikiPage extends ProjectPage {
return blob.getText().getContent();
}
- private void collectPages(String directory, List<String> pages) {
- var ident = git().getBlobIdent(getProject(), commitId, directory);
+ private void collectPages(@Nullable String directory, List<String> pages) {
+ var ident = directory != null ? git().getBlobIdent(getProject(), commitId, directory)
+ : new BlobIdent(commitId.name(), null, FileMode.TREE.getBits());
if (ident != null && ident.isTree()) {
for (var child : git().getChildren(getProject(), commitId, directory, BlobIdentFilter.ALL, false)) {
if (child.isTree()) {
collectPages(child.path, pages);
} else if (child.isFile() && child.path.endsWith(".md")) {
- String name = child.path.substring(folder.length() + 1, child.path.length() - 3);
+ String name = child.path.substring(folder != null ? folder.length() + 1 : 0, child.path.length() - 3);
if (!name.equals("_Sidebar"))
pages.add(name);
}
@@ -799,7 +789,7 @@ public class ProjectWikiPage extends ProjectPage {
}
private boolean canEdit(String path) {
- return folder.equals(getProject().getWikiFolder()) && SecurityUtils.canEditWikiPage(getProject(), revision, path);
+ return Objects.equals(folder, getProject().getWikiFolder().getPath()) && SecurityUtils.canEditWikiPage(getProject(), revision, path);
}
private void save(Form<?> form, String name, String text, String message, boolean delete, boolean existed) {
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/WikiEditBean.java b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/WikiEditBean.java
new file mode 100644
index 0000000000..d9d2b59aa8
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/WikiEditBean.java
@@ -0,0 +1,106 @@
+package io.onedev.server.web.page.project.wiki;
+
+import static io.onedev.server.web.translation.Translation._T;
+
+import java.io.Serializable;
+
+import javax.validation.ConstraintValidatorContext;
+import javax.validation.constraints.NotEmpty;
+
+import io.onedev.server.annotation.ClassValidating;
+import io.onedev.server.annotation.Editable;
+import io.onedev.server.annotation.Multiline;
+import io.onedev.server.annotation.OmitName;
+import io.onedev.server.annotation.Path;
+import io.onedev.server.annotation.Wiki;
+import io.onedev.server.git.BlobIdent;
+import io.onedev.server.security.SecurityUtils;
+import io.onedev.server.util.EditContext;
+import io.onedev.server.util.HierarchicalContext;
+import io.onedev.server.validation.Validatable;
+import io.onedev.server.web.util.WicketUtils;
+import io.onedev.server.web.util.WikiUtils;
+
+@Editable
+@ClassValidating
+public class WikiEditBean implements Serializable, Validatable {
+
+ private static final long serialVersionUID = 1L;
+
+ private String name;
+
+ private String content;
+
+ private String commitMessage;
+
+ @Editable(order=100, name="Page name")
+ @NotEmpty
+ @Path(Path.Type.RELATIVE)
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ @Editable(order=200)
+ @OmitName
+ @NotEmpty
+ @Wiki
+ public String getContent() {
+ return content;
+ }
+
+ public void setContent(String content) {
+ this.content = content;
+ }
+
+ @Editable(order=300, name="Commit message", placeholderProvider="getDefaultCommitMessage")
+ @Multiline
+ public String getCommitMessage() {
+ return commitMessage;
+ }
+
+ public void setCommitMessage(String commitMessage) {
+ this.commitMessage = commitMessage;
+ }
+
+ @SuppressWarnings("unused")
+ private static String getDefaultCommitMessage() {
+ String name = (String) EditContext.get().getInputValue("name");
+ return HierarchicalContext.get().findData(ProjectWikiPage.class).getDefaultPageCommitMessage(name);
+ }
+
+ @Override
+ public boolean isValid(ConstraintValidatorContext context) {
+ if (name != null)
+ name = name.replace(' ', '-');
+
+ var page = (ProjectWikiPage)WicketUtils.getPage();
+
+ var project = page.getProject();
+ var commitId = page.getCommitId();
+ var revision = page.getRevision();
+ boolean valid = true;
+ if ((page.isCreating() || !name.equals(page.getPageName())) && commitId != null
+ && project.getBlob(new BlobIdent(commitId.name(), WikiUtils.pagePath(project.getWikiFolder().getPath(), name)), false) != null) {
+ context.disableDefaultConstraintViolation();
+ context.buildConstraintViolationWithTemplate(_T("A page with this name already exists."))
+ .addPropertyNode("name").addConstraintViolation();
+ valid = false;
+ }
+ String message = getCommitMessage();
+ if (message == null)
+ message = page.getDefaultPageCommitMessage(name);
+ String error = project.getBranchProtection(revision != null ? revision : "main", SecurityUtils.getAuthUser())
+ .checkCommitMessage(message, false);
+ if (error != null) {
+ context.disableDefaultConstraintViolation();
+ context.buildConstraintViolationWithTemplate(error).addPropertyNode("commitMessage").addConstraintViolation();
+ valid = false;
+ }
+ return valid;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/WikiPageBean.java b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/WikiPageBean.java
deleted file mode 100644
index 55e95d2ff2..0000000000
--- a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/WikiPageBean.java
+++ /dev/null
@@ -1,69 +0,0 @@
-package io.onedev.server.web.page.project.wiki;
-
-import java.io.Serializable;
-
-import javax.validation.ConstraintValidatorContext;
-import javax.validation.constraints.NotEmpty;
-
-import io.onedev.server.annotation.ClassValidating;
-import io.onedev.server.annotation.Editable;
-import io.onedev.server.annotation.Multiline;
-import io.onedev.server.annotation.OmitName;
-import io.onedev.server.annotation.Path;
-import io.onedev.server.util.EditContext;
-import io.onedev.server.util.HierarchicalContext;
-import io.onedev.server.validation.Validatable;
-
-@Editable
-@ClassValidating
-public class WikiPageBean implements Serializable, Validatable {
-
- private static final long serialVersionUID = 1L;
-
- private String name;
- private byte[] content = new byte[0];
- private String commitMessage;
-
- @Editable(order=100, name="Page name")
- @NotEmpty
- @Path(Path.Type.RELATIVE)
- public String getName() {
- return name;
- }
-
- public void setName(String name) {
- this.name = name;
- }
-
- @Editable(order=200)
- @OmitName
- public byte[] getContent() {
- return content;
- }
-
- public void setContent(byte[] content) {
- this.content = content;
- }
-
- @Editable(order=300, name="Commit message", placeholderProvider="getDefaultCommitMessage")
- @Multiline
- public String getCommitMessage() {
- return commitMessage;
- }
-
- public void setCommitMessage(String commitMessage) {
- this.commitMessage = commitMessage;
- }
-
- @SuppressWarnings("unused")
- private static String getDefaultCommitMessage() {
- String name = (String) EditContext.get().getInputValue("name");
- return HierarchicalContext.get().findData(ProjectWikiPage.class).getDefaultPageCommitMessage(name);
- }
-
- @Override
- public boolean isValid(ConstraintValidatorContext context) {
- return HierarchicalContext.get().findData(ProjectWikiPage.class).validatePage(this, context);
- }
-
-}
diff --git a/server-core/src/main/java/io/onedev/server/web/util/WikiLinkResolver.java b/server-core/src/main/java/io/onedev/server/web/util/WikiLinkResolver.java
index f6b1b73497..0895ef4c89 100644
--- a/server-core/src/main/java/io/onedev/server/web/util/WikiLinkResolver.java
+++ b/server-core/src/main/java/io/onedev/server/web/util/WikiLinkResolver.java
@@ -1,5 +1,7 @@
package io.onedev.server.web.util;
+import java.util.Objects;
+
import org.apache.wicket.request.Url;
import org.apache.wicket.request.cycle.RequestCycle;
import org.eclipse.jgit.lib.FileMode;
@@ -24,11 +26,11 @@ public class WikiLinkResolver {
private final Project project;
private final String revision;
- private final String folder;
+ private final @Nullable String folder;
private final String currentPath;
private final String returnPage;
- public WikiLinkResolver(Project project, @Nullable String revision, String folder,
+ public WikiLinkResolver(Project project, @Nullable String revision, @Nullable String folder,
String currentPath, String returnPage) {
this.project = project;
this.revision = revision;
@@ -47,11 +49,11 @@ public class WikiLinkResolver {
String path = blobIdent.path;
if (context.getMode() == BlobRenderContext.Mode.ADD || context.getMode() == BlobRenderContext.Mode.EDIT)
path = context.getNewPath();
- String folder = project.getWikiFolder();
- if (path == null || !path.startsWith(folder + "/") || !path.endsWith(".md"))
+ String folder = project.getWikiFolder().getPath();
+ if (path == null || !WikiUtils.isUnderFolder(folder, path) || !path.endsWith(".md"))
return html;
- String currentPage = path.substring(folder.length() + 1, path.length() - 3);
+ String currentPage = path.substring(folder != null ? folder.length() + 1 : 0, path.length() - 3);
return new WikiLinkResolver(project, blobIdent.revision, folder, path, currentPage).resolvePageLinks(html);
}
@@ -72,7 +74,7 @@ public class WikiLinkResolver {
}
private String pageName(String path) {
- return path.substring(folder.length() + 1, path.length() - 3);
+ return path.substring(folder != null ? folder.length() + 1 : 0, path.length() - 3);
}
private String pageUrl(String path) {
@@ -103,7 +105,7 @@ public class WikiLinkResolver {
}
private @Nullable String addPageUrl(String path) {
- if (!folder.equals(project.getWikiFolder()) || !WikiUtils.isUnderFolder(folder, path)
+ if (!Objects.equals(folder, project.getWikiFolder().getPath()) || !WikiUtils.isUnderFolder(folder, path)
|| !SecurityUtils.canEditWikiPage(project, revision, path))
return null;
String destination = pageName(path);
diff --git a/server-core/src/main/java/io/onedev/server/web/util/WikiUtils.java b/server-core/src/main/java/io/onedev/server/web/util/WikiUtils.java
index 8b70469171..e634ab3c95 100644
--- a/server-core/src/main/java/io/onedev/server/web/util/WikiUtils.java
+++ b/server-core/src/main/java/io/onedev/server/web/util/WikiUtils.java
@@ -22,8 +22,8 @@ public class WikiUtils {
private static final Pattern REFERENCE = Pattern.compile("\\[\\[([^\\]\\r\\n]+)\\]\\]");
- public static boolean isUnderFolder(String folder, String path) {
- return path != null && path.startsWith(folder + "/");
+ public static boolean isUnderFolder(@Nullable String folder, String path) {
+ return path != null && (folder == null || path.startsWith(folder + "/"));
}
public static void validatePath(String path) {
@@ -32,10 +32,11 @@ public class WikiUtils {
throw new NotAcceptableException(error);
}
- public static String pagePath(String folder, String page) {
- validatePath(folder);
+ public static String pagePath(@Nullable String folder, String page) {
+ if (folder != null)
+ validatePath(folder);
validatePath(page);
- return normalizePath(folder + "/" + page + ".md");
+ return normalizePath((folder != null ? folder + "/" : "") + page + ".md");
}
/** Use the same path for permission checks and Git writes. */
@@ -47,8 +48,8 @@ public class WikiUtils {
return normalized;
}
- public static String pageReference(String folder, String currentPath, String path, String text) {
- if (!path.startsWith(folder + "/") || !path.endsWith(".md"))
+ public static String pageReference(@Nullable String folder, String currentPath, String path, String text) {
+ if (!isUnderFolder(folder, path) || !path.endsWith(".md"))
throw new IllegalArgumentException("Not a wiki page");
validatePath(path);
int slash = currentPath.lastIndexOf('/');
diff --git a/server-core/src/test/java/io/onedev/server/web/editable/polymorphic/PolymorphicPropertyEditorTest.java b/server-core/src/test/java/io/onedev/server/web/editable/polymorphic/PolymorphicPropertyEditorTest.java
new file mode 100644
index 0000000000..7b8e17940f
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/web/editable/polymorphic/PolymorphicPropertyEditorTest.java
@@ -0,0 +1,67 @@
+package io.onedev.server.web.editable.polymorphic;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.mockStatic;
+
+import java.util.Set;
+
+import org.apache.wicket.markup.head.IHeaderResponse;
+import org.apache.wicket.model.Model;
+import org.apache.wicket.util.tester.WicketTester;
+import org.jsoup.Jsoup;
+import org.junit.Test;
+
+import io.onedev.commons.loader.AppLoader;
+import io.onedev.commons.loader.DefaultImplementationRegistry;
+import io.onedev.commons.loader.ImplementationRegistry;
+import io.onedev.server.model.Project;
+import io.onedev.server.model.support.wiki.WikiSetting;
+import io.onedev.server.web.editable.PropertyDescriptor;
+import io.onedev.server.web.translation.Translation;
+import io.onedev.server.web.util.ProjectAware;
+
+public class PolymorphicPropertyEditorTest {
+
+ @Test
+ public void displaysProjectSpecificFolderPlaceholder() {
+ var tester = new WicketTester();
+ tester.getApplication().getResourceSettings().setThrowExceptionOnMissingResource(false);
+ try (var loader = mockStatic(AppLoader.class); var translation = mockStatic(Translation.class)) {
+ loader.when(() -> AppLoader.getInstance(ImplementationRegistry.class))
+ .thenReturn(new DefaultImplementationRegistry(Set.of()));
+ translation.when(() -> Translation._T("Inherit from parent")).thenReturn("Inherit from parent");
+ translation.when(() -> Translation._T("Use wiki folder")).thenReturn("Use wiki folder");
+ var parent = new Project();
+ var child = new Project();
+ child.setParent(parent);
+ for (var project : new Project[] {parent, child}) {
+ var editor = new ProjectFolderEditor(project);
+ tester.startComponentInPage(editor);
+ var document = Jsoup.parse(tester.getLastResponseAsString());
+ assertEquals(project == parent ? "Use wiki folder" : "Inherit from parent",
+ document.selectFirst("select option[value='']").text());
+ }
+ } finally {
+ tester.destroy();
+ }
+ }
+ private static class ProjectFolderEditor extends PolymorphicPropertyEditor implements ProjectAware {
+
+ private final Project project;
+
+ ProjectFolderEditor(Project project) {
+ super("editor", new PropertyDescriptor(WikiSetting.class, "folder"), Model.of());
+ this.project = project;
+ }
+
+ @Override
+ public Project getProject() {
+ return project;
+ }
+
+ @Override
+ public void renderHead(IHeaderResponse response) {
+ }
+ }
+
+}
diff --git a/server-core/src/test/java/io/onedev/server/web/page/project/wiki/WikiPageBeanTest.java b/server-core/src/test/java/io/onedev/server/web/page/project/wiki/WikiPageBeanTest.java
deleted file mode 100644
index d11e1ba33e..0000000000
--- a/server-core/src/test/java/io/onedev/server/web/page/project/wiki/WikiPageBeanTest.java
+++ /dev/null
@@ -1,36 +0,0 @@
-package io.onedev.server.web.page.project.wiki;
-
-import static org.junit.Assert.*;
-
-import javax.validation.Validation;
-
-import org.junit.Test;
-
-import io.onedev.server.web.editable.PropertyDescriptor;
-import io.onedev.server.web.editable.wiki.WikiPageContentEditSupport;
-
-public class WikiPageBeanTest {
-
- @Test
- public void validatesPageNamesOnTheirProperty() {
- try (var factory = Validation.buildDefaultValidatorFactory()) {
- var validator = factory.getValidator();
- for (String name : new String[] {null, "", "../outside", "/absolute", "docs/../../outside"}) {
- var violations = validator.validateValue(WikiPageBean.class, "name", name);
- assertFalse("Expected invalid name: " + name, violations.isEmpty());
- assertTrue(violations.stream().allMatch(it -> it.getPropertyPath().toString().equals("name")));
- }
- for (String name : new String[] {"Home", "Guides/Setup", "Getting started"})
- assertTrue(validator.validateValue(WikiPageBean.class, "name", name).isEmpty());
- assertTrue(validator.validateValue(WikiPageBean.class, "commitMessage", null).isEmpty());
- }
- }
-
- @Test
- public void usesCustomEditorOnlyForWikiContent() {
- var support = new WikiPageContentEditSupport();
- assertNotNull(support.getEditContext(new PropertyDescriptor(WikiPageBean.class, "content")));
- assertNull(support.getEditContext(new PropertyDescriptor(WikiPageBean.class, "name")));
- assertNull(support.getEditContext(new PropertyDescriptor(WikiPageBean.class, "commitMessage")));
- }
-}
diff --git a/server-core/src/test/java/io/onedev/server/web/util/WikiLinkResolverTest.java b/server-core/src/test/java/io/onedev/server/web/util/WikiLinkResolverTest.java
index a007de798f..7f6da73543 100644
--- a/server-core/src/test/java/io/onedev/server/web/util/WikiLinkResolverTest.java
+++ b/server-core/src/test/java/io/onedev/server/web/util/WikiLinkResolverTest.java
@@ -13,6 +13,8 @@ import org.jsoup.Jsoup;
import org.junit.Test;
import io.onedev.server.model.Project;
+import io.onedev.server.model.support.wiki.SpecifiedPath;
+import io.onedev.server.model.support.wiki.RepositoryRoot;
import io.onedev.server.git.BlobIdent;
import io.onedev.server.web.page.project.blob.render.BlobRenderContext;
import io.onedev.server.web.page.project.blob.render.BlobRenderContext.Mode;
@@ -28,7 +30,7 @@ public class WikiLinkResolverTest {
public void wikiReferencesResolveInViewsAndEditorPreviews() {
Project project = mock(Project.class);
when(project.getPath()).thenReturn("project");
- when(project.getWikiFolder()).thenReturn("docs/wiki");
+ when(project.getWikiFolder()).thenReturn(specifiedPath("docs/wiki"));
BlobRenderContext context = mock(BlobRenderContext.class);
when(context.getProject()).thenReturn(project);
when(context.getBlobIdent()).thenReturn(new BlobIdent("main", "docs/wiki/Home.md"));
@@ -57,7 +59,7 @@ public class WikiLinkResolverTest {
@Test
public void previewUsesEditedPathToDetermineWhetherFileIsWiki() {
Project project = mock(Project.class);
- when(project.getWikiFolder()).thenReturn("docs/wiki");
+ when(project.getWikiFolder()).thenReturn(specifiedPath("docs/wiki"));
BlobRenderContext context = mock(BlobRenderContext.class);
when(context.getProject()).thenReturn(project);
when(context.getBlobIdent()).thenReturn(new BlobIdent("main", "docs/wiki/Home.md"));
@@ -75,7 +77,7 @@ public class WikiLinkResolverTest {
public void routesOrdinaryLinksImagesAndWikiReferencesConsistently() {
Project project = mock(Project.class);
when(project.getPath()).thenReturn("project");
- when(project.getWikiFolder()).thenReturn("wiki");
+ when(project.getWikiFolder()).thenReturn(specifiedPath("wiki"));
when(project.getMode(eq("main"), anyString())).thenReturn(FileMode.REGULAR_FILE.getBits());
RequestCycle cycle = mock(RequestCycle.class);
UrlRenderer renderer = mock(UrlRenderer.class);
@@ -116,9 +118,46 @@ public class WikiLinkResolverTest {
}
}
+ @Test
+ public void routesRepositoryRootPagesAndCreationLinks() {
+ var project = mock(Project.class);
+ when(project.getPath()).thenReturn("project");
+ when(project.getWikiFolder()).thenReturn(new RepositoryRoot());
+ var context = mock(BlobRenderContext.class);
+ when(context.getProject()).thenReturn(project);
+ when(context.getMode()).thenReturn(Mode.VIEW);
+ when(context.getBlobIdent()).thenReturn(new BlobIdent("main", "Home.md"));
+ var cycle = mock(RequestCycle.class);
+ when(cycle.urlFor(eq(ProjectWikiPage.class), any(PageParameters.class))).thenAnswer(it -> {
+ PageParameters params = it.getArgument(1);
+ return url("~wiki", params) + (params.get("new").toBoolean(false) ? "?new=true" : "");
+ });
+ when(cycle.urlFor(any(RawBlobResourceReference.class), any(PageParameters.class)))
+ .thenAnswer(it -> "/raw/" + ((PageParameters) it.getArgument(1)).get("file"));
+ try (var requestCycle = mockStatic(RequestCycle.class);
+ var sprite = mockStatic(SpriteImage.class); var security = mockStatic(SecurityUtils.class)) {
+ requestCycle.when(RequestCycle::get).thenReturn(cycle);
+ sprite.when(() -> SpriteImage.getVersionedHref(io.onedev.server.web.asset.icon.IconScope.class, "plus")).thenReturn("/icons.svg#plus");
+ security.when(() -> SecurityUtils.canEditWikiPage(project, "main", "guide/Setup.md")).thenReturn(true);
+ var document = Jsoup.parseBodyFragment(WikiLinkResolver.resolveWikiLinks("[[guide/Setup]]", context));
+ assertEquals("/project/~wiki/main/guide/Setup", document.selectFirst("a").attr("href"));
+ assertEquals("/project/~wiki/main/guide/Setup?new=true", document.selectFirst("a.add-missing").attr("href"));
+ var resolver = new WikiLinkResolver(project, "main", null, "guide/Setup.md", "guide/Setup");
+ document = Jsoup.parseBodyFragment(resolver.resolve("<a href='../Home.md'>Home</a><img src='../logo.png'>"));
+ assertEquals("/project/~wiki/main/Home", document.selectFirst("a").attr("href"));
+ assertEquals("/raw/logo.png", document.selectFirst("img").attr("src"));
+ }
+ }
+
private static String url(String route, PageParameters params) {
String path = java.util.stream.IntStream.range(0, params.getIndexedCount())
.mapToObj(i -> params.get(i).toString()).collect(java.util.stream.Collectors.joining("/"));
return "/project/" + route + "/" + path + (params.get("raw").toBoolean(false) ? "?raw=true" : "");
}
+ private static SpecifiedPath specifiedPath(String path) {
+ var folder = new SpecifiedPath();
+ folder.setPath(path);
+ return folder;
+ }
+
}
diff --git a/server-core/src/test/java/io/onedev/server/web/util/WikiUtilsTest.java b/server-core/src/test/java/io/onedev/server/web/util/WikiUtilsTest.java
index 57626adbaa..7d0d7ff2ed 100644
--- a/server-core/src/test/java/io/onedev/server/web/util/WikiUtilsTest.java
+++ b/server-core/src/test/java/io/onedev/server/web/util/WikiUtilsTest.java
@@ -12,8 +12,10 @@ import org.jsoup.Jsoup;
import org.junit.Test;
import io.onedev.server.model.Project;
+import io.onedev.server.model.support.wiki.SpecifiedPath;
+import io.onedev.server.model.support.wiki.WikiSetting;
+import io.onedev.server.model.support.wiki.RepositoryRoot;
import io.onedev.server.model.Role;
-import io.onedev.server.model.support.WikiSetting;
import io.onedev.server.model.support.role.CodePrivilege;
import io.onedev.server.security.permission.ReadCode;
import io.onedev.server.security.SecurityUtils;
@@ -114,13 +116,21 @@ public class WikiUtilsTest {
Project parent = new Project();
Project child = new Project();
child.setParent(parent);
- assertEquals("wiki", child.getWikiFolder());
- parent.getWikiSetting().setFolder("documentation");
- assertEquals("documentation", child.getWikiFolder());
- child.getWikiSetting().setFolder("docs/wiki");
- assertEquals("docs/wiki", child.getWikiFolder());
+ assertEquals("wiki", child.getWikiFolder().getPath());
+ parent.getWikiSetting().setFolder(specifiedPath("documentation"));
+ assertEquals("documentation", child.getWikiFolder().getPath());
+ child.getWikiSetting().setFolder(specifiedPath("docs/wiki"));
+ assertEquals("docs/wiki", child.getWikiFolder().getPath());
child.getWikiSetting().setFolder(null);
- assertEquals("documentation", child.getWikiFolder());
+ assertEquals("documentation", child.getWikiFolder().getPath());
+ child.getWikiSetting().setFolder(new RepositoryRoot());
+ org.junit.Assert.assertNull(child.getWikiFolder().getPath());
+ child.getWikiSetting().setFolder(null);
+ parent.getWikiSetting().setFolder(new RepositoryRoot());
+ org.junit.Assert.assertNull(child.getWikiFolder().getPath());
+ parent.getWikiSetting().setFolder(null);
+ assertTrue(parent.getWikiFolder() instanceof SpecifiedPath);
+ assertEquals("wiki", child.getWikiFolder().getPath());
}
@Test
@@ -141,7 +151,7 @@ public class WikiUtilsTest {
public void projectAccessReadsOnlyEnabledWikiFiles() {
var project = mock(Project.class);
when(project.isWikiManagement()).thenReturn(true);
- when(project.getWikiFolder()).thenReturn("docs/wiki");
+ when(project.getWikiFolder()).thenReturn(specifiedPath("docs/wiki"));
var subject = mock(org.apache.shiro.subject.Subject.class);
when(subject.isPermitted(any(ProjectPermission.class))).thenAnswer(invocation ->
((ProjectPermission) invocation.getArgument(0)).getPrivilege() instanceof AccessProject);
@@ -150,6 +160,9 @@ public class WikiUtilsTest {
assertTrue(SecurityUtils.canReadFile(subject, project, "docs/wiki/image.png"));
assertFalse(SecurityUtils.canReadFile(subject, project, "private.txt"));
assertFalse(SecurityUtils.canReadFile(subject, project, "docs/wiki-other/Home.md"));
+ when(project.getWikiFolder()).thenReturn(new RepositoryRoot());
+ assertTrue(SecurityUtils.canReadFile(subject, project, "Home.md"));
+ assertTrue(SecurityUtils.canReadFile(subject, project, "images/logo.png"));
when(project.isWikiManagement()).thenReturn(false);
assertFalse(SecurityUtils.canReadFile(subject, project, "docs/wiki/Home.md"));
when(project.isWikiManagement()).thenReturn(true);
@@ -197,17 +210,41 @@ public class WikiUtilsTest {
public void validatesFolderAsRelativePath() {
try (var factory = javax.validation.Validation.buildDefaultValidatorFactory()) {
var setting = new WikiSetting();
- setting.setFolder("../outside");
+ setting.setFolder(specifiedPath("../outside"));
var violations = factory.getValidator().validate(setting);
assertEquals(1, violations.size());
- assertEquals("folder", violations.iterator().next().getPropertyPath().toString());
- setting.setFolder("/absolute");
+ assertEquals("folder.path", violations.iterator().next().getPropertyPath().toString());
+ setting.setFolder(specifiedPath("/absolute"));
assertEquals(1, factory.getValidator().validate(setting).size());
- setting.setFolder("docs/wiki");
+ setting.setFolder(specifiedPath("docs/wiki"));
+ assertTrue(factory.getValidator().validate(setting).isEmpty());
+ setting.setFolder(specifiedPath(""));
+ assertFalse(factory.getValidator().validate(setting).isEmpty());
+ setting.setFolder(specifiedPath(null));
+ assertFalse(factory.getValidator().validate(setting).isEmpty());
+ setting.setFolder(new RepositoryRoot());
assertTrue(factory.getValidator().validate(setting).isEmpty());
setting.setFolder(null);
assertTrue(factory.getValidator().validate(setting).isEmpty());
}
}
+ private static SpecifiedPath specifiedPath(String path) {
+ var folder = new SpecifiedPath();
+ folder.setPath(path);
+ return folder;
+ }
+
+ @Test
+ public void supportsRepositoryRootPaths() {
+ assertEquals("Home.md", WikiUtils.pagePath(null, "Home"));
+ assertEquals("guide/Setup.md", WikiUtils.pagePath(null, "guide/Setup"));
+ assertTrue(WikiUtils.isUnderFolder(null, "Home.md"));
+ assertTrue(WikiUtils.isUnderFolder(null, "images/logo.png"));
+ assertFalse(WikiUtils.isUnderFolder(null, null));
+ assertEquals("[[../Home|Home]]", WikiUtils.pageReference(null, "guide/Setup.md", "Home.md", null));
+ assertThrows(io.onedev.server.exception.NotAcceptableException.class,
+ () -> WikiUtils.pagePath(null, "../secret"));
+ }
+
}