2015-11-26 17:33:45 -05:00
|
|
|
// Copyright 2015 The Gogs Authors. All rights reserved.
|
2020-01-12 04:36:21 -05:00
|
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
2015-11-26 17:33:45 -05:00
|
|
|
// Use of this source code is governed by a MIT-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
2021-12-09 20:27:50 -05:00
|
|
|
package repo
|
2015-11-26 17:33:45 -05:00
|
|
|
|
|
|
|
import (
|
2022-08-24 21:31:57 -05:00
|
|
|
"fmt"
|
2015-11-26 17:33:45 -05:00
|
|
|
"path/filepath"
|
|
|
|
"strings"
|
2015-12-20 12:02:54 -05:00
|
|
|
|
2021-11-24 04:49:20 -05:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2020-11-27 21:42:08 -05:00
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
|
|
"code.gitea.io/gitea/modules/util"
|
2015-11-26 17:33:45 -05:00
|
|
|
)
|
|
|
|
|
2022-08-24 21:31:57 -05: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)
|
|
|
|
}
|
|
|
|
|
2022-10-18 00:50:37 -05:00
|
|
|
func (err ErrWikiAlreadyExist) Unwrap() error {
|
|
|
|
return util.ErrAlreadyExist
|
|
|
|
}
|
|
|
|
|
2022-08-24 21:31:57 -05:00
|
|
|
// 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)
|
|
|
|
}
|
|
|
|
|
2022-10-18 00:50:37 -05:00
|
|
|
func (err ErrWikiReservedName) Unwrap() error {
|
|
|
|
return util.ErrInvalidArgument
|
|
|
|
}
|
|
|
|
|
2022-08-24 21:31:57 -05:00
|
|
|
// 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)
|
|
|
|
}
|
|
|
|
|
2022-10-18 00:50:37 -05:00
|
|
|
func (err ErrWikiInvalidFileName) Unwrap() error {
|
|
|
|
return util.ErrInvalidArgument
|
|
|
|
}
|
|
|
|
|
2015-11-30 20:45:55 -05:00
|
|
|
// WikiCloneLink returns clone URLs of repository wiki.
|
2017-01-27 13:04:53 -05:00
|
|
|
func (repo *Repository) WikiCloneLink() *CloneLink {
|
2020-01-12 04:36:21 -05:00
|
|
|
return repo.cloneLink(true)
|
2015-11-30 20:45:55 -05:00
|
|
|
}
|
|
|
|
|
2015-11-26 17:33:45 -05:00
|
|
|
// WikiPath returns wiki data path by given user and repository name.
|
|
|
|
func WikiPath(userName, repoName string) string {
|
2021-11-24 04:49:20 -05:00
|
|
|
return filepath.Join(user_model.UserPath(userName), strings.ToLower(repoName)+".wiki.git")
|
2015-11-26 17:33:45 -05:00
|
|
|
}
|
|
|
|
|
2016-11-14 11:58:06 -05:00
|
|
|
// WikiPath returns wiki data path for given repository.
|
2015-11-26 17:33:45 -05:00
|
|
|
func (repo *Repository) WikiPath() string {
|
2020-01-12 04:36:21 -05:00
|
|
|
return WikiPath(repo.OwnerName, repo.Name)
|
2015-11-26 17:33:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// HasWiki returns true if repository has wiki.
|
|
|
|
func (repo *Repository) HasWiki() bool {
|
2020-11-27 21:42:08 -05:00
|
|
|
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 17:33:45 -05:00
|
|
|
}
|