Merge pull request #519 from lgcareer/dev-1.1.0

add Enterprise WeChat alert to alert sender

escheduler-alert/src/main/java/cn/escheduler/alert/manager/EnterpriseWeChatManager.java

+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package cn.escheduler.alert.manager;
+
+import cn.escheduler.alert.utils.Constants;
+import cn.escheduler.alert.utils.EnterpriseWeChatUtils;
+import cn.escheduler.dao.model.Alert;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Enterprise WeChat Manager
+ */
+public class EnterpriseWeChatManager {
+    private static final Logger logger = LoggerFactory.getLogger(MsgManager.class);
+    /**
+     * Enterprise We Chat send
+     * @param alert
+     */
+    public Map<String,Object> send(Alert alert, String token){
+        Map<String,Object> retMap = new HashMap<>();
+        retMap.put(Constants.STATUS, false);
+        String agentId = EnterpriseWeChatUtils.enterpriseWeChatAgentId;
+        String users = EnterpriseWeChatUtils.enterpriseWeChatUsers;
+        List<String> userList = Arrays.asList(users.split(","));
+        logger.info("send message {}",alert);
+        String msg = EnterpriseWeChatUtils.makeUserSendMsg(userList, agentId,EnterpriseWeChatUtils.markdownByAlert(alert));
+        try {
+            EnterpriseWeChatUtils.sendEnterpriseWeChat(Constants.UTF_8, msg, token);
+        } catch (IOException e) {
+            logger.error(e.getMessage(),e);
+        }
+        retMap.put(Constants.STATUS, true);
+        return retMap;
+    }
+
+}

escheduler-alert/src/main/java/cn/escheduler/alert/runner/AlertSender.java

@@ -17,7 +17,9 @@
 package cn.escheduler.alert.runner;
 
 import cn.escheduler.alert.manager.EmailManager;
+import cn.escheduler.alert.manager.EnterpriseWeChatManager;
 import cn.escheduler.alert.utils.Constants;
+import cn.escheduler.alert.utils.EnterpriseWeChatUtils;
 import cn.escheduler.common.enums.AlertStatus;
 import cn.escheduler.common.enums.AlertType;
 import cn.escheduler.dao.AlertDao;
