wiki.go 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. // Copyright 2015 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package models
  5. import (
  6. "fmt"
  7. "io/ioutil"
  8. "net/url"
  9. "os"
  10. "path"
  11. "path/filepath"
  12. "strings"
  13. "github.com/Unknwon/com"
  14. "github.com/gogs/git-module"
  15. "github.com/gogs/gogs/pkg/setting"
  16. "github.com/gogs/gogs/pkg/sync"
  17. )
  18. var wikiWorkingPool = sync.NewExclusivePool()
  19. // ToWikiPageURL formats a string to corresponding wiki URL name.
  20. func ToWikiPageURL(name string) string {
  21. return url.QueryEscape(name)
  22. }
  23. // ToWikiPageName formats a URL back to corresponding wiki page name,
  24. // and removes leading characters './' to prevent changing files
  25. // that are not belong to wiki repository.
  26. func ToWikiPageName(urlString string) string {
  27. name, _ := url.QueryUnescape(urlString)
  28. return strings.Replace(strings.TrimLeft(path.Clean("/"+name), "/"), "/", " ", -1)
  29. }
  30. // WikiCloneLink returns clone URLs of repository wiki.
  31. func (repo *Repository) WikiCloneLink() (cl *CloneLink) {
  32. return repo.cloneLink(true)
  33. }
  34. // WikiPath returns wiki data path by given user and repository name.
  35. func WikiPath(userName, repoName string) string {
  36. return filepath.Join(UserPath(userName), strings.ToLower(repoName)+".wiki.git")
  37. }
  38. func (repo *Repository) WikiPath() string {
  39. return WikiPath(repo.MustOwner().Name, repo.Name)
  40. }
  41. // HasWiki returns true if repository has wiki.
  42. func (repo *Repository) HasWiki() bool {
  43. return com.IsDir(repo.WikiPath())
  44. }
  45. // InitWiki initializes a wiki for repository,
  46. // it does nothing when repository already has wiki.
  47. func (repo *Repository) InitWiki() error {
  48. if repo.HasWiki() {
  49. return nil
  50. }
  51. if err := git.InitRepository(repo.WikiPath(), true); err != nil {
  52. return fmt.Errorf("InitRepository: %v", err)
  53. } else if err = createDelegateHooks(repo.WikiPath()); err != nil {
  54. return fmt.Errorf("createDelegateHooks: %v", err)
  55. }
  56. return nil
  57. }
  58. func (repo *Repository) LocalWikiPath() string {
  59. return path.Join(setting.AppDataPath, "tmp/local-wiki", com.ToStr(repo.ID))
  60. }
  61. // UpdateLocalWiki makes sure the local copy of repository wiki is up-to-date.
  62. func (repo *Repository) UpdateLocalWiki() error {
  63. return UpdateLocalCopyBranch(repo.WikiPath(), repo.LocalWikiPath(), "master", true)
  64. }
  65. func discardLocalWikiChanges(localPath string) error {
  66. return discardLocalRepoBranchChanges(localPath, "master")
  67. }
  68. // updateWikiPage adds new page to repository wiki.
  69. func (repo *Repository) updateWikiPage(doer *User, oldTitle, title, content, message string, isNew bool) (err error) {
  70. wikiWorkingPool.CheckIn(com.ToStr(repo.ID))
  71. defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID))
  72. if err = repo.InitWiki(); err != nil {
  73. return fmt.Errorf("InitWiki: %v", err)
  74. }
  75. localPath := repo.LocalWikiPath()
  76. if err = discardLocalWikiChanges(localPath); err != nil {
  77. return fmt.Errorf("discardLocalWikiChanges: %v", err)
  78. } else if err = repo.UpdateLocalWiki(); err != nil {
  79. return fmt.Errorf("UpdateLocalWiki: %v", err)
  80. }
  81. title = ToWikiPageName(title)
  82. filename := path.Join(localPath, title+".md")
  83. // If not a new file, show perform update not create.
  84. if isNew {
  85. if com.IsExist(filename) {
  86. return ErrWikiAlreadyExist{filename}
  87. }
  88. } else {
  89. os.Remove(path.Join(localPath, oldTitle+".md"))
  90. }
  91. // SECURITY: if new file is a symlink to non-exist critical file,
  92. // attack content can be written to the target file (e.g. authorized_keys2)
  93. // as a new page operation.
  94. // So we want to make sure the symlink is removed before write anything.
  95. // The new file we created will be in normal text format.
  96. os.Remove(filename)
  97. if err = ioutil.WriteFile(filename, []byte(content), 0666); err != nil {
  98. return fmt.Errorf("WriteFile: %v", err)
  99. }
  100. if len(message) == 0 {
  101. message = "Update page '" + title + "'"
  102. }
  103. if err = git.AddChanges(localPath, true); err != nil {
  104. return fmt.Errorf("AddChanges: %v", err)
  105. } else if err = git.CommitChanges(localPath, git.CommitChangesOptions{
  106. Committer: doer.NewGitSig(),
  107. Message: message,
  108. }); err != nil {
  109. return fmt.Errorf("CommitChanges: %v", err)
  110. } else if err = git.Push(localPath, "origin", "master"); err != nil {
  111. return fmt.Errorf("Push: %v", err)
  112. }
  113. return nil
  114. }
  115. func (repo *Repository) AddWikiPage(doer *User, title, content, message string) error {
  116. return repo.updateWikiPage(doer, "", title, content, message, true)
  117. }
  118. func (repo *Repository) EditWikiPage(doer *User, oldTitle, title, content, message string) error {
  119. return repo.updateWikiPage(doer, oldTitle, title, content, message, false)
  120. }
  121. func (repo *Repository) DeleteWikiPage(doer *User, title string) (err error) {
  122. wikiWorkingPool.CheckIn(com.ToStr(repo.ID))
  123. defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID))
  124. localPath := repo.LocalWikiPath()
  125. if err = discardLocalWikiChanges(localPath); err != nil {
  126. return fmt.Errorf("discardLocalWikiChanges: %v", err)
  127. } else if err = repo.UpdateLocalWiki(); err != nil {
  128. return fmt.Errorf("UpdateLocalWiki: %v", err)
  129. }
  130. title = ToWikiPageName(title)
  131. filename := path.Join(localPath, title+".md")
  132. os.Remove(filename)
  133. message := "Delete page '" + title + "'"
  134. if err = git.AddChanges(localPath, true); err != nil {
  135. return fmt.Errorf("AddChanges: %v", err)
  136. } else if err = git.CommitChanges(localPath, git.CommitChangesOptions{
  137. Committer: doer.NewGitSig(),
  138. Message: message,
  139. }); err != nil {
  140. return fmt.Errorf("CommitChanges: %v", err)
  141. } else if err = git.Push(localPath, "origin", "master"); err != nil {
  142. return fmt.Errorf("Push: %v", err)
  143. }
  144. return nil
  145. }