Code coverage report for wechat-enterprise/lib/wechat-enterprise.js

Statements: 93.37% (169 / 181)      Branches: 83.82% (57 / 68)      Functions: 96.67% (29 / 30)      Lines: 93.37% (169 / 181)      Ignored: none     

All files » wechat-enterprise/lib/ » wechat-enterprise.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 4122 2 2 2 2         2                                                                                                       2   2             2   2 23 23 22   23 22   23           2 37 37 36 175 175 175     175             37           2 25 25 25 25 1 24 7 6 6   1     25 25 25 25 25     2 8 18 18   18 16   16     16 16 16 16 16 16 16     18   18 7 7 7 2 1   1         7 5         18 4   14       18 16 16 16 16 16 16 15       16 3 3 2 2   1 1 1 1 1         16 1 1     16 16 4 4   12   16     2                                     2 8 8 8                                 2 15 15     2 14 15               2 18               2 8 8 8 8   8 23 23 23 23   23 2 2 1 1 1   1   1 1 21 21 21     21 21 1 1 1   20 20 1 1   19 19 19 1 1 1   18 18 18         18 18 18       18 18                                                                                       2 8 1     7 7 4 4   3         2 14 4       2 2 2 2   2  
var xml2js = require('xml2js');
var ejs = require('ejs');
var Session = require('./session');
var List = require('./list');
var WXBizMsgCrypt = require('./msg_crypto');
 
/*!
 * 响应模版
 */
var tpl = ['<xml>',
    '<ToUserName><![CDATA[<%-toUsername%>]]></ToUserName>',
    '<FromUserName><![CDATA[<%-fromUsername%>]]></FromUserName>',
    '<CreateTime><%=createTime%></CreateTime>',
    '<MsgType><![CDATA[<%=msgType%>]]></MsgType>',
  '<% if (msgType === "news") { %>',
    '<ArticleCount><%=content.length%></ArticleCount>',
    '<Articles>',
    '<% content.forEach(function(item){ %>',
      '<item>',
        '<Title><![CDATA[<%-item.title%>]]></Title>',
        '<Description><![CDATA[<%-item.description%>]]></Description>',
        '<PicUrl><![CDATA[<%-item.picUrl || item.picurl || item.pic %>]]></PicUrl>',
        '<Url><![CDATA[<%-item.url%>]]></Url>',
      '</item>',
    '<% }); %>',
    '</Articles>',
  '<% } else if (msgType === "music") { %>',
    '<Music>',
      '<Title><![CDATA[<%-content.title%>]]></Title>',
      '<Description><![CDATA[<%-content.description%>]]></Description>',
      '<MusicUrl><![CDATA[<%-content.musicUrl || content.url %>]]></MusicUrl>',
      '<HQMusicUrl><![CDATA[<%-content.hqMusicUrl || content.hqUrl %>]]></HQMusicUrl>',
    '</Music>',
  '<% } else if (msgType === "voice") { %>',
    '<Voice>',
      '<MediaId><![CDATA[<%-content.mediaId%>]]></MediaId>',
    '</Voice>',
  '<% } else if (msgType === "image") { %>',
    '<Image>',
      '<MediaId><![CDATA[<%-content.mediaId%>]]></MediaId>',
    '</Image>',
  '<% } else if (msgType === "video") { %>',
    '<Video>',
      '<MediaId><![CDATA[<%-content.mediaId%>]]></MediaId>',
      '<Title><![CDATA[<%-content.title%>]]></Title>',
      '<Description><![CDATA[<%-content.description%>]]></Description>',
    '</Video>',
  '<% } else if (msgType === "transfer_customer_service") { %>',
    '<% if (content && content.kfAccount) { %>',
      '<TransInfo>',
        '<KfAccount><![CDATA[<%-content.kfAccount%>]]></KfAccount>',
      '</TransInfo>',
    '<% } %>',
  '<% } else { %>',
    '<Content><![CDATA[<%-content%>]]></Content>',
  '<% } %>',
  '</xml>'].join('');
 
/*!
 * 编译过后的模版
 */
var compiled = ejs.compile(tpl);
 
var wrapTpl = '<xml>' +
  '<Encrypt><![CDATA[<%-encrypt%>]]></Encrypt>' +
  '<MsgSignature><![CDATA[<%-signature%>]]></MsgSignature>' +
  '<TimeStamp><%-timestamp%></TimeStamp>' +
  '<Nonce><![CDATA[<%-nonce%>]]></Nonce>' +
'</xml>';
 
var encryptWrap = ejs.compile(wrapTpl);
 
var load = function (stream, callback) {
  var buffers = [];
  stream.on('data', function (trunk) {
    buffers.push(trunk);
  });
  stream.on('end', function () {
    callback(null, Buffer.concat(buffers));
  });
  stream.once('error', callback);
};
 
