Skip to content

The Unified and Autonomous Development Platform

Fix the issue that pre-receive hook does not work for git version 2.11 or higher

Robin Shencfe6ebe2f815
diff --git a/core/src/main/java/com/gitplex/server/git/GitPreReceiveCallback.java b/core/src/main/java/com/gitplex/server/git/GitPreReceiveCallback.java
index 1d52263a18..dd36d77d12 100644
--- a/core/src/main/java/com/gitplex/server/git/GitPreReceiveCallback.java
+++ b/core/src/main/java/com/gitplex/server/git/GitPreReceiveCallback.java
@@ -1,9 +1,11 @@
package com.gitplex.server.git;
-import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.net.InetAddress;
+import java.util.Enumeration;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import javax.annotation.Nullable;
import javax.inject.Inject;
@@ -13,7 +15,6 @@ import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import org.apache.commons.io.IOUtils;
import org.apache.shiro.SecurityUtils;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.ObjectId;
@@ -94,7 +95,7 @@ public class GitPreReceiveCallback extends HttpServlet {
"Git hook callbacks can only be accessed from localhost.");
return;
}
-
+
List<String> fields = StringUtils.splitAndTrim(request.getPathInfo(), "/");
Preconditions.checkState(fields.size() == 2);
@@ -102,9 +103,26 @@ public class GitPreReceiveCallback extends HttpServlet {
try {
Project project = projectManager.load(Long.valueOf(fields.get(0)));
- ByteArrayOutputStream baos = new ByteArrayOutputStream();
- IOUtils.copy(request.getInputStream(), baos);
-
+ String refUpdateInfo = null;
+
+ /*
+ * Since git 2.11, pushed commits will be placed in to a QUARANTINE directory when pre-receive hook
+ * is fired. Current version of jgit does not pick up objects in this directory so we should call
+ * native git instead with various environments passed from pre-receive hook
+ */
+ Map<String, String> gitEnvs = new HashMap<>();
+ Enumeration<String> paramNames = request.getParameterNames();
+ while (paramNames.hasMoreElements()) {
+ String paramName = paramNames.nextElement();
+ if (paramName.contains(" ")) {
+ refUpdateInfo = paramName;
+ } else if (paramName.startsWith("ENV_")) {
+ gitEnvs.put(paramName.substring("ENV_".length()), request.getParameter(paramName));
+ }
+ }
+
+ Preconditions.checkState(refUpdateInfo != null, "Git ref update information is not available");
+
Output output = new Output(response.getOutputStream());
/*
@@ -113,9 +131,8 @@ public class GitPreReceiveCallback extends HttpServlet {
* to curl via "@-", below logic is used to parse these info correctly even
* without line breaks.
*/
- String callbackData = new String(baos.toByteArray());
- callbackData = StringUtils.reverse(StringUtils.remove(callbackData, '\n'));
- fields = StringUtils.splitAndTrim(callbackData, " ");
+ refUpdateInfo = StringUtils.reverse(StringUtils.remove(refUpdateInfo, '\n'));
+ fields = StringUtils.splitAndTrim(refUpdateInfo, " ");
int pos = 0;
while (true) {
@@ -143,12 +160,12 @@ public class GitPreReceiveCallback extends HttpServlet {
BranchProtection protection = project.getBranchProtection(branchName);
if (protection != null && protection.isNoDeletion())
error(output, refName, "Can not delete this branch according to branch protection setting");
- } else if (!GitUtils.isMergedInto(project.getRepository(), oldObjectId, newObjectId)) {
+ } else if (!GitUtils.isMergedInto(project.getGitDir(), gitEnvs, oldObjectId.name(), newObjectId.name())) {
BranchProtection protection = project.getBranchProtection(branchName);
if (protection != null && protection.isNoForcedPush())
error(output, refName, "Can not force-push to this branch according to branch protection setting");
} else {
- if (projectManager.isPushNeedsQualityCheck(user, project, branchName, oldObjectId, newObjectId)) {
+ if (projectManager.isPushNeedsQualityCheck(user, project, branchName, oldObjectId, newObjectId, gitEnvs)) {
error(output, refName,
"Your changes need to be reviewed/verified. Please submit pull request instead");
}
diff --git a/core/src/main/java/com/gitplex/server/git/GitUtils.java b/core/src/main/java/com/gitplex/server/git/GitUtils.java
index fce4903125..2f9d7c8462 100644
--- a/core/src/main/java/com/gitplex/server/git/GitUtils.java
+++ b/core/src/main/java/com/gitplex/server/git/GitUtils.java
@@ -6,6 +6,7 @@ import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;
+import java.util.Map;
import java.util.concurrent.Callable;
import java.util.regex.Pattern;
@@ -43,6 +44,7 @@ import org.eclipse.jgit.util.SystemReader;
import org.eclipse.jgit.util.io.NullOutputStream;
import com.gitplex.server.git.command.FetchCommand;
+import com.gitplex.server.git.command.IsAncestorCommand;
import com.gitplex.server.git.exception.ObsoleteCommitException;
import com.gitplex.server.git.exception.RefUpdateException;
import com.gitplex.server.util.diff.WhitespaceOption;
@@ -376,6 +378,12 @@ public class GitUtils {
}
}
+ public static boolean isMergedInto(File gitDir, Map<String, String> gitEnvs, String base, String tip) {
+ IsAncestorCommand cmd = new IsAncestorCommand(gitDir, gitEnvs);
+ cmd.ancestor(base).descendant(tip);
+ return cmd.call();
+ }
+
/**
* Get commit of specified revision id.
*
diff --git a/core/src/main/java/com/gitplex/server/git/command/IsAncestorCommand.java b/core/src/main/java/com/gitplex/server/git/command/IsAncestorCommand.java
new file mode 100644
index 0000000000..32863672a1
--- /dev/null
+++ b/core/src/main/java/com/gitplex/server/git/command/IsAncestorCommand.java
@@ -0,0 +1,68 @@
+package com.gitplex.server.git.command;
+
+import java.io.File;
+import java.util.Map;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.gitplex.utils.command.Commandline;
+import com.gitplex.utils.command.ExecuteResult;
+import com.gitplex.utils.command.LineConsumer;
+import com.google.common.base.Preconditions;
+
+public class IsAncestorCommand extends GitCommand<Boolean> {
+
+ private static final Logger logger = LoggerFactory.getLogger(IsAncestorCommand.class);
+
+ private String ancestor;
+
+ private String descendant;
+
+ public IsAncestorCommand(File gitDir, Map<String, String> gitEnvs) {
+ super(gitDir, gitEnvs);
+ }
+
+ public IsAncestorCommand ancestor(String ancestor) {
+ this.ancestor = ancestor;
+ return this;
+ }
+
+ public IsAncestorCommand descendant(String descendant) {
+ this.descendant = descendant;
+ return this;
+ }
+
+ @Override
+ public Boolean call() {
+ Preconditions.checkNotNull(ancestor, "ancestor has to be specified.");
+ Preconditions.checkNotNull(descendant, "descendant has to be specified.");
+
+ Commandline cmd = cmd();
+
+ cmd.addArgs("merge-base", "--is-ancestor", ancestor, descendant);
+
+ ExecuteResult result = cmd.execute(new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ }
+
+ }, new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ logger.error(line);
+ }
+
+ });
+
+ if (result.getReturnCode() == 0)
+ return true;
+ else if (result.getReturnCode() == 1)
+ return false;
+ else
+ throw result.buildException();
+ }
+
+}
\ No newline at end of file
diff --git a/core/src/main/java/com/gitplex/server/git/command/ListChangedFilesCommand.java b/core/src/main/java/com/gitplex/server/git/command/ListChangedFilesCommand.java
new file mode 100644
index 0000000000..634e2db63e
--- /dev/null
+++ b/core/src/main/java/com/gitplex/server/git/command/ListChangedFilesCommand.java
@@ -0,0 +1,80 @@
+package com.gitplex.server.git.command;
+
+import java.io.File;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import org.eclipse.jgit.util.QuotedString;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.gitplex.utils.command.Commandline;
+import com.gitplex.utils.command.LineConsumer;
+import com.google.common.base.Preconditions;
+
+public class ListChangedFilesCommand extends GitCommand<Collection<String>> {
+
+ private static final Logger logger = LoggerFactory.getLogger(ListChangedFilesCommand.class);
+
+ private String fromRev;
+
+ private String toRev;
+
+ private String path;
+
+ public ListChangedFilesCommand(File gitDir, Map<String, String> gitEnvs) {
+ super(gitDir, gitEnvs);
+ }
+
+ public ListChangedFilesCommand fromRev(String fromRev) {
+ this.fromRev = fromRev;
+ return this;
+ }
+
+ public ListChangedFilesCommand toRev(String toRev) {
+ this.toRev = toRev;
+ return this;
+ }
+
+ public ListChangedFilesCommand path(String path) {
+ this.path = path;
+ return this;
+ }
+
+ @Override
+ public Collection<String> call() {
+ Preconditions.checkNotNull(toRev, "toRev has to be specified.");
+ Preconditions.checkNotNull(fromRev, "fromRev has to be specified.");
+
+ final Set<String> changedFiles = new HashSet<String>();
+
+ Commandline cmd = cmd();
+
+ cmd.addArgs("diff", "--name-only", "--no-renames", fromRev + ".." + toRev);
+
+ if (path != null)
+ cmd.addArgs("--", path);
+
+ cmd.execute(new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ if (line.trim().length() != 0)
+ changedFiles.add(QuotedString.GIT_PATH.dequote(line));
+ }
+
+ }, new LineConsumer() {
+
+ @Override
+ public void consume(String line) {
+ logger.error(line);
+ }
+
+ }).checkReturnCode();
+
+ return changedFiles;
+ }
+
+}
diff --git a/core/src/main/java/com/gitplex/server/manager/ProjectManager.java b/core/src/main/java/com/gitplex/server/manager/ProjectManager.java
index c1edc67dfe..b2dc6eca79 100644
--- a/core/src/main/java/com/gitplex/server/manager/ProjectManager.java
+++ b/core/src/main/java/com/gitplex/server/manager/ProjectManager.java
@@ -1,6 +1,7 @@
package com.gitplex.server.manager;
import java.util.Collection;
+import java.util.Map;
import javax.annotation.Nullable;
@@ -62,9 +63,12 @@ public interface ProjectManager extends EntityManager<Project> {
* old object id of the ref
* @param newObjectId
* new object id of the ref
+ * @param gitEnvs
+ * git environments
* @return
* result of the check
*/
- boolean isPushNeedsQualityCheck(User user, Project project, String branchName, ObjectId oldObjectId, ObjectId newObjectId);
+ boolean isPushNeedsQualityCheck(User user, Project project, String branchName, ObjectId oldObjectId,
+ ObjectId newObjectId, @Nullable Map<String, String> gitEnvs);
}
diff --git a/core/src/main/java/com/gitplex/server/manager/impl/DefaultProjectManager.java b/core/src/main/java/com/gitplex/server/manager/impl/DefaultProjectManager.java
index 90cd341c6b..abbb791dd4 100644
--- a/core/src/main/java/com/gitplex/server/manager/impl/DefaultProjectManager.java
+++ b/core/src/main/java/com/gitplex/server/manager/impl/DefaultProjectManager.java
@@ -36,6 +36,7 @@ import com.gitplex.server.event.lifecycle.SystemStarted;
import com.gitplex.server.event.lifecycle.SystemStopping;
import com.gitplex.server.git.GitUtils;
import com.gitplex.server.git.command.CloneCommand;
+import com.gitplex.server.git.command.ListChangedFilesCommand;
import com.gitplex.server.manager.CacheManager;
import com.gitplex.server.manager.CommitInfoManager;
import com.gitplex.server.manager.ProjectManager;
@@ -200,7 +201,7 @@ public class DefaultProjectManager extends AbstractEntityManager<Project> implem
try {
String content = FileUtils.readFileToString(hookFile);
- if (!content.contains("GITPLEX_USER_ID"))
+ if (!content.contains("ENV_GIT_ALTERNATE_OBJECT_DIRECTORIES"))
return false;
} catch (IOException e) {
throw new RuntimeException(e);
@@ -311,22 +312,29 @@ public class DefaultProjectManager extends AbstractEntityManager<Project> implem
return projects;
}
- private Set<String> getChangedFiles(Project project, ObjectId oldObjectId, ObjectId newObjectId) {
- Set<String> changedFiles = new HashSet<>();
- try (TreeWalk treeWalk = new TreeWalk(project.getRepository())) {
- treeWalk.setFilter(TreeFilter.ANY_DIFF);
- treeWalk.setRecursive(true);
- RevCommit oldCommit = project.getRevCommit(oldObjectId);
- RevCommit newCommit = project.getRevCommit(newObjectId);
- treeWalk.addTree(oldCommit.getTree());
- treeWalk.addTree(newCommit.getTree());
- while (treeWalk.next()) {
- changedFiles.add(treeWalk.getPathString());
+ private Collection<String> getChangedFiles(Project project, ObjectId oldObjectId, ObjectId newObjectId,
+ Map<String, String> gitEnvs) {
+ if (gitEnvs != null) {
+ ListChangedFilesCommand cmd = new ListChangedFilesCommand(project.getGitDir(), gitEnvs);
+ cmd.fromRev(oldObjectId.name()).toRev(newObjectId.name());
+ return cmd.call();
+ } else {
+ Set<String> changedFiles = new HashSet<>();
+ try (TreeWalk treeWalk = new TreeWalk(project.getRepository())) {
+ treeWalk.setFilter(TreeFilter.ANY_DIFF);
+ treeWalk.setRecursive(true);
+ RevCommit oldCommit = project.getRevCommit(oldObjectId);
+ RevCommit newCommit = project.getRevCommit(newObjectId);
+ treeWalk.addTree(oldCommit.getTree());
+ treeWalk.addTree(newCommit.getTree());
+ while (treeWalk.next()) {
+ changedFiles.add(treeWalk.getPathString());
+ }
+ } catch (IOException e) {
+ throw new RuntimeException(e);
}
- } catch (IOException e) {
- throw new RuntimeException(e);
+ return changedFiles;
}
- return changedFiles;
}
@Override
@@ -350,7 +358,8 @@ public class DefaultProjectManager extends AbstractEntityManager<Project> implem
}
@Override
- public boolean isPushNeedsQualityCheck(User user, Project project, String branch, ObjectId oldObjectId, ObjectId newObjectId) {
+ public boolean isPushNeedsQualityCheck(User user, Project project, String branch, ObjectId oldObjectId,
+ ObjectId newObjectId, Map<String, String> gitEnvs) {
BranchProtection branchProtection = project.getBranchProtection(branch);
if (branchProtection != null) {
if (branchProtection.getReviewRequirement() != null
@@ -363,7 +372,7 @@ public class DefaultProjectManager extends AbstractEntityManager<Project> implem
return true;
}
- for (String changedFile: getChangedFiles(project, oldObjectId, newObjectId)) {
+ for (String changedFile: getChangedFiles(project, oldObjectId, newObjectId, gitEnvs)) {
FileProtection fileProtection = branchProtection.getFileProtection(changedFile);
if (fileProtection != null && !fileProtection.getReviewRequirement().matches(user))
return true;
diff --git a/core/src/main/java/com/gitplex/server/security/SecurityUtils.java b/core/src/main/java/com/gitplex/server/security/SecurityUtils.java
index ef7d2a83fc..f0f279172e 100644
--- a/core/src/main/java/com/gitplex/server/security/SecurityUtils.java
+++ b/core/src/main/java/com/gitplex/server/security/SecurityUtils.java
@@ -168,12 +168,13 @@ public class SecurityUtils extends org.apache.shiro.SecurityUtils {
}
public static boolean canModify(Project project, String branch, String file) {
- return canWrite(project) && !GitPlex.getInstance(ProjectManager.class).isModificationNeedsQualityCheck(getUser(), project, branch, file);
+ return canWrite(project) && !GitPlex.getInstance(ProjectManager.class)
+ .isModificationNeedsQualityCheck(getUser(), project, branch, file);
}
public static boolean canPush(Project project, String branchName, ObjectId oldObjectId, ObjectId newObjectId) {
- return canWrite(project) && !GitPlex.getInstance(ProjectManager.class).isPushNeedsQualityCheck(getUser(), project, branchName,
- oldObjectId, newObjectId);
+ return canWrite(project) && !GitPlex.getInstance(ProjectManager.class)
+ .isPushNeedsQualityCheck(getUser(), project, branchName, oldObjectId, newObjectId, null);
}
public static boolean canManage(User user) {
diff --git a/core/src/main/resources/git-receive-hook b/core/src/main/resources/git-receive-hook
index ea78cabea8..653c3be594 100644
--- a/core/src/main/resources/git-receive-hook
+++ b/core/src/main/resources/git-receive-hook
@@ -1,6 +1,6 @@
#!/bin/bash
IFS=$'\r\n';
-lines=($(${GITPLEX_CURL} -k -s -S -f -X POST -d @- ${GITPLEX_URL}/%s/${GITPLEX_REPOSITORY_ID}/${GITPLEX_USER_ID} 2>&1))
+lines=($(${GITPLEX_CURL} -k -s -S -f -X POST --data-urlencode "ENV_GIT_ALTERNATE_OBJECT_DIRECTORIES=${GIT_ALTERNATE_OBJECT_DIRECTORIES}" --data-urlencode "ENV_GIT_OBJECT_DIRECTORY=${GIT_OBJECT_DIRECTORY}" --data-urlencode "ENV_GIT_QUARANTINE_PATH=${GIT_QUARANTINE_PATH}" -d @- ${GITPLEX_URL}/%s/${GITPLEX_REPOSITORY_ID}/${GITPLEX_USER_ID} 2>&1))
returnCode=0;