m8-framework-mcp 1.0.0

package/docs/ejs-doc/404/404.html

@@ -0,0 +1,9 @@
+<h1>404 NOT_FOUND</h1>
+
+<div class="alert alert-danger">
+    <p>很抱歉，该资源不存在，如有必要请邮件给文档维护人：戴荔春（6016）—— 移动研发部。</p>
+</div>
+
+<div class="alert alert-info">
+    <p>如果你是文档编写者，并且是本地访问环境，即localhost，可前往<a href="/fedoc/tools/mdeditor/mdeditor.php">markdown在线编辑</a>。</p>
+</div>

package/docs/ejs-doc/_draft/sha1_salt.md

@@ -0,0 +1,47 @@
+## 加盐的简单介绍
+
+加盐是为了提高密码的安全级别而采取的方案，这里仅仅作为拓展了解即可
+
+参考 [加盐密码哈希：如何正确使用](http://blog.jobbole.com/61872/)
+
+__什么是加盐？__
+
+服务器端给每一个用户都存一个不同的`salt`值，这个值随机生成，并且很长(可以认为和`hash`后的长度相当)
+
+服务器端存在数据库的用户密码是`hash(password + salt)`
+
+__加盐的作用__
+
+提供安全等级，增加破解成本
+
+因为盐值的关系，密码的哈希值被随机化了，因此使的`查表法`，`反向查表法`，`彩虹表`都不再生效
+
+注意，请区分加盐后加密，加盐的作用是防范上述的撞库攻击，而加密是确保数据抓包后无法被直接使用
+
+### 如何加盐
+
+__密码存储步骤__
+
+- 服务端随机生成一个长度足够的`salt`
+
+- 将盐值混入密码(比如直接追加到密码后方)，并用`hash`计算
+
+- 将`hash值`和`salt`都存入用户数据库
+
+__密码匹配步骤__
+
+- 客户端和服务端建立安全连接(如https，或者加密手段，要确保直接抓包拿到的数据无法使用)
+
+- 客户端从服务端拿到盐值(一般基于用户名去拿，但是当用户名不存在时最好是给一个错误盐值，而不是提示用户名不存在，这样可以增加破解难度)
+
+- 客户端将`salt`混入用户的密码，并用`hash`计算，发送到服务端
+
+- 服务端从数据库取出用户的密码哈希值
+
+- 匹配两种是否相等，匹配成功才代表密码正确
+
+__更多__
+
+加盐做的仅仅是提高安全级别
+
+一般情况下，如果不是那些银行，商城等安全级别要求很高的系统，`hash` + `salt`形式已经满足要求了

package/docs/ejs-doc/_include/config.php

@@ -0,0 +1,10 @@
+<?php
+// 全局配置
+$config = [
+    // 文档根目录
+    'root' => 'ejs4mpdoc',
+    // 文档标题
+    'title' => 'EJS 4.x在线文档',
+    // 文档描述
+    'description' => '本文档由【前端研究中心-前端研发1部】维护'
+];

package/docs/ejs-doc/_include/cssboot.inc.php

@@ -0,0 +1,62 @@
+<?php include 'config.php' ?>
+
+<script>
+// 通用前缀
+var ROOT_DIR = '<?php echo $config["root"] ?>',
+	BASE_PATH = '/' + ROOT_DIR;
+
+var SrcBoot = {
+	// 先以天为缓存周期吧
+	_timeStamp: (function() {
+		var d = new Date();
+
+		return ('' + d.getFullYear() + (d.getMonth() + 1) + d.getDate());
+	})(),
+
+	// 获取资源全路径
+	getPath: function(path) {
+		// 是否是相对路径
+		var isRelative = path.indexOf('./') != -1 || path.indexOf('../') != -1;
+
+		path = (isRelative ? '' :  (BASE_PATH + '/')) + path;
+
+		return path;
+	},
+
+	getExt: function(path) {
+		var dotPos = path.lastIndexOf('.'),
+			ext = path.substring(dotPos + 1);
+
+		return ext;
+	},
+
+	// 批量输出css|js
+	output: function(arr) {
+		var i = 0,
+			len = arr.length,
+			path,
+			ext;
+
+		for(; i < len; i++) {
+			path = this.getPath(arr[i]);
+			ext = this.getExt(path);
+
+			path += ('?_=' + this._timeStamp);
+
+			if(ext == 'js') {
+				document.writeln('<sc' + 'ript src="' + path + '"></sc' + 'ript>');
+			} else {
+				document.writeln('<link rel="stylesheet" href="' + path + '">');
+			}
+		}
+	}
+};
+
+// 从BASE_PATH开始
+SrcBoot.output([
+	'js/bootstrap/css/bootstrap.min.css',
+	// 代码高亮
+	'js/widgets/prism/themes/prism.css',
+	'css/common.css'
+]);
+</script>

package/docs/ejs-doc/_include/jsboot.inc.php

@@ -0,0 +1,7 @@
+<script>
+SrcBoot.output([
+    'js/libs/jquery.min.js',
+    'js/libs/handlebars.min.js',
+    'js/common.js'
+]);
+</script>

package/docs/ejs-doc/api_app/api_app.md

@@ -0,0 +1,43 @@
+# 小程序生命周期
+
+## app
+
+小程序生命周期事件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 不支持        |    支持(4.0.0)    | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**注意**
+
+H5 或其他小程序平台，可以使用 uniapp 新增的生命周期选项: [生命周期](https://uniapp.dcloud.io/tutorial/page.html#lifecycle)
+
+**使用示例**
+
+```js
+ejs.app({
+    onLaunch: function () {
+        console.log('小程序启动了');
+    },
+    onShow: function () {
+        console.log('页面显示了');
+    },
+    onHide: function () {
+        console.log('页面隐藏了');
+    },
+    onClose: function () {
+        console.log('关闭小程序');
+    }
+});
+```
+
+**参数说明**
+
+| 参数     | 参数类型 | 说明               |
+| :------- | :------: | :----------------- |
+| onLaunch | Function | 小程序打开时触发   |
+| onShow   | Function | 当页面显示时触发   |
+| onHide   | Function | 当页面隐藏时触发   |
+| onClose  | Function | 当关闭小程序时触发 |

package/docs/ejs-doc/api_audio/api_audio.md

@@ -0,0 +1,225 @@
+# ejs.audio
+
+## startRecord
+
+开始录制音频
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持（3.1.2） |   支持（3.1.2）   | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.audio.startRecord({
+    minDuration: 1,
+    maxDuration: 120,
+    folderPath: '',
+    fileName: '',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数        |    参数类型     | 说明                                                            | 平台差异说明                                |
+| :---------- | :-------------: | :-------------------------------------------------------------- | :------------------------------------------ |
+| minDuration | Number / String | 最小允许可录制时长，默认为`1`，单位秒                           | EJS`3.4.0`开始支持，其他平台不支持          |
+| maxDuration | Number / String | 最大允许可录制时长，默认为`120`，单位秒，EJS-iOS 不支持默认时长 |                                             |
+| folderPath  |     String      | 音频根目录，不传递则有默认的音频存储根目                        | 仅 EJS`3.4.0`开始支持，EJS-iOS 不支持该参数 |
+| fileName    |     String      | 音频文件名， 不传递则使用默认的音频文件                         | 仅 EJS`3.4.0`开始支持，EJS-iOS 不支持该参数 |
+
+## stopRecord
+
+停止录制音频，并返回结果
+
+请在`maxDuration`之前停止
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持（3.1.2） |   支持（3.1.2）   | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.audio.stopRecord({
+    success: function (result) {
+        /**
+         * 选择文件后返回
+         * {
+                duration: 3,
+                path: '/storage/emulated/0/com.epoint.workplatform/kfld/Temp/1513243453523.amr',
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**返回说明**
+
+| 参数     | 参数类型 | 说明               | 平台差异说明 |
+| :------- | :------: | :----------------- | :----------- |
+| duration |  String  | 录音的时长，单位 s |              |
+| path     |  String  | 录音的完整本地路径 |              |
+
+## pauseRecord
+
+暂停录音
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 不支持        |      不支持       | 不支持 | 不支持 | 支持       | 不支持       |
+
+**使用示例**
+
+```js
+ejs.audio.pauseRecord({
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+## resumeRecord
+
+继续录音
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 不支持        |      不支持       | 不支持 | 不支持 | 支持       | 不支持       |
+
+**使用示例**
+
+```js
+ejs.audio.resumeRecord({
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+## cancelRecord
+
+取消正在进行的音频录制
+
+取消后会销毁文件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持（3.1.2） |   支持（3.1.2）   | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.audio.cancelRecord({
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+## startPlay
+
+播放音频文件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持（3.1.2） |   支持（3.1.2）   | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.audio.startPlay({
+    path: '/storage/emulated/0/com.epoint.workplatform/kfld/Temp/1513243453523.amr',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数 | 参数类型 | 说明                       |
+| :--- | :------: | :------------------------- |
+| path |  String  | `必填`，需要播放的文件路径 |
+
+## stopPlay
+
+停止播放音频文件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持（3.1.2） |   支持（3.1.2）   | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.audio.stopPlay({
+    // path: '/storage/emulated/0/com.epoint.workplatform/kfld/Temp/1513243453523.amr',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数 | 参数类型 | 说明                   | 平台差异说明                                |
+| :--- | :------: | :--------------------- | :------------------------------------------ |
+| path |  String  | 需要停止播放的文件路径 | EJS `3.4.0`后不需要填写，其他平台不需要填写 |
+
+## pausePlay
+
+暂停播放音频文件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 不支持        |      不支持       | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.audio.pausePlay({
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+## seek
+
+跳转音频至第几秒
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 不支持        |      不支持       | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.audio.seek({
+    position: 2,
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数     |    参数类型     | 说明                       | 平台差异说明 |
+| :------- | :-------------: | :------------------------- | :----------- |
+| position | Number / String | 跳转到音频某个位置，单位秒 |              |

package/docs/ejs-doc/api_auth/api_auth.md

@@ -0,0 +1,256 @@
+# ejs.auth
+
+## getToken
+
+获取`token`，标准接口需要`token`才能正常请求
+
+如果是使用的公司开发框架，`ajax`请求中自动带了`token`，无需关心
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持          |       支持        | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.getToken({
+    success: function (result) {
+        /**
+         * {
+                access_token: ''
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**返回说明**
+
+| 参数         | 参数类型 | 说明                                                                   |
+| :----------- | :------: | :--------------------------------------------------------------------- |
+| access_token |  String  | 对应的`token`，必须登录后才会有，`token`的刷新由原始容器进行，无需关心 |
+
+## refreshToken
+
+刷新`token`API
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持          |       支持        | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.refreshToken({
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数         |    参数类型     | 说明                                                                                                                          |
+| :----------- | :-------------: | :---------------------------------------------------------------------------------------------------------------------------- |
+| isForce      | Number / String | 是否强制刷新 token，默认超出 expires_in 过期时间后才会刷新，如果要强制刷新传 1。iOS（ejs > `3.4.0`） 支持；`Android` 默认支持 |
+| isAutoLogout | Number / String | refreshToken 过期后是否自动退出登录，默认会自动退出，如果不自动退出则传 0。iOS（ejs > `3.4.0`） 支持；`Android` 默认支持      |
+
+## getUserInfo
+
+获取当前登陆用户信息
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持          |       支持        | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.getUserInfo({
+    success: function (result) {
+        /**
+         * {
+            userInfo: '{...}'
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**返回说明**
+
+`userInfo` 是一个 JSON 格式的字符串，包含当前登录用户的信息。以下是 JSON.parse()解析 `userInfo` 后所得到的用户信息对象的属性说明：
+
+| 参数             | 参数类型 | 说明                   |
+| :--------------- | :------: | :--------------------- |
+| displayname      |  String  | 用户姓名               |
+| ouguid           |  String  | 部门标识               |
+| baseouname       |  String  | 独立部门名称           |
+| baseouguid       |  String  | 独立部门标识           |
+| ccworksequenceid |  String  | 新版即时通讯账号       |
+| loginid          |  String  | 登录名                 |
+| forcemodifypwd   |  String  | 是否需要强制修改密码   |
+| oaversion        |  String  | 返回业务系统的 oa 版本 |
+| userguid         |  String  | 用户标识               |
+| previewurl       |  String  | 文件在线预览地址       |
+| complexpassword  |  String  | 密码复杂度规则         |
+| usersignpicture  |  String  | 用户签名图片地址       |
+| photourl         |  String  | 用户个人头像地址       |
+| ouname           |  String  | 部门名称               |
+| sequenceid       |  String  | 用户微消息帐号         |
+
+## refreshUserInfo
+
+更新原生本地的用户信息，并返回新的用户信息
+
+**平台差异**
+
+| ejs（H5 应用)   | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :-------------- | :---------------: | :----: | :----- | :--------- | :----------- |
+| `>= 4.2.3 `支持 | `>= V2.0.2` 支持  | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.refreshUserInfo({
+    success: function (result) {
+        /**
+         * {
+            userInfo: {
+                ...
+            }
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**返回说明**
+
+| 参数     | 参数类型 | 说明                   |
+| :------- | :------: | :--------------------- |
+| userInfo |  Object  | 对应的当前登录用户信息 |
+
+## getAuthCode
+
+获取用户授权码(只有在需要鉴权的项目中需要用到)
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持          |       支持        | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.getAuthCode({
+    success: function (result) {
+        /**
+         * {
+            authCode: ''
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**返回说明**
+
+| 参数     | 参数类型 | 说明       |
+| :------- | :------: | :--------- |
+| authCode |  String  | 用户授权码 |
+
+## getUserAuthCode
+
+调用框架接口获取 `authcode`，H5 应用下需要鉴权后使用
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持          |       支持        | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.getUserAuthCode({
+    appkey: '应用的appkey',
+    success: function (result) {
+        /**
+         * {
+            authcode: ''
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数   | 参数类型 | 说明           |
+| :----- | :------: | :------------- |
+| appkey |  String  | 应用的`appkey` |
+
+**返回说明**
+
+| 参数     | 参数类型 | 说明       |
+| :------- | :------: | :--------- |
+| authcode |  String  | 用户授权码 |
+
+## logoutUserWithAlert
+
+退出当前用户至登录页面
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持（3.5.0） |    支持(3.5.0)    | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.logoutUserWithAlert({
+    title: '提示',
+    message: '请重新登录',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数    | 参数类型 | 说明     |
+| :------ | :------: | :------- |
+| title   |  String  | 提示标题 |
+| message |  String  | 提示内容 |
+
+## logout
+
+退出当前用户至登录页面，无 UI 提示
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持（4.1.9） |    支持(4.1.9)    | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.auth.logout({
+    success: function (result) {},
+    error: function (error) {}
+});
+```