123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385 |
- // 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 (
- "context"
- "fmt"
- "net/url"
- "os"
- "strings"
-
- "code.gitea.io/gitea/models"
- admin_model "code.gitea.io/gitea/models/admin"
- repo_model "code.gitea.io/gitea/models/repo"
- "code.gitea.io/gitea/models/unit"
- user_model "code.gitea.io/gitea/models/user"
- "code.gitea.io/gitea/modules/git"
- "code.gitea.io/gitea/modules/log"
- repo_module "code.gitea.io/gitea/modules/repository"
- "code.gitea.io/gitea/modules/sync"
- "code.gitea.io/gitea/modules/util"
- asymkey_service "code.gitea.io/gitea/services/asymkey"
- )
-
- var (
- reservedWikiNames = []string{"_pages", "_new", "_edit", "raw"}
- // TODO: use clustered lock (unique queue? or *abuse* cache)
- 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.PathEscape(strings.ReplaceAll(name, " ", "-"))
- }
-
- // NormalizeWikiName normalizes a wiki name
- func NormalizeWikiName(name string) string {
- return strings.ReplaceAll(name, "-", " ")
- }
-
- // NameToFilename converts a wiki name to its corresponding filename.
- func NameToFilename(name string) string {
- name = strings.ReplaceAll(name, " ", "-")
- 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(ctx context.Context, repo *repo_model.Repository) error {
- if repo.HasWiki() {
- return nil
- }
-
- if err := git.InitRepository(ctx, repo.WikiPath(), true); err != nil {
- return fmt.Errorf("InitRepository: %v", err)
- } else if err = repo_module.CreateDelegateHooks(repo.WikiPath()); err != nil {
- return fmt.Errorf("createDelegateHooks: %v", err)
- } else if _, _, err = git.NewCommand(ctx, "symbolic-ref", "HEAD", git.BranchPrefix+"master").RunStdString(&git.RunOpts{Dir: repo.WikiPath()}); err != nil {
- return fmt.Errorf("unable to set default wiki branch to master: %v", err)
- }
- return nil
- }
-
- // prepareWikiFileName try to find a suitable file path with file name by the given raw wiki name.
- // return: existence, prepared file path with name, error
- func prepareWikiFileName(gitRepo *git.Repository, wikiName string) (bool, string, error) {
- unescaped := wikiName + ".md"
- escaped := NameToFilename(wikiName)
-
- // Look for both files
- filesInIndex, err := gitRepo.LsTree("master", unescaped, escaped)
- if err != nil {
- if strings.Contains(err.Error(), "Not a valid object name master") {
- return false, escaped, nil
- }
- log.Error("%v", err)
- return false, escaped, err
- }
-
- foundEscaped := false
- for _, filename := range filesInIndex {
- switch filename {
- case unescaped:
- // if we find the unescaped file return it
- return true, unescaped, nil
- case escaped:
- foundEscaped = true
- }
- }
-
- // If not return whether the escaped file exists, and the escaped filename to keep backwards compatibility.
- return foundEscaped, escaped, nil
- }
-
- // updateWikiPage adds a new page to the repository wiki.
- func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, oldWikiName, newWikiName, content, message string, isNew bool) (err error) {
- if err = nameAllowed(newWikiName); err != nil {
- return err
- }
- wikiWorkingPool.CheckIn(fmt.Sprint(repo.ID))
- defer wikiWorkingPool.CheckOut(fmt.Sprint(repo.ID))
-
- if err = InitWiki(ctx, repo); err != nil {
- return fmt.Errorf("InitWiki: %v", err)
- }
-
- hasMasterBranch := git.IsBranchExist(ctx, repo.WikiPath(), "master")
-
- basePath, err := repo_module.CreateTemporaryPath("update-wiki")
- if err != nil {
- return err
- }
- defer func() {
- if err := repo_module.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(ctx, 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(ctx, 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)
- }
- }
-
- isWikiExist, newWikiPath, err := prepareWikiFileName(gitRepo, newWikiName)
- if err != nil {
- return err
- }
-
- if isNew {
- if isWikiExist {
- return models.ErrWikiAlreadyExist{
- Title: newWikiPath,
- }
- }
- } else {
- // avoid check existence again if wiki name is not changed since gitRepo.LsFiles(...) is not free.
- isOldWikiExist := true
- oldWikiPath := newWikiPath
- if oldWikiName != newWikiName {
- isOldWikiExist, oldWikiPath, err = prepareWikiFileName(gitRepo, oldWikiName)
- if err != nil {
- return err
- }
- }
-
- if isOldWikiExist {
- 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,
- }
-
- committer := doer.NewGitSig()
-
- sign, signingKey, signer, _ := asymkey_service.SignWikiCommit(ctx, repo.WikiPath(), doer)
- if sign {
- commitTreeOpts.KeyID = signingKey
- if repo.GetTrustModel() == repo_model.CommitterTrustModel || repo.GetTrustModel() == repo_model.CollaboratorCommitterTrustModel {
- committer = signer
- }
- } else {
- commitTreeOpts.NoGPGSign = true
- }
- if hasMasterBranch {
- commitTreeOpts.Parents = []string{"HEAD"}
- }
-
- commitHash, err := gitRepo.CommitTree(doer.NewGitSig(), committer, tree, commitTreeOpts)
- if err != nil {
- log.Error("%v", err)
- return err
- }
-
- if err := git.Push(gitRepo.Ctx, basePath, git.PushOptions{
- Remote: "origin",
- Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, "master"),
- Env: repo_module.FullPushingEnvironment(
- doer,
- doer,
- repo,
- repo.Name+".wiki",
- 0,
- ),
- }); err != nil {
- log.Error("%v", err)
- if git.IsErrPushOutOfDate(err) || git.IsErrPushRejected(err) {
- return err
- }
- return fmt.Errorf("Push: %v", err)
- }
-
- return nil
- }
-
- // AddWikiPage adds a new wiki page with a given wikiPath.
- func AddWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName, content, message string) error {
- return updateWikiPage(ctx, doer, repo, "", wikiName, content, message, true)
- }
-
- // EditWikiPage updates a wiki page identified by its wikiPath,
- // optionally also changing wikiPath.
- func EditWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, oldWikiName, newWikiName, content, message string) error {
- return updateWikiPage(ctx, doer, repo, oldWikiName, newWikiName, content, message, false)
- }
-
- // DeleteWikiPage deletes a wiki page identified by its path.
- func DeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, wikiName string) (err error) {
- wikiWorkingPool.CheckIn(fmt.Sprint(repo.ID))
- defer wikiWorkingPool.CheckOut(fmt.Sprint(repo.ID))
-
- if err = InitWiki(ctx, repo); err != nil {
- return fmt.Errorf("InitWiki: %v", err)
- }
-
- basePath, err := repo_module.CreateTemporaryPath("update-wiki")
- if err != nil {
- return err
- }
- defer func() {
- if err := repo_module.RemoveTemporaryPath(basePath); err != nil {
- log.Error("Merge: RemoveTemporaryPath: %s", err)
- }
- }()
-
- if err := git.Clone(ctx, 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(ctx, 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)
- }
-
- found, wikiPath, err := prepareWikiFileName(gitRepo, wikiName)
- if err != nil {
- return err
- }
- 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"},
- }
-
- committer := doer.NewGitSig()
-
- sign, signingKey, signer, _ := asymkey_service.SignWikiCommit(ctx, repo.WikiPath(), doer)
- if sign {
- commitTreeOpts.KeyID = signingKey
- if repo.GetTrustModel() == repo_model.CommitterTrustModel || repo.GetTrustModel() == repo_model.CollaboratorCommitterTrustModel {
- committer = signer
- }
- } else {
- commitTreeOpts.NoGPGSign = true
- }
-
- commitHash, err := gitRepo.CommitTree(doer.NewGitSig(), committer, tree, commitTreeOpts)
- if err != nil {
- return err
- }
-
- if err := git.Push(gitRepo.Ctx, basePath, git.PushOptions{
- Remote: "origin",
- Branch: fmt.Sprintf("%s:%s%s", commitHash.String(), git.BranchPrefix, "master"),
- Env: repo_module.PushingEnvironment(doer, repo),
- }); err != nil {
- if git.IsErrPushOutOfDate(err) || git.IsErrPushRejected(err) {
- return err
- }
- return fmt.Errorf("Push: %v", err)
- }
-
- return nil
- }
-
- // DeleteWiki removes the actual and local copy of repository wiki.
- func DeleteWiki(ctx context.Context, repo *repo_model.Repository) error {
- if err := repo_model.UpdateRepositoryUnits(repo, nil, []unit.Type{unit.TypeWiki}); err != nil {
- return err
- }
-
- admin_model.RemoveAllWithNotice(ctx, "Delete repository wiki", repo.WikiPath())
- return nil
- }
|