Redirect to fork or propose to create one when editing files

When viewing a file that the user can't edit because they can't write to
the branch, the edit and delete buttons are no longer disabled. Instead
they redirect to a the corresponding page in the user's fork, or to the
form to create a fork.

The form to create a fork will have an info message at the top explaining
why the fork is needed. After creating the fork, it redirects to the
relevant edit or delete page.

The redirect happens when accessing /_edit/, so that for example online
documentation can have an "edit this page" link to the base repository
that does the right thing.

Author: brechtvl

models/repo/repo.go

@@ -605,6 +605,11 @@ func (repo *Repository) Link() string {
 	return setting.AppSubURL + "/" + url.PathEscape(repo.OwnerName) + "/" + url.PathEscape(repo.Name)
 }
 
+// Change the repository in a link from the base to a fork repository
+func (repo *Repository) AdaptLinkToFork(forkRepo *Repository, link string) string {
+	return forkRepo.Link() + strings.TrimPrefix(link, repo.Link())
+}
+
 // ComposeCompareURL returns the repository comparison URL
 func (repo *Repository) ComposeCompareURL(oldCommitID, newCommitID string) string {
 	return fmt.Sprintf("%s/%s/compare/%s...%s", url.PathEscape(repo.OwnerName), url.PathEscape(repo.Name), util.PathEscapeSegments(oldCommitID), util.PathEscapeSegments(newCommitID))

options/locale/locale_en-US.ini

@@ -1051,6 +1051,7 @@ fork_from = Fork From
 already_forked = You've already forked %s
 fork_to_different_account = Fork to a different account
 fork_visibility_helper = The visibility of a forked repository cannot be changed.
+fork_to_edit_description = The %[1]s repository can not be edited directly.<br>To propose changes, you can fork the repository and create a pull request.
 fork_branch = Branch to be cloned to the fork
 all_branches = All branches
 view_all_branches = View all branches
@@ -1334,9 +1335,9 @@ editor.cannot_edit_non_text_files = Binary files cannot be edited in the web int
 editor.edit_this_file = Edit File
 editor.this_file_locked = File is locked
 editor.must_be_on_a_branch = You must be on a branch to make or propose changes to this file.
-editor.fork_before_edit = You must fork this repository to make or propose changes to this file.
+editor.fork_before_edit = Edit this file in a fork to propose changes.
 editor.delete_this_file = Delete File
-editor.must_have_write_access = You must have write access to make or propose changes to this file.
+editor.fork_before_delete = Delete this file in a fork to propose changes.
 editor.file_delete_success = File "%s" has been deleted.
 editor.name_your_file = Name your file…
 editor.filename_help = Add a directory by typing its name followed by a slash ('/'). Remove a directory by typing backspace at the beginning of the input field.

routers/web/repo/editor.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"net/url"
 	"path"
 	"strings"
 
@@ -45,6 +46,41 @@ func canCreateBasePullRequest(ctx *context.Context) bool {
 	return baseRepo != nil && baseRepo.UnitEnabled(ctx, unit.TypePullRequests)
 }
 
+// redirectToFork redirects to the user's fork when editing is not possible
+func redirectToFork(ctx *context.Context) bool {
+	if ctx.Repo.CanWriteToBranch(ctx, ctx.Doer, ctx.Repo.BranchName) {
+		return false
+	}
+
+	repo := ctx.Repo.Repository
+	userAndOrgForks, err := repo_model.GetForksByUserAndOrgs(ctx, ctx.Doer, repo)
+	if err != nil {
+		ctx.ServerError("GetForksByUserAndOrgs", err)
+		return true
+	}
+
+	// When already on a repo the user owns, don't redirect further even if
+	// writing to the branch is not possible.
+	for _, forkRepo := range userAndOrgForks {
+		if forkRepo.ID == repo.ID {
+			ctx.NotFound(nil)
+			return true
+		}
+	}
+
+	link := setting.AppSubURL + ctx.Req.URL.RequestURI()
+	if len(userAndOrgForks) > 0 {
+		// Redirect to user repository
+		forkRepo := userAndOrgForks[0]
+		ctx.Redirect(repo.AdaptLinkToFork(forkRepo, link))
+	} else {
+		// Redirect to create new user repository
+		ctx.Redirect(repo.Link() + "/fork/?redirect_to_edit=" + url.QueryEscape(link))
+	}
+
+	return true
+}
+
 func renderCommitRights(ctx *context.Context) bool {
 	canCommitToBranch, err := ctx.Repo.CanCommitToBranch(ctx, ctx.Doer)
 	if err != nil {
@@ -213,11 +249,19 @@ func GetEditorConfig(ctx *context.Context, treePath string) string {
 
 // EditFile render edit file page
 func EditFile(ctx *context.Context) {
+	if redirectToFork(ctx) {
+		return
+	}
+
 	editFile(ctx, false)
 }
 
 // NewFile render create file page
 func NewFile(ctx *context.Context) {
+	if redirectToFork(ctx) {
+		return
+	}
+
 	editFile(ctx, true)
 }
 
@@ -431,6 +475,10 @@ func DiffPreviewPost(ctx *context.Context) {
 
 // DeleteFile render delete file page
 func DeleteFile(ctx *context.Context) {
+	if redirectToFork(ctx) {
+		return
+	}
+
 	ctx.Data["PageIsDelete"] = true
 	ctx.Data["BranchLink"] = ctx.Repo.RepoLink + "/src/" + ctx.Repo.RefTypeNameSubURL()
 	treePath := cleanUploadFileName(ctx.Repo.TreePath)
@@ -599,6 +647,10 @@ func DeleteFilePost(ctx *context.Context) {
 
 // UploadFile render upload file page
 func UploadFile(ctx *context.Context) {
+	if redirectToFork(ctx) {
+		return
+	}
+
 	ctx.Data["PageIsUpload"] = true
 	upload.AddUploadContext(ctx, "repo")
 	canCommit := renderCommitRights(ctx)

routers/web/repo/fork.go

@@ -125,6 +125,11 @@ func getForkRepository(ctx *context.Context) *repo_model.Repository {
 // Fork render repository fork page
 func Fork(ctx *context.Context) {
 	ctx.Data["Title"] = ctx.Tr("new_fork")
+
+	redirectTo := ctx.FormString("redirect_to_edit")
+	ctx.Data["ForkForEdit"] = len(redirectTo) > 0
+	ctx.Data["ForkRedirectTo"] = redirectTo
+
 	getForkRepository(ctx)
 	if ctx.Written() {
 		return
@@ -228,5 +233,11 @@ func ForkPost(ctx *context.Context) {
 	}
 
 	log.Trace("Repository forked[%d]: %s/%s", forkRepo.ID, ctxUser.Name, repo.Name)
-	ctx.Redirect(ctxUser.HomeLink() + "/" + url.PathEscape(repo.Name))
+
+	redirectTo := ctx.FormString("redirect_to_edit")
+	if len(redirectTo) > 0 {
+		ctx.Redirect(forkRepo.AdaptLinkToFork(repo, redirectTo))
+	} else {
+		ctx.Redirect(ctxUser.HomeLink() + "/" + url.PathEscape(repo.Name))
+	}
 }

routers/web/repo/view_file.go

@@ -255,6 +255,7 @@ func prepareToRenderFile(ctx *context.Context, entry *git.TreeEntry) {
 			} else if !ctx.Repo.RefFullName.IsBranch() {
 				ctx.Data["EditFileTooltip"] = ctx.Tr("repo.editor.must_be_on_a_branch")
 			} else if !ctx.Repo.CanWriteToBranch(ctx, ctx.Doer, ctx.Repo.BranchName) {
+				ctx.Data["CanEditFile"] = true
 				ctx.Data["EditFileTooltip"] = ctx.Tr("repo.editor.fork_before_edit")
 			}
 		}
@@ -318,6 +319,7 @@ func prepareToRenderFile(ctx *context.Context, entry *git.TreeEntry) {
 	} else if !ctx.Repo.RefFullName.IsBranch() {
 		ctx.Data["DeleteFileTooltip"] = ctx.Tr("repo.editor.must_be_on_a_branch")
 	} else if !ctx.Repo.CanWriteToBranch(ctx, ctx.Doer, ctx.Repo.BranchName) {
-		ctx.Data["DeleteFileTooltip"] = ctx.Tr("repo.editor.must_have_write_access")
+		ctx.Data["CanDeleteFile"] = true
+		ctx.Data["DeleteFileTooltip"] = ctx.Tr("repo.editor.fork_before_delete")
 	}
 }

routers/web/web.go

@@ -1314,15 +1314,22 @@ func registerWebRoutes(m *web.Router) {
 	m.Group("/{username}/{reponame}", func() { // repo code
 		m.Group("", func() {
 			m.Group("", func() {
-				m.Post("/_preview/*", web.Bind(forms.EditPreviewDiffForm{}), repo.DiffPreviewPost)
-				m.Combo("/_edit/*").Get(repo.EditFile).
+				// These will redirect to a fork if writing to the branch is not possible
+				m.Combo("/_edit/*").Get(repo.EditFile)
+				m.Combo("/_new/*").Get(repo.NewFile)
+				m.Combo("/_delete/*").Get(repo.DeleteFile)
+				m.Combo("/_upload/*", repo.MustBeAbleToUpload).Get(repo.UploadFile)
+			}, context.RepoRefByType(git.RefTypeBranch), repo.WebGitOperationCommonData)
+			m.Group("", func() {
+				m.Combo("/_edit/*").
 					Post(web.Bind(forms.EditRepoFileForm{}), repo.EditFilePost)
-				m.Combo("/_new/*").Get(repo.NewFile).
+				m.Combo("/_new/*").
 					Post(web.Bind(forms.EditRepoFileForm{}), repo.NewFilePost)
-				m.Combo("/_delete/*").Get(repo.DeleteFile).
+				m.Combo("/_delete/*").
 					Post(web.Bind(forms.DeleteRepoFileForm{}), repo.DeleteFilePost)
-				m.Combo("/_upload/*", repo.MustBeAbleToUpload).Get(repo.UploadFile).
+				m.Combo("/_upload/*", repo.MustBeAbleToUpload).
 					Post(web.Bind(forms.UploadRepoFileForm{}), repo.UploadFilePost)
+				m.Post("/_preview/*", web.Bind(forms.EditPreviewDiffForm{}), repo.DiffPreviewPost)
 				m.Combo("/_diffpatch/*").Get(repo.NewDiffPatch).
 					Post(web.Bind(forms.EditRepoFileForm{}), repo.NewDiffPatchPost)
 				m.Combo("/_cherrypick/{sha:([a-f0-9]{7,64})}/*").Get(repo.CherryPick).

templates/repo/pulls/fork.tmpl

@@ -1,6 +1,11 @@
 {{template "base/head" .}}
 <div role="main" aria-label="{{.Title}}" class="page-content repository new fork">
 	<div class="ui container medium-width">
+		{{if .ForkForEdit}}
+			<div class="ui blue message">
+				<p>{{ctx.Locale.Tr "repo.fork_to_edit_description" .ForkRepo.FullName}}</p>
+			</div>
+		{{end}}
 		<h3 class="ui top attached header">
 			{{ctx.Locale.Tr "new_fork"}}
 		</h3>
@@ -72,6 +77,7 @@
 					<label for="description">{{ctx.Locale.Tr "repo.repo_desc"}}</label>
 					<textarea id="description" name="description">{{.description}}</textarea>
 				</div>
+				<input type="hidden" id="redirect_to_edit" name="redirect_to_edit" value="{{.ForkRedirectTo}}">
 
 				<div class="inline field">
 					<label></label>