foster/forgejo
0
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-02-07 18:56:35 -05:00
Code Issues Wiki Activity

refactor: centralize wiki path

Browse source
This commit is contained in:
Snoweuph 2025-01-19 13:51:11 +01:00
parent d68e0d3e39
commit 6b2f67ea01
No known key found for this signature in database
GPG key ID: BEFC41DA223CEC55
7 changed files with 257 additions and 227 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
routers/api/v1/repo/wiki.go
View file

@ -65,7 +65,7 @@ func NewWikiPage(ctx *context.APIContext) {
return return
} }
wikiName := wiki_service.UserTitleToWebPath("", form.Title) wikiName := wiki_service.TitleToPath(form.Title)
if len(form.Message) == 0 { if len(form.Message) == 0 {
form.Message = fmt.Sprintf("Add %q", form.Title) form.Message = fmt.Sprintf("Add %q", form.Title)
@ -92,7 +92,7 @@ func NewWikiPage(ctx *context.APIContext) {
wikiPage := getWikiPage(ctx, wikiName) wikiPage := getWikiPage(ctx, wikiName)
if !ctx.Written() { if !ctx.Written() {
notify_service.NewWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName), form.Message) notify_service.NewWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName.WebPath()), form.Message)
ctx.JSON(http.StatusCreated, wikiPage) ctx.JSON(http.StatusCreated, wikiPage)
} }
} }
@ -140,10 +140,10 @@ func EditWikiPage(ctx *context.APIContext) {
form := web.GetForm(ctx).(*api.CreateWikiPageOptions) form := web.GetForm(ctx).(*api.CreateWikiPageOptions)
oldWikiName := wiki_service.WebPathFromRequest(ctx.PathParamRaw(":pageName")) oldWikiName := wiki_service.RequestToPath(ctx.PathParamRaw(":pageName"))
newWikiName := wiki_service.UserTitleToWebPath("", form.Title) newWikiName := wiki_service.TitleToPath(form.Title)
if len(newWikiName) == 0 { if len(newWikiName.WebPath()) == 0 {
newWikiName = oldWikiName newWikiName = oldWikiName
} }
@ -166,12 +166,12 @@ func EditWikiPage(ctx *context.APIContext) {
wikiPage := getWikiPage(ctx, newWikiName) wikiPage := getWikiPage(ctx, newWikiName)
if !ctx.Written() { if !ctx.Written() {
notify_service.EditWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(newWikiName), form.Message) notify_service.EditWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(newWikiName.WebPath()), form.Message)
ctx.JSON(http.StatusOK, wikiPage) ctx.JSON(http.StatusOK, wikiPage)
} }
} }
func getWikiPage(ctx *context.APIContext, wikiName wiki_service.WebPath) *api.WikiPage { func getWikiPage(ctx *context.APIContext, wikiName wiki_service.Path) *api.WikiPage {
wikiRepo, commit := findWikiRepoCommit(ctx) wikiRepo, commit := findWikiRepoCommit(ctx)
if wikiRepo != nil { if wikiRepo != nil {
defer wikiRepo.Close() defer wikiRepo.Close()
@ -186,12 +186,12 @@ func getWikiPage(ctx *context.APIContext, wikiName wiki_service.WebPath) *api.Wi
return nil return nil
} }
sidebarContent, _ := wikiContentsByName(ctx, commit, "_Sidebar", true) sidebarContent, _ := wikiContentsByName(ctx, commit, wiki_service.TitleToPath("_Sidebar"), true)
if ctx.Written() { if ctx.Written() {
return nil return nil
} }
footerContent, _ := wikiContentsByName(ctx, commit, "_Footer", true) footerContent, _ := wikiContentsByName(ctx, commit, wiki_service.TitleToPath("_Footer"), true)
if ctx.Written() { if ctx.Written() {
return nil return nil
} }
@ -246,7 +246,7 @@ func DeleteWikiPage(ctx *context.APIContext) {
// "423": // "423":
// "$ref": "#/responses/repoArchivedError" // "$ref": "#/responses/repoArchivedError"
wikiName := wiki_service.WebPathFromRequest(ctx.PathParamRaw(":pageName")) wikiName := wiki_service.RequestToPath(ctx.PathParamRaw(":pageName"))
if err := wiki_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, wikiName); err != nil { if err := wiki_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, wikiName); err != nil {
if err.Error() == "file does not exist" { if err.Error() == "file does not exist" {
@ -257,7 +257,7 @@ func DeleteWikiPage(ctx *context.APIContext) {
return return
} }
notify_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName)) notify_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName.WebPath()))
ctx.Status(http.StatusNoContent) ctx.Status(http.StatusNoContent)
} }
@ -329,7 +329,7 @@ func ListWikiPages(ctx *context.APIContext) {
ctx.Error(http.StatusInternalServerError, "GetCommit", err) ctx.Error(http.StatusInternalServerError, "GetCommit", err)
return return
} }
wikiName, err := wiki_service.GitPathToWebPath(entry.Name()) wikiName, err := wiki_service.GitPathToPath(wiki_service.GitPath(entry.Name()))
if err != nil { if err != nil {
if repo_model.IsErrWikiInvalidFileName(err) { if repo_model.IsErrWikiInvalidFileName(err) {
continue continue
@ -337,7 +337,7 @@ func ListWikiPages(ctx *context.APIContext) {
ctx.Error(http.StatusInternalServerError, "WikiFilenameToName", err) ctx.Error(http.StatusInternalServerError, "WikiFilenameToName", err)
return return
} }
pages = append(pages, wiki_service.ToWikiPageMetaData(wikiName, c, ctx.Repo.Repository)) pages = append(pages, wiki_service.ToWikiPageMetaData(*wikiName, c, ctx.Repo.Repository))
} }
ctx.SetTotalCountHeader(int64(len(entries))) ctx.SetTotalCountHeader(int64(len(entries)))
@ -374,7 +374,7 @@ func GetWikiPage(ctx *context.APIContext) {
// "$ref": "#/responses/notFound" // "$ref": "#/responses/notFound"
// get requested pagename // get requested pagename
pageName := wiki_service.WebPathFromRequest(ctx.PathParamRaw(":pageName")) pageName := wiki_service.RequestToPath(ctx.PathParamRaw(":pageName"))
wikiPage := getWikiPage(ctx, pageName) wikiPage := getWikiPage(ctx, pageName)
if !ctx.Written() { if !ctx.Written() {
@ -424,9 +424,9 @@ func ListPageRevisions(ctx *context.APIContext) {
} }
// get requested pagename // get requested pagename
pageName := wiki_service.WebPathFromRequest(ctx.PathParamRaw(":pageName")) pageName := wiki_service.RequestToPath(ctx.PathParamRaw(":pageName"))
if len(pageName) == 0 { if len(pageName.WebPath()) == 0 {
pageName = "Home" pageName = wiki_service.WebPathToPath("Home")
} }
// lookup filename in wiki - get filecontent, gitTree entry , real filename // lookup filename in wiki - get filecontent, gitTree entry , real filename
@ -519,9 +519,9 @@ func wikiContentsByEntry(ctx *context.APIContext, entry *git.TreeEntry) string {
// wikiContentsByName returns the contents of a wiki page, along with a boolean // wikiContentsByName returns the contents of a wiki page, along with a boolean
// indicating whether the page exists. Writes to ctx if an error occurs. // indicating whether the page exists. Writes to ctx if an error occurs.
func wikiContentsByName(ctx *context.APIContext, commit *git.Commit, wikiName wiki_service.WebPath, isSidebarOrFooter bool) (string, string) { func wikiContentsByName(ctx *context.APIContext, commit *git.Commit, wikiName wiki_service.Path, isSidebarOrFooter bool) (string, string) {
gitFilename := wiki_service.WebPathToGitPath(wikiName) gitFilename := wikiName.GitPath()
entry, err := findEntryForFile(commit, gitFilename) entry, err := findEntryForFile(commit, string(gitFilename))
if err != nil { if err != nil {
if git.IsErrNotExist(err) { if git.IsErrNotExist(err) {
if !isSidebarOrFooter { if !isSidebarOrFooter {
@ -532,5 +532,5 @@ func wikiContentsByName(ctx *context.APIContext, commit *git.Commit, wikiName wi
} }
return "", "" return "", ""
} }
return wikiContentsByEntry(ctx, entry), gitFilename return wikiContentsByEntry(ctx, entry), string(gitFilename)
} }

92
routers/web/repo/wiki.go
View file

@ -127,16 +127,16 @@ func wikiContentsByEntry(ctx *context.Context, entry *git.TreeEntry) []byte {
// wikiContentsByName returns the contents of a wiki page, along with a boolean // wikiContentsByName returns the contents of a wiki page, along with a boolean
// indicating whether the page exists. Writes to ctx if an error occurs. // indicating whether the page exists. Writes to ctx if an error occurs.
func wikiContentsByName(ctx *context.Context, commit *git.Commit, wikiName wiki_service.WebPath) ([]byte, *git.TreeEntry, string, bool) { func wikiContentsByName(ctx *context.Context, commit *git.Commit, wikiName wiki_service.Path) ([]byte, *git.TreeEntry, string, bool) {
gitFilename := wiki_service.WebPathToGitPath(wikiName) gitFilename := wikiName.GitPath()
entry, err := findEntryForFile(commit, gitFilename) entry, err := findEntryForFile(commit, string(gitFilename))
if err != nil && !git.IsErrNotExist(err) { if err != nil && !git.IsErrNotExist(err) {
ctx.ServerError("findEntryForFile", err) ctx.ServerError("findEntryForFile", err)
return nil, nil, "", false return nil, nil, "", false
} else if entry == nil { } else if entry == nil {
return nil, nil, "", true return nil, nil, "", true
} }
return wikiContentsByEntry(ctx, entry), entry, gitFilename, false return wikiContentsByEntry(ctx, entry), entry, string(gitFilename), false
} }
func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) { func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
@ -165,7 +165,7 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
if !entry.IsRegular() { if !entry.IsRegular() {
continue continue
} }
wikiName, err := wiki_service.GitPathToWebPath(entry.Name()) wikiName, err := wiki_service.GitPathToPath(wiki_service.GitPath(entry.Name()))
if err != nil { if err != nil {
if repo_model.IsErrWikiInvalidFileName(err) { if repo_model.IsErrWikiInvalidFileName(err) {
continue continue
@ -175,32 +175,32 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
} }
ctx.ServerError("WikiFilenameToName", err) ctx.ServerError("WikiFilenameToName", err)
return nil, nil return nil, nil
} else if wikiName == "_Sidebar" || wikiName == "_Footer" { } else if wikiName.WebPath() == "_Sidebar" || wikiName.WebPath() == "_Footer" {
continue continue
} }
_, displayName := wiki_service.WebPathToUserTitle(wikiName) _, displayName := wikiName.DisplayName()
pages = append(pages, PageMeta{ pages = append(pages, PageMeta{
Name: displayName, Name: displayName,
SubURL: wiki_service.WebPathToURLPath(wikiName), SubURL: string(wikiName.URLPath()),
GitEntryName: entry.Name(), GitEntryName: entry.Name(),
}) })
} }
ctx.Data["Pages"] = pages ctx.Data["Pages"] = pages
// get requested page name // get requested page name
pageName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*")) pageName := wiki_service.RequestToPath(ctx.PathParamRaw("*"))
if len(pageName) == 0 { if len(pageName.WebPath()) == 0 {
pageName = "Home" pageName = wiki_service.WebPathToPath("Home")
} }
_, displayName := wiki_service.WebPathToUserTitle(pageName) _, displayName := pageName.DisplayName()
ctx.Data["PageURL"] = wiki_service.WebPathToURLPath(pageName) ctx.Data["PageURL"] = pageName.URLPath()
ctx.Data["old_title"] = displayName ctx.Data["old_title"] = displayName
ctx.Data["Title"] = displayName ctx.Data["Title"] = displayName
ctx.Data["title"] = displayName ctx.Data["title"] = displayName
isSideBar := pageName == "_Sidebar" isSideBar := pageName.WebPath() == "_Sidebar"
isFooter := pageName == "_Footer" isFooter := pageName.WebPath() == "_Footer"
// lookup filename in wiki - get filecontent, gitTree entry , real filename // lookup filename in wiki - get filecontent, gitTree entry , real filename
data, entry, pageFilename, noEntry := wikiContentsByName(ctx, commit, pageName) data, entry, pageFilename, noEntry := wikiContentsByName(ctx, commit, pageName)
@ -216,7 +216,7 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
var sidebarContent []byte var sidebarContent []byte
if !isSideBar { if !isSideBar {
sidebarContent, _, _, _ = wikiContentsByName(ctx, commit, "_Sidebar") sidebarContent, _, _, _ = wikiContentsByName(ctx, commit, wiki_service.WebPathToPath("_Sidebar"))
if ctx.Written() { if ctx.Written() {
if wikiRepo != nil { if wikiRepo != nil {
wikiRepo.Close() wikiRepo.Close()
@ -229,7 +229,7 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
var footerContent []byte var footerContent []byte
if !isFooter { if !isFooter {
footerContent, _, _, _ = wikiContentsByName(ctx, commit, "_Footer") footerContent, _, _, _ = wikiContentsByName(ctx, commit, wiki_service.WebPathToPath("_Footer"))
if ctx.Written() { if ctx.Written() {
if wikiRepo != nil { if wikiRepo != nil {
wikiRepo.Close() wikiRepo.Close()
@ -337,13 +337,13 @@ func renderRevisionPage(ctx *context.Context) (*git.Repository, *git.TreeEntry)
} }
// get requested pagename // get requested pagename
pageName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*")) pageName := wiki_service.RequestToPath(ctx.PathParamRaw("*"))
if len(pageName) == 0 { if len(pageName.WebPath()) == 0 {
pageName = "Home" pageName = wiki_service.WebPathToPath("Home")
} }
_, displayName := wiki_service.WebPathToUserTitle(pageName) _, displayName := pageName.DisplayName()
ctx.Data["PageURL"] = wiki_service.WebPathToURLPath(pageName) ctx.Data["PageURL"] = pageName.URLPath()
ctx.Data["old_title"] = displayName ctx.Data["old_title"] = displayName
ctx.Data["Title"] = displayName ctx.Data["Title"] = displayName
ctx.Data["title"] = displayName ctx.Data["title"] = displayName
@ -421,13 +421,13 @@ func renderEditPage(ctx *context.Context) {
}() }()
// get requested pagename // get requested pagename
pageName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*")) pageName := wiki_service.RequestToPath(ctx.PathParamRaw("*"))
if len(pageName) == 0 { if len(pageName.WebPath()) == 0 {
pageName = "Home" pageName = wiki_service.WebPathToPath("Home")
} }
_, displayName := wiki_service.WebPathToUserTitle(pageName) _, displayName := pageName.DisplayName()
ctx.Data["PageURL"] = wiki_service.WebPathToURLPath(pageName) ctx.Data["PageURL"] = pageName.URLPath()
ctx.Data["old_title"] = displayName ctx.Data["old_title"] = displayName
ctx.Data["Title"] = displayName ctx.Data["Title"] = displayName
ctx.Data["title"] = displayName ctx.Data["title"] = displayName
@ -627,7 +627,7 @@ func WikiPages(ctx *context.Context) {
if !entry.Entry.IsRegular() { if !entry.Entry.IsRegular() {
continue continue
} }
wikiName, err := wiki_service.GitPathToWebPath(entry.Entry.Name()) wikiName, err := wiki_service.GitPathToPath(wiki_service.GitPath(entry.Entry.Name()))
if err != nil { if err != nil {
if repo_model.IsErrWikiInvalidFileName(err) { if repo_model.IsErrWikiInvalidFileName(err) {
continue continue
@ -635,10 +635,10 @@ func WikiPages(ctx *context.Context) {
ctx.ServerError("WikiFilenameToName", err) ctx.ServerError("WikiFilenameToName", err)
return return
} }
_, displayName := wiki_service.WebPathToUserTitle(wikiName) _, displayName := wikiName.DisplayName()
pages = append(pages, PageMeta{ pages = append(pages, PageMeta{
Name: displayName, Name: displayName,
SubURL: wiki_service.WebPathToURLPath(wikiName), SubURL: string(wikiName.URLPath()),
GitEntryName: entry.Entry.Name(), GitEntryName: entry.Entry.Name(),
UpdatedUnix: timeutil.TimeStamp(entry.Commit.Author.When.Unix()), UpdatedUnix: timeutil.TimeStamp(entry.Commit.Author.When.Unix()),
}) })
@ -666,12 +666,12 @@ func WikiRaw(ctx *context.Context) {
return return
} }
providedWebPath := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*")) providedWebPath := wiki_service.RequestToPath(ctx.PathParamRaw("*"))
providedGitPath := wiki_service.WebPathToGitPath(providedWebPath) providedGitPath := providedWebPath.GitPath()
var entry *git.TreeEntry var entry *git.TreeEntry
if commit != nil { if commit != nil {
// Try to find a file with that name // Try to find a file with that name
entry, err = findEntryForFile(commit, providedGitPath) entry, err = findEntryForFile(commit, string(providedGitPath))
if err != nil && !git.IsErrNotExist(err) { if err != nil && !git.IsErrNotExist(err) {
ctx.ServerError("findFile", err) ctx.ServerError("findFile", err)
return return
@ -679,8 +679,8 @@ func WikiRaw(ctx *context.Context) {
if entry == nil { if entry == nil {
// Try to find a wiki page with that name // Try to find a wiki page with that name
providedGitPath = strings.TrimSuffix(providedGitPath, ".md") providedGitPath = wiki_service.GitPath(strings.TrimSuffix(string(providedGitPath), ".md"))
entry, err = findEntryForFile(commit, providedGitPath) entry, err = findEntryForFile(commit, string(providedGitPath))
if err != nil && !git.IsErrNotExist(err) { if err != nil && !git.IsErrNotExist(err) {
ctx.ServerError("findFile", err) ctx.ServerError("findFile", err)
return return
@ -727,7 +727,7 @@ func NewWikiPost(ctx *context.Context) {
return return
} }
wikiName := wiki_service.UserTitleToWebPath("", form.Title) wikiName := wiki_service.TitleToPath(form.Title)
if len(form.Message) == 0 { if len(form.Message) == 0 {
form.Message = ctx.Locale.TrString("repo.editor.add", form.Title) form.Message = ctx.Locale.TrString("repo.editor.add", form.Title)
@ -746,9 +746,9 @@ func NewWikiPost(ctx *context.Context) {
return return
} }
notify_service.NewWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName), form.Message) notify_service.NewWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName.WebPath()), form.Message)
ctx.Redirect(ctx.Repo.RepoLink + "/wiki/" + wiki_service.WebPathToURLPath(wikiName)) ctx.Redirect(ctx.Repo.RepoLink + "/wiki/" + string(wikiName.URLPath()))
} }
// EditWiki render wiki modify page // EditWiki render wiki modify page
@ -778,8 +778,8 @@ func EditWikiPost(ctx *context.Context) {
return return
} }
oldWikiName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*")) oldWikiName := wiki_service.RequestToPath(ctx.PathParamRaw("*"))
newWikiName := wiki_service.UserTitleToWebPath("", form.Title) newWikiName := wiki_service.TitleToPath(form.Title)
if len(form.Message) == 0 { if len(form.Message) == 0 {
form.Message = ctx.Locale.TrString("repo.editor.update", form.Title) form.Message = ctx.Locale.TrString("repo.editor.update", form.Title)
@ -790,16 +790,16 @@ func EditWikiPost(ctx *context.Context) {
return return
} }
notify_service.EditWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(newWikiName), form.Message) notify_service.EditWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(newWikiName.WebPath()), form.Message)
ctx.Redirect(ctx.Repo.RepoLink + "/wiki/" + wiki_service.WebPathToURLPath(newWikiName)) ctx.Redirect(ctx.Repo.RepoLink + "/wiki/" + string(newWikiName.URLPath()))
} }
// DeleteWikiPagePost delete wiki page // DeleteWikiPagePost delete wiki page
func DeleteWikiPagePost(ctx *context.Context) { func DeleteWikiPagePost(ctx *context.Context) {
wikiName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*")) wikiName := wiki_service.RequestToPath(ctx.PathParamRaw("*"))
if len(wikiName) == 0 { if len(wikiName.WebPath()) == 0 {
wikiName = "Home" wikiName = wiki_service.WebPathToPath("Home")
} }
if err := wiki_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, wikiName); err != nil { if err := wiki_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, wikiName); err != nil {
@ -807,7 +807,7 @@ func DeleteWikiPagePost(ctx *context.Context) {
return return
} }
notify_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName)) notify_service.DeleteWikiPage(ctx, ctx.Doer, ctx.Repo.Repository, string(wikiName.WebPath()))
ctx.JSONRedirect(ctx.Repo.RepoLink + "/wiki/") ctx.JSONRedirect(ctx.Repo.RepoLink + "/wiki/")
} }

26
routers/web/repo/wiki_test.go
View file

@ -27,7 +27,7 @@ const (
message = "Wiki commit message for unit tests" message = "Wiki commit message for unit tests"
) )
func wikiEntry(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) *git.TreeEntry { func wikiEntry(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.Path) *git.TreeEntry {
wikiRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo) wikiRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo)
require.NoError(t, err) require.NoError(t, err)
defer wikiRepo.Close() defer wikiRepo.Close()
@ -36,14 +36,14 @@ func wikiEntry(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.
entries, err := commit.ListEntries() entries, err := commit.ListEntries()
require.NoError(t, err) require.NoError(t, err)
for _, entry := range entries { for _, entry := range entries {
if entry.Name() == wiki_service.WebPathToGitPath(wikiName) { if entry.Name() == string(wikiName.GitPath()) {
return entry return entry
} }
} }
return nil return nil
} }
func wikiContent(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) string { func wikiContent(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.Path) string {
entry := wikiEntry(t, repo, wikiName) entry := wikiEntry(t, repo, wikiName)
if !assert.NotNil(t, entry) { if !assert.NotNil(t, entry) {
return "" return ""
@ -56,11 +56,11 @@ func wikiContent(t *testing.T, repo *repo_model.Repository, wikiName wiki_servic
return string(bytes) return string(bytes)
} }
func assertWikiExists(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) { func assertWikiExists(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.Path) {
assert.NotNil(t, wikiEntry(t, repo, wikiName)) assert.NotNil(t, wikiEntry(t, repo, wikiName))
} }
func assertWikiNotExists(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) { func assertWikiNotExists(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.Path) {
assert.Nil(t, wikiEntry(t, repo, wikiName)) assert.Nil(t, wikiEntry(t, repo, wikiName))
} }
@ -127,8 +127,8 @@ func TestNewWikiPost(t *testing.T) {
}) })
NewWikiPost(ctx) NewWikiPost(ctx)
assert.EqualValues(t, http.StatusSeeOther, ctx.Resp.Status()) assert.EqualValues(t, http.StatusSeeOther, ctx.Resp.Status())
assertWikiExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)) assertWikiExists(t, ctx.Repo.Repository, wiki_service.TitleToPath(title))
assert.Equal(t, content, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title))) assert.Equal(t, content, wikiContent(t, ctx.Repo.Repository, wiki_service.TitleToPath(title)))
} }
} }
@ -146,7 +146,7 @@ func TestNewWikiPost_ReservedName(t *testing.T) {
NewWikiPost(ctx) NewWikiPost(ctx)
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status()) assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
assert.EqualValues(t, ctx.Tr("repo.wiki.reserved_page"), ctx.Flash.ErrorMsg) assert.EqualValues(t, ctx.Tr("repo.wiki.reserved_page"), ctx.Flash.ErrorMsg)
assertWikiNotExists(t, ctx.Repo.Repository, "_edit") assertWikiNotExists(t, ctx.Repo.Repository, wiki_service.WebPathToPath("_edit"))
} }
func TestEditWiki(t *testing.T) { func TestEditWiki(t *testing.T) {
@ -159,7 +159,7 @@ func TestEditWiki(t *testing.T) {
EditWiki(ctx) EditWiki(ctx)
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status()) assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
assert.EqualValues(t, "Home", ctx.Data["Title"]) assert.EqualValues(t, "Home", ctx.Data["Title"])
assert.Equal(t, wikiContent(t, ctx.Repo.Repository, "Home"), ctx.Data["content"]) assert.Equal(t, wikiContent(t, ctx.Repo.Repository, wiki_service.WebPathToPath("Home")), ctx.Data["content"])
} }
func TestEditWikiPost(t *testing.T) { func TestEditWikiPost(t *testing.T) {
@ -179,10 +179,10 @@ func TestEditWikiPost(t *testing.T) {
}) })
EditWikiPost(ctx) EditWikiPost(ctx)
assert.EqualValues(t, http.StatusSeeOther, ctx.Resp.Status()) assert.EqualValues(t, http.StatusSeeOther, ctx.Resp.Status())
assertWikiExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)) assertWikiExists(t, ctx.Repo.Repository, wiki_service.TitleToPath(title))
assert.Equal(t, content, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title))) assert.Equal(t, content, wikiContent(t, ctx.Repo.Repository, wiki_service.TitleToPath(title)))
if title != "Home" { if title != "Home" {
assertWikiNotExists(t, ctx.Repo.Repository, "Home") assertWikiNotExists(t, ctx.Repo.Repository, wiki_service.WebPathToPath("Home"))
} }
} }
} }
@ -195,7 +195,7 @@ func TestDeleteWikiPagePost(t *testing.T) {
contexttest.LoadRepo(t, ctx, 1) contexttest.LoadRepo(t, ctx, 1)
DeleteWikiPagePost(ctx) DeleteWikiPagePost(ctx)
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status()) assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
assertWikiNotExists(t, ctx.Repo.Repository, "Home") assertWikiNotExists(t, ctx.Repo.Repository, wiki_service.WebPathToPath("Home"))
} }
func TestWikiRaw(t *testing.T) { func TestWikiRaw(t *testing.T) {

34
services/wiki/wiki.go
View file

@ -98,12 +98,12 @@ func NormalizeWikiBranch(ctx context.Context, repo *repo_model.Repository, to st
// prepareGitPath try to find a suitable file path with file name by the given raw wiki name. // prepareGitPath try to find a suitable file path with file name by the given raw wiki name.
// return: existence, prepared file path with name, error // return: existence, prepared file path with name, error
func prepareGitPath(gitRepo *git.Repository, branch string, wikiPath WebPath) (bool, string, error) { func prepareGitPath(gitRepo *git.Repository, branch string, wikiPath Path) (bool, GitPath, error) {
unescaped := string(wikiPath) + ".md" unescaped := string(wikiPath.WebPath()) + ".md"
gitPath := WebPathToGitPath(wikiPath) gitPath := wikiPath.GitPath()
// Look for both files // Look for both files
filesInIndex, err := gitRepo.LsTree(branch, unescaped, gitPath) filesInIndex, err := gitRepo.LsTree(branch, unescaped, string(gitPath))
if err != nil { if err != nil {
if strings.Contains(err.Error(), "Not a valid object name "+branch) { if strings.Contains(err.Error(), "Not a valid object name "+branch) {
return false, gitPath, nil return false, gitPath, nil
@ -117,8 +117,8 @@ func prepareGitPath(gitRepo *git.Repository, branch string, wikiPath WebPath) (b
switch filename { switch filename {
case unescaped: case unescaped:
// if we find the unescaped file return it // if we find the unescaped file return it
return true, unescaped, nil return true, GitPath(unescaped), nil
case gitPath: case string(gitPath):
foundEscaped = true foundEscaped = true
} }
} }
@ -128,7 +128,7 @@ func prepareGitPath(gitRepo *git.Repository, branch string, wikiPath WebPath) (b
} }
// updateWikiPage adds a new page or edits an existing page in repository wiki. // updateWikiPage adds a new page or edits an existing page in repository wiki.
func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, oldWikiName, newWikiName WebPath, content, message string, isNew bool) (err error) { func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, oldWikiName, newWikiName Path, content, message string, isNew bool) (err error) {
err = repo.MustNotBeArchived() err = repo.MustNotBeArchived()
if err != nil { if err != nil {
return err return err
@ -192,7 +192,7 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
if isNew { if isNew {
if isWikiExist { if isWikiExist {
return repo_model.ErrWikiAlreadyExist{ return repo_model.ErrWikiAlreadyExist{
Title: newWikiPath, Title: string(newWikiPath),
} }
} }
} else { } else {
@ -207,7 +207,7 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
} }
if isOldWikiExist { if isOldWikiExist {
err := gitRepo.RemoveFilesFromIndex(oldWikiPath) err := gitRepo.RemoveFilesFromIndex(string(oldWikiPath))
if err != nil { if err != nil {
log.Error("RemoveFilesFromIndex failed: %v", err) log.Error("RemoveFilesFromIndex failed: %v", err)
return err return err
@ -223,7 +223,7 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
return err return err
} }
if err := gitRepo.AddObjectToIndex("100644", objectHash, newWikiPath); err != nil { if err := gitRepo.AddObjectToIndex("100644", objectHash, string(newWikiPath)); err != nil {
log.Error("AddObjectToIndex failed: %v", err) log.Error("AddObjectToIndex failed: %v", err)
return err return err
} }
@ -281,18 +281,18 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
} }
// AddWikiPage adds a new wiki page with a given wikiPath. // AddWikiPage adds a new wiki page with a given wikiPath.
func AddWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName WebPath, content, message string) error { func AddWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName Path, content, message string) error {
return updateWikiPage(ctx, doer, repo, "", wikiName, content, message, true) return updateWikiPage(ctx, doer, repo, WebPathToPath(""), wikiName, content, message, true)
} }
// EditWikiPage updates a wiki page identified by its wikiPath, // EditWikiPage updates a wiki page identified by its wikiPath,
// optionally also changing wikiPath. // optionally also changing wikiPath.
func EditWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, oldWikiName, newWikiName WebPath, content, message string) error { func EditWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, oldWikiName, newWikiName Path, content, message string) error {
return updateWikiPage(ctx, doer, repo, oldWikiName, newWikiName, content, message, false) return updateWikiPage(ctx, doer, repo, oldWikiName, newWikiName, content, message, false)
} }
// DeleteWikiPage deletes a wiki page identified by its path. // DeleteWikiPage deletes a wiki page identified by its path.
func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName WebPath) (err error) { func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName Path) (err error) {
err = repo.MustNotBeArchived() err = repo.MustNotBeArchived()
if err != nil { if err != nil {
return err return err
@ -341,7 +341,7 @@ func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
return err return err
} }
if found { if found {
err := gitRepo.RemoveFilesFromIndex(wikiPath) err := gitRepo.RemoveFilesFromIndex(string(wikiPath))
if err != nil { if err != nil {
return err return err
} }
@ -433,11 +433,11 @@ func SearchWikiContents(ctx context.Context, repo *repo_model.Repository, keywor
res := make([]SearchContentsResult, 0, len(grepRes)) res := make([]SearchContentsResult, 0, len(grepRes))
for _, entry := range grepRes { for _, entry := range grepRes {
wp, err := GitPathToWebPath(entry.Filename) wp, err := GitPathToPath(GitPath(entry.Filename))
if err != nil { if err != nil {
return nil, err return nil, err
} }
_, title := WebPathToUserTitle(wp) _, title := wp.DisplayName()
res = append(res, SearchContentsResult{ res = append(res, SearchContentsResult{
GrepResult: entry, GrepResult: entry,

205
services/wiki/wiki_path.go
View file

@ -37,12 +37,125 @@ import (
// * This problem should have been 99% fixed, but it needs more tests. // * This problem should have been 99% fixed, but it needs more tests.
// * The old wiki code's behavior is always using %2F, instead of subdirectory, so there are a lot of legacy "%2F" files in user wikis. // * The old wiki code's behavior is always using %2F, instead of subdirectory, so there are a lot of legacy "%2F" files in user wikis.
type WebPath string type (
WebPath string
GitPath string
URLPath string
)
type Path struct {
file WebPath
}
func WebPathToPath(web WebPath) Path {
return Path{
file: web,
}
}
func RequestToPath(req string) Path {
s := util.PathJoinRelX(req)
// The old wiki code's behavior is always using %2F, instead of subdirectory.
s = strings.ReplaceAll(s, "/", "%2F")
return Path{
file: WebPath(s),
}
}
func TitleToPath(title string) Path {
// TODO: no support for subdirectory, because the old wiki code's behavior is always using %2F, instead of subdirectory.
// So we do not add the support for writing slashes in title at the moment.
title = strings.TrimSpace(title)
title = util.PathJoinRelX(escapeSegToWeb(title, false))
if title == "" || title == "." {
title = "unnamed"
}
return Path{
WebPath(title),
}
}
func GitPathToPath(g GitPath) (*Path, error) {
gitPath := string(g)
if !strings.HasSuffix(gitPath, ".md") {
return nil, repo_model.ErrWikiInvalidFileName{FileName: gitPath}
}
gitPath = strings.TrimSuffix(gitPath, ".md")
a := strings.Split(gitPath, "/")
for i := range a {
shouldAddDashMarker := hasDashMarker(a[i])
s, err := unescapeSegment(a[i])
if err != nil {
return nil, err
}
a[i] = s
a[i] = escapeSegToWeb(a[i], shouldAddDashMarker)
}
return &Path{
file: WebPath(strings.Join(a, "/")),
}, nil
}
func (w Path) DisplayName() (dir, display string) {
dir = path.Dir(string(w.file))
display = path.Base(string(w.file))
if strings.HasSuffix(display, ".md") {
display = strings.TrimSuffix(display, ".md")
display, _ = url.PathUnescape(display)
}
display, _ = unescapeSegment(display)
return dir, display
}
func (w Path) WebPath() WebPath {
return w.file
}
func (w Path) GitPath() GitPath {
if strings.HasSuffix(string(w.file), ".md") {
ret, _ := url.PathUnescape(string(w.file))
return GitPath(util.PathJoinRelX(ret))
}
a := strings.Split(string(w.file), "/")
for i := range a {
shouldAddDashMarker := hasDashMarker(a[i])
a[i], _ = unescapeSegment(a[i])
a[i] = escapeSegToWeb(a[i], shouldAddDashMarker)
a[i] = strings.ReplaceAll(a[i], "%20", " ") // space is safe to be kept in git path
a[i] = strings.ReplaceAll(a[i], "+", " ")
}
return GitPath(strings.Join(a, "/") + ".md")
}
func (w Path) URLPath() URLPath {
return URLPath(w.file)
}
func WebPathSegments(s WebPath) []string {
a := strings.Split(string(s), "/")
for i := range a {
a[i], _ = unescapeSegment(a[i])
}
return a
}
// ToWikiPageMetaData converts meta information to a WikiPageMetaData
func ToWikiPageMetaData(wikiPath Path, lastCommit *git.Commit, repo *repo_model.Repository) *api.WikiPageMetaData {
subURL := string(wikiPath.WebPath())
_, title := wikiPath.DisplayName()
return &api.WikiPageMetaData{
Title: title,
HTMLURL: util.URLJoin(repo.HTMLURL(), "wiki", subURL),
SubURL: subURL,
LastCommit: convert.ToWikiCommit(lastCommit),
}
}
var reservedWikiNames = []string{"_pages", "_new", "_edit", "raw"} var reservedWikiNames = []string{"_pages", "_new", "_edit", "raw"}
func validateWebPath(name WebPath) error { func validateWebPath(name Path) error {
for _, s := range WebPathSegments(name) { for _, s := range WebPathSegments(name.WebPath()) {
if util.SliceContainsString(reservedWikiNames, s) { if util.SliceContainsString(reservedWikiNames, s) {
return repo_model.ErrWikiReservedName{Title: s} return repo_model.ErrWikiReservedName{Title: s}
} }
@ -84,89 +197,3 @@ func escapeSegToWeb(s string, hadDashMarker bool) string {
s = url.QueryEscape(s) s = url.QueryEscape(s)
return s return s
} }
func WebPathSegments(s WebPath) []string {
a := strings.Split(string(s), "/")
for i := range a {
a[i], _ = unescapeSegment(a[i])
}
return a
}
func WebPathToGitPath(s WebPath) string {
if strings.HasSuffix(string(s), ".md") {
ret, _ := url.PathUnescape(string(s))
return util.PathJoinRelX(ret)
}
a := strings.Split(string(s), "/")
for i := range a {
shouldAddDashMarker := hasDashMarker(a[i])
a[i], _ = unescapeSegment(a[i])
a[i] = escapeSegToWeb(a[i], shouldAddDashMarker)
a[i] = strings.ReplaceAll(a[i], "%20", " ") // space is safe to be kept in git path
a[i] = strings.ReplaceAll(a[i], "+", " ")
}
return strings.Join(a, "/") + ".md"
}
func GitPathToWebPath(s string) (wp WebPath, err error) {
if !strings.HasSuffix(s, ".md") {
return "", repo_model.ErrWikiInvalidFileName{FileName: s}
}
s = strings.TrimSuffix(s, ".md")
a := strings.Split(s, "/")
for i := range a {
shouldAddDashMarker := hasDashMarker(a[i])
if a[i], err = unescapeSegment(a[i]); err != nil {
return "", err
}
a[i] = escapeSegToWeb(a[i], shouldAddDashMarker)
}
return WebPath(strings.Join(a, "/")), nil
}
func WebPathToUserTitle(s WebPath) (dir, display string) {
dir = path.Dir(string(s))
display = path.Base(string(s))
if strings.HasSuffix(display, ".md") {
display = strings.TrimSuffix(display, ".md")
display, _ = url.PathUnescape(display)
}
display, _ = unescapeSegment(display)
return dir, display
}
func WebPathToURLPath(s WebPath) string {
return string(s)
}
func WebPathFromRequest(s string) WebPath {
s = util.PathJoinRelX(s)
// The old wiki code's behavior is always using %2F, instead of subdirectory.
s = strings.ReplaceAll(s, "/", "%2F")
return WebPath(s)
}
func UserTitleToWebPath(base, title string) WebPath {
// TODO: no support for subdirectory, because the old wiki code's behavior is always using %2F, instead of subdirectory.
// So we do not add the support for writing slashes in title at the moment.
title = strings.TrimSpace(title)
title = util.PathJoinRelX(base, escapeSegToWeb(title, false))
if title == "" || title == "." {
title = "unnamed"
}
return WebPath(title)
}
// ToWikiPageMetaData converts meta information to a WikiPageMetaData
func ToWikiPageMetaData(wikiName WebPath, lastCommit *git.Commit, repo *repo_model.Repository) *api.WikiPageMetaData {
subURL := string(wikiName)
_, title := WebPathToUserTitle(wikiName)
return &api.WikiPageMetaData{
Title: title,
HTMLURL: util.URLJoin(repo.HTMLURL(), "wiki", subURL),
SubURL: subURL,
LastCommit: convert.ToWikiCommit(lastCommit),
}
}

83
services/wiki/wiki_test.go
View file

@ -31,7 +31,7 @@ func TestWebPathSegments(t *testing.T) {
func TestUserTitleToWebPath(t *testing.T) { func TestUserTitleToWebPath(t *testing.T) {
type test struct { type test struct {
Expected string Expected WebPath
UserTitle string UserTitle string
} }
for _, test := range []test{ for _, test := range []test{
@ -45,7 +45,7 @@ func TestUserTitleToWebPath(t *testing.T) {
{"a%2Fb", "a/b"}, {"a%2Fb", "a/b"},
{"a%25b", "a%b"}, {"a%25b", "a%b"},
} { } {
assert.EqualValues(t, test.Expected, UserTitleToWebPath("", test.UserTitle)) assert.EqualValues(t, test.Expected, TitleToPath(test.UserTitle).WebPath())
} }
} }
@ -62,15 +62,15 @@ func TestWebPathToDisplayName(t *testing.T) {
{"2000-01-02 meeting", "2000-01-02+meeting.-.md"}, {"2000-01-02 meeting", "2000-01-02+meeting.-.md"},
{"a b", "a%20b.md"}, {"a b", "a%20b.md"},
} { } {
_, displayName := WebPathToUserTitle(test.WebPath) _, displayName := WebPathToPath(test.WebPath).DisplayName()
assert.EqualValues(t, test.Expected, displayName) assert.EqualValues(t, test.Expected, displayName)
} }
} }
func TestWebPathToGitPath(t *testing.T) { func TestWebPathToGitPath(t *testing.T) {
type test struct { type test struct {
Expected string Expected GitPath
WikiName WebPath WebPath WebPath
} }
for _, test := range []test{ for _, test := range []test{
{"wiki-name.md", "wiki%20name"}, {"wiki-name.md", "wiki%20name"},
@ -80,14 +80,14 @@ func TestWebPathToGitPath(t *testing.T) {
{"2000-01-02-meeting.md", "2000-01-02+meeting"}, {"2000-01-02-meeting.md", "2000-01-02+meeting"},
{"2000-01-02 meeting.-.md", "2000-01-02%20meeting.-"}, {"2000-01-02 meeting.-.md", "2000-01-02%20meeting.-"},
} { } {
assert.EqualValues(t, test.Expected, WebPathToGitPath(test.WikiName)) assert.EqualValues(t, test.Expected, WebPathToPath(test.WebPath).GitPath())
} }
} }
func TestGitPathToWebPath(t *testing.T) { func TestGitPathToWebPath(t *testing.T) {
type test struct { type test struct {
Expected string Expected WebPath
Filename string Filename GitPath
} }
for _, test := range []test{ for _, test := range []test{
{"hello-world", "hello-world.md"}, // this shouldn't happen, because it should always have a ".-" suffix {"hello-world", "hello-world.md"}, // this shouldn't happen, because it should always have a ".-" suffix
@ -96,19 +96,19 @@ func TestGitPathToWebPath(t *testing.T) {
{"hello+world.-", "hello world.-.md"}, {"hello+world.-", "hello world.-.md"},
{"symbols-%2F", "symbols %2F.md"}, {"symbols-%2F", "symbols %2F.md"},
} { } {
name, err := GitPathToWebPath(test.Filename) wikiPath, err := GitPathToPath(test.Filename)
require.NoError(t, err) require.NoError(t, err)
assert.EqualValues(t, test.Expected, name) assert.EqualValues(t, test.Expected, wikiPath.WebPath())
} }
for _, badFilename := range []string{ for _, badFilename := range []GitPath{
"nofileextension", "nofileextension",
"wrongfileextension.txt", "wrongfileextension.txt",
} { } {
_, err := GitPathToWebPath(badFilename) _, err := GitPathToPath(badFilename)
require.Error(t, err) require.Error(t, err)
assert.True(t, repo_model.IsErrWikiInvalidFileName(err)) assert.True(t, repo_model.IsErrWikiInvalidFileName(err))
} }
_, err := GitPathToWebPath("badescaping%%.md") _, err := GitPathToPath("badescaping%%.md")
require.Error(t, err) require.Error(t, err)
assert.False(t, repo_model.IsErrWikiInvalidFileName(err)) assert.False(t, repo_model.IsErrWikiInvalidFileName(err))
} }
@ -127,12 +127,15 @@ func TestUserWebGitPathConsistency(t *testing.T) {
if userTitle == "" || userTitle == "." || userTitle == ".." { if userTitle == "" || userTitle == "." || userTitle == ".." {
continue continue
} }
webPath := UserTitleToWebPath("", userTitle) wikiPath := TitleToPath(userTitle)
gitPath := WebPathToGitPath(webPath) webPath := wikiPath.WebPath()
gitPath := wikiPath.GitPath()
webPath1, _ := GitPathToWebPath(gitPath) wikiPath1, err := GitPathToPath(gitPath)
_, userTitle1 := WebPathToUserTitle(webPath1) require.NoError(t, err)
gitPath1 := WebPathToGitPath(webPath1) webPath1 := wikiPath1.WebPath()
_, userTitle1 := WebPathToPath(webPath1).DisplayName()
gitPath1 := WebPathToPath(webPath1).GitPath()
assert.EqualValues(t, userTitle, userTitle1, "UserTitle for userTitle: %q", userTitle) assert.EqualValues(t, userTitle, userTitle1, "UserTitle for userTitle: %q", userTitle)
assert.EqualValues(t, webPath, webPath1, "WebPath for userTitle: %q", userTitle) assert.EqualValues(t, webPath, webPath1, "WebPath for userTitle: %q", userTitle)
@ -163,8 +166,8 @@ func TestRepository_AddWikiPage(t *testing.T) {
"Here's a <tag> and a/slash", "Here's a <tag> and a/slash",
} { } {
t.Run("test wiki exist: "+userTitle, func(t *testing.T) { t.Run("test wiki exist: "+userTitle, func(t *testing.T) {
webPath := UserTitleToWebPath("", userTitle) wikiPath := TitleToPath(userTitle)
require.NoError(t, AddWikiPage(git.DefaultContext, doer, repo, webPath, wikiContent, commitMsg)) require.NoError(t, AddWikiPage(git.DefaultContext, doer, repo, wikiPath, wikiContent, commitMsg))
// Now need to show that the page has been added: // Now need to show that the page has been added:
gitRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo) gitRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo)
require.NoError(t, err) require.NoError(t, err)
@ -172,8 +175,8 @@ func TestRepository_AddWikiPage(t *testing.T) {
defer gitRepo.Close() defer gitRepo.Close()
masterTree, err := gitRepo.GetTree("master") masterTree, err := gitRepo.GetTree("master")
require.NoError(t, err) require.NoError(t, err)
gitPath := WebPathToGitPath(webPath) gitPath := wikiPath.GitPath()
entry, err := masterTree.GetTreeEntryByPath(gitPath) entry, err := masterTree.GetTreeEntryByPath(string(gitPath))
require.NoError(t, err) require.NoError(t, err)
assert.EqualValues(t, gitPath, entry.Name(), "%s not added correctly", userTitle) assert.EqualValues(t, gitPath, entry.Name(), "%s not added correctly", userTitle)
}) })
@ -182,7 +185,7 @@ func TestRepository_AddWikiPage(t *testing.T) {
t.Run("check wiki already exist", func(t *testing.T) { t.Run("check wiki already exist", func(t *testing.T) {
t.Parallel() t.Parallel()
// test for already-existing wiki name // test for already-existing wiki name
err := AddWikiPage(git.DefaultContext, doer, repo, "Home", wikiContent, commitMsg) err := AddWikiPage(git.DefaultContext, doer, repo, TitleToPath("Home"), wikiContent, commitMsg)
require.Error(t, err) require.Error(t, err)
assert.True(t, repo_model.IsErrWikiAlreadyExist(err)) assert.True(t, repo_model.IsErrWikiAlreadyExist(err))
}) })
@ -190,7 +193,7 @@ func TestRepository_AddWikiPage(t *testing.T) {
t.Run("check wiki reserved name", func(t *testing.T) { t.Run("check wiki reserved name", func(t *testing.T) {
t.Parallel() t.Parallel()
// test for reserved wiki name // test for reserved wiki name
err := AddWikiPage(git.DefaultContext, doer, repo, "_edit", wikiContent, commitMsg) err := AddWikiPage(git.DefaultContext, doer, repo, TitleToPath("_edit"), wikiContent, commitMsg)
require.Error(t, err) require.Error(t, err)
assert.True(t, repo_model.IsErrWikiReservedName(err)) assert.True(t, repo_model.IsErrWikiReservedName(err))
}) })
@ -208,17 +211,17 @@ func TestRepository_EditWikiPage(t *testing.T) {
"New home", "New home",
"New/name/with/slashes", "New/name/with/slashes",
} { } {
webPath := UserTitleToWebPath("", newWikiName) wikiPath := TitleToPath(newWikiName)
unittest.PrepareTestEnv(t) unittest.PrepareTestEnv(t)
require.NoError(t, EditWikiPage(git.DefaultContext, doer, repo, "Home", webPath, newWikiContent, commitMsg)) require.NoError(t, EditWikiPage(git.DefaultContext, doer, repo, TitleToPath("Home"), wikiPath, newWikiContent, commitMsg))
// Now need to show that the page has been added: // Now need to show that the page has been added:
gitRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo) gitRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo)
require.NoError(t, err) require.NoError(t, err)
masterTree, err := gitRepo.GetTree("master") masterTree, err := gitRepo.GetTree("master")
require.NoError(t, err) require.NoError(t, err)
gitPath := WebPathToGitPath(webPath) gitPath := wikiPath.GitPath()
entry, err := masterTree.GetTreeEntryByPath(gitPath) entry, err := masterTree.GetTreeEntryByPath(string(gitPath))
require.NoError(t, err) require.NoError(t, err)
assert.EqualValues(t, gitPath, entry.Name(), "%s not edited correctly", newWikiName) assert.EqualValues(t, gitPath, entry.Name(), "%s not edited correctly", newWikiName)
@ -234,7 +237,7 @@ func TestRepository_DeleteWikiPage(t *testing.T) {
unittest.PrepareTestEnv(t) unittest.PrepareTestEnv(t)
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1}) repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
doer := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) doer := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
require.NoError(t, DeleteWikiPage(git.DefaultContext, doer, repo, "Home")) require.NoError(t, DeleteWikiPage(git.DefaultContext, doer, repo, TitleToPath("Home")))
// Now need to show that the page has been added: // Now need to show that the page has been added:
gitRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo) gitRepo, err := gitrepo.OpenWikiRepository(git.DefaultContext, repo)
@ -242,8 +245,8 @@ func TestRepository_DeleteWikiPage(t *testing.T) {
defer gitRepo.Close() defer gitRepo.Close()
masterTree, err := gitRepo.GetTree("master") masterTree, err := gitRepo.GetTree("master")
require.NoError(t, err) require.NoError(t, err)
gitPath := WebPathToGitPath("Home") gitPath := WebPathToPath("Home").GitPath()
_, err = masterTree.GetTreeEntryByPath(gitPath) _, err = masterTree.GetTreeEntryByPath(string(gitPath))
require.Error(t, err) require.Error(t, err)
} }
@ -276,8 +279,8 @@ func TestPrepareWikiFileName(t *testing.T) {
}} }}
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
webPath := UserTitleToWebPath("", tt.arg) wikiPath := TitleToPath(tt.arg)
existence, newWikiPath, err := prepareGitPath(gitRepo, "master", webPath) existence, newWikiPath, err := prepareGitPath(gitRepo, "master", wikiPath)
if (err != nil) != tt.wantErr { if (err != nil) != tt.wantErr {
require.NoError(t, err) require.NoError(t, err)
return return
@ -308,20 +311,20 @@ func TestPrepareWikiFileName_FirstPage(t *testing.T) {
defer gitRepo.Close() defer gitRepo.Close()
existence, newWikiPath, err := prepareGitPath(gitRepo, "master", "Home") existence, newWikiPath, err := prepareGitPath(gitRepo, "master", TitleToPath("Home"))
assert.False(t, existence) assert.False(t, existence)
require.NoError(t, err) require.NoError(t, err)
assert.EqualValues(t, "Home.md", newWikiPath) assert.EqualValues(t, "Home.md", newWikiPath)
} }
func TestWebPathConversion(t *testing.T) { func TestWebPathConversion(t *testing.T) {
assert.Equal(t, "path/wiki", WebPathToURLPath(WebPath("path/wiki"))) assert.Equal(t, "path/wiki", string(WebPathToPath("path/wiki").URLPath()))
assert.Equal(t, "wiki", WebPathToURLPath(WebPath("wiki"))) assert.Equal(t, "wiki", string(WebPathToPath("wiki").URLPath()))
assert.Equal(t, "", WebPathToURLPath(WebPath(""))) assert.Equal(t, "", string(WebPathToPath("").URLPath()))
} }
func TestWebPathFromRequest(t *testing.T) { func TestWebPathFromRequest(t *testing.T) {
assert.Equal(t, WebPath("a%2Fb"), WebPathFromRequest("a/b")) assert.Equal(t, WebPath("a%2Fb"), RequestToPath("a/b").WebPath())
assert.Equal(t, WebPath("a"), WebPathFromRequest("a")) assert.Equal(t, WebPath("a"), RequestToPath("a").WebPath())
assert.Equal(t, WebPath("b"), WebPathFromRequest("a/../b")) assert.Equal(t, WebPath("b"), RequestToPath("a/../b").WebPath())
} }

2
tests/test_utils.go
View file

@ -457,7 +457,7 @@ func CreateDeclarativeRepoWithOptions(t *testing.T, owner *user_model.User, opts
require.NoError(t, err) require.NoError(t, err)
// Add a new wiki page // Add a new wiki page
err = wiki_service.AddWikiPage(db.DefaultContext, owner, repo, "Home", "Welcome to the wiki!", "Add a Home page") err = wiki_service.AddWikiPage(db.DefaultContext, owner, repo, wiki_service.WebPathToPath("Home"), "Welcome to the wiki!", "Add a Home page")
require.NoError(t, err) require.NoError(t, err)
} }