mirror of
https://github.com/go-gitea/gitea
synced 2024-08-25 11:42:12 +02:00
There are multiple places where Gitea does not properly escape URLs that it is building and there are multiple places where it builds urls when there is already a simpler function available to use this. This is an extensive PR attempting to fix these issues. 1. The first commit in this PR looks through all href, src and links in the Gitea codebase and has attempted to catch all the places where there is potentially incomplete escaping. 2. Whilst doing this we will prefer to use functions that create URLs over recreating them by hand. 3. All uses of strings should be directly escaped - even if they are not currently expected to contain escaping characters. The main benefit to doing this will be that we can consider relaxing the constraints on user names and reponames in future. 4. The next commit looks at escaping in the wiki and re-considers the urls that are used there. Using the improved escaping here wiki files containing '/'. (This implementation will currently still place all of the wiki files the root directory of the repo but this would not be difficult to change.) 5. The title generation in feeds is now properly escaped. 6. EscapePound is no longer needed - urls should be PathEscaped / QueryEscaped as necessary but then re-escaped with Escape when creating html with locales Signed-off-by: Andrew Thornton <art27@cantab.net> Signed-off-by: Andrew Thornton <art27@cantab.net>
192 lines
6.5 KiB
Go
192 lines
6.5 KiB
Go
// Copyright 2017 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 (
|
|
"fmt"
|
|
"net/url"
|
|
"strings"
|
|
|
|
webhook_model "code.gitea.io/gitea/models/webhook"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/json"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
dingtalk "github.com/lunny/dingtalk_webhook"
|
|
)
|
|
|
|
type (
|
|
// DingtalkPayload represents
|
|
DingtalkPayload dingtalk.Payload
|
|
)
|
|
|
|
var (
|
|
_ PayloadConvertor = &DingtalkPayload{}
|
|
)
|
|
|
|
// JSONPayload Marshals the DingtalkPayload to json
|
|
func (d *DingtalkPayload) JSONPayload() ([]byte, error) {
|
|
data, err := json.MarshalIndent(d, "", " ")
|
|
if err != nil {
|
|
return []byte{}, err
|
|
}
|
|
return data, nil
|
|
}
|
|
|
|
// Create implements PayloadConvertor Create method
|
|
func (d *DingtalkPayload) Create(p *api.CreatePayload) (api.Payloader, error) {
|
|
// created tag/branch
|
|
refName := git.RefEndName(p.Ref)
|
|
title := fmt.Sprintf("[%s] %s %s created", p.Repo.FullName, p.RefType, refName)
|
|
|
|
return createDingtalkPayload(title, title, fmt.Sprintf("view ref %s", refName), p.Repo.HTMLURL+"/src/"+util.PathEscapeSegments(refName)), nil
|
|
}
|
|
|
|
// Delete implements PayloadConvertor Delete method
|
|
func (d *DingtalkPayload) Delete(p *api.DeletePayload) (api.Payloader, error) {
|
|
// created tag/branch
|
|
refName := git.RefEndName(p.Ref)
|
|
title := fmt.Sprintf("[%s] %s %s deleted", p.Repo.FullName, p.RefType, refName)
|
|
|
|
return createDingtalkPayload(title, title, fmt.Sprintf("view ref %s", refName), p.Repo.HTMLURL+"/src/"+util.PathEscapeSegments(refName)), nil
|
|
}
|
|
|
|
// Fork implements PayloadConvertor Fork method
|
|
func (d *DingtalkPayload) Fork(p *api.ForkPayload) (api.Payloader, error) {
|
|
title := fmt.Sprintf("%s is forked to %s", p.Forkee.FullName, p.Repo.FullName)
|
|
|
|
return createDingtalkPayload(title, title, fmt.Sprintf("view forked repo %s", p.Repo.FullName), p.Repo.HTMLURL), nil
|
|
}
|
|
|
|
// Push implements PayloadConvertor Push method
|
|
func (d *DingtalkPayload) Push(p *api.PushPayload) (api.Payloader, error) {
|
|
var (
|
|
branchName = git.RefEndName(p.Ref)
|
|
commitDesc string
|
|
)
|
|
|
|
var titleLink, linkText string
|
|
if len(p.Commits) == 1 {
|
|
commitDesc = "1 new commit"
|
|
titleLink = p.Commits[0].URL
|
|
linkText = fmt.Sprintf("view commit %s", p.Commits[0].ID[:7])
|
|
} else {
|
|
commitDesc = fmt.Sprintf("%d new commits", len(p.Commits))
|
|
titleLink = p.CompareURL
|
|
linkText = fmt.Sprintf("view commit %s...%s", p.Commits[0].ID[:7], p.Commits[len(p.Commits)-1].ID[:7])
|
|
}
|
|
if titleLink == "" {
|
|
titleLink = p.Repo.HTMLURL + "/src/" + util.PathEscapeSegments(branchName)
|
|
}
|
|
|
|
title := fmt.Sprintf("[%s:%s] %s", p.Repo.FullName, branchName, commitDesc)
|
|
|
|
var text string
|
|
// for each commit, generate attachment text
|
|
for i, commit := range p.Commits {
|
|
var authorName string
|
|
if commit.Author != nil {
|
|
authorName = " - " + commit.Author.Name
|
|
}
|
|
text += fmt.Sprintf("[%s](%s) %s", commit.ID[:7], commit.URL,
|
|
strings.TrimRight(commit.Message, "\r\n")) + authorName
|
|
// add linebreak to each commit but the last
|
|
if i < len(p.Commits)-1 {
|
|
text += "\r\n"
|
|
}
|
|
}
|
|
|
|
return createDingtalkPayload(title, text, linkText, titleLink), nil
|
|
}
|
|
|
|
// Issue implements PayloadConvertor Issue method
|
|
func (d *DingtalkPayload) Issue(p *api.IssuePayload) (api.Payloader, error) {
|
|
text, issueTitle, attachmentText, _ := getIssuesPayloadInfo(p, noneLinkFormatter, true)
|
|
|
|
return createDingtalkPayload(issueTitle, text+"\r\n\r\n"+attachmentText, "view issue", p.Issue.HTMLURL), nil
|
|
}
|
|
|
|
// IssueComment implements PayloadConvertor IssueComment method
|
|
func (d *DingtalkPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error) {
|
|
text, issueTitle, _ := getIssueCommentPayloadInfo(p, noneLinkFormatter, true)
|
|
|
|
return createDingtalkPayload(issueTitle, text+"\r\n\r\n"+p.Comment.Body, "view issue comment", p.Comment.HTMLURL), nil
|
|
}
|
|
|
|
// PullRequest implements PayloadConvertor PullRequest method
|
|
func (d *DingtalkPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error) {
|
|
text, issueTitle, attachmentText, _ := getPullRequestPayloadInfo(p, noneLinkFormatter, true)
|
|
|
|
return createDingtalkPayload(issueTitle, text+"\r\n\r\n"+attachmentText, "view pull request", p.PullRequest.HTMLURL), nil
|
|
}
|
|
|
|
// Review implements PayloadConvertor Review method
|
|
func (d *DingtalkPayload) Review(p *api.PullRequestPayload, event webhook_model.HookEventType) (api.Payloader, error) {
|
|
var text, title string
|
|
switch p.Action {
|
|
case api.HookIssueReviewed:
|
|
action, err := parseHookPullRequestEventType(event)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
title = fmt.Sprintf("[%s] Pull request review %s : #%d %s", p.Repository.FullName, action, p.Index, p.PullRequest.Title)
|
|
text = p.Review.Content
|
|
|
|
}
|
|
|
|
return createDingtalkPayload(title, title+"\r\n\r\n"+text, "view pull request", p.PullRequest.HTMLURL), nil
|
|
}
|
|
|
|
// Repository implements PayloadConvertor Repository method
|
|
func (d *DingtalkPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error) {
|
|
switch p.Action {
|
|
case api.HookRepoCreated:
|
|
title := fmt.Sprintf("[%s] Repository created", p.Repository.FullName)
|
|
return createDingtalkPayload(title, title, "view repository", p.Repository.HTMLURL), nil
|
|
case api.HookRepoDeleted:
|
|
title := fmt.Sprintf("[%s] Repository deleted", p.Repository.FullName)
|
|
return &DingtalkPayload{
|
|
MsgType: "text",
|
|
Text: struct {
|
|
Content string `json:"content"`
|
|
}{
|
|
Content: title,
|
|
},
|
|
}, nil
|
|
}
|
|
|
|
return nil, nil
|
|
}
|
|
|
|
// Release implements PayloadConvertor Release method
|
|
func (d *DingtalkPayload) Release(p *api.ReleasePayload) (api.Payloader, error) {
|
|
text, _ := getReleasePayloadInfo(p, noneLinkFormatter, true)
|
|
|
|
return createDingtalkPayload(text, text, "view release", p.Release.URL), nil
|
|
}
|
|
|
|
func createDingtalkPayload(title, text, singleTitle, singleURL string) *DingtalkPayload {
|
|
return &DingtalkPayload{
|
|
MsgType: "actionCard",
|
|
ActionCard: dingtalk.ActionCard{
|
|
Text: strings.TrimSpace(text),
|
|
Title: strings.TrimSpace(title),
|
|
HideAvatar: "0",
|
|
SingleTitle: singleTitle,
|
|
|
|
// https://developers.dingtalk.com/document/app/message-link-description
|
|
// to open the link in browser, we should use this URL, otherwise the page is displayed inside DingTalk client, very difficult to visit non-public URLs.
|
|
SingleURL: "dingtalk://dingtalkclient/page/link?pc_slide=false&url=" + url.QueryEscape(singleURL),
|
|
},
|
|
}
|
|
}
|
|
|
|
// GetDingtalkPayload converts a ding talk webhook into a DingtalkPayload
|
|
func GetDingtalkPayload(p api.Payloader, event webhook_model.HookEventType, meta string) (api.Payloader, error) {
|
|
return convertPayloader(new(DingtalkPayload), p, event)
|
|
}
|