Skip to content

The Unified and Autonomous Development Platform

feat: Able to publish site under specific name with permission check

Robin Shen8d9cbc2987f5
diff --git a/doc/wicket-customizations.md b/doc/wicket-customizations.md
index 072872cee0..a9f18c14c5 100644
--- a/doc/wicket-customizations.md
+++ b/doc/wicket-customizations.md
@@ -83,15 +83,10 @@ caching. Exception logging is source-audited, not asserted by those tests.
`RedirectRequestHandler` was introduced in `59b517746c` ("Fix the issue that page
redirecting works abnormally"). Wicket 10.11.0 leaves destinations without a
leading slash unchanged. For example, `ProjectSiteFileResource` redirects
-`project/~site` to the application-relative `project/~site/`. Passing that string
-directly to the browser resolves it as `project/project/~site/`; rendering it
-relative to the current request produces the intended `project/~site/` URL.
-`e2e-test/tests/redirect-request-handler.spec.js` verifies this using a newly
-created project's empty site, including both scripted browser redirects
-and crawler HTTP redirects. The destination's directory listing also confirms
-that the redirect reaches the correct resource. Replacing only the URL-rendering
-customization with Wicket 10.11.0's implementation makes both cases fail with a
-duplicated project path; restoring the customization makes both pass.
+`project/~sites/public` to the application-relative `project/~sites/public/`
+when the public site directory exists. Passing that string
+directly to the browser resolves it as `project/project/~sites/public/`; rendering it
+relative to the current request produces the intended `project/~sites/public/` URL.
`InterceptRedirectCustomizationTest` generates callback metadata using Wicket 10's
encoder and verifies removal, ordinary/duplicate parameters, page versions, and
diff --git a/e2e-test/README.md b/e2e-test/README.md
index 7af1fe0a96..17c7780e1e 100644
--- a/e2e-test/README.md
+++ b/e2e-test/README.md
@@ -74,15 +74,6 @@ users and projects are cleaned up.
npm test -- tests/ssh-clone.spec.js
```
-## Application-relative redirects
-
-`tests/redirect-request-handler.spec.js` exercises `RedirectRequestHandler` via
-the project site's missing-trailing-slash redirect. It verifies that the project
-path is not duplicated when resolving the application-relative destination,
-for both normal browsers (JavaScript redirect) and crawlers (HTTP redirect).
-The fixture's empty site must display its directory listing at the canonical
-URL, rather than an unrelated project-not-found page.
-
## Login redirects and page-store warnings
`tests/login-redirect.spec.js` checks protected system settings and private
diff --git a/e2e-test/tests/redirect-request-handler.spec.js b/e2e-test/tests/redirect-request-handler.spec.js
deleted file mode 100644
index 7fbd9aef6d..0000000000
--- a/e2e-test/tests/redirect-request-handler.spec.js
+++ /dev/null
@@ -1,33 +0,0 @@
-import { expect, test } from './fixtures.js';
-
-for (const crawler of [false, true]) {
- test.describe(crawler ? 'crawler redirect' : 'browser redirect', () => {
- if (crawler) test.use({ userAgent: 'OneDev E2E crawler' });
-
- test('adds the site trailing slash without duplicating the project path', async ({ page, api, baseURL }) => {
- const project = await api.createProject();
- const siteUrl = new URL(`${project.name}/~site`, baseURL).href;
- const canonicalUrl = `${siteUrl}/`;
- const navigation = [];
- page.on('response', response => {
- if (response.request().isNavigationRequest() && response.frame() === page.mainFrame())
- navigation.push({ url: response.url(), status: response.status() });
- });
-
- // ProjectSiteFileResource passes "project/~site/" to RedirectToUrlException.
- // RedirectRequestHandler must rebase it against the current request;
- // leaving it unchanged sends the browser to "project/project/~site/".
- await page.goto(siteUrl);
- await expect(page).toHaveURL(canonicalUrl);
-
- // A new project's site has an empty directory listing. Verify that the
- // redirect reaches it instead of an unrelated project-not-found page.
- await expect(page.getByRole('heading', { name: 'Index of /', exact: true })).toBeVisible();
- expect(navigation).toEqual([
- // ServletWebResponse uses JavaScript for browsers and HTTP for crawlers.
- { url: siteUrl, status: crawler ? 302 : 200 },
- { url: canonicalUrl, status: 200 },
- ]);
- });
- });
-}
diff --git a/server-core/src/main/java/io/onedev/server/OneDev.java b/server-core/src/main/java/io/onedev/server/OneDev.java
index ab5de18c00..b796de6d30 100644
--- a/server-core/src/main/java/io/onedev/server/OneDev.java
+++ b/server-core/src/main/java/io/onedev/server/OneDev.java
@@ -106,7 +106,7 @@ public class OneDev extends AbstractPlugin implements Serializable, Runnable {
public OneDev() {
try {
wrapperManagerClass = Class.forName("org.tanukisoftware.wrapper.WrapperManager");
- } catch (ClassNotFoundException e) {
+ } catch (ClassNotFoundException ignored) {
}
thread = new Thread(this);
initStage = new InitStage("Server is Starting...");
@@ -394,7 +394,7 @@ public class OneDev extends AbstractPlugin implements Serializable, Runnable {
if (wrapperManagerClass != null) {
try {
Method method = wrapperManagerClass.getDeclaredMethod("restartAndReturn");
- method.invoke(null, new Object[0]);
+ method.invoke(null);
} catch (Exception e) {
logger.error("Error restarting server", e);
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
index 3425c3b2ac..efe6b05f19 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
@@ -2921,6 +2921,19 @@ public class BuildSpec implements Serializable, Validatable {
}
}
}
+
+ migrateSteps(doc, versions, stepsNode -> {
+ for (var stepNodeItem : stepsNode.getValue()) {
+ var stepNode = (MappingNode) stepNodeItem;
+ if ("PublishSiteStep".equals(getStepType(stepNode))) {
+ for (var tuple : stepNode.getValue()) {
+ var keyNode = (ScalarNode) tuple.getKeyNode();
+ if (keyNode.getValue().equals("artifacts"))
+ keyNode.setValue("siteFiles");
+ }
+ }
+ }
+ });
}
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/PublishSiteStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/PublishSiteStep.java
index 5be118aebf..558302501d 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/PublishSiteStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/PublishSiteStep.java
@@ -19,6 +19,8 @@ import io.onedev.server.annotation.Editable;
import io.onedev.server.annotation.Interpolative;
import io.onedev.server.annotation.Patterns;
import io.onedev.server.annotation.ProjectChoice;
+import io.onedev.server.annotation.ReservedOptions;
+import io.onedev.server.annotation.UrlSegment;
import io.onedev.server.buildspec.BuildSpec;
import io.onedev.server.job.JobContext;
import io.onedev.server.job.JobService;
@@ -30,7 +32,8 @@ import io.onedev.server.service.SettingService;
import io.onedev.server.util.patternset.PatternSet;
@Editable(order=1060, name="Site", group = PUBLISH, description="This step publishes specified files to be served as project web site. "
- + "Project web site can be accessed publicly via <code>http://&lt;onedev base url&gt;/path/to/project/~site</code>")
+ + "Sites are published at <code>/path/to/project/~sites/&lt;site name&gt;/</code>. "
+ + "Leave the site name empty to publish a public site at <code>/path/to/project/~sites/public/</code>")
public class PublishSiteStep extends ServerSideStep {
private static final long serialVersionUID = 1L;
@@ -38,6 +41,8 @@ public class PublishSiteStep extends ServerSideStep {
private String projectPath;
private String sourcePath;
+
+ private String siteName;
private String siteFiles;
@@ -52,6 +57,20 @@ public class PublishSiteStep extends ServerSideStep {
this.projectPath = projectPath;
}
+ @Editable(order=20, placeholder="Public site", description="Optionally specify a site name. Named sites require "
+ + "access permission configured in roles. Leave empty to publish a publicly accessible site. "
+ + "The name 'public' is reserved (case insensitive)")
+ @UrlSegment
+ @Interpolative(variableSuggester = "suggestVariables")
+ @ReservedOptions(value="(?i)public", message="Site name 'public' is reserved")
+ public String getSiteName() {
+ return siteName;
+ }
+
+ public void setSiteName(String siteName) {
+ this.siteName = siteName;
+ }
+
@Editable(order=50, name="From Directory", placeholder="Job workdir", description="Optionally specify path "
+ "relative to <a href='https://docs.onedev.io/concepts#job-workdir'>job working directory</a> to publish "
+ "artifacts from. Leave empty to use job working directory itself")
@@ -72,12 +91,12 @@ public class PublishSiteStep extends ServerSideStep {
@Interpolative(variableSuggester="suggestVariables")
@Patterns(path=true)
@NotEmpty
- public String getArtifacts() {
+ public String getSiteFiles() {
return siteFiles;
}
- public void setArtifacts(String artifacts) {
- this.siteFiles = artifacts;
+ public void setSiteFiles(String siteFiles) {
+ this.siteFiles = siteFiles;
}
@SuppressWarnings("unused")
@@ -87,7 +106,7 @@ public class PublishSiteStep extends ServerSideStep {
@Override
protected PatternSet getFiles() {
- return PatternSet.parse(getArtifacts());
+ return PatternSet.parse(getSiteFiles());
}
@Override
@@ -107,16 +126,19 @@ public class PublishSiteStep extends ServerSideStep {
project = build.getProject();
}
var projectId = project.getId();
- LockUtils.write(project.getSiteLockName(), () -> {
- File projectSiteDir = OneDev.getInstance(ProjectService.class).getSiteDir(projectId);
- FileUtils.cleanDir(projectSiteDir);
- FileUtils.copyDirectory(inputDir, projectSiteDir);
- OneDev.getInstance(ProjectService.class).directoryModified(projectId, projectSiteDir);
+ LockUtils.write(project.getSitesLockName(), () -> {
+ File projectSitesDir = OneDev.getInstance(ProjectService.class).getSitesDir(projectId);
+ var siteDir = new File(projectSitesDir,
+ siteName != null ? siteName : Project.PUBLIC_SITE);
+ FileUtils.cleanDir(siteDir);
+ FileUtils.copyDirectory(inputDir, siteDir);
+ OneDev.getInstance(ProjectService.class).directoryModified(projectId, projectSitesDir);
return null;
});
String serverUrl = OneDev.getInstance(SettingService.class).getSystemSetting().getServerUrl();
logger.log("Site published as "
- + StringUtils.stripEnd(serverUrl, "/") + "/" + project.getPath() + "/~site");
+ + StringUtils.stripEnd(serverUrl, "/") + "/" + project.getPath() + "/~sites/"
+ + (siteName != null ? siteName : Project.PUBLIC_SITE) + "/");
} else {
logger.error("Site publish is prohibited by current job executor");
return new ServerStepResult(false);
diff --git a/server-core/src/main/java/io/onedev/server/cluster/ClusterResource.java b/server-core/src/main/java/io/onedev/server/cluster/ClusterResource.java
index 147e127143..5b7de0463a 100644
--- a/server-core/src/main/java/io/onedev/server/cluster/ClusterResource.java
+++ b/server-core/src/main/java/io/onedev/server/cluster/ClusterResource.java
@@ -245,15 +245,15 @@ public class ClusterResource {
return ok(out).build();
}
- @Path("/project-site")
+ @Path("/project-sites")
@Produces(MediaType.APPLICATION_OCTET_STREAM)
@GET
public Response downloadProjectSiteFile(@QueryParam("projectId") Long projectId, @QueryParam("filePath") String filePath) {
if (!SecurityUtils.isSystem())
throw new UnauthorizedException("This api can only be accessed via cluster credential");
- StreamingOutput os = output -> read(Project.getSiteLockName(projectId), () -> {
- File file = new File(projectService.getSiteDir(projectId), filePath);
+ StreamingOutput os = output -> read(Project.getSitesLockName(projectId), () -> {
+ File file = new File(projectService.getSitesDir(projectId), filePath);
try (output; InputStream is = new FileInputStream(file)) {
IOUtils.copy(is, output, BUFFER_SIZE);
}
diff --git a/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java b/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java
index 4bc54fccbe..49d3727a73 100644
--- a/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java
+++ b/server-core/src/main/java/io/onedev/server/commandhandler/Upgrade.java
@@ -13,6 +13,8 @@ import static org.hibernate.cfg.AvailableSettings.DIALECT;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.nio.file.StandardCopyOption;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
@@ -45,8 +47,10 @@ import io.onedev.server.data.migration.DataMigrator;
import io.onedev.server.data.migration.MigrationHelper;
import io.onedev.server.exception.ExceptionUtils;
import io.onedev.server.jetty.MaintenanceProbeServer;
+import io.onedev.server.model.Project;
import io.onedev.server.persistence.HibernateConfig;
import io.onedev.server.security.SecurityUtils;
+import io.onedev.server.util.SiteSyncUtils;
@Singleton
public class Upgrade extends AbstractPlugin {
@@ -954,6 +958,30 @@ public class Upgrade extends AbstractPlugin {
}
}
+ if (oldAppDataVersion < 250) {
+ logger.info("Moving published sites into the public site directory...");
+ var projectsDir = new File(upgradeDir, "site/projects");
+ if (projectsDir.exists()) {
+ for (var projectDir : projectsDir.listFiles()) {
+ var legacyDir = new File(projectDir, "site");
+ var files = legacyDir.listFiles(file -> !SiteSyncUtils.isVersionFile(file));
+ if (files != null && files.length != 0) {
+ var sitesDir = new File(projectDir, Project.SITES_DIR);
+ FileUtils.createDir(sitesDir);
+ try {
+ var versionFile = new File(legacyDir, SiteSyncUtils.FILE_VERSION);
+ if (versionFile.exists())
+ Files.copy(versionFile.toPath(), new File(sitesDir, SiteSyncUtils.FILE_VERSION).toPath(),
+ StandardCopyOption.REPLACE_EXISTING);
+ FileUtils.moveDirectory(legacyDir, new File(sitesDir, Project.PUBLIC_SITE));
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+ }
+ }
+ }
+
try {
File wrapperConfFile = new File(upgradeDir, "conf/wrapper.conf");
String wrapperConf = FileUtils.readFileToString(wrapperConfFile, UTF_8);
diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
index af228e104c..5a690f9e18 100644
--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
@@ -9567,4 +9567,8 @@ public class DataMigrator {
}
}
+ private void migrate250(File dataDir, Stack<Integer> versions) {
+ // Recreate the schema to add the optional accessibleSites role property.
+ }
+
}
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 36b8a2ddbc..d33e7e3717 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
@@ -178,7 +178,9 @@ public class Project extends AbstractEntity implements LabelSupport<ProjectLabel
public static final String ATTACHMENT_DIR = "attachment";
- public static final String SITE_DIR = "site";
+ public static final String SITES_DIR = "sites";
+
+ public static final String PUBLIC_SITE = "public";
public static final String SHARE_TEST_DIR = ".onedev-share-test";
@@ -2212,12 +2214,12 @@ public class Project extends AbstractEntity implements LabelSupport<ProjectLabel
return new ArrayList<>();
}
- public String getSiteLockName() {
- return getSiteLockName(getId());
+ public String getSitesLockName() {
+ return getSitesLockName(getId());
}
- public static String getSiteLockName(Long projectId) {
- return "project-site:" + projectId;
+ public static String getSitesLockName(Long projectId) {
+ return "project-sites:" + projectId;
}
public Collection<Build> getBuilds(ObjectId commitId) {
diff --git a/server-core/src/main/java/io/onedev/server/model/Role.java b/server-core/src/main/java/io/onedev/server/model/Role.java
index 30258744a5..2a15a061cb 100644
--- a/server-core/src/main/java/io/onedev/server/model/Role.java
+++ b/server-core/src/main/java/io/onedev/server/model/Role.java
@@ -37,11 +37,13 @@ import io.onedev.server.model.support.role.CodePrivilege;
import io.onedev.server.model.support.role.IssueFieldSet;
import io.onedev.server.model.support.role.JobPrivilege;
import io.onedev.server.model.support.role.PackPrivilege;
+import io.onedev.server.annotation.Patterns;
import io.onedev.server.security.permission.AccessBuildLog;
import io.onedev.server.security.permission.AccessBuildPipeline;
import io.onedev.server.security.permission.AccessBuildReports;
import io.onedev.server.security.permission.AccessConfidentialIssues;
import io.onedev.server.security.permission.AccessProject;
+import io.onedev.server.security.permission.AccessSites;
import io.onedev.server.security.permission.AccessTimeTracking;
import io.onedev.server.security.permission.BasePermission;
import io.onedev.server.security.permission.CreateChildren;
@@ -129,6 +131,8 @@ public class Role extends AbstractEntity implements BasePermission {
@Column(length=65535, nullable=false)
private ArrayList<JobPrivilege> jobPrivileges = new ArrayList<>();
+ private String accessibleSites;
+
private boolean manageWorkspaces;
private boolean createWorkspaces;
@@ -375,6 +379,19 @@ public class Role extends AbstractEntity implements BasePermission {
this.jobPrivileges = (ArrayList<JobPrivilege>) jobPrivileges;
}
+ @Editable(order=750, name="Access Sites", placeholder="No accessible named sites", description="Optionally specify "
+ + "space-separated site names. Use '*' or '?' for wildcard match. Prefix with '-' to exclude. "
+ + "The public site is always accessible")
+ @DependsOn(property="manageProject", value="false")
+ @Patterns
+ public String getAccessibleSites() {
+ return accessibleSites;
+ }
+
+ public void setAccessibleSites(String accessibleSites) {
+ this.accessibleSites = accessibleSites;
+ }
+
@Editable(order=800, name="Workspace Management", description="""
Workspace administrative permission inside a project, including batch operations
over multiple workspaces including batch operations over multiple workspaces.
@@ -465,6 +482,8 @@ public class Role extends AbstractEntity implements BasePermission {
permissions.add(new ManageWorkspaces());
if (createWorkspaces)
permissions.add(new CreateWorkspaces());
+ if (accessibleSites != null)
+ permissions.add(new AccessSites(accessibleSites));
if (uploadCache)
permissions.add(new UploadCache());
for (var jobPrivilege: jobPrivileges) {
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 07ef0b80e8..07aa45c341 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
@@ -59,6 +59,7 @@ import io.onedev.server.security.permission.AccessBuildPipeline;
import io.onedev.server.security.permission.AccessBuildReports;
import io.onedev.server.security.permission.AccessConfidentialIssues;
import io.onedev.server.security.permission.AccessProject;
+import io.onedev.server.security.permission.AccessSites;
import io.onedev.server.security.permission.AccessTimeTracking;
import io.onedev.server.security.permission.BasePermission;
import io.onedev.server.security.permission.ConfidentialIssuePermission;
@@ -603,6 +604,11 @@ public class SecurityUtils extends org.apache.shiro.SecurityUtils {
return getSubject().isPermitted(new ProjectPermission(project, new ReadPack()));
}
+ public static boolean canAccessSite(Project project, String siteName) {
+ return siteName.equals(Project.PUBLIC_SITE)
+ || getSubject().isPermitted(new ProjectPermission(project, new AccessSites(siteName)));
+ }
+
public static boolean canAccessReport(Build build, String reportName) {
return getSubject().isPermitted(new ProjectPermission(build.getProject(),
new JobPermission(build.getJobName(), new AccessBuildReports(reportName))));
diff --git a/server-core/src/main/java/io/onedev/server/security/permission/AccessSites.java b/server-core/src/main/java/io/onedev/server/security/permission/AccessSites.java
new file mode 100644
index 0000000000..72a73d54da
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/security/permission/AccessSites.java
@@ -0,0 +1,38 @@
+package io.onedev.server.security.permission;
+
+import io.onedev.server.util.facade.UserFacade;
+import io.onedev.commons.utils.match.StringMatcher;
+import io.onedev.server.util.patternset.PatternSet;
+import org.apache.shiro.authz.Permission;
+import org.jetbrains.annotations.Nullable;
+
+public class AccessSites implements BasePermission {
+
+ private final String siteNames;
+
+ private transient PatternSet sitePatterns;
+
+ public AccessSites(String siteNames) {
+ this.siteNames = siteNames;
+ }
+
+ private PatternSet getSitePatterns() {
+ if (sitePatterns == null)
+ sitePatterns = PatternSet.parse(siteNames);
+ return sitePatterns;
+ }
+ @Override
+ public boolean implies(Permission p) {
+ if (p instanceof AccessSites) {
+ AccessSites accessSites = (AccessSites) p;
+ return getSitePatterns().matches(new StringMatcher(), accessSites.siteNames);
+ } else {
+ return new AccessProject().implies(p);
+ }
+ }
+
+ @Override
+ public boolean isApplicable(@Nullable UserFacade user) {
+ return true;
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/service/ProjectService.java b/server-core/src/main/java/io/onedev/server/service/ProjectService.java
index ad5ed3ea9c..b40579dda0 100644
--- a/server-core/src/main/java/io/onedev/server/service/ProjectService.java
+++ b/server-core/src/main/java/io/onedev/server/service/ProjectService.java
@@ -198,7 +198,7 @@ public interface ProjectService extends EntityService<Project> {
* @return
* directory to store static content. The directory will exist after calling this method
*/
- File getSiteDir(Long projectId);
+ File getSitesDir(Long projectId);
/**
* Get directory to store additional info of specified project
diff --git a/server-core/src/main/java/io/onedev/server/service/impl/DefaultProjectService.java b/server-core/src/main/java/io/onedev/server/service/impl/DefaultProjectService.java
index cad7028f05..3dd49cdc21 100644
--- a/server-core/src/main/java/io/onedev/server/service/impl/DefaultProjectService.java
+++ b/server-core/src/main/java/io/onedev/server/service/impl/DefaultProjectService.java
@@ -9,9 +9,9 @@ import static io.onedev.server.git.GitUtils.isValid;
import static io.onedev.server.git.GitUtils.setDefaultBranch;
import static io.onedev.server.model.Project.ATTACHMENT_DIR;
import static io.onedev.server.model.Project.SHARE_TEST_DIR;
-import static io.onedev.server.model.Project.SITE_DIR;
+import static io.onedev.server.model.Project.SITES_DIR;
import static io.onedev.server.model.Project.SORT_FIELDS;
-import static io.onedev.server.model.Project.getSiteLockName;
+import static io.onedev.server.model.Project.getSitesLockName;
import static io.onedev.server.replica.ProjectReplica.Type.BACKUP;
import static io.onedev.server.replica.ProjectReplica.Type.PRIMARY;
import static io.onedev.server.replica.ProjectReplica.Type.REDUNDANT;
@@ -49,6 +49,7 @@ import java.util.concurrent.Future;
import java.util.concurrent.locks.Lock;
import java.util.function.Consumer;
+import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;
import org.apache.shiro.authz.UnauthorizedException;
import org.apache.shiro.subject.Subject;
@@ -1326,8 +1327,17 @@ public class DefaultProjectService extends BaseEntityService<Project>
@Override
public ArtifactInfo call() {
- return read(Project.getSiteLockName(projectId), () -> {
- File siteArtifact = new File(getSiteDir(projectId), siteArtifactPath);
+ return read(Project.getSitesLockName(projectId), () -> {
+ var sitesDir = getSitesDir(projectId);
+ if (!siteArtifactPath.isEmpty()) {
+ // Match the stored name exactly, even on a case-insensitive filesystem,
+ // so a case alias cannot bypass case-sensitive site permissions.
+ var siteName = StringUtils.substringBefore(siteArtifactPath, "/");
+ var matches = sitesDir.list((dir, name) -> name.equals(siteName));
+ if (matches == null || matches.length == 0)
+ return null;
+ }
+ File siteArtifact = new File(sitesDir, siteArtifactPath);
if (siteArtifact.exists()) {
if (siteArtifact.isFile()) {
String mediaType = Files.probeContentType(siteArtifact.toPath());
@@ -1338,11 +1348,11 @@ public class DefaultProjectService extends BaseEntityService<Project>
List<ArtifactInfo> children = new ArrayList<>();
File[] childFiles = siteArtifact.listFiles();
if (childFiles != null) {
- int baseLen = getSiteDir(projectId).getAbsolutePath().length() + 1;
for (File child : childFiles) {
if (!SiteSyncUtils.isVersionFile(child)
&& !child.getName().equals(".DS_Store")) {
- String relativePath = child.getAbsolutePath().substring(baseLen);
+ String relativePath = siteArtifactPath.isEmpty() ? child.getName()
+ : siteArtifactPath + "/" + child.getName();
if (child.isFile()) {
children.add(new FileInfo(relativePath, child.lastModified(),
child.length(), null));
@@ -1665,7 +1675,7 @@ public class DefaultProjectService extends BaseEntityService<Project>
visitInfoService.syncVisitInfo(projectId, syncWithServer);
packBlobService.syncPacks(projectId, syncWithServer);
- syncDirectory(projectId, SITE_DIR, getSiteLockName(projectId), syncWithServer);
+ syncDirectory(projectId, SITES_DIR, getSitesLockName(projectId), syncWithServer);
writeVersion(projectDir, remoteVersion);
logger.debug("Project synced (project: {}, server: {})", project.getPath(), syncWithServer);
@@ -1812,8 +1822,8 @@ public class DefaultProjectService extends BaseEntityService<Project>
}
@Override
- public File getSiteDir(Long projectId) {
- return getSubDir(projectId, SITE_DIR);
+ public File getSitesDir(Long projectId) {
+ return getSubDir(projectId, SITES_DIR);
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java b/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java
index f906345e1f..e432df6d29 100644
--- a/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java
+++ b/server-core/src/main/java/io/onedev/server/web/mapper/BaseUrlMapper.java
@@ -274,7 +274,7 @@ public class BaseUrlMapper extends CompoundRequestMapper {
add(new BaseResourceMapper("~downloads/projects/${project}/archives", new ArchiveResourceReference()));
add(new ProjectResourceMapper("${project}/~raw", new RawBlobResourceReference()));
- add(new ProjectResourceMapper("${project}/~site", new SiteFileResourceReference()));
+ add(new ProjectResourceMapper("${project}/~sites/${site}", new SiteFileResourceReference()));
// Change AttachmentResource.authorizeGroup accordingly if change attachment url here
add(new BaseResourceMapper("~downloads/projects/${project}/attachments/${attachment-group}/${attachment}",
diff --git a/server-core/src/main/java/io/onedev/server/web/mapper/ProjectResourceMapper.java b/server-core/src/main/java/io/onedev/server/web/mapper/ProjectResourceMapper.java
index 39570138cc..f5ece04d5e 100644
--- a/server-core/src/main/java/io/onedev/server/web/mapper/ProjectResourceMapper.java
+++ b/server-core/src/main/java/io/onedev/server/web/mapper/ProjectResourceMapper.java
@@ -67,7 +67,7 @@ public class ProjectResourceMapper extends BaseResourceMapper {
if (parameters == null) {
parameters = new PageParameters();
}
- parameters.add(placeholder, normalizedUrl.getSegments().get(index), INamedParameters.Type.PATH);
+ parameters.set(placeholder, normalizedUrl.getSegments().get(index), INamedParameters.Type.PATH);
}
}
return new ResourceReferenceRequestHandler(getResourceReference(), parameters);
@@ -107,7 +107,7 @@ public class ProjectResourceMapper extends BaseResourceMapper {
String placeholder = getPlaceholder(mountSegments[index]);
if (placeholder != null) {
- url.getSegments().set(index, parameters.get(placeholder).toString(""));
+ url.getSegments().set(index + start - 1, parameters.get(placeholder).toString(""));
parameters.remove(placeholder);
}
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.html b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.html
index 9729b843e2..eb239b21c4 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.html
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.html
@@ -8,7 +8,7 @@
<div class="d-flex flex-wrap align-items-center row-gap-1">
<div class="project-path d-flex align-items-center text-nowrap mr-2">
<span wicket:id="path" class="path mb-0 h2 text-truncate"></span>
- <a wicket:id="site" class="ml-2 mt-1 flex-shrink-0" target="_blank" t:data-tippy-content="Published site"><wicket:svg href="website" class="icon"/></a>
+ <a wicket:id="sites" class="ml-2 mt-1 flex-shrink-0" t:data-tippy-content="Published sites"><wicket:svg href="website" class="icon"/></a>
</div>
<wicket:enclosure child="forkInfo">
<span wicket:id="forkInfo" class="btn-group fork-info flex-shrink-0 ml-sm-auto">
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.java
index d33826415d..126a284a20 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.java
@@ -5,6 +5,7 @@ import static io.onedev.server.web.translation.Translation._T;
import java.io.Serializable;
import java.text.MessageFormat;
import java.text.NumberFormat;
+import java.util.ArrayList;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
@@ -16,6 +17,7 @@ import org.apache.wicket.Component;
import org.apache.wicket.Session;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.markup.html.AjaxLink;
+import org.apache.wicket.behavior.AttributeAppender;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.head.CssHeaderItem;
import org.apache.wicket.markup.head.IHeaderResponse;
@@ -77,11 +79,14 @@ import io.onedev.server.util.artifact.DirectoryInfo;
import io.onedev.server.util.criteria.Criteria;
import io.onedev.server.web.component.MultilineLabel;
import io.onedev.server.web.component.entity.labels.EntityLabelsPanel;
+import io.onedev.server.web.component.floating.FloatingPanel;
import io.onedev.server.web.component.issue.statestats.StateStatsBar;
import io.onedev.server.web.component.link.ViewStateAwarePageLink;
import io.onedev.server.web.component.markdown.BlobMarkdownViewer;
import io.onedev.server.web.component.markdown.MarkdownOutlineDropdownLink;
import io.onedev.server.web.component.markdown.MarkdownViewer;
+import io.onedev.server.web.component.menu.MenuItem;
+import io.onedev.server.web.component.menu.MenuLink;
import io.onedev.server.web.component.modal.ModalLink;
import io.onedev.server.web.component.modal.ModalPanel;
import io.onedev.server.web.component.project.ProjectAvatar;
@@ -94,12 +99,12 @@ import io.onedev.server.web.component.project.stats.issue.IssueStatsPanel;
import io.onedev.server.web.component.project.stats.pack.PackStatsPanel;
import io.onedev.server.web.component.project.stats.pullrequest.PullRequestStatsPanel;
import io.onedev.server.web.component.project.stats.workspace.WorkspaceStatsPanel;
-import io.onedev.server.web.mapper.ProjectMapperUtils;
import io.onedev.server.web.page.project.ProjectListPage;
import io.onedev.server.web.page.project.ProjectPage;
import io.onedev.server.web.page.project.blob.ProjectBlobPage;
import io.onedev.server.web.page.project.blob.render.BlobRenderContext;
import io.onedev.server.web.page.project.issues.iteration.IterationIssuesPage;
+import io.onedev.server.web.resource.ProjectSiteFileResource;
import io.onedev.server.web.resource.SiteFileResourceReference;
import io.onedev.server.web.upload.FileUpload;
import io.onedev.server.web.util.paginghistory.PagingHistorySupport;
@@ -533,20 +538,53 @@ public class ProjectOverviewPage extends ProjectPage {
return params;
}
+ private ExternalLink newSiteLink(String id, String siteName) {
+ var params = ProjectSiteFileResource.paramsOf(getProject(), siteName);
+ var link = new ExternalLink(id, urlFor(new SiteFileResourceReference(), params).toString());
+ link.add(AttributeAppender.append("target", "_blank"));
+ return link;
+ }
+
private WebMarkupContainer newSummary(String componentId) {
WebMarkupContainer container = new WebMarkupContainer(componentId);
container.add(new ProjectAvatar("avatar", getProject().getId()));
container.add(new Label("path", getProject().getPath()));
- var siteRoot = getProjectService().getSiteArtifactInfo(getProject().getId(), "");
- if (siteRoot instanceof DirectoryInfo directory
- && directory.getChildren() != null
- && !directory.getChildren().isEmpty()) {
- var siteParams = new PageParameters();
- siteParams.set(ProjectMapperUtils.PARAM_PROJECT, getProject().getPath());
- container.add(new ExternalLink("site", urlFor(new SiteFileResourceReference(), siteParams).toString()));
+ var sitesRoot = getProjectService().getSiteArtifactInfo(getProject().getId(), "");
+ var siteNames = new ArrayList<String>();
+ if (sitesRoot instanceof DirectoryInfo directory && directory.getChildren() != null) {
+ for (var child : directory.getChildren()) {
+ if (child instanceof DirectoryInfo && SecurityUtils.canAccessSite(getProject(), child.getPath()))
+ siteNames.add(child.getPath());
+ }
+ }
+ if (siteNames.size() == 1) {
+ container.add(newSiteLink("sites", siteNames.get(0)));
+ } else if (siteNames.size() > 1) {
+ container.add(new MenuLink("sites") {
+ @Override
+ protected List<MenuItem> getMenuItems(FloatingPanel dropdown) {
+ var items = new ArrayList<MenuItem>();
+ for (var siteName : siteNames) {
+ if (SecurityUtils.canAccessSite(getProject(), siteName)) {
+ items.add(new MenuItem() {
+ @Override
+ public String getLabel() {
+ return siteName;
+ }
+
+ @Override
+ public WebMarkupContainer newLink(String id) {
+ return newSiteLink(id, siteName);
+ }
+ });
+ }
+ }
+ return items;
+ }
+ });
} else {
- container.add(new WebMarkupContainer("site").setVisible(false));
+ container.add(new WebMarkupContainer("sites").setVisible(false));
}
container.add(new EntityLabelsPanel<>("labels", projectModel));
diff --git a/server-core/src/main/java/io/onedev/server/web/resource/ProjectSiteFileResource.java b/server-core/src/main/java/io/onedev/server/web/resource/ProjectSiteFileResource.java
index 494320b559..40b62cb5ad 100644
--- a/server-core/src/main/java/io/onedev/server/web/resource/ProjectSiteFileResource.java
+++ b/server-core/src/main/java/io/onedev/server/web/resource/ProjectSiteFileResource.java
@@ -25,6 +25,7 @@ import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
+import org.apache.shiro.authz.UnauthorizedException;
import org.apache.wicket.request.flow.RedirectToUrlException;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.request.resource.AbstractResource;
@@ -35,25 +36,27 @@ import org.slf4j.LoggerFactory;
import org.unbescape.html.HtmlEscape;
import com.google.common.base.Joiner;
-import com.google.common.base.Splitter;
import io.onedev.commons.utils.ExplicitException;
import io.onedev.k8shelper.KubernetesHelper;
import io.onedev.server.OneDev;
import io.onedev.server.cluster.ClusterService;
import io.onedev.server.exception.ExceptionUtils;
-import io.onedev.server.git.BlobIdent;
import io.onedev.server.model.Project;
+import io.onedev.server.security.SecurityUtils;
import io.onedev.server.service.ProjectService;
import io.onedev.server.util.LongRange;
import io.onedev.server.util.artifact.ArtifactInfo;
import io.onedev.server.util.artifact.DirectoryInfo;
import io.onedev.server.util.artifact.FileInfo;
+import io.onedev.server.validation.validator.UrlSegmentValidator;
import io.onedev.server.web.mapper.ProjectMapperUtils;
import io.onedev.server.web.util.WicketUtils;
public class ProjectSiteFileResource extends AbstractResource {
+ private static final String PARAM_SITE = "site";
+
private static final long serialVersionUID = 1L;
private static final Logger logger = LoggerFactory.getLogger(ProjectSiteFileResource.class);
@@ -68,8 +71,14 @@ public class ProjectSiteFileResource extends AbstractResource {
throw new EntityNotFoundException();
Long projectId = project.getId();
+ var siteName = params.get(PARAM_SITE).toString("");
+ if (!UrlSegmentValidator.PATTERN.matcher(siteName).matches())
+ throw new ExplicitException("Invalid site name");
+ if (!SecurityUtils.canAccessSite(project, siteName))
+ throw new UnauthorizedException();
List<String> filePathSegments = new ArrayList<>();
+ filePathSegments.add(siteName);
for (int i = 0; i < params.getIndexedCount(); i++) {
String segment = params.get(i).toString();
if (segment.contains(".."))
@@ -82,42 +91,23 @@ public class ProjectSiteFileResource extends AbstractResource {
String filePath = Joiner.on("/").join(filePathSegments);
if (filePathSegments.contains(FILE_VERSION))
return newNotFoundResponse(filePath);
- if (filePath.length() != 0) {
- ArtifactInfo artifactInfo = getProjectService().getSiteArtifactInfo(projectId, filePath);
- if (artifactInfo instanceof DirectoryInfo) {
- if (attributes.getRequest().getUrl().getPath().endsWith("/")) {
- DirectoryInfo directoryInfo = (DirectoryInfo) artifactInfo;
- String indexFilePath = filePath + "/index.html";
- artifactInfo = getProjectService().getSiteArtifactInfo(projectId, indexFilePath);
- if (artifactInfo instanceof FileInfo)
- fileInfo = (FileInfo) artifactInfo;
- else
- return newDirectoryResponse(filePath, directoryInfo);
- filePath = indexFilePath;
- } else {
- throw new RedirectToUrlException(attributes.getRequest().getUrl().getPath() + "/");
- }
- } else if (artifactInfo instanceof FileInfo) {
- fileInfo = (FileInfo) artifactInfo;
- } else {
- return newNotFoundResponse(filePath);
- }
- } else if (attributes.getRequest().getUrl().getPath().endsWith("/")) {
- filePath = "index.html";
- ArtifactInfo artifactInfo = getProjectService().getSiteArtifactInfo(projectId, filePath);
+ ArtifactInfo artifactInfo = getProjectService().getSiteArtifactInfo(projectId, filePath);
+ if (artifactInfo instanceof DirectoryInfo directoryInfo) {
+ if (!attributes.getRequest().getUrl().getPath().endsWith("/"))
+ throw new RedirectToUrlException(attributes.getRequest().getUrl().getPath() + "/");
+ String indexFilePath = filePath + "/index.html";
+ artifactInfo = getProjectService().getSiteArtifactInfo(projectId, indexFilePath);
if (artifactInfo instanceof FileInfo)
fileInfo = (FileInfo) artifactInfo;
- else {
- artifactInfo = getProjectService().getSiteArtifactInfo(projectId, "");
- if (artifactInfo instanceof DirectoryInfo)
- return newDirectoryResponse("", (DirectoryInfo) artifactInfo);
- else
- return newNotFoundResponse(filePath);
- }
+ else
+ return newDirectoryResponse(filePath, directoryInfo);
+ filePath = indexFilePath;
+ } else if (artifactInfo instanceof FileInfo) {
+ fileInfo = (FileInfo) artifactInfo;
} else {
- throw new RedirectToUrlException(attributes.getRequest().getUrl().getPath() + "/");
+ return newNotFoundResponse(filePath);
}
-
+
ResourceResponse response = new ResourceResponse();
response.disableCaching();
response.setAcceptRange(ContentRangeType.BYTES);
@@ -147,8 +137,8 @@ public class ProjectSiteFileResource extends AbstractResource {
String activeServer = getProjectService().getActiveServer(projectId, true);
if (activeServer.equals(getClusterService().getLocalServerAddress())) {
- read(Project.getSiteLockName(projectId), () -> {
- File file = new File(getProjectService().getSiteDir(projectId), finalFilePath);
+ read(Project.getSitesLockName(projectId), () -> {
+ File file = new File(getProjectService().getSitesDir(projectId), finalFilePath);
try (InputStream is = new FileInputStream(file)) {
copyRange(is, attributes.getResponse().getOutputStream(), range);
} catch (IOException e) {
@@ -161,7 +151,7 @@ public class ProjectSiteFileResource extends AbstractResource {
try {
String serverUrl = getClusterService().getServerUrl(activeServer);
WebTarget target = client.target(serverUrl);
- target = target.path("~api/cluster/project-site")
+ target = target.path("~api/cluster/project-sites")
.queryParam("projectId", project.getId())
.queryParam("filePath", finalFilePath);
Invocation.Builder builder = target.request();
@@ -205,7 +195,7 @@ public class ProjectSiteFileResource extends AbstractResource {
.append("</title></head><body><h1>Index of ")
.append(escapedDisplayPath)
.append("</h1><ul>");
- if (!directoryPath.isEmpty())
+ if (directoryPath.contains("/"))
builder.append("<li><a href=\"../\">../</a></li>");
for (ArtifactInfo child : directoryInfo.getChildren() != null
? directoryInfo.getChildren() : Collections.<ArtifactInfo>emptyList()) {
@@ -253,20 +243,10 @@ public class ProjectSiteFileResource extends AbstractResource {
return OneDev.getInstance(ClusterService.class);
}
- public static PageParameters paramsOf(Project project, BlobIdent blobIdent) {
+ public static PageParameters paramsOf(Project project, String siteName) {
PageParameters params = new PageParameters();
params.set(ProjectMapperUtils.PARAM_PROJECT, project.getPath());
-
- int index = 0;
- for (String segment: Splitter.on("/").split(blobIdent.revision)) {
- params.set(index, segment);
- index++;
- }
- for (String segment: Splitter.on("/").split(blobIdent.path)) {
- params.set(index, segment);
- index++;
- }
-
+ params.set(PARAM_SITE, siteName);
return params;
}
diff --git a/server-core/src/test/java/io/onedev/server/buildspec/step/PublishSiteStepTest.java b/server-core/src/test/java/io/onedev/server/buildspec/step/PublishSiteStepTest.java
new file mode 100644
index 0000000000..203737c5a2
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/buildspec/step/PublishSiteStepTest.java
@@ -0,0 +1,92 @@
+package io.onedev.server.buildspec.step;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.concurrent.Callable;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import io.onedev.commons.utils.TaskLogger;
+import io.onedev.server.OneDev;
+import io.onedev.server.job.JobContext;
+import io.onedev.server.job.JobService;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+import io.onedev.server.persistence.SessionService;
+import io.onedev.server.service.BuildService;
+import io.onedev.server.service.ProjectService;
+import io.onedev.server.service.SettingService;
+import io.onedev.server.validation.HibernateValidationTestSupport;
+
+class PublishSiteStepTest extends HibernateValidationTestSupport {
+
+ @TempDir
+ Path directory;
+
+ @Test
+ void validatesOptionalSiteName() {
+ var step = new PublishSiteStep();
+ assertTrue(validator.validateProperty(step, "siteName").isEmpty());
+ for (var name : new String[] {"public", "PUBLIC", "PuBlIc", "../secret", "a/b", "a\\b", ".", "", "bad name"}) {
+ step.setSiteName(name);
+ assertFalse(validator.validateProperty(step, "siteName").isEmpty(), name);
+ }
+ for (var name : new String[] {"docs", "preview-1", "docs..v2", "public-docs"}) {
+ step.setSiteName(name);
+ assertTrue(validator.validateProperty(step, "siteName").isEmpty(), name);
+ }
+ }
+
+ @Test
+ void publishingReplacesOnlyTheSelectedSite() throws Exception {
+ var sites = Files.createDirectory(directory.resolve("sites"));
+ var input = Files.createDirectory(directory.resolve("input"));
+ Files.createDirectory(sites.resolve("public"));
+ Files.writeString(sites.resolve("public/index.html"), "public");
+ Files.createDirectory(sites.resolve("docs"));
+ Files.writeString(sites.resolve("docs/old.html"), "old");
+ Files.writeString(input.resolve("index.html"), "updated");
+ var project = new Project();
+ project.setId(1L);
+ project.setName("test");
+ project.setPath("test");
+ var build = new Build();
+ build.setId(2L);
+ build.setProject(project);
+ var sessions = mock(SessionService.class);
+ when(sessions.call(any())).thenAnswer(it -> ((Callable<?>) it.getArgument(0)).call());
+ var builds = mock(BuildService.class);
+ when(builds.load(2L)).thenReturn(build);
+ var jobs = mock(JobService.class);
+ var context = mock(JobContext.class, RETURNS_DEEP_STUBS);
+ when(jobs.getJobContext(2L)).thenReturn(context);
+ when(context.getJobExecutor().isSitePublishEnabled()).thenReturn(true);
+ var projects = mock(ProjectService.class);
+ when(projects.getSitesDir(1L)).thenReturn(sites.toFile());
+ var settings = mock(SettingService.class, RETURNS_DEEP_STUBS);
+ when(settings.getSystemSetting().getServerUrl()).thenReturn("https://onedev.example");
+ try (var oneDev = mockStatic(OneDev.class)) {
+ oneDev.when(() -> OneDev.getInstance(SessionService.class)).thenReturn(sessions);
+ oneDev.when(() -> OneDev.getInstance(BuildService.class)).thenReturn(builds);
+ oneDev.when(() -> OneDev.getInstance(JobService.class)).thenReturn(jobs);
+ oneDev.when(() -> OneDev.getInstance(ProjectService.class)).thenReturn(projects);
+ oneDev.when(() -> OneDev.getInstance(SettingService.class)).thenReturn(settings);
+ var step = new PublishSiteStep();
+ step.setSiteName("docs");
+ step.run(2L, input.toFile(), mock(TaskLogger.class));
+ assertEquals("public", Files.readString(sites.resolve("public/index.html")));
+ assertEquals("updated", Files.readString(sites.resolve("docs/index.html")));
+ assertFalse(Files.exists(sites.resolve("docs/old.html")));
+ Files.writeString(input.resolve("index.html"), "new public");
+ step.setSiteName(null);
+ step.run(2L, input.toFile(), mock(TaskLogger.class));
+ assertEquals("new public", Files.readString(sites.resolve("public/index.html")));
+ assertEquals("updated", Files.readString(sites.resolve("docs/index.html")));
+ verify(projects, times(2)).directoryModified(1L, sites.toFile());
+ }
+ }
+}
diff --git a/server-core/src/test/java/io/onedev/server/security/permission/AccessSitesTest.java b/server-core/src/test/java/io/onedev/server/security/permission/AccessSitesTest.java
new file mode 100644
index 0000000000..0d47d0a63d
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/security/permission/AccessSitesTest.java
@@ -0,0 +1,25 @@
+package io.onedev.server.security.permission;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import org.junit.jupiter.api.Test;
+
+import io.onedev.server.model.Role;
+
+class AccessSitesTest {
+
+ @Test
+ void rolesGrantOnlyConfiguredSitesUnlessManagingProject() {
+ var role = new Role();
+ role.setEditableIssueFields(new io.onedev.server.model.support.role.IncludeIssueFields());
+ assertFalse(role.implies(new AccessSites("docs")));
+ role.setAccessibleSites("docs preview-* -preview-secret");
+ assertTrue(role.implies(new AccessSites("docs")));
+ assertTrue(role.implies(new AccessSites("preview-feature")));
+ assertFalse(role.implies(new AccessSites("preview-secret")));
+ assertFalse(role.implies(new AccessSites("other")));
+ assertFalse(role.implies(new AccessSites("DOCS")));
+ role.setManageProject(true);
+ assertTrue(role.implies(new AccessSites("other")));
+ }
+}
diff --git a/server-core/src/test/java/io/onedev/server/web/resource/ProjectSiteFileResourceTest.java b/server-core/src/test/java/io/onedev/server/web/resource/ProjectSiteFileResourceTest.java
new file mode 100644
index 0000000000..1aefa73df7
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/web/resource/ProjectSiteFileResourceTest.java
@@ -0,0 +1,158 @@
+package io.onedev.server.web.resource;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.Set;
+
+import org.apache.shiro.authz.Permission;
+import org.apache.shiro.authz.UnauthorizedException;
+import org.apache.shiro.subject.Subject;
+import org.apache.shiro.util.ThreadContext;
+import org.apache.wicket.mock.MockWebRequest;
+import org.apache.wicket.mock.MockWebResponse;
+import org.apache.wicket.request.Url;
+import org.apache.wicket.request.flow.RedirectToUrlException;
+import org.apache.wicket.request.handler.resource.ResourceReferenceRequestHandler;
+import org.apache.wicket.request.resource.IResource.Attributes;
+import org.apache.wicket.util.tester.WicketTester;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import io.onedev.commons.utils.ExplicitException;
+import io.onedev.server.OneDev;
+import io.onedev.server.cluster.ClusterTask;
+import io.onedev.server.model.Project;
+import io.onedev.server.security.permission.AccessSites;
+import io.onedev.server.security.permission.ProjectPermission;
+import io.onedev.server.service.ProjectService;
+import io.onedev.server.service.impl.DefaultProjectService;
+import io.onedev.server.util.SiteSyncUtils;
+import io.onedev.server.util.artifact.DirectoryInfo;
+import io.onedev.server.util.artifact.FileInfo;
+import io.onedev.server.web.mapper.ProjectResourceMapper;
+
+class ProjectSiteFileResourceTest {
+
+ @Test
+ void rejectsCaseAliasesOfExcludedSites(@TempDir Path sitesDir) throws Exception {
+ for (var site : List.of("public", "secret", "TeamDocs")) {
+ Files.createDirectory(sitesDir.resolve(site));
+ Files.writeString(sitesDir.resolve(site).resolve("index.html"), "site content");
+ }
+ var tester = new WicketTester();
+ var subject = mock(Subject.class);
+ when(subject.isPermitted(any(Permission.class))).thenAnswer(it ->
+ new AccessSites("* -secret").implies(((ProjectPermission) it.getArgument(0)).getPrivilege()));
+ ThreadContext.bind(subject);
+ try (var oneDev = mockStatic(OneDev.class)) {
+ var projects = spy(new DefaultProjectService(Set.of()));
+ doReturn(sitesDir.toFile()).when(projects).getSitesDir(1L);
+ doAnswer(it -> ((ClusterTask<?>) it.getArgument(1)).call())
+ .when(projects).runOnActiveServer(eq(1L), any());
+ var project = new Project();
+ project.setId(1L);
+ project.setPath("test");
+ doReturn(project).when(projects).findByPath("test");
+ oneDev.when(() -> OneDev.getInstance(ProjectService.class)).thenReturn(projects);
+ var resource = new ProjectSiteFileResource();
+ assertThrows(UnauthorizedException.class,
+ () -> resource.newResourceResponse(attributes(project, "secret/index.html")));
+ for (var alias : List.of("SECRET", "Secret", "teamdocs", "PUBLIC")) {
+ assertEquals(404, resource.newResourceResponse(attributes(project, alias + "/index.html")).getStatusCode());
+ assertEquals(404, resource.newResourceResponse(attributes(project, alias + "/")).getStatusCode());
+ }
+ for (var site : List.of("public", "TeamDocs")) {
+ assertEquals(12, resource.newResourceResponse(attributes(project, site + "/index.html")).getContentLength());
+ assertEquals(12, resource.newResourceResponse(attributes(project, site + "/")).getContentLength());
+ }
+ assertEquals(3, ((DirectoryInfo) projects.getSiteArtifactInfo(1L, "")).getChildren().size());
+ } finally {
+ ThreadContext.unbindSubject();
+ tester.destroy();
+ }
+ }
+
+ @Test
+ void checksNamedSitePermissionBeforeAccessingFilesAndDirectories() throws Exception {
+ var tester = new WicketTester();
+ var subject = mock(Subject.class);
+ ThreadContext.bind(subject);
+ try (var oneDev = mockStatic(OneDev.class)) {
+ var projects = mock(ProjectService.class);
+ var project = new Project();
+ project.setId(1L);
+ project.setName("test");
+ project.setPath("test");
+ when(projects.findByPath("test")).thenReturn(project);
+ oneDev.when(() -> OneDev.getInstance(ProjectService.class)).thenReturn(projects);
+ var resource = new ProjectSiteFileResource();
+ var mapper = new ProjectResourceMapper("${project}/~sites/${site}", new SiteFileResourceReference());
+ assertNull(mapper.mapRequest(new MockWebRequest(Url.parse("test/~sites"))));
+ for (var projectPath : new String[] {"test", "parent/test"}) {
+ project.setPath(projectPath);
+ var params = ProjectSiteFileResource.paramsOf(project, "docs").set(0, "index.html");
+ var url = mapper.mapHandler(new ResourceReferenceRequestHandler(new SiteFileResourceReference(), params));
+ assertEquals(projectPath + "/~sites/docs/index.html", url.toString());
+ var handler = (ResourceReferenceRequestHandler) mapper.mapRequest(new MockWebRequest(url));
+ assertEquals(projectPath, handler.getPageParameters().get("project").toString());
+ assertEquals("docs", handler.getPageParameters().get("site").toString());
+ assertEquals("index.html", handler.getPageParameters().get(0).toString());
+ }
+ project.setPath("test");
+ var handler = (ResourceReferenceRequestHandler) mapper.mapRequest(new MockWebRequest(
+ Url.parse("test/~sites/docs/index.html?site=public&project=other")));
+ assertEquals("test", handler.getPageParameters().get("project").toString());
+ assertEquals("docs", handler.getPageParameters().get("site").toString());
+ for (var path : new String[] {"docs", "docs/index.html", "docs/assets/logo.png"}) {
+ assertThrows(UnauthorizedException.class, () -> resource.newResourceResponse(attributes(project, path)));
+ }
+ verify(projects, never()).getSiteArtifactInfo(anyLong(), anyString());
+
+ when(projects.getSiteArtifactInfo(1L, "public/index.html"))
+ .thenReturn(new FileInfo("public/index.html", 0, 42, "text/html"));
+ assertEquals(42, resource.newResourceResponse(attributes(project, "public/index.html")).getContentLength());
+
+ when(subject.isPermitted(any(Permission.class))).thenAnswer(it -> {
+ var permission = (ProjectPermission) it.getArgument(0);
+ return permission.getProject().equals(project)
+ && new AccessSites("docs").implies(permission.getPrivilege());
+ });
+ when(projects.getSiteArtifactInfo(1L, "docs"))
+ .thenReturn(new DirectoryInfo("docs", 0, List.of(new FileInfo("docs/file.txt", 0, 1, "text/plain"))));
+ var attrs = attributes(project, "docs/");
+ var response = resource.newResourceResponse(attrs);
+ response.getWriteCallback().writeData(attrs);
+ var html = ((MockWebResponse) attrs.getResponse()).getTextResponse().toString();
+ assertTrue(html.contains("href=\"file.txt\""));
+ assertFalse(html.contains("href=\"../\""));
+ assertThrows(RedirectToUrlException.class, () -> resource.newResourceResponse(attributes(project, "docs")));
+
+ when(projects.getSiteArtifactInfo(1L, "docs/index.html"))
+ .thenReturn(new FileInfo("docs/index.html", 0, 99, "text/html"));
+ assertEquals(99, resource.newResourceResponse(attributes(project, "docs/")).getContentLength());
+ assertEquals(404, resource.newResourceResponse(attributes(project, "docs/missing.txt")).getStatusCode());
+ assertEquals(404, resource.newResourceResponse(attributes(project, "docs/" + SiteSyncUtils.FILE_VERSION)).getStatusCode());
+ for (var path : new String[] {"public/../docs/secret", "public/..\\docs/secret"})
+ assertThrows(ExplicitException.class, () -> resource.newResourceResponse(attributes(project, path)));
+
+ // A new session without the site privilege must be denied.
+ ThreadContext.bind(mock(Subject.class));
+ assertThrows(UnauthorizedException.class, () -> resource.newResourceResponse(attributes(project, "docs/index.html")));
+ } finally {
+ ThreadContext.unbindSubject();
+ tester.destroy();
+ }
+ }
+
+ private Attributes attributes(Project project, String path) {
+ var segments = path.split("/", -1);
+ var params = ProjectSiteFileResource.paramsOf(project, segments[0]);
+ for (int i = 1; i < segments.length; i++)
+ params.set(i - 1, segments[i]);
+ return new Attributes(new MockWebRequest(Url.parse("test/~sites/" + path)), new MockWebResponse(), params);
+ }
+}