Gitea-John71/Gitea
2
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-08-15 08:16:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: wiki edit form (#38918)

Browse Source 
1. the fragile `document.querySelector('.repository.wiki.new
.ui.form')!` is broken (again), rewrite to "data-global-init"
    * regression from #37571 because a new form was added
3. use "form-fetch-action" and JSON response instead of
"RenderWithErrDeprecated"
This commit is contained in:
wxiaoguang
2026-08-14 17:31:23 +08:00
committed by GitHub
parent befeacdf7d
commit b6368965fb
10 changed files with 127 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files
routers/web/repo/wiki.go
+23 -37
View File
@@ -27,7 +27,6 @@ import (
"gitea.dev/modules/templates"
"gitea.dev/modules/timeutil"
"gitea.dev/modules/util"
"gitea.dev/modules/web"
"gitea.dev/routers/common"
"gitea.dev/services/context"
"gitea.dev/services/forms"
@@ -639,6 +638,16 @@ func WikiRaw(ctx *context.Context) {
ctx.NotFound(nil)
}
func wikiHandleEditError(ctx *context.Context, wikiName wiki_service.WebPath, err error) {
if repo_model.IsErrWikiReservedName(err) {
ctx.JSONErrorWithField(ctx.Tr("repo.wiki.reserved_page", wikiName), "title")
} else if repo_model.IsErrWikiAlreadyExist(err) {
ctx.JSONErrorWithField(ctx.Tr("repo.wiki.page_already_exists"), "title")
} else {
ctx.ServerError("EditWiki", err)
}
}
// NewWiki render wiki create page
func NewWiki(ctx *context.Context) {
ctx.Data["Title"] = ctx.Tr("repo.wiki.new_page")
@@ -655,41 +664,25 @@ func NewWiki(ctx *context.Context) {
// NewWikiPost response for wiki create request
func NewWikiPost(ctx *context.Context) {
form := web.GetForm[*forms.NewWikiForm](ctx)
ctx.Data["Title"] = ctx.Tr("repo.wiki.new_page")
if ctx.HasError() {
ctx.HTML(http.StatusOK, tplWikiNew)
return
}
if util.IsEmptyString(form.Title) {
ctx.RenderWithErrDeprecated(ctx.Tr("repo.issues.new.title_empty"), tplWikiNew, form)
form := context.GetFetchActionForm[*forms.WikiEditForm](ctx)
if form == nil {
return
}
wikiName := wiki_service.UserTitleToWebPath("", form.Title)
if len(form.Message) == 0 {
if form.Message == "" {
form.Message = ctx.Locale.TrString("repo.editor.add", form.Title)
}
if err := wiki_service.AddWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, wikiName, form.Content, form.Message); err != nil {
if repo_model.IsErrWikiReservedName(err) {
ctx.Data["Err_Title"] = true
ctx.RenderWithErrDeprecated(ctx.Tr("repo.wiki.reserved_page", wikiName), tplWikiNew, &form)
} else if repo_model.IsErrWikiAlreadyExist(err) {
ctx.Data["Err_Title"] = true
ctx.RenderWithErrDeprecated(ctx.Tr("repo.wiki.page_already_exists"), tplWikiNew, &form)
} else {
ctx.ServerError("AddWikiPage", err)
}
err := wiki_service.AddWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, wikiName, form.Content, form.Message)
if err != nil {
wikiHandleEditError(ctx, wikiName, err)
return
}
notify_service.NewWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName), form.Message)
ctx.Redirect(ctx.Repo.RepoLink + "/wiki/" + wiki_service.WebPathToURLPath(wikiName))
ctx.JSONRedirect(ctx.Repo.RepoLink + "/wiki/" + wiki_service.WebPathToURLPath(wikiName))
}
// EditWiki render wiki modify page
@@ -711,38 +704,31 @@ func EditWiki(ctx *context.Context) {
// EditWikiPost response for wiki modify request
func EditWikiPost(ctx *context.Context) {
form := web.GetForm[*forms.NewWikiForm](ctx)
ctx.Data["Title"] = ctx.Tr("repo.wiki.new_page")
if ctx.HasError() {
ctx.HTML(http.StatusOK, tplWikiNew)
form := context.GetFetchActionForm[*forms.WikiEditForm](ctx)
if form == nil {
return
}
oldWikiName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*"))
newWikiName := wiki_service.UserTitleToWebPath("", form.Title)
if len(form.Message) == 0 {
if form.Message == "" {
form.Message = ctx.Locale.TrString("repo.editor.update", form.Title)
}
if err := wiki_service.EditWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, oldWikiName, newWikiName, form.Content, form.Message); err != nil {
ctx.ServerError("EditWikiPage", err)
wikiHandleEditError(ctx, newWikiName, err)
return
}
notify_service.EditWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(newWikiName), form.Message)
ctx.Redirect(ctx.Repo.RepoLink + "/wiki/" + wiki_service.WebPathToURLPath(newWikiName))
ctx.JSONRedirect(ctx.Repo.RepoLink + "/wiki/" + wiki_service.WebPathToURLPath(newWikiName))
}
// DeleteWikiPagePost delete wiki page
func DeleteWikiPagePost(ctx *context.Context) {
wikiName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*"))
if len(wikiName) == 0 {
wikiName = "Home"
}
wikiName = util.IfZero(wikiName, "Home")
if err := wiki_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, wikiName); err != nil {
ctx.ServerError("DeleteWikiPage", err)
return
routers/web/repo/wiki_test.go
+68 -74
View File
@@ -4,6 +4,7 @@
package repo
import (
"fmt"
"io"
"net/http"
"net/url"
@@ -12,9 +13,8 @@ import (
repo_model "gitea.dev/models/repo"
"gitea.dev/models/unittest"
"gitea.dev/modules/git"
"gitea.dev/modules/web"
"gitea.dev/modules/test"
"gitea.dev/services/contexttest"
"gitea.dev/services/forms"
repo_service "gitea.dev/services/repository"
wiki_service "gitea.dev/services/wiki"
@@ -23,16 +23,15 @@ import (
)
const (
content = "Wiki contents for unit tests"
message = "Wiki commit message for unit tests"
testWikiContent = "Wiki contents for unit tests"
testWikiMessage = "Wiki commit message for unit tests"
)
func wikiEntry(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) (*git.Repository, *git.TreeEntry) {
wikiRepo, err := git.OpenRepository(t.Context(), repo.WikiStorageRepo())
assert.NoError(t, err)
t.Cleanup(func() {
defer wikiRepo.Close()
})
require.NoError(t, err)
defer wikiRepo.Close()
commit, err := wikiRepo.GetBranchCommit(t.Context(), "master")
assert.NoError(t, err)
entries, err := commit.Tree().ListEntries(t.Context(), wikiRepo)
@@ -81,25 +80,35 @@ func assertPagesMetas(t *testing.T, expectedNames []string, metas any) {
func TestWiki(t *testing.T) {
unittest.PrepareTestEnv(t)
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki")
ctx.SetPathParam("*", "Home")
contexttest.LoadRepo(t, ctx, 1)
Wiki(ctx)
assert.Equal(t, http.StatusOK, ctx.Resp.WrittenStatus())
assert.EqualValues(t, "Home", ctx.Data["Title"])
assertPagesMetas(t, []string{"Home", "Page With Image", "Page With Spaced Name", "Unescaped File"}, ctx.Data["Pages"])
ctx, _ = contexttest.MockContext(t, "user2/repo1/jpeg.jpg")
ctx.SetPathParam("*", "jpeg.jpg")
contexttest.LoadRepo(t, ctx, 1)
Wiki(ctx)
assert.Equal(t, http.StatusSeeOther, ctx.Resp.WrittenStatus())
assert.Equal(t, "/user2/repo1/wiki/raw/jpeg.jpg", ctx.Resp.Header().Get("Location"))
t.Run("Home", func(t *testing.T) {
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki")
ctx.SetPathParam("*", "Home")
contexttest.LoadRepo(t, ctx, 1)
Wiki(ctx)
assert.Equal(t, http.StatusOK, ctx.Resp.WrittenStatus())
assert.EqualValues(t, "Home", ctx.Data["Title"])
assertPagesMetas(t, []string{"Home", "Page With Image", "Page With Spaced Name", "Unescaped File"}, ctx.Data["Pages"])
})
t.Run("Image", func(t *testing.T) {
ctx, _ := contexttest.MockContext(t, "user2/repo1/jpeg.jpg")
ctx.SetPathParam("*", "jpeg.jpg")
contexttest.LoadRepo(t, ctx, 1)
Wiki(ctx)
assert.Equal(t, http.StatusSeeOther, ctx.Resp.WrittenStatus())
assert.Equal(t, "/user2/repo1/wiki/raw/jpeg.jpg", ctx.Resp.Header().Get("Location"))
})
t.Run("Pages", testWikiPages)
t.Run("NewWiki", testNewWiki)
t.Run("NewWikiPost", testNewWikiPost)
t.Run("NewWikiPostReservedName", testNewWikiPostReservedName)
t.Run("EditWiki", testEditWiki)
t.Run("EditWikiPost", testEditWikiPost)
t.Run("DeletePost", testDeleteWikiPagePost)
t.Run("Raw", testWikiRaw)
t.Run("DefaultWikiBranch", testDefaultWikiBranch)
}
func TestWikiPages(t *testing.T) {
unittest.PrepareTestEnv(t)
func testWikiPages(t *testing.T) {
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/?action=_pages")
contexttest.LoadRepo(t, ctx, 1)
WikiPages(ctx)
@@ -107,9 +116,7 @@ func TestWikiPages(t *testing.T) {
assertPagesMetas(t, []string{"Home", "Page With Image", "Page With Spaced Name", "Unescaped File"}, ctx.Data["Pages"])
}
func TestNewWiki(t *testing.T) {
unittest.PrepareTestEnv(t)
func testNewWiki(t *testing.T) {
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/?action=_new")
contexttest.LoadUser(t, ctx, 2)
contexttest.LoadRepo(t, ctx, 1)
@@ -118,48 +125,42 @@ func TestNewWiki(t *testing.T) {
assert.EqualValues(t, ctx.Tr("repo.wiki.new_page"), ctx.Data["Title"])
}
func TestNewWikiPost(t *testing.T) {
func testNewWikiPost(t *testing.T) {
for _, title := range []string{
"New page",
"&&&&",
} {
unittest.PrepareTestEnv(t)
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/?action=_new")
contexttest.LoadUser(t, ctx, 2)
contexttest.LoadRepo(t, ctx, 1)
web.SetForm(ctx, &forms.NewWikiForm{
Title: title,
Content: content,
Message: message,
contexttest.MockRequestPostForm(ctx.Req, url.Values{
"title": []string{title},
"content": []string{testWikiContent},
"message": []string{testWikiMessage},
})
NewWikiPost(ctx)
assert.Equal(t, http.StatusSeeOther, ctx.Resp.WrittenStatus())
assert.Equal(t, http.StatusOK, ctx.Resp.WrittenStatus())
assertWikiExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title))
assert.Equal(t, content, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)))
assert.Equal(t, testWikiContent, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)))
}
}
func TestNewWikiPost_ReservedName(t *testing.T) {
unittest.PrepareTestEnv(t)
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/?action=_new")
func testNewWikiPostReservedName(t *testing.T) {
ctx, resp := contexttest.MockContext(t, "user2/repo1/wiki/?action=_new")
contexttest.LoadUser(t, ctx, 2)
contexttest.LoadRepo(t, ctx, 1)
web.SetForm(ctx, &forms.NewWikiForm{
Title: "_edit",
Content: content,
Message: message,
contexttest.MockRequestPostForm(ctx.Req, url.Values{
"title": []string{"_edit"},
"content": []string{testWikiContent},
"message": []string{testWikiMessage},
})
NewWikiPost(ctx)
assert.Equal(t, http.StatusOK, ctx.Resp.WrittenStatus())
assert.EqualValues(t, ctx.Tr("repo.wiki.reserved_page", "_edit"), ctx.Flash.ErrorMsg)
assert.Equal(t, http.StatusBadRequest, ctx.Resp.WrittenStatus())
assert.EqualValues(t, ctx.Tr("repo.wiki.reserved_page", "_edit"), test.ParseJSONError(resp.Body.Bytes()).ErrorMessage)
assertWikiNotExists(t, ctx.Repo.Repository, "_edit")
}
func TestEditWiki(t *testing.T) {
unittest.PrepareTestEnv(t)
func testEditWiki(t *testing.T) {
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/Home?action=_edit")
ctx.SetPathParam("*", "Home")
contexttest.LoadUser(t, ctx, 2)
@@ -177,34 +178,31 @@ func TestEditWiki(t *testing.T) {
assert.Equal(t, http.StatusForbidden, ctx.Resp.WrittenStatus())
}
func TestEditWikiPost(t *testing.T) {
for _, title := range []string{
"Home",
"New/<page>",
} {
func testEditWikiPost(t *testing.T) {
const existingPageTitle = "Page With Image"
for _, title := range []string{existingPageTitle, "New/<page>"} {
unittest.PrepareTestEnv(t)
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/Home?action=_new")
ctx.SetPathParam("*", "Home")
ctx, _ := contexttest.MockContext(t, fmt.Sprintf("/user2/repo1/wiki/%s?action=_new", url.PathEscape(existingPageTitle)))
ctx.SetPathParam("*", existingPageTitle)
contexttest.LoadUser(t, ctx, 2)
contexttest.LoadRepo(t, ctx, 1)
web.SetForm(ctx, &forms.NewWikiForm{
Title: title,
Content: content,
Message: message,
contexttest.MockRequestPostForm(ctx.Req, url.Values{
"title": []string{title},
"content": []string{testWikiContent},
"message": []string{testWikiMessage},
})
assertWikiExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", existingPageTitle))
EditWikiPost(ctx)
assert.Equal(t, http.StatusSeeOther, ctx.Resp.WrittenStatus())
assert.Equal(t, http.StatusOK, ctx.Resp.WrittenStatus())
assertWikiExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title))
assert.Equal(t, content, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)))
if title != "Home" {
assertWikiNotExists(t, ctx.Repo.Repository, "Home")
assert.Equal(t, testWikiContent, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)))
if title != existingPageTitle {
assertWikiNotExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", existingPageTitle))
}
}
}
func TestDeleteWikiPagePost(t *testing.T) {
unittest.PrepareTestEnv(t)
func testDeleteWikiPagePost(t *testing.T) {
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/Home?action=_delete")
contexttest.LoadUser(t, ctx, 2)
contexttest.LoadRepo(t, ctx, 1)
@@ -213,7 +211,7 @@ func TestDeleteWikiPagePost(t *testing.T) {
assertWikiNotExists(t, ctx.Repo.Repository, "Home")
}
func TestWikiRaw(t *testing.T) {
func testWikiRaw(t *testing.T) {
for filepath, filetype := range map[string]string{
"jpeg.jpg": "image/jpeg",
"images/jpeg.jpg": "image/jpeg",
@@ -223,8 +221,6 @@ func TestWikiRaw(t *testing.T) {
"Page With Spaced Name.md": "", // there is no "Page With Spaced Name.md" in repo
"Page-With-Spaced-Name.md": "text/plain; charset=utf-8",
} {
unittest.PrepareTestEnv(t)
ctx, _ := contexttest.MockContext(t, "user2/repo1/wiki/raw/"+url.PathEscape(filepath))
ctx.SetPathParam("*", filepath)
contexttest.LoadUser(t, ctx, 2)
@@ -239,9 +235,7 @@ func TestWikiRaw(t *testing.T) {
}
}
func TestDefaultWikiBranch(t *testing.T) {
unittest.PrepareTestEnv(t)
func testDefaultWikiBranch(t *testing.T) {
// repo with no wiki
repoWithNoWiki := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 2})
assert.False(t, repo_service.HasWiki(t.Context(), repoWithNoWiki))