232 lines · 7.9 KB · Go
RawDownload
// Copyright 2017 The Gitea Authors. All rights reserved.// SPDX-License-Identifier: MIT package webhook import (	"context"	"fmt"	"html/template"	"net/http"	"net/url"	"strings" 	webhook_model "forgejo.org/models/webhook"	"forgejo.org/modules/git"	api "forgejo.org/modules/structs"	"forgejo.org/modules/util"	webhook_module "forgejo.org/modules/webhook"	"forgejo.org/services/forms"	"forgejo.org/services/webhook/shared") type dingtalkHandler struct{} func (dingtalkHandler) Type() webhook_module.HookType       { return webhook_module.DINGTALK }func (dingtalkHandler) Metadata(*webhook_model.Webhook) any { return nil }func (dingtalkHandler) Icon(size int) template.HTML         { return shared.ImgIcon("dingtalk.ico", size) } func (dingtalkHandler) UnmarshalForm(bind func(any)) forms.WebhookForm {	var form struct {		forms.WebhookCoreForm		PayloadURL string `binding:"Required;ValidUrl"`	}	bind(&form) 	return forms.WebhookForm{		WebhookCoreForm: form.WebhookCoreForm,		URL:             form.PayloadURL,		ContentType:     webhook_model.ContentTypeJSON,		Secret:          "",		HTTPMethod:      http.MethodPost,		Metadata:        nil,	}} type (	// DingtalkPayload represents an dingtalk payload.	DingtalkPayload struct {		MsgType string `json:"msgtype"`		Text    struct {			Content string `json:"content"`		} `json:"text"`		ActionCard DingtalkActionCard `json:"actionCard"`	} 	DingtalkActionCard struct {		Text        string `json:"text"`		Title       string `json:"title"`		HideAvatar  string `json:"hideAvatar"`		SingleTitle string `json:"singleTitle"`		SingleURL   string `json:"singleURL"`	}) // Create implements PayloadConvertor Create methodfunc (dc dingtalkConvertor) Create(p *api.CreatePayload) (DingtalkPayload, error) {	// created tag/branch	refName := git.RefName(p.Ref).ShortName()	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 methodfunc (dc dingtalkConvertor) Delete(p *api.DeletePayload) (DingtalkPayload, error) {	// created tag/branch	refName := git.RefName(p.Ref).ShortName()	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 methodfunc (dc dingtalkConvertor) Fork(p *api.ForkPayload) (DingtalkPayload, 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 methodfunc (dc dingtalkConvertor) Push(p *api.PushPayload) (DingtalkPayload, error) {	var (		branchName = git.RefName(p.Ref).ShortName()		commitDesc string	) 	var titleLink, linkText string	if p.TotalCommits == 1 {		commitDesc = "1 new commit"		titleLink = p.Commits[0].URL		linkText = "view commit"	} else {		commitDesc = fmt.Sprintf("%d new commits", p.TotalCommits)		titleLink = p.CompareURL		linkText = "view commits"	}	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 methodfunc (dc dingtalkConvertor) Issue(p *api.IssuePayload) (DingtalkPayload, error) {	text, issueTitle, attachmentText, _ := getIssuesPayloadInfo(p, noneLinkFormatter, true) 	return createDingtalkPayload(issueTitle, text+"\r\n\r\n"+attachmentText, "view issue", p.Issue.HTMLURL), nil} // Wiki implements PayloadConvertor Wiki methodfunc (dc dingtalkConvertor) Wiki(p *api.WikiPayload) (DingtalkPayload, error) {	text, _, _ := getWikiPayloadInfo(p, noneLinkFormatter, true)	url := p.Repository.HTMLURL + "/wiki/" + url.PathEscape(p.Page) 	return createDingtalkPayload(text, text, "view wiki", url), nil} // IssueComment implements PayloadConvertor IssueComment methodfunc (dc dingtalkConvertor) IssueComment(p *api.IssueCommentPayload) (DingtalkPayload, 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 methodfunc (dc dingtalkConvertor) PullRequest(p *api.PullRequestPayload) (DingtalkPayload, 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 methodfunc (dc dingtalkConvertor) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (DingtalkPayload, error) {	var text, title string	if p.Action == api.HookIssueReviewed {		action, err := parseHookPullRequestEventType(event)		if err != nil {			return DingtalkPayload{}, 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 methodfunc (dc dingtalkConvertor) Repository(p *api.RepositoryPayload) (DingtalkPayload, 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 DingtalkPayload{}, nil} // Release implements PayloadConvertor Release methodfunc (dc dingtalkConvertor) Release(p *api.ReleasePayload) (DingtalkPayload, error) {	text, _ := getReleasePayloadInfo(p, noneLinkFormatter, true) 	return createDingtalkPayload(text, text, "view release", p.Release.HTMLURL), nil} func (dc dingtalkConvertor) Package(p *api.PackagePayload) (DingtalkPayload, error) {	text, _ := getPackagePayloadInfo(p, noneLinkFormatter, true) 	return createDingtalkPayload(text, text, "view package", p.Package.HTMLURL), nil} func createDingtalkPayload(title, text, singleTitle, singleURL string) DingtalkPayload {	return DingtalkPayload{		MsgType: "actionCard",		ActionCard: DingtalkActionCard{			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),		},	}} type dingtalkConvertor struct{} var _ shared.PayloadConvertor[DingtalkPayload] = dingtalkConvertor{} func (dingtalkHandler) NewRequest(ctx context.Context, w *webhook_model.Webhook, t *webhook_model.HookTask) (*http.Request, []byte, error) {	return shared.NewJSONRequest(dingtalkConvertor{}, w, t, true)}