// 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" "net/url" "os" "path" "path/filepath" "strings" "time" "github.com/unknwon/com" "github.com/gogs/git-module" "gogs.io/gogs/internal/conf" "gogs.io/gogs/internal/pathutil" "gogs.io/gogs/internal/repoutil" "gogs.io/gogs/internal/sync" ) var wikiWorkingPool = sync.NewExclusivePool() // WikiBranch returns the branch name used by the wiki repository. It checks if // "main" branch exists, otherwise falls back to "master". func WikiBranch(repoPath string) string { if git.RepoHasBranch(repoPath, "main") { return "main" } return "master" } // 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. It enforces // single-level hierarchy by replacing all "/" with spaces. func ToWikiPageName(urlString string) string { name, _ := url.QueryUnescape(urlString) name = pathutil.Clean(name) return strings.ReplaceAll(name, "/", " ") } // WikiCloneLink returns clone URLs of repository wiki. // // Deprecated: Use repoutil.NewCloneLink instead. func (repo *Repository) WikiCloneLink() (cl *repoutil.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(repoutil.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.Init(repo.WikiPath(), git.InitOptions{Bare: true}); err != nil { return fmt.Errorf("init repository: %v", err) } else if err = createDelegateHooks(repo.WikiPath()); err != nil { return fmt.Errorf("createDelegateHooks: %v", err) } return nil } func (repo *Repository) LocalWikiPath() string { return filepath.Join(conf.Server.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 { wikiPath := repo.WikiPath() return UpdateLocalCopyBranch(wikiPath, repo.LocalWikiPath(), WikiBranch(wikiPath), true) } func discardLocalWikiChanges(localPath string) error { return discardLocalRepoBranchChanges(localPath, WikiBranch(localPath)) } // updateWikiPage adds new page to repository wiki. func (repo *Repository) updateWikiPage(doer *User, oldTitle, title, content, message string, isNew bool) 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 { oldTitle = ToWikiPageName(oldTitle) _ = 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 := os.WriteFile(filename, []byte(content), 0o666); err != nil { return fmt.Errorf("WriteFile: %v", err) } if message == "" { message = "Update page '" + title + "'" } if err := git.Add(localPath, git.AddOptions{All: true}); err != nil { return fmt.Errorf("add all changes: %v", err) } err := git.CreateCommit( localPath, &git.Signature{ Name: doer.DisplayName(), Email: doer.Email, When: time.Now(), }, message, ) if err != nil { return fmt.Errorf("commit changes: %v", err) } else if err = git.Push(localPath, "origin", WikiBranch(localPath)); 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) _ = os.Remove(path.Join(localPath, title+".md")) message := "Delete page '" + title + "'" if err = git.Add(localPath, git.AddOptions{All: true}); err != nil { return fmt.Errorf("add all changes: %v", err) } err = git.CreateCommit( localPath, &git.Signature{ Name: doer.DisplayName(), Email: doer.Email, When: time.Now(), }, message, ) if err != nil { return fmt.Errorf("commit changes: %v", err) } else if err = git.Push(localPath, "origin", WikiBranch(localPath)); err != nil { return fmt.Errorf("push: %v", err) } return nil }