/*!
 * 将xml2js解析出来的对象转换成直接可访问的对象
 */
var formatMessage = function (result) {
  var message = {};
  if (typeof result === 'object') {
    for (var key in result) {
      Eif (result[key].length === 1) {
        var val = result[key][0];
        Iif (typeof val === 'object') {
          message[key] = formatMessage(val);
        } else {
          message[key] = (val || '').trim();
        }
      } else {
        message = result[key].map(formatMessage);
      }
    }
  }
  return message;
};
 
/*!
 * 将回复消息封装成xml格式
 */
var reply = function (content, fromUsername, toUsername) {
  var info = {};
  var type = 'text';
  info.content = content || '';
  if (Array.isArray(content)) {
    type = 'news';
  } else if (typeof content === 'object') {
    if (content.hasOwnProperty('type')) {
      type = content.type;
      info.content = content.content;
    } else {
      type = 'music';
    }
  }
  info.msgType = type;
  info.createTime = new Date().getTime();
  info.toUsername = toUsername;
  info.fromUsername = fromUsername;
  return compiled(info);
};
 
var respond = function (handler) {
  return function (req, res, next) {
    var message = req.weixin;
    var callback = handler.getHandler(message.MsgType);
 
    res.reply = function (content) {
      res.writeHead(200);
      // 响应空字符串,用于响应慢的情况,避免微信重试
      Iif (!content) {
        return res.end();
      }
      var xml = reply(content, message.ToUserName, message.FromUserName);
      var wrap = {};
      wrap.encrypt = handler.cryptor.encrypt(xml);
      wrap.nonce = parseInt((Math.random() * 100000000000), 10);
      wrap.timestamp = new Date().getTime();
      wrap.signature = handler.cryptor.getSignature(wrap.timestamp, wrap.nonce, wrap.encrypt);
      res.end(encryptWrap(wrap));
    };
 
    var done = function () {
      // 如果session中有_wait标记
      if (message.MsgType === 'text' && req.wxsession && req.wxsession._wait) {
        var list = List.get(req.wxsession._wait);
        var handle = list.get(message.Content);
        var wrapper = function (message) {
          return handler.handle ? function(req, res) {
            res.reply(message);
          } : function (info, req, res) {
            res.reply(message);
          };
        };
 
        // 如果回复命中规则,则用预置的方法回复
        if (handle) {
          callback = typeof handle === 'string' ? wrapper(handle) : handle;
        }
      }
 
      // 兼容旧API
      if (handler.handle) {
        callback(req, res, next);
      } else {
        callback(message, req, res, next);
      }
    };
 
    if (req.sessionStore) {
      var storage = req.sessionStore;
      var _end = res.end;
      var openid = message.FromUserName + ':' + message.ToUserName;
      res.end = function () {
        _end.apply(res, arguments);
        if (req.wxsession) {
          req.wxsession.save();
        }
      };
      // 等待列表
      res.wait = function (name, callback) {
        var list = List.get(name);
        if (list) {
          req.wxsession._wait = name;
          res.reply(list.description);
        } else {
          var err = new Error('Undefined list: ' + name);
          err.name = 'UndefinedListError';
          res.writeHead(500);
          res.end(err.name);
          callback && callback(err);
        }
      };
 
      // 清除等待列表
      res.nowait = function () {
        delete req.wxsession._wait;
        res.reply.apply(res, arguments);
      };
 
      storage.get(openid, function (err, session) {
        if (!session) {
          req.wxsession = new Session(openid, req);
          req.wxsession.cookie = req.session.cookie;
        } else {
          req.wxsession = new Session(openid, req, session);
        }
        done();
      });
    } else {
      done();
    }
  };
};
 
/**
 * 微信自动回复平台的内部的Handler对象
 * @param {Object} config 企业号的开发者配置对象
 * @param {Function} handle handle对象
 *
 * config:
 * ```
 * {
 *   token: '',          // 公众平台上,开发者设置的Token
 *   encodingAESKey: '', // 公众平台上,开发者设置的EncodingAESKey
 *   corpId: '',         // 企业号的CorpId
 * }
 * ```
 */
var Handler = function (config, handle) {
  this.config = config;
  this.handlers = {};
  this.handle = handle;
};
 
/**
 * 设置handler对象
 * 按消息设置handler对象的快捷方式
 *
 * - `text(fn)`
 * - `image(fn)`
 * - `voice(fn)`
 * - `video(fn)`
 * - `location(fn)`
 * - `link(fn)`
 * - `event(fn)`
 * @param {String} type handler处理的消息类型
 * @param {Function} handle handle对象
 */
Handler.prototype.setHandler = function (type, fn) {
  this.handlers[type] = fn;
  return this;
};
 
