commit cddd5eaacfd176ae11feff01d722888c8efe1266 Author: 茁壮成长 <2291200076@qq.com> Date: Sat Aug 7 00:54:13 2021 +0800 BTaDC Document diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cbfa684 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Coding Zhang + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..20e7de5 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# 背Ta单词 官方文档 + +这是背Ta单词官方文档的Git仓库。想要查看文档，请访问[https://docs.reciteword.com/](https://docs.reciteword.com/)。 + +本文档基于 *[docsify](https://docsify.js.org/#/)* 构建。 + +## 参与贡献 + +您可以通过 `Pull Request` 为我们做出贡献。 + +文档内容在 `docs/manual` 目录下，您无需搭建*docsify*环境即可直接修改，修改后提交 `Pull Request` 即可。 + +若您不会上述操作，也可直接将需要修改的文档链接及需要修改的内容发至邮箱：**admin@only4.work**，收到您的邮件后，我们会第一时间回复。 + +感谢您的支持！ + +背Ta单词团队 + +------ + + + +# BTaDC Documentation + +This is the Git repo for BTaDC documentation. To view the documentation, visit [https://docs.reciteword.com/](https://docs.reciteword.com/). + +Powered by *[docsify](https://docsify.js.org/#/)*. + +## Contributing + +You can contribute to us via `Pull Request`. + +The content of the document is in the `docs/manual`directory. You can modify it directly without setting up the *docsify* environment, and create a new `Pull Request` after the modification. + +If you do not know the steps, you can directly send url and the content you want to improve to **admin@only4.work**. We will reply in the first time. + +Thank you for your support! + +BTaDC team + diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/.keep b/docs/3. 接口文档/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/1. 简介.md b/docs/3. 接口文档/1. 简介.md new file mode 100644 index 0000000..2955f2e --- /dev/null +++ b/docs/3. 接口文档/1. 简介.md @@ -0,0 +1,13 @@ +为了应对各种各样的扩展需求，先提供统一接口供开发者使用。 + +接口分为`前端接口`和`后端接口`， +浏览器中运行的JavaScript脚本可以通过`前端接口`与服务器进行交流， +开发应用/插件时，PHP文件内可以使用`后端接口`获取或设置相关数据。 + +除公开数据外，涉及到用户相关操作`前端接口`均需要提供相关参数以验证用户是否登录，避免`前端接口`被滥用。 + +接口分为以下几类： +- 公开类，包括前台文章，浏览量，点赞量等无需用户登录即可调用 +- 数据写入类，表单提交调用，例如评论，点赞等 +- 用户账户类，用户登录状态下，对账户信息进行管理（读取、填写、修改、删除等） +- 管理员类，仅管理员可使用，包括网站全局配置（后台的一系列配置），例如网站标题，第三方统计，服务器环境查看（phpinfo）等。 \ No newline at end of file diff --git a/docs/3. 接口文档/2. 全局状态码.md b/docs/3. 接口文档/2. 全局状态码.md new file mode 100644 index 0000000..105502a --- /dev/null +++ b/docs/3. 接口文档/2. 全局状态码.md @@ -0,0 +1,82 @@ +# 权限相关 +> 版本：v1.0.0 +更新日期：2021.01.19 +前缀：000×× + +| 状态码 | 内容 | 提示消息 | 备注 | +| --- | --- | --- | --- | +| 00001 | 权限不足 | 权限不足 | 还未启用 | + + +# 登录相关 +> 版本：v1.0.3 +更新日期：2021.01.21 +前缀：100×× + +| 状态码 | 内容 | 提示消息 | 备注 | +| --- | --- | --- | --- | +| 10000 | 登录成功 | 登录成功 | | +| 10010 | 验证码输入错误 | 验证码输入错误，请重试 | | +| 10011 | 验证码已经失效 | 验证码已经失效，请重试 | | +| 10012 | 验证码未输入 | 验证码未输入 | | +| 10020 | 用户名或密码错误 | 用户名或密码错误 | 用户存在 | +| 10021 | 用户名未输入 | 用户名未输入 | | +| 10022 | 密码未输入 | 密码未输入 | | +| 10023 | 用户不存在 | 用户不存在 | | +| 10030 | 已登录帐号，但未确定是否为当前帐号 | 您已登录 | | +| 10031 | 已登录当前帐号 | 您已登录当前帐号，无需再次登录 | 基于安全性考虑，目前返回状态码更改为10030 | +| 10032 | 已登录其他帐号 | 当前登录帐号与您正在登录的账号不同，请先注销后再登录 | 基于安全性考虑，目前返回状态码更改为10030 | +| 10040 | 系统未知错误 | 系统未知错误 | | +| 10041 | 服务器原因登录失败 | 服务器原因登录失败 | | +| 10050 | 无效token | 页面过期啦，请刷新再试 | | +| 10051 | 无token | 页面过期啦，请刷新再试 | | + + +# 注册相关 +> 版本：v1.0.3 +更新日期：2021.01.20 +前缀：200×× + +| 状态码 | 内容 | 提示消息 | 备注 | +| --- | --- | --- | --- | +| 20000 | 注册成功 | 注册成功 | | +| 20010 | 验证码输入错误 | 验证码输入错误，请重试 | | +| 20011 | 验证码已经失效 | 验证码已经失效，请重试 | | +| 20012 | 验证码未输入 | 验证码未输入 | | +| 20020 | 用户名已存在 | 用户名已存在 | | +| 20021 | 用户名未输入 | 用户名未输入 | | +| 20022 | 密码未输入 | 密码未输入 | | +| 20023 | 确认密码未输入 | 确认密码未输入 | | +| 20024 | 两次密码不相同 | 两次密码不相同 | | +| 20025 | 昵称未输入 | 昵称未输入 | | +| 20026 | 用户名太短、太长或含有特殊字符、中文 | 用户名太短、太长或含有特殊字符、中文 | | +| 20027 | 昵称太短、太长或含有特殊字符 | 昵称太短、太长或含有特殊字符 | 还未启用 | +| 20028 | 密码太短、太长或含有特殊字符、中文 | 密码太短、太长或含有特殊字符、中文 | | +| 20032 | 已登录其他帐号 | 已登录其他帐号，请退出后再注册 | | +| 20040 | 系统未知错误 | 系统未知错误 | | +| 20041 | 服务器原因注册失败 | 服务器原因注册失败 | | +| 20050 | 无效token | 页面过期啦，请刷新再试 | | +| 20051 | 无token | 页面过期啦，请刷新再试 | | + + +# 文件上传相关 +> 版本：v1.0.2 +更新日期：2021.01.28 +前缀：300×× + +| 状态码 | 内容 | 提示消息 | 备注 | +| --- | --- | --- | --- | +| 30000 | 上传成功 | 上传成功 | | +| 30010 | 验证码输入错误 | 验证码输入错误，请重试 | 还未启用 | +| 30011 | 验证码已经失效 | 验证码已经失效，请重试 | 还未启用 | +| 30012 | 验证码未输入 | 验证码未输入 | 还未启用 | +| 30013 | 未登录账号 | 用户未登录，请登录后再上传 | | +| 30020 | 文件格式不支持 | 文件格式不支持 | | +| 30021 | 文件太大 | 文件太大了，请尝试将文件分多次上传 | | +| 30022 | 空文件 | 上传失败，文件为空 | | +| 30030 | 文件读取失败 | 文件读取失败，请确认文件可以正常打开后重新上传 | 还未启用 | +| 30031 | 文件上传时php系统报错 | 文件上传出错啦 | 同时输出详细错误信息（message_detail） | +| 30040 | 系统未知错误 | 系统未知错误 | | +| 30041 | 服务器原因上传失败 | 服务器原因上传失败 | 还未启用（文件已经存在暂时使用，后期要调整） | +| 30050 | 无效token | 页面过期啦，请刷新再试 | | +| 30051 | 无token | 页面过期啦，请刷新再试 | | \ No newline at end of file diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/通用参数（待完成）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/通用参数（待完成）.md new file mode 100644 index 0000000..4f07f1c --- /dev/null +++ b/docs/3. 接口文档/3. 前端Api接口（撰写中）/0. 概述/通用参数（待完成）.md @@ -0,0 +1 @@ +.keep \ No newline at end of file diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/上传logo（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/上传logo（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/检查更新（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/检查更新（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/站点基本信息（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/1. 站点/站点基本信息（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户注册（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户注册（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户登录（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/用户登录（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/2. 管理员/（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户注册（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户注册（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户登录（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/用户登录（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/（待完善）.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/3. 用户/（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/4. 单词/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/4. 单词/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/5. 词书/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/5. 词书/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/6. 通知/.keep b/docs/3. 接口文档/3. 前端Api接口（撰写中）/6. 通知/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 修改账户信息.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 修改账户信息.md new file mode 100644 index 0000000..e5353b3 --- /dev/null +++ b/docs/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 修改账户信息.md @@ -0,0 +1,131 @@ +> **密码禁止明文传输！** 加密方法见：开发文档 > 规范 > 注册、登录时密码使用的加密技术 + +## 接口列表 + +> api基础路径为 `./api/v1/users` + + +### ● 修改昵称 + +通过此接口实现用户昵称修改功能。 + +> 更新日期：2021.02.27 +> **info** 所有版本均支持此接口 +> 使用此接口前，须先进行用户登录 + +**接口地址**：./api/v1/users/modify_user_nickname.php +**请求方式**：POST + +
+接口详细信息（点击展开） + +| 参数名称 | 是否必须 | 类型 | 参数值示例 | 说明 | +| :---------- | :------: | :----- | :----- | :------- | +| key | 是 | string | ajax | 固定参数，填写`"ajax"` | +| nickname | 是 | string | 111111 | 用户修改后的新用户名（放在URL参数中） | +| uuid | 是 | string | | 用户uuid | + +#### 请求示例： + +```javascript +// jQuery +$.ajax({ + type: "post", + url: "./api/v1/users/modify_user_nickname.php?nickname=" + newNickname, + data: {key: 'ajax', uuid: '用户uuid'}, + dataType: "json", + success: function (res) { + if(res){ + if(res.success == true) + /* 昵称修改成功 */ + else + /* 昵称修改失败 */ + } + }, + error:function (res) { + // 请求失败回调函数 + } +}); +``` + +**返回格式**：`json` + +| 返回参数 | 类型 | 参数值示例 | 说明 | +| :---------- | :----- | :----- | :------- | +| msg | string | 这是一条消息 | 修改成功/失败时的提示消息 | +| success | bool | true | 用于判断用户昵称是否修改成功 | + +#### 返回示例： + +```javascript +{"msg":"信息","success":true} +``` +
+ + +-------------------------------------------------------------------------------- + +### ● 修改密码 + +通过此接口实现用户密码修改功能。 + +> 更新日期：2021.02.27 +> **info** 所有版本均支持此接口 +> 使用此接口前，须先进行用户登录 + +**接口地址**：./api/v1/users/modify_user_nickname.php +**请求方式**：POST + +
+接口详细信息（点击展开） + +| 参数名称 | 是否必须 | 类型 | 参数值示例 | 说明 | +| :---------- | :------: | :----- | :----- | :------- | +| key | 是 | string | ajax | 固定参数，填写`"ajax"` | +| uuid | 是 | string | | 用户uuid | +| oldPwd | 是 | string | | 旧密码（加密后） | +| newPwd | 是 | string | | 新密码（加密后） | +| newPwd_Confirm | 是 | string | | 新密码确认（加密后） | + +#### 请求示例： + +```javascript +// jQuery +$.ajax({ + type: "post", + url: "./api/v1/users/modify_user_password.php", + data: { + key: 'ajax', + uuid: '用户uuid', + oldPwd: Base64.encode(Base64.encode(oldPwd.split('').reverse().join('')).split('').reverse().join('')), + newPwd: Base64.encode(Base64.encode(newPwd.split('').reverse().join('')).split('').reverse().join('')), + newPwd_Confirm: Base64.encode(Base64.encode(newPwd_Confirm.split('').reverse().join('')).split('').reverse().join('')), + }, + dataType: "json", + success: function (res) { + if(res){ + if(res.success == true) + /* 密码修改成功 */ + else + /* 密码修改失败 */ + } + }, + error:function (res) { + // 请求失败回调函数 + } +}); +``` + +**返回格式**：`json` + +| 返回参数 | 类型 | 参数值示例 | 说明 | +| :---------- | :----- | :----- | :------- | +| msg | string | 这是一条消息 | 修改成功/失败时的提示消息 | +| success | bool | true | 用于判断用户密码是否修改成功 | + +#### 返回示例： + +```javascript +{"msg":"信息","success":true} +``` +
\ No newline at end of file diff --git a/docs/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 用户登录、注销、获取状态.md b/docs/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 用户登录、注销、获取状态.md new file mode 100644 index 0000000..cdc6172 --- /dev/null +++ b/docs/3. 接口文档/3. 前端Api接口（撰写中）/用户类 - 用户登录、注销、获取状态.md @@ -0,0 +1,163 @@ +> **密码禁止明文传输！** 加密方法见：开发文档 > 规范 > 注册、登录时密码使用的加密技术 + +## 接口列表 + +> api基础路径为 `./api/v1/users` + + +### ● 用户登录 + +通过此接口实现用户登录功能。 + +> 更新日期：2021.02.27 +> **info** 所有版本均支持此接口 + +**接口地址**：./api/v1/users/login.php +**请求方式**：POST + +
+接口详细信息（点击展开） + +| 参数名称 | 是否必须 | 类型 | 参数值示例 | 说明 | +| :---------- | :------: | :----- | :----- | :------- | +| username | 是 | string | 111111 | 用户名 | +| password | 是 | string | c97ee47294955604c0af78f83b3c735a | 密码（需要加密） | +| captcha | 是 | string | 7438 | 用户输入的验证码 | +| login_token | 是 | string | 9f8f89ac0de94f7578e96dd9129bfc5a | 发回页面加载时生成的令牌 | + +#### 请求示例： + +```javascript +// jQuery +$.ajax({ + type: "POST", + url: 'api/v1/users/login.php', + dataType: "json", + data: { + username: "", // 用户名 + password: "", // 密码 + captcha: "", // 验证码 + login_token: "", // 登录token + }, + success: function (res) { + if(res){ + if(res.success == true) { + // 登录成功 + } else { + // 登录失败 + } + } + }, + error:function (res) { + // POST失败时回调函数 + } +}); +``` + +**返回格式**：`json` + +| 返回参数 | 类型 | 参数值示例 | 说明 | +| :---------- | :----- | :----- | :------- | +| flag | string | | 状态码 | +| message | string | 这是一条消息 | 登录成功/失败时的提示消息 | +| success | bool | true | 用于判断用户是否登陆成功 | +| action | array | ["refresh_Page"] | 用于指示前端应该执行何种操作，例如清空文本框，刷新页面等等 | + +#### 返回示例： + +```javascript +{ + "flag":"状态码", + "message":"登录成功/失败提示信息", + "success":true, // 用于指示是否登录成功 + "action":["前台事件1","前台事件2", ... ] +} +``` +
+ + +-------------------------------------------------------------------------------- + +### ● 获取用户登录状态 + +通过此接口获取用户登录是否登录。如果登陆成功，可以获得用户名和用户昵称。 + +> 更新日期：2021.02.27 +> **info** 所有版本均支持此接口 + +**接口地址**：./api/v1/users/get-status.php +**请求方式**：GET + +
+接口详细信息（点击展开） + +#### 请求示例： + +```javascript +// jQuery +$.getJSON("api/v1/users/get-status.php",function (res) { + if(res['flag']){ + // 已经登录 + }else{ + // 没有登录 + } +}); +``` + +**返回格式**：`json` + +| 返回参数 | 类型 | 参数值示例 | 说明 | +| :---------- | :----- | :----- | :------- | +| username | string | 111111 | 用户名（仅用户登录状态下返回） | +| nickname | string | 用户昵称 | 用户昵称（仅用户登录状态下返回） | +| flag | bool | true | 是否登录 | + +#### 返回示例： + +```javascript +/* 已登录 */ +{"username":"用户名","nickname":"用户昵称","flag":true} + +/* 未登录 */ +{"flag":false} +``` +
+ + +-------------------------------------------------------------------------------- + +### ● 退出登录 + +通过此接口让用户退出。 + +> 更新日期：2021.02.27 +> **info** 所有版本均支持此接口 + +**接口地址**：./api/v1/users/logout.php +**请求方式**：GET + +
+接口详细信息（点击展开） + +#### 请求示例： + +```javascript +// jQuery +$.getJSON("api/v1/users/logout.php",function (res) { + if(res){ + // 退出登录成功，可以执行页面跳转 + }else{ + // 退出登录失败 + } +}); +``` + +**返回格式**：`json` + +#### 返回示例： + +```javascript +{true} +``` +
+ diff --git a/docs/3. 接口文档/4. 后端Api接口（待完善）.md b/docs/3. 接口文档/4. 后端Api接口（待完善）.md new file mode 100644 index 0000000..4f07f1c --- /dev/null +++ b/docs/3. 接口文档/4. 后端Api接口（待完善）.md @@ -0,0 +1 @@ +.keep \ No newline at end of file diff --git a/docs/3. 接口文档/5. 文档模板/.keep b/docs/3. 接口文档/5. 文档模板/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/3. 接口文档/5. 文档模板/前端Api接口.md b/docs/3. 接口文档/5. 文档模板/前端Api接口.md new file mode 100644 index 0000000..2d87f34 --- /dev/null +++ b/docs/3. 接口文档/5. 文档模板/前端Api接口.md @@ -0,0 +1,75 @@ + +#### 【XXX】 + +这里填写接口简介。 + +> 更新日期：2021.XX.XX +> _**i**_ 支持v1.0.X及以上版本，低版本需做兼容处理。 +> 或 +> **** 所有版本均支持此接口 + +> 使用此接口前，须先进行用户登录 +> 或 +> 此接口无需用户登录 + +**接口地址**：./api/v1/user/insert +**请求方式**：POST / GET + +
+接口详细信息（点击展开） + + +| 参数名称 | 是否必须 | 类型 | 参数值示例 | 说明 | +| :---------- | :------: | :----- | :----- | :------- | +| name | 是 | string | 张三 | 姓名 | +| age | 是 | int | 18 | 年龄 | +| city | 是 | string | 湖北省武汉市 | 城市 | +| address | 是 | string | 湖北省武汉市武昌区友谊大道368号 | 详细地址 | +| email | 是 | string | xxx@xx.com | 邮箱地址 | +| phone | 是 | string | 18900000000 | 手机号码 | +| weixin | 是 | string | xxxxxxx | 微信号码 | +| qq | 是 | string | 1234567890 | qq号码 | +| weibo | 是 | string | https://www.weibo.com/xxxxxx | 微博地址 | +| description | 是 | string | 此人很懒，没有填写简介 | 个人简介 | +| description | 否 | string | 此人很懒，没有填写简介 | 非必须时，可以在这里说明默认值 | + + +| 参数名称 | 是否必须 | 值 | 说明 | +| :----------- | :------: | :----- | :------- | +| Content-Type | 是 | application/json | | +| Content-Type | 是 | application/x-www-form-urlencoded | | + +#### 请求示例： + +```javascript +xxxxxx +``` + +**返回格式**：`json` + +| 返回参数 | 类型 | 参数值示例 | 说明 | +| :---------- | :----- | :----- | :------- | +| status | string | 0 | 状态码，0表示正常，-1表示错 | +| msg | string | 这是一条消息 | 返回的消息 | +| data | string | 这是一个data | 本次新增的用户编号，用于新增其他信息的userid参数 | + +#### 返回示例： + +```javascript +/* 成功 */ +{ + status:0, + msg:"用户新增成功", + data:1 +} + +/* 失败 */ +{ + status:1, + msg:"用户新增失败" +} +``` + +
+ + \ No newline at end of file diff --git a/docs/4. 应用开发文档/.keep b/docs/4. 应用开发文档/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/4. 应用开发文档/1. 开始.md b/docs/4. 应用开发文档/1. 开始.md new file mode 100644 index 0000000..60e89ef --- /dev/null +++ b/docs/4. 应用开发文档/1. 开始.md @@ -0,0 +1,33 @@ +# 创建第一个主题 + +> 在开始之前，你需要掌握HTML CSS JavaScript，以及PHP的相关知识。在主题的开发过程中，会涉及到这些知识。本文档是基于你已经掌握这些知识的基础上撰写的。 + +让我们开始吧。 + + + +## 应用介绍 + +- 应用分为主题和插件； +- 可以同时启用多个应用（但是需要考虑是否兼容）； +- 按照规范组织目录结构； +- 在后台统一安装、删除、启用、关闭； +- 「自述文件」为 `intro.json`； +- 应用放置目录为 `/system`； + + + +### 主题 + +- 主题是网站前端的显示效果，同时只能启用一个主题； +- 通过提供的统一接口获取需要显示的内容； +- 主题可以内置1个应用（也可不内置），对主题的能力进行扩展，启用状态与主题保持一致； +- 所在目录为 `/system/plugin`； + + + +### 插件 + +- 主要作用为扩展网站的某项功能； +- 可以同时启用多个应用（但是需要考虑是否兼容）； +- 所在目录为 `/system/plugin`； diff --git a/docs/4. 应用开发文档/2. 应用开发文档（待完善）.md b/docs/4. 应用开发文档/2. 应用开发文档（待完善）.md new file mode 100644 index 0000000..bce379c --- /dev/null +++ b/docs/4. 应用开发文档/2. 应用开发文档（待完善）.md @@ -0,0 +1,80 @@ +## 下载应用模板 + +| 主题模板 | 插件模板 | +| ---------------------- | ---------------------- | +| [点击下载]()【待完善】 | [点击下载]()【待完善】 | + + + +## 文件结构 + +```conf +/path/system/theme/themeName + +screenshot.png [必需]缩略图（500×400像素）； +intro.json [必需]自述文件【该文件由系统生成】； +README.md [不需要]应用开发模板说明文件，可以删除。 + +—————————————— 下面的待更新 —————————————— + +main.php [可选]应用内置管理页，在创建主题时填写才会生成； +include.php [可选]应用嵌入页，在创建主题时填写才会生成； + +include [可选]主题自带「文件模块」，使用{module:abc}「嵌入调用」该目录下的abc.php文件； +script [可选]JS目录； +style [必需]样式目录, 内存样式表及所需图片； + style.css [必需]不限于这个文件名，一套主题也可以拥有多个样式（各自独立使用）； + + css [可选]并不会自动创建，用于不应该放在style文件夹中的样式内容； +template 用于存放模板文件；建议优先确立以下 6 个模板文件及内容； + index.php 首页及列表页 + single.php 文章页(单页) + search.php 搜索结果页，不存在时使用index.php + header.php 公共头部文件 + footer.php 公共尾部文件 + 404.php 建议设置 +``` + + + +## 应用配置文件 + +### intro.json + +> 注意：建议使用工具生成或修改该文件。如果手动修改，特殊字符或符号可能会导致JSON解析失败。 +> +> [点击使用工具]()【待完善】 + +``` +{ + "plug": { + "plugId": "应用Id [必填]", + "name": "应用名称 [必填]", + "description": "应用简介 [必填]", + "pubDate": "发布日期，格式：2022-01-01 [必填]", + "update": "升级时间，格式：2022-01-01 [必填]", + "version": "版本号，格式：“1.0.0”或“1.0”。请严格按照格式填写，以免用户无法正常升级 [必填]", + "adapted": "最低兼容的系统版本数字代号（可在文档 关于 版本信息 发行版本 找到），此处请填写数字，不要填写字符串 [必填]", + "screenShot": "./preview.png 主题的缩略图所在相对路径 [必填]" + }, + "author": { + "authorId": "作者Id，后台创建应用时生成 [必填]", + "name": "作者姓名 [必填]", + "email": "作者邮箱 [选填]", + "url": "作者网站 [选填]" + } +} +``` + +| 字段 | 说明 / 格式 | 是否必填 | intro.json | +| -------- | -------------- | ---------------------------- | ---------------------------- | +| 应用Id | 创建应用时生成 | 必填 | plug.plugId | +| 应用名称 | | 必填 | plug.name | +| 应用简介 | | | plug.description | +| | | | plug.update | +| | | | plug.version | +| | | | plug.adapted | +| | | | plug.screenShot | +| | | | plug. | +| | | | | + diff --git a/docs/4. 应用开发文档/2. 规范（待完善）/.keep b/docs/4. 应用开发文档/2. 规范（待完善）/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/4. 应用开发文档/2. 规范（待完善）/1. 本项目遵循的注释规范.md b/docs/4. 应用开发文档/2. 规范（待完善）/1. 本项目遵循的注释规范.md new file mode 100644 index 0000000..0e3ff9b --- /dev/null +++ b/docs/4. 应用开发文档/2. 规范（待完善）/1. 本项目遵循的注释规范.md @@ -0,0 +1,31 @@ +> `@since` 表示从那个版本开始就有这个类/接口/方法 +> `@deprecated` 表示不建议使用该类/接口/方法 +> `@exception` 标注Runtime异常 +> `@throws` 标注非Runtime异常 + +类、接口 +```php +/** + * 〈一句话功能简述〉LogManager 类集中控制对日志读写的操作。 + * 〈功能详细描述〉全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，读取或写入符合条件的日志纪录。 + * @author [作者]张三，李四，王五 + * @version [版本号, YYYY-MM-DD]1.2, 2001-03-25 + * @see [相关类/方法]LogIteraotor + * @see [相关类/方法]BasicLog + * @since [产品/模块版本]CommonLog1.0 + */ +``` + +方法 +```php +/** + * 〈一句话功能简述〉 + * 〈功能详细描述〉 + * @param [参数1] [参数1说明] + * @param [参数2] [参数2说明] + * @return [返回类型说明] + * @exception/throws [违例类型] [违例说明] + * @see [类、类#方法、类#成员] + * @deprecated + */ +``` diff --git a/docs/4. 应用开发文档/2. 规范（待完善）/2. 注释规范.md b/docs/4. 应用开发文档/2. 规范（待完善）/2. 注释规范.md new file mode 100644 index 0000000..3a5c7d0 --- /dev/null +++ b/docs/4. 应用开发文档/2. 规范（待完善）/2. 注释规范.md @@ -0,0 +1,118 @@ +#### 1.在有处理逻辑的代码中，源程序有效注释量必须在20％以上。 +> 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 + +#### 2.文件注释：文件注释写入文件头部。 +> 说明：以`/**`开始 + +示例： +```php +/** + * 文件名：[文件名] + * 作者：〈版权〉 + * 描述：〈描述〉 + * 修改人：〈修改人〉 + * 修改时间：YYYY-MM-DD + * 修改内容：〈修改内容〉 + */ +``` +> 说明：每次修改后在文件头部写明修改信息。 + +示例： +```php +/** + * 文件名：LogManager.java + * 版权：Copyright 2000-2001 Huawei Tech. Co. Ltd. All Rights Reserved. + * 描述： WIN V200R002 WEBSMAP 通用日志系统 + * 修改人：张三 + * 修改时间：2001-02-16 + * 修改内容：新增 + * 修改人：李四 + * 修改时间：2001-02-26 + * 修改内容：。。。。。。 + * 修改人：王五 + * 修改时间：2001-03-25 + * 修改内容：。。。。。。 + */ +``` + +#### 3.类和接口的注释：该注释放在 `class` 定义之前，`using` 或 `package` 关键字之后。 +示例： +```php +package com.websmap.comm; + +/** + * 注释内容 + */ + public class CommManager +``` +#### 4.类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述，说明：可根据需要列出：版本号、生成日期、作者、内容、功能、与其它类的关系等。 +格式： +```php +/** + * 〈一句话功能简述〉 + * 〈功能详细描述〉 + * @author [作者] + * @version [版本号, YYYY-MM-DD] + * @see [相关类/方法] + * @since [产品/模块版本] + * @deprecated + */ +``` +> 说明：描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，`@since` 表示从那个版本开始就有这个类或者接口，`@deprecated` 表示不建议使用该类或者接口。 + +示例： +```php +/** + * LogManager 类集中控制对日志读写的操作。 + * 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，读取或写入符合条件的日志纪录。 + * @author 张三，李四，王五 + * @version 1.2, 2001-03-25 + * @see LogIteraotor + * @see BasicLog + * @since CommonLog1.0 + */ +``` + +#### 5.类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。用 `// ` 来注释,需要对齐被注释代码。 +示例： +```php +// 注释内容 +private String logType +``` + +#### 6.成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。用 `// ` 来注释，需要对齐被注释代码。 + +#### 7.公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。 +格式： +```php +/** + * 〈一句话功能简述〉 + * 〈功能详细描述〉 + * @param [参数1] [参数1说明] + * @param [参数2] [参数2说明] + * @return [返回类型说明] + * @exception/throws [违例类型] [违例说明] + * @see [类、类#方法、类#成员] + * @deprecated + */ +``` + +> 说明：`@since` 表示从那个版本开始就有这个方法；`@exception`或 `throws` 列出可能出现的异常；`@deprecated` 表示不建议使用该方法。 + +#### 8.对于方法内部用 `throw` 语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。对于非 `RuntimeException` ，即 `throws` 子句声明会抛出的异常，必须在方法的注释中标明。 +> 说明：异常注释用 `@exception`或 `@throws` 表示，在JavaDoc中两者等价，但推荐用 `@exception` 标注Runtime异常，`@throws` 标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。 + +#### 9.注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 + +#### 10.注释的排版，按照上述示例来展示。 + +#### 11.注释应该放在被注释的代码前面，分行展示，但中间不留空行。 + +#### 12.对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。 +> 说明：分支语句往往是程序实现某一特定功能的关键。 + +#### 13.边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 + +#### 14.注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。 + +#### 15.避免在注释中使用缩写，特别是不常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。 \ No newline at end of file diff --git a/docs/4. 应用开发文档/2. 规范（待完善）/3. 通用规范.md b/docs/4. 应用开发文档/2. 规范（待完善）/3. 通用规范.md new file mode 100644 index 0000000..bc8ab5d --- /dev/null +++ b/docs/4. 应用开发文档/2. 规范（待完善）/3. 通用规范.md @@ -0,0 +1,2 @@ +为避免重复及便于识别，应用名中不能出现特殊字符，应用识别名须遵循驼峰式书写规范，只能包含`大小写字母`和下划线`_`，应用目录名为应用识别名，定义的所有函数需要以应用识别名加`_`作为前缀； +所有目录及文件名，全部小写，不得出现大写字母； \ No newline at end of file diff --git a/docs/4. 应用开发文档/2. 规范（待完善）/注册、登录时密码使用的加密技术.md b/docs/4. 应用开发文档/2. 规范（待完善）/注册、登录时密码使用的加密技术.md new file mode 100644 index 0000000..7bca43f --- /dev/null +++ b/docs/4. 应用开发文档/2. 规范（待完善）/注册、登录时密码使用的加密技术.md @@ -0,0 +1,13 @@ +# 登录： +> 使用`密码加盐`生成不可逆哈希，**他人无法获取密码原文**。 +```javascript +md5.hex(pwd + md5.hex(pwd)); +``` + +# 注册： +> 使用密码倒序`Base64`加密，再倒序`Base64`加密，避免密码在网上裸奔。 +```javascript +Base64.encode(Base64.encode(pwd.split('').reverse().join('')).split('').reverse().join('')); +``` + +网站使用`SSL证书`（即网址前面的https），数据传输`非对称加密`（即使用“公钥”加密，“私钥”解密，公钥大家都知道，私钥仅服务器知道），确保中间人无法获得您的密码。 \ No newline at end of file diff --git a/docs/4. 应用开发文档/3. 应用接口（待完善）.md b/docs/4. 应用开发文档/3. 应用接口（待完善）.md new file mode 100644 index 0000000..0e35085 --- /dev/null +++ b/docs/4. 应用开发文档/3. 应用接口（待完善）.md @@ -0,0 +1,2 @@ +.keep + diff --git a/docs/4. 应用开发文档/4. 应用发布与更新（待完善）.md b/docs/4. 应用开发文档/4. 应用发布与更新（待完善）.md new file mode 100644 index 0000000..9ab013b --- /dev/null +++ b/docs/4. 应用开发文档/4. 应用发布与更新（待完善）.md @@ -0,0 +1,99 @@ +# 发布应用 + +> 在编写并测试好代码后，可以将应用上传至应用中心进行审核。审核通过后即可发布。 +> +> 应用期将视应用中心实际情况适时开发上线。 + + + +以下是发布应用的流程。 + +### 1. 成为开发者 + +成为开发者的条件：①有开发者账号；②绑定手机号；③等待通过审核 + +首先，你需要注册一个开发者应用账号。 + +然后，在用户中心绑定您的手机号，并完善账户信息。 + +最后，点击提交审核按钮，等待审核通过。审核期间，您可以上传应用以及配置相关信息，也可同时提交应用审核，但只有审核通过后，你的应用才可以发布至应用中心。 + +> **请注意，账号一旦注册，用户名等账户重要信息暂时不可修改。所以注册账号时一定要想好。** + +> 根据《互联网用户账号名称管理规定》等相关规定，您只有绑定手机号才可以进行后续操作。 + + + +### 2. 在后台创建一个应用 + +创建应用后，系统会为你生成一个**应用ID**（`plugId`）和**应用密钥**（`plugSecret`）。`plugSecret`将只显示一次，请保存好这两个密钥，如果您忘记了，则需要重置`plugSecret` + +- `plugId`用于唯一标识应用。在用户下载应用，或者更新应用的时候会用到。该值由系统生成，无法修改。 +- `plugSecret`的用处还没想好，但是是有用的【待更新】 + +> **请一定保管好plugSecret，不要泄露给任何人！如果已发生泄露，请立即重置plugSecret** + + + +### 3. 上传你的应用 + +根据页面提示上传您的应用。 + +上传应用后，应用信息将默认使用`intro.json`文件中的信息。如需修改，可修改`intro.json`文件，然后重新上传。 + +> `intro.json`编写规范请[查看这里]()【待完善】 + + + +- 应用发布日期（与配置文件中`pubDate`保持一致，且不能填写还未到的日期，一旦首次审核通过，将不能更改） +- 选择你的应用风格 +- +- 上传应用缩略图 +- + + + + + +### 4. 阅读并同意应用中心相关条款 + +在认真阅读并同意应用中心服务协议、隐私政策等条款内容后，勾选“我已阅读并同意上述条款”，然后点击下一步。 + + + +### 5. 提交审核 + +确认应用信息填写无误后，即可提交审核。 + +> 第一次审核通过日期显示为应用发布日期，开发者无法手动修改。 + +若审核未通过，您可以根据提示信息修改对应信息，并再次提交。 + +> 请注意，若审核未通过，请修改后再次提交。请不要不经修改反复提交。否则您的账号将可能受到相应处罚，甚至封号。 + + + +# 应用更新 + +主题更新时，你需要做以下几步： + +上传新的主题包，填写更新说明，并提交审核 + +## 1.上传新的应用包 + +登录后台，选择账号中需要更新的应用，然后点击修改。 + + + +## 2. 填写更新说明 + +上传应用包后，填写版本更新说明。 + +如果需要修改应用的其他信息，也可在当前页一并更改，更改后提交即可。 + + + +## 3. 提交审核 + +点击提交审核按钮，等待审核结果。 + diff --git a/docs/4. 应用开发文档/4. 应用开发（待完善）/.keep b/docs/4. 应用开发文档/4. 应用开发（待完善）/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/4. 应用开发文档/5. 主题开发（待完善）/.keep b/docs/4. 应用开发文档/5. 主题开发（待完善）/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/4. 应用开发文档/5. 主题开发（待完善）/主题开发（待完善）.md b/docs/4. 应用开发文档/5. 主题开发（待完善）/主题开发（待完善）.md new file mode 100644 index 0000000..8d9eedb --- /dev/null +++ b/docs/4. 应用开发文档/5. 主题开发（待完善）/主题开发（待完善）.md @@ -0,0 +1 @@ +如果有页面在当前主题中不存在，将使用默认页面展示。 diff --git a/docs/4. 应用开发文档/5. 申请下架应用（待完善）.md b/docs/4. 应用开发文档/5. 申请下架应用（待完善）.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/5. 关于/.keep b/docs/5. 关于/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/5. 关于/1. 版本信息/1. 发行版本.md b/docs/5. 关于/1. 版本信息/1. 发行版本.md new file mode 100644 index 0000000..4906395 --- /dev/null +++ b/docs/5. 关于/1. 版本信息/1. 发行版本.md @@ -0,0 +1,11 @@ +# 历史发行版本 + +> 仅包括最新稳定版 + +| 版本号 | 版本数字代号 | 更新日期 | 下载链接 | 说明 | +| ------ | ------------ | ---------- | ---------------------- | ---- | +| v1.0.1 | 2 | XXXX-XX-XX | [点击下载（待完善）]() | | +| v1.0.0 | 1 | XXXX-XX-XX | [点击下载（待完善）]() | | + + + diff --git a/docs/5. 关于/1. 版本信息/2. 更新日志.md b/docs/5. 关于/1. 版本信息/2. 更新日志.md new file mode 100644 index 0000000..df5d26c --- /dev/null +++ b/docs/5. 关于/1. 版本信息/2. 更新日志.md @@ -0,0 +1,3 @@ +版本：2021.02.24 + +- 增加开源许可证（GPL-3.0） \ No newline at end of file diff --git a/docs/5. 关于/2. 联系.md b/docs/5. 关于/2. 联系.md new file mode 100644 index 0000000..fada527 --- /dev/null +++ b/docs/5. 关于/2. 联系.md @@ -0,0 +1,10 @@ +联系邮箱：`admin@mail.only4.work` + +如果您发现了Bug，请备注`BUG` +如果您有更好的电子或建议，请备注`建议` +如果您想要与我们取得合作，请备注`合作`，我们十分欢迎您的合作，但下列情况除外： +> - 交换友链 +> - 广告 +> - 推销产品，服务（包括但不限于SEO优化等） + +最后，感谢您的支持！ \ No newline at end of file diff --git a/docs/5. 关于/3. 开发团队 & 贡献者名单.md b/docs/5. 关于/3. 开发团队 & 贡献者名单.md new file mode 100644 index 0000000..a93b85f --- /dev/null +++ b/docs/5. 关于/3. 开发团队 & 贡献者名单.md @@ -0,0 +1,39 @@ +## 开发团队 + +> 排名不分先后 + +张博凯 + +## 参与贡献名单 + +> 每个分类中排名按照有效贡献数量由多到少、质量由高到低排序。 + + +### 前端 + +张博凯 + + + + +### 后端 + +张博凯 + + + +### 数据库设计 + +张博凯 + + + +### 文档 + +#### 部署文档 + +张博凯 + +#### 开发文档 + +张博凯 \ No newline at end of file diff --git a/docs/5. 关于/4. 特别鸣谢.md b/docs/5. 关于/4. 特别鸣谢.md new file mode 100644 index 0000000..3f6b243 --- /dev/null +++ b/docs/5. 关于/4. 特别鸣谢.md @@ -0,0 +1,16 @@ +感谢大家对本项目的支持，您的打赏是我们前进的动力！ + +打赏方式：开始->简介->支持本项目发展 + +> 所有打赏都用于本项目的持续发展，例如支付服务器费用等。打赏不支持退款，请理性打赏哦。 + +## 打赏名单 + +> 按照打赏金额由高到低排序，金额相同按照时间由近到远排序 +> 本打赏名单非实时更新，您打赏过后可能需要一段时间才会显示在此处，如果超过24小时仍未更新，请联系我们（联系方式见 关于->联系），感谢您的理解！ + + +| 姓名/昵称 | 打赏金额 | 打赏时间 | 留言 | +|-------|:-----:|------|----| +| 暂无 | | | | + diff --git a/docs/5. 关于/5. 免责声明.md b/docs/5. 关于/5. 免责声明.md new file mode 100644 index 0000000..b6a3302 --- /dev/null +++ b/docs/5. 关于/5. 免责声明.md @@ -0,0 +1,30 @@ +# 免责声明 + +本项目为非赢利项目，在使用本项目相关代码之前，请务必仔细阅读本条款，您下载使用本项目即代表您了解并同意本声明。 + + **第一条** 通过各类方式使用本项目的行为，都将被视作是对本声明全部内容的无异议的认可。 + + **第二条** 对于访问者根据本项目提供的信息所做出的一切行为，除非另有明确的书面承诺文件，否则本项目不承担任何形式的责任。 + + **第三条** 未经本项目和作者同意，其他任何机构、个人不得以任何形式侵犯其作品（包含代码、内容、图片等）著作权，包括但不限于：擅自复制、链接、非法使用或转载，或以任何方式对本项目进行仿制。 + + **第四条** 访问者在从事与本项目相关的所有行为（包括但不限于访问浏览、利用、转载、宣传介绍）时，必须以善意且谨慎的态度行事；访问者不得故意或者过失的损害或者弱化本项目的各类合法权利与利益，不得利用本项目以任何方式直接或者间接的从事违反中国法律、国际公约以及社会公德的行为，且访问者应当恪守下述承诺： +1、传输和利用信息符合中国法律、国际公约的规定、符合公序良俗； +2、不将本项目以及与之相关的网络服务用作非法用途以及非正当用途，违反此条款的任何个人（或单位）将承担全部法律责任，本项目作者不承担该法律责任； +3、不得扰乱本项目官网或者冒充项目官网； +4、遵守与本项目以及与之相关的网络服务的协议、规定、程序和惯例等。 + + **第五条** 本项目郑重提醒访问者：请在转载或下载有关作品时务必尊重该作品的版权、著作权；如果您发现有您未署名的作品，请立即和我们联系，我们会在第一时间加上您的署名或作相关处理。 + + **第六条** 除另有明确说明或者中国法律有强制性规定外，本项目用户原创的作品，本项目及作者共同享有版权，其他项目、媒体及个人如需使用，须取得本项目的书面授权，未经授权严禁转载或用于其它商业用途。 + + **第七条** 如涉及本项目以链接形式推荐其他项目内容时，本项目并不对这些项目或资源的可用性负责，且不保证从这些项目获取的任何内容、产品、服务或其他材料的真实性、合法性。对于任何因使用或信赖从此类项目或资源上获取的内容、产品、服务或其他材料而造成（或声称造成）的任何直接或间接损失，本项目均不承担任何责任。 + + **第八条** 搭建本项目是您提供的数据库信息、网站信息，除第九条规定及您本人同意外，我们不会将您的任何资料以任何方式泄露给任何一方。 + + **第九条** 当政府部门、司法机关等依照法定程序要求本项目披露个人资料时，本项目将根据执法单位之要求或为公共安全之目的提供个人资料。在此情况下之任何披露，本项目均应当获得免责。由于用户将个人密码告知他人或与他人共享注册账户，由此导致的任何个人资料泄露，本项目不负任何责任。 + + **第十条** 本项目内容如无意中侵犯了任何媒体、公司、企业或个人等的知识产权，请来电或致函告之，本项目将在规定时间内给予删除等相关处理。 + + +联系方式见 关于 -> 联系 页面 \ No newline at end of file diff --git a/docs/5. 关于/6. 使用的开源组件列表.md b/docs/5. 关于/6. 使用的开源组件列表.md new file mode 100644 index 0000000..0e07951 --- /dev/null +++ b/docs/5. 关于/6. 使用的开源组件列表.md @@ -0,0 +1,12 @@ +| 项目 | 版本 | 说明 | 项目网站 | 开源许可证 | +|---|---|---|---|---| +| jQuery | 3.5.1 | Javascript框架 | [官网](https://jquery.com/) \| [文档(英文)](https://api.jquery.com/) \| [GitHub](https://github.com/jquery/jquery) | [MIT License](https://github.com/jquery/jquery/blob/main/LICENSE.txt) | +| Jcrop | v0.9.10 | jQuery组件，用于头像上传
（jQuery 1.7.2） | [官网](https://jcrop.com/) \| [文档(英文)](https://jcrop.com/guide/) \| [GitHub](https://github.com/tapmodo/Jcrop) | [MIT License](https://github.com/tapmodo/Jcrop/blob/master/MIT-LICENSE.txt) | +| MDUI | 1.0.1 | 前端用户界面 | [官网](https://www.mdui.org/) \| [文档](https://www.mdui.org/docs/) \| [GitHub](https://github.com/zdhxiong/mdui) \| [码云](https://gitee.com/zdhxiong/mdui) | [MIT License](https://gitee.com/zdhxiong/mdui/blob/v1/LICENSE) | +| js-md5 | 0.7.3 | 密码加密 | [npm](https://www.npmjs.com/package/js-md5) \| [GitHub](https://github.com/emn178/js-md5) | [MIT License](https://github.com/emn178/js-md5/blob/master/LICENSE.txt) | +| js-base64 | 3.6.0 | 密码加密 | [jsdelivr](https://www.jsdelivr.com/package/npm/js-base64) \| [npm](https://www.npmjs.com/package/js-base64) \| [GitHub](https://github.com/dankogai/js-base64/) | [BSD-3-Clause License](https://github.com/dankogai/js-base64/blob/main/LICENSE.md "BSD 3-Clause \"New\" or \"Revised\" License") | +| art-template | 4.13.2 | template-web.js
JavaScript模板引擎 | [官网](https://aui.github.io/art-template/zh-cn/index.html) \| [文档](https://aui.github.io/art-template/zh-cn/docs/) \| [GitHub](https://github.com/aui/art-template) | [MIT License](https://github.com/aui/art-template/blob/master/LICENSE) | + + diff --git a/docs/5. 关于/7. 开源许可证（GPL-3.0 License）.md b/docs/5. 关于/7. 开源许可证（GPL-3.0 License）.md new file mode 100644 index 0000000..a737dcf --- /dev/null +++ b/docs/5. 关于/7. 开源许可证（GPL-3.0 License）.md @@ -0,0 +1,675 @@ + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/docs/5. 关于/8. 使用的第三方接口.md b/docs/5. 关于/8. 使用的第三方接口.md new file mode 100644 index 0000000..e42775f --- /dev/null +++ b/docs/5. 关于/8. 使用的第三方接口.md @@ -0,0 +1,3 @@ +### 使用第三方接口 + +有道翻译单词读音接口（感谢有道的免费服务！） \ No newline at end of file diff --git a/docs/5. 关于/9. 更好的理解本项目的开源许可证（GPL-3.0）.md b/docs/5. 关于/9. 更好的理解本项目的开源许可证（GPL-3.0）.md new file mode 100644 index 0000000..cc3ec42 --- /dev/null +++ b/docs/5. 关于/9. 更好的理解本项目的开源许可证（GPL-3.0）.md @@ -0,0 +1,411 @@ +> **项目许可证以项目中LINCENSE文件为准，本页内容仅作为参考** +> 本页内容目的是让您更加了解 `GPL-3.0 许可证` 的相关内容，不具有法律效应，其中中文版本是来源于网络的非正式翻译版本。 + +GNU General Public License v3.0 + +
+ +以下是中文翻译版License，来自[https://jxself.org/translations/gpl-3.zh.shtml](https://jxself.org/translations/gpl-3.zh.shtml)： +> 关于该非正式翻译，请注意[关于非正式翻译的信息](http://www.gnu.org/licenses/translations.html) + +GNU通用公共许可协议 +第三版，2007年6月29日 +版权所有 © 2007 自由软件基金会 +任何人皆可复制和发布本协议的完整副本，但不得修改 +【译者声明】 +　　This is an unofficial translation of the GNU General Public License into Chinese. It was not published by the Free Software Foundation, and does not legally state the distribution terms for software that uses the GNU GPL--only the original English text of the GNU GPL does that. However, we hope that this translation will help Chinese speakers understand the GNU GPL better. +　　这是GNU通用公共许可协议的一份非官方中文翻译，并非自由软件基金会所发表，不适用于使用GNU通用公共许可协议发布的软件的法律声明——只有GNU通用公共许可协议英文原版才具有法律效力。不过我们希望本翻译能够帮助中文读者更好地理解GNU通用公共许可协议。 + +You may publish this translation, modified or unmodified, only under the terms at https://www.gnu.org/licenses/translations.html. + +【引言】 +　　GNU通用公共许可协议是一份面向软件及其他类型作品的，自由的版权共产协议。 +　　就多数软件而言，许可协议被设计用于剥夺你分享和修改软件的自由。相反，GNU通用公共许可协议力图保障你分享和修改某程序全部版本的权利——确保自由软件对其用户来说是自由的。我们自由软件基金会将GNU通用公共许可协议用于我们的大多数软件，并为一些其他作品的作者效仿。你也可以将本协议用于你的程序。 +　　所谓自由软件，强调自由，而非免费。本GNU通用公共许可协议设计用于确保你享有分发自由软件的自由（你可以为此服务收费），确保你可以在需要的时候获得这些软件的源码，确保你可以修改这些软件或者在新的自由软件中复用其中某些片段，并且确保你在这方面享有知情权。 +　　为保障你的权益，我们需要作一些限定：禁止任何人否认你的上述权利，或者要求你放弃它们。因此，当你分发或修改这些软件时，你有一定的责任——尊重他人的自由。如果你分发这种程序的副本，无论收费还是免费，你必须给予与你同等的权利。你还要确保他们也能收到源码并了解他们的权利。 +　　采用GNU通用公共许可协议的开发者通过两步保障你的权益：其一，申明软件的版权；其二，通过本协议使你可以合法地复制、分发和修改该软件。 +　　为了保护每一位作者和开发者，GNU通用公共许可协议指明一点：自由软件并没有品质担保。为用户和作者双方着想，GNU通用公共许可协议要求修改版必须有标记，以免其问题被错误地归到先前版本的作者身上。 +　　某些设备设计成拒绝用户安装运行修改过的软件，但厂商不受限。这和我们保护用户享有修改软件的自由的宗旨存在根本性矛盾。该滥用协议的模式出现于个人用品领域，这恰是最不可接受的。因此，我们设计了这版GNU通用公共许可协议来禁止这类产品。如果此类问题在其他领域涌现，我们时刻准备着在将来的版本中把规定扩展到相应领域，以保护用户的自由。 +　　最后，每个程序都持续受到软件专利的威胁。政府不应该允许专利限制通用计算机软件的开发和应用，在做不到这点时，我们希望避免专利应用有效地使自由软件私有化的危险。就此，GNU通用公共许可协议保证专利不能使程序非自由化。 + +　　下文是关于复制、分发和修改的严谨描述和实施条件。 + +【关于复制、分发和修改的术语和条件】 +〇、定义 + +　　“本协议”指GNU通用公共许可协议第三版。 +　　“版权”也指适用于诸如半导体掩模的其他类型作品的类似法律。 +　　“本程序”指任何在本协议保护下的有版权的作品。每个许可获得者称作“你”。“许可获得者”和“接收者”可以是个人或组织。 +　　“修改”一个作品指需要版权许可的复制及对作品全面的或部分的改编行为，有别于制作副本。所产生的作品称作前作的“修改版”，或“基于”前作的作品。 +　　“受保护作品”指程序或其派生作品。 +　　“传播”作品指那些未经许可就会在适用版权法律下构成直接或间接侵权的行为，不包括在计算机上运行和私下的修改。传播包括复制、分发（无论修改与否）、向公众公开，以及在某些国家的其他行为。 +　　“转发”作品指让他方能够制作或者接收副本的行为。仅仅通过计算机网络和用户交互，没有传输副本，则不算转发。 +　　一个显示“适当的法律声明”的交互式用户界面应包括一个便捷而醒目的可视化特性：(1)显示适当的版权声明；(2)告知用户没有品质担保（提供了品质担保的情况除外），许可获得者可以在本协议约束下转发该作品，及查看本协议副本的途径。如果该界面提供一个命令列表，如菜单，其表项应符合上述规范。 + +一、源码 + +　　作品的源码指其可修改的首选形式，目标码指所有其他形式。 +　　“标准接口”指标准化组织定义的官方标准中的接口，或针为某种编程语言设定的接口中为开发者广泛使用的接口。 +　　可执行作品中的“系统库”不是指整个程序，而是涵盖此等内容：(a)以通常形式和主部件打包到一起却并非后者一部分，且(b)仅为和主部件一起使作品可用或实现某些已有公开实现源码的接口。“主部件”在这里指可执行作品运行依赖的操作系统（如果存在）的必要部件（内核、窗口系统等），生成该作品的编译器，或运行所需的目标码解释器。 +　　目标码形式的作品中“相应的源码”指所有修改作品及生成、安装、运行（对可执行作品而言）目标码所需的源码，包括控制上述行为的脚本。可是，其中不包括系统库、通用工具、未修改直接用于支持上述行为却不是该作品一部分的通常可得的自由软件。例如，相应的源码包含配合作品源文件的接口定义，以及共享库和作品专门依赖的动态链接子程序的源码。这里的依赖体现为频密的数据交换或者该子程序和作品其他部分的控制流切换。 +　　相应的源码不必包含那些用户可以通过源码其他部分自动生成的内容。 +　　源码形式作品的相应源码即其本身。 + +二、基本许可 + +　　本协议的一切授权都是对本程序的版权而言的，并且在所述条件都满足时不可撤销。本协议明确批准你不受限制地运行本程序的未修改版本。受保护作品的运行输出，仅当其内容构成一个受保护作品时，才会为本协议所约束。如版权法所赋予，本协议承认你正当使用或与之等价的权利。 +　　只要你获得的许可仍有效，你可以制作、运行和传播那些你并不转发的受保护作品。只要你遵守本协议中关于转发你不占有版权的材料的条款，你可以向他人转发，仅仅以求对方为你做定制或向你提供运行这些作品的工具。那些为你制作或运行这些受保护作品的人，应该在你的指引和控制下，谨代表你工作，即禁止他们在双方关系之外制作任何你提供的受版权保护材料的副本。 +　　仅当满足后文所述条件时，其他各种情况下的转发才是允许的。不允许再授权行为，而第十条的存在使再授权变得没有必要。 + +三、保护用户的合法权益免受反破解法限制 + +　　在任何满足1996年12月20日通过的WIPO版权条约第11章要求的法律，或类似的禁止或限制技术手段破解的法律下，受保护作品不应该视为有效技术手段的一部分。 +　　当你转发一个受保护作品时，你将失去任何通过法律途径限制技术手段破解的权力，乃至于通过行使本协议所予权利实现的破解。你即已表明无心通过限制用户操作或修改受保护作品来确保你或第三方关于禁止技术手段破解的法定权利。 + +四、转发完整副本 + +　　你可以通过任何媒介发布你接收到的本程序的完整源码副本，但要做到：为每一个副本醒目而恰当地发布版权；完整地保留关于本协议及按第七条加入的非许可性条款；完整地保留免责声明；给接收者附上一份本协议的副本。 +　　你可以免费或收费转发，也可以选择提供技术支持或品质担保以换取收入。 + +五、转发修改过的源码版本 + +　　你可以以源码形式转发基于本程序的作品或修改的内容，除满足第四条外还需要满足以下几点要求： +　　a)该作品必须带有醒目的修改声明及相应的日期。 +　　b)该作品必须带有醒目的声明，指出其在本协议及任何符合第七条的附加条件下发布。这个要求修正了第四条关于“完整保留”的内容。 +　　c)你必须按照本协议将该作品整体向想要获得许可的人授权，本协议及符合第七条的附加条款就此适用于整个作品，即其每一部分，不管如何建包。本协议不允许以其他形式授权该作品，但如果你收到别的许可则另当别论。 +　　d)如果该作品有交互式用户界面，则其必须显示适当的法律声明。然而，当本程序有交互式用户界面却不显示适当的法律声明时，你的作品也不必。 +一个在存储或分发媒介上的受保护作品和其他分离的单体作品的联合作品，在既不是该受保护作品的自然扩展，也不以构筑更大的程序为目的，并且自身及其产生的版权并非用于限制单体作品给予联合作品用户的访问及其他合法权利时，称为“聚合体”。在聚合作品中包含受保护作品并不会使本协议影响聚合作品的其他部分。 + +六、以非源码形式转发 + +　　你可以如第四条和第五条所述那样以目标码形式转发受保护作品，同时在本协议规范下以如下方式之一转发机器可读的对应源码： +　　a)目标码通过实体产品（涵盖某种实体分发媒介）转发时，通过常用于软件交换的耐用型实体媒介随同转发相应的源码。 +　　b)目标码通过实体产品（涵盖某种实体分发媒介）转发时，伴以具有至少三年且与售后服务等长有效期的书面承诺，给予目标码的持有者：(1)包含产品全部软件的相应源码的常用于软件交换的耐用型实体媒介，且收费不超过其合理的转发成本；或者(2)通过网络免费获得相应源码的途径。 +　　c)单独转发目标码时，伴以提供源码的书面承诺。本选项仅在你收到目标码及b项形式的承诺的情况下可选。 +　　d)通过在指定地点提供目标码获取服务（无论是否收费）的形式转发目标码时，在同一地点以同样的方式提供对等的源码获取服务，并不得额外收费。你不以要求接收者在复制目标码的同时复制源码。如果提供目标码复制的地点为网络服务器，相应的源码可以提供在另一个支持相同复制功能的服务器上（由你或者第三方运营），不过你要在目标码处指出相应源码的确切路径。不管你用什么源码服务器，你有义务要确保持续可用以满足这些要求。 +　　e)通过点对点传输转发目标码时，告知其他节点目标码和源码在何处以d项形式向大众免费提供。 +　　“面向用户的产品”指(1)“消费品”，即个人、家庭或日常用途的个人有形财产；或者(2)面向社会团体设计或销售，却落入居家之物。在判断一款产品是否消费品时，争议案例的判断将向利于扩大保护靠拢。就特定用户接收到特定产品而言，“正常使用”指对此类产品的典型或一般使用，不管该用户的身份，该用户对该产品的实际用法，以及该产品的预期用法。无论产品是否实质上具有商业上的，工业上的，及非面向消费者的用法，它都视为消费品，除非以上用法代表了它唯一的重要使用模式。 +　　“安装信息”对面向用户的产品而言，指基于修改过的源码安装运行该产品中的受保护作品的修改版所需的方法、流程、认证码及其他信息。这些信息必须足以保证修改过的目标码不会仅仅因为被修改过而不能继续工作。 +　　如果你根据本条在，或随，或针对一款面向用户的产品，以目标码形式转发某作品，且转发体现于该产品的所有权和使用权永久或者在一定时期内转让予接收者的过程（无论其有何特点），根据本条进行的源码转发必须伴有安装信息。不过，如果你和第三方都没有保留在该产品上安装修改后的目标码的能力（如作品安装在ROM上），这项要求不成立。 　　要求提供安装信息并不要求为修改或安装的作品，以及其载体产品继续提供技术支持、品质担保和升级。当修改本身对网络运行有实质上的负面影响，或违背了网络通信协议和规则时，可以拒绝其联网。 +　　根据本条发布的源码及安装信息，必须以公共的文件格式（并且存在可用的空开源码的处理工具）存在，同时不得对解压、阅读和复制设置任何密码。 + +七、附加条款 + +　　“附加许可”用于补充本协议，以允许一些例外情况。合乎适用法律的对整个程序适用的附加许可，应该被视为本协议的内容。如果附加许可作用于程序的某部分，则该部分受此附加许可约束，而其他部分不受其影响。 +　　当你转发本程序时，你可以选择性删除副本或其部分的附加条款。（附加条款可以写明在某些情况下要求你修改时删除该条款。）在你拥有或可授予恰当版权许可的受保护作品中，你可以在你添加的材料上附加许可。 +　　尽管已存在本协议的其他条款，对你添加到受保护作品的材料，你可以（如果你获得该材料版权持有人的授权）以如下条款补充本协议： +　　a)表示不提供品质担保或有超出十五、十六条的责任。 +　　b)要求在此材料中或在适当的法律声明中保留特定的合理法律声明或创作印记。 +　　c)禁止误传材料的起源，或要求合理标示修改以别于原版。 +　　d)限制以宣传为目的使用该材料的作者或授权人的名号。 +　　e)降低约束以便赋予在商标法下使用商品名、商品标识及服务标识。 +　　f)要求任何转发该材料（或其修改版）并对接收者提供契约性责任许诺的人，保证这种许诺不会给作者或授权人带来连带责任。 +　　此外的非许可性附加条款都被视作第十条所说的“进一步的限制”。如果你接收到的程序或其部分，声称受本协议约束，却补充了这种进一步的限制条款，你可以去掉它们。如果某许可协议包含进一步的限制条款，但允许通过本协议再授权或转发，你可以通过本协议再授权或转发加入了受前协议管理的材料，不过要同时移除上述条款。 +　　如果你根据本条向受保护作品添加了调控，你必须在相关的源文件中加入对应的声明，或者指出哪里可以找到它们。 +　　附加条款，不管是许可性的还是非许可性的，可以以独立的书面协议出现，也可以声明为例外情况，两种做法都可以实现上述要求。 + +八、终止授权 + +　　除非在本协议明确授权下，你不得传播或修改受保护作品。其他任何传播或修改受保护作品的企图都是无效的，并将自动中止你通过本协议获得的权利（包括第十一条第3段中提到的专利授权）。 +　　然而，当你不再违反本协议时，你从特定版权持有人处获得的授权恢复：(1)暂时恢复，直到版权持有人明确终止；(2)永久恢复，如果版权持有人没能在60天内以合理的方式指出你的侵权行为。 +　　再者，如果你第一次收到了特定版权持有人关于你违反本协议（对任意作品）的通告，且在收到通告后30天内改正，那你可以继续享此有授权。 +　　当你享有的权利如本条所述被中止时，已经从你那根据本协议获得授权的他方的权利不会因此中止。在你的权利恢复之前，你没有资格凭第十条获得同一材料的授权。 + +九、持有副本无需接受协议 + +　　你不必为接收或运行本程序而接受本协议。类似的，仅仅因点对点传输接收到副本引发的对受保护作品的辅助性传播，并不要求接受本协议。但是，除本协议外没有什么可以授权你传播或修改任何受保护作品。如果你不接受本协议，这些行为就侵犯了版权。因此，一旦修改和传播一个受保护作品，就表明你接受本协议。 + +十、对下游接收者的自动授权 + +　　每当你转发一个受保护作品，其接收者自动获得来自初始授权人的授权，依照本协议可以运行、修改和传播此作。你没有要求第三方遵守该协议的义务。 +　　“实体事务”指转移一个组织的控制权或全部资产、或拆分或合并组织的事务。如果实体事务导致一个受保护作品的传播，则事务中各收到作品副本方，都有获得前利益相关者享有或可以如前段所述提供的对该作品的任何授权，以及从前利益相关者处获得并拥有相应的源码的权利，如果前利益相关者享有或可以通过合理的努力获得此源码。 +　　你不可以对本协议所授权利的行使施以进一步的限制。例如，你不可以索要授权费或版税，或就行使本协议所授权利征收其他费用；你也不能发起诉讼（包括交互诉讼和反诉），宣称制作、使用、零售、批发、引进本程序或其部分的行为侵犯了任何专利。 + +十一、专利 + +　　“贡献人”指通过本协议对本程序或其派生作品进行使用认证的版权持有人。授权作品成为贡献人的“贡献者版”。 +　　贡献人的“实质专利权限”指其拥有或掌控的，无论是已获得的还是将获得的全部专利权限中，可能被通过某种本协议允许的方式制作、使用或销售其贡献者版作品的行为侵犯的部分，不包括仅有修改其贡献者版作品才构成侵犯的部分。“掌控”所指包括享有和本协议相一致的专利再授权的权利。 +　　每位贡献人皆其就实质专利权限，授予你一份全球有效的免版税的非独占专利许可，以制作、使用、零售、批发、引进，及运行、修改、传播其贡献者版的内容。 +　　在以下三段中，“专利许可”指通过任何方式明确表达的不行使专利权（如对使用专利的明确许可和不起诉专利侵权的契约）的协议或承诺。对某方“授予”专利许可，指这种不对其行使专利权的协议或承诺。 +　　如果你转发的受保护作品已知依赖于某专利，而其相应的源码并不是任何人都能根据本协议从网上或其他地方免费获得，那你必须(1)以上述方式提供相应的源码；或者(2)放弃从该程序的专利许可中获得利益；或者(3)以某种和本协议相一致的方式将专利许可扩展到下游接收者。“已知依赖于”指你实际上知道若没有专利许可，你在某国家转发受保护作品的行为，或者接收者在某国家使用受保护作品的行为，会侵犯一项或多项该国认定的专利，而这些专利你有理由相信它们的有效性。 +　　如果根据一项事务或安排，抑或与之相关，你转发某受保护作品，或通过促成其转手以实现传播，并且该作品的接收方授予专利许可，以使指可以使用、传播、修改或转发该作品的特定副本，则此等专利许可将自动延伸及每一个收到该作品或其派生作品的人。 +　　如果某专利在其涵盖范围内，不包含本协议专门赋予的一项或多项权利，禁止行使它们或以不行使它们为前提，则该专利是“歧视性”的。如果你和软件发布行业的第三方有合作，合作要求你就转发受保护作品的情况向其付费，并授予作品接收方歧视性专利，而且该专利(a)与你转发的副本（或在此基础上制作的副本）有关，或针对包含该受保护作品的产品或联合作品，你不得转发本程序，除非参加此项合作或取得该专利早于2007年3月28日。 +　　本协议的任何部分不应被解释成在排斥或限制任何暗含的授权，或者其他在适用法律下对抗侵权的措施。 + +十二、不得牺牲他人的自由 + +　　即便你面临与本协议条款冲突的条件（来自于法庭要求、协议或其他），那也不能成为你违背本协议的理由。倘若你不能在转发受保护作品时同时满足本协议和其他文件的要求，你就不能转发本程序。例如，当你同意了某些要求你就再转发问题向你的转发对象收取版税的条款时，唯一能同时满足它和本协议要求的做法便是不转发本程序。 + +十三、和GNU Affero通用公共许可协议一起使用 + +　　尽管已存在本协议的一些条款，你可以将任何受保护作品与以GNU Affero通用公共许可协议管理的作品关联或组合成一个联合作品，并转发。本协议对其中的受保护作品部分仍然有效，但GNU Affero通用公共许可协议第十三条的关于网络交互的特别要求适用于整个联合作品。 + +十四、本协议的修订版 + +　　自由软件联盟可能会不定时发布GNU通用公共许可协议的修订版或新版。新版将秉承当前版本的精神，但对问题或事项的描述细节不尽相同。 +　　每一版都会有不同的版本号，如果本程序指定其使用的GNU通用公共许可协议的版本“或任何更新的版本”，你可以选择遵守该版本或者任何更新的版本的条款。如果本程序没有指定协议版本，你可以选用自由软件联盟发布的任意版本的GNU通用公共许可协议。 +　　如果本程序指定代理来决定将来那个GNU通用公共许可协议版本适用，则该代理的公开声明将指导你选择协议版本。 +　　新的版本可能会给予你额外或不同的许可。但是，任何作者或版权持有人的义务，不会因为你选择新的版本而增加。 + +十五、不提供品质担保 + +　　本程序在适用法律范围内不提供品质担保。除非另作书面声明，版权持有人及其他程序提供者“概”不提供任何显式或隐式的品质担保，品质担保所指包括而不仅限于有经济价值和适合特定用途的保证。全部风险，如程序的质量和性能问题，皆由你承担。若程序出现缺陷，你将承担所有必要的修复和更正服务的费用。 + +十六、责任范围 + +　　除非适用法律或书面协议要求，任何版权持有人或本程序按本协议可能存在的第三方修改和再发布者，都不对你的损失负有责任，包括由于使用或者不能使用本程序造成的任何一般的、特殊的、偶发的或重大的损失（包括而不仅限于数据丢失、数据失真、你或第三方的后续损失、其他程序无法与本程序协同运作），即使那些人声称会对此负责 + +十七、第十五条和第十六条的解释 + +　　如果上述免责声明和责任范围声明不为地方法律所支持，上诉法庭应采用与之最接近的关于放弃本程序相关民事责任的地方法律，除非本程序附带收费的品质担保或责任许诺。 + +【附录：如何将上述条款应用到你的新程序】 +　　如果你开发了一个新程序，并希望它能最大限度地为公众所使用，最好的办法是将其作为自由软件，以使每个人都能在本协议约束下对其再发布及修改。 +　　为此，请在附上以下声明。最安全的做法是将其附在每份源码的开头，以便于最有效地传递免责信息。同时，每个文件至少包含一处“版权”声明和一个协议全文的链接。 + +　　<用一行来标明程序名及其作用> +　　版权所有（C）<年份> <作者姓名> +　　本程序为自由软件，在自由软件联盟发布的GNU通用公共许可协议的约束下，你可以对其进行再发布及修改。协议版本为第三版或（随你）更新的版本。 +　　我们希望发布的这款程序有用，但不保证，甚至不保证它有经济价值和适合特定用途。详情参见GNU通用公共许可协议。 +　　你理当已收到一份GNU通用公共许可协议的副本，如果没有，请查阅 + +　　同时提供你的电子邮件地址或传统的邮件联系方式。 + +　　如果该程序是交互式的，让它在交互模式下输出类似下面的一段声明： + +　　<程序名> 第69版，版权所有（C）<年份> <作者姓名> +　　本程序从未提供品质担保，输入'show w'可查看详情。这是款自由软件，欢迎你在满足一定条件后对其再发布，输入'show c'可查看详情。 + +　　例子中的命令'show w'和'show c'应用于显示GNU通用公共许可协议相应的部分。当然你也可以因地制宜地选用别的方式，对图形界面程序可以用“关于”菜单。 + +　　如果你之上存在雇主（你是码农）或校方，你还应当让他们在必要时为此程序签署放弃版权声明。详情参见。 + +　　本GNU通用公共许可协议不允许把你的程序并入私有程序。如果你的程序是某种库，且你想允许它被私有程序链接而使之更有用，请使用GNU较宽松通用公共许可协议。决定前请先查阅。 + +—————————— + +翻译：阮坤良 + +
+ +以下是英文原版License，来自[http://www.gnu.org/licenses/gpl-3.0.html](http://www.gnu.org/licenses/gpl-3.0.html)： + +GNU GENERAL PUBLIC LICENSE +Version 3, 29 June 2007 + +Copyright © 2007 Free Software Foundation, Inc. + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +Preamble +The GNU General Public License is a free, copyleft license for software and other kinds of works. + +The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +TERMS AND CONDITIONS +0. Definitions. +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on the Program. + +To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. + +1. Source Code. +The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work. + +A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. + +The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +2. Basic Permissions. +All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. +No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. + +4. Conveying Verbatim Copies. +You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. +You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: + +a) The work must carry prominent notices stating that you modified it, and giving a relevant date. +b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”. +c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. +d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. +A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. + +6. Conveying Non-Source Forms. +You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: + +a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. +b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. +c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. +d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. +e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. +A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. + +A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. + +7. Additional Terms. +“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: + +a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or +b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or +c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or +d) Limiting the use for publicity purposes of names of licensors or authors of the material; or +e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or +f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. +All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. + +8. Termination. +You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. + +9. Acceptance Not Required for Having Copies. +You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. +Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. + +An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. + +11. Patents. +A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. + +In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. + +A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. + +12. No Surrender of Others' Freedom. +If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. + +13. Use with the GNU Affero General Public License. +Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. + +14. Revised Versions of this License. +The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. + +15. Disclaimer of Warranty. +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. +If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs +If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. +The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”. + +You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . + +The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . \ No newline at end of file diff --git a/docs/5. 关于/关于我们（待完善）.md b/docs/5. 关于/关于我们（待完善）.md new file mode 100644 index 0000000..4f07f1c --- /dev/null +++ b/docs/5. 关于/关于我们（待完善）.md @@ -0,0 +1 @@ +.keep \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/.keep b/docs/6. 【清单 ToDo】/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/6. 【清单 ToDo】/Bug & 已知问题.md b/docs/6. 【清单 ToDo】/Bug & 已知问题.md new file mode 100644 index 0000000..026e58d --- /dev/null +++ b/docs/6. 【清单 ToDo】/Bug & 已知问题.md @@ -0,0 +1,187 @@ +# 需修复Bug + +### 网站查单词刷新采用ajax，校验php的sessionID + +### 数据库 表前缀 + +### 密码使用密文传输保存，不使用明文传输 +前台使用`md5(md5(password) + salt)`处理传回后台，`salt`每个用户唯一 +后台使用`password_hash`获取前台传回<经过md5处理的密码>的哈希值保存数据库，验证时使用`password_verify` +> // `password_hash`得到的数据类似于 +`string(60) "$2y$10$MWf.96gY7Afy70tQoXXV.uRCoS8BOzAbZH10PCu7WCX4oH5FR85Gy"` +// php5.5之后才有`password_hash()` +// 【**参考资料**】 PHP 加密：Password Hashing API：https://blog.csdn.net/weixin_34055910/article/details/93947848 +设计安全的账号系统的正确姿势 +https://blog.coderzh.com/2016/01/03/security-design/ + +```php +10])); // 输出 false,因为 password_hash() 在加密时,出来默认 cost 为 10 外,还会指定随机的盐值 +``` + + +什么叫给密码“加盐”？如何安全的为你的用户密码“加盐”？ +https://zhuanlan.zhihu.com/p/144392745 +```php +prepare("SELECT COUNT(id) FROM zyblog_test_user WHERE username = :username"); + $pre->bindParam(':username', $username); + $pre->execute(); + $result = $pre->fetchColumn(); + + // 如果用户名存在，则无法注册 + if ($result > 0) { + echo '用户名已注册！', PHP_EOL; + return 0; + } + + // 生成salt + $salt = generateSalt(); + // 密码进行加盐hash处理 + $password = generateHashPassword($password, $salt); + + // 插入新用户 + $pre = $pdo->prepare("insert into zyblog_test_user(username, password, salt) values(?, ?, ?)"); + + $pre->bindValue(1, $username); + $pre->bindValue(2, $password); + $pre->bindValue(3, $salt); + + $pre->execute(); + + return $pdo->lastInsertId(); +} + +$userId = register($username, $password); +if ($userId > 0) { + echo '注册成功！用户ID为：' . $userId, PHP_EOL; +} + +// 注册成功！用户ID为：1 + +// 查询数据库中的数据 +$sth = $pdo->prepare("SELECT * FROM zyblog_test_user"); +$sth->execute(); + +$result = $sth->fetchAll(PDO::FETCH_ASSOC); +print_r($result); + +// Array +// ( +// [0] => Array +// ( +// [id] => 1 +// [username] => ZyBlog1 +// [password] => bbff8283d0f90625015256b742b0e694 +// [salt] => xOkb +// ) + +// ) + +// 登录时验证 +function login($username, $password) +{ + global $pdo; + // 先根据用户名查表 + $pre = $pdo->prepare("SELECT * FROM zyblog_test_user WHERE username = :username"); + $pre->bindParam(':username', $username); + $pre->execute(); + $result = $pre->fetch(PDO::FETCH_ASSOC); + + // 用户名存在并获得用户信息后 + if ($result) { + // 根据用户表中的salt字段生成hash密码 + $password = generateHashPassword($password, $result['salt']); + + // 比对hash密码确认登录是否成功 + if ($password == $result['password']) { + return true; + } + } + return false; +} + +$isLogin = login($username, $password); +if ($isLogin) { + echo '登录成功！', PHP_EOL; +} else { + echo '登录失败，用户名或密码错误！', PHP_EOL; +} + +// 登录成功！ + +// 测试表 +/* +CREATE TABLE `zyblog_test_user` ( + `id` int(11) NOT NULL AUTO_INCREMENT, + `username` varchar(255) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '用户名', + `password` varchar(255) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '密码', + `salt` char(4) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '盐', + PRIMARY KEY (`id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin; +*/ +``` +PHP的password_hash()使用实例 +https://www.jb51.net/article/48180.htm + +> 虽然通过password_hash()创建的哈希密码更加安全，但是却降低了互操作性。 +如我们使用md5方式，在php中用标准的MD5加密，很容易通过其他语言来校验，如node.js： +代码如下： + +``` +var hash = crypto.createHash('md5').update("123456").digest('hex'); +if(hash == "e10adc3949ba59abbe56e057f20f883e") console.log('密码正确'); +``` + +而使用password_hash()加密的哈希值基本只能通过PHP的password_verify来校验。 + + +------------ + + +# 已知问题 +## 登录页面 +- firefox电脑端测试时发现手机模拟弹出框关闭后网页无法操作，只能刷新； +- Chrome电脑版手机模式下全屏后按Esc键，右下角的按钮不变化的问题。 \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/保证Rest API的安全性.md b/docs/6. 【清单 ToDo】/保证Rest API的安全性.md new file mode 100644 index 0000000..cdece98 --- /dev/null +++ b/docs/6. 【清单 ToDo】/保证Rest API的安全性.md @@ -0,0 +1,28 @@ +　　如果单纯考虑加解密，或者签名方式来保证请求合法，其实是远远不够的。事实上，一个安全的API平台往往需要多方面一起考虑，保证请求安全合法。 + +## 1、是不是实际客户端的请求？ + +设计专门的私有请求头：定义独有的Request headers，标明有此请求头的请求合法。 +请求包含请求时间：定义时间，防止中间拦截篡改，只对指定超时范围内（如10秒）的请求予以响应。 +请求URI是否合法：此URI是否在API平台注册？防止伪造URI攻击 +请求是否包含不允许的参数定义：请求此版本的这个URI是否允许某些字段，防止注入工具。 +部分竞争资源是否包含调用时版本（Etag）：部分竞争资源，使用If-Match头提供。如用户资金账户查询API，可以返回此时的账户版本，修改扣款时附加版本号（类似乐观锁设计）。 + + +## 2、API平台是否允许你调用（访问控制）？ + +　　访问控制，主要是授权调用部分。API都对外暴露，但是某些公共API可以直接请求，某些，需要授权请求。本质的目的，都是为了验证发起用户合法，且对用户能标识统计计费。 + +　　以HMac Auth为例，我们简单设计一个签名算法。开发者注册时获取App Key、App Secret，然后申请部分API的访问权限，发起请求时： + +所有请求参数按第一个字符升序排序（先字母后数字），如第一个相同，则看第二个，依次顺延。 +按请求参数名及参数值相互连接组成一个字符串。param1=value1¶m2=value2...（其中包含App Key参数） +将应用密钥分别添加到以上请求参数串的头部和尾部:secret + 请求参数字符串 + secret。 +对该字符串进行 SHA1 运算，得到一个二进制数组。 +将该二进制数组转换为十六进制的字符串，该字符串为此次请求的签名。 +该签名值使用sign系统级参数一起和其它请求参数一起发送给API平台。 +服务端先验证是不是实际客户端的请求，然后按照App Key查找对应App Secret，执行签名算法，比较签名是否一致。签名一致后查看此App Key对应的用户是否有访问此API的权限，有则放行。 + +执行成功后包装返回指定格式的结果，进行统计计费。 + +https://www.ituring.com.cn/article/208878 \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/借鉴.md b/docs/6. 【清单 ToDo】/借鉴.md new file mode 100644 index 0000000..d0fe5a8 --- /dev/null +++ b/docs/6. 【清单 ToDo】/借鉴.md @@ -0,0 +1,23 @@ +> 按住Ctrl在新窗口打开 + +## MdClub +[https://community.mdclub.org/articles/2](https://community.mdclub.org/articles/2) +[https://www.mdclub.org/](https://www.mdclub.org/) +[https://www.mdclub.org/api/Token/login](https://www.mdclub.org/api/Token/login) +[]() + +## Discuz Q! +[Discuz! Q REST API文档 https://discuz.com/api-docs/v1/LanguagePack.html](https://discuz.com/api-docs/v1/LanguagePack.html) + +## MrDoc +[MrDoc觅道文档 https://zmister.com/mrdoc/](https://zmister.com/mrdoc/) + +---------- + +## iconfont-阿里巴巴矢量图标库 +[iconfont-阿里巴巴矢量图标库 https://www.iconfont.cn/manage/index](https://www.iconfont.cn/manage/index) + +---------- + +## Django +[快速安装指南¶ https://docs.djangoproject.com/zh-hans/3.1/intro/install/](https://docs.djangoproject.com/zh-hans/3.1/intro/install/) \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/数据库/.keep b/docs/6. 【清单 ToDo】/数据库/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/6. 【清单 ToDo】/数据库/MySQL数据库优化 & 设计注意事项（参考）.md b/docs/6. 【清单 ToDo】/数据库/MySQL数据库优化 & 设计注意事项（参考）.md new file mode 100644 index 0000000..6781629 --- /dev/null +++ b/docs/6. 【清单 ToDo】/数据库/MySQL数据库优化 & 设计注意事项（参考）.md @@ -0,0 +1,132 @@ +参考资料： +https://www.cnblogs.com/daxian2012/p/11207510.html + +------------ + +# 1.数据库设计和表创建时就要考虑性能 +### 设计表时要注意： +- 表字段避免null值出现，null值很难查询优化且占用额外的索引空间，推荐默认数字0代替null。 +- 尽量使用INT而非BIGINT，如果非负则加上UNSIGNED（这样数值容量会扩大一倍），当然能使用TINYINT、SMALLINT、MEDIUM_INT更好。 +- 使用枚举或整数代替字符串类型 +- 尽量使用TIMESTAMP而非DATETIME +- 单表不要有太多字段，建议在20以内 +- 用整型来存IP + +### 索引 +- 索引并不是越多越好，要根据查询有针对性的创建，考虑在WHERE和ORDER BY命令上涉及的列建立索引，可根据EXPLAIN来查看是否用了索引还是全表扫描 +- 应尽量避免在WHERE子句中对字段进行NULL值判断，否则将导致引擎放弃使用索引而进行全表扫描 +- 值分布很稀少的字段不适合建索引，例如"性别"这种只有两三个值的字段 +- 字符字段只建前缀索引 +- 字符字段最好不要做主键 +- 不用外键，由程序保证约束 +- 尽量不用UNIQUE，由程序保证约束 +- 使用多列索引时主意顺序和查询条件保持一致，同时删除不必要的单列索引 +简言之就是使用合适的数据类型，选择合适的索引 + +### 选择合适的数据类型 +（1）使用可存下数据的最小的数据类型，整型 < date,time < char,varchar < blob +（2）使用简单的数据类型，整型比字符处理开销更小，因为字符串的比较更复杂。如，int类型存储时间类型，bigint类型转ip函数 +（3）使用合理的字段属性长度，固定长度的表会更快。使用enum、char而不是varchar +（4）尽可能使用not null定义字段 +（5）尽量少用text，非用不可最好分表 + +### 选择合适的索引列 +（1）查询频繁的列，在where，group by，order by，on从句中出现的列 +（2）where条件中<，<=，=，>，>=，between，in，以及like 字符串+通配符（%）出现的列 +（3）长度小的列，索引字段越小越好，因为数据库的存储单位是页，一页中能存下的数据越多越好 +（4）离散度大（不同的值多）的列，放在联合索引前面。查看离散度，通过统计不同的列值来实现，count越大，离散程度越高： +原开发人员已经跑路，该表早已建立，我无法修改，故：该措辞无法执行，放弃！ + +# 2.sql的编写需要注意优化 +- 使用limit对查询结果的记录进行限定 +- 避免select *，将需要查找的字段列出来 +- 使用连接（join）来代替子查询 +- 拆分大的delete或insert语句 +- 可通过开启慢查询日志来找出较慢的SQL +- 不做列运算：SELECT id WHERE age + 1 = 10，任何对列的操作都将导致表扫描，它包括数据库教程函数、计算表达式等等，查询时要尽可能将操作移至等号右边 +- sql语句尽可能简单：一条sql只能在一个cpu运算；大语句拆小语句，减少锁时间；一条大sql可以堵死整个库 +- OR改写成IN：OR的效率是n级别，IN的效率是log(n)级别，in的个数建议控制在200以内 +- 不用函数和触发器，在应用程序实现 +- 避免%xxx式查询 +- 少用JOIN +- 使用同类型进行比较，比如用'123'和'123'比，123和123比 +- 尽量避免在WHERE子句中使用!=或<>操作符，否则将引擎放弃使用索引而进行全表扫描 +- 对于连续数值，使用BETWEEN不用IN：SELECT id FROM t WHERE num BETWEEN 1 AND 5 +- 列表数据不要拿全表，要使用LIMIT来分页，每页数量也不要太大 + +# 引擎 +目前广泛使用的是MyISAM和InnoDB两种引擎： + +### MyISAM +MyISAM引擎是MySQL 5.1及之前版本的默认引擎，它的特点是： + +- 不支持行锁，读取时对需要读到的所有表加锁，写入时则对表加排它锁 +- 不支持事务 +- 不支持外键 +- 不支持崩溃后的安全恢复 +- 在表有读取查询的同时，支持往表中插入新纪录 +- 支持BLOB和TEXT的前500个字符索引，支持全文索引 +- 支持延迟更新索引，极大提升写入性能 +- 对于不会进行修改的表，支持压缩表，极大减少磁盘空间占用 + +### InnoDB +InnoDB在MySQL 5.5后成为默认索引，它的特点是： + +- 支持行锁，采用MVCC来支持高并发 +- 支持事务 +- 支持外键 +- 支持崩溃后的安全恢复 +- 不支持全文索引 + +总体来讲，MyISAM适合SELECT密集型的表，而InnoDB适合INSERT和UPDATE密集型的表 +MyISAM速度可能超快，占用存储空间也小 + +# 分区 + +MySQL在5.1版引入的分区是一种简单的水平拆分，用户需要在建表的时候加上分区参数，对应用是透明的无需修改代码。 + +对用户来说，分区表是一个独立的逻辑表，但是底层由多个物理子表组成，实现分区的代码实际上是通过对一组底层表的对象封装，但对SQL层来说是一个完全封装底层的黑盒子。MySQL实现分区的方式也意味着索引也是按照分区的子表定义，没有全局索引。 + +用户的SQL语句是需要针对分区表做优化，SQL条件中要带上分区条件的列，从而使查询定位到少量的分区上，否则就会扫描全部分区，可以通过EXPLAIN PARTITIONS来查看某条SQL语句会落在那些分区上，从而进行SQL优化，我测试，查询时不带分区条件的列，也会提高速度，故该措施值得一试。 + +分区的好处是： + +- 可以让单表存储更多的数据 +- 分区表的数据更容易维护，可以通过清楚整个分区批量删除大量数据，也可以增加新的分区来支持新插入的数据。另外，还可以对一个独立分区进行优化、检查、修复等操作 +- 部分查询能够从查询条件确定只落在少数分区上，速度会很快 +- 分区表的数据还可以分布在不同的物理设备上，从而高效利用多个硬件设备 +- 可以使用分区表赖避免某些特殊瓶颈，例如InnoDB单个索引的互斥访问、ext3文件系统的inode锁竞争 +- 可以备份和恢复单个分区 + +分区的限制和缺点： + +- 一个表最多只能有1024个分区 +- 如果分区字段中有主键或者唯一索引的列，那么所有主键列和唯一索引列都必须包含进来 +- 分区表无法使用外键约束 +- NULL值会使分区过滤无效 +- 所有分区必须使用相同的存储引擎 + +分区的类型： + +- RANGE分区：基于属于一个给定连续区间的列值，把多行分配给分区 +- LIST分区：类似于按RANGE分区，区别在于LIST分区是基于列值匹配一个离散值集合中的某个值来进行选择 +- HASH分区：基于用户定义的表达式的返回值来进行选择的分区，该表达式使用将要插入到表中的这些行的列值进行计算。这个函数可以包含MySQL中有效的、产生非负整数值的任何表达式 +- KEY分区：类似于按HASH分区，区别在于KEY分区只支持计算一列或多列，且MySQL服务器提供其自身的哈希函数。必须有一列或多列包含整数值 + +具体关于mysql分区的概念请自行google或查询官方文档 +。 + +# 分表 + +分表就是把一张大表，按照如上过程都优化了，还是查询卡死，那就把这个表分成多张表，把一次查询分成多次查询，然后把结果组合返回给用户。 + +分表分为垂直拆分和水平拆分，通常以某个字段做拆分项。比如以id字段拆分为100张表： 表名为 tableName_id%100 + +但：分表需要修改源程序代码，会给开发带来大量工作，极大的增加了开发成本，故：只适合在开发初期就考虑到了大量数据存在，做好了分表处理，不适合应用上线了再做修改，成本太高！！！而且选择这个方案，都不如选择我提供的第二第三个方案的成本低！故不建议采用。 + +# 分库 + +把一个数据库分成多个，建议做个读写分离就行了，真正的做分库也会带来大量的开发成本，得不偿失！不推荐使用。 + + + diff --git a/docs/6. 【清单 ToDo】/测试用/.keep b/docs/6. 【清单 ToDo】/测试用/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/6. 【清单 ToDo】/测试用/延长文件上传时间，测试进度条.md b/docs/6. 【清单 ToDo】/测试用/延长文件上传时间，测试进度条.md new file mode 100644 index 0000000..6e98ff7 --- /dev/null +++ b/docs/6. 【清单 ToDo】/测试用/延长文件上传时间，测试进度条.md @@ -0,0 +1,7 @@ + + + // 下面几行测试用，目的是延长文件上传时间，测试进度条 + // $a = rand(5, 15); + // for ($x=0; $x<=3000000; $x++) { + // $a+=rand(rand(5, 15), rand(25, 35)); + // } \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/测试用/登录页 浏览器书签快速填充登录.md b/docs/6. 【清单 ToDo】/测试用/登录页 浏览器书签快速填充登录.md new file mode 100644 index 0000000..0ba81a7 --- /dev/null +++ b/docs/6. 【清单 ToDo】/测试用/登录页 浏览器书签快速填充登录.md @@ -0,0 +1,42 @@ +Url如下： + +``` +javascript:void (function() { + function debugmode(){ + document.getElementById('login_username').value = "111111"; + document.getElementById('login_password').value = "111111"; + + document.getElementById('register_username').value = "666666"; + document.getElementById('register_nickname').value = "六个六"; + document.getElementById('register_password').value = "666666"; + document.getElementById('register_password_confirm').value = "666666"; + + + getCaptchaCode(true); + } + function getCaptchaCode(isFailRetry){ + $.ajax({ + type: "POST", + url: 'api/get-captcha-code-test-only.php', + dataType: "json", + success: function (res) { + login_captcha.value = register_captcha.value = findpwd_captcha.value = res; + login_captcha.focus(); register_captcha.focus(); findpwd_captcha.focus(); + window.getSelection().empty(); + }, + error: function (res) { + if(isFailRetry) setTimeout(getCaptchaCode(false), 100); + else{ + login_captcha.value = register_captcha.value = findpwd_captcha.value = "验证码开小差啦，点下验证码再试一次吧"; + login_captcha.focus(); register_captcha.focus(); findpwd_captcha.focus(); + } + } + }); + } + var vercodeimg_onload = function() { setTimeout(debugmode(), 100) }; + login_vercodeimg.onload = vercodeimg_onload; + register_vercodeimg.onload = vercodeimg_onload; + findpwd_vercodeimg.onload = vercodeimg_onload; + debugmode(); + }(document)); +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/环境选择.md b/docs/6. 【清单 ToDo】/环境选择.md new file mode 100644 index 0000000..d5c60ef --- /dev/null +++ b/docs/6. 【清单 ToDo】/环境选择.md @@ -0,0 +1,14 @@ +### Nginx相对于Apache +#### Nginx相对于Apache的优点： + +- 轻量级，比apache占用更少的内存及资源； +- 抗并发，nginx处理请求是异步非阻塞的，而apache则是阻塞型的，在高并发下nginx 能保持低资源低消耗高性能 +- 高度模块化的设计，编写模块相对简单 +- 社区活跃，各种高性能模块出品迅速 + +#### Apache相对于Nginx的优点： + +- rewrite，比nginx强大 +- 动态页面 +- 模块多，基本想到的都可以找到 +- 少bug，nginx的bug相对较多 \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/.keep b/docs/6. 【清单 ToDo】/随笔记/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/6. 【清单 ToDo】/随笔记/PHP 生成不重复唯一标识 uniqid() session_create_id().md b/docs/6. 【清单 ToDo】/随笔记/PHP 生成不重复唯一标识 uniqid() session_create_id().md new file mode 100644 index 0000000..52e4173 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/PHP 生成不重复唯一标识 uniqid() session_create_id().md @@ -0,0 +1,10 @@ +http://jz6.cn/post/23 + +# uniqid() +`uniqid()` 生成不重复唯一标识 +``` +md5(uniqid(md5(microtime(true)),true)) +``` +# session_create_id() +使用`session_create_id()`函数生成唯一标识符，经过实际测试发现，即使循环调用`session_create_id()`一亿次，都没有出现过重复。 +`session_create_id()`是php 7.1新增的函数，用来生成session id，低版本无法使用。 \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/handlebars （草稿）.md b/docs/6. 【清单 ToDo】/随笔记/handlebars （草稿）.md new file mode 100644 index 0000000..09b1027 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/handlebars （草稿）.md @@ -0,0 +1,29 @@ +```sql +handlebars +官网：https://handlebarsjs.com/installation.html +可借鉴的（堆糖）：https://www.duitang.com/p/atlas/?id=117068767 +查阅资料：https://www.jianshu.com/p/2ad73da601fc + + + +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/html map标签.md b/docs/6. 【清单 ToDo】/随笔记/html map标签.md new file mode 100644 index 0000000..90188fc --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/html map标签.md @@ -0,0 +1,113 @@ +https://www.w3school.com.cn/html5/tag_map.asp +```html +Planets + + + Sun + Mercury + Venus + +``` + +http://www.divcss5.com/html5/h54844.shtml +```html +首先让我们来看一下htmlmap标签是什么： + +　　htmlmap标签:定义一个客户端图像映射。图像映射（image-map）指带有可点击区域的一幅图像。 + +　　定义map： + +　　 + +　　 + +　　 + +　　map标签定义map，area标签定义可点击的热点，area属性; + +　　shape：定义热点形状，可选参数rect(矩形)、circle(圆形)、poligon(自定义形状)。 + +　　coords：定义形状路径; + +　　当shape=rect时，四个数字依次为：起点X、起点Y、终点X、终点Y + +　　当shape=circle时，三个数字依次为：中心点X、中心点Y、半径 + +　　当shape=poligon时，可定义多个路径点，依次为：起点X、起点Y、路径1X、路径1Y、路径2X、路径2Y...... + +　　href定义点击跳转的地址。 + +　　htmlmap标签必需的属性： + +　　id：unique_name：为map标签定义唯一的名称。 + +　　htmlmap标签可选的属性： + +　　name：mapname：为image-map规定的名称。 + +　　map标签在HTML中的结构： + +　　1、coords的对应坐标不用变，只需在JS里面改变其比例就OK！ + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　2、如果有多张图片，一张图片对应一个map，class不用变，改变map的name值和对应的usemap值就好。name=usemap他们俩是一对CP哦，不要分开它们，给他们一样的值。 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　html标签常用在为图像的某区域添加超链接！ + +　　用法如下： + +　　 + +　　 + +　　 + +　　 + +　　 + +　　 + +　　usemap属性获取标签信息，标签定义一个链接区域，shape属性定义区域形状，coords属性定义链接区域的起点坐标和终点坐标 + +　　注释：area元素永远嵌套在map元素内部。area元素可定义图像映射中的区域。 + +　　注释：中的usemap属性可引用中的id或name属性（取决于浏览器），所以我们应同时向添加id和name属性。 +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/js redirect.php.md b/docs/6. 【清单 ToDo】/随笔记/js redirect.php.md new file mode 100644 index 0000000..ebdc257 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/js redirect.php.md @@ -0,0 +1,8 @@ +```php +location.replace("?page={$url}");'; + } +} +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/js 强制在新窗口打开链接.md b/docs/6. 【清单 ToDo】/随笔记/js 强制在新窗口打开链接.md new file mode 100644 index 0000000..9fde78b --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/js 强制在新窗口打开链接.md @@ -0,0 +1,7 @@ +```javascript +// 在新窗口中打开链接 +$('body').on('click', '.markdown-body a', function (e) { + e.preventDefault(); + window.open(this.href, '_blank'); +}); +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/mysql导入txt文件.md b/docs/6. 【清单 ToDo】/随笔记/mysql导入txt文件.md new file mode 100644 index 0000000..d681197 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/mysql导入txt文件.md @@ -0,0 +1,66 @@ +https://www.cnblogs.com/madman-fly/p/10742724.html +【图片见原文】 + +1.首先在命令行启动mysql + + net start mysql + + +![](https://img2018.cnblogs.com/blog/1612697/201904/1612697-20190420200545001-1769864324.png) + +2.登录MySQL（建议使用非root用户） + + mysql --local-infile=1 -u one -p + + +![](https://img2018.cnblogs.com/blog/1612697/201904/1612697-20190420201658791-1381031511.png) + +3.创建数据库 +如 CREATE DATABASE menagerie; + +在使用在这个数据库 +use menagerie + +![](https://img2018.cnblogs.com/blog/1612697/201904/1612697-20190420202140624-1006608963.png) + +创建表 + +如：CREATE TABLE pet (name VARCHAR(20), owner VARCHAR(20), + species VARCHAR(20), sex CHAR(1), birth DATE, death DATE); + +创建后可以检查一下 + +show tables + +![](https://img2018.cnblogs.com/blog/1612697/201904/1612697-20190420205104915-1490000600.png) + +验证表是否按预期方式创建 + + DESCRIBE pet; + +![](https://img2018.cnblogs.com/blog/1612697/201904/1612697-20190420210122798-760808132.png) + +4.创建好txt文件（最好存放在根目录下方便查找） + +在数据库中导入 + +LOAD DATA LOCAL INFILE 'C:\pet.txt' INTO TABLE pet; + +若报错 + +![](https://img2018.cnblogs.com/blog/1612697/201904/1612697-20190420210458100-594278701.png) + +可将其改为绝对路径 + +LOAD DATA LOCAL INFILE 'C:\\pet.txt' INTO TABLE pet; + +即可导入成功 + +![](https://img2018.cnblogs.com/blog/1612697/201904/1612697-20190420210752513-1266477457.png) + +select * from pet； + +![]( +![](./media//202101/2021-01-23_194828.png)) + +至此完成所有工作。 \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/mysql查看执行sql语句的记录日志.md b/docs/6. 【清单 ToDo】/随笔记/mysql查看执行sql语句的记录日志.md new file mode 100644 index 0000000..4469c36 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/mysql查看执行sql语句的记录日志.md @@ -0,0 +1,42 @@ +https://www.cnblogs.com/jhin-wxy/p/8965888.html + +### 1、使用processlist，但是有个弊端，就是只能查看正在执行的sql语句，对应历史记录，查看不到。好处是不用设置，不会保存。 +```sql +use information_schema; +show processlist; +``` +或者： +```sql +select * from information_schema.`PROCESSLIST` where info is not null; +``` + +------------ + +### 2、开启日志模式 +> 需要root权限 +#### 1、设置 + +```sql +-- 日志开启 +SET GLOBAL log_output = 'TABLE'; SET GLOBAL general_log = 'ON'; + +-- 日志关闭 +SET GLOBAL log_output = 'TABLE'; SET GLOBAL general_log = 'OFF'; +``` + +#### 2、查询 + +```sql +SELECT * from mysql.general_log ORDER BY event_time DESC; +``` + +#### 3、清空表（delete对于这个表，不允许使用，只能用truncate） + +```sql +-- truncate table mysql.general_log; +``` + + +在查询sql语句之后，在对应的`C:\Program Files\MySQL\MySQL Server 5.7\data`文件夹下面有对应的log记录 + +ps:在查询到所需要的记录之后，应尽快关闭日志模式，占用磁盘空间比较大 \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/php 获取网页URL.md b/docs/6. 【清单 ToDo】/随笔记/php 获取网页URL.md new file mode 100644 index 0000000..d0bcc37 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/php 获取网页URL.md @@ -0,0 +1,27 @@ +# 代码 +```php +'; + echo dirname('/').'/index.php?c=admin'; + echo '
'; + $phpSelf = dirname($_SERVER['PHP_SELF']."apple") == "/" ? "" : dirname($_SERVER['PHP_SELF']); + echo $phpSelf; exit; + exit(); +``` + +------------ + +# 执行结果 + +``` +/* https://www.only4.work/Admin/新建文件.php */ +/Admin/index.php?c=admin +//index.php?c=admin +/Admin + + +/* https://www.only4.work/新建文件.php */ +//index.php?c=admin +//index.php?c=admin +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/php学习笔记（二十）mysqli的stmt的预处理类的使用（防止sql注入问题）.md b/docs/6. 【清单 ToDo】/随笔记/php学习笔记（二十）mysqli的stmt的预处理类的使用（防止sql注入问题）.md new file mode 100644 index 0000000..49a510e --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/php学习笔记（二十）mysqli的stmt的预处理类的使用（防止sql注入问题）.md @@ -0,0 +1,88 @@ +https://blog.csdn.net/freejs/article/details/84368851 + +php学习笔记（二十）mysqli的stmt的预处理类的使用（防止sql注入问题） + +```php +bind_param("isd",$id,$name,$price); + * i：整型 + * d：double + * s：string + * b：二进制数 + * 返回mysqli_stmt预处理类对象:$stmt = $mysqli->prepare($insert) + * 一次性将结果全取出来:store_result() + * + */ + +//使用面向对象的方式： +$mysqli = new mysqli("localhost","root","root","hibernate"); +if (mysqli_connect_errno()){ + echo "连接失败：".mysqli_connect_error(); + $mysqli = null; + exit(); +} +$mysqli->autocommit(true); +$insert = "insert into users values (?,?,?);"; +//1.返回mysqli_stmt预处理类对象 +$stmt = $mysqli->stmt_init(); +//准备一条语句放在服务器上 +$stmt->prepare($insert); +//2.mysqli的方式(简化了操作) +//$stmt = $mysqli->prepare($insert); +$stmt->bind_param("isd",$id,$name,$price); +$id = 32; +$name = "ssssss"; +$price = 21.23; +//绑定之后开始执行了 +if ($stmt->execute()){ + echo "执行成功"; +}else { + echo "执行失败"; +} + + +//2.处理结果集 +//准备好语句 +$select = "select * from users where id > ?"; +//准备一条语句放在服务器上 +$stmt->prepare($select); +$stmt->bind_param("i",$select_id); +//绑定结果集（要与查询的字段个数相同） +$stmt->bind_result($id,$name,$price); +$select_id = 12; +//绑定之后开始执行了 +if ($stmt->execute()){ + echo "执行成功"; +}else { + echo "执行失败"; +} +//获取结果集（每次获取） +while ($stmt->fetch()){ + echo "
$id $name $price"; +} +echo "
记录总数：".$stmt->num_rows; + +//一次性将结果全取出来 +$stmt->store_result(); +//字段信息 +$result = $stmt->result_metadata(); +while ($field = $result->fetch_field()){ + echo "
".$field->name; +} + +$stmt->free_result(); +$stmt->close(); +$mysqli->close(); +?> + +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/取消内存限制.md b/docs/6. 【清单 ToDo】/随笔记/取消内存限制.md new file mode 100644 index 0000000..288b3e8 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/取消内存限制.md @@ -0,0 +1,3 @@ +``` +ini_set('memory_limit','-1'); +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/可以接入的第三方登录（整理）.md b/docs/6. 【清单 ToDo】/随笔记/可以接入的第三方登录（整理）.md new file mode 100644 index 0000000..4da24c5 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/可以接入的第三方登录（整理）.md @@ -0,0 +1,7 @@ +QQ +微博 +微信 +百度 +脉脉 +GitHub +领英 \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/可参考网站.md b/docs/6. 【清单 ToDo】/随笔记/可参考网站.md new file mode 100644 index 0000000..ed9162b --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/可参考网站.md @@ -0,0 +1,10 @@ +天天阅词 +https://www.tiantianyueci.com/ + +抓鸟 +https://dict.zhuaniao.com/# + + +翻译： +使用条款; 服务条款 +terms of use \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/文件备份/.keep b/docs/6. 【清单 ToDo】/随笔记/文件备份/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/6. 【清单 ToDo】/随笔记/文件备份/page_login.css.bak.md b/docs/6. 【清单 ToDo】/随笔记/文件备份/page_login.css.bak.md new file mode 100644 index 0000000..293baea --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/文件备份/page_login.css.bak.md @@ -0,0 +1,666 @@ +/recite-words/static/css/page_login.css.bak + +```css +audio, +body, +caption, +div, +footer, +form, +h1, +h2, +h3, +h4, +h5, +h6, +header, +html, +iframe, +label, +legend, +li, +main, +mark, +menu, +nav, +ol, +p, +section, +span, +summary, +table, +textarea, +time, +ul, +video { + padding: 0; + margin: 0; + border: 0; + outline: 0 none; +} +html { + position: relative; + min-height: 100%; +} +html, +body { + width: 100%; + margin: 0; + padding: 0; +} +body { + margin-bottom: 60px; + overflow-x: hidden; +} +.mdui-drawer-body-left footer { + width: calc(100% - 240px); +} +main { + position: relative; + top: 0; + left: 0; + right: 0; + margin: 1.7rem 0; +} +main .login-container, +main .register-container { + margin-top: 4rem; + margin-bottom: 4rem; +} +main .upload-container .title { + margin: 1rem 0; +} +main .upload-container .title h1 { + font-weight: 300; + font-size: 2rem; + text-shadow: -5px 5px 0 rgba(0, 0, 0, 0.1); +} +main .upload-container .title p { + margin-top: 1rem; + font-size: 0.8rem; + color: #999; +} +main .upload-container .success-info { + margin-top: 1rem; + width: 0; +} +main .upload-container .success-info .mdui-tab a { + text-transform: inherit; +} +main .upload-container .success-info ul { + list-style: none; +} +main .upload-container .success-info ul li { + position: relative; + margin-top: 0.5rem; + padding: 0.8rem; + border: 1px solid #dadada; + background-color: #f7f7f7; + font-size: 14px; + color: #555; + white-space: pre-wrap; + word-break: break-all; + word-wrap: break-word; + border-radius: 0; + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; +} +main .upload-container .success-info ul li i.icon-copy { + display: none; +} +main .upload-container .success-info ul li:hover i.icon-copy { + display: block; + position: absolute; + top: 4px; + font-size: 25px; + right: 10px; + color: #00b0ff; + cursor: pointer; +} +main .console-container .mdui-table td, +main .console-container .mdui-table th { + padding: 12px 28px; +} +main .console-container div.item i.mdui-icon { + float: left; + font-size: 3.7rem; +} +main .console-container div.item > div { + border-radius: 3px; +} +main .console-container div.item > div p { + margin-bottom: 25px; +} +main .system-container .mdui-textfield-label { + pointer-events: inherit; +} +main .system-container .mdui-textfield { + overflow: inherit; +} +main .images-container #info .mdui-dialog-content { + word-break: break-all; + word-wrap: break-word; +} +main .images-container #info .mdui-btn-group .mdui-btn { + margin-left: 0; + min-width: inherit; +} +main .images-container #info img.qrcode { + text-align: center; + margin-top: 0.4rem; +} +main .images-container #info .mdui-dialog-content { + padding-bottom: 0; +} +main .images-container #info table { + width: 100%; +} +main .images-container #info table tbody tr td[align="right"] { + width: 50px; + color: #998; +} +main .images-container .box { + min-height: 10rem; +} +main .images-container .folders-box .item, +main .images-container .images-box .item { + position: relative; + padding: 2rem 0.4rem 0.4rem; + text-align: center; + width: 100%; + height: auto; + transition: all 0.1s; + border: 1px solid transparent; + margin-top: 1rem; +} +main .images-container .folders-box .item i.iconfont, +main .images-container .images-box .item i.iconfont { + display: none; + position: absolute; + cursor: pointer; + font-size: 19px; +} +main .images-container .folders-box .item i.icon-choice, +main .images-container .images-box .item i.icon-choice { + top: 5px; + left: 5px; + color: #cecece; +} +main .images-container .folders-box .item i.icon-choice:hover, +main .images-container .images-box .item i.icon-choice:hover { + color: #999; +} +main .images-container .folders-box .item i.icon-info, +main .images-container .images-box .item i.icon-info { + top: 5px; + right: 5px; + color: #129cff; +} +main .images-container .folders-box .item:hover, +main .images-container .images-box .item:hover { + background-color: #ebebeb; +} +main .images-container .folders-box .item.choice, +main .images-container .images-box .item.choice { + background: rgba(204, 232, 255, 0.5); + border: 1px solid rgba(153, 209, 255, 0.57); +} +main .images-container .folders-box .item.choice i.icon-choice, +main .images-container .images-box .item.choice i.icon-choice { + display: block; + color: #3b8cff; +} +main .images-container .folders-box .item:hover i.icon-choice, +main .images-container .images-box .item:hover i.icon-choice, +main .images-container .folders-box .item.choice i.icon-choice, +main .images-container .images-box .item.choice i.icon-choice, +main .images-container .folders-box .item:hover i.icon-info, +main .images-container .images-box .item:hover i.icon-info, +main .images-container .folders-box .item.choice i.icon-info, +main .images-container .images-box .item.choice i.icon-info { + display: block; +} +main .images-container .folders-box .item .info, +main .images-container .images-box .item .info { + cursor: pointer; + height: 90px; + overflow: hidden; + display: block; + text-align: center; + vertical-align: middle; +} +main .images-container .folders-box .item .info img, +main .images-container .images-box .item .info img { + max-height: 100%; + max-width: 100%; + border-radius: 0; + position: relative; + top: 50%; + transform: translateY(-50%); +} +main .images-container .folders-box .item .info.image img, +main .images-container .images-box .item .info.image img { + -webkit-box-shadow: 1px 1px 5px rgba(0, 0, 0, 0.2); + -moz-box-shadow: 1px 1px 5px rgba(0, 0, 0, 0.2); + box-shadow: 1px 1px 5px rgba(0, 0, 0, 0.2); +} +main .images-container .folders-box .item p.name, +main .images-container .images-box .item p.name { + color: #555; + cursor: default; + text-align: center; + word-break: break-all; + font-size: 12px; + margin: 0.3rem auto; + line-height: 1.5em; + overflow: hidden; + display: -webkit-box; + -webkit-box-orient: vertical; + -webkit-line-clamp: 3; +} +main .mdui-textfield .captcha { + position: absolute; + top: 34px; + right: 0; + bottom: 0; + width: 140px; + cursor: pointer; +} +main ul.breadcrumb { + display: block; + flex-wrap: wrap; + padding: 0.65rem 1rem; + margin-bottom: 0.5rem; + list-style: none; + background-color: #e9ecef; + border-radius: 0.2rem; + font-size: 13px; +} +main ul.breadcrumb li { + display: inline-block; +} +main ul.breadcrumb li + li { + padding-left: 0.2rem; +} +main ul.breadcrumb li + li:before { + display: inline-block; + padding-right: 0.2rem; + color: #6c757d; + content: "/"; +} +main ul.breadcrumb li a { + cursor: pointer; +} +main ul.breadcrumb li.active a { + cursor: default; + color: #6c757d; +} +main .mdui-table td, +main .mdui-table th { + padding: 0 10px; +} +main .mask { + position: absolute; + top: -1px; + left: -1px; + right: -1px; + bottom: -1px; + background: rgba(255, 255, 255, 0.47058824); + z-index: 99; +} +main .mask .content { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + z-index: 100; +} +.krajee-default .file-footer-caption { + margin-bottom: 28px; +} +.krajee-default .file-thumb-progress .progress, +.krajee-default .file-thumb-progress .progress-bar { + height: 20px; + font-size: 12px; +} +.file-input { + font-size: 1rem; +} +.file-input .file-preview { + border: none; + box-shadow: 0 0 15px 0 rgba(0, 0, 0, 0.13); +} +.file-input .file-preview .fileinput-remove { + top: 6px; + right: 6px; +} +.file-input .file-preview .file-drop-zone-title { + font-size: 1.2em; +} +.file-input .file-preview .file-preview-thumbnails .krajee-default.file-preview-frame { + border: 2px solid transparent; + transition: all 0.3s; + box-shadow: 0 0 15px 0 rgba(0, 0, 0, 0.13); +} +.file-input .file-preview .file-preview-thumbnails .krajee-default.file-preview-frame.hover { + border: 2px solid red; +} +.file-input .file-preview .kv-fileinput-error ul { + list-style: none; +} +.file-input .file-caption-main .form-control { + box-shadow: 0 2px 15px 0 rgba(0, 0, 0, 0.13); + border: none; + height: 40px; + padding: 8px 18px; +} +.file-input .file-caption-main .form-control:focus { + z-index: 0; +} +.file-input .file-caption-main .btn { + padding: 8px 18px; + border: 0; +} +.file-input .file-caption-main .btn:first-child { + border-left: 1px solid #e2e2e2; +} +.file-input .file-caption-main .btn:last-child { + margin-right: -1px; +} +.file-input .file-caption-main .btn-file { + border-color: #2383eb; + background-color: #2383eb; +} +.file-input .file-caption-main .input-group-append { + box-shadow: 0 0 15px 0 rgba(0, 0, 0, 0.13); +} +.file-input .file-caption-main .input-group-append .btn { + box-shadow: 0 2px 15px 0 rgba(0, 0, 0, 0.13); +} +.file-input .file-caption-main .file-caption .file-caption-name { + font-size: 90%; +} +.file-zoom-fullscreen.modal { + z-index: 999999; +} +.mdui-tab-scrollable { + padding-left: 0; +} +.mdui-table-fluid { + box-shadow: 0 0 10px 0 rgba(45, 45, 45, 0.13); + border-radius: 5px; + border: none; +} +.mdui-btn-raised { + box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2), 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12); +} +.panel { + padding: 0; + overflow: hidden; + white-space: normal; + word-break: break-all; + box-shadow: 0 0 20px 0 rgba(0, 0, 0, 0.13); + border-radius: 0.5rem; +} +.panel .panel-header { + padding: 1rem; +} +.panel .panel-body { + border-top: 1px solid #f1f1f1; + border-bottom: 1px solid #f1f1f1; + padding: 1rem; +} +.panel .panel-body-box { + border-top: 1px solid #f1f1f1; + padding: 1rem; + border-bottom-left-radius: 0.5rem; + border-bottom-right-radius: 0.5rem; +} +.panel .panel-footer { + padding: 1rem; +} +.error-box { + border: none; + margin: 0; +} +.none { + display: none; +} +#loading-container { + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + display: none; +} +#loading-container .mask { + position: absolute; + width: 100%; + z-index: 9999; +} +#loading-container .loading { + position: absolute; + top: 5rem; + right: 1rem; + z-index: 10000; +} +.panel-box { + overflow: hidden; + white-space: normal; + word-break: break-all; + box-shadow: 0 0 20px 0 rgba(0, 0, 0, 0.13); + border-radius: 0.5rem; + padding: 1rem; +} +#menu .quota-container { + position: absolute; + left: 50%; + bottom: 2rem; + text-align: left; + transform: translateX(-50%); +} +#menu .quota-container progress { + background-color: #f6f6f6; + display: inline; + height: 0.5rem; +} +#menu .quota-container progress::-webkit-progress-bar { + background-color: #e0eaf0; +} +#menu .quota-container progress::-webkit-progress-value { + background-color: #1abc9c; +} +#menu .quota-container progress::-moz-progress-bar { + background-color: #e0eaf0; +} +#menu .quota-container progress::-moz-progress-value { + background-color: #708d9b; +} +#fab-buttons.mdui-fab-wrapper { + margin-bottom: 4rem; +} +#search-form .search-input { + display: inline-block; + padding-bottom: 0.6rem; + width: 140px; +} +footer { + position: absolute; + bottom: 0; + width: 100%; + height: 60px; + line-height: 60px; + color: #999; + text-align: left; + background-color: #f5f5f5; + z-index: -1; +} +.pagination { + display: inline-block; + padding-left: 0; + margin: 20px 0; + border-radius: 4px; +} +.pagination > li { + display: inline; +} +.pagination > li > a, +.pagination > li > span { + position: relative; + float: left; + text-decoration: none; + color: #00b5ad; + background-color: #fff; + border: 1px solid #ddd; + margin-left: -1px; + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; +} +.pagination > li:first-child > a, +.pagination > li:first-child > span { + margin-left: 0; + border-bottom-left-radius: 3px; + border-top-left-radius: 3px; +} +.pagination > li:last-child > a, +.pagination > li:last-child > span { + border-bottom-right-radius: 3px; + border-top-right-radius: 3px; +} +.pagination > li > a:hover, +.pagination > li > a:focus, +.pagination > li > span:hover, +.pagination > li > span:focus { + z-index: 2; + color: #22ddde; + background-color: #eeeeee; + border-color: #ddd; +} +.pagination > .active > a, +.pagination > .active > a:hover, +.pagination > .active > a:focus, +.pagination > .active > span, +.pagination > .active > span:hover, +.pagination > .active > span:focus { + z-index: 3; + color: #e4e4e4; + background-color: transparent; + border-color: #e4e4e4; + cursor: default; +} +.pagination > .disabled > span, +.pagination > .disabled > span:hover, +.pagination > .disabled > span:focus, +.pagination > .disabled > a, +.pagination > .disabled > a:hover, +.pagination > .disabled > a:focus { + color: #777777; + background-color: #fff; + border-color: #ddd; + cursor: not-allowed; +} +body.mdui-theme-layout-dark .markdown-body { + color: #eaeaea; +} +body.mdui-theme-layout-dark .markdown-body a { + color: #64adff; +} +body.mdui-theme-layout-dark .markdown-body img { + background-color: rgba(0, 0, 0, 0); +} +body.mdui-theme-layout-dark .markdown-body .highlight pre, +body.mdui-theme-layout-dark .markdown-body pre { + background-color: #585858; +} +body.mdui-theme-layout-dark .markdown-body table tr { + background-color: #4c4c4c; +} +body.mdui-theme-layout-dark .markdown-body table tr:nth-child(2n) { + background-color: #5d5d5d; +} +body.mdui-theme-layout-dark .pagination > .disabled > span, +body.mdui-theme-layout-dark .pagination > .disabled > span:hover, +body.mdui-theme-layout-dark .pagination > .disabled > span:focus, +body.mdui-theme-layout-dark .pagination > .disabled > a, +body.mdui-theme-layout-dark .pagination > .disabled > a:hover, +body.mdui-theme-layout-dark .pagination > .disabled > a:focus, +body.mdui-theme-layout-dark .pagination > li > a, +body.mdui-theme-layout-dark .pagination > li > span { + background-color: #2b2b2b; +} +body.mdui-theme-layout-dark .mdui-btn, +body.mdui-theme-layout-dark .mdui-theme-accent-indigo .mdui-dialog-actions .mdui-btn { + color: white !important; +} +body.mdui-theme-layout-dark main .mask { + background-color: rgba(47, 45, 45, 0.47058824); +} +body.mdui-theme-layout-dark main .mask .content .mdui-color-white { + color: white !important; + background-color: rgba(76, 76, 76, 0.78) !important; +} +body.mdui-theme-layout-dark main .images-container .folders-box .item p.name, +body.mdui-theme-layout-dark main .images-container .images-box .item p.name { + color: #a0a0a0; +} +body.mdui-theme-layout-dark main .images-container .folders-box .item:hover, +body.mdui-theme-layout-dark main .images-container .images-box .item:hover { + background-color: #212121; +} +body.mdui-theme-layout-dark main ul.breadcrumb { + background-color: #3e3e3e; +} +body.mdui-theme-layout-dark main ul.breadcrumb li.active a { + color: #c3c3c3; +} +body.mdui-theme-layout-dark main .upload-container .success-info ul li { + border: 1px solid #888888; + background-color: #303030; + color: #d4d4d4; +} +body.mdui-theme-layout-dark footer { + background-color: #303030; +} +body.mdui-theme-layout-dark .modal-content { + background-color: #333; +} +body.mdui-theme-layout-dark .file-input .file-preview { + box-shadow: 0 0 15px 0 rgba(0, 0, 0, 0.2); +} +body.mdui-theme-layout-dark .file-input .file-caption-main .btn:first-child { + border-left: 0; +} +body.mdui-theme-layout-dark .file-input .file-caption-main .form-control { + color: #bababa; + background-color: #303030; + box-shadow: 0 0 15px 0 rgba(0, 0, 0, 0.2); +} +body.mdui-theme-layout-dark .file-input .file-caption-main .form-control .file-caption-name { + color: #c1c1c1; +} +@media (max-width: 768px) { + body { + margin-bottom: 120px; + } + .krajee-default.file-preview-frame { + width: 95%; + } + .krajee-default.file-preview-frame .kv-file-content { + width: 100%; + height: 100%; + } + #loading-container .loading { + top: 4.5rem; + } + main .images-container #info img.qrcode { + width: 150px; + } + footer { + height: auto; + width: 100% !important; + line-height: 1.666; + padding: 1rem 0; + } +} +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/绘制随机不规则三角彩条.md b/docs/6. 【清单 ToDo】/随笔记/绘制随机不规则三角彩条.md new file mode 100644 index 0000000..c523d04 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/绘制随机不规则三角彩条.md @@ -0,0 +1,67 @@ +https://zhuanlan.zhihu.com/p/28257724 +https://cloud.tencent.com/developer/article/1619012 + + +![](https://pic1.zhimg.com/v2-c84e0527949ec8f63832ad757f18d3c9_1440w.jpg?source=172ae18b) + +```html + + + +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/被弃用的url.php.md b/docs/6. 【清单 ToDo】/随笔记/被弃用的url.php.md new file mode 100644 index 0000000..bed468a --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/被弃用的url.php.md @@ -0,0 +1,45 @@ +```php +$param) + { + $tmp[] = $k.'='.urlencode($param); + } + $params = implode('&',$tmp); + return $params; + } +} +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/让PHP程序永远在后台运行.md b/docs/6. 【清单 ToDo】/随笔记/让PHP程序永远在后台运行.md new file mode 100644 index 0000000..66cd70a --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/让PHP程序永远在后台运行.md @@ -0,0 +1,36 @@ +让PHP程序永远在后台运行 +https://www.cnblogs.com/lookphp/p/5276530.html + +PHP里有个函数很有用。这是在最近的开发中才逐渐用到的。 +int ignore_user_abort ( [bool setting] ) +这个函数的作用是指示服务器端在远程客户端关闭连接后是否继续执行下面的脚本。 + +setting 参数是一个可选参数。如设置为True，则表示如果用户停止脚本运行，仍然不影响脚本的运行（即：脚本将持续执行）；如果设置为False，则表示当用户停止运行脚本程序时，脚本程序将停止运行。 + +下面这个例子，在用户关闭浏览器后，该脚本仍然后在服务器上继续执行： + + +```php +ignore_user_abort(); // 后台运行 +set_time_limit(0); // 取消脚本运行时间的超时上限 +do { + sleep(60); // 休眠1分钟 +}while(true); +``` + +------------ + +```php + +``` \ No newline at end of file diff --git a/docs/6. 【清单 ToDo】/随笔记/随笔记.md b/docs/6. 【清单 ToDo】/随笔记/随笔记.md new file mode 100644 index 0000000..4698c80 --- /dev/null +++ b/docs/6. 【清单 ToDo】/随笔记/随笔记.md @@ -0,0 +1,553 @@ +`$a ?? 0` 等同于 `isset($a) ? $a : 0`。 +`$a ?: 0` 等同于 `$a ? $a : 0`。 +`empty`：判断一个变量是否为空(`null` `false` `00` `0` `'0'`这类，都会返回`true`)。 +`isset`：判断一个变量是否设置(值为`false` `00` `0` `'0'`这类，也会返回`true`)。 + +```php +// session_status() +// https://www.php.net/manual/zh/function.session-status.php +// 返回值 +// PHP_SESSION_DISABLED 会话是被禁用的。 +// PHP_SESSION_NONE 会话是启用的，但不存在当前会话。 +// PHP_SESSION_ACTIVE 会话是启用的，而且存在当前会话。 +``` + +------------ + +mysql.php参考 +```php +// 参考文章：https://www.cnblogs.com/liujunhang/p/10926632.html +// PHP 官网 关于MySQL的介绍：https://www.php.net/manual/zh/set.mysqlinfo.php +``` + +------------ + +mysql +``` +// 常用sql语句总结 +// 在上面的代码中，我们尝试了通过mysqli对mysql数据进行的增删改查操作，其中较为核心的是，sql语句的使用。 +// 下面我们来说一下常用的sql语句语法： + +// 创建数据库 +// create database 数据库名 default character set = 'utf8'; +// 创建数据表 +// create table 数据表名 ( +// -- 下面是表中的一些字段 +// id INT(6) UNSIGNED AUTO_INCREMENT PRIMARY KEY, +// firstname VARCHAR(30) NOT NULL, +// lastname VARCHAR(30) NOT NULL, +// email VARCHAR(50), +// reg_date TIMESTAMP +// ) +// 插入数据 +// insert into table_name (column1, column2, column3,...) values (value1, value2, value3,...) +// 读取数据 +// select column_name(s) from table_name +// 如果传入一个*，则表示搜索所有的数据： + +// select * from table_name +// 也可以在后面加入指定条件 + +// select * from table_name where 条件 +// 修改 +// update table_name +// set column1=value, column2=value2,... +// where some_column=some_value + +// 删除数据 +// delete from table_name +// where some_column = some_value +``` + +------------ + +会话相关 +```php +// // 初始化会话。 +// // 如果要使用会话，别忘了现在就调用： +// session_start(); + +// // 重置会话中的所有变量 +// $_SESSION = array(); + +// // 如果要清理的更彻底，那么同时删除会话 cookie +// // 注意：这样不但销毁了会话中的数据，还同时销毁了会话本身 +// if (ini_get("session.use_cookies")) { +// $params = session_get_cookie_params(); +// setcookie(session_name(),"", -1, +// $params["path"], $params["domain"], +// $params["secure"], $params["httponly"] +// ); +// } + +// // 最后，销毁会话 +// session_destroy(); + +------------------------------------------------------ + +// //开启 Session +// session_start(); +// // 删除所有 Session 变量 +// $_SESSION = array(); +// //判断 cookie 中是否保存 Session ID +// if(isset($_COOKIE[session_name()])){ +// setcookie(session_name(),'',time()-3600, '/'); +// } +// //彻底销毁 Session +// session_destroy(); +``` + +------------ + +``` +//SQL join 用于把来自两个或多个表的行结合起来。 + + +/* +https://zhidao.baidu.com/question/1835987585872639700.html +SQL语句中AS的意思是：别名。 + +AS用处： +query时 + +用来重新指定返回的column名字。 + +示例 + +一个table有个column叫 id，query是select id from table1 + +如果不想叫id，就可重新命名。 + +如叫 systemID，可这样写：select id as systemId from table1。 + +create table 或 procedure 时 + +as 是个关键字。 + +示例 + +create table test as select * from table1 + +这时会create 一个table test，完全copy table table1里的全部数据。 + +create procdure name as （is） + +begin + +end;这时as和is可以互换。 + */ +``` + +------------ + +mysql-connect(full).php.bak +```php +connect_error){ + die("连接失败，错误:" . $conn->connect_error ."
"); +} + +// 否则连接成功 +echo "数据库连接成功!
"; + +// *************************************************** 通过mysqli 创建数据库 *************************************************** + +// /* +// * 通过mysqli 创建数据库 创建连接语句：$conn = new mysqli($mysql_server_name, $mysql_username, $mysql_password); +// */ +// // 设置sql语句 +// $sql = "create database stu_01 default character set = 'utf8' "; +// // 发送sql语句 并且验证是否创建成功 +// if($conn->query($sql) === TRUE){ +// echo "数据库创建成功."; +// }else { +// echo "数据库创建失败 ，错误信息为:" . $conn->error; // 如果失败输出错误信息 +// } + +// *************************************************** 通过mysqli 创建数据表 *************************************************** + +// // 使用sql 创建数据表 +// $sql = "create table stu_info( +// id int(6) UNSIGNED auto_increment primary key, +// firstname varchar(30) not null, +// lastname varchar(30) not null, +// email varchar(50), +// reg_date timestamp +// )"; + +// if($conn->query($sql) === TRUE){ +// echo "数据表创建成功。" ."
"; +// }else { +// echo "数据表创建失败,错误信息:" . $conn->error ."
"; +// } + +// *************************************************** 通过mysqli 向数据表中插入信息 *************************************************** + +// // 设置插入数据的sql语句 +// $sql = "insert into stu_info(firstname,lastname,email) values('张三','张小三','zhangsan@qq.com')"; + +// // 发送sql 语句 +// if($conn->query($sql) === TRUE){ +// echo "新记录添加成功!"."
"; +// }else { +// echo "新记录添加失败，错误信息:" . $conn->error ."
"; +// } + + +// // 下面开始插入多条数据 + +// $sql = "insert into stu_info(firstname,lastname,email) values('张三丰','张君宝','sanfeng@qq.com');"; +// // 使用.= 的形式进行sql语句连接 +// $sql .= "insert into stu_info(firstname,lastname,email) values('东方不败','东方拜拜','dongfang@qq.com');"; + +// // 发送sql +// if($conn->multi_query($sql) === TRUE) { +// echo "数据添加成功!" . '
'; +// }else{ +// echo "数据添加失败,错误信息如下: " . $conn->connect_error . '
'; +// } + +// *************************************************** 通过mysqli 读取数据据库中的信息 *************************************************** + +// // 设置sql 语句，查询全部数据 +// $sql = "select * from stu_info"; +// // $sql = "select id ,firstname,lastname from stu_info;"; +// // $sql = "select * from stu_info where id > 3;"; + +// // 发送sql语句，获得查询结果 +// $result = $conn->query($sql); + +// // 如果查询的结果>0表示查询成功，那么就可以将数据输出 +// // 函数 num_rows() 判断返回的数据。 + +// // 如果返回的是多条数据，函数 fetch_assoc() 将结合集放入到关联数组并循环输出。 +// if(isset($result->num_rows) && $result->num_rows > 0) { +// // 输出数据 +// while($row = $result->fetch_assoc()){ +// echo "id" . $row['id'] . '- Name:' . $row['firstname'] . " " . $row['lastname'] . '
'; +// } +// }else { +// echo "暂无数据" . '
'; +// } + +// *************************************************** 通过mysqli 删除数据 *************************************************** + +// // 设置sql +// $sql = "delete from stu_info where lastname = '东方拜拜';"; + +// // 发送sql +// if($conn->query($sql) === TRUE) { +// echo "删除成功" . '
'; +// }else { +// echo "删除失败，错误信息为:" . $conn->connect_error . '
'; +// } + +// *************************************************** 通过mysqli 删除数据 *************************************************** + +// // 设置sql语句 +// $sql = "update stu_info set firstname='张小三小三小三小三小三' where id = 4"; + +// // 发送sql语句 +// if($conn->query($sql) === TRUE) { +// echo "修改成功" . '
'; +// }else { +// echo "修改失败，错误信息:" . $conn->connect_error . '
'; +// } + + + +// *************************************************** 清空数据表 *************************************************** + +// $sql = "TRUNCATE `$mysql_database`.`stu_info`"; + +// // 发送sql语句，获得查询结果 +// $result = $conn->query($sql); + +// *************************************************** 关闭数据库连接 *************************************************** + +// 连接之后，还需要将连接关闭 +$conn->close(); + + + + + + + + + + +// 常用sql语句总结 +// 在上面的代码中，我们尝试了通过mysqli对mysql数据进行的增删改查操作，其中较为核心的是，sql语句的使用。 +// 下面我们来说一下常用的sql语句语法： + +// 创建数据库 +// create database 数据库名 default character set = 'utf8'; +// 创建数据表 +// create table 数据表名 ( +// -- 下面是表中的一些字段 +// id INT(6) UNSIGNED AUTO_INCREMENT PRIMARY KEY, +// firstname VARCHAR(30) NOT NULL, +// lastname VARCHAR(30) NOT NULL, +// email VARCHAR(50), +// reg_date TIMESTAMP +// ) +// 插入数据 +// insert into table_name (column1, column2, column3,...) values (value1, value2, value3,...) +// 读取数据 +// select column_name(s) from table_name +// 如果传入一个*，则表示搜索所有的数据： + +// select * from table_name +// 也可以在后面加入指定条件 + +// select * from table_name where 条件 +// 修改 +// update table_name +// set column1=value, column2=value2,... +// where some_column=some_value + +// 删除数据 +// delete from table_name +// where some_column = some_value +``` + +------------ + +csrf document.txt +``` +[https://www.zhihu.com/question/60102253] + +PHP加了Token验证表单防止CSRF后还有必要做其它的防范吗?比如判断REFERER，再加个验证码之类的？有没有这个必要，目前再写一个模板做练习，已经加上了Token验证，准备再加上判断REFERER时突然觉得这样会不会有点多此一举？或则有什么其它更好的方法吗？ + + +目前的代码是这样的，先判断来源，再判断Token + +//判断请求-登陆 +if($_GET['login']=='action'){ + //判断REFERER + $referer = $_SERVER["HTTP_REFERER"]; //获取前一页面的 URL 地址 + $url = $_SERVER["HTTP_HOST"]; //获取本页面的主机 URL 地址 + //echo "来源页面:$referer
本地页面:$url
"; //输出结果(测试用) + if(preg_match("|$url|", $referer)){ + //来源通过，判断Token令牌 + session_start(); + if($_POST['token'] == $_SESSION['token']){ + unset($_SESSION['token']); + echo "这是一个正常的提交请求"; + }else{ + echo "这是一个非法的提交请求"; + } + }else{ + echo '非法来源的请求'; + } +} + + + +[https://blog.csdn.net/qq_31752115/article/details/103775475] +php如何防止csrf攻击 + +CSRF概念：CSRF跨站点请求伪造(Cross—Site Request Forgery)，跟XSS攻击一样，存在巨大的危害性，你可以这样来理解： + +攻击者盗用了你的身份，以你的名义发送恶意请求，对服务器来说这个请求是完全合法的，但是却完成了攻击者所期望的一个操作，比如以你的名义发送邮件、发消息，盗取你的账号，添加系统管理员，甚至于购买商品、虚拟货币转账等。（推荐学习：PHP编程从入门到精通） + +如：其中Web A为存在CSRF漏洞的网站，Web B为攻击者构建的恶意网站，User C为Web A网站的合法用户。 + +防御CSRF攻击： + +目前防御 CSRF 攻击主要有三种策略：验证 HTTP Referer 字段；在请求地址中添加 token 并验证；在 HTTP 头中自定义属性并验证。 + +（1）验证 HTTP Referer 字段 + +根据 HTTP 协议，在 HTTP 头中有一个字段叫 Referer，它记录了该 HTTP 请求的来源地址。在通常情况下，访问一个安全受限页面的请求来自于同一个网站，比如需要访问 http://bank.example/withdraw?account=bob&amount=1000000&for=Mallory，用户必须先登陆 bank.example，然后通过点击页面上的按钮来触发转账事件。 + +这时，该转帐请求的 Referer 值就会是转账按钮所在的页面的 URL，通常是以 bank.example 域名开头的地址。而如果黑客要对银行网站实施 CSRF 攻击，他只能在他自己的网站构造请求，当用户通过黑客的网站发送请求到银行时，该请求的 Referer 是指向黑客自己的网站。 + +因此，要防御 CSRF 攻击，银行网站只需要对于每一个转账请求验证其 Referer 值，如果是以 bank.example 开头的域名，则说明该请求是来自银行网站自己的请求，是合法的。如果 Referer 是其他网站的话，则有可能是黑客的 CSRF 攻击，拒绝该请求。 + +（2）在请求地址中添加 token 并验证 + +CSRF 攻击之所以能够成功，是因为黑客可以完全伪造用户的请求，该请求中所有的用户验证信息都是存在于 cookie 中，因此黑客可以在不知道这些验证信息的情况下直接利用用户自己的 cookie 来通过安全验证。 + +要抵御 CSRF，关键在于在请求中放入黑客所不能伪造的信息，并且该信息不存在于 cookie 之中。 + +可以在 HTTP 请求中以参数的形式加入一个随机产生的 token，并在服务器端建立一个拦截器来验证这个 token，如果请求中没有 token 或者 token 内容不正确，则认为可能是 CSRF 攻击而拒绝该请求。 + +（3）在 HTTP 头中自定义属性并验证 + +这种方法也是使用 token 并进行验证，和上一种方法不同的是，这里并不是把 token 以参数的形式置于 HTTP 请求之中，而是把它放到 HTTP 头中自定义的属性里。通过 XMLHttpRequest 这个类，可以一次性给所有该类请求加上 csrftoken 这个 HTTP 头属性，并把 token 值放入其中。这样解决了上种方法在请求中加入 token 的不便，同时，通过 XMLHttpRequest 请求的地址不会被记录到浏览器的地址栏，也不用担心 token 会透过 Referer 泄露到其他网站中去。 +``` + +------------ + +note____.txt +```php + + + + + +查询IP（有道）API +https://foundation.youdao.com/ip/ipinfo + +如果有标DJ的是英式音标，标KK的是美式音标。bai +比如你查一个词coat，DJ：du[kəut]，KK：[kot]。 + + +若页面需默认用 极速 速核，增加标签： +若页面需默认用ie兼容内核，增加标签： +若页面需默认用ie标准内核，增加标签： + + + +HTML5 Boilerplate 使用相对协议请求 Google CDN 中的 jQuery ，使用方式为： + + + +上面的例子中除了引用 Google CDN 中的文件外，还添加了一个本地 jQuery 链接，以便连接 Google CDN 失败后，使用本地副本。 + + + +分享到QQ的缩略图显示设置：未确认是否有效？ + + + + + +H5手Q分享通用接口代码片段（https://blog.csdn.net/qq_35432904/article/details/81704321） + + + + + + +error_reporting(0);//禁用错误报告 +error_reporting(E_ALL ^ E_NOTICE);//显示除去 E_NOTICE 之外的所有错误信息 +error_reporting(E_ALL^E_WARNING^E_NOTICE);//显示除去E_WARNING E_NOTICE 之外的所有错误信息 +error_reporting(E_ERROR | E_WARNING | E_PARSE);//显示运行时错误，与error_reporting(E_ALL ^ E_NOTICE);效果相同。 +error_reporting(E_ALL);//显示所有错误 + +js: + // var flags = [ + // {flag:'1',info:'清香1'}, + // {flag:'2',info:'清香2'}, + // {flag:'3',info:'清香3'}, + // {flag:'4',info:'清香4'}, + // {flag:'5',info:'清香5'}]; + // var arr = '4'; + // flags.map(e=>{ if(arr == e.flag){ console.log(e.info); alert(e.info);} }) + + + +HTMl中Meta标签 参考：https://www.cnblogs.com/cxzhome/p/8448463.html + + +详解HTML5中rel属性的prefetch预加载功能使用：https://www.cnblogs.com/suyuwen1/p/5506397.html + + +header('Content-Type: text/html; charset=utf-8'); //网页编码 + +header('Content-Type: text/plain'); //纯文本格式 + +header('Content-Type: image/jpeg'); //JPG、JPEG + +header('Content-Type: application/zip'); // ZIP文件 + +header('Content-Type: application/pdf'); // PDF文件 + +header('Content-Type: audio/mpeg'); // 音频文件 + +header('Content-type: text/css'); //css文件 + +header('Content-type: text/javascript'); //js文件 + +header('Content-type: application/json'); //json + +header('Content-type: application/pdf'); //pdf + +header('Content-type: text/xml'); //xml + +header('Content-Type: application/x-shockw**e-flash'); //Flash动画 +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` + +------------ + +```php + +``` \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..6b69965 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,52 @@ + + +[plugin-structures](include/intro.md ':include') + +## 传送门 + +| | 网址 | +|------|------| +| 首页 | reciteword.com | +| 演示站点 | reciteword.only4.work | +| 社区(暂无) | club.reciteword.com | +| Gitee | gitee.com/only4/recite-words | + +------------ + +## 支持项目发展 + +如果您喜欢本项目的话，请点一下Star按钮，如果您想要支持本项目的话，可以请我喝杯咖啡。 + +> 所有打赏都用于本项目的持续发展，例如支付服务器费用等。打赏不支持退款，请理性打赏哦。 + + +
+ + + 看起来似乎打赏按钮没有加载出来，那就直接点[这里]吧... + + + + + +
+ +------------ + +## Licence + +本项目使用 GPL-3.0 许可证许可，如果您对该许可证不了解，请查看“关于”目录下许可证的中文非正式版本。如果您希望在许可证允许的范围外使用本项目，可以通过“关于->联系”的联系方式与我们取得联系。 + +------------ + +## 版权声明 + +我们欢迎您使用本程序，但是在使用本程序的过程中，请**不要修改或移除页脚处的版权信息**。 + +> 项目中存在检测程序，一旦您对版权声明进行修改或者删除，程序将保存证据，并启动自毁模式，我们对于由此造成的一切后果不承担责任，并保留采取进一步措施的权利。 + +------------ + +## 说明 + +限于精力和能力有限，目前暂时只有网页版，无小程序端、安卓端、iOS端、PC端。后续如果有时间的话，将会按照PC端/安卓端→小程序端→iOS端的顺序依次开发。 diff --git a/docs/_404.md b/docs/_404.md new file mode 100644 index 0000000..901bd7b --- /dev/null +++ b/docs/_404.md @@ -0,0 +1,19 @@ +# 404 未找到 + +你所访问的页面不存在或已被删除！ + +[点击这里](/)返回首页 + + +---------- + + +# 404 Not found + +The page you visited does not exist or has been deleted. + +[Click here](/) to go to home page + +---------- + +背Ta单词 \ No newline at end of file diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 0000000..fd36e05 --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,16 @@ + + +# 背Ta单词官方文档 + + +- 本文档是“背Ta单词”开源项目的官方文档，旨在为大家提供详细的部署安装及应用开发指南。 +- +[![Stars](https://gitee.com/only4/recite-words/badge/star.svg?theme=dark)](https://gitee.com/only4/recite-words/stargazers) +[![Forks](https://gitee.com/only4/recite-words/badge/fork.svg?theme=dark)](https://gitee.com/only4/recite-words/members) +[![License](https://img.shields.io/badge/License-GPL--3.0-breghtgreen)](https://gitee.com/only4/recite-words/blob/develop/LICENSE) +![Version](https://img.shields.io/badge/Version-1.0.0-blue) + +[官方网站](https://reciteword.com) +[开始阅读](README.md) + + diff --git a/docs/_footer.md b/docs/_footer.md new file mode 100644 index 0000000..09f173e --- /dev/null +++ b/docs/_footer.md @@ -0,0 +1,5 @@ +--------- + +
+背Ta单词 官方文档 +
\ No newline at end of file diff --git a/docs/_navbar.md b/docs/_navbar.md new file mode 100644 index 0000000..a39f252 --- /dev/null +++ b/docs/_navbar.md @@ -0,0 +1,13 @@ +- [主页](https://www.reciteword.com/ "背Ta单词官方网站") + +- [应用中心(暂未上线)](https:/// "应用中心") + +- [交流中心(暂未上线)](https:/// "交流中心") + +- [](https://gitee.com/ "背Ta单词 Gitee repo") + + + \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..38b5d86 --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,12 @@ +- **一、快速开始** + - [1. 简介](manual/start/introduction) + - [2. 环境要求](manual/start/requirements) + - [3. 下载安装（需要更新）](manual/start/install) + - [4. 数据库安装（需要更新）](manual/start/database) + - [5. 初次使用配置（需要更新）](manual/start/initial-configuration) + - [6. 升级（TODO）](manual/start/upgrade) + - [7. 网站备份（需要更新）](manual/start/backup) + - [7. 网站迁移（TODO）](manual/start/migration) + +- [TODO](manual/todo) +- [test](manual/test) \ No newline at end of file diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..0e65cf6 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/images/coverimg.png b/docs/images/coverimg.png new file mode 100644 index 0000000..4c03ef0 Binary files /dev/null and b/docs/images/coverimg.png differ diff --git a/docs/images/gitee.svg b/docs/images/gitee.svg new file mode 100644 index 0000000..5bc5c28 --- /dev/null +++ b/docs/images/gitee.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/github.svg b/docs/images/github.svg new file mode 100644 index 0000000..e693cd3 --- /dev/null +++ b/docs/images/github.svg @@ -0,0 +1 @@ + diff --git a/docs/include/intro.md b/docs/include/intro.md new file mode 100644 index 0000000..010d246 --- /dev/null +++ b/docs/include/intro.md @@ -0,0 +1,7 @@ +## 背Ta单词 + +> “背Ta单词”是一款网页版在线背单词系统，主打图表背单词。在背单词的过程中，显示相关单词记忆数据图表，用图表背单词，用大数据背单词，就是快！ + +本项目基于PHP平台，使用MySQL数据库。在众多框架流行的今天，反其道而行之，后端不使用第三方框架，使用原生PHP开发，快捷高效，同时可以轻易部署到云服务器、云虚拟主机等多种环境中，十分灵活。 + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..2ac45e9 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,234 @@ + + + + + 背Ta单词 官方文档 + + + + + + + + +
加载中...
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/manual/2. 使用说明/.keep b/docs/manual/2. 使用说明/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/manual/2. 使用说明/开始使用（撰写中）.md b/docs/manual/2. 使用说明/开始使用（撰写中）.md new file mode 100644 index 0000000..9c7eb32 --- /dev/null +++ b/docs/manual/2. 使用说明/开始使用（撰写中）.md @@ -0,0 +1,63 @@ +# 开始使用 + +## 访问网站 + +使用浏览器打开 `https://reciteword.com/` + + +## 功能介绍 + +> 电脑端点击左侧菜单可以切换功能，平板或手机端可以点击左上角『三』按钮展开菜单，然后便可点击相关栏目切换功能。 + +### 无需登录即可使用的功能 + +#### 首页 + +在首页，如果您还没有进行过登录操作，您可以看到一个随机显示出来的单词，这个单词来自于随机的一个词书，包含音标和中文释义等。 + +如果您登录过账号，您还可以看到您对该单词的记忆历史。首页也会优先推送您希望背诵的词书，您记忆历史中掌握相对薄弱的单词，或者该词书中相对重要，常用常考的单词。 + +注意：如果您是新注册的账号，或者您重置过单词的记忆历史，在记忆历史较少的情况下，首页仍然会显示随机单词。您可以多进行单词学习，以使得单词推荐更具有针对性。 + + +### 用户账号相关功能 + +#### 注册 + +点击右上角『登录』按钮，或者选择左侧『登录/注册』按钮，然后选择『注册』选项卡，按照页面指引填写相关个人信息，即可完成用户注册。 + +注意：用户注册需要在无用户登录的情况下进行，如果您已经进行过登录操作，则需要先进行『退出登录』操作，然后再按照上述步骤进行操作。 + + +#### 登录 + +点击右上角『登录』按钮，或者选择左侧『登录/注册』按钮，然后选择『登录』选项卡，按照页面指引填写您的用户名，密码，有时可能还需要填写验证码，点击登录按钮。 + +#### 退出登录 + +在登录状态下，点击页面右上角用户名，然后点击『退出登录』，稍等1秒即可退出登录，页面会自动刷新，完成退出登录操作。如果退出登录失败，您可以刷新网页后再次尝试。 + +#### 修改密码 + + +#### 重置密码 + + +#### 账号注销 + +【该功能程序员正在加紧开发啦，请过段时间再来关注吧~】 + +#### 用户中心 + +在登陆状态下，您可以点击菜单栏中『用户中心』按钮打开用户中心。 + +在用户中心中，您可以查看您的个人信息（为了保护您的账户安全，您的密码在设置后将永远不会明文显示在网页任何地方，如果您忘记了自己的密码，可以通过忘记密码的功能，对自己的账号密码进行重置） + + +### 登录后可使用的功能 + +> 以下功能需要先进行用户登录才可使用 + +#### 选择词书 + +在您注册用户后，或者 \ No newline at end of file diff --git a/docs/manual/start/.keep b/docs/manual/start/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/manual/start/8. 目录结构.md b/docs/manual/start/8. 目录结构.md new file mode 100644 index 0000000..8197258 --- /dev/null +++ b/docs/manual/start/8. 目录结构.md @@ -0,0 +1,191 @@ +## 文字版 + +> 最后修改日期：2021年3月23日 +> 备注：文字版比图片版更详细 + +```html + ├ about + │ ├ credits // 使用开源框架的开源协议 + │ │ ├ css // CSS样式文件 + │ │ │ ├ text_defaults.css // + │ │ ├ js // JavaScript文件 + │ │ │ ├ cr.js // + │ │ │ ├ credits.js // + │ │ ├ index.htm // + │ ├ feedback // 用户反馈 + + ├ admin + │ ├ login.php // 登录 + │ ├ index.php // 管理员后台的主路由 + │ ├ install.php // 网站安装脚本，安装之后会自动删除 + │ ├ update.php // 网站升级脚本 + + ├ api + │ ├ v1 // 接口（第1版） + │ │ ├ captcha // 验证码 + │ │ ├ upload // 用户上传文件 + │ │ │ ├ avatar // 用户头像 + │ │ │ ├ wordbook // 词书 + │ │ ├ users // 用户账户 + │ │ │ │ ├ get-status.php // 获取用户是否登录 + │ │ │ │ ├ login.php // 用户登录 + │ │ │ │ ├ logout.php // 用户注销 + │ │ │ │ ├ regist.php // 用户注册 + │ │ │ ├ words // 单词 + │ │ │ │ ├ get-random-words.php // 随机单词 + + ├ file // 和用户有关的数据 + │ ├ avatar // 用户头像 + │ │ ├ crop // 头像 + │ │ ├ original // 头像裁切前原图 + │ │ ├ thumbnail // 头像缩略图 + │ ├ upload // 用户上传的文件(按照`年-月`分文件夹存放） + │ ├ wordbook // 用户上传的词书 + + ├ resources // + │ ├ prompt // + │ │ ├ check_javascript // 检查浏览器是否支持JavaScript + │ │ │ ├ check.php // + │ │ │ ├ noscript.html // + │ │ ├ 404.php // 404页面 + │ ├ template // 前端页面模板 + │ │ ├ ...... // + │ ├ views // + │ │ ├ avatar-upload // 头像上传前端页面 + + ├ static // 静态文件 + │ ├ css // 前端CSS样式 + │ │ ├ universe.css // 全局CSS样式 + │ ├ image // 前端公用静态图片素材 + │ │ ├ ...... + │ ├ js // JavaScript脚本 + │ │ ├ app.js // + │ │ ├ ...... // + │ ├ vendor // 前端使用的第三方库 + │ │ ├ jquery // + │ │ │ ├ jquery-3.5.1.min.js // jQuery 3.5.1 + │ │ ├ mdui // + │ │ │ ├ ...... // + │ │ ├ ...... // + + ├ system + │ ├ function // 网站核心函数（用户不可以直接访问该文件夹下页面） + │ │ ├ api // api后台实现 + │ │ ├ basic // 网站基础函数 + │ │ │ ├ user.php // 用户操作 + │ │ │ │ ├ ...... // + │ │ │ ├ token.php // 令牌生成与失效 + │ │ │ │ ├ generate // 生成页面token + │ │ │ │ ├ destroy // 销毁页面token + │ │ │ ├ ...... + │ │ ├ database // 数据库连接 + │ │ │ ├ mysql.php + │ │ │ ├ sql.php + │ │ │ ├ sqlite.php + │ │ │ ├ ...... + │ │ ├ page // 页面显示时可能会用的到的一些组件 + │ │ │ ├ components // 组件（可供主题、插件调用） + │ │ │ ├ partials // 片段（可供主题、插件调用） + │ │ │ ├ public // 网站页面公共部分（导航栏、菜单、页脚等） + │ │ │ ├ ...... // 网站各个功能页面 + │ │ ├ statistics // 统计页面执行速度及使用内存 + │ │ │ ├ begin.php + │ │ │ ├ end.php + │ │ ├ ...... + │ ├ install // 网站安装【安装后自动删除】 + │ │ ├ ..... .php + │ ├ plugin // 插件（还没启用） + │ │ ├ pluginName1 + │ │ │ ├ settings.php + │ │ │ │ ├ 待完善 + │ │ │ ├ ....... + │ │ ├ pluginName2 + │ │ │ ├ ....... + │ │ │ ├ ....... + │ ├ theme // 主题（还没启用） + │ │ ├ default + │ │ │ ├ head.php // 页面头部 + │ │ │ ├ navbar.php // 头部导航栏 + │ │ │ ├ footer.php // 页脚 + │ │ │ ├ frame.php // 页面框架 + │ │ │ ├ ....... + │ ├ themeName1 + │ │ ├ ....... + │ │ ├ ....... + │ ├ themeName2 + │ │ ├ ....... + │ │ ├ ....... + │ ├ ....... + │ ├ config.php // 网站配置文件 + + ├ index.php // 网站的主路由 + │ ├ privacy.html // 网站隐私政策 +``` + + +## 图形版 + +> 最后修改日期：2021年3月23日，图片使用 Process On 制作 + +新标签页打开 + +![](http://processon.com/chart_image/604db2a3637689019dd8ca1a.png?_=1615704904368) + + + + diff --git a/docs/manual/start/9. 常见问题.md b/docs/manual/start/9. 常见问题.md new file mode 100644 index 0000000..b5d29b4 --- /dev/null +++ b/docs/manual/start/9. 常见问题.md @@ -0,0 +1,46 @@ +## 登录验证码未加载出来 + +### 问题描述 + +程序安装后登陆时的验证码无法绘制，报 [Warning: Wrong parameter count for imagettftext() in xxx/captcha.php 错误] + + +### 问题出现原因 + +安装路径中，出现空格、中文字符以及特殊符号，导致调用GD库时无法找到字体文件。 + + +### 解决方案 + +1. 将程序安装在无空格、中文字符以及特殊符号的路径下（推荐） +2. 如果不得不安装在特定目录下，请将 `static/font/geneva.ttf` 字体文件复制一份至符合上述要求的路径，然后按照下方说明修改 `api/captcha.php` 文件。 + +``` +// 修改`api/captcha.php`文件以下内容 +imagettftext($image, $fontsize, 0, $x, $y, $fontcolor, dirname(__DIR__).'/static/font/geneva.ttf', $fontcontent); + +// 为 +imagettftext($image, $fontsize, 0, $x, $y, $fontcolor, '复制出来的字体所在路径/geneva.ttf', $fontcontent); + +// 注意 1. 不得使用相对路径，要使用绝对路径； +// 2. 引号不要漏掉了； +// 3. 修改后记得保存captcha.php文件，然后再刷新页面 +``` + +--------------- + +# 无法创建SQLite3数据库 + +> 这个问题一般出现在Windows环境下 + + +### 解决方案 + +需要修改php.ini文件 + +``` +extension=pdo_sqlite # 去掉前面的分号 +extension=sqlite3 # 去掉前面的分号 +sqlite3.extension_dir = "php所在目录/ext" # 去掉前面的分号，并将值设为ext文件夹的路径 +``` + diff --git a/docs/manual/start/backup.md b/docs/manual/start/backup.md new file mode 100644 index 0000000..261f999 --- /dev/null +++ b/docs/manual/start/backup.md @@ -0,0 +1,19 @@ +## 网站备份 + +**在您要对网站升级时，请务必先对网站数据进行备份。** + +网站备份分为两个步骤，即**网站文件备份**和**数据库备份**，二者缺一不可，而且建议尽可能在同一时间备份（即二者备份之间的时间差不要太大，尽可能减小在备份期间用户操作导致的网站文件和数据库不完全同步）。 + +> 建议在半夜用户活跃度低的时候进行备份操作，以免加大服务器压力。如果有条件的话，可以暂时关闭站点进行备份。 + +### 网站文件备份 + +在服务器端，将网站所在文件夹打包压缩，检查压缩包是否完好（即是否可以正常解压，解压出来的文件数量及大小是否与压缩前相等），然后将压缩包存档。 +> 特别是`.tar.gz`格式的压缩包一定要检查是否完整，这类压缩包如果在压缩中出现错误而中断，压缩包是可以查看的，但是文件会不完整。相比之下，`.zip`格式的压缩包一般来说可以正常打开基本上就是完整的。 +> 对于备份网站代码部分来说，`.tar.gz`格式会比`.zip格式`压缩包明显小不少，但是压缩时间会略长。如果网站附件、图片比较多的话，还是建议用`.zip格式`压缩，反之建议用`.tar.gz格式`压缩。 + +### 数据库备份 + +您可以通过MySQL管理工具（如网页版的phpMyAdmin，桌面版的Navicat等等软件），或者使用MySQL命令行进行备份。 + +> **使用宝塔的用户，千万不要为了贪图一时方便使用数据库一键备份**，宝塔一键备份在某种情况下会出现丢失部分数据，或者部分特殊字符变乱码等情况。同时，也**不要使用宝塔面板中一键导入数据库功能**。这些功能虽然操作起来方便，但是根据我们实际测试，数据库中的部分特殊字符以及表情符号等，会变成乱码。（测试版本为`宝塔Linux面板7.4.7`） \ No newline at end of file diff --git a/docs/manual/start/database - 副本.md b/docs/manual/start/database - 副本.md new file mode 100644 index 0000000..fd6c942 --- /dev/null +++ b/docs/manual/start/database - 副本.md @@ -0,0 +1,281 @@ +> 数据表前缀默认为`bdc_` + +- 在线数据库关系图设计工具：https://dbdiagram.io/ + + + + +# v1.5 +> 更新时间：2021.04.10 +```sql +-- -------------------------------------------------------- + +-- +-- 表的结构 `users` +-- + +CREATE TABLE `users` ( + +-- 用户基本信息 + `id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '用户 id', + `username` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '用户名（可以修改，但唯一）', + `uuid` varchar(32) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '注册时生成，全局唯一不可改', + `password` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '密码（暂时，因为后期加密方式可能会升级）', + `encryptedpwd` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '密码（MD5加盐后Bcypt加密）', + `safety_password` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '安全密码', + `encryptedsafety_pwd` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '密码（MD5加盐后Bcypt加密）', + `status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '用户状态(0正常 1禁用 2审核中 3审核拒绝 4审核忽略)', + `sex` tinyint(4) NOT NULL DEFAULT '0' COMMENT '性别(0未填写 1男 2女)', + `education` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '手机号', + `mobile` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '手机号', + `mail` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '邮箱', + +-- 用户社交信息 及 统计 + `nickname` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '用户昵称', + `avatar` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '头像地址', + `avatar_at` datetime DEFAULT NULL COMMENT '头像修改时间', + `signature` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '个性签名', + `signature_at` datetime DEFAULT NULL COMMENT '个性签名更新时间', + `thread_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '主题数', + `follow_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '关注数', + `fans_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '粉丝数', + `liked_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '点赞数', + +-- 虚拟资产 + `virtual_currency` DECIMAL(10,0) UNSIGNED NOT NULL DEFAULT '0' COMMENT 'β币', + +-- 付费信息 + `joined_at` datetime DEFAULT NULL COMMENT '付费时间', + `expired_at` datetime DEFAULT NULL COMMENT '付费到期时间', + +-- 实名认证 + `identity` char(18) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '身份证号码', + `realname` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '身份证姓名', + +-- 登陆相关 + `last_login_ip` varchar(45) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '最后登录 ip', + `login_at` datetime DEFAULT NULL COMMENT '最后登录时间', + `login_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '登录次数', + +-- 注册相关，暂时用不到，但是保留，后续找回密码可能用得到 + `register_ip` varchar(45) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '注册ip', + `created_at` datetime NOT NULL COMMENT '注册时间', + `register_reason` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '注册原因', + +-- 账户修改相关 + `username_bout` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT '用户名修改次数', + +-- 协议相关 + `accept_policy_version` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT '用户接受的相关协议版本号，相关协议更新后可通知到用户', + +-- 用户独立表相关（这个待定） + `db_file` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '用户学习记录SQLite数据库文件名', + `db_version` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT 'SQLite数据库内用户数据版本，记录版本便于后期分批升级用户数据', + +-- 设置表的索引 + +-- 设置主键 + PRIMARY KEY (`id`), + +-- 设置唯一 + UNIQUE KEY `users_uuid_unique` (`uuid`), + UNIQUE KEY `users_username_unique` (`username`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='用户表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `attachments` +-- + +CREATE TABLE `attachments` ( + `id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '附件 id', + `uuid` char(36) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'uuid', + `user_id` bigint(20) UNSIGNED NOT NULL COMMENT '用户 id', + `type` smallint(5) UNSIGNED NOT NULL DEFAULT '0' COMMENT '附件类型(0未知，1图片，2视频，3音频，4其他附件)', + `is_remote` tinyint(3) UNSIGNED NOT NULL DEFAULT '0' COMMENT '是否远程附件', + `is_approved` tinyint(3) UNSIGNED NOT NULL DEFAULT '1' COMMENT '是否合法', + `attachment` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件系统生成的名称', + `file_path` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件路径', + `file_name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件原名称', + `file_size` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT '文件大小', + `file_type` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件类型', + `ip` varchar(45) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT 'ip 地址', + `created_at` datetime NOT NULL COMMENT '创建时间', + `updated_at` datetime NOT NULL COMMENT '更新时间', + +-- 设置主键 + PRIMARY KEY (`id`), + +-- 设置唯一 + UNIQUE KEY `attachments_attachment_unique` (`attachment`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='附件'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `settings` +-- + +CREATE TABLE `settings` ( + `key` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '设置项 key（设置项的名称）', + `value` text COLLATE utf8mb4_unicode_ci COMMENT '设置项 value（设置项的值）', + `tag` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'default' COMMENT '设置项 tag（设置项所在分类）', + +-- 设置主键 + PRIMARY KEY (`key`,`tag`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='网站设置'; + +-- +-- 转存表中的数据 `settings` +-- + +INSERT INTO `settings` (`key`, `value`, `tag`) VALUES + ('favicon', 'favicon.png', 'default'), + ('title','在线背单词（开发中）','site'), + ('captcha_font', '/static/font/geneva.ttf', 'font'); +COMMIT; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `words` +-- + +CREATE TABLE `words` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '单词 id', + `words` varchar(255) NOT NULL DEFAULT '' COMMENT '英语单词（词组）', + `word_type` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '类型(0未知，1单词，2词组)', + `pho` text NOT NULL COMMENT '音标 phonetic-transcription', + `trans` longtext NOT NULL COMMENT '中文', + `search_count` int(11) NOT NULL DEFAULT 0 COMMENT '查询统计', + `look_count` int(11) NOT NULL DEFAULT 0 COMMENT '浏览统计', + `favi_count` int(11) NOT NULL DEFAULT 0 COMMENT '收藏统计', + `star_count` int(11) NOT NULL DEFAULT 0 COMMENT '星标统计', + `mark_count` int(11) NOT NULL DEFAULT 0 COMMENT '书签统计', + +-- 设置主键 + PRIMARY KEY (`id`,`words`), + +-- 设置唯一 + UNIQUE(`words`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='单词表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `wordbooks` +-- + +CREATE TABLE `wordbooks` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '词书 id', + `name` varchar(255) NOT NULL DEFAULT '' COMMENT '词书名称（用于显示给用户）', + `alias` varchar(255) NOT NULL DEFAULT '' COMMENT '词书别名（用于url访问及数据库查询）', + `intro` text NOT NULL COMMENT '词书简介', + + `type` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '类型(0用户上传词书，1公共词书)', + `permission` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '权限(0私密，1公开，2审核中)', + `recommend` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '类型(0不推荐，1推荐)', + + `create_at` datetime DEFAULT NULL COMMENT '创建时间', + `update_at` datetime DEFAULT NULL COMMENT '更新时间', + + `search_count` int(11) NOT NULL DEFAULT 0 COMMENT '查询统计', + `look_count` int(11) NOT NULL DEFAULT 0 COMMENT '浏览统计', + `favi_count` int(11) NOT NULL DEFAULT 0 COMMENT '收藏统计', + `star_count` int(11) NOT NULL DEFAULT 0 COMMENT '星标统计', + `mark_count` int(11) NOT NULL DEFAULT 0 COMMENT '书签统计', + +-- 设置主键 + PRIMARY KEY (`id`,`alias`), + +-- 设置唯一 + UNIQUE(`alias`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='词书表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `word_ref_wordbook` +-- + +CREATE TABLE `word_ref_wordbook` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'id', + `word_id` int(11) NOT NULL COMMENT 'id', + `wordbook_id` int(11) NOT NULL COMMENT 'id', + +-- 设置主键 + PRIMARY KEY (`id`,`word_id`,`wordbook_id`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='单词、词书关联表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `word_supplements` （用于保存用户提交的数据库中不存在或者有错误的单词） +-- + +CREATE TABLE `word_supplements` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '工单 id', + `word_id` int(11) NOT NULL COMMENT '单词 id', + `uuid` varchar(100) NOT NULL COMMENT '用户 uuid', + `type` smallint(5) UNSIGNED NOT NULL COMMENT '类型(0补充数据库中不存在的单词，1单词拼写错误，2单词释义错误、错字、乱码，3单词释义不全，4其他)', + `create_at` datetime DEFAULT NULL COMMENT '创建时间（时间戳）', + `content` text NOT NULL COMMENT '用户提交内容', + `status` smallint(5) UNSIGNED NOT NULL COMMENT '状态(0等待管理员回复，1被采纳，2被拒绝，3未被采纳但是有一定用处)', + +-- 设置主键 + PRIMARY KEY (`id`,`word_id`,`uuid`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='错误单词反馈记录表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +ALTER TABLE `attachments` ADD FOREIGN KEY (`uuid`) REFERENCES `users` (`uuid`); + +ALTER TABLE `word_supplements` ADD FOREIGN KEY (`word_id`) REFERENCES `words` (`id`); + +ALTER TABLE `word_supplements` ADD FOREIGN KEY (`uuid`) REFERENCES `users` (`uuid`); + +ALTER TABLE `word_ref_wordbook` ADD FOREIGN KEY (`word_id`) REFERENCES `words` (`id`); + +ALTER TABLE `word_ref_wordbook` ADD FOREIGN KEY (`wordbook_id`) REFERENCES `wordbooks` (`id`); + + + +-- +-- 删除表 +-- +DROP TABLE `word_supplements`; +DROP TABLE `wordbooks`; +DROP TABLE `words`; +DROP TABLE `settings`; +DROP TABLE `attachments`; +DROP TABLE `users`; +``` + + +# v1.3 +[【附件】v1.3.sql](https://docs.only4.work/media/attachment/2021/01/v1.3.sql) + +> 更新时间：2021.01.22 \ No newline at end of file diff --git a/docs/manual/start/database.md b/docs/manual/start/database.md new file mode 100644 index 0000000..1136829 --- /dev/null +++ b/docs/manual/start/database.md @@ -0,0 +1,292 @@ +> 数据表前缀默认为`bdc_` + +- 在线数据库关系图设计工具：https://dbdiagram.io/ + + + + +# v1.5 +> 更新时间：2021.04.10 + + +
+点击展开 + +```sql +-- -------------------------------------------------------- + +-- +-- 表的结构 `users` +-- + +CREATE TABLE `users` ( + +-- 用户基本信息 + `id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '用户 id', + `username` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '用户名（可以修改，但唯一）', + `uuid` varchar(32) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '注册时生成，全局唯一不可改', + `password` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '密码（暂时，因为后期加密方式可能会升级）', + `encryptedpwd` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '密码（MD5加盐后Bcypt加密）', + `safety_password` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '安全密码', + `encryptedsafety_pwd` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '密码（MD5加盐后Bcypt加密）', + `status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '用户状态(0正常 1禁用 2审核中 3审核拒绝 4审核忽略)', + `sex` tinyint(4) NOT NULL DEFAULT '0' COMMENT '性别(0未填写 1男 2女)', + `education` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '手机号', + `mobile` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '手机号', + `mail` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '邮箱', + +-- 用户社交信息 及 统计 + `nickname` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '用户昵称', + `avatar` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '头像地址', + `avatar_at` datetime DEFAULT NULL COMMENT '头像修改时间', + `signature` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '个性签名', + `signature_at` datetime DEFAULT NULL COMMENT '个性签名更新时间', + `thread_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '主题数', + `follow_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '关注数', + `fans_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '粉丝数', + `liked_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '点赞数', + +-- 虚拟资产 + `virtual_currency` DECIMAL(10,0) UNSIGNED NOT NULL DEFAULT '0' COMMENT 'β币', + +-- 付费信息 + `joined_at` datetime DEFAULT NULL COMMENT '付费时间', + `expired_at` datetime DEFAULT NULL COMMENT '付费到期时间', + +-- 实名认证 + `identity` char(18) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '身份证号码', + `realname` varchar(20) COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '身份证姓名', + +-- 登陆相关 + `last_login_ip` varchar(45) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '最后登录 ip', + `login_at` datetime DEFAULT NULL COMMENT '最后登录时间', + `login_count` int(10) UNSIGNED NOT NULL DEFAULT 0 COMMENT '登录次数', + +-- 注册相关，暂时用不到，但是保留，后续找回密码可能用得到 + `register_ip` varchar(45) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '注册ip', + `created_at` datetime NOT NULL COMMENT '注册时间', + `register_reason` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '注册原因', + +-- 账户修改相关 + `username_bout` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT '用户名修改次数', + +-- 协议相关 + `accept_policy_version` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT '用户接受的相关协议版本号，相关协议更新后可通知到用户', + +-- 用户独立表相关（这个待定） + `db_file` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '用户学习记录SQLite数据库文件名', + `db_version` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT 'SQLite数据库内用户数据版本，记录版本便于后期分批升级用户数据', + +-- 设置表的索引 + +-- 设置主键 + PRIMARY KEY (`id`), + +-- 设置唯一 + UNIQUE KEY `users_uuid_unique` (`uuid`), + UNIQUE KEY `users_username_unique` (`username`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='用户表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `attachments` +-- + +CREATE TABLE `attachments` ( + `id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '附件 id', + `uuid` char(36) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'uuid', + `user_id` bigint(20) UNSIGNED NOT NULL COMMENT '用户 id', + `type` smallint(5) UNSIGNED NOT NULL DEFAULT '0' COMMENT '附件类型(0未知，1图片，2视频，3音频，4其他附件)', + `is_remote` tinyint(3) UNSIGNED NOT NULL DEFAULT '0' COMMENT '是否远程附件', + `is_approved` tinyint(3) UNSIGNED NOT NULL DEFAULT '1' COMMENT '是否合法', + `attachment` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件系统生成的名称', + `file_path` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件路径', + `file_name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件原名称', + `file_size` int(10) UNSIGNED NOT NULL DEFAULT '0' COMMENT '文件大小', + `file_type` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '文件类型', + `ip` varchar(45) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT 'ip 地址', + `created_at` datetime NOT NULL COMMENT '创建时间', + `updated_at` datetime NOT NULL COMMENT '更新时间', + +-- 设置主键 + PRIMARY KEY (`id`), + +-- 设置唯一 + UNIQUE KEY `attachments_attachment_unique` (`attachment`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='附件'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `settings` +-- + +CREATE TABLE `settings` ( + `key` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '设置项 key（设置项的名称）', + `value` text COLLATE utf8mb4_unicode_ci COMMENT '设置项 value（设置项的值）', + `tag` varchar(100) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'default' COMMENT '设置项 tag（设置项所在分类）', + +-- 设置主键 + PRIMARY KEY (`key`,`tag`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='网站设置'; + +-- +-- 转存表中的数据 `settings` +-- + +INSERT INTO `settings` (`key`, `value`, `tag`) VALUES + ('favicon', 'favicon.png', 'default'), + ('title','在线背单词（开发中）','site'), + ('captcha_font', '/static/font/geneva.ttf', 'font'); +COMMIT; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `words` +-- + +CREATE TABLE `words` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '单词 id', + `words` varchar(255) NOT NULL DEFAULT '' COMMENT '英语单词（词组）', + `word_type` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '类型(0未知，1单词，2词组)', + `pho` text NOT NULL COMMENT '音标 phonetic-transcription', + `trans` longtext NOT NULL COMMENT '中文', + `search_count` int(11) NOT NULL DEFAULT 0 COMMENT '查询统计', + `look_count` int(11) NOT NULL DEFAULT 0 COMMENT '浏览统计', + `favi_count` int(11) NOT NULL DEFAULT 0 COMMENT '收藏统计', + `star_count` int(11) NOT NULL DEFAULT 0 COMMENT '星标统计', + `mark_count` int(11) NOT NULL DEFAULT 0 COMMENT '书签统计', + +-- 设置主键 + PRIMARY KEY (`id`,`words`), + +-- 设置唯一 + UNIQUE(`words`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='单词表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `wordbooks` +-- + +CREATE TABLE `wordbooks` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '词书 id', + `name` varchar(255) NOT NULL DEFAULT '' COMMENT '词书名称（用于显示给用户）', + `alias` varchar(255) NOT NULL DEFAULT '' COMMENT '词书别名（用于url访问及数据库查询）', + `intro` text NOT NULL COMMENT '词书简介', + + `type` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '类型(0用户上传词书，1公共词书)', + `permission` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '权限(0私密，1公开，2审核中)', + `recommend` smallint(5) UNSIGNED NOT NULL DEFAULT 0 COMMENT '类型(0不推荐，1推荐)', + + `create_at` datetime DEFAULT NULL COMMENT '创建时间', + `update_at` datetime DEFAULT NULL COMMENT '更新时间', + + `search_count` int(11) NOT NULL DEFAULT 0 COMMENT '查询统计', + `look_count` int(11) NOT NULL DEFAULT 0 COMMENT '浏览统计', + `favi_count` int(11) NOT NULL DEFAULT 0 COMMENT '收藏统计', + `star_count` int(11) NOT NULL DEFAULT 0 COMMENT '星标统计', + `mark_count` int(11) NOT NULL DEFAULT 0 COMMENT '书签统计', + +-- 设置主键 + PRIMARY KEY (`id`,`alias`), + +-- 设置唯一 + UNIQUE(`alias`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='词书表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `word_ref_wordbook` +-- + +CREATE TABLE `word_ref_wordbook` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'id', + `word_id` int(11) NOT NULL COMMENT 'id', + `wordbook_id` int(11) NOT NULL COMMENT 'id', + +-- 设置主键 + PRIMARY KEY (`id`,`word_id`,`wordbook_id`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='单词、词书关联表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +-- +-- 表的结构 `word_supplements` （用于保存用户提交的数据库中不存在或者有错误的单词） +-- + +CREATE TABLE `word_supplements` ( + `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '工单 id', + `word_id` int(11) NOT NULL COMMENT '单词 id', + `uuid` varchar(100) NOT NULL COMMENT '用户 uuid', + `type` smallint(5) UNSIGNED NOT NULL COMMENT '类型(0补充数据库中不存在的单词，1单词拼写错误，2单词释义错误、错字、乱码，3单词释义不全，4其他)', + `create_at` datetime DEFAULT NULL COMMENT '创建时间（时间戳）', + `content` text NOT NULL COMMENT '用户提交内容', + `status` smallint(5) UNSIGNED NOT NULL COMMENT '状态(0等待管理员回复，1被采纳，2被拒绝，3未被采纳但是有一定用处)', + +-- 设置主键 + PRIMARY KEY (`id`,`word_id`,`uuid`) +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='错误单词反馈记录表'; + +-- -------------------------------------------------------- + +-- -------------------------------------------------------- + +ALTER TABLE `attachments` ADD FOREIGN KEY (`uuid`) REFERENCES `users` (`uuid`); + +ALTER TABLE `word_supplements` ADD FOREIGN KEY (`word_id`) REFERENCES `words` (`id`); + +ALTER TABLE `word_supplements` ADD FOREIGN KEY (`uuid`) REFERENCES `users` (`uuid`); + +ALTER TABLE `word_ref_wordbook` ADD FOREIGN KEY (`word_id`) REFERENCES `words` (`id`); + +ALTER TABLE `word_ref_wordbook` ADD FOREIGN KEY (`wordbook_id`) REFERENCES `wordbooks` (`id`); + + + +-- +-- 删除表 +-- +DROP TABLE `word_supplements`; +DROP TABLE `wordbooks`; +DROP TABLE `words`; +DROP TABLE `settings`; +DROP TABLE `attachments`; +DROP TABLE `users`; +``` + +
+ + +---------- + + +# v1.3 + +> 更新时间：2021.01.22 + +[【附件】v1.3.sql](https://docs.only4.work/media/attachment/2021/01/v1.3.sql) \ No newline at end of file diff --git a/docs/manual/start/initial-configuration.md b/docs/manual/start/initial-configuration.md new file mode 100644 index 0000000..a593649 --- /dev/null +++ b/docs/manual/start/initial-configuration.md @@ -0,0 +1,5 @@ +## 初次使用配置说明 + +# 操作场景 + +本文档将对常用功能进行简要说明，帮助您更好的了解常用功能项与配置方式，更快的上手使用。 \ No newline at end of file diff --git a/docs/manual/start/install.md b/docs/manual/start/install.md new file mode 100644 index 0000000..24517d4 --- /dev/null +++ b/docs/manual/start/install.md @@ -0,0 +1,55 @@ +## 下载 + +> 生产环境使用请下载“ **最新稳定版** ”。 + +||版本号|更新日期|下载链接|特别说明| +|--|--|--|--|--| +|最新稳定版|v1.0.0|XXXX-XX-XX|[点击下载（待完善）]()|| +|预发行版本|v1.0.0-beta|XXXX-XX-XX|[点击下载（待完善）]()|| +|最新测试版|v1.0.0-alpha|XXXX-XX-XX|[点击下载（待完善）]()|| + +更多历史版本：[点击查看（待完善）]()（关于👉版本信息👉发行版本） + +## 安装 + +**此处说明待完善** +将下载得到的`.zip`或`.tar.gz`格式压缩包解压到您想要安装的目录（如果希望部署在网站首页，请解压至您的网站根目录）。 + +> 例如，您的网站根目录为`/home/wwwroot/`，则压缩包解压后目录结构为`/home/wwwroot/install`。然后运行`/install/index.php`文件，按照提示进行进一步安装。 + +> 在后续的文档中，因为每个人的网站域名都不相同，我们将省略域名，直接写为`/`。 +假设您将网站安装在`https://域名/XXX/`，则`https://域名/XXX/index.php`会被写作`/index.php`。 + +在安装过程中，您需要提供以下信息： +- 您的网站名称 +- 管理员账号密码 +- 数据库地址、数据库名、数据库用户名、数据库密码，如果您希望在同一个数据库中安装多个网站，请确保每个网站的**表前缀**不同。 + +安装过程通常很快，如果您很熟悉的话，5分钟内完成安装应该不成问题。填好上方所有信息，点击`立即安装`按钮，几秒后便可安装成功。 + +> 在安装过程结束后，您还需要手动设置部分目录为禁止访问，以免用户信息被他人利用以及导致网站出现安全漏洞。 +- /file/avatar/original 用户上传的头像源文件 +- /file/sqlitedb 网站用户SQLite数据库所在的文件夹 +- /file/upload 用户上传的文件 + +不同HTTP Server的设置方式不同。例如： +> 【此处完档为草稿，请勿直接拷贝代码！】 +Nginx **说明待完善 ** +``` +禁止访问扩展名为bat的文件，配置如下： +location ~* /.bat { +deny all; +} +禁止访问configs目录，以及其下所有子目录或文件，配置如下： +location ^~ /configs/ { +deny all; +} +``` + +Apache **说明待完善 ** +配置htaccess文件（安装包中提供，只需要检查是否生效即可） +``` +``` + + +安装后，如果希望修改数据库相关信息，请修改文件**【待完善】**。 \ No newline at end of file diff --git a/docs/manual/start/introduction.md b/docs/manual/start/introduction.md new file mode 100644 index 0000000..1874179 --- /dev/null +++ b/docs/manual/start/introduction.md @@ -0,0 +1,29 @@ +## 如何安装 + +背Ta单词的安装非常快速。在大多数情况下，安装过程只需不到1分钟就能完成。 + +### 服务器要求 + +在开始安装之前，请检查你的服务器是否满足要求。如果你不了解你的服务器是否满足要求也没关系，安装脚本会自动帮你完成检查。服务器要求如下： +- Apache 或 Nginx +- PHP 7.2+(???)，需要启用 imagemagick(???) 扩展 +- MySQL 5.6+ + +### 开始安装 + +1. 下载最新版本安装包、上传至服务器并解压至希望安装的目录。 +1. 在你的 Web 服务器上创建数据库，数据库编码建议设置为`utf8mb4_general_ci`。 +1. 设置文件夹权限。 +1. 在浏览器中访问 URL 运行安装脚本。 + +------------ + +### 版本号规范 + +> 本项目版本号遵循 `Major.Minor.Patch` 原则（即`主版本号.次版本号.修订版本号`）。 +> **主版本号**增加代表重大更新，同时也意味着可能会有与以前插件等不兼容的升级，例如进行了不兼容的Api升级，插件开发者可能需要进行适配。 +> **次版本号**增大代表一般更新，即进行了向下兼容的版本升级。在新版本推出一定时间无问题后，可以放心升级。 +> **修订版本号**增大代表向下兼容的问题修正，Bug修正等。这种情况下，建议始终保持最新版本，以免漏洞被他人利用给您造成损失。 +> 总之，主版本号相同的情况下，建议您升级至最新版本。主版本号不同时，升级需要考虑兼容问题，建议先按照“网站迁移”的步骤对现有网站进行克隆，将克隆出来的站点作为测试站点，然后升级测试站点。确认升级后各功能均正常，方可对主站点进行升级。 + +> 参考文档：[语义化版本 2.0.0](https://semver.org/lang/zh-CN/) \ No newline at end of file diff --git a/docs/manual/start/migration.md b/docs/manual/start/migration.md new file mode 100644 index 0000000..2494923 --- /dev/null +++ b/docs/manual/start/migration.md @@ -0,0 +1,9 @@ +### 修改数据库表前缀 + +> 以下内容非最终代码，请不要直接复制运行。 + +```sql +Select CONCAT( 'ALTER TABLE ', table_name, 'RENAME TO bdc_', substring(table_name,CHAR_LENGTH('oldpre')+1)),';' ) +FROM information_schema.tables +Where table_name LIKE 'oldpre_%'; +``` diff --git a/docs/manual/start/requirements.md b/docs/manual/start/requirements.md new file mode 100644 index 0000000..15daf02 --- /dev/null +++ b/docs/manual/start/requirements.md @@ -0,0 +1,45 @@ +# 环境 + +## 服务器端环境要求 + +> 推荐环境：LNMP（Linux、Nginx、PHP、MySQL） + +| 项目 | 环境 | 最低配置要求 | 推荐配置要求 | 说明 | +| --- | --- | --- | --- | --- | +| 服务器系统 | Linux（CentOS、Ubuntu等） / Windows Server and so on... | | | 建议使用Linux系列系统，不建议使用Windows Server | +| Web Server | Nginx / Apache / IIS and so on... | | | 建议使用Nginx或Apache（首选Nginx） | +| 服务器端脚本语言 | PHP | 7.3 | 7.4 | GD库版本需要大于2.0.18 | +| 数据库 | MySQL | 5.0 | 5.7 | | + + +------------ + +## PHP扩展 + +GD库（用户上传头像、网站登录、注册、找回密码、注销账号等时使用） + + +------------ + +## 客户端环境要求 + +### 浏览器 + +> 浏览器需要开启JavaScript，如果需要使用登录后相关功能还需要开启Cookie，**目前市面上绝大多数浏览器都满足此条件**。 + +#### 兼容性 + +不支持IE 10 以下版本的浏览器。 + + +#### PC端(网页) +推荐使用`Chrome`浏览器，或者使用`Chrome内核`的浏览器（一般双核浏览器的极速模式为Chrome内核，比如`QQ浏览器`），也可使用`Firefox`浏览器。 +**非常不推荐使用IE浏览器**，IE浏览器已经逐步被抛弃，我们不会为其做适配，经过测试，确认无法在IE10及以下浏览器中运行。 + +#### 移动端(网页) +目前仍在测试中，手机浏览器测试过QQ浏览器，Firefox浏览器，均可正常使用。如果您在使用过程中遇到问题，也可及时联系我们。 \ No newline at end of file diff --git a/docs/manual/start/upgrade.md b/docs/manual/start/upgrade.md new file mode 100644 index 0000000..4f07f1c --- /dev/null +++ b/docs/manual/start/upgrade.md @@ -0,0 +1 @@ +.keep \ No newline at end of file diff --git a/docs/manual/test.md b/docs/manual/test.md new file mode 100644 index 0000000..d3135cf --- /dev/null +++ b/docs/manual/test.md @@ -0,0 +1,9 @@ +# drawio + +[filename](https://cdn.jsdelivr.net/npm/docsify-drawio/test.drawio ':include :type=code') + +----- + +# 深色背景 + + diff --git a/docs/manual/todo.md b/docs/manual/todo.md new file mode 100644 index 0000000..d410ed9 --- /dev/null +++ b/docs/manual/todo.md @@ -0,0 +1,3 @@ +- [ ] Tests +- [ ] Example +- [x] ~Documentation~ \ No newline at end of file diff --git a/docsify.md b/docsify.md new file mode 100644 index 0000000..9eb2c2d --- /dev/null +++ b/docsify.md @@ -0,0 +1,20 @@ +## docsify + +> 官方网站：https://docsify.js.org/#/zh-cn/quickstart + +### 全局安装 `docsify-cli` 工具 + +可以方便地创建及在本地预览生成的文档。 + +```bash +npm i docsify-cli -g +``` + +### 本地预览 + +通过运行 `docsify serve` 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 [http://localhost:3000](http://localhost:3000/) 。 + +```bash +docsify serve docs +``` +