Add API to get/edit wiki

integrations/api_wiki_test.go

@@ -5,6 +5,7 @@
 package integrations
 
 import (
+	"encoding/base64"
 	"fmt"
 	"net/http"
 	"testing"
@@ -29,33 +30,34 @@ func TestAPIGetWikiPage(t *testing.T) {
 
 	assert.Equal(t, &api.WikiPage{
 		WikiPageMetaData: &api.WikiPageMetaData{
-			Name:    "Home",
+			Title:   "Home",
+			HTMLURL: "http://localhost:3003/user2/repo1/wiki/Home",
 			SubURL:  "Home",
-			Updated: "2017-11-26T20:31:18-08:00",
-		},
-		Title:       "",
-		Content:     "# Home page\n\nThis is the home page!\n",
-		CommitCount: 1,
-		LastCommit: &api.WikiCommit{
-			ID: "2c54faec6c45d31c1abfaecdab471eac6633738a",
-			Author: &api.CommitUser{
-				Identity: api.Identity{
-					Name:  "Ethan Koenig",
-					Email: "[email protected]",
+			LastCommit: &api.WikiCommit{
+				ID: "2c54faec6c45d31c1abfaecdab471eac6633738a",
+				Author: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Ethan Koenig",
+						Email: "[email protected]",
+					},
+					Date: "2017-11-27T04:31:18Z",
 				},
-				Date: "2017-11-26T20:31:18-08:00",
-			},
-			Committer: &api.CommitUser{
-				Identity: api.Identity{
-					Name:  "Ethan Koenig",
-					Email: "[email protected]",
+				Committer: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Ethan Koenig",
+						Email: "[email protected]",
+					},
+					Date: "2017-11-27T04:31:18Z",
 				},
-				Date: "2017-11-26T20:31:18-08:00",
+				Message: "Add Home.md\n",
 			},
-			Message: "Add Home.md\n",
 		},
-		Sidebar: "",
-		Footer:  "",
+		ContentBase64: base64.RawStdEncoding.EncodeToString(
+			[]byte("# Home page\n\nThis is the home page!\n"),
+		),
+		CommitCount: 1,
+		Sidebar:     "",
+		Footer:      "",
 	}, page)
 }
 
@@ -75,24 +77,96 @@ func TestAPIListWikiPages(t *testing.T) {
 
 	dummymeta := []*api.WikiPageMetaData{
 		{
-			Name:    "Home",
+			Title:   "Home",
+			HTMLURL: "http://localhost:3003/user2/repo1/wiki/Home",
 			SubURL:  "Home",
-			Updated: "2017-11-26T20:31:18-08:00",
+			LastCommit: &api.WikiCommit{
+				ID: "2c54faec6c45d31c1abfaecdab471eac6633738a",
+				Author: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Ethan Koenig",
+						Email: "[email protected]",
+					},
+					Date: "2017-11-27T04:31:18Z",
+				},
+				Committer: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Ethan Koenig",
+						Email: "[email protected]",
+					},
+					Date: "2017-11-27T04:31:18Z",
+				},
+				Message: "Add Home.md\n",
+			},
 		},
 		{
-			Name:    "Page With Image",
+			Title:   "Page With Image",
+			HTMLURL: "http://localhost:3003/user2/repo1/wiki/Page-With-Image",
 			SubURL:  "Page-With-Image",
-			Updated: "2019-01-24T20:41:55-05:00",
+			LastCommit: &api.WikiCommit{
+				ID: "0cf15c3f66ec8384480ed9c3cf87c9e97fbb0ec3",
+				Author: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Gabriel Silva Simões",
+						Email: "[email protected]",
+					},
+					Date: "2019-01-25T01:41:55Z",
+				},
+				Committer: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Gabriel Silva Simões",
+						Email: "[email protected]",
+					},
+					Date: "2019-01-25T01:41:55Z",
+				},
+				Message: "Add jpeg.jpg and page with image\n",
+			},
 		},
 		{
-			Name:    "Page With Spaced Name",
+			Title:   "Page With Spaced Name",
+			HTMLURL: "http://localhost:3003/user2/repo1/wiki/Page-With-Spaced-Name",
 			SubURL:  "Page-With-Spaced-Name",
-			Updated: "2019-01-24T20:39:51-05:00",
+			LastCommit: &api.WikiCommit{
+				ID: "c10d10b7e655b3dab1f53176db57c8219a5488d6",
+				Author: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Gabriel Silva Simões",
+						Email: "[email protected]",
+					},
+					Date: "2019-01-25T01:39:51Z",
+				},
+				Committer: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "Gabriel Silva Simões",
+						Email: "[email protected]",
+					},
+					Date: "2019-01-25T01:39:51Z",
+				},
+				Message: "Add page with spaced name\n",
+			},
 		},
 		{
-			Name:    "Unescaped File",
+			Title:   "Unescaped File",
+			HTMLURL: "http://localhost:3003/user2/repo1/wiki/Unescaped-File",
 			SubURL:  "Unescaped-File",
-			Updated: "2021-07-19T18:42:46+02:00",
+			LastCommit: &api.WikiCommit{
+				ID: "0dca5bd9b5d7ef937710e056f575e86c0184ba85",
+				Author: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "6543",
+						Email: "[email protected]",
+					},
+					Date: "2021-07-19T16:42:46Z",
+				},
+				Committer: &api.CommitUser{
+					Identity: api.Identity{
+						Name:  "6543",
+						Email: "[email protected]",
+					},
+					Date: "2021-07-19T16:42:46Z",
+				},
+				Message: "add unescaped file\n",
+			},
 		},
 	}
 
