WIP: Webhook wechat

models/webhook.go

@@ -560,18 +560,20 @@ const (
 	MSTEAMS
 	FEISHU
 	MATRIX
+	WORKWECHAT
 )
 
 var hookTaskTypes = map[string]HookTaskType{
-	"gitea":    GITEA,
-	"gogs":     GOGS,
-	"slack":    SLACK,
-	"discord":  DISCORD,
-	"dingtalk": DINGTALK,
-	"telegram": TELEGRAM,
-	"msteams":  MSTEAMS,
-	"feishu":   FEISHU,
-	"matrix":   MATRIX,
+	"gitea":      GITEA,
+	"gogs":       GOGS,
+	"slack":      SLACK,
+	"discord":    DISCORD,
+	"dingtalk":   DINGTALK,
+	"telegram":   TELEGRAM,
+	"msteams":    MSTEAMS,
+	"feishu":     FEISHU,
+	"matrix":     MATRIX,
+	"workwechat": WORKWECHAT,
 }
 
 // ToHookTaskType returns HookTaskType by given name.
@@ -600,6 +602,8 @@ func (t HookTaskType) Name() string {
 		return "feishu"
 	case MATRIX:
 		return "matrix"
+	case WORKWECHAT:
+		return "workwechat"
 	}
 	return ""
 }

modules/auth/repo_form.go

@@ -359,6 +359,18 @@ func (f *NewFeishuHookForm) Validate(ctx *macaron.Context, errs binding.Errors)
 	return validate(errs, ctx.Data, f, ctx.Locale)
 }
 
+// NewWorkwechatHookForm form for creating work wechat hook
+type NewWorkwechatHookForm struct {
+	PayloadURL string `binding:"Required;ValidUrl"`
+	ChatID     string `form:"chatid"`
+	WebhookForm
+}
+
+// Validate validates the fields
+func (f *NewWorkwechatHookForm) Validate(ctx *macaron.Context, errs binding.Errors) binding.Errors {
+	return validate(errs, ctx.Data, f, ctx.Locale)
+}
+
 // .___
 // |   | ______ ________ __   ____
 // |   |/  ___//  ___/  |  \_/ __ \

modules/convert/convert.go

