Add support for corporate WeChat webhooks

docs/content/doc/features/webhooks.en-us.md

@@ -27,6 +27,7 @@ All event pushes are POST requests. The methods currently supported are:
 - Telegram
 - Microsoft Teams
 - Feishu
+- Wechatwork
 
 ### Event information
 

docs/content/doc/features/webhooks.zh-tw.md

@@ -26,6 +26,7 @@ Gitea 的儲存庫事件支援 web hook。這可以有儲存庫管理員在設
 - Telegram
 - Microsoft Teams
 - Feishu
+- Wechatwork
 
 ### 事件資訊
 

models/migrations/v161.go

@@ -19,18 +19,20 @@ func convertTaskTypeToString(x *xorm.Engine) error {
 		MSTEAMS
 		FEISHU
 		MATRIX
+		WECHATWORK
 	)
 
 	hookTaskTypes := map[int]string{
-		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",
+		WECHATWORK: "wechatwork",
 	}
 
 	type HookTask struct {

models/migrations/v162.go

@@ -19,18 +19,20 @@ func convertWebhookTaskTypeToString(x *xorm.Engine) error {
 		MSTEAMS
 		FEISHU
 		MATRIX
+		WECHATWORK
 	)
 
 	hookTaskTypes := map[int]string{
-		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",
+		WECHATWORK: "wechatwork",
 	}
 
 	type Webhook struct {

models/webhook.go

@@ -563,15 +563,16 @@ type HookTaskType = string
 
 // Types of hook tasks
 const (
-	GITEA    HookTaskType = "gitea"
-	GOGS     HookTaskType = "gogs"
-	SLACK    HookTaskType = "slack"
-	DISCORD  HookTaskType = "discord"
-	DINGTALK HookTaskType = "dingtalk"
-	TELEGRAM HookTaskType = "telegram"
-	MSTEAMS  HookTaskType = "msteams"
-	FEISHU   HookTaskType = "feishu"
-	MATRIX   HookTaskType = "matrix"
+	GITEA      HookTaskType = "gitea"
+	GOGS       HookTaskType = "gogs"
+	SLACK      HookTaskType = "slack"
+	DISCORD    HookTaskType = "discord"
+	DINGTALK   HookTaskType = "dingtalk"
+	TELEGRAM   HookTaskType = "telegram"
+	MSTEAMS    HookTaskType = "msteams"
+	FEISHU     HookTaskType = "feishu"
+	MATRIX     HookTaskType = "matrix"
+	WECHATWORK HookTaskType = "wechatwork"
 )
 
 // HookEventType is the type of an hook event

modules/setting/webhook.go

@@ -36,7 +36,7 @@ func newWebhookService() {
 	Webhook.QueueLength = sec.Key("QUEUE_LENGTH").MustInt(1000)
 	Webhook.DeliverTimeout = sec.Key("DELIVER_TIMEOUT").MustInt(5)
 	Webhook.SkipTLSVerify = sec.Key("SKIP_TLS_VERIFY").MustBool()
-	Webhook.Types = []string{"gitea", "gogs", "slack", "discord", "dingtalk", "telegram", "msteams", "feishu", "matrix"}
+	Webhook.Types = []string{"gitea", "gogs", "slack", "discord", "dingtalk", "telegram", "msteams", "feishu", "matrix", "wechatwork"}
 	Webhook.PagingNum = sec.Key("PAGING_NUM").MustInt(10)
 	Webhook.ProxyURL = sec.Key("PROXY_URL").MustString("")
 	if Webhook.ProxyURL != "" {

modules/structs/hook.go

@@ -42,7 +42,7 @@ type CreateHookOptionConfig map[string]string
 // CreateHookOption options when create a hook
 type CreateHookOption struct {
 	// required: true
-	// enum: dingtalk,discord,gitea,gogs,msteams,slack,telegram,feishu
+	// enum: dingtalk,discord,gitea,gogs,msteams,slack,telegram,feishu,wechatwork
 	Type string `json:"type" binding:"Required"`
 	// required: true
 	Config       CreateHookOptionConfig `json:"config" binding:"Required"`

options/locale/locale_cs-CZ.ini

@@ -1701,6 +1701,7 @@ settings.add_telegram_hook_desc=Integrovat <a href="%s">Telegram</a> do vašeho
 settings.add_matrix_hook_desc=Integrovat <a href="%s">Matrix</a> do vašeho repozitáře.
 settings.add_msteams_hook_desc=Integrovat <a href="%s">Microsoft Teams</a> do vašeho repozitáře.
 settings.add_feishu_hook_desc=Integrovat <a href="%s">Feishu</a> do vašeho repozitáře.
+settings.add_wechatwork_hook_desc=Integrovat <a href="%s">Wechatwork</a> do vašeho repozitáře.
 settings.deploy_keys=Klíče pro nasazení
 settings.add_deploy_key=Přidat klíč pro nasazení
 settings.deploy_key_desc=Klíče pro nasazení mají k tomuto repozitáři přístup pouze pro čtení.

options/locale/locale_en-US.ini

@@ -1752,6 +1752,7 @@ settings.add_telegram_hook_desc = Integrate <a href="%s">Telegram</a> into your
 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_feishu_hook_desc = Integrate <a href="%s">Feishu</a> into your repository.
+settings.add_Wechat_hook_desc = Integrate <a href="%s">Wechatwork</a> into your repository.
 settings.deploy_keys = Deploy Keys
 settings.add_deploy_key = Add Deploy Key
 settings.deploy_key_desc = Deploy keys have read-only pull access to the repository.

options/locale/locale_zh-CN.ini

@@ -1746,6 +1746,7 @@ settings.add_telegram_hook_desc=将 <a href="%s">Telegram</a> 集成到您的仓
 settings.add_matrix_hook_desc=将 <a href="%s">Matrix</a> 集成到您的仓库中。
 settings.add_msteams_hook_desc=将 <a href="%s">Microsoft Teams</a> 集成到您的仓库中。
 settings.add_feishu_hook_desc=将 <a href="%s">Feishu</a> 集成到您的仓库中。
+settings.add_wechatwork_hook_desc=将 <a href="%s">Wechatwork</a> 集成到您的仓库中。
 settings.deploy_keys=部署密钥
 settings.add_deploy_key=添加部署密钥
 settings.deploy_key_desc=部署密钥具有对仓库的只读拉取权限。

options/locale/locale_zh-TW.ini

@@ -1745,6 +1745,7 @@ settings.add_telegram_hook_desc=將 <a href="%s">Telegram</a> 整合到您的儲
 settings.add_matrix_hook_desc=將 <a href="%s">Matrix</a> 整合到您的儲存庫。
 settings.add_msteams_hook_desc=將 <a href="%s">Microsoft Teams</a> 整合到您的儲存庫。
 settings.add_feishu_hook_desc=將 <a href="%s">Feishu</a> 整合到您的儲存庫。
+settings.add_wechatwork_hook_desc=将 <a href="%s">Wechatwork</a> 整合到您的儲存庫。
 settings.deploy_keys=部署金鑰
 settings.add_deploy_key=新增部署金鑰
 settings.deploy_key_desc=部署金鑰具有唯讀權限，可拉取此儲存庫。

routers/repo/webhook.go

@@ -638,6 +638,50 @@ func FeishuHooksNewPost(ctx *context.Context) {
 	ctx.Redirect(orCtx.Link)
 }
 
+// WechatworkHooksNewPost response for creating wechatwork hook
+func WechatworkHooksNewPost(ctx *context.Context) {
+	form := web.GetForm(ctx).(*forms.NewWechatWorkHookForm)
+
+	ctx.Data["Title"] = ctx.Tr("repo.settings")
+	ctx.Data["PageIsSettingsHooks"] = true
+	ctx.Data["PageIsSettingsHooksNew"] = true
+	ctx.Data["Webhook"] = models.Webhook{HookEvent: &models.HookEvent{}}
+	ctx.Data["HookType"] = models.WECHATWORK
+
+	orCtx, err := getOrgRepoCtx(ctx)
+	if err != nil {
+		ctx.ServerError("getOrgRepoCtx", err)
+		return
+	}
+
+	if ctx.HasError() {
+		ctx.HTML(http.StatusOK, orCtx.NewTemplate)
+		return
+	}
+
+	w := &models.Webhook{
+		RepoID:          orCtx.RepoID,
+		URL:             form.PayloadURL,
+		ContentType:     models.ContentTypeJSON,
+		HookEvent:       ParseHookEvent(form.WebhookForm),
+		IsActive:        form.Active,
+		Type:            models.WECHATWORK,
+		Meta:            "",
+		OrgID:           orCtx.OrgID,
+		IsSystemWebhook: orCtx.IsSystemWebhook,
+	}
+	if err := w.UpdateEvent(); err != nil {
+		ctx.ServerError("UpdateEvent", err)
+		return
+	} else if err := models.CreateWebhook(w); err != nil {
+		ctx.ServerError("CreateWebhook", err)
+		return
+	}
+
+	ctx.Flash.Success(ctx.Tr("repo.settings.add_hook_success"))
+	ctx.Redirect(orCtx.Link)
+}
+
 func checkWebhook(ctx *context.Context) (*orgRepoCtx, *models.Webhook) {
 	ctx.Data["RequireHighlightJS"] = true
 
@@ -1062,6 +1106,39 @@ func FeishuHooksEditPost(ctx *context.Context) {
 	ctx.Redirect(fmt.Sprintf("%s/%d", orCtx.Link, w.ID))
 }
 
+// WechatworkHooksEditPost response for editing wechatwork hook
+func WechatworkHooksEditPost(ctx *context.Context) {
+	form := web.GetForm(ctx).(*forms.NewWechatWorkHookForm)
+	ctx.Data["Title"] = ctx.Tr("repo.settings")
+	ctx.Data["PageIsSettingsHooks"] = true
+	ctx.Data["PageIsSettingsHooksEdit"] = true
+
+	orCtx, w := checkWebhook(ctx)
+	if ctx.Written() {
+		return
+	}
+	ctx.Data["Webhook"] = w
+
+	if ctx.HasError() {
+		ctx.HTML(http.StatusOK, orCtx.NewTemplate)
+		return
+	}
+
+	w.URL = form.PayloadURL
+	w.HookEvent = ParseHookEvent(form.WebhookForm)
+	w.IsActive = form.Active
+	if err := w.UpdateEvent(); err != nil {
+		ctx.ServerError("UpdateEvent", err)
+		return
+	} else if err := models.UpdateWebhook(w); err != nil {
+		ctx.ServerError("UpdateWebhook", err)
+		return
+	}
+
+	ctx.Flash.Success(ctx.Tr("repo.settings.update_hook_success"))
+	ctx.Redirect(fmt.Sprintf("%s/%d", orCtx.Link, w.ID))
+}
+
 // TestWebhook test if web hook is work fine
 func TestWebhook(ctx *context.Context) {
 	hookID := ctx.ParamsInt64(":id")

routers/routes/web.go

@@ -490,6 +490,7 @@ func RegisterRoutes(m *web.Route) {
 			m.Post("/matrix/{id}", bindIgnErr(forms.NewMatrixHookForm{}), repo.MatrixHooksEditPost)
 			m.Post("/msteams/{id}", bindIgnErr(forms.NewMSTeamsHookForm{}), repo.MSTeamsHooksEditPost)
 			m.Post("/feishu/{id}", bindIgnErr(forms.NewFeishuHookForm{}), repo.FeishuHooksEditPost)
+			m.Post("/wechatwork/{id}", bindIgnErr(forms.NewWechatWorkHookForm{}), repo.WechatworkHooksEditPost)
 		}, webhooksEnabled)
 
 		m.Group("/{configType:default-hooks|system-hooks}", func() {
@@ -503,6 +504,8 @@ func RegisterRoutes(m *web.Route) {
 			m.Post("/matrix/new", bindIgnErr(forms.NewMatrixHookForm{}), repo.MatrixHooksNewPost)
 			m.Post("/msteams/new", bindIgnErr(forms.NewMSTeamsHookForm{}), repo.MSTeamsHooksNewPost)
 			m.Post("/feishu/new", bindIgnErr(forms.NewFeishuHookForm{}), repo.FeishuHooksNewPost)
+			m.Post("/wechatwork/new", bindIgnErr(forms.NewWechatWorkHookForm{}), repo.WechatworkHooksNewPost)
+
 		})
 
 		m.Group("/auths", func() {
@@ -684,6 +687,7 @@ func RegisterRoutes(m *web.Route) {
 				m.Post("/matrix/new", bindIgnErr(forms.NewMatrixHookForm{}), repo.MatrixHooksNewPost)
 				m.Post("/msteams/new", bindIgnErr(forms.NewMSTeamsHookForm{}), repo.MSTeamsHooksNewPost)
 				m.Post("/feishu/new", bindIgnErr(forms.NewFeishuHookForm{}), repo.FeishuHooksNewPost)
+				m.Post("/wechatwork/new", bindIgnErr(forms.NewWechatWorkHookForm{}), repo.WechatworkHooksNewPost)
 				m.Get("/{id}", repo.WebHooksEdit)
 				m.Post("/{id}/test", repo.TestWebhook)
 				m.Post("/gitea/{id}", bindIgnErr(forms.NewWebhookForm{}), repo.WebHooksEditPost)
@@ -695,6 +699,7 @@ func RegisterRoutes(m *web.Route) {
 				m.Post("/matrix/{id}", bindIgnErr(forms.NewMatrixHookForm{}), repo.MatrixHooksEditPost)
 				m.Post("/msteams/{id}", bindIgnErr(forms.NewMSTeamsHookForm{}), repo.MSTeamsHooksEditPost)
 				m.Post("/feishu/{id}", bindIgnErr(forms.NewFeishuHookForm{}), repo.FeishuHooksEditPost)
+				m.Post("/wechatwork/{id}", bindIgnErr(forms.NewWechatWorkHookForm{}), repo.WechatworkHooksEditPost)
 			}, webhooksEnabled)
 
 			m.Group("/keys", func() {

services/forms/repo_form.go

@@ -376,6 +376,18 @@ func (f *NewFeishuHookForm) Validate(req *http.Request, errs binding.Errors) bin
 	return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
 }
 
+// NewFeishuHookForm form for creating feishu hook
+type NewWechatWorkHookForm struct {
+	PayloadURL string `binding:"Required;ValidUrl"`
+	WebhookForm
+}
+
+// Validate validates the fields
+func (f *NewWechatWorkHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
+	ctx := context.GetContext(req)
+	return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
+}
+
 // .___
 // |   | ______ ________ __   ____
 // |   |/  ___//  ___/  |  \_/ __ \

services/webhook/webhook.go

@@ -55,6 +55,10 @@ var (
 			name:           models.MATRIX,
 			payloadCreator: GetMatrixPayload,
 		},
+		models.WECHATWORK: {
+			name:           models.WECHATWORK,
+			payloadCreator: GetWechatworkPayload,
+		},
 	}
 )