Merge pull request #88 from takayama-lily/dev

-

Author: takayama-lily

client.js

@@ -149,7 +149,6 @@ class AndroidClient extends Client {
 
         this.on("error", (err)=>{
             this.logger.error(err.message);
-            this.status = Client.INIT;
         });
         this.on("close", (e_flag)=>{
             this.read();

docs/project.md

@@ -65,24 +65,32 @@
 
 ----
 
+## 什么是CQ码？
+
+CQ码是指字符串格式下用于表示多媒体内容的方式，形如：  
+`[CQ:image,file=123.jpg]`  
+`[CQ:at,qq=123456]`  
+常用的有at、表情、图片、语音、音乐、分享等。  
+因此混在字符串中的CQ码，以下字符会被转义：`[]&,`
+推荐使用数组格式的消息链，可以避免转义操作。
+
 |[CQ码]|收|发|说明|
 |-|-|-|-|
-|at|◯|◯|[CQ:at,qq=123456,text=@ABC] text用来定义@不到时的输出|
-|face|◯|◯|表情，[CQ:face,id=104]
-|sface|◯|◯|小表情(HD协议不支持)，[CQ:sface,id=271,text=/吃瓜]|
+|at|◯|◯|[CQ:at,qq=123456,text=@ABC,dummy=0]<br>text用来定义@不到时的输出<br>dummy设为1可以假@|
+|face|◯|◯|[CQ:face,id=104]
+|sface|◯|◯|此表情HD协议不支持，[CQ:sface,id=271,text=/吃瓜]|
 |bface|◯|◯|原创表情，[CQ:bface,file=xxxxxxxx,text=摸头]|
-|dice&rps|◯|◯|魔法表情骰子和猜拳：<br>[CQ:dice,id=1] ※id=1-6 不填则随机<br>[CQ:rps,id=1] ※id=1-3 分别对应1石头2剪刀3布|
+|dice&rps|◯|◯|骰子和猜拳：<br>[CQ:dice,id=1]<br>[CQ:rps,id=1]|
 |image|◯|◯|参考 [图片](https://github.com/howmanybots/onebot/blob/master/v11/specs/message/segment.md#%E5%9B%BE%E7%89%87)|
 |record|◯|◯|语音，写法同image<br>支持任何格式的音频自动转amr(必须将 [ffmpeg](http://ffmpeg.org/download.html) 加入环境变量path)<br>linux下的ffmpeg不自带amr解码器，可能需要自行编译ffmpeg|
 |flash|◯|◯|闪照，写法同image|
 |anonymous||◯|发匿名，[CQ:anonymous,ignore=1]<br>ignore可省略，为0时匿名失败不发送|
-|notice|◯|✕|群公告，[CQ:notice,title=群公告,content=xxxxxx]|
-|file|◯|✕|群文件，[CQ:file,url=xxxxxx,size=123456,md5=xxxxxx,duration=0,name=xxxxxx]|
+|notice|◯||群公告|
+|file|◯||群文件|
 |music|✕|✕|
 |video|✕|✕|
 |location|◯|◯|[CQ:location,address=江西省九江市修水县,lat=29.063940,lng=114.339610]|
-|contact|✕|✕|
-|anonymous|✕|✕|
+|contact|◯|✕|联系人或群推荐
 |reply|✕|✕|
-|share|✕|✕|
+|share|◯|◯|链接分享
 |<s>node</s>|✕|◯|<s>[CQ:node,uin=123456789,name=昵称,content=消息内容,time=时间戳]<br>time可省略，暂时只支持纯文本/s>|

lib/common.js

@@ -62,11 +62,20 @@ function uin2code(groupUin) {
     return left * 1000000 + groupUin % 1000000;
 }
 
+function escapeXml(xml) {
+    return xml.replace(/[&"><]/g, function(s) {
+        if (s === "&") return "&amp;";
+        if (s === "<") return "&lt;";
+        if (s === ">") return "&gt;";
+        if (s === '"') return "&quot;";
+    });
+}
+
 function log(any) {
     console.log(util.inspect(any, {depth: 20, showHidden: false, maxArrayLength: 1000, maxStringLength: 5000}));
 }
 
 module.exports = {
     uuid, md5, timestamp, checkUin, uinAutoCheck,
-    log, code2uin, uin2code,
+    log, code2uin, uin2code, escapeXml
 };