aboutsummaryrefslogtreecommitdiff
path: root/internal/db/wiki.go
diff options
context:
space:
mode:
authorUnknwon <u@gogs.io>2019-10-24 01:51:46 -0700
committerGitHub <noreply@github.com>2019-10-24 01:51:46 -0700
commit01c8df01ec0608f1f25b2f1444adabb98fa5ee8a (patch)
treef8a7e5dd8d2a8c51e1ce2cabb9d33571a93314dd /internal/db/wiki.go
parent613139e7bef81d3573e7988a47eb6765f3de347a (diff)
internal: move packages under this directory (#5836)
* Rename pkg -> internal * Rename routes -> route * Move route -> internal/route * Rename models -> db * Move db -> internal/db * Fix route2 -> route * Move cmd -> internal/cmd * Bump version
Diffstat (limited to 'internal/db/wiki.go')
-rw-r--r--internal/db/wiki.go179
1 files changed, 179 insertions, 0 deletions
diff --git a/internal/db/wiki.go b/internal/db/wiki.go
new file mode 100644
index 00000000..a7e27418
--- /dev/null
+++ b/internal/db/wiki.go
@@ -0,0 +1,179 @@
+// Copyright 2015 The Gogs 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 db
+
+import (
+ "fmt"
+ "io/ioutil"
+ "net/url"
+ "os"
+ "path"
+ "path/filepath"
+ "strings"
+
+ "github.com/unknwon/com"
+
+ "github.com/gogs/git-module"
+
+ "gogs.io/gogs/internal/setting"
+ "gogs.io/gogs/internal/sync"
+)
+
+var wikiWorkingPool = sync.NewExclusivePool()
+
+// ToWikiPageURL formats a string to corresponding wiki URL name.
+func ToWikiPageURL(name string) string {
+ return url.QueryEscape(name)
+}
+
+// ToWikiPageName formats a URL back to corresponding wiki page name,
+// and removes leading characters './' to prevent changing files
+// that are not belong to wiki repository.
+func ToWikiPageName(urlString string) string {
+ name, _ := url.QueryUnescape(urlString)
+ return strings.Replace(strings.TrimLeft(path.Clean("/"+name), "/"), "/", " ", -1)
+}
+
+// WikiCloneLink returns clone URLs of repository wiki.
+func (repo *Repository) WikiCloneLink() (cl *CloneLink) {
+ return repo.cloneLink(true)
+}
+
+// WikiPath returns wiki data path by given user and repository name.
+func WikiPath(userName, repoName string) string {
+ return filepath.Join(UserPath(userName), strings.ToLower(repoName)+".wiki.git")
+}
+
+func (repo *Repository) WikiPath() string {
+ return WikiPath(repo.MustOwner().Name, repo.Name)
+}
+
+// HasWiki returns true if repository has wiki.
+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
+}
+
+func (repo *Repository) LocalWikiPath() string {
+ return path.Join(setting.AppDataPath, "tmp/local-wiki", com.ToStr(repo.ID))
+}
+
+// UpdateLocalWiki makes sure the local copy of repository wiki is up-to-date.
+func (repo *Repository) UpdateLocalWiki() error {
+ return UpdateLocalCopyBranch(repo.WikiPath(), repo.LocalWikiPath(), "master", true)
+}
+
+func discardLocalWikiChanges(localPath string) error {
+ return discardLocalRepoBranchChanges(localPath, "master")
+}
+
+// updateWikiPage adds new page to repository wiki.
+func (repo *Repository) updateWikiPage(doer *User, oldTitle, title, content, message string, isNew bool) (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)
+ }
+
+ localPath := repo.LocalWikiPath()
+ if err = discardLocalWikiChanges(localPath); err != nil {
+ return fmt.Errorf("discardLocalWikiChanges: %v", err)
+ } else if err = repo.UpdateLocalWiki(); err != nil {
+ return fmt.Errorf("UpdateLocalWiki: %v", err)
+ }
+
+ title = ToWikiPageName(title)
+ filename := path.Join(localPath, title+".md")
+
+ // If not a new file, show perform update not create.
+ if isNew {
+ if com.IsExist(filename) {
+ return ErrWikiAlreadyExist{filename}
+ }
+ } else {
+ os.Remove(path.Join(localPath, oldTitle+".md"))
+ }
+
+ // SECURITY: if new file is a symlink to non-exist critical file,
+ // attack content can be written to the target file (e.g. authorized_keys2)
+ // as a new page operation.
+ // So we want to make sure the symlink is removed before write anything.
+ // The new file we created will be in normal text format.
+ os.Remove(filename)
+
+ if err = ioutil.WriteFile(filename, []byte(content), 0666); err != nil {
+ return fmt.Errorf("WriteFile: %v", err)
+ }
+
+ if len(message) == 0 {
+ message = "Update page '" + title + "'"
+ }
+ if err = git.AddChanges(localPath, true); err != nil {
+ return fmt.Errorf("AddChanges: %v", err)
+ } else if err = git.CommitChanges(localPath, git.CommitChangesOptions{
+ Committer: doer.NewGitSig(),
+ Message: message,
+ }); err != nil {
+ return fmt.Errorf("CommitChanges: %v", err)
+ } else if err = git.Push(localPath, "origin", "master"); err != nil {
+ return fmt.Errorf("Push: %v", err)
+ }
+
+ return nil
+}
+
+func (repo *Repository) AddWikiPage(doer *User, title, content, message string) error {
+ return repo.updateWikiPage(doer, "", title, content, message, true)
+}
+
+func (repo *Repository) EditWikiPage(doer *User, oldTitle, title, content, message string) error {
+ return repo.updateWikiPage(doer, oldTitle, title, content, message, false)
+}
+
+func (repo *Repository) DeleteWikiPage(doer *User, title string) (err error) {
+ wikiWorkingPool.CheckIn(com.ToStr(repo.ID))
+ defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID))
+
+ localPath := repo.LocalWikiPath()
+ if err = discardLocalWikiChanges(localPath); err != nil {
+ return fmt.Errorf("discardLocalWikiChanges: %v", err)
+ } else if err = repo.UpdateLocalWiki(); err != nil {
+ return fmt.Errorf("UpdateLocalWiki: %v", err)
+ }
+
+ title = ToWikiPageName(title)
+ filename := path.Join(localPath, title+".md")
+ os.Remove(filename)
+
+ message := "Delete page '" + title + "'"
+
+ if err = git.AddChanges(localPath, true); err != nil {
+ return fmt.Errorf("AddChanges: %v", err)
+ } else if err = git.CommitChanges(localPath, git.CommitChangesOptions{
+ Committer: doer.NewGitSig(),
+ Message: message,
+ }); err != nil {
+ return fmt.Errorf("CommitChanges: %v", err)
+ } else if err = git.Push(localPath, "origin", "master"); err != nil {
+ return fmt.Errorf("Push: %v", err)
+ }
+
+ return nil
+}