['text', 'image', 'voice', 'video', 'location', 'link', 'event'].forEach(function (method) {
  Handler.prototype[method] = function (fn) {
    return this.setHandler(method, fn);
  };
});
 
/**
 * 根据消息类型取出handler对象
 * @param {String} type 消息类型
 */
Handler.prototype.getHandler = function (type) {
  return this.handle || this.handlers[type] || function (info, req, res, next) {
    next();
  };
};
 
/**
 * 根据Handler对象生成响应方法,并最终生成中间件函数
 */
Handler.prototype.middlewarify = function () {
  var that = this;
  var config = this.config;
  that.cryptor = new WXBizMsgCrypt(config.token, config.encodingAESKey, config.corpId);
  var _respond = respond(this);
 
  return function (req, res, next) {
    var method = req.method;
    var signature = req.query.msg_signature;
    var timestamp = req.query.timestamp;
    var nonce = req.query.nonce;
 
    if (method === 'GET') {
      var echostr = req.query.echostr;
      if (signature !== that.cryptor.getSignature(timestamp, nonce, echostr)) {
        res.writeHead(401);
        res.end('Invalid signature');
        return;
      }
      var result = that.cryptor.decrypt(echostr);
      // TODO 检查corpId的正确性
      res.writeHead(200);
      res.end(result.message);
    } else Eif (method === 'POST') {
      load(req, function (err, buf) {
        Iif (err) {
          return next(err);
        }
        var xml = buf.toString('utf-8');
        if (!xml) {
          var emptyErr = new Error('body is empty');
          emptyErr.name = 'Wechat';
          return next(emptyErr);
        }
        xml2js.parseString(xml, {trim: true}, function (err, result) {
          if (err) {
            err.name = 'BadMessage' + err.name;
            return next(err);
          }
          var xml = formatMessage(result.xml);
          var encryptMessage = xml.Encrypt;
          if (signature !== that.cryptor.getSignature(timestamp, nonce, encryptMessage)) {
            res.writeHead(401);
            res.end('Invalid signature');
            return;
          }
          var decrypted = that.cryptor.decrypt(encryptMessage);
          var messageWrapXml = decrypted.message;
          Iif (messageWrapXml === '') {
            res.writeHead(401);
            res.end('Invalid corpid');
            return;
          }
          req.weixin_xml = messageWrapXml;
          xml2js.parseString(messageWrapXml, {trim: true}, function (err, result) {
            Iif (err) {
              err.name = 'BadMessage' + err.name;
              return next(err);
            }
            req.weixin = formatMessage(result.xml);
            _respond(req, res, next);
          });
        });
      });
    } else {
      res.writeHead(501);
      res.end('Not Implemented');
    }
  };
};
 
/**
 * 根据口令
 *
 * Examples:
 * 使用wechat作为自动回复中间件的三种方式
 * ```
 * wechat(config, function (req, res, next) {});
 *
 * wechat(config, wechat.text(function (message, req, res, next) {
 *   // TODO
 * }).location(function (message, req, res, next) {
 *   // TODO
 * }));
 *
 * wechat(config)
 *   .text(function (message, req, res, next) {
 *     // TODO
 *   }).location(function (message, req, res, next) {
 *    // TODO
 *   }).middleware();
 * ```
 * 静态方法
 *
 * - `text`,处理文字推送的回调函数,接受参数为(text, req, res, next)。
 * - `image`,处理图片推送的回调函数,接受参数为(image, req, res, next)。
 * - `voice`,处理声音推送的回调函数,接受参数为(voice, req, res, next)。
 * - `video`,处理视频推送的回调函数,接受参数为(video, req, res, next)。
 * - `location`,处理位置推送的回调函数,接受参数为(location, req, res, next)。
 * - `link`,处理链接推送的回调函数,接受参数为(link, req, res, next)。
 * - `event`,处理事件推送的回调函数,接受参数为(event, req, res, next)。
 * @param {Object} config 企业号的开发者配置对象
 * @param {Function} handle 生成的回调函数,参见示例
 */
var middleware = function (config, handle) {
  if (arguments.length === 1) {
    return new Handler(config);
  }
 
  Eif (arguments.length === 2) {
    if (handle instanceof Handler) {
      handle.config = config;
      return handle.middlewarify();
    } else {
      return new Handler(config, handle).middlewarify();
    }
  }
};
 
['text', 'image', 'voice', 'video', 'location', 'link', 'event'].forEach(function (method) {
  middleware[method] = function (fn) {
    return (new Handler())[method](fn);
  };
});
 
middleware.reply = reply;
middleware.encryptWrap = encryptWrap;
middleware.toXML = compiled;
middleware.WXBizMsgCrypt = WXBizMsgCrypt;
 
module.exports = middleware;