@@ -230,6 +230,9 @@ func ToHook(repoLink string, w *models.Webhook) *api.Hook {
 		config["username"] = s.Username
 		config["icon_url"] = s.IconURL
 		config["color"] = s.Color
+	} else if w.HookTaskType == models.WORKWECHAT {
+		we := webhook.GetWorkwechatHook(w)
+		config["chatid"] = we.ChatID
 	}
 
 	return &api.Hook{

modules/webhook/webhook.go

@@ -132,6 +132,11 @@ func prepareWebhook(w *models.Webhook, repo *models.Repository, event models.Hoo
 		if err != nil {
 			return fmt.Errorf("GetMatrixPayload: %v", err)
 		}
+	case models.WORKWECHAT:
+		payloader, err = GetWorkwechatPayload(p, event, w.Meta)
+		if err != nil {
+			return fmt.Errorf("GetWorkwechatPayload: %v", err)
+		}
 	default:
 		p.SetSecret(w.Secret)
 		payloader = p

modules/webhook/workwechat.go

@@ -0,0 +1,287 @@
+// Copyright 2018 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"
+	"strings"
+
+	"code.gitea.io/gitea/models"
+	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/log"
+	api "code.gitea.io/gitea/modules/structs"
+)
+
+type (
+	// Text message
+	Text struct {
+		Content string `json:"content"`
+	}
+
+	//TextCard message
+	TextCard struct {
+		Title       string `json:"title"`
+		Description string `json:"description"`
+		URL         string `json:"url"`
+		ButtonText  string `json:"btntxt"`
+	}
+	//WorkwechatPayload represents
+	WorkwechatPayload struct {
+		ChatID   string   `json:"chatid"`
+		MsgType  string   `json:"msgtype"`
+		Text     Text     `json:"text"`
+		TextCard TextCard `json:"textcard"`
+		Safe     int      `json:"safe"`
+	}
+
+	// WorkwechatMeta contains the work wechat metadata
+	WorkwechatMeta struct {
+		ChatID string `json:"chatid"`
+	}
+)
+
+// GetWorkwechatHook returns workwechat metadata
+func GetWorkwechatHook(w *models.Webhook) *WorkwechatMeta {
+	we := &WorkwechatMeta{}
+	if err := json.Unmarshal([]byte(w.Meta), we); err != nil {
+		log.Error("webhook.GetWorkwechatHook(%d): %v", w.ID, err)
+	}
+	return we
+}
+
+// SetSecret sets the workwechat secret
+func (p *WorkwechatPayload) SetSecret(_ string) {}
+
+// JSONPayload Marshals the WorkwechatPayload to json
+func (p *WorkwechatPayload) JSONPayload() ([]byte, error) {
+	data, err := json.MarshalIndent(p, "", "  ")
+	if err != nil {
+		return []byte{}, err
+	}
+	return data, nil
+}
+
+func getWorkwechatCreatePayload(p *api.CreatePayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	// created tag/branch
+	refName := git.RefEndName(p.Ref)
+	title := fmt.Sprintf("[%s] %s %s created", p.Repo.FullName, p.RefType, refName)
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Title:       title,
+			Description: title,
+			ButtonText:  fmt.Sprintf("view ref %s", refName),
+			URL:         p.Repo.HTMLURL + "/src/" + refName,
+		},
+	}, nil
+}
+
+func getWorkwechatDeletePayload(p *api.DeletePayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	// created tag/branch
+	refName := git.RefEndName(p.Ref)
+	title := fmt.Sprintf("[%s] %s %s deleted", p.Repo.FullName, p.RefType, refName)
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Title:       title,
+			Description: title,
+			ButtonText:  fmt.Sprintf("view ref %s", refName),
+			URL:         p.Repo.HTMLURL + "/src/" + refName,
+		},
+	}, nil
+}
+
+func getWorkwechatForkPayload(p *api.ForkPayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	title := fmt.Sprintf("%s is forked to %s", p.Forkee.FullName, p.Repo.FullName)
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Description: title,
+			Title:       title,
+			ButtonText:  fmt.Sprintf("view forked repo %s", p.Repo.FullName),
+			URL:         p.Repo.HTMLURL,
+		},
+	}, nil
+}
+
+func getWorkwechatPushPayload(p *api.PushPayload, meta *WorkwechatMeta) (*WorkwechatPayload, 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/" + 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 += "\n"
+		}
+	}
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Description: text,
+			Title:       title,
+			ButtonText:  linkText,
+			URL:         titleLink,
+		},
+	}, nil
+}
+
+func getWorkwechatIssuesPayload(p *api.IssuePayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	text, issueTitle, attachmentText, _ := getIssuesPayloadInfo(p, noneLinkFormatter, true)
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Description: text + "\r\n\r\n" + attachmentText,
+			Title:       issueTitle,
+			ButtonText:  "view issue",
+			URL:         p.Issue.URL,
+		},
+	}, nil
+}
+
+func getWorkwechatIssueCommentPayload(p *api.IssueCommentPayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	text, issueTitle, _ := getIssueCommentPayloadInfo(p, noneLinkFormatter, true)
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Description: text + "\r\n\r\n" + p.Comment.Body,
+			Title:       issueTitle,
+			ButtonText:  "view issue comment",
+			URL:         p.Comment.HTMLURL,
+		},
+	}, nil
+}
+
+func getWorkwechatPullRequestPayload(p *api.PullRequestPayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	text, issueTitle, attachmentText, _ := getPullRequestPayloadInfo(p, noneLinkFormatter, true)
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Description: text + "\r\n\r\n" + attachmentText,
+			Title:       issueTitle,
+			ButtonText:  "view pull request",
+			URL:         p.PullRequest.HTMLURL,
+		},
+	}, nil
+}
+
+func getWorkwechatRepositoryPayload(p *api.RepositoryPayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	var title, url string
+	switch p.Action {
+	case api.HookRepoCreated:
+		title = fmt.Sprintf("[%s] Repository created", p.Repository.FullName)
+		url = p.Repository.HTMLURL
+		return &WorkwechatPayload{
+			ChatID:  meta.ChatID,
+			MsgType: "textcard",
+			TextCard: TextCard{
+				Description: title,
+				Title:       title,
+				ButtonText:  "view repository",
+				URL:         url,
+			},
+		}, nil
+	case api.HookRepoDeleted:
+		title = fmt.Sprintf("[%s] Repository deleted", p.Repository.FullName)
+		return &WorkwechatPayload{
+			MsgType: "text",
+			Text: struct {
+				Content string `json:"content"`
+			}{
+				Content: title,
+			},
+		}, nil
+	}
+
+	return nil, nil
+}
+
+func getWorkwechatReleasePayload(p *api.ReleasePayload, meta *WorkwechatMeta) (*WorkwechatPayload, error) {
+	text, _ := getReleasePayloadInfo(p, noneLinkFormatter, true)
+
+	return &WorkwechatPayload{
+		ChatID:  meta.ChatID,
+		MsgType: "textcard",
+		TextCard: TextCard{
+			Description: text,
+			Title:       text,
+			ButtonText:  "view release",
+			URL:         p.Release.URL,
+		},
+	}, nil
+}
+
+// GetWorkwechatPayload converts a work wechat webhook into a WorkwechatPayload
+func GetWorkwechatPayload(p api.Payloader, event models.HookEventType, meta string) (*WorkwechatPayload, error) {
+	s := new(WorkwechatPayload)
+
+	workwechatMeta := &WorkwechatMeta{}
+	if err := json.Unmarshal([]byte(meta), &workwechatMeta); err != nil {
+		return s, errors.New("GetWorkwechatPayload meta json:" + err.Error())
+	}
+	switch event {
+	case models.HookEventCreate:
+		return getWorkwechatCreatePayload(p.(*api.CreatePayload), workwechatMeta)
+	case models.HookEventDelete:
+		return getWorkwechatDeletePayload(p.(*api.DeletePayload), workwechatMeta)
+	case models.HookEventFork:
+		return getWorkwechatForkPayload(p.(*api.ForkPayload), workwechatMeta)
+	case models.HookEventIssues:
+		return getWorkwechatIssuesPayload(p.(*api.IssuePayload), workwechatMeta)
+	case models.HookEventIssueComment:
+		return getWorkwechatIssueCommentPayload(p.(*api.IssueCommentPayload), workwechatMeta)
+	case models.HookEventPush:
+		return getWorkwechatPushPayload(p.(*api.PushPayload), workwechatMeta)
+	case models.HookEventPullRequest:
+		return getWorkwechatPullRequestPayload(p.(*api.PullRequestPayload), workwechatMeta)
+	case models.HookEventRepository:
+		return getWorkwechatRepositoryPayload(p.(*api.RepositoryPayload), workwechatMeta)
+	case models.HookEventRelease:
+		return getWorkwechatReleasePayload(p.(*api.ReleasePayload), workwechatMeta)
+	}
+
+	return s, nil
+}

options/locale/locale_en-US.ini

@@ -954,7 +954,7 @@ issues.new.no_reviewers = No reviewers
 issues.new.add_reviewer_title = Request review
 issues.choose.get_started = Get Started
 issues.choose.blank = Default
-issues.choose.blank_about = Create an issue from default template. 
+issues.choose.blank_about = Create an issue from default template.
 issues.no_ref = No Branch/Tag Specified
 issues.create = Create Issue
 issues.new_label = New Label
@@ -1617,6 +1617,8 @@ settings.add_dingtalk_hook_desc = Integrate <a href="%s">Dingtalk</a> into your
 settings.add_telegram_hook_desc = Integrate <a href="%s">Telegram</a> into your repository.
 settings.add_matrix_hook_desc = Integrate <a href="%s">Matrix</a> into your repository.
 settings.add_msteams_hook_desc = Integrate <a href="%s">Microsoft Teams</a> into your repository.
+settings.add_workwechat_hook_desc = Integrate <a href="%s">Work Wechat</a> into your repository.
+settings.workwechat_chatid=Chat ID
 settings.add_feishu_hook_desc = Integrate <a href="%s">Feishu</a> into your repository.
 settings.deploy_keys = Deploy Keys
 settings.add_deploy_key = Add Deploy Key