summaryrefslogtreecommitdiffstats
path: root/modules
diff options
context:
space:
mode:
authorqwerty287 <80460567+qwerty287@users.noreply.github.com>2021-10-25 05:43:40 +0200
committerGitHub <noreply@github.com>2021-10-25 11:43:40 +0800
commit3676fafdacaef7ef0a6b72be99a342f91c8d5e5d (patch)
treefcf5a5155bdb1d9b1329e977ea3094fbca7577f2 /modules
parent843bc9deeb67cba2ac71165fcd0bdcce835cfab5 (diff)
downloadgitea-3676fafdacaef7ef0a6b72be99a342f91c8d5e5d.tar.gz
gitea-3676fafdacaef7ef0a6b72be99a342f91c8d5e5d.zip
Add API to get/edit wiki (#17278)
* Add API to get/edit wiki * Add swagger docs, various improvements * fmt * Fix lint and rm comment * Add page parameter * Add pagination to pages * Add tests * fmt * Update func names * Update error handling * Update type name * Fix lint * Don't delete Home * Update func name * Update routers/api/v1/repo/wiki.go Co-authored-by: delvh <dev.lh@web.de> * Remove unnecessary check * Fix lint * Use English strings * Update integrations/api_wiki_test.go Co-authored-by: delvh <dev.lh@web.de> * Update func and test names * Remove unsed check and avoid duplicated error reports * Improve error handling * Return after error * Document 404 error * Update swagger * Fix lint * Apply suggestions from code review Co-authored-by: delvh <dev.lh@web.de> * Document file encoding * fmt * Apply suggestions * Use convert * Fix integration test * simplify permissions * unify duplicate key Title/Name * improve types & return UTC timestamps * improve types pt.2 - add WikiPageMetaData.LastCommit - add WikiPageMetaData.HTMLURL - replace WikiPageMetaData.Updated with .LastCommit.Committer.Created also delete convert.ToWikiPage(), as it received too many arguments and only had one callsite anyway. sorry for bad advice earlier 🙃 * WikiPage.Content is base64 encoded * simplify error handling in wikiContentsByName() * update swagger * fix & DRY findWikiRepoCommit() error handling ListWikiPages() previously wrote error twice when repo wiki didn't exist * rename Content -> ContentBase64 * Fix test * Fix tests * Update var name * suburl -> sub_url Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: Norwin <git@nroo.de> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Diffstat (limited to 'modules')
-rw-r--r--modules/convert/wiki.go60
-rw-r--r--modules/structs/repo_wiki.go47
2 files changed, 107 insertions, 0 deletions
diff --git a/modules/convert/wiki.go b/modules/convert/wiki.go
new file mode 100644
index 0000000000..9563f1544e
--- /dev/null
+++ b/modules/convert/wiki.go
@@ -0,0 +1,60 @@
+// Copyright 2021 The Gitea 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 convert
+
+import (
+ "time"
+
+ "code.gitea.io/gitea/models"
+ "code.gitea.io/gitea/modules/git"
+ api "code.gitea.io/gitea/modules/structs"
+ "code.gitea.io/gitea/modules/util"
+ wiki_service "code.gitea.io/gitea/services/wiki"
+)
+
+// ToWikiCommit convert a git commit into a WikiCommit
+func ToWikiCommit(commit *git.Commit) *api.WikiCommit {
+ return &api.WikiCommit{
+ ID: commit.ID.String(),
+ Author: &api.CommitUser{
+ Identity: api.Identity{
+ Name: commit.Author.Name,
+ Email: commit.Author.Email,
+ },
+ Date: commit.Author.When.UTC().Format(time.RFC3339),
+ },
+ Committer: &api.CommitUser{
+ Identity: api.Identity{
+ Name: commit.Committer.Name,
+ Email: commit.Committer.Email,
+ },
+ Date: commit.Committer.When.UTC().Format(time.RFC3339),
+ },
+ Message: commit.CommitMessage,
+ }
+}
+
+// ToWikiCommitList convert a list of git commits into a WikiCommitList
+func ToWikiCommitList(commits []*git.Commit, total int64) *api.WikiCommitList {
+ result := make([]*api.WikiCommit, len(commits))
+ for i := range commits {
+ result[i] = ToWikiCommit(commits[i])
+ }
+ return &api.WikiCommitList{
+ WikiCommits: result,
+ Count: total,
+ }
+}
+
+// ToWikiPageMetaData converts meta information to a WikiPageMetaData
+func ToWikiPageMetaData(title string, lastCommit *git.Commit, repo *models.Repository) *api.WikiPageMetaData {
+ suburl := wiki_service.NameToSubURL(title)
+ return &api.WikiPageMetaData{
+ Title: title,
+ HTMLURL: util.URLJoin(repo.HTMLURL(), "wiki", suburl),
+ SubURL: suburl,
+ LastCommit: ToWikiCommit(lastCommit),
+ }
+}
diff --git a/modules/structs/repo_wiki.go b/modules/structs/repo_wiki.go
new file mode 100644
index 0000000000..09e21387df
--- /dev/null
+++ b/modules/structs/repo_wiki.go
@@ -0,0 +1,47 @@
+// Copyright 2021 The Gitea 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 structs
+
+// WikiCommit page commit/revision
+type WikiCommit struct {
+ ID string `json:"sha"`
+ Author *CommitUser `json:"author"`
+ Committer *CommitUser `json:"commiter"`
+ Message string `json:"message"`
+}
+
+// WikiPage a wiki page
+type WikiPage struct {
+ *WikiPageMetaData
+ // Page content, base64 encoded
+ ContentBase64 string `json:"content_base64"`
+ CommitCount int64 `json:"commit_count"`
+ Sidebar string `json:"sidebar"`
+ Footer string `json:"footer"`
+}
+
+// WikiPageMetaData wiki page meta information
+type WikiPageMetaData struct {
+ Title string `json:"title"`
+ HTMLURL string `json:"html_url"`
+ SubURL string `json:"sub_url"`
+ LastCommit *WikiCommit `json:"last_commit"`
+}
+
+// CreateWikiPageOptions form for creating wiki
+type CreateWikiPageOptions struct {
+ // page title. leave empty to keep unchanged
+ Title string `json:"title"`
+ // content must be base64 encoded
+ ContentBase64 string `json:"content_base64"`
+ // optional commit message summarizing the change
+ Message string `json:"message"`
+}
+
+// WikiCommitList commit/revision list
+type WikiCommitList struct {
+ WikiCommits []*WikiCommit `json:"commits"`
+ Count int64 `json:"count"`
+}