]> source.dussan.org Git - gitea.git/commitdiff
Fixes #7474 - Handles all redirects for Web UI File CRUD (#7478)
authorRichard Mahn <richmahn@users.noreply.github.com>
Wed, 17 Jul 2019 18:40:28 +0000 (14:40 -0400)
committertechknowlogick <techknowlogick@gitea.io>
Wed, 17 Jul 2019 18:40:28 +0000 (14:40 -0400)
* Fixes #7474 - Handles all redirects for Web UI File CRUD

* Fixes lint errors

* Typo fix

* Adds unit tests for a few helper functions

* Fixes per review

* Fix for new branch creation and to unit test

* Fixes the template used for errors on delete

options/locale/locale_en-US.ini
public/js/index.js
routers/repo/editor.go
routers/repo/editor_test.go
templates/repo/editor/commit_form.tmpl

index 6ef1277c6254323956ff755e2ddd0362336c2bdf..969a0953a2894c3117064f424ae2b928985da252 100644 (file)
@@ -696,6 +696,7 @@ editor.delete = Delete '%s'
 editor.commit_message_desc = Add an optional extended description…
 editor.commit_directly_to_this_branch = Commit directly to the <strong class="branch-name">%s</strong> branch.
 editor.create_new_branch = Create a <strong>new branch</strong> for this commit and start a pull request.
+editor.propose_file_change = Propose file change
 editor.new_branch_name_desc = New branch name…
 editor.cancel = Cancel
 editor.filename_cannot_be_empty = The filename cannot be empty.
index e6719c57f042dd8acc6032c7952ddd19a7c79adf..d26764fcc72882181c7981dee9acce42bcabe9fc 100644 (file)
@@ -1306,6 +1306,7 @@ function initEditor() {
             $('.quick-pull-branch-name').hide();
             $('.quick-pull-branch-name input').prop('required',false);
         }
+        $('#commit-button').text($(this).attr('button_text'));
     });
 
     const $editFilename = $("#file-name");
index f3327017e5f361bd1c87b248307ee472604ff4cc..1c7eee98ac6f88dfee6d29bbde0e27c419575d2e 100644 (file)
@@ -8,6 +8,7 @@ import (
        "fmt"
        "io/ioutil"
        "path"
+       "path/filepath"
        "strings"
 
        "code.gitea.io/gitea/models"
@@ -137,7 +138,7 @@ func editFile(ctx *context.Context, isNewFile bool) {
        } else {
                ctx.Data["commit_choice"] = frmCommitChoiceNewBranch
        }
-       ctx.Data["new_branch_name"] = ""
+       ctx.Data["new_branch_name"] = GetUniquePatchBranchName(ctx)
        ctx.Data["last_commit"] = ctx.Repo.CommitID
        ctx.Data["MarkdownFileExts"] = strings.Join(setting.Markdown.FileExtensions, ",")
        ctx.Data["LineWrapExtensions"] = strings.Join(setting.Repository.Editor.LineWrapExtensions, ",")
@@ -266,6 +267,10 @@ func editFilePost(ctx *context.Context, form auth.EditRepoFileForm, isNewFile bo
                } else {
                        ctx.RenderWithErr(ctx.Tr("repo.editor.fail_to_update_file", form.TreePath, err), tplEditFile, &form)
                }
+       }
+
+       if form.CommitChoice == frmCommitChoiceNewBranch {
+               ctx.Redirect(ctx.Repo.RepoLink + "/compare/" + ctx.Repo.BranchName + "..." + form.NewBranchName)
        } else {
                ctx.Redirect(ctx.Repo.RepoLink + "/src/branch/" + util.PathEscapeSegments(branchName) + "/" + util.PathEscapeSegments(form.TreePath))
        }
@@ -335,7 +340,7 @@ func DeleteFile(ctx *context.Context) {
        } else {
                ctx.Data["commit_choice"] = frmCommitChoiceNewBranch
        }
-       ctx.Data["new_branch_name"] = ""
+       ctx.Data["new_branch_name"] = GetUniquePatchBranchName(ctx)
 
        ctx.HTML(200, tplDeleteFile)
 }
@@ -362,7 +367,7 @@ func DeleteFilePost(ctx *context.Context, form auth.DeleteRepoFileForm) {
                return
        }
 