@@ -112,9 +186,9 @@ func TestAPINewWikiPage(t *testing.T) {
 		urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/new?token=%s", username, "repo1", token)
 
 		req := NewRequestWithJSON(t, "POST", urlStr, &api.CreateWikiPageOptions{
-			Title:   title,
-			Content: "Wiki page content for API unit tests",
-			Message: "",
+			Title:         title,
+			ContentBase64: base64.StdEncoding.EncodeToString([]byte("Wiki page content for API unit tests")),
+			Message:       "",
 		})
 		session.MakeRequest(t, req, http.StatusCreated)
 	}
@@ -129,9 +203,9 @@ func TestAPIEditWikiPage(t *testing.T) {
 	urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/page/Page-With-Spaced-Name?token=%s", username, "repo1", token)
 
 	req := NewRequestWithJSON(t, "PATCH", urlStr, &api.CreateWikiPageOptions{
-		Title:   "edited title",
-		Content: "Edited wiki page content for API unit tests",
-		Message: "",
+		Title:         "edited title",
+		ContentBase64: base64.StdEncoding.EncodeToString([]byte("Edited wiki page content for API unit tests")),
+		Message:       "",
 	})
 	session.MakeRequest(t, req, http.StatusOK)
 }
@@ -158,14 +232,14 @@ func TestAPIListPageRevisions(t *testing.T) {
 						Name:  "Ethan Koenig",
 						Email: "[email protected]",
 					},
-					Date: "2017-11-26T20:31:18-08:00",
+					Date: "2017-11-27T04:31:18Z",
 				},
 				Committer: &api.CommitUser{
 					Identity: api.Identity{
 						Name:  "Ethan Koenig",
 						Email: "[email protected]",
 					},
-					Date: "2017-11-26T20:31:18-08:00",
+					Date: "2017-11-27T04:31:18Z",
 				},
 				Message: "Add Home.md\n",
 			},

modules/convert/wiki.go

@@ -7,8 +7,10 @@ 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"
 )
 
@@ -21,52 +23,38 @@ func ToWikiCommit(commit *git.Commit) *api.WikiCommit {
 				Name:  commit.Author.Name,
 				Email: commit.Author.Email,
 			},
