The Unified and Autonomous Development Platform
feat: Git Pre/Post Receive Callback Extension (OD-1920)
Robin Shen6b41acb26062
diff --git a/server-core/src/main/java/io/onedev/server/CoreModule.java b/server-core/src/main/java/io/onedev/server/CoreModule.javaindex 829b7f0446..faa8831e2c 100644--- a/server-core/src/main/java/io/onedev/server/CoreModule.java+++ b/server-core/src/main/java/io/onedev/server/CoreModule.java@@ -39,6 +39,7 @@ import io.onedev.server.exception.handler.ExceptionHandler;import io.onedev.server.git.*;import io.onedev.server.git.hook.GitPostReceiveCallback;import io.onedev.server.git.hook.GitPreReceiveCallback;+import io.onedev.server.git.hook.GitPreReceiveChecker;import io.onedev.server.git.location.GitLocation;import io.onedev.server.git.service.DefaultGitService;import io.onedev.server.git.service.GitService;@@ -328,7 +329,8 @@ public class CoreModule extends AbstractPluginModule {contribute(LineCoverageContribution.class, (build, blobPath, reportName) -> new HashMap<>());contribute(AdministrationSettingContribution.class, () -> new ArrayList<>());contribute(ProjectSettingContribution.class, () -> new ArrayList<>());-+ contribute(GitPreReceiveChecker.class, (submitter, refName, oldObjectId, newObjectId) -> null);+bind(PackFilter.class);}diff --git a/server-core/src/main/java/io/onedev/server/git/hook/GitPreReceiveCallback.java b/server-core/src/main/java/io/onedev/server/git/hook/GitPreReceiveCallback.javaindex 8bf317c574..8e4b8d8b59 100644--- a/server-core/src/main/java/io/onedev/server/git/hook/GitPreReceiveCallback.java+++ b/server-core/src/main/java/io/onedev/server/git/hook/GitPreReceiveCallback.java@@ -38,9 +38,12 @@ public class GitPreReceiveCallback extends HttpServlet {private final ProjectManager projectManager;+ private final Set<GitPreReceiveChecker> preReceiveCheckers;+@Inject- public GitPreReceiveCallback(ProjectManager projectManager) {+ public GitPreReceiveCallback(ProjectManager projectManager, Set<GitPreReceiveChecker> preReceiveCheckers) {this.projectManager = projectManager;+ this.preReceiveCheckers = preReceiveCheckers;}private void error(Output output, @Nullable String refName, List<String> messages) {@@ -162,6 +165,13 @@ public class GitPreReceiveCallback extends HttpServlet {&& project.isBuildRequiredForPush(user, branchName, oldObjectId, newObjectId, gitEnvs)) {errorMessages.add("Build required for your change. Please submit pull request instead");}+ if (errorMessages.isEmpty()) {+ for (var preReceiveChecker : preReceiveCheckers) {+ var errorMessage = preReceiveChecker.check(user, refName, oldObjectId, newObjectId);+ if (errorMessage != null)+ errorMessages.add(errorMessage);+ }+ }if (errorMessages.isEmpty() && newObjectId.equals(ObjectId.zeroId())) {try {projectManager.onDeleteBranch(project, branchName);@@ -193,6 +203,13 @@ public class GitPreReceiveCallback extends HttpServlet {errorMessages.add("Can not update this tag as tag protection setting requires "+ "valid tag signature");}+ if (errorMessages.isEmpty()) {+ for (var preReceiveChecker : preReceiveCheckers) {+ var errorMessage = preReceiveChecker.check(user, refName, oldObjectId, newObjectId);+ if (errorMessage != null)+ errorMessages.add(errorMessage);+ }+ }if (errorMessages.isEmpty() && newObjectId.equals(ObjectId.zeroId())) {try {projectManager.onDeleteTag(project, tagName);diff --git a/server-core/src/main/java/io/onedev/server/git/hook/GitPreReceiveChecker.java b/server-core/src/main/java/io/onedev/server/git/hook/GitPreReceiveChecker.javanew file mode 100644index 0000000000..2849fc7396--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/git/hook/GitPreReceiveChecker.java@@ -0,0 +1,23 @@+package io.onedev.server.git.hook;++import io.onedev.commons.loader.ExtensionPoint;+import io.onedev.server.model.User;+import org.eclipse.jgit.lib.ObjectId;++import javax.annotation.Nullable;++@ExtensionPoint+public interface GitPreReceiveChecker {++ /**+ * Perform pre-receive check against specified ref update+ * @param submitter user to push code+ * @param refName+ * @param oldObjectId ObjectId.zeroId() when create ref+ * @param newObjectId ObjectId.zeroId() when delete ref+ * @return found error, or null if no errors found+ */+ @Nullable+ String check(User submitter, String refName, ObjectId oldObjectId, ObjectId newObjectId);++}diff --git a/server-core/src/main/java/io/onedev/server/pack/PackService.java b/server-core/src/main/java/io/onedev/server/pack/PackService.javaindex 3420cea09a..e13ab3bc92 100644--- a/server-core/src/main/java/io/onedev/server/pack/PackService.java+++ b/server-core/src/main/java/io/onedev/server/pack/PackService.java@@ -1,10 +1,13 @@package io.onedev.server.pack;+import io.onedev.commons.loader.ExtensionPoint;+import javax.annotation.Nullable;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.util.List;+@ExtensionPointpublic interface PackService {String getServiceId();diff --git a/server-core/src/main/java/io/onedev/server/pack/PackSupport.java b/server-core/src/main/java/io/onedev/server/pack/PackSupport.javaindex db573d22dc..76e23caf21 100644--- a/server-core/src/main/java/io/onedev/server/pack/PackSupport.java+++ b/server-core/src/main/java/io/onedev/server/pack/PackSupport.java@@ -1,11 +1,13 @@package io.onedev.server.pack;+import io.onedev.commons.loader.ExtensionPoint;import io.onedev.server.model.Pack;import io.onedev.server.model.Project;import org.apache.wicket.Component;import java.io.Serializable;+@ExtensionPointpublic interface PackSupport extends Serializable {int getOrder();diff --git a/server-product/src/main/java/io/onedev/server/product/ProductModule.java b/server-product/src/main/java/io/onedev/server/product/ProductModule.javaindex 3a5da38bbc..55fb24ddef 100644--- a/server-product/src/main/java/io/onedev/server/product/ProductModule.java+++ b/server-product/src/main/java/io/onedev/server/product/ProductModule.java@@ -31,6 +31,7 @@ public class ProductModule extends AbstractPluginModule {reserved.add(file.getName());return reserved;});+}}