Skip to content

The Unified and Autonomous Development Platform

feat: Improve issue and pull request restful api to be able to upload attachment (OD-2489)

Robin Shen5b56582bb2f0
diff --git a/server-core/src/main/java/io/onedev/server/attachment/AttachmentManager.java b/server-core/src/main/java/io/onedev/server/attachment/AttachmentManager.java
index 26616af991..d9eca02057 100644
--- a/server-core/src/main/java/io/onedev/server/attachment/AttachmentManager.java
+++ b/server-core/src/main/java/io/onedev/server/attachment/AttachmentManager.java
@@ -10,10 +10,10 @@ public interface AttachmentManager {
File getAttachmentGroupDir(Long projectId, String attachmentGroup);
- String saveAttachment(Long projectId, String attachmentGroup, String suggestedAttachmentName,
+ String saveAttachment(Long projectId, String attachmentGroup, String preferredAttachmentName,
InputStream attachmentStream);
- String saveAttachmentLocal(Long projectId, String attachmentGroup, String suggestedAttachmentName,
+ String saveAttachmentLocal(Long projectId, String attachmentGroup, String preferredAttachmentName,
InputStream attachmentStream);
FileInfo getAttachmentInfo(Long projectId, String attachmentGroup, String attachment);
diff --git a/server-core/src/main/java/io/onedev/server/attachment/DefaultAttachmentManager.java b/server-core/src/main/java/io/onedev/server/attachment/DefaultAttachmentManager.java
index be979d09f1..1cb802b27f 100644
--- a/server-core/src/main/java/io/onedev/server/attachment/DefaultAttachmentManager.java
+++ b/server-core/src/main/java/io/onedev/server/attachment/DefaultAttachmentManager.java
@@ -539,11 +539,11 @@ public class DefaultAttachmentManager implements AttachmentManager, SchedulableT
}
@Override
- public String saveAttachment(Long projectId, String attachmentGroup, String suggestedAttachmentName,
+ public String saveAttachment(Long projectId, String attachmentGroup, String preferredAttachmentName,
InputStream attachmentStream) {
String activeServer = projectManager.getActiveServer(projectId, true);
if (activeServer.equals(clusterManager.getLocalServerAddress())) {
- return saveAttachmentLocal(projectId, attachmentGroup, suggestedAttachmentName, attachmentStream);
+ return saveAttachmentLocal(projectId, attachmentGroup, preferredAttachmentName, attachmentStream);
} else {
Client client = ClientBuilder.newClient();
client.property(ClientProperties.REQUEST_ENTITY_PROCESSING, "CHUNKED");
@@ -553,7 +553,7 @@ public class DefaultAttachmentManager implements AttachmentManager, SchedulableT
.path("~api/cluster/attachment")
.queryParam("projectId", projectId)
.queryParam("attachmentGroup", attachmentGroup)
- .queryParam("suggestedAttachmentName", suggestedAttachmentName);
+ .queryParam("suggestedAttachmentName", preferredAttachmentName);
var builder = target.request();
builder.header(AUTHORIZATION, BEARER + " " + clusterManager.getCredential());
@@ -577,10 +577,10 @@ public class DefaultAttachmentManager implements AttachmentManager, SchedulableT
}
@Override
- public String saveAttachmentLocal(Long projectId, String attachmentGroup, String suggestedAttachmentName,
+ public String saveAttachmentLocal(Long projectId, String attachmentGroup, String preferredAttachmentName,
InputStream attachmentStream) {
return write(getAttachmentLockName(projectId, attachmentGroup), () -> {
- var suggestedAttachmentNameCopy = suggestedAttachmentName;
+ var suggestedAttachmentNameCopy = preferredAttachmentName;
suggestedAttachmentNameCopy = suggestedAttachmentNameCopy.replace("..", "-");
String attachmentName = suggestedAttachmentNameCopy;
File attachmentDir = getAttachmentGroupDir(projectId, attachmentGroup);
diff --git a/server-core/src/main/java/io/onedev/server/model/Issue.java b/server-core/src/main/java/io/onedev/server/model/Issue.java
index 10341afb3d..4d6baeab2f 100644
--- a/server-core/src/main/java/io/onedev/server/model/Issue.java
+++ b/server-core/src/main/java/io/onedev/server/model/Issue.java
@@ -1,5 +1,6 @@
package io.onedev.server.model;
+import static com.fasterxml.jackson.annotation.JsonProperty.Access.READ_ONLY;
import static io.onedev.server.model.AbstractEntity.PROP_NUMBER;
import static io.onedev.server.model.Issue.PROP_BOARD_POSITION;
import static io.onedev.server.model.Issue.PROP_COMMENT_COUNT;
@@ -60,6 +61,7 @@ import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.DynamicUpdate;
+import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
@@ -338,6 +340,7 @@ public class Issue extends ProjectBelonging implements AttachmentStorageSupport
private int progress = -1;
+ @JsonProperty(access = READ_ONLY)
private int descriptionRevisionCount;
@Column(nullable=false)
diff --git a/server-core/src/main/java/io/onedev/server/model/IssueComment.java b/server-core/src/main/java/io/onedev/server/model/IssueComment.java
index 27cdedecf5..b56fb3c504 100644
--- a/server-core/src/main/java/io/onedev/server/model/IssueComment.java
+++ b/server-core/src/main/java/io/onedev/server/model/IssueComment.java
@@ -1,5 +1,7 @@
package io.onedev.server.model;
+import static com.fasterxml.jackson.annotation.JsonProperty.Access.READ_ONLY;
+
import java.util.ArrayList;
import java.util.Collection;
@@ -14,6 +16,8 @@ import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.Table;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
import io.onedev.server.model.support.EntityComment;
import io.onedev.server.rest.annotation.Immutable;
import io.onedev.server.util.facade.IssueCommentFacade;
@@ -38,6 +42,7 @@ public class IssueComment extends EntityComment {
@OneToMany(mappedBy="comment", cascade=CascadeType.REMOVE)
private Collection<IssueCommentRevision> revisions = new ArrayList<>();
+ @JsonProperty(access = READ_ONLY)
private int revisionCount;
@Lob
diff --git a/server-core/src/main/java/io/onedev/server/model/PullRequest.java b/server-core/src/main/java/io/onedev/server/model/PullRequest.java
index b3be8e9fed..4e7444acaf 100644
--- a/server-core/src/main/java/io/onedev/server/model/PullRequest.java
+++ b/server-core/src/main/java/io/onedev/server/model/PullRequest.java
@@ -1,5 +1,6 @@
package io.onedev.server.model;
+import static com.fasterxml.jackson.annotation.JsonProperty.Access.READ_ONLY;
import static io.onedev.server.model.AbstractEntity.PROP_NUMBER;
import static io.onedev.server.model.PullRequest.PROP_CLOSE_DAY;
import static io.onedev.server.model.PullRequest.PROP_CLOSE_MONTH;
@@ -69,6 +70,7 @@ import org.eclipse.jgit.revwalk.RevCommit;
import org.hibernate.annotations.DynamicUpdate;
import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
@@ -376,6 +378,7 @@ public class PullRequest extends ProjectBelonging
private int eyesCount;
+ @JsonProperty(access = READ_ONLY)
private int descriptionRevisionCount;
@Embedded
diff --git a/server-core/src/main/java/io/onedev/server/model/PullRequestComment.java b/server-core/src/main/java/io/onedev/server/model/PullRequestComment.java
index 42ef385c18..1b3bf2792b 100644
--- a/server-core/src/main/java/io/onedev/server/model/PullRequestComment.java
+++ b/server-core/src/main/java/io/onedev/server/model/PullRequestComment.java
@@ -1,5 +1,7 @@
package io.onedev.server.model;
+import static com.fasterxml.jackson.annotation.JsonProperty.Access.READ_ONLY;
+
import java.util.ArrayList;
import java.util.Collection;
@@ -12,6 +14,8 @@ import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.Table;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
import io.onedev.server.model.support.EntityComment;
import io.onedev.server.rest.annotation.Immutable;
import io.onedev.server.util.facade.PullRequestCommentFacade;
@@ -35,6 +39,7 @@ public class PullRequestComment extends EntityComment {
@OneToMany(mappedBy="comment", cascade=CascadeType.REMOVE)
private Collection<PullRequestCommentRevision> revisions = new ArrayList<>();
+ @JsonProperty(access = READ_ONLY)
private int revisionCount;
public PullRequest getRequest() {
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/IssueResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/IssueResource.java
index b4cad25db5..ef74a6087f 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/IssueResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/IssueResource.java
@@ -1,5 +1,6 @@
package io.onedev.server.rest.resource;
+import java.io.InputStream;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
@@ -33,6 +34,7 @@ import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.onedev.server.OneDev;
+import io.onedev.server.attachment.AttachmentManager;
import io.onedev.server.data.migration.VersionedXmlDoc;
import io.onedev.server.entitymanager.AuditManager;
import io.onedev.server.entitymanager.IssueChangeManager;
@@ -61,6 +63,7 @@ import io.onedev.server.search.entity.issue.IssueQuery;
import io.onedev.server.search.entity.issue.IssueQueryParseOption;
import io.onedev.server.security.SecurityUtils;
import io.onedev.server.util.ProjectScopedCommit;
+import io.onedev.server.web.UrlManager;
import io.onedev.server.web.page.help.ApiHelpUtils;
import io.onedev.server.web.page.help.ValueInfo;
@@ -86,11 +89,17 @@ public class IssueResource {
private final ObjectMapper objectMapper;
private final AuditManager auditManager;
-
+
+ private final AttachmentManager attachmentManager;
+
+ private final UrlManager urlManager;
+
@Inject
public IssueResource(SettingManager settingManager, IssueManager issueManager,
IssueChangeManager issueChangeManager, IterationManager iterationManager,
- ProjectManager projectManager, ObjectMapper objectMapper, AuditManager auditManager) {
+ ProjectManager projectManager, ObjectMapper objectMapper,
+ AuditManager auditManager, AttachmentManager attachmentManager,
+ UrlManager urlManager) {
this.settingManager = settingManager;
this.issueManager = issueManager;
this.issueChangeManager = issueChangeManager;
@@ -98,6 +107,8 @@ public class IssueResource {
this.projectManager = projectManager;
this.objectMapper = objectMapper;
this.auditManager = auditManager;
+ this.attachmentManager = attachmentManager;
+ this.urlManager = urlManager;
}
@Api(order=100)
@@ -418,6 +429,21 @@ public class IssueResource {
data.getRemoveFields(), data.getComment());
return Response.ok().build();
}
+
+ @Api(order=1550, example = "/~downloads/projects/1/attachments/6a5a1a20-c8c0-44a5-a1bb-8a3d2a830094/attachment.txt",
+ description = "Upload attachment to issue and get attachment url via response. This url can then be used in issue description or comment")
+ @Path("/{issueId}/attachments/{preferredAttachmentName}")
+ @POST
+ @Consumes(MediaType.APPLICATION_OCTET_STREAM)
+ public String uploadAttachment(@PathParam("issueId") Long issueId, @PathParam("preferredAttachmentName") String preferredAttachmentName, InputStream input) {
+ Issue issue = issueManager.load(issueId);
+ if (!SecurityUtils.canModifyIssue(issue))
+ throw new UnauthorizedException();
+
+ var attachmentName = attachmentManager.saveAttachment(issue.getProject().getId(), issue.getUUID(), preferredAttachmentName, input);
+ var url = urlManager.urlForAttachment(issue.getProject(), issue.getUUID(), attachmentName, false);
+ return url;
+ }
@Api(order=1600)
@Path("/{issueId}")
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/PullRequestResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/PullRequestResource.java
index af588c4fc1..1b41f7b6b5 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/PullRequestResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/PullRequestResource.java
@@ -3,6 +3,7 @@ package io.onedev.server.rest.resource;
import static io.onedev.server.model.support.pullrequest.MergeStrategy.SQUASH_SOURCE_BRANCH_COMMITS;
import static javax.ws.rs.core.Response.Status.NOT_ACCEPTABLE;
+import java.io.InputStream;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
@@ -29,6 +30,7 @@ import org.apache.shiro.authz.UnauthorizedException;
import org.eclipse.jgit.lib.ObjectId;
import org.joda.time.DateTime;
+import io.onedev.server.attachment.AttachmentManager;
import io.onedev.server.data.migration.VersionedXmlDoc;
import io.onedev.server.entitymanager.AuditManager;
import io.onedev.server.entitymanager.PullRequestChangeManager;
@@ -56,6 +58,7 @@ import io.onedev.server.rest.resource.support.RestConstants;
import io.onedev.server.search.entity.pullrequest.PullRequestQuery;
import io.onedev.server.security.SecurityUtils;
import io.onedev.server.util.ProjectAndBranch;
+import io.onedev.server.web.UrlManager;
@Api(name="Pull Request", description="In most cases, pull request resource is operated with pull request id, which is different from pull request number. "
+ "To get pull request id of a particular pull request number, use the <a href='/~help/api/io.onedev.server.rest.PullRequestResource/queryBasicInfo'>Query Basic Info</a> operation with query for "
@@ -75,16 +78,23 @@ public class PullRequestResource {
private final GitService gitService;
private final AuditManager auditManager;
+
+ private final AttachmentManager attachmentManager;
+
+ private final UrlManager urlManager;
@Inject
public PullRequestResource(PullRequestManager pullRequestManager,
PullRequestChangeManager pullRequestChangeManager,
- UserManager userManager, GitService gitService, AuditManager auditManager) {
+ UserManager userManager, GitService gitService, AuditManager auditManager,
+ AttachmentManager attachmentManager, UrlManager urlManager) {
this.pullRequestManager = pullRequestManager;
this.pullRequestChangeManager = pullRequestChangeManager;
this.userManager = userManager;
this.gitService = gitService;
this.auditManager = auditManager;
+ this.attachmentManager = attachmentManager;
+ this.urlManager = urlManager;
}
@Api(order=100)
@@ -490,6 +500,21 @@ public class PullRequestResource {
pullRequestManager.restoreSourceBranch(request, note);
return Response.ok().build();
}
+
+ @Api(order=2050, example = "/~downloads/projects/1/attachments/6a5a1a20-c8c0-44a5-a1bb-8a3d2a830094/attachment.txt",
+ description = "Upload attachment to pull request and get attachment url via response. This url can then be used in pull request description or comment")
+ @Path("/{requestId}/attachments/{preferredAttachmentName}")
+ @POST
+ @Consumes(MediaType.APPLICATION_OCTET_STREAM)
+ public String uploadAttachment(@PathParam("requestId") Long requestId, @PathParam("preferredAttachmentName") String preferredAttachmentName, InputStream input) {
+ PullRequest request = pullRequestManager.load(requestId);
+ if (!SecurityUtils.canModifyPullRequest(request))
+ throw new UnauthorizedException();
+
+ var attachmentName = attachmentManager.saveAttachment(request.getProject().getId(), request.getUUID(), preferredAttachmentName, input);
+ var url = urlManager.urlForAttachment(request.getProject(), request.getUUID(), attachmentName, false);
+ return url;
+ }
@Api(order=2100)
@Path("/{requestId}")
diff --git a/server-core/src/main/java/io/onedev/server/web/DefaultUrlManager.java b/server-core/src/main/java/io/onedev/server/web/DefaultUrlManager.java
index 729a9b135b..8f8a923081 100644
--- a/server-core/src/main/java/io/onedev/server/web/DefaultUrlManager.java
+++ b/server-core/src/main/java/io/onedev/server/web/DefaultUrlManager.java
@@ -12,11 +12,14 @@ import io.onedev.server.web.page.project.compare.RevisionComparePage;
import io.onedev.server.web.page.project.pullrequests.detail.changes.PullRequestChangesPage;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.request.mapper.parameter.PageParametersEncoder;
+import org.apache.wicket.util.encoding.UrlEncoder;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.revwalk.RevCommit;
import javax.inject.Inject;
import javax.inject.Singleton;
+
+import java.nio.charset.StandardCharsets;
import java.util.List;
@Singleton
@@ -157,6 +160,13 @@ public class DefaultUrlManager implements UrlManager {
return urlFor(project, withRootUrl) + "/~pulls/" + pullRequestNumber;
}
+ @Override
+ public String urlForAttachment(Project project, String attachmentGroup, String attachmentName, boolean withRootUrl) {
+ var encodedAttachmentGroup = UrlEncoder.PATH_INSTANCE.encode(attachmentGroup, StandardCharsets.UTF_8);
+ var encodedAttachmentName = UrlEncoder.PATH_INSTANCE.encode(attachmentName, StandardCharsets.UTF_8);
+ return (withRootUrl ? settingManager.getSystemSetting().getServerUrl() : "") + "/~downloads/projects/" + project.getId() + "/attachments/" + encodedAttachmentGroup + "/" + encodedAttachmentName;
+ }
+
@Override
public String urlFor(PullRequestComment comment, boolean withRootUrl) {
return urlFor(comment.getRequest(), withRootUrl) + "#" + comment.getAnchor();
diff --git a/server-core/src/main/java/io/onedev/server/web/UrlManager.java b/server-core/src/main/java/io/onedev/server/web/UrlManager.java
index 1bbfaadafe..e6e3f14c2a 100644
--- a/server-core/src/main/java/io/onedev/server/web/UrlManager.java
+++ b/server-core/src/main/java/io/onedev/server/web/UrlManager.java
@@ -31,6 +31,8 @@ public interface UrlManager {
String urlFor(IssueComment comment, boolean withRootUrl);
String urlFor(IssueChange change, boolean withRootUrl);
+
+ String urlForAttachment(Project project, String attachmentGroup, String attachmentName, boolean withRootUrl);
String urlFor(CodeComment comment, boolean withRootUrl);
diff --git a/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.java b/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.java
index 34a83d1b31..4c5a91a0e4 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/help/ExampleValuePanel.java
@@ -296,11 +296,15 @@ public class ExampleValuePanel extends Panel {
private Fragment newScalarFragment(Serializable value) {
Fragment fragment = new Fragment("content", "scalarFrag", this);
- var valueOrigin = getValueOrigin();
- if (valueOrigin == CREATE_BODY || valueOrigin == UPDATE_BODY || valueOrigin == READ_BODY)
+ if (findParent(ExampleValuePanel.class) != null) {
fragment.add(new Label("value", toJson(value)));
- else
- fragment.add(new Label("value", String.valueOf(value)));
+ } else {
+ var valueOrigin = getValueOrigin();
+ if ((valueOrigin == CREATE_BODY || valueOrigin == UPDATE_BODY || valueOrigin == READ_BODY) && (value instanceof Date || value instanceof Enum))
+ fragment.add(new Label("value", toJson(value)));
+ else
+ fragment.add(new Label("value", String.valueOf(value)));
+ }
return fragment;
}