Skip to content

The Unified and Autonomous Development Platform

feat: Enhance file access and retrieval for project wikis

Robin Shenebf83472c128
diff --git a/e2e-test/tests/wiki.spec.js b/e2e-test/tests/wiki.spec.js
index 584867b64b..dc6262cdfc 100644
--- a/e2e-test/tests/wiki.spec.js
+++ b/e2e-test/tests/wiki.spec.js
@@ -248,16 +248,16 @@ test('allows project members to view wiki but denies repository API and outside
await login(page, wikiProject.reader.name, wikiProject.reader.password);
await page.goto(`${wikiProject.name}/~wiki/main/Home`);
await expect(body(page)).toContainText('Home');
- const wikiFile = await page.request.get(`~api/repositories/${wikiProject.id}/files/main/wiki/Home.md`);
- // Repository API access requires code-read permission even for wiki files.
- expect(wikiFile.status()).toBe(403);
+ const wikiFile = await page.request.get(`~api/repositories/${wikiProject.id}/files?revision=main&file=wiki/Home.md`);
+ expect(wikiFile.status()).toBe(200);
await body(page).getByRole('link', { name: 'Private file', exact: true }).click();
await expect(page.getByText('You are not allowed to perform this operation', { exact: true })).toBeVisible();
await expect(page.locator('body')).not.toContainText('E2E_PRIVATE_CODE_CONTENT');
for (const url of [
`${wikiProject.name}/~files/main/wiki/Home.md?query=password`,
- `${wikiProject.name}/~raw/main/private.txt`,
- `~api/repositories/${wikiProject.id}/files/main/private.txt`,
+ `${wikiProject.name}/~raw?revision=main&file=private.txt`,
+ `${wikiProject.name}/~raw?revision=main&file=wiki/../private.txt`,
+ `~api/repositories/${wikiProject.id}/files?revision=main&file=private.txt`,
]) {
const response = await page.request.get(url);
expect(response.status(), url).toBe(403);
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/RepositoryResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/RepositoryResource.java
index 3ea000bd55..948933c12d 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/RepositoryResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/RepositoryResource.java
@@ -340,18 +340,25 @@ public class RepositoryResource {
}
@Api(order=100, description="Get metadata and content of specified file")
- @Path("/{projectId}/files/{revisionAndFile:.*}")
+ @Path("/{projectId}/files")
@GET
public FileResponse getFile(
@PathParam("projectId") Long projectId,
- @PathParam("revisionAndFile") @NotEmpty @Api(example="some-branch-or-tag/path/to/file") String revisionAndFile) {
+ @QueryParam("revision") @NotEmpty @Api(example="some-branch-or-tag") String revision,
+ @QueryParam("file") @NotEmpty @Api(example="path/to/file") String file) {
Project project = projectService.load(projectId);
- if (!SecurityUtils.canReadCode(project)) {
+ file = GitUtils.normalizePath(file);
+ if (file == null)
+ throw new NotAcceptableException("File should be specified");
+
+ if (!SecurityUtils.canReadFile(project, file)) {
throw new UnauthorizedException();
}
- List<String> revisionAndPathSegments = Splitter.on('/').splitToList(revisionAndFile);
- BlobIdent blobIdent = new BlobIdent(project, revisionAndPathSegments);
+ int mode = project.getMode(revision, file);
+ if (mode == 0)
+ throw new NotFoundException("Unable to find blob path '" + file + "' in revision '" + revision + "'");
+ BlobIdent blobIdent = new BlobIdent(revision, file, mode);
if (!blobIdent.isFile()) {
throw new NotAcceptableException("Specified path is not a file: " + blobIdent.path);
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 83376577e9..0af2768059 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
@@ -295,9 +295,10 @@ public class SecurityUtils extends org.apache.shiro.SecurityUtils {
/** The caller must normalize the file path before checking permission and reading it. */
public static boolean canReadFile(Subject subject, Project project, String file) {
- return canReadCode(subject, project) || project.isWikiManagement()
- && file != null && file.startsWith(project.getWikiFolder() + "/")
- && canAccessProject(subject, project);
+ return canReadCode(subject, project)
+ || project.isWikiManagement()
+ && file.startsWith(project.getWikiFolder() + "/")
+ && canAccessProject(subject, project);
}
public static boolean canEditWikiPage(Project project, @Nullable String revision, String path) {
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/ProjectBlobPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/blob/ProjectBlobPage.java
index 7690101cc4..05af00db11 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/ProjectBlobPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/ProjectBlobPage.java
@@ -262,7 +262,8 @@ public class ProjectBlobPage extends ProjectPage implements BlobRenderContext,
if (params.get(PARAM_RAW).toBoolean(false)) {
RequestCycle.get().scheduleRequestHandlerAfterCurrent(
- new ResourceReferenceRequestHandler(new RawBlobResourceReference(), getPageParameters()));
+ new ResourceReferenceRequestHandler(new RawBlobResourceReference(),
+ RawBlobResource.paramsOf(getProject(), getBlobIdent())));
}
}
diff --git a/server-core/src/main/java/io/onedev/server/web/resource/RawBlobResource.java b/server-core/src/main/java/io/onedev/server/web/resource/RawBlobResource.java
index b34ed28448..c38dd09be4 100644
--- a/server-core/src/main/java/io/onedev/server/web/resource/RawBlobResource.java
+++ b/server-core/src/main/java/io/onedev/server/web/resource/RawBlobResource.java
@@ -7,8 +7,6 @@ import java.io.UnsupportedEncodingException;
import java.net.URISyntaxException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.List;
import javax.persistence.EntityNotFoundException;
import javax.ws.rs.core.HttpHeaders;
@@ -26,8 +24,6 @@ import org.jspecify.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import com.google.common.base.Splitter;
-
import io.onedev.k8shelper.KubernetesHelper;
import io.onedev.server.OneDev;
import io.onedev.server.cluster.ClusterService;
@@ -42,7 +38,6 @@ import io.onedev.server.security.SecurityUtils;
import io.onedev.server.service.ProjectService;
import io.onedev.server.util.IOUtils;
import io.onedev.server.util.LongRange;
-import io.onedev.server.util.RevisionAndPath;
import io.onedev.server.web.mapper.ProjectMapperUtils;
import io.onedev.server.web.util.MimeUtils;
import io.onedev.server.web.util.WicketUtils;
@@ -52,6 +47,8 @@ public class RawBlobResource extends AbstractResource {
private static final long serialVersionUID = 1L;
private static final String PARAM_DISPOSITION = "disposition";
+ private static final String PARAM_REVISION = "revision";
+ private static final String PARAM_FILE = "file";
private static final Logger logger = LoggerFactory.getLogger(RawBlobResource.class);
@@ -64,17 +61,8 @@ public class RawBlobResource extends AbstractResource {
if (project == null)
throw new EntityNotFoundException("Project not found: " + projectPath);
- List<String> revisionAndPathSegments = new ArrayList<>();
- for (int i = 0; i < params.getIndexedCount(); i++) {
- String segment = params.get(i).toString();
- if (segment.length() != 0)
- revisionAndPathSegments.add(segment);
- }
-
- RevisionAndPath revisionAndPath = RevisionAndPath.parse(project, revisionAndPathSegments);
-
- String revision = revisionAndPath.getRevision();
- String path = GitUtils.normalizePath(revisionAndPath.getPath());
+ String revision = params.get(PARAM_REVISION).toOptionalString();
+ String path = GitUtils.normalizePath(params.get(PARAM_FILE).toOptionalString());
if (StringUtils.isBlank(revision) || StringUtils.isBlank(path))
throw new NotAcceptableException("Revision and path should be specified");
@@ -199,15 +187,8 @@ public class RawBlobResource extends AbstractResource {
if (disposition != null)
params.add(PARAM_DISPOSITION, disposition.name());
- 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_REVISION, blobIdent.revision);
+ params.set(PARAM_FILE, blobIdent.path);
return params;
}
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 12165c7f36..a007de798f 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
@@ -86,7 +86,11 @@ public class WikiLinkResolverTest {
when(cycle.urlFor(eq(ProjectBlobPage.class), any(PageParameters.class)))
.thenAnswer(it -> url("~files", it.getArgument(1)));
when(cycle.urlFor(any(RawBlobResourceReference.class), any(PageParameters.class)))
- .thenAnswer(it -> url("~raw", it.getArgument(1)));
+ .thenAnswer(it -> {
+ PageParameters params = it.getArgument(1);
+ assertEquals(0, params.getIndexedCount());
+ return "/project/~raw?revision=" + params.get("revision") + "&file=" + params.get("file");
+ });
try (var requestCycle = mockStatic(RequestCycle.class);
var sprite = mockStatic(SpriteImage.class); var security = mockStatic(SecurityUtils.class)) {
requestCycle.when(RequestCycle::get).thenReturn(cycle);
@@ -100,8 +104,8 @@ public class WikiLinkResolverTest {
assertEquals("Read this", document.selectFirst("p a").text());
assertEquals(1, document.select("a[href=/project/~files/main/README.md]").size());
assertEquals(1, document.select("a[href=/project/~wiki/main/guide/Sibling#intro]").size());
- assertEquals(1, document.select("a[href=/project/~raw/main/wiki/manual.pdf]").size());
- assertEquals("/project/~raw/main/wiki/logo.png", document.select("img").get(0).attr("src"));
+ assertEquals(1, document.select("a[href='/project/~raw?revision=main&file=wiki/manual.pdf']").size());
+ assertEquals("/project/~raw?revision=main&file=wiki/logo.png", document.select("img").get(0).attr("src"));
assertEquals("/project/~files/main/logo.png?raw=true&v=2#preview", document.select("img").get(1).attr("src"));
assertEquals(1, document.select("a[href=/project/~files/main/manual.pdf#page=3]").size());
assertEquals(3, document.select("span.missing").size());
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 c1daebe66a..57626adbaa 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
@@ -150,7 +150,6 @@ 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"));
- assertFalse(SecurityUtils.canReadFile(subject, project, null));
when(project.isWikiManagement()).thenReturn(false);
assertFalse(SecurityUtils.canReadFile(subject, project, "docs/wiki/Home.md"));
when(project.isWikiManagement()).thenReturn(true);