Agit flow add refs/for-review/<pull index> support

cmd/serv.go

@@ -236,7 +236,8 @@ func runServ(c *cli.Context) error {
 		if git.DefaultFeatures().SupportProcReceive {
 			// for AGit Flow
 			if cmd == "ssh_info" {
-				fmt.Print(`{"type":"gitea","version":1}`)
+				data := private.GetSSHInfo(ctx)
+				fmt.Println(data)
 				return nil
 			}
 		}

modules/git/config.go

@@ -40,35 +40,41 @@ func syncGitConfig() (err error) {
 	}
 
 	// Set git some configurations - these must be set to these values for gitea to work correctly
-	if err := configSet("core.quotePath", "false"); err != nil {
+	if err = configSet("core.quotePath", "false"); err != nil {
 		return err
 	}
 
 	if DefaultFeatures().CheckVersionAtLeast("2.10") {
-		if err := configSet("receive.advertisePushOptions", "true"); err != nil {
+		if err = configSet("receive.advertisePushOptions", "true"); err != nil {
 			return err
 		}
 	}
 
 	if DefaultFeatures().CheckVersionAtLeast("2.18") {
-		if err := configSet("core.commitGraph", "true"); err != nil {
+		if err = configSet("core.commitGraph", "true"); err != nil {
 			return err
 		}
-		if err := configSet("gc.writeCommitGraph", "true"); err != nil {
+		if err = configSet("gc.writeCommitGraph", "true"); err != nil {
 			return err
 		}
-		if err := configSet("fetch.writeCommitGraph", "true"); err != nil {
+		if err = configSet("fetch.writeCommitGraph", "true"); err != nil {
 			return err
 		}
 	}
 
 	if DefaultFeatures().SupportProcReceive {
 		// set support for AGit flow
-		if err := configAddNonExist("receive.procReceiveRefs", "refs/for"); err != nil {
+		if err = configAddNonExist("receive.procReceiveRefs", "refs/for"); err != nil {
+			return err
+		}
+		if err = configAddNonExist("receive.procReceiveRefs", "refs/for-review"); err != nil {
 			return err
 		}
 	} else {
-		if err := configUnsetAll("receive.procReceiveRefs", "refs/for"); err != nil {
+		if err = configUnsetAll("receive.procReceiveRefs", "refs/for"); err != nil {
+			return err
+		}
+		if err = configUnsetAll("receive.procReceiveRefs", "refs/for-review"); err != nil {
 			return err
 		}
 	}

modules/git/ref.go

@@ -67,7 +67,8 @@ func (ref *Reference) RefGroup() string {
 // or refs/for/<targe-branch> -o topic='<topic-branch>'
 const ForPrefix = "refs/for/"
 
-// TODO: /refs/for-review for suggest change interface
+// ForReviewPrefix special ref to update a pull request: refs/for-review/<pull index>
+const ForReviewPrefix = "refs/for-review/"
 
 // RefName represents a full git reference name
 type RefName string
@@ -108,6 +109,12 @@ func (ref RefName) IsFor() bool {
 	return strings.HasPrefix(string(ref), ForPrefix)
 }
 
+var forReviewPattern = regexp.MustCompile(ForReviewPrefix + `[1-9]\d*$`)
+
+func (ref RefName) IsForReview() bool {
+	return forReviewPattern.MatchString(string(ref))
+}
+
 func (ref RefName) nameWithoutPrefix(prefix string) string {
 	if strings.HasPrefix(string(ref), prefix) {
 		return strings.TrimPrefix(string(ref), prefix)

modules/git/ref_test.go

@@ -28,6 +28,18 @@ func TestRefName(t *testing.T) {
 	assert.Equal(t, "main", RefName("refs/for/main").ForBranchName())
 	assert.Equal(t, "my/branch", RefName("refs/for/my/branch").ForBranchName())
 
+	// Test for review name
+	assert.False(t, RefName("refs/for-review/").IsForReview())
+	assert.False(t, RefName("refs/for-review/-1").IsForReview())
+	assert.False(t, RefName("refs/for-review/0").IsForReview())
+	assert.False(t, RefName("refs/for-review/01").IsForReview())
+	assert.True(t, RefName("refs/for-review/1").IsForReview())
+	assert.True(t, RefName("refs/for-review/10").IsForReview())
+	assert.True(t, RefName("refs/for-review/10999").IsForReview())
+	assert.False(t, RefName("refs/for-review/a10").IsForReview())
+	assert.False(t, RefName("refs/for-review/10a").IsForReview())
+	assert.False(t, RefName("refs/for-review/abc").IsForReview())
+
 	// Test commit hashes.
 	assert.Equal(t, "c0ffee", RefName("c0ffee").ShortName())
 }

modules/private/manager.go

@@ -12,6 +12,7 @@ import (
 	"strconv"
 	"time"
 
+	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
 )
 
@@ -36,6 +37,32 @@ func ReloadTemplates(ctx context.Context) ResponseExtra {
 	return requestJSONClientMsg(req, "Reloaded")
 }
 
+// Shutdown calls the internal shutdown function
+func GetSSHInfo(ctx context.Context) string {
+	reqURL := setting.LocalURL + "ssh_info"
+	req := newInternalRequest(ctx, reqURL, "GET")
+
+	resp, err := req.Response()
+	if err != nil {
+		log.Error("GetSSHInfo Error: %v", err)
+		return ""
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		log.Error("response status code is not OK, code: %d", resp.StatusCode)
+		return ""
+	}
+
+	content, err := io.ReadAll(resp.Body)
+	if err != nil {
+		log.Error("read body error: %v", err)
+		return ""
+	}
+
+	return string(content)
+}
+
 // FlushOptions represents the options for the flush call
 type FlushOptions struct {
 	Timeout     time.Duration

routers/private/hook_pre_receive.go

@@ -4,9 +4,12 @@
 package private
 
 import (
+	"errors"
 	"fmt"
 	"net/http"
 	"os"
+	"strconv"
+	"strings"
 
 	asymkey_model "code.gitea.io/gitea/models/asymkey"
 	git_model "code.gitea.io/gitea/models/git"
@@ -123,6 +126,8 @@ func HookPreReceive(ctx *gitea_context.PrivateContext) {
 			preReceiveTag(ourCtx, refFullName)
 		case git.DefaultFeatures().SupportProcReceive && refFullName.IsFor():
 			preReceiveFor(ourCtx, refFullName)
+		case git.DefaultFeatures().SupportProcReceive && refFullName.IsForReview():
+			preReceiveForReview(ourCtx, refFullName)
 		default:
 			ourCtx.AssertCanWriteCode()
 		}
@@ -468,6 +473,80 @@ func preReceiveFor(ctx *preReceiveContext, refFullName git.RefName) {
 	}
 }
 
+func canUpdateAgitPull(ctx *preReceiveContext, pull *issues_model.PullRequest) error {
+	if pull.Flow != issues_model.PullRequestFlowAGit {
+		return errors.New("Pull request that are not created through agit cannot be updated using agit")
+	}
+
+	if ctx.opts.UserID == pull.Issue.PosterID {
+		return nil
+	}
+
+	if !pull.AllowMaintainerEdit {
+		return fmt.Errorf("The author does not allow maintainers to edit this pull request")
+	}
+
+	if !ctx.loadPusherAndPermission() {
+		return fmt.Errorf("Internal Server Error (no specific error)")
+	}
+
+	if ctx.userPerm.CanWrite(unit.TypeCode) {
+		return errors.New("You have no permission to update this pull request")
+	}
+	return nil
+}
+
+func preReceiveForReview(ctx *preReceiveContext, refFullName git.RefName) {
+	if !ctx.AssertCreatePullRequest() {
+		return
+	}
+
+	if ctx.Repo.Repository.IsEmpty {
+		ctx.JSON(http.StatusForbidden, private.Response{
+			UserMsg: "Can't create pull request for an empty repository.",
+		})
+		return
+	}
+
+	if ctx.opts.IsWiki {
+		ctx.JSON(http.StatusForbidden, private.Response{
+			UserMsg: "Pull requests are not supported on the wiki.",
+		})
+		return
+	}
+
+	pullIndex, err := strconv.ParseInt(strings.TrimPrefix(string(refFullName), git.ForReviewPrefix), 10, 64)
+	if err != nil {
+		ctx.JSON(http.StatusForbidden, private.Response{
+			UserMsg: "Unknow pull request index.",
+		})
+		return
+	}
+	pull, err := issues_model.GetPullRequestByIndex(ctx, ctx.Repo.Repository.ID, pullIndex)
+	if err != nil {
+		log.Error("preReceiveForReview: GetPullRequestByIndex: err: %v", err)
+		ctx.JSON(http.StatusForbidden, private.Response{
+			UserMsg: "Unknow pull request index.",
+		})
+		return
+	}
+	err = pull.LoadIssue(ctx)
+	if err != nil {
+		log.Error("preReceiveForReview: pull.LoadIssue: err: %v", err)
+		ctx.JSON(http.StatusForbidden, private.Response{
+			UserMsg: "Unknow pull request.",
+		})
+		return
+	}
+
+	if err := canUpdateAgitPull(ctx, pull); err != nil {
+		ctx.JSON(http.StatusForbidden, private.Response{
+			UserMsg: err.Error(),
+		})
+		return
+	}
+}
+
 func generateGitEnv(opts *private.HookOptions) (env []string) {
 	env = os.Environ()
 	if opts.GitAlternativeObjectDirectories != "" {

routers/web/misc/misc.go

@@ -20,7 +20,7 @@ func SSHInfo(rw http.ResponseWriter, req *http.Request) {
 		return
 	}
 	rw.Header().Set("content-type", "text/json;charset=UTF-8")
-	_, err := rw.Write([]byte(`{"type":"gitea","version":1}`))
+	_, err := rw.Write([]byte(`{"type":"gitea","version":2}`))
 	if err != nil {
 		log.Error("fail to write result: err: %v", err)
 		rw.WriteHeader(http.StatusInternalServerError)