Move wiki related funtions from models to services/wiki (#9355)
* Move wiki related funtions from models to services/wikitokarchuk/v1.17
Lunny Xiao
5 years ago
committed by
zeripath
parent
e5d8e2d10c
commit
b9309e52f0
@ -0,0 +1,322 @@ |
||||
// Copyright 2015 The Gogs Authors. All rights reserved.
|
||||
// Copyright 2019 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package wiki |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/url" |
||||
"os" |
||||
"strings" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
"code.gitea.io/gitea/modules/git" |
||||
"code.gitea.io/gitea/modules/log" |
||||
"code.gitea.io/gitea/modules/sync" |
||||
"code.gitea.io/gitea/modules/util" |
||||
|
||||
"github.com/unknwon/com" |
||||
) |
||||
|
||||
var ( |
||||
reservedWikiNames = []string{"_pages", "_new", "_edit", "raw"} |
||||
wikiWorkingPool = sync.NewExclusivePool() |
||||
) |
||||
|
||||
func nameAllowed(name string) error { |
||||
if util.IsStringInSlice(name, reservedWikiNames) { |
||||
return models.ErrWikiReservedName{ |
||||
Title: name, |
||||
} |
||||
} |
||||
return nil |
||||
} |
||||
|
||||
// NameToSubURL converts a wiki name to its corresponding sub-URL.
|
||||
func NameToSubURL(name string) string { |
||||
return url.QueryEscape(strings.Replace(name, " ", "-", -1)) |
||||
} |
||||
|
||||
// NormalizeWikiName normalizes a wiki name
|
||||
func NormalizeWikiName(name string) string { |
||||
return strings.Replace(name, "-", " ", -1) |
||||
} |
||||
|
||||
// NameToFilename converts a wiki name to its corresponding filename.
|
||||
func NameToFilename(name string) string { |
||||
name = strings.Replace(name, " ", "-", -1) |
||||
return url.QueryEscape(name) + ".md" |
||||
} |
||||
|
||||
// FilenameToName converts a wiki filename to its corresponding page name.
|
||||
func FilenameToName(filename string) (string, error) { |
||||
if !strings.HasSuffix(filename, ".md") { |
||||
return "", models.ErrWikiInvalidFileName{ |
||||
FileName: filename, |
||||
} |
||||
} |
||||
basename := filename[:len(filename)-3] |
||||
unescaped, err := url.QueryUnescape(basename) |
||||
if err != nil { |
||||
return "", err |
||||
} |
||||
return NormalizeWikiName(unescaped), nil |
||||
} |
||||
|
||||
// InitWiki initializes a wiki for repository,
|
||||
// it does nothing when repository already has wiki.
|
||||
func InitWiki(repo *models.Repository) error { |
||||
if repo.HasWiki() { |
||||
return nil |
||||
} |
||||
|
||||
if err := git.InitRepository(repo.WikiPath(), true); err != nil { |
||||
return fmt.Errorf("InitRepository: %v", err) |
||||
} else if err = models.CreateDelegateHooks(repo.WikiPath()); err != nil { |
||||
return fmt.Errorf("createDelegateHooks: %v", err) |
||||
} |
||||
return nil |
||||
} |
||||
|
||||
// updateWikiPage adds a new page to the repository wiki.
|
||||
func updateWikiPage(doer *models.User, repo *models.Repository, oldWikiName, newWikiName, content, message string, isNew bool) (err error) { |
||||
if err = nameAllowed(newWikiName); err != nil { |
||||
return err |
||||
} |
||||
wikiWorkingPool.CheckIn(com.ToStr(repo.ID)) |
||||
defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID)) |
||||
|
||||
if err = InitWiki(repo); err != nil { |
||||
return fmt.Errorf("InitWiki: %v", err) |
||||
} |
||||
|
||||
hasMasterBranch := git.IsBranchExist(repo.WikiPath(), "master") |
||||
|
||||
basePath, err := models.CreateTemporaryPath("update-wiki") |
||||
if err != nil { |
||||
return err |
||||
} |
||||
defer func() { |
||||
if err := models.RemoveTemporaryPath(basePath); err != nil { |
||||
log.Error("Merge: RemoveTemporaryPath: %s", err) |
||||
} |
||||
}() |
||||
|
||||
cloneOpts := git.CloneRepoOptions{ |
||||
Bare: true, |
||||
Shared: true, |
||||
} |
||||
|
||||
if hasMasterBranch { |
||||
cloneOpts.Branch = "master" |
||||
} |
||||
|
||||
if err := git.Clone(repo.WikiPath(), basePath, cloneOpts); err != nil { |
||||
log.Error("Failed to clone repository: %s (%v)", repo.FullName(), err) |
||||
return fmt.Errorf("Failed to clone repository: %s (%v)", repo.FullName(), err) |
||||
} |
||||
|
||||
gitRepo, err := git.OpenRepository(basePath) |
||||
if err != nil { |
||||
log.Error("Unable to open temporary repository: %s (%v)", basePath, err) |
||||
return fmt.Errorf("Failed to open new temporary repository in: %s %v", basePath, err) |
||||
} |
||||
defer gitRepo.Close() |
||||
|
||||
if hasMasterBranch { |
||||
if err := gitRepo.ReadTreeToIndex("HEAD"); err != nil { |
||||
log.Error("Unable to read HEAD tree to index in: %s %v", basePath, err) |
||||
return fmt.Errorf("Unable to read HEAD tree to index in: %s %v", basePath, err) |
||||
} |
||||
} |
||||
|
||||
newWikiPath := NameToFilename(newWikiName) |
||||
if isNew { |
||||
filesInIndex, err := gitRepo.LsFiles(newWikiPath) |
||||
if err != nil { |
||||
log.Error("%v", err) |
||||
return err |
||||
} |
||||
if util.IsStringInSlice(newWikiPath, filesInIndex) { |
||||
return models.ErrWikiAlreadyExist{ |
||||
Title: newWikiPath, |
||||
} |
||||
} |
||||
} else { |
||||
oldWikiPath := NameToFilename(oldWikiName) |
||||
filesInIndex, err := gitRepo.LsFiles(oldWikiPath) |
||||
if err != nil { |
||||
log.Error("%v", err) |
||||
return err |
||||
} |
||||
|
||||
if util.IsStringInSlice(oldWikiPath, filesInIndex) { |
||||
err := gitRepo.RemoveFilesFromIndex(oldWikiPath) |
||||
if err != nil { |
||||
log.Error("%v", err) |
||||
return err |
||||
} |
||||
} |
||||
} |
||||
|
||||
// FIXME: The wiki doesn't have lfs support at present - if this changes need to check attributes here
|
||||
|
||||
objectHash, err := gitRepo.HashObject(strings.NewReader(content)) |
||||
if err != nil { |
||||
log.Error("%v", err) |
||||
return err |
||||
} |
||||
|
||||
if err := gitRepo.AddObjectToIndex("100644", objectHash, newWikiPath); err != nil { |
||||
log.Error("%v", err) |
||||
return err |
||||
} |
||||
|
||||
tree, err := gitRepo.WriteTree() |
||||
if err != nil { |
||||
log.Error("%v", err) |
||||
return err |
||||
} |
||||
|
||||
commitTreeOpts := git.CommitTreeOpts{ |
||||
Message: message, |
||||
} |
||||
|
||||
sign, signingKey := repo.SignWikiCommit(doer) |
||||
if sign { |
||||
commitTreeOpts.KeyID = signingKey |
||||
} else { |
||||
commitTreeOpts.NoGPGSign = true |
||||
} |
||||
if hasMasterBranch { |
||||
commitTreeOpts.Parents = []string{"HEAD"} |
||||
} |
||||
commitHash, err := gitRepo.CommitTree(doer.NewGitSig(), tree, commitTreeOpts) |
||||
if err != nil { |
||||
log.Error("%v", err) |
||||
return err |
||||
} |
||||
|
||||
if err := git.Push(basePath, git.PushOptions{ |
||||
Remote: "origin", |
||||
Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, "master"), |
||||
Env: models.FullPushingEnvironment( |
||||
doer, |
||||
doer, |
||||
repo, |
||||
repo.Name+".wiki", |
||||
0, |
||||
), |
||||
}); err != nil { |
||||
log.Error("%v", err) |
||||
return fmt.Errorf("Push: %v", err) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// AddWikiPage adds a new wiki page with a given wikiPath.
|
||||
func AddWikiPage(doer *models.User, repo *models.Repository, wikiName, content, message string) error { |
||||
return updateWikiPage(doer, repo, "", wikiName, content, message, true) |
||||
} |
||||
|
||||
// EditWikiPage updates a wiki page identified by its wikiPath,
|
||||
// optionally also changing wikiPath.
|
||||
func EditWikiPage(doer *models.User, repo *models.Repository, oldWikiName, newWikiName, content, message string) error { |
||||
return updateWikiPage(doer, repo, oldWikiName, newWikiName, content, message, false) |
||||
} |
||||
|
||||
// DeleteWikiPage deletes a wiki page identified by its path.
|
||||
func DeleteWikiPage(doer *models.User, repo *models.Repository, wikiName string) (err error) { |
||||
wikiWorkingPool.CheckIn(com.ToStr(repo.ID)) |
||||
defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID)) |
||||
|
||||
if err = InitWiki(repo); err != nil { |
||||
return fmt.Errorf("InitWiki: %v", err) |
||||
} |
||||
|
||||
basePath, err := models.CreateTemporaryPath("update-wiki") |
||||
if err != nil { |
||||
return err |
||||
} |
||||
defer func() { |
||||
if err := models.RemoveTemporaryPath(basePath); err != nil { |
||||
log.Error("Merge: RemoveTemporaryPath: %s", err) |
||||
} |
||||
}() |
||||
|
||||
if err := git.Clone(repo.WikiPath(), basePath, git.CloneRepoOptions{ |
||||
Bare: true, |
||||
Shared: true, |
||||
Branch: "master", |
||||
}); err != nil { |
||||
log.Error("Failed to clone repository: %s (%v)", repo.FullName(), err) |
||||
return fmt.Errorf("Failed to clone repository: %s (%v)", repo.FullName(), err) |
||||
} |
||||
|
||||
gitRepo, err := git.OpenRepository(basePath) |
||||
if err != nil { |
||||
log.Error("Unable to open temporary repository: %s (%v)", basePath, err) |
||||
return fmt.Errorf("Failed to open new temporary repository in: %s %v", basePath, err) |
||||
} |
||||
defer gitRepo.Close() |
||||
|
||||
if err := gitRepo.ReadTreeToIndex("HEAD"); err != nil { |
||||
log.Error("Unable to read HEAD tree to index in: %s %v", basePath, err) |
||||
return fmt.Errorf("Unable to read HEAD tree to index in: %s %v", basePath, err) |
||||
} |
||||
|
||||
wikiPath := NameToFilename(wikiName) |
||||
filesInIndex, err := gitRepo.LsFiles(wikiPath) |
||||
found := false |
||||
for _, file := range filesInIndex { |
||||
if file == wikiPath { |
||||
found = true |
||||
break |
||||
} |
||||
} |
||||
if found { |
||||
err := gitRepo.RemoveFilesFromIndex(wikiPath) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
} else { |
||||
return os.ErrNotExist |
||||
} |
||||
|
||||
// FIXME: The wiki doesn't have lfs support at present - if this changes need to check attributes here
|
||||
|
||||
tree, err := gitRepo.WriteTree() |
||||
if err != nil { |
||||
return err |
||||
} |
||||
message := "Delete page '" + wikiName + "'" |
||||
commitTreeOpts := git.CommitTreeOpts{ |
||||
Message: message, |
||||
Parents: []string{"HEAD"}, |
||||
} |
||||
|
||||
sign, signingKey := repo.SignWikiCommit(doer) |
||||
if sign { |
||||
commitTreeOpts.KeyID = signingKey |
||||
} else { |
||||
commitTreeOpts.NoGPGSign = true |
||||
} |
||||
|
||||
commitHash, err := gitRepo.CommitTree(doer.NewGitSig(), tree, commitTreeOpts) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
if err := git.Push(basePath, git.PushOptions{ |
||||
Remote: "origin", |
||||
Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, "master"), |
||||
Env: models.PushingEnvironment(doer, repo), |
||||
}); err != nil { |
||||
return fmt.Errorf("Push: %v", err) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
@ -0,0 +1,210 @@ |
||||
// Copyright 2019 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package wiki |
||||
|
||||
import ( |
||||
"path/filepath" |
||||
"testing" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
"code.gitea.io/gitea/modules/git" |
||||
"github.com/stretchr/testify/assert" |
||||
) |
||||
|
||||
func TestMain(m *testing.M) { |
||||
models.MainTest(m, filepath.Join("..", "..")) |
||||
} |
||||
|
||||
func TestWikiNameToSubURL(t *testing.T) { |
||||
type test struct { |
||||
Expected string |
||||
WikiName string |
||||
} |
||||
for _, test := range []test{ |
||||
{"wiki-name", "wiki name"}, |
||||
{"wiki-name", "wiki-name"}, |
||||
{"name-with%2Fslash", "name with/slash"}, |
||||
{"name-with%25percent", "name with%percent"}, |
||||
} { |
||||
assert.Equal(t, test.Expected, NameToSubURL(test.WikiName)) |
||||
} |
||||
} |
||||
|
||||
func TestNormalizeWikiName(t *testing.T) { |
||||
type test struct { |
||||
Expected string |
||||
WikiName string |
||||
} |
||||
for _, test := range []test{ |
||||
{"wiki name", "wiki name"}, |
||||
{"wiki name", "wiki-name"}, |
||||
{"name with/slash", "name with/slash"}, |
||||
{"name with%percent", "name-with%percent"}, |
||||
{"%2F", "%2F"}, |
||||
} { |
||||
assert.Equal(t, test.Expected, NormalizeWikiName(test.WikiName)) |
||||
} |
||||
} |
||||
|
||||
func TestWikiNameToFilename(t *testing.T) { |
||||
type test struct { |
||||
Expected string |
||||
WikiName string |
||||
} |
||||
for _, test := range []test{ |
||||
{"wiki-name.md", "wiki name"}, |
||||
{"wiki-name.md", "wiki-name"}, |
||||
{"name-with%2Fslash.md", "name with/slash"}, |
||||
{"name-with%25percent.md", "name with%percent"}, |
||||
} { |
||||
assert.Equal(t, test.Expected, NameToFilename(test.WikiName)) |
||||
} |
||||
} |
||||
|
||||
func TestWikiFilenameToName(t *testing.T) { |
||||
type test struct { |
||||
Expected string |
||||
Filename string |
||||
} |
||||
for _, test := range []test{ |
||||
{"hello world", "hello-world.md"}, |
||||
{"symbols/?*", "symbols%2F%3F%2A.md"}, |
||||
} { |
||||
name, err := FilenameToName(test.Filename) |
||||
assert.NoError(t, err) |
||||
assert.Equal(t, test.Expected, name) |
||||
} |
||||
for _, badFilename := range []string{ |
||||
"nofileextension", |
||||
"wrongfileextension.txt", |
||||
} { |
||||
_, err := FilenameToName(badFilename) |
||||
assert.Error(t, err) |
||||
assert.True(t, models.IsErrWikiInvalidFileName(err)) |
||||
} |
||||
_, err := FilenameToName("badescaping%%.md") |
||||
assert.Error(t, err) |
||||
assert.False(t, models.IsErrWikiInvalidFileName(err)) |
||||
} |
||||
|
||||
func TestWikiNameToFilenameToName(t *testing.T) { |
||||
// converting from wiki name to filename, then back to wiki name should
|
||||
// return the original (normalized) name
|
||||
for _, name := range []string{ |
||||
"wiki-name", |
||||
"wiki name", |
||||
"wiki name with/slash", |
||||
"$$$%%%^^&&!@#$(),.<>", |
||||
} { |
||||
filename := NameToFilename(name) |
||||
resultName, err := FilenameToName(filename) |
||||
assert.NoError(t, err) |
||||
assert.Equal(t, NormalizeWikiName(name), resultName) |
||||
} |
||||
} |
||||
|
||||
func TestRepository_InitWiki(t *testing.T) { |
||||
models.PrepareTestEnv(t) |
||||
// repo1 already has a wiki
|
||||
repo1 := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) |
||||
assert.NoError(t, InitWiki(repo1)) |
||||
|
||||
// repo2 does not already have a wiki
|
||||
repo2 := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 2}).(*models.Repository) |
||||
assert.NoError(t, InitWiki(repo2)) |
||||
assert.True(t, repo2.HasWiki()) |
||||
} |
||||
|
||||
func TestRepository_AddWikiPage(t *testing.T) { |
||||
assert.NoError(t, models.PrepareTestDatabase()) |
||||
const wikiContent = "This is the wiki content" |
||||
const commitMsg = "Commit message" |
||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) |
||||
doer := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User) |
||||
for _, wikiName := range []string{ |
||||
"Another page", |
||||
"Here's a <tag> and a/slash", |
||||
} { |
||||
wikiName := wikiName |
||||
t.Run("test wiki exist: "+wikiName, func(t *testing.T) { |
||||
t.Parallel() |
||||
assert.NoError(t, AddWikiPage(doer, repo, wikiName, wikiContent, commitMsg)) |
||||
// Now need to show that the page has been added:
|
||||
gitRepo, err := git.OpenRepository(repo.WikiPath()) |
||||
assert.NoError(t, err) |
||||
defer gitRepo.Close() |
||||
masterTree, err := gitRepo.GetTree("master") |
||||
assert.NoError(t, err) |
||||
wikiPath := NameToFilename(wikiName) |
||||
entry, err := masterTree.GetTreeEntryByPath(wikiPath) |
||||
assert.NoError(t, err) |
||||
assert.Equal(t, wikiPath, entry.Name(), "%s not addded correctly", wikiName) |
||||
}) |
||||
} |
||||
|
||||
t.Run("check wiki already exist", func(t *testing.T) { |
||||
t.Parallel() |
||||
// test for already-existing wiki name
|
||||
err := AddWikiPage(doer, repo, "Home", wikiContent, commitMsg) |
||||
assert.Error(t, err) |
||||
assert.True(t, models.IsErrWikiAlreadyExist(err)) |
||||
}) |
||||
|
||||
t.Run("check wiki reserved name", func(t *testing.T) { |
||||
t.Parallel() |
||||
// test for reserved wiki name
|
||||
err := AddWikiPage(doer, repo, "_edit", wikiContent, commitMsg) |
||||
assert.Error(t, err) |
||||
assert.True(t, models.IsErrWikiReservedName(err)) |
||||
}) |
||||
} |
||||
|
||||
func TestRepository_EditWikiPage(t *testing.T) { |
||||
const newWikiContent = "This is the new content" |
||||
const commitMsg = "Commit message" |
||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) |
||||
doer := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User) |
||||
for _, newWikiName := range []string{ |
||||
"Home", // same name as before
|
||||
"New home", |
||||
"New/name/with/slashes", |
||||
} { |
||||
models.PrepareTestEnv(t) |
||||
assert.NoError(t, EditWikiPage(doer, repo, "Home", newWikiName, newWikiContent, commitMsg)) |
||||
|
||||
// Now need to show that the page has been added:
|
||||
gitRepo, err := git.OpenRepository(repo.WikiPath()) |
||||
assert.NoError(t, err) |
||||
masterTree, err := gitRepo.GetTree("master") |
||||
assert.NoError(t, err) |
||||
wikiPath := NameToFilename(newWikiName) |
||||
entry, err := masterTree.GetTreeEntryByPath(wikiPath) |
||||
assert.NoError(t, err) |
||||
assert.Equal(t, wikiPath, entry.Name(), "%s not editted correctly", newWikiName) |
||||
|
||||
if newWikiName != "Home" { |
||||
_, err := masterTree.GetTreeEntryByPath("Home.md") |
||||
assert.Error(t, err) |
||||
} |
||||
gitRepo.Close() |
||||
} |
||||
} |
||||
|
||||
func TestRepository_DeleteWikiPage(t *testing.T) { |
||||
models.PrepareTestEnv(t) |
||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) |
||||
doer := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User) |
||||
assert.NoError(t, DeleteWikiPage(doer, repo, "Home")) |
||||
|
||||
// Now need to show that the page has been added:
|
||||
gitRepo, err := git.OpenRepository(repo.WikiPath()) |
||||
assert.NoError(t, err) |
||||
defer gitRepo.Close() |
||||
masterTree, err := gitRepo.GetTree("master") |
||||
assert.NoError(t, err) |
||||
wikiPath := NameToFilename("Home") |
||||
_, err = masterTree.GetTreeEntryByPath(wikiPath) |
||||
assert.Error(t, err) |
||||
} |
||||
Loading…
Reference in new issue