forgejo/models/repo/wiki.go

98 lines
2.5 KiB
Go
Raw Normal View History

2015-11-26 22:33:45 +00:00
// Copyright 2015 The Gogs Authors. All rights reserved.
// Copyright 2020 The Gitea Authors. All rights reserved.
2015-11-26 22:33:45 +00:00
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package repo
2015-11-26 22:33:45 +00:00
import (
"fmt"
2015-11-26 22:33:45 +00:00
"path/filepath"
"strings"
user_model "code.gitea.io/gitea/models/user"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/util"
2015-11-26 22:33:45 +00:00
)
// ErrWikiAlreadyExist represents a "WikiAlreadyExist" kind of error.
type ErrWikiAlreadyExist struct {
Title string
}
// IsErrWikiAlreadyExist checks if an error is an ErrWikiAlreadyExist.
func IsErrWikiAlreadyExist(err error) bool {
_, ok := err.(ErrWikiAlreadyExist)
return ok
}
func (err ErrWikiAlreadyExist) Error() string {
return fmt.Sprintf("wiki page already exists [title: %s]", err.Title)
}
func (err ErrWikiAlreadyExist) Unwrap() error {
return util.ErrAlreadyExist
}
// ErrWikiReservedName represents a reserved name error.
type ErrWikiReservedName struct {
Title string
}
// IsErrWikiReservedName checks if an error is an ErrWikiReservedName.
func IsErrWikiReservedName(err error) bool {
_, ok := err.(ErrWikiReservedName)
return ok
}
func (err ErrWikiReservedName) Error() string {
return fmt.Sprintf("wiki title is reserved: %s", err.Title)
}
func (err ErrWikiReservedName) Unwrap() error {
return util.ErrInvalidArgument
}
// ErrWikiInvalidFileName represents an invalid wiki file name.
type ErrWikiInvalidFileName struct {
FileName string
}
// IsErrWikiInvalidFileName checks if an error is an ErrWikiInvalidFileName.
func IsErrWikiInvalidFileName(err error) bool {
_, ok := err.(ErrWikiInvalidFileName)
return ok
}
func (err ErrWikiInvalidFileName) Error() string {
return fmt.Sprintf("Invalid wiki filename: %s", err.FileName)
}
func (err ErrWikiInvalidFileName) Unwrap() error {
return util.ErrInvalidArgument
}
2015-12-01 01:45:55 +00:00
// WikiCloneLink returns clone URLs of repository wiki.
2017-01-27 18:04:53 +00:00
func (repo *Repository) WikiCloneLink() *CloneLink {
return repo.cloneLink(true)
2015-12-01 01:45:55 +00:00
}
2015-11-26 22:33:45 +00:00
// WikiPath returns wiki data path by given user and repository name.
func WikiPath(userName, repoName string) string {
return filepath.Join(user_model.UserPath(userName), strings.ToLower(repoName)+".wiki.git")
2015-11-26 22:33:45 +00:00
}
// WikiPath returns wiki data path for given repository.
2015-11-26 22:33:45 +00:00
func (repo *Repository) WikiPath() string {
return WikiPath(repo.OwnerName, repo.Name)
2015-11-26 22:33:45 +00:00
}
// HasWiki returns true if repository has wiki.
func (repo *Repository) HasWiki() bool {
isDir, err := util.IsDir(repo.WikiPath())
if err != nil {
log.Error("Unable to check if %s is a directory: %v", repo.WikiPath(), err)
}
return isDir
2015-11-26 22:33:45 +00:00
}