@@ -40,6 +42,7 @@ public class AlertSender{
     private static final Logger logger = LoggerFactory.getLogger(AlertSender.class);
 
     private static final EmailManager emailManager= new EmailManager();
+    private static final EnterpriseWeChatManager weChatManager= new EnterpriseWeChatManager();
 
 
     private List<Alert> alertList;
@@ -109,6 +112,12 @@ public class AlertSender{
             if (flag){
                 alertDao.updateAlert(AlertStatus.EXECUTION_SUCCESS, "execution success", alert.getId());
                 logger.info("alert send success");
+                try {
+                    String token = EnterpriseWeChatUtils.getToken();
+                    weChatManager.send(alert,token);
+                } catch (Exception e) {
+                    logger.error(e.getMessage(),e);
+                }
             }else {
                 alertDao.updateAlert(AlertStatus.EXECUTION_FAILURE,String.valueOf(retMaps.get(Constants.MESSAGE)),alert.getId());
                 logger.info("alert send error : {}" , String.valueOf(retMaps.get(Constants.MESSAGE)));

escheduler-alert/src/main/java/cn/escheduler/alert/utils/Constants.java

@@ -129,6 +129,10 @@ public class Constants {
 
     public static final int ALERT_SCAN_INTERVEL = 5000;
 
+    public static final String MARKDOWN_QUOTE = ">";
+
+    public static final String MARKDOWN_ENTER = "\n";
+
     public static final String ENTERPRISE_WECHAT_CORP_ID = "enterprise.wechat.corp.id";
 
     public static final String ENTERPRISE_WECHAT_SECRET = "enterprise.wechat.secret";
@@ -140,4 +144,8 @@ public class Constants {
     public static final String ENTERPRISE_WECHAT_TEAM_SEND_MSG = "enterprise.wechat.team.send.msg";
 
     public static final String ENTERPRISE_WECHAT_USER_SEND_MSG = "enterprise.wechat.user.send.msg";
+
+    public static final String ENTERPRISE_WECHAT_AGENT_ID = "enterprise.wechat.agent.id";
+
+    public static final String ENTERPRISE_WECHAT_USERS = "enterprise.wechat.users";
 }

escheduler-alert/src/main/java/cn/escheduler/alert/utils/EnterpriseWeChatUtils.java

@@ -16,9 +16,12 @@
  */
 package cn.escheduler.alert.utils;
 
+import cn.escheduler.common.enums.ShowType;
+import cn.escheduler.dao.model.Alert;
 import com.alibaba.fastjson.JSON;
 
 import com.google.common.reflect.TypeToken;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.http.HttpEntity;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpGet;
@@ -31,13 +34,12 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
-import java.util.Collection;
-import java.util.Map;
+import java.util.*;
 
 import static cn.escheduler.alert.utils.PropertyUtils.getString;
 
 /**
- * qiye weixin utils
+ * Enterprise WeChat utils
  */
 public class EnterpriseWeChatUtils {
 
@@ -48,7 +50,7 @@ public class EnterpriseWeChatUtils {
     private static final String enterpriseWeChatSecret = getString(Constants.ENTERPRISE_WECHAT_SECRET);
 
     private static final String enterpriseWeChatTokenUrl = getString(Constants.ENTERPRISE_WECHAT_TOKEN_URL);
-    private String enterpriseWeChatTokenUrlReplace = enterpriseWeChatTokenUrl
+    private static String enterpriseWeChatTokenUrlReplace = enterpriseWeChatTokenUrl
             .replaceAll("\\$corpId", enterpriseWeChatCorpId)
             .replaceAll("\\$secret", enterpriseWeChatSecret);
 
@@ -58,12 +60,16 @@ public class EnterpriseWeChatUtils {
 
     private static final String enterpriseWeChatUserSendMsg = getString(Constants.ENTERPRISE_WECHAT_USER_SEND_MSG);
 
+    public static final String enterpriseWeChatAgentId = getString(Constants.ENTERPRISE_WECHAT_AGENT_ID);
+
+    public static final String enterpriseWeChatUsers = getString(Constants.ENTERPRISE_WECHAT_USERS);
+
     /**
-     * get winxin token info
+     * get Enterprise WeChat token info
      * @return token string info
      * @throws IOException
      */
-    public String getToken() throws IOException {
+    public static String getToken() throws IOException {
         String resp;
 
         CloseableHttpClient httpClient = HttpClients.createDefault();
@@ -71,7 +77,7 @@ public class EnterpriseWeChatUtils {
         CloseableHttpResponse response = httpClient.execute(httpGet);
         try {
             HttpEntity entity = response.getEntity();
-            resp = EntityUtils.toString(entity, "utf-8");
+            resp = EntityUtils.toString(entity, Constants.UTF_8);
             EntityUtils.consume(entity);
         } finally {
             response.close();
@@ -84,26 +90,26 @@ public class EnterpriseWeChatUtils {
     }
 
     /**
-     * make team single weixin message
+     * make team single Enterprise WeChat message
      * @param toParty
      * @param agentId
      * @param msg
-     * @return weixin send message
+     * @return Enterprise WeChat send message
      */
-    public String makeTeamSendMsg(String toParty, String agentId, String msg) {
+    public static String makeTeamSendMsg(String toParty, String agentId, String msg) {
         return enterpriseWeChatTeamSendMsg.replaceAll("\\$toParty", toParty)
                 .replaceAll("\\$agentId", agentId)
                 .replaceAll("\\$msg", msg);
     }
 
     /**
-     * make team multi weixin message
+     * make team multi Enterprise WeChat message
      * @param toParty
      * @param agentId
      * @param msg
-     * @return weixin send message
+     * @return Enterprise WeChat send message
      */
-    public String makeTeamSendMsg(Collection<String> toParty, String agentId, String msg) {
+    public static String makeTeamSendMsg(Collection<String> toParty, String agentId, String msg) {
         String listParty = FuncUtils.mkString(toParty, "|");
         return enterpriseWeChatTeamSendMsg.replaceAll("\\$toParty", listParty)
                 .replaceAll("\\$agentId", agentId)
@@ -115,9 +121,9 @@ public class EnterpriseWeChatUtils {
      * @param toUser
      * @param agentId
      * @param msg
-     * @return weixin send message
+     * @return Enterprise WeChat send message
      */
-    public String makeUserSendMsg(String toUser, String agentId, String msg) {
+    public static String makeUserSendMsg(String toUser, String agentId, String msg) {
         return enterpriseWeChatUserSendMsg.replaceAll("\\$toUser", toUser)
                 .replaceAll("\\$agentId", agentId)
                 .replaceAll("\\$msg", msg);
@@ -128,9 +134,9 @@ public class EnterpriseWeChatUtils {
      * @param toUser
      * @param agentId
      * @param msg
-     * @return weixin send message
+     * @return Enterprise WeChat send message
      */
-    public String makeUserSendMsg(Collection<String> toUser, String agentId, String msg) {
+    public static String makeUserSendMsg(Collection<String> toUser, String agentId, String msg) {
         String listUser = FuncUtils.mkString(toUser, "|");
         return enterpriseWeChatUserSendMsg.replaceAll("\\$toUser", listUser)
                 .replaceAll("\\$agentId", agentId)
@@ -138,14 +144,14 @@ public class EnterpriseWeChatUtils {
     }
 
     /**
-     * send weixin
+     * send Enterprise WeChat
      * @param charset
      * @param data
      * @param token
-     * @return weixin resp, demo: {"errcode":0,"errmsg":"ok","invaliduser":""}
+     * @return Enterprise WeChat resp, demo: {"errcode":0,"errmsg":"ok","invaliduser":""}
      * @throws IOException
      */
-    public String sendQiyeWeixin(String charset, String data, String token) throws IOException {
+    public static String sendEnterpriseWeChat(String charset, String data, String token) throws IOException {
         String enterpriseWeChatPushUrlReplace = enterpriseWeChatPushUrl.replaceAll("\\$token", token);
 
         CloseableHttpClient httpclient = HttpClients.createDefault();
@@ -160,8 +166,83 @@ public class EnterpriseWeChatUtils {
         } finally {
             response.close();
         }
-        logger.info("qiye weixin send [{}], param:{}, resp:{}", enterpriseWeChatPushUrl, data, resp);
+        logger.info("Enterprise WeChat send [{}], param:{}, resp:{}", enterpriseWeChatPushUrl, data, resp);
         return resp;
     }
 
+    /**
+     * convert table to markdown style
+     * @param title
+     * @param content
+     * @return
+     */
+    public static String markdownTable(String title,String content){
+        List<LinkedHashMap> mapItemsList = JSONUtils.toList(content, LinkedHashMap.class);
+        StringBuilder contents = new StringBuilder(200);
+        for (LinkedHashMap mapItems : mapItemsList){
+
+            Set<Map.Entry<String, String>> entries = mapItems.entrySet();
+
+            Iterator<Map.Entry<String, String>> iterator = entries.iterator();
+
+            StringBuilder t = new StringBuilder(String.format("`%s`%s",title,Constants.MARKDOWN_ENTER));
+            while (iterator.hasNext()){
+
+                Map.Entry<String, String> entry = iterator.next();
+                t.append(Constants.MARKDOWN_QUOTE);
+                t.append(entry.getKey()).append(":").append(entry.getValue());
+                t.append(Constants.MARKDOWN_ENTER);
+            }
+
+            contents.append(t);
+        }
+        return contents.toString();
+    }
+
+    /**
+     * convert text to markdown style
+     * @param title
+     * @param content
+     * @return
+     */
+    public static String markdownText(String title,String content){
+        if (StringUtils.isNotEmpty(content)){
+            List<String> list;
+            try {
+                list = JSONUtils.toList(content,String.class);
+            }catch (Exception e){
+                logger.error("json format exception",e);
+                return null;
+            }
+
+            StringBuilder contents = new StringBuilder(100);
+            contents.append(String.format("`%s`\n",title));
+            for (String str : list){
+                contents.append(Constants.MARKDOWN_QUOTE);
+                contents.append(str);
+                contents.append(Constants.MARKDOWN_ENTER);
+            }
+
+            return contents.toString();
+
+        }
+        return null;
+    }
+
+    /**
+     * Determine the mardown style based on the show type of the alert
+     * @param alert
+     * @return
+     */
+    public static String markdownByAlert(Alert alert){
+        String result = "";
+        if (alert.getShowType() == ShowType.TABLE) {
+            result = markdownTable(alert.getTitle(),alert.getContent());
+        }else if(alert.getShowType() == ShowType.TEXT){
+            result = markdownText(alert.getTitle(),alert.getContent());
+        }
+        return result;
+
+    }
+
 }

escheduler-alert/src/main/resources/alert.properties

@@ -19,10 +19,12 @@ xls.file.path=/tmp/xls
 # Enterprise WeChat configuration
 enterprise.wechat.corp.id=xxxxxxx
 enterprise.wechat.secret=xxxxxxx
+enterprise.wechat.agent.id=xxxxxxx
+enterprise.wechat.users=xxxxxxx
 enterprise.wechat.token.url=https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=$corpId&corpsecret=$secret
 enterprise.wechat.push.url=https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=$token
 enterprise.wechat.team.send.msg={\"toparty\":\"$toParty\",\"agentid\":\"$agentId\",\"msgtype\":\"text\",\"text\":{\"content\":\"$msg\"},\"safe\":\"0\"}
-enterprise.wechat.user.send.msg={\"touser\":\"$toUser\",\"agentid\":\"$agentId\",\"msgtype\":\"text\",\"text\":{\"content\":\"$msg\"},\"safe\":\"0\"}
+enterprise.wechat.user.send.msg={\"touser\":\"$toUser\",\"agentid\":\"$agentId\",\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"$msg\"}}