diff options
author | Lunny Xiao <xiaolunwen@gmail.com> | 2020-01-08 02:27:36 +0800 |
---|---|---|
committer | zeripath <art27@cantab.net> | 2020-01-07 18:27:36 +0000 |
commit | b9309e52f0b08a554107d888029d62f9b7904ca0 (patch) | |
tree | d8eb24e40b5a65c16a3b2447bf0bef0e9e865a6a /models | |
parent | e5d8e2d10c6798e57ac855f71b025b087b664799 (diff) | |
download | gitea-b9309e52f0b08a554107d888029d62f9b7904ca0.tar.gz gitea-b9309e52f0b08a554107d888029d62f9b7904ca0.zip |
Move wiki related funtions from models to services/wiki (#9355)
* Move wiki related funtions from models to services/wiki
Diffstat (limited to 'models')
-rw-r--r-- | models/wiki.go | 313 | ||||
-rw-r--r-- | models/wiki_test.go | 193 |
2 files changed, 0 insertions, 506 deletions
diff --git a/models/wiki.go b/models/wiki.go index 8b63716afa..32a0cc1627 100644 --- a/models/wiki.go +++ b/models/wiki.go @@ -5,53 +5,12 @@ package models import ( - "fmt" - "net/url" - "os" "path/filepath" "strings" - "code.gitea.io/gitea/modules/git" - "code.gitea.io/gitea/modules/log" - "code.gitea.io/gitea/modules/sync" - "github.com/unknwon/com" ) -var ( - reservedWikiNames = []string{"_pages", "_new", "_edit", "raw"} - wikiWorkingPool = sync.NewExclusivePool() -) - -// NormalizeWikiName normalizes a wiki name -func NormalizeWikiName(name string) string { - return strings.Replace(name, "-", " ", -1) -} - -// WikiNameToSubURL converts a wiki name to its corresponding sub-URL. -func WikiNameToSubURL(name string) string { - return url.QueryEscape(strings.Replace(name, " ", "-", -1)) -} - -// WikiNameToFilename converts a wiki name to its corresponding filename. -func WikiNameToFilename(name string) string { - name = strings.Replace(name, " ", "-", -1) - return url.QueryEscape(name) + ".md" -} - -// WikiFilenameToName converts a wiki filename to its corresponding page name. -func WikiFilenameToName(filename string) (string, error) { - if !strings.HasSuffix(filename, ".md") { - return "", ErrWikiInvalidFileName{filename} - } - basename := filename[:len(filename)-3] - unescaped, err := url.QueryUnescape(basename) - if err != nil { - return "", err - } - return NormalizeWikiName(unescaped), nil -} - // WikiCloneLink returns clone URLs of repository wiki. func (repo *Repository) WikiCloneLink() *CloneLink { return repo.cloneLink(x, true) @@ -71,275 +30,3 @@ func (repo *Repository) WikiPath() string { func (repo *Repository) HasWiki() bool { return com.IsDir(repo.WikiPath()) } - -// InitWiki initializes a wiki for repository, -// it does nothing when repository already has wiki. -func (repo *Repository) InitWiki() error { - if repo.HasWiki() { - return nil - } - - if err := git.InitRepository(repo.WikiPath(), true); err != nil { - return fmt.Errorf("InitRepository: %v", err) - } else if err = createDelegateHooks(repo.WikiPath()); err != nil { - return fmt.Errorf("createDelegateHooks: %v", err) - } - return nil -} - -// nameAllowed checks if a wiki name is allowed -func nameAllowed(name string) error { - for _, reservedName := range reservedWikiNames { - if name == reservedName { - return ErrWikiReservedName{name} - } - } - return nil -} - -// updateWikiPage adds a new page to the repository wiki. -func (repo *Repository) updateWikiPage(doer *User, 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 = repo.InitWiki(); err != nil { - return fmt.Errorf("InitWiki: %v", err) - } - - hasMasterBranch := git.IsBranchExist(repo.WikiPath(), "master") - - basePath, err := CreateTemporaryPath("update-wiki") - if err != nil { - return err - } - defer func() { - if err := 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 := WikiNameToFilename(newWikiName) - if isNew { - filesInIndex, err := gitRepo.LsFiles(newWikiPath) - if err != nil { - log.Error("%v", err) - return err - } - for _, file := range filesInIndex { - if file == newWikiPath { - return ErrWikiAlreadyExist{newWikiPath} - } - } - } else { - oldWikiPath := WikiNameToFilename(oldWikiName) - filesInIndex, err := gitRepo.LsFiles(oldWikiPath) - if err != nil { - log.Error("%v", err) - return err - } - found := false - for _, file := range filesInIndex { - if file == oldWikiPath { - found = true - break - } - } - if found { - 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: 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 (repo *Repository) AddWikiPage(doer *User, wikiName, content, message string) error { - return repo.updateWikiPage(doer, "", wikiName, content, message, true) -} - -// EditWikiPage updates a wiki page identified by its wikiPath, -// optionally also changing wikiPath. -func (repo *Repository) EditWikiPage(doer *User, oldWikiName, newWikiName, content, message string) error { - return repo.updateWikiPage(doer, oldWikiName, newWikiName, content, message, false) -} - -// DeleteWikiPage deletes a wiki page identified by its path. -func (repo *Repository) DeleteWikiPage(doer *User, wikiName string) (err error) { - wikiWorkingPool.CheckIn(com.ToStr(repo.ID)) - defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID)) - - if err = repo.InitWiki(); err != nil { - return fmt.Errorf("InitWiki: %v", err) - } - - basePath, err := CreateTemporaryPath("update-wiki") - if err != nil { - return err - } - defer func() { - if err := 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 := WikiNameToFilename(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: PushingEnvironment(doer, repo), - }); err != nil { - return fmt.Errorf("Push: %v", err) - } - - return nil -} diff --git a/models/wiki_test.go b/models/wiki_test.go index 37c0a86635..244c4f2553 100644 --- a/models/wiki_test.go +++ b/models/wiki_test.go @@ -8,100 +8,11 @@ import ( "path/filepath" "testing" - "code.gitea.io/gitea/modules/git" "code.gitea.io/gitea/modules/setting" "github.com/stretchr/testify/assert" ) -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, WikiNameToFilename(test.WikiName)) - } -} - -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, WikiNameToSubURL(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 := WikiFilenameToName(test.Filename) - assert.NoError(t, err) - assert.Equal(t, test.Expected, name) - } - for _, badFilename := range []string{ - "nofileextension", - "wrongfileextension.txt", - } { - _, err := WikiFilenameToName(badFilename) - assert.Error(t, err) - assert.True(t, IsErrWikiInvalidFileName(err)) - } - _, err := WikiFilenameToName("badescaping%%.md") - assert.Error(t, err) - assert.False(t, 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 := WikiNameToFilename(name) - resultName, err := WikiFilenameToName(filename) - assert.NoError(t, err) - assert.Equal(t, NormalizeWikiName(name), resultName) - } -} - func TestRepository_WikiCloneLink(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) @@ -131,107 +42,3 @@ func TestRepository_HasWiki(t *testing.T) { repo2 := AssertExistsAndLoadBean(t, &Repository{ID: 2}).(*Repository) assert.False(t, repo2.HasWiki()) } - -func TestRepository_InitWiki(t *testing.T) { - PrepareTestEnv(t) - // repo1 already has a wiki - repo1 := AssertExistsAndLoadBean(t, &Repository{ID: 1}).(*Repository) - assert.NoError(t, repo1.InitWiki()) - - // repo2 does not already have a wiki - repo2 := AssertExistsAndLoadBean(t, &Repository{ID: 2}).(*Repository) - assert.NoError(t, repo2.InitWiki()) - assert.True(t, repo2.HasWiki()) -} - -func TestRepository_AddWikiPage(t *testing.T) { - assert.NoError(t, PrepareTestDatabase()) - const wikiContent = "This is the wiki content" - const commitMsg = "Commit message" - repo := AssertExistsAndLoadBean(t, &Repository{ID: 1}).(*Repository) - doer := AssertExistsAndLoadBean(t, &User{ID: 2}).(*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, repo.AddWikiPage(doer, 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 := WikiNameToFilename(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 := repo.AddWikiPage(doer, "Home", wikiContent, commitMsg) - assert.Error(t, err) - assert.True(t, IsErrWikiAlreadyExist(err)) - }) - - t.Run("check wiki reserved name", func(t *testing.T) { - t.Parallel() - // test for reserved wiki name - err := repo.AddWikiPage(doer, "_edit", wikiContent, commitMsg) - assert.Error(t, err) - assert.True(t, IsErrWikiReservedName(err)) - }) -} - -func TestRepository_EditWikiPage(t *testing.T) { - const newWikiContent = "This is the new content" - const commitMsg = "Commit message" - repo := AssertExistsAndLoadBean(t, &Repository{ID: 1}).(*Repository) - doer := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) - for _, newWikiName := range []string{ - "Home", // same name as before - "New home", - "New/name/with/slashes", - } { - PrepareTestEnv(t) - assert.NoError(t, repo.EditWikiPage(doer, "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 := WikiNameToFilename(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) { - PrepareTestEnv(t) - repo := AssertExistsAndLoadBean(t, &Repository{ID: 1}).(*Repository) - doer := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) - assert.NoError(t, repo.DeleteWikiPage(doer, "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 := WikiNameToFilename("Home") - _, err = masterTree.GetTreeEntryByPath(wikiPath) - assert.Error(t, err) -} |