gitea/models/wiki.go

224 lines
6.7 KiB
Go
Raw Normal View History

2015-11-26 23:33:45 +01:00
// 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 models
import (
"fmt"
2015-11-27 06:24:24 +01:00
"io/ioutil"
2016-03-04 19:32:17 +01:00
"net/url"
2015-11-27 07:50:38 +01:00
"os"
2015-11-27 06:24:24 +01:00
"path"
2015-11-26 23:33:45 +01:00
"path/filepath"
"strings"
2015-11-26 23:33:45 +01:00
"github.com/Unknwon/com"
"code.gitea.io/git"
2015-11-27 06:24:24 +01:00
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/sync"
2015-11-26 23:33:45 +01:00
)
var (
reservedWikiPaths = []string{"_pages", "_new", "_edit"}
wikiWorkingPool = sync.NewExclusivePool()
)
2015-11-27 06:24:24 +01:00
// ToWikiPageURL formats a string to corresponding wiki URL name.
func ToWikiPageURL(name string) string {
return url.QueryEscape(strings.Replace(name, " ", "-", -1))
2015-11-26 23:33:45 +01:00
}
// 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.
2015-12-20 21:13:12 +01:00
func ToWikiPageName(urlString string) string {
name, _ := url.QueryUnescape(strings.Replace(urlString, "-", " ", -1))
name = strings.Replace(name, "\t", " ", -1)
return strings.Replace(strings.TrimLeft(name, "./"), "/", " ", -1)
2015-11-27 06:24:24 +01:00
}
2015-12-01 02:45:55 +01:00
// WikiCloneLink returns clone URLs of repository wiki.
2017-01-27 19:04:53 +01:00
func (repo *Repository) WikiCloneLink() *CloneLink {
2015-12-01 02:45:55 +01:00
return repo.cloneLink(true)
}
2015-11-26 23:33:45 +01:00
// 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")
}
// WikiPath returns wiki data path for given repository.
2015-11-26 23:33:45 +01:00
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)
2015-11-26 23:33:45 +01:00
}
return nil
}
// LocalWikiPath returns the path to the local wiki repository (?).
2015-11-27 06:24:24 +01:00
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 {
// Don't pass branch name here because it fails to clone and
// checkout to a specific branch when wiki is an empty repository.
2017-03-20 14:36:19 +01:00
var branch = ""
if com.IsExist(repo.LocalWikiPath()) {
branch = "master"
}
return UpdateLocalCopyBranch(repo.WikiPath(), repo.LocalWikiPath(), branch)
2015-11-27 06:24:24 +01:00
}
2016-03-04 19:32:17 +01:00
func discardLocalWikiChanges(localPath string) error {
return discardLocalRepoBranchChanges(localPath, "master")
2016-03-04 19:32:17 +01:00
}
// pathAllowed checks if a wiki path is allowed
func pathAllowed(path string) error {
for i := range reservedWikiPaths {
if path == reservedWikiPaths[i] {
return ErrWikiAlreadyExist{path}
}
}
return nil
}
2015-11-27 07:50:38 +01:00
// updateWikiPage adds new page to repository wiki.
func (repo *Repository) updateWikiPage(doer *User, oldWikiPath, wikiPath, content, message string, isNew bool) (err error) {
if err = pathAllowed(wikiPath); err != nil {
return err
}
2015-11-27 06:24:24 +01:00
wikiWorkingPool.CheckIn(com.ToStr(repo.ID))
defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID))
2015-11-26 23:33:45 +01:00
if err = repo.InitWiki(); err != nil {
return fmt.Errorf("InitWiki: %v", err)
}
2015-11-27 06:24:24 +01:00
localPath := repo.LocalWikiPath()
2016-03-04 19:32:17 +01:00
if err = discardLocalWikiChanges(localPath); err != nil {
return fmt.Errorf("discardLocalWikiChanges: %v", err)
} else if err = repo.UpdateLocalWiki(); err != nil {
2015-11-27 06:24:24 +01:00
return fmt.Errorf("UpdateLocalWiki: %v", err)
}
title := ToWikiPageName(wikiPath)
filename := path.Join(localPath, wikiPath+".md")
2015-11-27 07:50:38 +01:00
// If not a new file, show perform update not create.
if isNew {
if com.IsExist(filename) {
return ErrWikiAlreadyExist{filename}
}
} else {
file := path.Join(localPath, oldWikiPath+".md")
2016-12-01 00:56:15 +01:00
if err := os.Remove(file); err != nil {
return fmt.Errorf("Failed to remove %s: %v", file, err)
2016-12-01 00:56:15 +01:00
}
2015-11-27 07:50:38 +01:00
}
// 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.
2016-12-01 00:56:15 +01:00
_ = os.Remove(filename)
2015-11-27 06:24:24 +01:00
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 {
2015-11-27 06:24:24 +01:00
return fmt.Errorf("CommitChanges: %v", err)
} else if err = git.Push(localPath, git.PushOptions{
Remote: "origin",
Branch: "master",
}); err != nil {
2015-11-27 06:24:24 +01:00
return fmt.Errorf("Push: %v", err)
}
2015-11-26 23:33:45 +01:00
return nil
}
2015-11-27 07:50:38 +01:00
// AddWikiPage adds a new wiki page with a given wikiPath.
func (repo *Repository) AddWikiPage(doer *User, wikiPath, content, message string) error {
return repo.updateWikiPage(doer, "", wikiPath, content, message, true)
2015-11-27 07:50:38 +01:00
}
// EditWikiPage updates a wiki page identified by its wikiPath,
// optionally also changing wikiPath.
func (repo *Repository) EditWikiPage(doer *User, oldWikiPath, wikiPath, content, message string) error {
return repo.updateWikiPage(doer, oldWikiPath, wikiPath, content, message, false)
2015-11-27 07:50:38 +01:00
}
// DeleteWikiPage deletes a wiki page identified by its wikiPath.
func (repo *Repository) DeleteWikiPage(doer *User, wikiPath string) (err error) {
wikiWorkingPool.CheckIn(com.ToStr(repo.ID))
defer wikiWorkingPool.CheckOut(com.ToStr(repo.ID))
localPath := repo.LocalWikiPath()
2016-03-04 19:32:17 +01:00
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)
}
filename := path.Join(localPath, wikiPath+".md")
2016-12-01 00:56:15 +01:00
if err := os.Remove(filename); err != nil {
return fmt.Errorf("Failed to remove %s: %v", filename, err)
2016-12-01 00:56:15 +01:00
}
title := ToWikiPageName(wikiPath)
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, git.PushOptions{
Remote: "origin",
Branch: "master",
}); err != nil {
return fmt.Errorf("Push: %v", err)
}
return nil
}