-			Date: commit.Author.When.Format(time.RFC3339),
+			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.Format(time.RFC3339),
+			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, count int64) *api.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:       count,
-	}
-}
-
-// ToWikiPage converts different data to a WikiPage
-func ToWikiPage(page string, lastCommit *git.Commit, commitsCount int64, data string, sidebarContent string, footerContent string) *api.WikiPage {
-	return &api.WikiPage{
-		WikiPageMetaData: &api.WikiPageMetaData{
-			Name:    page,
-			SubURL:  wiki_service.NameToSubURL(page),
-			Updated: lastCommit.Author.When.Format(time.RFC3339),
-		},
-		Content:     data,
-		CommitCount: commitsCount,
-		LastCommit:  ToWikiCommit(lastCommit),
-		Sidebar:     sidebarContent,
-		Footer:      footerContent,
+		Count:       total,
 	}
 }
 
 // ToWikiPageMetaData converts meta information to a WikiPageMetaData
-func ToWikiPageMetaData(page string, updated string) api.WikiPageMetaData {
-	return api.WikiPageMetaData{
-		Name:    page,
-		SubURL:  wiki_service.NameToSubURL(page),
-		Updated: updated,
+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),
 	}
 }

modules/structs/repo_wiki.go

@@ -15,26 +15,28 @@ type WikiCommit struct {
 // WikiPage a wiki page
 type WikiPage struct {
 	*WikiPageMetaData
-	Title       string      `json:"title"`
-	Content     string      `json:"content"`
-	CommitCount int64       `json:"commit_count"`
-	LastCommit  *WikiCommit `json:"last_commit"`
-	Sidebar     string      `json:"sidebar"`
-	Footer      string      `json:"footer"`
+	// Page content, base64 encoded
+	ContentBase64 string `json:"content"`
+	CommitCount   int64  `json:"commit_count"`
+	Sidebar       string `json:"sidebar"`
+	Footer        string `json:"footer"`
 }
 
 // WikiPageMetaData wiki page meta information
 type WikiPageMetaData struct {
-	Name    string `json:"name"`
-	SubURL  string `json:"suburl"`
-	Updated string `json:"updated"`
+	Title      string      `json:"title"`
+	HTMLURL    string      `json:"html_url"`
+	SubURL     string      `json:"suburl"`
+	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 UTF-8 encoded
-	Content string `json:"content"`
+	// content must be base64 encoded
+	ContentBase64 string `json:"content"`
+	// optional commit message summarizing the change
 	Message string `json:"message"`
 }
 

routers/api/v1/api.go

@@ -800,13 +800,13 @@ func Routes(sessioner func(http.Handler) http.Handler) *web.Route {
 				}, mustEnableIssues, reqToken())
 				m.Group("/wiki", func() {
 					m.Combo("/page/{pageName}").
-						Get(mustEnableWiki, repo.GetWikiPage).
-						Patch(mustNotBeArchived, reqRepoWriter(models.UnitTypeWiki), mustEnableWiki, reqToken(), bind(api.CreateWikiPageOptions{}), repo.EditWikiPage).
-						Delete(mustNotBeArchived, reqRepoWriter(models.UnitTypeWiki), mustEnableWiki, reqToken(), repo.DeleteWikiPage)
-					m.Get("/revisions/{pageName}", mustEnableWiki, repo.ListPageRevisions)
-					m.Post("/new", mustNotBeArchived, reqRepoWriter(models.UnitTypeWiki), mustEnableWiki, reqToken(), bind(api.CreateWikiPageOptions{}), repo.NewWikiPage)
-					m.Get("/pages", mustEnableWiki, repo.ListWikiPages)
-				})
+						Get(repo.GetWikiPage).
+						Patch(mustNotBeArchived, reqRepoWriter(models.UnitTypeWiki), bind(api.CreateWikiPageOptions{}), repo.EditWikiPage).
+						Delete(mustNotBeArchived, reqRepoWriter(models.UnitTypeWiki), repo.DeleteWikiPage)
+					m.Get("/revisions/{pageName}", repo.ListPageRevisions)
+					m.Post("/new", mustNotBeArchived, reqRepoWriter(models.UnitTypeWiki), bind(api.CreateWikiPageOptions{}), repo.NewWikiPage)
+					m.Get("/pages", repo.ListWikiPages)
+				}, mustEnableWiki)
 				m.Group("/issues", func() {
 					m.Combo("").Get(repo.ListIssues).
 						Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueOption{}), repo.CreateIssue)