-       if branchName != ctx.Repo.BranchName && !canCommit {
+       if branchName == ctx.Repo.BranchName && !canCommit {
                ctx.Data["Err_NewBranchName"] = true
                ctx.Data["commit_choice"] = frmCommitChoiceNewBranch
                ctx.RenderWithErr(ctx.Tr("repo.editor.cannot_commit_to_protected_branch", branchName), tplDeleteFile, &form)
@@ -387,20 +392,20 @@ func DeleteFilePost(ctx *context.Context, form auth.DeleteRepoFileForm) {
        }); err != nil {
                // This is where we handle all the errors thrown by repofiles.DeleteRepoFile
                if git.IsErrNotExist(err) || models.IsErrRepoFileDoesNotExist(err) {
-                       ctx.RenderWithErr(ctx.Tr("repo.editor.file_deleting_no_longer_exists", ctx.Repo.TreePath), tplEditFile, &form)
+                       ctx.RenderWithErr(ctx.Tr("repo.editor.file_deleting_no_longer_exists", ctx.Repo.TreePath), tplDeleteFile, &form)
                } else if models.IsErrFilenameInvalid(err) {
                        ctx.Data["Err_TreePath"] = true
-                       ctx.RenderWithErr(ctx.Tr("repo.editor.filename_is_invalid", ctx.Repo.TreePath), tplEditFile, &form)
+                       ctx.RenderWithErr(ctx.Tr("repo.editor.filename_is_invalid", ctx.Repo.TreePath), tplDeleteFile, &form)
                } else if models.IsErrFilePathInvalid(err) {
                        ctx.Data["Err_TreePath"] = true
                        if fileErr, ok := err.(models.ErrFilePathInvalid); ok {
                                switch fileErr.Type {
                                case git.EntryModeSymlink:
-                                       ctx.RenderWithErr(ctx.Tr("repo.editor.file_is_a_symlink", fileErr.Path), tplEditFile, &form)
+                                       ctx.RenderWithErr(ctx.Tr("repo.editor.file_is_a_symlink", fileErr.Path), tplDeleteFile, &form)
                                case git.EntryModeTree:
-                                       ctx.RenderWithErr(ctx.Tr("repo.editor.filename_is_a_directory", fileErr.Path), tplEditFile, &form)
+                                       ctx.RenderWithErr(ctx.Tr("repo.editor.filename_is_a_directory", fileErr.Path), tplDeleteFile, &form)
                                case git.EntryModeBlob:
-                                       ctx.RenderWithErr(ctx.Tr("repo.editor.directory_is_a_file", fileErr.Path), tplEditFile, &form)
+                                       ctx.RenderWithErr(ctx.Tr("repo.editor.directory_is_a_file", fileErr.Path), tplDeleteFile, &form)
                                default:
                                        ctx.ServerError("DeleteRepoFile", err)
                                }
@@ -410,25 +415,44 @@ func DeleteFilePost(ctx *context.Context, form auth.DeleteRepoFileForm) {
                } else if git.IsErrBranchNotExist(err) {
                        // For when a user deletes a file to a branch that no longer exists
                        if branchErr, ok := err.(git.ErrBranchNotExist); ok {
-                               ctx.RenderWithErr(ctx.Tr("repo.editor.branch_does_not_exist", branchErr.Name), tplEditFile, &form)
+                               ctx.RenderWithErr(ctx.Tr("repo.editor.branch_does_not_exist", branchErr.Name), tplDeleteFile, &form)
                        } else {
                                ctx.Error(500, err.Error())
                        }
                } else if models.IsErrBranchAlreadyExists(err) {
                        // For when a user specifies a new branch that already exists
                        if branchErr, ok := err.(models.ErrBranchAlreadyExists); ok {
-                               ctx.RenderWithErr(ctx.Tr("repo.editor.branch_already_exists", branchErr.BranchName), tplEditFile, &form)
+                               ctx.RenderWithErr(ctx.Tr("repo.editor.branch_already_exists", branchErr.BranchName), tplDeleteFile, &form)
                        } else {
                                ctx.Error(500, err.Error())
                        }
                } else if models.IsErrCommitIDDoesNotMatch(err) {
-                       ctx.RenderWithErr(ctx.Tr("repo.editor.file_changed_while_editing", ctx.Repo.RepoLink+"/compare/"+form.LastCommit+"..."+ctx.Repo.CommitID), tplEditFile, &form)
+                       ctx.RenderWithErr(ctx.Tr("repo.editor.file_changed_while_deleting", ctx.Repo.RepoLink+"/compare/"+form.LastCommit+"..."+ctx.Repo.CommitID), tplDeleteFile, &form)
                } else {
                        ctx.ServerError("DeleteRepoFile", err)
                }
+       }
+
+       ctx.Flash.Success(ctx.Tr("repo.editor.file_delete_success", ctx.Repo.TreePath))
+       if form.CommitChoice == frmCommitChoiceNewBranch {
+               ctx.Redirect(ctx.Repo.RepoLink + "/compare/" + ctx.Repo.BranchName + "..." + form.NewBranchName)
        } else {
-               ctx.Flash.Success(ctx.Tr("repo.editor.file_delete_success", ctx.Repo.TreePath))
-               ctx.Redirect(ctx.Repo.RepoLink + "/src/branch/" + util.PathEscapeSegments(branchName))
+               treePath := filepath.Dir(ctx.Repo.TreePath)
+               if treePath == "." {
+                       treePath = "" // the file deleted was in the root, so we return the user to the root directory
+               }
+               if len(treePath) > 0 {
+                       // Need to get the latest commit since it changed
+                       commit, err := ctx.Repo.GitRepo.GetBranchCommit(ctx.Repo.BranchName)
+                       if err == nil && commit != nil {
+                               // We have the comment, now find what directory we can return the user to
+                               // (must have entries)
+                               treePath = GetClosestParentWithFiles(treePath, commit)
+                       } else {
+                               treePath = "" // otherwise return them to the root of the repo
+                       }
+               }
+               ctx.Redirect(ctx.Repo.RepoLink + "/src/branch/" + util.PathEscapeSegments(branchName) + "/" + util.PathEscapeSegments(treePath))
        }
 }
 
@@ -467,7 +491,7 @@ func UploadFile(ctx *context.Context) {
        } else {
                ctx.Data["commit_choice"] = frmCommitChoiceNewBranch
        }
-       ctx.Data["new_branch_name"] = ""
+       ctx.Data["new_branch_name"] = GetUniquePatchBranchName(ctx)
 
        ctx.HTML(200, tplUploadFile)
 }
@@ -565,7 +589,11 @@ func UploadFilePost(ctx *context.Context, form auth.UploadRepoFileForm) {
                return
        }
 
-       ctx.Redirect(ctx.Repo.RepoLink + "/src/branch/" + util.PathEscapeSegments(branchName) + "/" + util.PathEscapeSegments(form.TreePath))
+       if form.CommitChoice == frmCommitChoiceNewBranch {
+               ctx.Redirect(ctx.Repo.RepoLink + "/compare/" + ctx.Repo.BranchName + "..." + form.NewBranchName)
+       } else {
+               ctx.Redirect(ctx.Repo.RepoLink + "/src/branch/" + util.PathEscapeSegments(branchName) + "/" + util.PathEscapeSegments(form.TreePath))
+       }
 }
 
 func cleanUploadFileName(name string) string {
@@ -636,3 +664,40 @@ func RemoveUploadFileFromServer(ctx *context.Context, form auth.RemoveUploadFile
        log.Trace("Upload file removed: %s", form.File)
        ctx.Status(204)
 }
+
+// GetUniquePatchBranchName Gets a unique branch name for a new patch branch
+// It will be in the form of <username>-patch-<num> where <num> is the first branch of this format
+// that doesn't already exist. If we exceed 1000 tries or an error is thrown, we just return "" so the user has to
+// type in the branch name themselves (will be an empty field)
+func GetUniquePatchBranchName(ctx *context.Context) string {
+       prefix := ctx.User.LowerName + "-patch-"
+       for i := 1; i <= 1000; i++ {
+               branchName := fmt.Sprintf("%s%d", prefix, i)
+               if _, err := ctx.Repo.Repository.GetBranch(branchName); err != nil {
+                       if git.IsErrBranchNotExist(err) {
+                               return branchName
+                       }
+                       log.Error("GetUniquePatchBranchName: %v", err)
+                       return ""
+               }
+       }
+       return ""
+}
+
+// GetClosestParentWithFiles Recursively gets the path of parent in a tree that has files (used when file in a tree is
+// deleted). Returns "" for the root if no parents other than the root have files. If the given treePath isn't a
+// SubTree or it has no entries, we go up one dir and see if we can return the user to that listing.
+func GetClosestParentWithFiles(treePath string, commit *git.Commit) string {
+       if len(treePath) == 0 || treePath == "." {
+               return ""
+       }
+       // see if the tree has entries
+       if tree, err := commit.SubTree(treePath); err != nil {
+               // failed to get tree, going up a dir
+               return GetClosestParentWithFiles(filepath.Dir(treePath), commit)
+       } else if entries, err := tree.ListEntries(); err != nil || len(entries) == 0 {
+               // no files in this dir, going up a dir
+               return GetClosestParentWithFiles(filepath.Dir(treePath), commit)
+       }
+       return treePath
+}
index 660f088e8848b8d9da2023357b6a19b276982c1b..7a68ecc9b78f8cd2f5229390e7a5d25bea3f4000 100644 (file)
@@ -5,6 +5,8 @@
 package repo
 
 import (
+       "code.gitea.io/gitea/modules/git"
+       "code.gitea.io/gitea/modules/test"
        "testing"
 
        "code.gitea.io/gitea/models"
@@ -37,3 +39,40 @@ func TestCleanUploadName(t *testing.T) {
                assert.EqualValues(t, cleanUploadFileName(k), v)
        }
 }
+
+func TestGetUniquePatchBranchName(t *testing.T) {
+       models.PrepareTestEnv(t)
+       ctx := test.MockContext(t, "user2/repo1")
+       ctx.SetParams(":id", "1")
+       test.LoadRepo(t, ctx, 1)
+       test.LoadRepoCommit(t, ctx)
+       test.LoadUser(t, ctx, 2)
+       test.LoadGitRepo(t, ctx)
+       expectedBranchName := "user2-patch-1"
+       branchName := GetUniquePatchBranchName(ctx)
+       assert.Equal(t, expectedBranchName, branchName)
+}
+
+func TestGetClosestParentWithFiles(t *testing.T) {
+       models.PrepareTestEnv(t)
+       ctx := test.MockContext(t, "user2/repo1")
+       ctx.SetParams(":id", "1")
+       test.LoadRepo(t, ctx, 1)
+       test.LoadRepoCommit(t, ctx)
+       test.LoadUser(t, ctx, 2)
+       test.LoadGitRepo(t, ctx)
+       repo := ctx.Repo.Repository
+       branch := repo.DefaultBranch
+       gitRepo, _ := git.OpenRepository(repo.RepoPath())
+       commit, _ := gitRepo.GetBranchCommit(branch)
+       expectedTreePath := ""
+
+       expectedTreePath = "" // Should return the root dir, empty string, since there are no subdirs in this repo
+       for _, deletedFile := range []string{
+               "dir1/dir2/dir3/file.txt",
+               "file.txt",
+       } {
+               treePath := GetClosestParentWithFiles(deletedFile, commit)
+               assert.Equal(t, expectedTreePath, treePath)
+       }
+}
index 86749623eba3d73d06bd2ea7f053cc5066359f43..d22cd07b03fb22d2debd51eb3ecad66a100101bd 100644 (file)
@@ -11,7 +11,7 @@
                <div class="quick-pull-choice js-quick-pull-choice">
                        <div class="field">
                                <div class="ui radio checkbox {{if not .CanCommitToBranch}}disabled{{end}}">
-                                       <input type="radio" class="js-quick-pull-choice-option" name="commit_choice" value="direct" {{if eq .commit_choice "direct"}}checked{{end}}>
+                                       <input type="radio" class="js-quick-pull-choice-option" name="commit_choice" value="direct" button_text="{{.i18n.Tr "repo.editor.commit_changes"}}" {{if eq .commit_choice "direct"}}checked{{end}}>
                                        <label>
                                                <i class="octicon octicon-git-commit" height="16" width="14"></i>
                                                {{.i18n.Tr "repo.editor.commit_directly_to_this_branch" (.BranchName|Escape) | Safe}}
@@ -20,7 +20,7 @@
                        </div>
                        <div class="field">
                                <div class="ui radio checkbox">
-                                       <input type="radio" class="js-quick-pull-choice-option" name="commit_choice" value="commit-to-new-branch" {{if eq .commit_choice "commit-to-new-branch"}}checked{{end}}>
+                                       <input type="radio" class="js-quick-pull-choice-option" name="commit_choice" value="commit-to-new-branch" button_text="{{.i18n.Tr "repo.editor.propose_file_change"}}" {{if eq .commit_choice "commit-to-new-branch"}}checked{{end}}>
                                        <label>
                                                <i class="octicon octicon-git-pull-request" height="16" width="12"></i>
                                                {{.i18n.Tr "repo.editor.create_new_branch" | Safe}}
@@ -36,8 +36,8 @@
                        </div>
                </div>
        </div>
-       <button type="submit" class="ui green button">
-               {{.i18n.Tr "repo.editor.commit_changes"}}
+       <button id="commit-button" type="submit" class="ui green button">
+               {{if eq .commit_choice "commit-to-new-branch"}}{{.i18n.Tr "repo.editor.propose_file_change"}}{{else}}{{.i18n.Tr "repo.editor.commit_changes"}}{{end}}
        </button>
        <a class="ui button red" href="{{EscapePound $.BranchLink}}/{{EscapePound .TreePath}}">{{.i18n.Tr "repo.editor.cancel"}}</a>
 </div>