Add Matrix webhook

Signed-off-by: Till Faelligen <[email protected]>

modules/webhook/matrix.go

@@ -0,0 +1,285 @@
+// Copyright 2020 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 webhook
+
+import (
+ "encoding/json"
+ "errors"
+ "fmt"
+ "regexp"
+ "strings"
+
+ "code.gitea.io/gitea/models"
+ "code.gitea.io/gitea/modules/git"
+ "code.gitea.io/gitea/modules/log"
+ "code.gitea.io/gitea/modules/setting"
+ api "code.gitea.io/gitea/modules/structs"
+)
+
+// MatrixMeta contains the Matrix metadata
+type MatrixMeta struct {
+ HomeserverURL string `json:"homeserver_url"`
+ Room string `json:"room_id"`
+ AccessToken string `json:"access_token"`
+ MessageType int `json:"message_type"`
+}
+
+var messageTypeText = map[int]string{
+ 1: "m.notice",
+ 2: "m.text",
+}
+
+// GetMatrixHook returns Matrix metadata
+func GetMatrixHook(w *models.Webhook) *MatrixMeta {
+ s := &MatrixMeta{}
+ if err := json.Unmarshal([]byte(w.Meta), s); err != nil {
+ log.Error("webhook.GetMatrixHook(%d): %v", w.ID, err)
+ }
+ return s
+}
+
+// MatrixPayload contains the information about the Matrix room
+type MatrixPayload struct {
+ Body string `json:"body"`
+ MsgType string `json:"msgtype"`
+ Format string `json:"format"`
+ FormattedBody string `json:"formatted_body"`
+}
+
+// SetSecret sets the Matrix secret
+func (p *MatrixPayload) SetSecret(_ string) {}
+
+// JSONPayload Marshals the MatrixPayload to json
+func (p *MatrixPayload) JSONPayload() ([]byte, error) {
+ data, err := json.MarshalIndent(p, "", " ")
+ if err != nil {
+ return []byte{}, err
+ }
+ return data, nil
+}
+
+// MatrixLinkFormatter creates a link compatible with Matrix
+func MatrixLinkFormatter(url string, text string) string {
+ return fmt.Sprintf(`<a href="%s">%s</a>`, url, text)
+}
+
+// MatrixLinkToRef Matrix-formatter link to a repo ref
+func MatrixLinkToRef(repoURL, ref string) string {
+ refName := git.RefEndName(ref)
+ switch {
+ case strings.HasPrefix(ref, git.BranchPrefix):
+ return MatrixLinkFormatter(repoURL+"/src/branch/"+refName, refName)
+ case strings.HasPrefix(ref, git.TagPrefix):
+ return MatrixLinkFormatter(repoURL+"/src/tag/"+refName, refName)
+ default:
+ return MatrixLinkFormatter(repoURL+"/src/commit/"+refName, refName)
+ }
+}
+
+func getMatrixCreatePayload(p *api.CreatePayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ repoLink := MatrixLinkFormatter(p.Repo.HTMLURL, p.Repo.FullName)
+ refLink := MatrixLinkToRef(p.Repo.HTMLURL, p.Ref)
+ text := fmt.Sprintf("[%s:%s] %s created by %s", repoLink, refLink, p.RefType, p.Sender.UserName)
+
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+// getMatrixDeletePayload composes Matrix payload for delete a branch or tag.
+func getMatrixDeletePayload(p *api.DeletePayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ refName := git.RefEndName(p.Ref)
+ repoLink := MatrixLinkFormatter(p.Repo.HTMLURL, p.Repo.FullName)
+ text := fmt.Sprintf("[%s:%s] %s deleted by %s", repoLink, refName, p.RefType, p.Sender.UserName)
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+// getMatrixForkPayload composes Matrix payload for forked by a repository.
+func getMatrixForkPayload(p *api.ForkPayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ baseLink := MatrixLinkFormatter(p.Forkee.HTMLURL, p.Forkee.FullName)
+ forkLink := MatrixLinkFormatter(p.Repo.HTMLURL, p.Repo.FullName)
+ text := fmt.Sprintf("%s is forked to %s", baseLink, forkLink)
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+func getMatrixIssuesPayload(p *api.IssuePayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ text, _, _, _ := getIssuesPayloadInfo(p, MatrixLinkFormatter, true)
+
+ pl := &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }
+
+ return pl, nil
+}
+
+func getMatrixIssueCommentPayload(p *api.IssueCommentPayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ text, _, _ := getIssueCommentPayloadInfo(p, MatrixLinkFormatter, true)
+
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+func getMatrixReleasePayload(p *api.ReleasePayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ text, _ := getReleasePayloadInfo(p, MatrixLinkFormatter, true)
+
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+func getMatrixPushPayload(p *api.PushPayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ var commitDesc string
+
+ if len(p.Commits) == 1 {
+ commitDesc = "1 commit"
+ } else {
+ commitDesc = fmt.Sprintf("%d commits", len(p.Commits))
+ }
+
+ repoLink := MatrixLinkFormatter(p.Repo.HTMLURL, p.Repo.FullName)
+ branchLink := MatrixLinkToRef(p.Repo.HTMLURL, p.Ref)
+ text := fmt.Sprintf("[%s] %s pushed %s to %s:<br>", repoLink, p.Pusher.UserName, commitDesc, branchLink)
+
+ // for each commit, generate a new line text
+ for i, commit := range p.Commits {
+ text += fmt.Sprintf("%s : %s - %s", MatrixLinkFormatter(commit.URL, commit.ID[:7]), commit.Message, commit.Author.Name)
+ // add linebreak to each commit but the last
+ if i < len(p.Commits)-1 {
+ text += "<br>"
+ }
+ }
+
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+func getMatrixPullRequestPayload(p *api.PullRequestPayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ text, _, _, _ := getPullRequestPayloadInfo(p, MatrixLinkFormatter, true)
+
+ pl := &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }
+
+ return pl, nil
+}
+
+func getMatrixPullRequestApprovalPayload(p *api.PullRequestPayload, matrix *MatrixMeta, event models.HookEventType) (*MatrixPayload, error) {
+ senderLink := MatrixLinkFormatter(setting.AppURL+p.Sender.UserName, p.Sender.UserName)
+ title := fmt.Sprintf("#%d %s", p.Index, p.PullRequest.Title)
+ titleLink := fmt.Sprintf("%s/pulls/%d", p.Repository.HTMLURL, p.Index)
+ repoLink := MatrixLinkFormatter(p.Repository.HTMLURL, p.Repository.FullName)
+ var text string
+
+ switch p.Action {
+ case api.HookIssueReviewed:
+ action, err := parseHookPullRequestEventType(event)
+ if err != nil {
+ return nil, err
+ }
+
+ text = fmt.Sprintf("[%s] Pull request review %s: [%s](%s) by %s", repoLink, action, title, titleLink, senderLink)
+ }
+
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+func getMatrixRepositoryPayload(p *api.RepositoryPayload, matrix *MatrixMeta) (*MatrixPayload, error) {
+ senderLink := MatrixLinkFormatter(setting.AppURL+p.Sender.UserName, p.Sender.UserName)
+ repoLink := MatrixLinkFormatter(p.Repository.HTMLURL, p.Repository.FullName)
+ var text string
+
+ switch p.Action {
+ case api.HookRepoCreated:
+ text = fmt.Sprintf("[%s] Repository created by %s", repoLink, senderLink)
+ case api.HookRepoDeleted:
+ text = fmt.Sprintf("[%s] Repository deleted by %s", repoLink, senderLink)
+ }
+
+ return &MatrixPayload{
+ Body: getMessageBody(text),
+ MsgType: messageTypeText[matrix.MessageType],
+ Format: "org.matrix.custom.html",
+ FormattedBody: text,
+ }, nil
+}
+
+// GetMatrixPayload converts a Matrix webhook into a MatrixPayload
+func GetMatrixPayload(p api.Payloader, event models.HookEventType, meta string) (*MatrixPayload, error) {
+ s := new(MatrixPayload)
+
+ matrix := &MatrixMeta{}
+ if err := json.Unmarshal([]byte(meta), &matrix); err != nil {
+ return s, errors.New("GetMatrixPayload meta json:" + err.Error())
+ }
+
+ switch event {
+ case models.HookEventCreate:
+ return getMatrixCreatePayload(p.(*api.CreatePayload), matrix)
+ case models.HookEventDelete:
+ return getMatrixDeletePayload(p.(*api.DeletePayload), matrix)
+ case models.HookEventFork:
+ return getMatrixForkPayload(p.(*api.ForkPayload), matrix)
+ case models.HookEventIssues, models.HookEventIssueAssign, models.HookEventIssueLabel, models.HookEventIssueMilestone:
+ return getMatrixIssuesPayload(p.(*api.IssuePayload), matrix)
+ case models.HookEventIssueComment, models.HookEventPullRequestComment:
+ return getMatrixIssueCommentPayload(p.(*api.IssueCommentPayload), matrix)
+ case models.HookEventPush:
+ return getMatrixPushPayload(p.(*api.PushPayload), matrix)
+ case models.HookEventPullRequest, models.HookEventPullRequestAssign, models.HookEventPullRequestLabel,
+ models.HookEventPullRequestMilestone, models.HookEventPullRequestSync:
+ return getMatrixPullRequestPayload(p.(*api.PullRequestPayload), matrix)
+ case models.HookEventPullRequestReviewRejected, models.HookEventPullRequestReviewApproved, models.HookEventPullRequestReviewComment:
+ return getMatrixPullRequestApprovalPayload(p.(*api.PullRequestPayload), matrix, event)
+ case models.HookEventRepository:
+ return getMatrixRepositoryPayload(p.(*api.RepositoryPayload), matrix)
+ case models.HookEventRelease:
+ return getMatrixReleasePayload(p.(*api.ReleasePayload), matrix)
+ }
+
+ return s, nil
+}
+
+var urlRegex = regexp.MustCompile(`<a.*?href="(.*?)">(.*?)</a>`)
+
+func getMessageBody(htmlText string) string {
+ htmlText = urlRegex.ReplaceAllString(htmlText, "[$2]($1)")
+ htmlText = strings.ReplaceAll(htmlText, "<br>", "\n")
+ return htmlText
+}

modules/webhook/matrix_test.go

@@ -0,0 +1,84 @@
+// Copyright 2020 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 webhook
+
+import (
+ "testing"
+
+ api "code.gitea.io/gitea/modules/structs"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+func TestMatrixIssuesPayloadOpened(t *testing.T) {
+ p := issueTestPayload()
+ sl := &MatrixMeta{}
+
+ p.Action = api.HookIssueOpened
+ pl, err := getMatrixIssuesPayload(p, sl)
+ require.Nil(t, err)
+ require.NotNil(t, pl)
+ assert.Equal(t, "[[test/repo](https://localhost:3000/test/repo)] Issue opened: [#2 crash](https://localhost:3000/test/repo/issues/2) by [user1](https://try.gitea.io/user1)", pl.Body)
+ assert.Equal(t, "[<a href=\"https://localhost:3000/test/repo\">test/repo</a>] Issue opened: <a href=\"https://localhost:3000/test/repo/issues/2\">#2 crash</a> by <a href=\"https://try.gitea.io/user1\">user1</a>", pl.FormattedBody)
+
+ p.Action = api.HookIssueClosed
+ pl, err = getMatrixIssuesPayload(p, sl)
+ require.Nil(t, err)
+ require.NotNil(t, pl)
+ assert.Equal(t, "[[test/repo](https://localhost:3000/test/repo)] Issue closed: [#2 crash](https://localhost:3000/test/repo/issues/2) by [user1](https://try.gitea.io/user1)", pl.Body)
+ assert.Equal(t, "[<a href=\"https://localhost:3000/test/repo\">test/repo</a>] Issue closed: <a href=\"https://localhost:3000/test/repo/issues/2\">#2 crash</a> by <a href=\"https://try.gitea.io/user1\">user1</a>", pl.FormattedBody)
+}
+
+func TestMatrixIssueCommentPayload(t *testing.T) {
+ p := issueCommentTestPayload()
+
+ sl := &MatrixMeta{}
+
+ pl, err := getMatrixIssueCommentPayload(p, sl)
+ require.Nil(t, err)
+ require.NotNil(t, pl)
+
+ assert.Equal(t, "[[test/repo](https://localhost:3000/test/repo)] New comment on issue [#2 crash](https://localhost:3000/test/repo/issues/2) by [user1](https://try.gitea.io/user1)", pl.Body)
+ assert.Equal(t, "[<a href=\"https://localhost:3000/test/repo\">test/repo</a>] New comment on issue <a href=\"https://localhost:3000/test/repo/issues/2\">#2 crash</a> by <a href=\"https://try.gitea.io/user1\">user1</a>", pl.FormattedBody)
+}
+
+func TestMatrixPullRequestCommentPayload(t *testing.T) {
+ p := pullRequestCommentTestPayload()
+
+ sl := &MatrixMeta{}
+
+ pl, err := getMatrixIssueCommentPayload(p, sl)
+ require.Nil(t, err)
+ require.NotNil(t, pl)
+
+ assert.Equal(t, "[[test/repo](https://localhost:3000/test/repo)] New comment on pull request [#2 Fix bug](https://localhost:3000/test/repo/pulls/2) by [user1](https://try.gitea.io/user1)", pl.Body)
+ assert.Equal(t, "[<a href=\"https://localhost:3000/test/repo\">test/repo</a>] New comment on pull request <a href=\"https://localhost:3000/test/repo/pulls/2\">#2 Fix bug</a> by <a href=\"https://try.gitea.io/user1\">user1</a>", pl.FormattedBody)
+}
+
+func TestMatrixReleasePayload(t *testing.T) {
+ p := pullReleaseTestPayload()
+
+ sl := &MatrixMeta{}
+
+ pl, err := getMatrixReleasePayload(p, sl)
+ require.Nil(t, err)
+ require.NotNil(t, pl)
+
+ assert.Equal(t, "[[test/repo](https://localhost:3000/test/repo)] Release created: [v1.0](https://localhost:3000/test/repo/src/v1.0) by [user1](https://try.gitea.io/user1)", pl.Body)
+ assert.Equal(t, "[<a href=\"https://localhost:3000/test/repo\">test/repo</a>] Release created: <a href=\"https://localhost:3000/test/repo/src/v1.0\">v1.0</a> by <a href=\"https://try.gitea.io/user1\">user1</a>", pl.FormattedBody)
+}
+
+func TestMatrixPullRequestPayload(t *testing.T) {
+ p := pullRequestTestPayload()
+
+ sl := &MatrixMeta{}
+
+ pl, err := getMatrixPullRequestPayload(p, sl)
+ require.Nil(t, err)
+ require.NotNil(t, pl)
+
+ assert.Equal(t, "[[test/repo](https://localhost:3000/test/repo)] Pull request opened: [#2 Fix bug](https://localhost:3000/test/repo/pulls/12) by [user1](https://try.gitea.io/user1)", pl.Body)
+ assert.Equal(t, "[<a href=\"https://localhost:3000/test/repo\">test/repo</a>] Pull request opened: <a href=\"https://localhost:3000/test/repo/pulls/12\">#2 Fix bug</a> by <a href=\"https://try.gitea.io/user1\">user1</a>", pl.FormattedBody)
+}