Merge branch 'dev'

增加发送钉钉消息的功能

Author: chanyipiaomiao

README.md

@@ -5,6 +5,7 @@ Golang + Beego编写, 提供一些开发/运维常见操作的HTTP API接口，
 # 主要功能
 
 - 微信报警
+- 发送钉钉报警
 - 2步验证(Google Authenticator验证)
 - 密码存储
 - 发送邮件
@@ -19,7 +20,9 @@ Golang + Beego编写, 提供一些开发/运维常见操作的HTTP API接口，
 - [依赖](#依赖)
 - [功能列表](#功能列表)
 	- [微信报警](#微信报警)
-		- [发送消息](#发送消息)
+		- [发送微信消息](#发送微信消息)
+	- [钉钉报警](#钉钉报警)
+		- [发送钉钉消息](#发送钉钉消息)
 	- [2步验证](#2步验证)
 		- [启用2步验证](#启用2步验证)
 		- [验证6位数字](#验证google-authenticator或是其他的类似的app生成的6位数字)
@@ -73,6 +76,7 @@ Golang + Beego编写, 提供一些开发/运维常见操作的HTTP API接口，
 	- 配置是否启用token验证
 	- 配置jwt token签名字符串,请自行生成修改
 	- 配置微信报警的配置, corpID、warningAppAgentID、warningAppSecret,可参考文档[设置微信报警流程](/doc/weixin.md)
+	- 配置钉钉机器人的URL(**可选**)
 
 2. 首先初始化, 会生成root token，该root token 管理其他的token(**该步骤可选**)
 
@@ -152,7 +156,7 @@ go get github.com/chanyipiaomiao/weixin-kit
 这3个参数可以在企业微信后台管理页面可以看到，详情可以查看上面的文档。
 
 
-#### 发送消息
+#### 发送微信消息
 
 ```sh
 POST /api/v1/sendmsg/weixin
@@ -166,6 +170,25 @@ text：   要发送的文本消息
 
 [返回到目录](#目录)
 
+## 钉钉报警
+
+需要在conf/app.conf 配置钉钉机器人的URL，或者是在POST中传递url参数指定钉钉机器人地址
+
+#### 发送钉钉消息
+
+```sh
+POST /api/v1/sendmsg/dingding
+
+msgType： text|markdown
+msg:      要发送的消息
+title:    发送markdown消息时需要指定此参数，指定标题
+url:      可以指定钉钉机器人的URL，这样就不用在conf/app.conf 配置钉钉机器人的URL
+```
+
+注意: 在发送markdown消息时，markdown的语法可以查看[官方文档](https://open-doc.dingtalk.com/docs/doc.htm?spm=a219a.7629140.0.0.xuaZtG&treeId=257&articleId=105735&docType=1#s2)
+
+[返回到目录](#目录)
+
 ## 2步验证
 
 2步验证,可以方便的集成到系统中,只需要调用3个API即可.

common/notice.go

@@ -8,9 +8,20 @@ import (
 )
 
 // SendByDingTalkRobot 通过钉钉发送消息通知
-func SendByDingTalkRobot(messageType string, message string) (bool, error) {
-	url := beego.AppConfig.String("dingTalkRobot")
-	dingtalk := hltool.NewDingTalkClient(url, message, "text")
+func SendByDingTalkRobot(messageType, message, title, robotURL string) (bool, error) {
+	var url string
+	if robotURL == "" {
+		url = beego.AppConfig.String("dingTalkRobot")
+	}
+	url = robotURL
+	dingtalk := &hltool.DingTalkClient{
+		RobotURL: url,
+		Message: &hltool.DingTalkMessage{
+			Type:    messageType,
+			Message: message,
+			Title:   title,
+		},
+	}
 	ok, err := hltool.SendMessage(dingtalk)
 	if err != nil {
 		dingFields := map[string]interface{}{

common/password.go

@@ -26,7 +26,7 @@ func GenPassword() map[string]bool {
 	sendResult := make(chan bool)
 	if ok, _ := beego.AppConfig.Bool("authpassword::enableDingtalkReciveGenPassword"); ok {
 		go func(ch chan bool, messageType, message string) {
-			ok, _ := SendByDingTalkRobot(messageType, message)
+			ok, _ := SendByDingTalkRobot(messageType, message, "", "")
 			ch <- ok
 		}(sendResult, "text", info)
 	}

controllers/common.go

@@ -105,7 +105,7 @@ type EmailController struct {
 	BaseController
 }
 
-// VersionController 密码管理控制器
+// VersionController 程序自身版本管理控制器
 type VersionController struct {
 	BaseController
 }
@@ -115,12 +115,17 @@ type TwoStepAuthController struct {
 	BaseController
 }
 
-// StorePasswordController 密码管理
+// StorePasswordController 密码管理控制器
 type StorePasswordController struct {
 	BaseController
 }
 
-// WeixinController 发送微信消息管理
+// WeixinController 发送微信消息控制器
 type WeixinController struct {
 	BaseController
 }
+
+// DingdingController 发送钉钉消息控制器
+type DingdingController struct {
+	BaseController
+}

controllers/dingding.go

@@ -0,0 +1,35 @@
+package controllers
+
+import (
+	"devops-api/common"
+	"fmt"
+)
+
+// SendMessage 发送钉钉消息
+func (d *DingdingController) SendMessage() {
+	msgType := d.GetString("msgType")
+	msg := d.GetString("msg")
+	title := d.GetString("title")
+	robotURL := d.GetString("url")
+
+	requestID := d.Data["RequestID"].(string)
+	sendDingdingMessageLog := map[string]interface{}{
+		"entryType": "SendDingdingMessage",
+		"requestId": requestID,
+	}
+	_, err := common.SendByDingTalkRobot(msgType, msg, title, robotURL)
+	if err != nil {
+		sendDingdingMessageLog["statuscode"] = 1
+		sendDingdingMessageLog["errmsg"] = fmt.Sprintf("%s", err)
+		common.GetLogger().Error(sendDingdingMessageLog, "发送钉钉消息")
+		d.Data["json"] = sendDingdingMessageLog
+		d.ServeJSON()
+		return
+	}
+	sendDingdingMessageLog["statuscode"] = 0
+	sendDingdingMessageLog["errmsg"] = ""
+	sendDingdingMessageLog["result"] = "发送成功"
+	common.GetLogger().Info(sendDingdingMessageLog, msg)
+	d.Data["json"] = sendDingdingMessageLog
+	d.ServeJSON()
+}

controllers/weixin.go

@@ -11,14 +11,14 @@ func (w *WeixinController) SendMessage() {
 	toTag := w.GetString("toTag")
 	toUser := w.GetString("toUser")
 	toParty := w.GetString("toParty")
-	text := w.GetString("text")
+	msg := w.GetString("msg")
 
 	requestID := w.Data["RequestID"].(string)
 	sendWeixinMessageLog := map[string]interface{}{
 		"entryType": "SendWeixinMessage",
 		"requestId": requestID,
 	}
-	_, err := common.SendWeixinMessage(msgType, text, toTag, toUser, toParty)
+	_, err := common.SendWeixinMessage(msgType, msg, toTag, toUser, toParty)
 	if err != nil {
 		sendWeixinMessageLog["statuscode"] = 1
 		sendWeixinMessageLog["errmsg"] = fmt.Sprintf("%s", err)
@@ -30,7 +30,7 @@ func (w *WeixinController) SendMessage() {
 	sendWeixinMessageLog["statuscode"] = 0
 	sendWeixinMessageLog["errmsg"] = ""
 	sendWeixinMessageLog["result"] = "发送成功"
-	common.GetLogger().Info(sendWeixinMessageLog, text)
+	common.GetLogger().Info(sendWeixinMessageLog, msg)
 	w.Data["json"] = sendWeixinMessageLog
 	w.ServeJSON()
 	return

routers/router.go

@@ -21,6 +21,9 @@ func init() {
 				beego.NSNamespace("/weixin",
 					beego.NSRouter("", &controllers.WeixinController{}, "post:SendMessage"),
 				),
+				beego.NSNamespace("/dingding",
+					beego.NSRouter("", &controllers.DingdingController{}, "post:SendMessage"),
+				),
 			),
 			beego.NSNamespace("/md5",
 				beego.NSRouter("", &controllers.MD5Controller{}),