[
{
"path": ".gitignore",
"content": ".git"
},
{
"path": "Readme.md",
"content": "## elecV2P 文档/例程/通知/反馈 - documents/examples/information/issues\r\n\r\n主项目地址: https://github.com/elecV2/elecV2P\r\n\r\n\r\n\r\nTG 频道: https://t.me/elecV2\r\nTG 交流群: https://t.me/elecV2G\r\n\r\n欢迎提交功能需求或者其他建议。\r\n\r\n### 说明\r\n\r\n- 文档目录：[docs](https://github.com/elecV2/elecV2P-dei/tree/master/docs)\r\n- 例程目录：[examples](https://github.com/elecV2/elecV2P-dei/tree/master/examples)\r\n- 初次使用建议先把 docs 内容浏览一遍，涉及内容较多，大部分可以直接跳过，在使用中碰到问题时再来查看"
},
{
"path": "docs/01-overview.md",
"content": "```\r\n最近更新： 2022-10-21\r\n适用版本： 3.7.3\r\n```\r\n\r\n*此章节内容同步自 [elecV2P Readme 文档](https://github.com/elecV2/elecV2P)*\r\n\r\n## 简介\r\n\r\nelecV2P - customize personal network.\r\n一款基于 NodeJS，可通过 JS 修改网络请求，以及定时运行脚本或 SHELL 指令的网络工具。\r\n\r\n\r\n\r\n### 基础功能\r\n\r\n- 查看/修改网络请求 (MITM)\r\n- 定时执行 JS/SHELL 脚本\r\n- FEED/IFTTT/自定义 通知\r\n- EFSS 基础文件管理\r\n\r\n## 安装/INSTALL\r\n\r\n***程序开放权限极大，建议局域网使用。公网部署（务必参考 [Advanced.md](https://github.com/elecV2/elecV2P-dei/blob/master/docs/Advanced.md)），风险自负***\r\n\r\n*elecV2P 所有文件及依赖总大小约 90 M。初始运行时内存占用约 90 M，运行 100 个定时任务时总内存占用约 150 M（仅供参考，不同软硬件条件下程序调用资源可能有所不同）*\r\n\r\n**在可使用 Docker 的情况下，推荐使用方法三进行安装**\r\n\r\n### 方法一：直接 NODEJS 运行\r\n\r\n**需求 NODEJS 版本 (node -v) >= 14.17.0**\r\n\r\n``` sh\r\ngit clone https://github.com/elecV2/elecV2P.git\r\ncd elecV2P\r\n\r\n# 安装依赖库（根据网络环境和硬盘读写速度，需要 1-10 分钟不等\r\nyarn\r\n\r\n# elecV2P 默认以 pm2 的方式启动，需要先安装好 pm2\r\n# pm2 的安装方式:\r\n# 1. 添加 elecV2P 所在目录/node_modules/.bin 到系统环境变量 PATH 中\r\n# 2. 或者直接执行 yarn global add pm2\r\n# 然后执行命令\r\nyarn start\r\n\r\n# 其他基础方式启动命令\r\nnode index.js\r\n# 假如提示 80 端口不可用，尝试命令\r\n# windows 平台 CMD:\r\n# set PORT=8000 && node index.js\r\n# windows 平台 PowerShell:\r\n# $env:PORT=\"8000\";node index.js\r\n# 其他平台：\r\n# PORT=8000 TZ=Asia/Shanghai node index.js\r\n## TZ=Asia/Shanghai 用于设置程序运行时区\r\n```\r\n\r\n#### 升级\r\n\r\n方式一：使用 [softupdate.js](https://raw.githubusercontent.com/elecV2/elecV2P/master/script/JSFile/softupdate.js) 软更新升级\r\n\r\n- 首先在 webUI/JSMANAGE 脚本管理中找到 softupdate.js 文件，假如不存在就远程推送或本地上传一下\r\n- 然后按照文件内的说明，根据自身需求更改 CONFIG 设置项\r\n- 最后点击测试运行即可\r\n\r\n方式二：手动升级（不推荐\r\n\r\n- 先备份好个人数据，比如 根证书，以及 efss、script/JSFile、Store、Lists、Shell 等文件夹\r\n- （推荐在 webUI/efss 界面，右键对应文件夹，然后 zip 打包下载。）\r\n- 然后在项目目录下执行命令 git pull，拉取最新的代码进行覆盖升级\r\n- 最后再把备份好的文件上传/复制还原到之前的位置\r\n\r\n### 其他 PM2 相关指令\r\n\r\n``` sh\r\npm2 stop elecV2P # 停止 elecV2P\r\npm2 stop all # 停止所有程序\r\n\r\npm2 restart elecV2P # 重启 elecV2P\r\npm2 restart 0\r\n\r\npm2 ls # 查看运行状态\r\npm2 logs # 查看运行日志\r\n\r\npm2 -h # 查看 PM2 帮助列表\r\n```\r\n\r\n### 方法二：DOCKER\r\n\r\n镜像名称: elecv2/elecv2p\r\n镜像地址: https://hub.docker.com/r/elecv2/elecv2p\r\n\r\n``` sh\r\n# 基础使用命令\r\ndocker run --restart=always -d --name elecv2p -e TZ=Asia/Shanghai -p 80:80 -p 8001:8001 -p 8002:8002 elecv2/elecv2p\r\n\r\n# 推荐使用命令\r\ndocker run --restart=always \\\r\n -d --name elecv2p \\\r\n -e TZ=Asia/Shanghai \\\r\n -p 8100:80 -p 8101:8001 -p 8102:8002 \\\r\n -v /elecv2p/JSFile:/usr/local/app/script/JSFile \\\r\n -v /elecv2p/Lists:/usr/local/app/script/Lists \\\r\n -v /elecv2p/Store:/usr/local/app/script/Store \\\r\n -v /elecv2p/Shell:/usr/local/app/script/Shell \\\r\n -v /elecv2p/rootCA:/usr/local/app/rootCA \\\r\n -v /elecv2p/efss:/usr/local/app/efss \\\r\n elecv2/elecv2p\r\n\r\n# -p/-v 对应参数 宿主:容器\r\n# 如需更改默认的 80 端口，可在 -e 后面加上 PORT=8000\r\n# 升级 Docker 镜像（如果没有使用 -v 持久化存储，容器内数据会丢失，请提前备份）\r\ndocker rm -f elecv2p # 先删除旧的容器\r\ndocker pull elecv2/elecv2p # 再拉取新的镜像\r\n# 再使用之前的 docker run xxxx 命令重新启动一下\r\n# 如果拉取到的镜像不是最新的版本，请修改 Docker 当前使用的仓库地址\r\n```\r\n\r\n- ARM32 平台如果出错，参考 [issues #78](https://github.com/elecV2/elecV2P/issues/78)\r\n\r\n### 方法三：DOCKER-COMPOSE （推荐）\r\n\r\n``` sh\r\n# 创建 elecV2P 持久化数据保存目录\r\nmkdir /elecv2p && cd /elecv2p\r\n# 假如失败，请尝试在其他有权限的目录进行创建\r\n# 后面 docker-compose.yaml 映射目录保持和创建的目录一致\r\n\r\n# 下载 docker-compose.yaml 文件\r\ncurl -sL https://git.io/JLw7s > docker-compose.yaml\r\n# 启动运行 elecV2P\r\ndocker-compose up -d\r\n\r\n# 注意: 需提前安装好 docker-compose 管理器\r\n# 默认将 80/8001/8002 端口分别映射到了宿主机的 8100/8101/8102 端口，以防出现占用的情况\r\n# 如果需要设置为其他端口，请自行修改 docker-compose.yaml 文件内容，然后重新启动\r\n```\r\n\r\n以下为 docker-compose.yaml 文件内容，可根据自身需求进行修改。\r\n\r\n``` yaml\r\nversion: '3.7'\r\nservices:\r\n elecv2p:\r\n image: elecv2/elecv2p\r\n container_name: elecv2p\r\n restart: always\r\n environment:\r\n - TZ=Asia/Shanghai\r\n ports:\r\n - \"8100:80\"\r\n - \"8101:8001\"\r\n - \"8102:8002\"\r\n volumes:\r\n - \"/elecv2p/JSFile:/usr/local/app/script/JSFile\"\r\n - \"/elecv2p/Lists:/usr/local/app/script/Lists\"\r\n - \"/elecv2p/Store:/usr/local/app/script/Store\"\r\n - \"/elecv2p/Shell:/usr/local/app/script/Shell\"\r\n - \"/elecv2p/rootCA:/usr/local/app/rootCA\"\r\n - \"/elecv2p/efss:/usr/local/app/efss\"\r\n```\r\n\r\n修改后保存文件，然后在 docker-compose.yaml 文件所在目录下执行以下任一命令\r\n\r\n``` sh\r\n# 直接启动（首次启动命令）\r\ndocker-compose up -d\r\n\r\n# 更新镜像并重新启动\r\ndocker-compose pull elecv2p && docker-compose up -d\r\n```\r\n\r\n- 如果在某些设备上无法启动，尝试把文件开头的 version: '3.7' 更改为 version: '3.3'\r\n- ARM32 平台如果出错，参考 [issues #78](https://github.com/elecV2/elecV2P/issues/78)\r\n\r\n其他 docker 相关指令\r\n\r\n``` sh\r\n# 查看是否启动及对应端口\r\ndocker ps\r\n\r\n# 查看 elecV2P 运行日志\r\ndocker logs elecv2p -f\r\n```\r\n\r\n## 默认端口\r\n\r\n- 80： webUI 后台管理界面。用于添加规则/管理脚本/定时任务/MITM 证书 等\r\n- 8001： ANYPROXY HTTP 代理端口。（*代理端口不是网页，不能通过浏览器直接访问*）\r\n- 8002： ANYPROXY 代理请求查看端口\r\n\r\n**ANYPROXY 相关端口默认关闭。可在 webUI 首页双击 ANYPROXY 临时开启。**\r\n**如需在启动时自动开启，请前往 webUI->SETTING->初始化相关设置 中进行设置。**\r\n**80/8002 对应端口需要用到 websocket，在使用 nginx 等反代工具时注意设置。参考 [ev2p-nginx.conf](https://github.com/elecV2/elecV2P-dei/blob/master/examples/ev2p-nginx.conf)**\r\n\r\n- *80 端口可使用环境变量 **PORT** 进行修改(比如: PORT=8000 node index.js)*\r\n- *在 elecV2P 已经启动时，可在 webUI->SETTING->初始化相关设置 中修改其他端口*\r\n- *在 elecV2P 尚未启动时，可在 script/Lists/config.json 文件中修改对应端口*\r\n\r\n## 根证书相关 - HTTPS 解密\r\n\r\n- *如果不使用 RULES/REWRITE 等 MITM 相关功能，此步骤可跳过。*\r\n- *升级启动后，如果不是使用之前的证书，需要重新下载安装信任根证书。*\r\n- *根证书包含两个文件 rootCA.crt/rootCA.key，文件名不可修改。*\r\n\r\n### 安装证书\r\n\r\n选择以下任意一种方式下载证书，然后安装并信任\r\n\r\n- 直接打开 :80/crt\r\n- :80 -> MITM -> 安装证书\r\n- :8002 -> RootCA\r\n\r\n根证书物理存储目录位于 `$HOME/.anyproxy/certificates`。\r\n\r\n*windows 平台的证书存储位置选择 浏览->受信任的根证书颁发机构*\r\n\r\n### 使用自签根证书\r\n\r\n在 webUI->MITM 界面上传自签根证书，然后重启 elecV2P\r\n\r\n**注意：使用新的证书后，记得重新下载安装信任证书，并清除由之前根证书签发的域名证书。**\r\n\r\n## RULES - 网络请求修改\r\n\r\n\r\n\r\n详细说明参考: [docs/03-rules.md](https://github.com/elecV2/elecV2P-dei/tree/master/docs/03-rules.md)\r\n\r\n## 定时任务\r\n\r\n\r\n\r\n支持两种定时方式：\r\n\r\n- 倒计时\r\n- cron 定时\r\n\r\n### 时间格式：\r\n\r\n- 倒计时 30 999 3 2 (以空格分开的四个数字，后三项可省略)\r\n\r\n| 30（秒） | 999（次） | 3（秒） | 2（次） \r\n:--------------: | :-------------: | :------------------: | :------------------:\r\n| 基础倒计时时间 | 重复次数（可选）| 增加随机时间（可选） | 增加随机重复次数（可选） \r\n\r\n\r\n- *当重复次数大于等于 **999** 时，无限循环*\r\n\r\n示例: 40 8 10 3 ，表示倒计时40秒，随机10秒，所以具体倒计时时间位于 40-50 秒之间，重复运行 8-11 次\r\n\r\n- cron 定时 \r\n\r\n时间格式：* * * * * * （五/六位 cron 时间格式）\r\n\r\n| * (0-59) | * (0-59) | * (0-23) | * (1-31) | * (1-12) | * (0-7) \r\n:----------: | :--------: | :--------: | :--------: | :--------: | :---------:\r\n| 秒（可选） | 分 | 小时 | 日 | 月 | 星期\r\n\r\n\r\n### 可执行任务类型\r\n\r\n- 运行 JS\r\n- 开始/停止 其他定时任务\r\n- 基础 shell 指令。比如 *rm -f \\**, *python test.py*, *reboot* 等等\r\n\r\n更多说明参考：[docs/06-task.md](https://github.com/elecV2/elecV2P-dei/tree/master/docs/06-task.md)\r\n\r\n## 通知\r\n\r\n目前支持通知方式：\r\n- FEED/RSS 订阅\r\n- IFTTT WEBHOOK\r\n- BARK 通知\r\n- 自定义通知\r\n\r\nFEED/RSS 订阅地址为 webUI/feed。\r\n\r\n通知内容：\r\n- 定时任务开始/结束\r\n- 定时任务 JS 运行次数\r\n- 脚本中的自主调用通知\r\n\r\nIFTTT/BARK/自定义通知等相关设置参考: [07-feed¬ify](https://github.com/elecV2/elecV2P-dei/tree/master/docs/07-feed¬ify.md)\r\n\r\n## DOCUMENTS&EXAMPLES\r\n\r\n说明文档及一些例程: [https://github.com/elecV2/elecV2P-dei](https://github.com/elecV2/elecV2P-dei)\r\n\r\n如果遇到问题欢迎 [open a issue](https://github.com/elecV2/elecV2P/issues)。尽量说明使用平台，版本，以及附上相关的错误日志（提供的信息越详细，越有助于解决问题）。\r\n\r\nTG 频道: https://t.me/elecV2\r\nTG 交流群: https://t.me/elecV2G\r\n\r\n## 更新日志\r\n\r\n查看: https://github.com/elecV2/elecV2P/blob/master/logs/update.log\r\n\r\n## 贡献参考\r\n\r\n- [anyproxy](https://github.com/alibaba/anyproxy)\r\n- [axios](https://github.com/axios/axios)\r\n- [expressjs](https://expressjs.com)\r\n- [node-cron](https://github.com/merencia/node-cron)\r\n- [node-rss](https://github.com/dylang/node-rss)\r\n- [pm2](https://pm2.keymetrics.io)\r\n- [vue](https://vuejs.org)\r\n- [vue-draggable-resizable](https://github.com/mauricius/vue-draggable-resizable)\r\n- [ace](https://github.com/ajaxorg/ace)\r\n- [adm-zip](https://github.com/cthackers/adm-zip)\r\n- [Ant Design Vue](https://www.antdv.com)\r\n\r\n### 说明文档列表\r\n\r\n- [overview - 简介及安装](01-overview.md)\r\n- [task - 定时任务](06-task.md)\r\n- [rewrite - 重写网络请求](05-rewrite.md)\r\n- [rules - 网络请求更改规则](03-rules.md)\r\n- [script - 脚本编写及说明](04-JS.md)\r\n- [Docker - Docker 运行相关](02-Docker.md)\r\n- [feed¬ify - 通知相关](07-feed¬ify.md)\r\n- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)\r\n- [webhook - webhook 使用简介](09-webhook.md)\r\n- [config - 配置文件说明](10-config.md)\r\n- [Advanced - 高级使用篇](Advanced.md)\r\n"
},
{
"path": "docs/02-Docker.md",
"content": "```\r\n最近更新: 2022-03-15\r\n适用版本: 3.6.3\r\n文档地址: https://github.com/elecV2/elecV2P-dei/blob/master/docs/02-Docker.md\r\n```\r\n\r\n## 简介\r\n\r\nDocker 镜像名称: elecv2/elecv2p\r\nDocker 镜像地址: https://hub.docker.com/r/elecv2/elecv2p\r\n\r\n## docker 及 docker-compose 的安装\r\n\r\n``` sh\r\n# 不同平台的安装方式可能不一样，仅供参考\r\n# docker 安装\r\nwget -qO- https://get.docker.com/ | sh\r\n\r\n# docker-compose 安装。（前往 https://github.com/docker/compose/releases 查看适合自己设备的版本）\r\ncurl -L \"https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/local/bin/docker-compose\r\n```\r\n\r\n## Docker 运行 elecV2P\r\n\r\n*以下命令仅供参考，具体映射端口和卷根据实际情况进行调整*\r\n\r\n```sh\r\n# 基础启动命令（重建后数据会丢失）\r\ndocker run --restart=always -d --name elecv2p -e TZ=Asia/Shanghai -p 80:80 -p 8001:8001 -p 8002:8002 elecv2/elecv2p\r\n\r\n# 推荐使用命令\r\ndocker run --restart=always \\\r\n -d --name elecv2p \\\r\n -e TZ=Asia/Shanghai \\\r\n -p 8100:80 -p 8101:8001 -p 8102:8002 \\\r\n -v /elecv2p/JSFile:/usr/local/app/script/JSFile \\\r\n -v /elecv2p/Lists:/usr/local/app/script/Lists \\\r\n -v /elecv2p/Store:/usr/local/app/script/Store \\\r\n -v /elecv2p/Shell:/usr/local/app/script/Shell \\\r\n -v /elecv2p/rootCA:/usr/local/app/rootCA \\\r\n -v /elecv2p/efss:/usr/local/app/efss \\\r\n elecv2/elecv2p\r\n\r\n# -p/-v 对应环境参数 宿主参数:容器内参数\r\n# 宿主机映射目录尽量填写尚未创建或空的文件夹\r\n# 如需更改默认的 80 端口，可在 -e 后面加上 PORT=8000\r\n# 某些设备上，可能无法在根目录创建 elecv2p 文件夹，这时请根据使用设备搜索可操作的目录，进行替换\r\n# 如果在部分复杂的网络情况下出现无法联网或访问的问题，尝试在命令中添加 --net=host\r\n\r\n# 查看 docker 运行状态\r\ndocker ps\r\n\r\n# 进入容器内部\r\ndocker exec -it elecv2p /bin/sh\r\n\r\n# Docker 的启动暂停\r\ndocker start elecv2p\r\ndocker stop elecv2p\r\ndocker restart elecv2p\r\n\r\n# 查看 Docker 运行日志\r\ndocker logs elecv2p -f\r\ndocker logs elecv2p --tail 20\r\n\r\n# 清除 Docker 运行日志\r\necho \"\" > $(docker inspect --format='{{.LogPath}}' elecv2p)\r\n\r\n# 升级容器\r\n# 先移除容器\r\ndocker rm -f elecv2p\r\n# 再拉取最新的镜像\r\ndocker pull elecv2/elecv2p\r\n# 最后再使用上面的 docker run 命令重新启动\r\n```\r\n\r\n## docker-compose 启动\r\n\r\n``` sh\r\nmkdir /elecv2p && cd /elecv2p\r\ncurl -sL https://git.io/JLw7s > docker-compose.yaml\r\n\r\ndocker-compose up -d\r\n\r\n# 默认把 80/8001/8002 端口分别映射成了 8100/8101/8102，以防出现端口占用的情况，访问时注意\r\n# 如果需要设置为其他端口，可以自行修改下面的内容然后手动保存\r\n```\r\n\r\n或者将以下内容手动保存为 docker-compose.yaml 文件。\r\n\r\n``` yaml\r\nversion: '3.7'\r\nservices:\r\n elecv2p:\r\n image: elecv2/elecv2p\r\n container_name: elecv2p\r\n restart: always\r\n environment:\r\n - TZ=Asia/Shanghai\r\n ports:\r\n - \"8100:80\"\r\n - \"8101:8001\"\r\n - \"8102:8002\"\r\n volumes:\r\n - \"/elecv2p/JSFile:/usr/local/app/script/JSFile\"\r\n - \"/elecv2p/Lists:/usr/local/app/script/Lists\"\r\n - \"/elecv2p/Store:/usr/local/app/script/Store\"\r\n - \"/elecv2p/Shell:/usr/local/app/script/Shell\"\r\n - \"/elecv2p/rootCA:/usr/local/app/rootCA\"\r\n - \"/elecv2p/efss:/usr/local/app/efss\"\r\n```\r\n\r\n- *具体使用的映射端口和 volumes 目录，根据个人情况进行调整*\r\n- *如需更改默认的 80 端口，在 environment 下添加一行: - PORT=8000*\r\n- *如果在某些设备上无法启动，尝试把文件开头的 version: '3.7' 更改为 version: '3.3'*\r\n\r\n然后在 docker-compose.yaml 同目录执行命令 **docker-compose up -d** ，启动程序。\r\n\r\n### env 默认环境变量\r\n\r\n在 elecV2P 启动前，可设置部分环境变量\r\n\r\n- TZ: 时区设置 timezone\r\n- PORT: webUI 对应端口，默认为 80\r\n- TOKEN: 启动时指定 WEBHOOK TOKEN\r\n\r\n使用示例：\r\n\r\n``` sh\r\ndocker run --restart=always \\\r\n -d --name elecv2p \\\r\n -e TZ=Asia/Shanghai PORT=8000 TOKEN=YOUR-WEBHOOK-TOKEN \\\r\n -p 8100:8000 -p 8101:8001 -p 8102:8002 \\\r\n -v /elecv2p/JSFile:/usr/local/app/script/JSFile \\\r\n -v /elecv2p/Lists:/usr/local/app/script/Lists \\\r\n -v /elecv2p/Store:/usr/local/app/script/Store \\\r\n -v /elecv2p/Shell:/usr/local/app/script/Shell \\\r\n -v /elecv2p/rootCA:/usr/local/app/rootCA \\\r\n -v /elecv2p/efss:/usr/local/app/efss \\\r\n elecv2/elecv2p\r\n```\r\n\r\n环境变量可以同时设置部分或全部\r\n\r\n**在 docker-compose 中 env 对应 environment**\r\n\r\n### 其他指令\r\n\r\n``` sh\r\n# 更新升级\r\ndocker-compose pull elecv2p && docker-compose up -d\r\n\r\n# 拉取特定版本的镜像文件。可用版本以 https://hub.docker.com/r/elecv2/elecv2p 的 tag 为准\r\ndocker pull elecv2/elecv2p:3.4.5\r\ndocker pull elecv2/elecv2p:arm64-3.0 # 在使用这些特定版本的镜像时，docker run 后面的镜像名也要记得调整\r\n\r\ndocker image prune # 清除没有挂载的镜像文件\r\n\r\n# 查看运行日志\r\ndocker logs elecv2p -f\r\n```\r\n\r\n### 一些说明\r\n\r\n- 当使用国内的一些 docker 源，因为缓存问题，更新之后可能不是最新的版本，需要手动更换一下 docker 源。（具体步骤谷歌）\r\n- arm32 平台如果出错，参考 [issues #78](https://github.com/elecV2/elecV2P/issues/78)\r\n\r\n### 说明文档列表\r\n\r\n- [overview - 简介及安装](01-overview.md)\r\n- [task - 定时任务](06-task.md)\r\n- [rewrite - 重写网络请求](05-rewrite.md)\r\n- [rules - 网络请求更改规则](03-rules.md)\r\n- [script - 脚本编写及说明](04-JS.md)\r\n- [Docker - Docker 运行相关](02-Docker.md)\r\n- [feed¬ify - 通知相关](07-feed¬ify.md)\r\n- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)\r\n- [webhook - webhook 使用简介](09-webhook.md)\r\n- [config - 配置文件说明](10-config.md)\r\n- [Advanced - 高级使用篇](Advanced.md)\r\n"
},
{
"path": "docs/03-rules.md",
"content": "```\r\n最近更新: 2022-03-24\r\n适用版本: 3.7.8\r\n文档地址: https://github.com/elecV2/elecV2P-dei/blob/master/docs/03-rules.md\r\n```\r\n\r\n## 准备工作\r\n\r\n- **再使用 RULES/REWRITE 相关功能前，请确定 ANYPROXY 已打开**\r\n- 已正确将网络请求代理到 ANYPROXY 端口\r\n- 匹配 https 请求请先添加 MITM host，普通 http 请求无需添加\r\n- *首次命中 https 请求时，系统需要生成中间证书，可能会稍长一点时间返回结果*\r\n\r\n## modify 规则集 格式说明\r\n\r\n| 匹配方式 | 匹配内容（正则） | 修改方式 | 修改目标 | 修改时间点\r\n :-----------: | --------------------- | :-------: | ------------------- | ----------\r\n| url | ^https://api.b.com/v2 | JS | file.js | 前(req)\r\n| host | api.bilibili.com | useragent | iPhone 6s | 后(res)\r\n| useragent | neteaseMusic / aliApp | block | reject|tinyimg |\r\n| reqmethod | GET/POST/PUT/DELETE | $HOLD | 30\r\n| reqbody | queryPara/word string | |\r\n| resstatus | 200 / 404 / 301 / ... | |\r\n| restype | text/html / text/json | ----- |\r\n| resbody | Keyword(string) | all - JS |\r\n\r\n- *实际使用中匹配方式和修改方式可以任意搭配*\r\n\r\n### 匹配方式\r\n\r\n```\r\nurl // 匹配 url \r\nhost // 匹配 url host 部分\r\nuseragent // 匹配 User-Agent \r\nreqmethod // 匹配 网络请求方式\r\nreqbody // 匹配 请求体（body）\r\nresstatus // 匹配 请求返回的状态码\r\nrestype // 匹配 返回的数据类型\r\nresbody // 匹配 返回的数据内容\r\n```\r\n\r\n- **v3.7.8 默认不再对 reqbody/resbody 内容进行匹配，以提升 elecV2P MITM 效率。如需开启，请参考下文源文件格式部分，增加属性项 \"enbody\": true。（不匹配不代表不可以修改，仍然可以通过 url/host 等方式进行匹配，然后使用脚本对 body 内容进行修改）**\r\n\r\n### 修改方式\r\n\r\n#### JS\r\n\r\n通过 JS 脚本修改网络请求数据，对应修改内容为 JS 文件名或远程 JS 链接。\r\n\r\n从该模块运行 JS，默认会添加 $request，$response(**数据返回前**) 两个变量，具体参数如下：\r\n\r\n- $request.headers, $request.body, $request.method, $request.hostname, $request.port, $request.path, $request.url\r\n- $response.headers, $response.body, $response.statusCode\r\n\r\n#### 307 重定向\r\n\r\n对应修改内容为重定向目标网址\r\n\r\n#### 阻止\r\n\r\nreject: 返回状态码 200, body 为空。 \r\ntinyimg: 返回状态码为 200, body 为一张 1x1 的图片\r\n\r\n#### $HOLD\r\n\r\n将原网络请求的 header 和 body 发送到前端网页进行修改处理，然后将修改后的数据直接发送给服务器/客户端。\r\n\r\n对应修改内容表示等待前端修改数据的时间，单位秒。当为 **0** 时，表示一直等待。如果为其他值且超时时则直接使用原数据进行下步操作。\r\n\r\n使用该修改方式时，请尽量使用比较详细的匹配规则，匹配单一网络请求，否则后面的 $HOLD 请求会覆盖前面的数据。\r\n\r\n**2020.7.16 2.1.0 更新**\r\n\r\n$HOLD request reject - 直接返回当前数据\r\n\r\n返回默认状态码: 200\r\n\r\n数据包含两部分: header 和 body\r\n\r\n#### User-Agent\r\n\r\n修改请求 header 中的 User-Agent。\r\n\r\n默认 User-Agent 可在 webUI->SETTING->网络请求相关设置进行管理修改\r\n\r\n### 修改时间\r\n\r\n网络请求匹配时间\r\n\r\n#### 网络请求前\r\n\r\nbeforeSendRequest\r\n\r\n#### 数据返回前\r\n\r\nbeforeSendResponse\r\n\r\n## 源文件格式\r\n\r\nRULES 规则列表保存于 **./script/Lists/default.list**，实际格式为严格的 JSON 类型（不包含任何注释）。\r\n*（参考: https://raw.githubusercontent.com/elecV2/elecV2P/master/script/Lists/default.list ）*\r\n\r\n``` JSON\r\n{\r\n \"rules\": {\r\n \"note\": \"elecV2P RULES 规则列表\",\r\n \"enable\": false, // 是否启用下面列表中的规则，仅在该值为 false 时，表示不启用，默认启用\r\n \"enbody\": false, // 是否对请求体(body)进行匹配，仅在该值为 true 时，表示启用（v3.7.8 添加，默认不启用\r\n \"list\": [\r\n {\r\n \"mtype\": \"url\",\r\n \"match\": \"adtest\",\r\n \"ctype\": \"block\",\r\n \"target\": \"reject\",\r\n \"stage\": \"req\"\r\n },\r\n {\r\n \"mtype\": \"url\",\r\n \"match\": \"httpbin.org/get\\\\?hold\",\r\n \"ctype\": \"hold\",\r\n \"target\": \"0\",\r\n \"stage\": \"req\", // enable 可省略。仅在 enable 为 false 的时候表示不启用\r\n \"enable\": true\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n*如非必要，请不要手动修改 list 源文件*\r\n\r\n### 说明文档列表\r\n\r\n- [overview - 简介及安装](01-overview.md)\r\n- [task - 定时任务](06-task.md)\r\n- [rewrite - 重写网络请求](05-rewrite.md)\r\n- [rules - 网络请求更改规则](03-rules.md)\r\n- [script - 脚本编写及说明](04-JS.md)\r\n- [Docker - Docker 运行相关](02-Docker.md)\r\n- [feed¬ify - 通知相关](07-feed¬ify.md)\r\n- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)\r\n- [webhook - webhook 使用简介](09-webhook.md)\r\n- [config - 配置文件说明](10-config.md)\r\n- [Advanced - 高级使用篇](Advanced.md)\r\n"
},
{
"path": "docs/04-JS.md",
"content": "```\r\n最近更新: 2024-11-10\r\n适用版本: 3.8.1\r\n文档地址: https://github.com/elecV2/elecV2P-dei/blob/master/docs/04-JS.md\r\n```\r\n\r\n**每个脚本理论上都有权限对服务器上的任一文件进行修改，请不要运行不信任的脚本。**\r\n\r\n## 保存目录\r\n\r\n本地脚本物理存储目录位于 **./script/JSFile**，在 RULS/REWRITE/TASK/WEBHOOK 中调用时，直接使用对应的文件名即可。支持多级目录，比如 test/exam.js。\r\n\r\n所有文件名称和内容可在 webUI->JSMANAGE/脚本管理 中查看和修改。\r\n\r\n*如果远程脚本推送失败，尝试在 SETTING/设置->网络请求相关设置 中添加代理，或者下载后使用本地上传。*\r\n\r\n## CONTEXT - 脚本运行环境\r\n\r\n在 elecV2P 中，默认脚本的运行环境是基于 [vm](http://nodejs.org/api/vm.html) 模块的虚拟环境，同时增加了以下一些默认的环境变量及函数。\r\n\r\n### 默认参数/环境变量\r\n\r\n\r\n#### 主要函数\r\n\r\n```\r\n- $axios // 网络请求\r\n- $cheerio // HTML处理\r\n- $exec // 简单 shell 命令执行\r\n- $download // 文件下载\r\n- $feed // 通知模块\r\n- $store // cookie/常量/数据存储\r\n- $evui // 在前端网页生成 UI 界面\r\n- $message // 发送网页消息\r\n- $done // 返回脚本执行结果（后面代码会继续执行）\r\n\r\n- $cache // 临时数据存储（v3.4.3 添加）\r\n- $task // 定时任务管理（v3.4.4 添加，sudo 模式下生效）\r\n- $env // 临时环境变量（v3.4.5 添加，默认包含 process.env 中的所有值）\r\n- $fend // efh 脚本前后端通信函数（v3.5.5 添加）\r\n- $webhook // 调用 webhook 接口（v3.5.8 添加，sudo 模式下生效）\r\n```\r\n\r\n可利用这些函数判断当前脚本是否运行在 elecV2P 中，比如：\r\n\r\n``` JS\r\nif (typeof $fend !== 'undefined') {\r\n console.log('elecV2P 运行环境')\r\n} else {\r\n console.log('其他运行环境')\r\n}\r\n```\r\n\r\n#### 附加变量 (以两个短下划线开头)\r\n\r\n```\r\n- __version // 当前 elecV2P 版本\r\n- __vernum // 当前版本数字表达（v3.4.5 添加）。比如版本 3.4.5 表达为 345\r\n- __home // 主页地址。 可在 webUI->SETTING 界面设置\r\n- __efss // efss 目录。 可在 webUI/efss 页面设置\r\n- __name // 脚本名。 v3.3.0 添加 (如果是多级目录脚本，会包含目录)\r\n- __dirname // 脚本所在目录 (v3.4.4)\r\n- __filename // 脚本完整路径 (v3.4.4)\r\n- __userid // 用户 ID (v3.6.4)\r\n- __md5hash // 当前脚本内容的 md5 hash 值（v3.6.7）\r\n\r\n- __taskid // 启动该脚本的任务 id (仅在定时任务触发脚本时有值，其他时候为 undefined)\r\n- __taskname // 启动该脚本的任务名称 (仅在定时任务触发脚本时有值，其他时候为 undefined)\r\n\r\n// 测试 JS:\r\n// console.log('dirname:', __dirname, 'version:', __version, 'homepage:', __home)\r\n// console.log('当前 efss 目录:', __efss, '当前脚本名称:', __name)\r\n// if (__vernum >= 367) console.log('当前脚本 md5 hash:', __md5hash)\r\n```\r\n\r\n#### 特殊变量函数\r\n\r\n```\r\n- $ws // 通过 websocket 向前端发送数据\r\n- $request/$response\r\n- require() // 直接引用其他 nodejs 模块或脚本\r\n- console.clear() // 清空该脚本的运行日志\r\n- // @grant // 在单个脚本开启增强功能\r\n```\r\n\r\n### @grant（v3.8.1 后取消脚本环境兼容性判断\r\n\r\nJS 文件开头使用 **// @grant** 开启一些增强功能\r\n\r\n*如果要使用纯 nodejs 环境运行，在 TASK 中请选择 shell 指令模式，然后: node xxxxx.js。 或者在脚本中使用 $exec('node xxxx.js') 来执行*\r\n\r\n```\r\n// @grant nodejs 脚本和直接使用 node xxxx.js 运行脚本的区别:\r\n\r\n- 使用 node xxxxx.js 无法使用 $axios/$store/$feed 等非 nodejs 原生函数/变量\r\n- 默认脚本运行在 vm 的虚拟环境中，而 node xxxx.js 运行在原生系统环境中\r\n```\r\n\r\n日志调整\r\n\r\n* **// @grant calm** ;不打印日志，但保留到日志文件中，也不影响通知(console.error 错误日志还是会正常打印)\r\n* **// @grant still** ;不输出日志，有通知(即 console 函数无效)\r\n* **// @grant quiet** ;输出日志，但不通知\r\n* **// @grant silent** ;不输出日志，也不通知\r\n\r\n#### sudo 模式(v3.4.4)\r\n\r\n* **// @grant sudo** \r\n\r\nsudo 模式下启用功能\r\n\r\n- $task ;定时任务管理（v3.4.4）\r\n- $webhook ;调用 webhook 接口功能（v3.5.8）\r\n- 其他功能待添加\r\n\r\n### $axios - 网络请求\r\n\r\n$axios(request)\r\n\r\nrequest 格式 [object/string]\r\n- object：支持参数参考：[axios](https://github.com/axios/axios)\r\n- string：单个 url 链接\r\n\r\n``` JS\r\n// --- example 1 ---\r\n$axios('https://httpbin.org/get?hello=elecV2P').then(res=>console.log(res.data)).catch(e=>console.log(e))\r\n\r\n// --- example 2 ---\r\n$axios({\r\n url: 'https://httpbin.org/put',\r\n method: 'put',\r\n timeout: 6000,\r\n data: {\r\n hello: 'elecV2P'\r\n }\r\n}).then(res=>console.log(res.data)).catch(e=>console.log(e.message))\r\n```\r\n\r\n* **$axios** 无 .put/.post 等方法，使用 { ..., method: 'put/post' } 实现\r\n\r\n**v2.1.8 更新 $axios(request, proxy)**\r\n\r\n增加第二个参数 proxy, 此参数会覆盖 request.proxy, 示例\r\n\r\n``` JS\r\n$axios(request, {\r\n host: '127.0.0.1',\r\n port: 9000,\r\n auth: {\r\n username: 'hello',\r\n password: 'elecV2P'\r\n }\r\n}).then(res=>console.log(res.data)).catch(e=>console.log(e.message))\r\n\r\n// 当 proxy 为 {} 时使用内部 ANYPROXY 代理，为 false 时: 强制跳过使用代理，如省略则使用 webUI->SETTING 网络请求相关设置。\r\n// 其他设置参考 [axios](https://github.com/axios/axios) request/proxy 部分\r\n```\r\n\r\n如在运行脚本时需要访问某些境外网站，可在 webUI->SETTING 网络请求相关设置 中添加代理。\r\n\r\n### $store - store/cookie 常量\r\n\r\n所有存储常量以文件的形式保存在 **script/Store** 目录中。\r\n所有脚本共用存储常量，比如在 a.js 中使用 $store.put('something', 'akey'), 可在 b.js 中使用 $store.get('akey') 来获取存储值。\r\n\r\n``` JS example\r\n$store.get(key, options) // 获取存储值\r\n// options 可选\r\n// - string 字符串\r\n// - 'raw': 获取存储文件源内容\r\n// - 'string/array/object/boolean/number': 以相应格式获取存储值\r\n// - object (v3.6.6 新增)\r\n// {\r\n// type: 'string', // 可选值同上面字符串\r\n// pass: 'string', // 获取加密内容时密码\r\n// algo: 'ebuf', // 获取加密内容时算法，可省略。默认为 ebuf 自定义算法\r\n// }\r\n\r\n$store.put(value, key, options) // 保存\r\n// options 可选\r\n// - string 字符串\r\n// - 'a': 添加内容。具体参考下面的 JS 实例\r\n// - 'string/array/object/boolean/number': 保存为对应格式\r\n// - object (v3.3.3 新增)\r\n// {\r\n// type: 'a', // 可选值同上面字符串\r\n// note: '备注信息', // 关于 cookie 的一些说明，可省略\r\n// belong: 'test.js', // 该 cookie 的归属脚本（调用或写入该 cookie 的脚本），可省略\r\n// pass: 'string', // 加密存储内容时的密码(v3.6.6 新增)\r\n// algo: 'ebuf', // 加密存储内容时的算法(v3.6.6 新增)，可省略。默认为 ebuf 自定义算法\r\n// }\r\n$store.set(key, value, options) // 等同于将上面的 $store.put 交换 key 和 value 的位置。(v3.4.5 添加)\r\n\r\n$store.delete(key) // 删除\r\n```\r\n\r\n$store 保存时会对数据类型进行简单的判断，当数据类型为 **number/boolean/array/object** 时，会按照数据类型进行保存。\r\n\r\n``` JS store 实例\r\n$store.put(123, 'number') // put 方法，第一个参数为保存值 value, 第二个参数为关键字 key\r\ntypeof $store.get('number') // get 方法通过关键字获取保存值，返回数字 123，类型为 number\r\n\r\n$store.get('number', 'raw') // 返回 { \"type\": \"number\", \"value\": 123 }\r\n\r\n$store.set('newarr', [2,3,4]) // 存储为数组。保存成功返回 true，失败返回 false。 set 方法第一个参数为 key，第二个参数为 value\r\n$store.get('newarr') // 返回数组: [2,3,4]\r\n\r\n$store.put(5, 'newarr', 'a')\r\n// 根据 newarr 原来保存值的类型，存储新的结果\r\n// 原 newarr 值为 array 数组，则新保存值为: [2,3,4,5]\r\n// 如果原 newarr 的值为数字，比如 8，则新的存储值 13\r\n$store.put([6,7], 'newarr', 'a') // newarr 新值为：[2,3,4,5,6,7]\r\n\r\n$store.put('a string', 'keystr') // 不指定类型时 直接保存为 string 的形式\r\n$store.put('add new line', 'keystr', 'a') // 在原 keystr 的值后面添加新行\r\n$store.get('keystr', 'raw')\r\n// 返回：\r\n// {\"type\":\"string\",\"value\":\"a string\\nadd new line\"}\r\n\r\n$store.put({a: 334, b: 'abc'}, 'keyobj') // 存储类型为 object。\r\n$store.get('keyobj') // 返回: {\"a\":334,\"b\":\"abc\"}\r\n$store.get('keyobj', 'raw') // 返回: {\"type\":\"object\",\"value\":{\"a\":334,\"b\":\"abc\"}}\r\n$store.put({c: 'new val'}, 'keyobj', 'a') // 新存储的值为: {\"a\":334,\"b\":\"abc\",\"c\": \"new val\"}\r\n\r\n$store.put('eoooe', 'keybol', 'boolean') // 强制转化为 boolean 值: true\r\n// 建议在使用 $store.put 并指定 type 的时候，先确定原存储数值和即将保存数值的类型，以免发生未知错误。\r\n\r\n$store.delete('number') // 删除某个 store/cookie 常量 number\r\n// 等同于 $store.put('', 'number')\r\n\r\n// 特殊情况\r\n$store.put('a string 字符', 'objstr', 'object') // 强制将字符串保存为 object 格式。存储值为: {0: \"a string 字符\"}。 PS: array 是同样结果\r\n$store.get('keystr', 'array') // 将字符串以 object 格式取出。结果为: {\"0\":\"a string\"}\r\n\r\n// v2.5.2 更新 $store.get type random。 type 关键字 random 或者 r\r\n$store.get('newarr', 'random') // 返回 newarr 数组中的一个随机值\r\n$store.get('number', 'r') // 返回 0 - number 代表值 中间的任一整数\r\n$store.get('keyobj', 'r') // 返回 object 中的任一 keys 对应值\r\n$store.get('keybol', 'random') // 返回 随机 true/false\r\n$store.get('keystr', 'r') // 如果 keystr 存储的是字符串，取随机值时，取随机一行的数据\r\n\r\n// v3.3.3 更新: $store.put 第三个参数改为 options\r\n// 当 options 为字符串类型时表示为之前的普通 type 类型\r\n// 当 options 为 object 类型时，type/note/belong 关键字分别表示该 cookie 的 类型/备注/关联脚本\r\n$store.put('a string 字符', 'objstr', {\r\n type: 'string',\r\n note: '关于这个 cookie 一些备注说明',\r\n belong: __name + ', store.js', // 调用/写入这个 cookie 的脚本\r\n})\r\n\r\n// v3.6.6 更新 加密存储\r\n$store.put('待加密的内容', 'tstr', {\r\n pass: '加密密钥 password',\r\n})\r\n// 使用对应密钥获取加密内容\r\n$store.get('tstr', {\r\n pass: '加密密钥 password',\r\n})\r\n\r\n// 普通 get，获取到的数据是加密后的内容\r\n$store.get('tstr')\r\n\r\n$store.put({ a: '加密其他类型的数据，比如 object' }, 'tobj', {\r\n type: 'object',\r\n pass: $env.STORE_KEY || 'testkey', // 可配合环境变量隐藏使用密钥\r\n})\r\n```\r\n\r\n### $cache - 临时数据存储 (v3.4.3)\r\n\r\n用于存储脚本运行时的一些临时数据，在 elecV2P 重启后会自动丢弃。\r\n所有脚本共享临时数据，比如在 a.js 中使用 $cache.hello = 'elecV2P', 可在 b.js 中使用 $cache.hello 来获取临时值。\r\n\r\n共有五个方法: get(key), put(value, key), delete(key), keys(), clear()\r\nv3.4.5 添加方法: set(key, value) // 和 put 方法的 key/value 顺序相反\r\n\r\n``` JS\r\n$cache.v = 'hello elecV2P' // 添加临时变量 v\r\n// 等同于\r\n$cache.put('hello elecV2P', 'v') // put 方法 value 在前，key 在后\r\n$cache.set('vv', '你好，elecV2P') // set 方法 key 在前，value 在后（v3.4.5 添加）\r\n\r\nlet val = $cache.get('v') // 获取临时变量 v 中的内容\r\n// 等同于 let val = $cache.v\r\n\r\n$cache.delete('v') // 删除临时变量 v\r\nconsole.log($cache.v, $cache.vv) // 如果临时变量不存在，将会返回 undefined\r\n\r\n$cache.obj = { // 临时变量存储对象可以是任意值。包括 object 和 函数等\r\n num: 1234,\r\n s(){\r\n console.log('$cache function', this.num++)\r\n }\r\n}\r\n$cache.obj.s()\r\nconsole.log($cache.obj.num)\r\n\r\nlet keys = $cache.keys() // 以数组的形式返回当前所有临时变量关键字。\r\n// [ 'obj' ]\r\n\r\n$cache.clear() // 清空存储的临时变量\r\nconsole.log(keys, $cache.keys())\r\n\r\nconsole.log($cache.size) // 当前临时变量个数。（v3.4.5 添加）\r\n```\r\n\r\n**$cache** 和 **$store** 的区别:\r\n- $cache 数据在内存中读写，$store 数据在硬盘上读写（因此，$cache 存取速度更快，但会占用一些内存，不建议保存大量数据）\r\n- $cache 是临时存储，在 elecV2P 重启后所有数据会丢失。$store 是常量存储，重启后已存储数据依然存在\r\n- $store 只能通过 get/put 方法来存取数据，而 $cache 可以直接通过点引用来存取。（比如: $cache.haha = '哈哈哈哈哈哈哈'）\r\n- $store 没有 keys()/clear()/size 的方法/属性，也不能保存函数类'动态'数据\r\n\r\n### $env - 临时环境变量 (v3.4.5)\r\n\r\n``` JS\r\nconsole.log($env)\r\nconsole.log('version', $env.version)\r\n\r\nlet key = 'name'\r\nif ($env[key]) {\r\n console.log($env[key])\r\n} else {\r\n console.log('当前环境变量中暂无', key, '相关值')\r\n}\r\n```\r\n\r\n- 临时环境变量默认包含 process.env 中的所有值，不管当前是否以 nodejs 兼容模式运行\r\n- 临时环境变量仅在当前脚本中有效。比如在 a.js 中设置 $env.version = '1.0.0', 在 b.js 中 $env.version 还是等于 process.env.version\r\n- process.env 的变化会反应到 $env 中，但 $env 的变化不会影响 process.env 的值\r\n- 在使用定时任务或 webhook 等方式运行脚本时，可使用 -env 添加临时环境变量（具体参考 [06-task.md](https://github.com/elecV2/elecV2P-dei/blob/master/docs/06-task.md) 运行 JS 相关部分）\r\n- v3.7.6 增加 $env.lang 获取当前设置的语言偏好，比如 en | zh-CN\r\n\r\n### $feed - 通知模块\r\n\r\n发送一条通知\r\n- $feed.push(tile, description, url)\r\n - title: 通知标题。 如省略，则会使用 'elecV2P 通知' 替代\r\n - description: 通知内容。 如省略，则会显示 'a empty message\\n没有任何通知内容'\r\n - url: 点击通知后的跳转链接。可省略\r\n\r\n``` JS example\r\n// PUSH 通知包括 RSS 和其他手动设置好的通知方式\r\n$feed.push('elecV2P notification', '这是一条来自 elecV2P 的通知', 'https://github.com/elecV2/elecV2P')\r\n\r\n// 单独发送一条 ifttt 通知\r\n$feed.ifttt('elecV2P 通知', '一条来自 $feed.ifttt 的通知', 'https://github.com/elecV2/elecV2P-dei')\r\n\r\n// 单独发送一条 bark 通知\r\n$feed.bark('elecV2P 通知', '一条来自 $feed.bark 的通知', 'https://t.me/elecV2')\r\n\r\n// 在 title 开头添加 $enable$ 强制发送通知\r\n$feed.cust('$enable$自定义通知', '使用 $enable$ 强制发送的一条通知', 'https://github.com/elecV2/elecV2P-dei/tree/master/docs/07-feed¬ify.md')\r\n```\r\n\r\n- ifttt/bark 等通知需提前在 webUI->SETTING 页面设置好 TOKEN/KEY\r\n- 如果 SETTING 相关通知为关闭状态，则调用了也不会有通知\r\n\r\n更多相关说明参考: [07-feed¬ify](https://github.com/elecV2/elecV2P-dei/tree/master/docs/07-feed¬ify.md)\r\n\r\n### $exec - Shell 指令执行函数\r\n\r\n*Shell 指令的运行基于 nodejs 的 [child_process_exec](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) 模块*\r\n\r\n#### 基础使用: $exec(command, options = { cwd, env, timeout, call, cb, stdin })\r\n\r\n*options 可省略，opitons 中的每一项参数也都可省略*\r\n\r\n- cwd: (string) 工作目录\r\n - 当没有设置或设置目录不存在时，如果是 node 命令开头，默认为: script/JSFile，其他情况默认为: script/Shell\r\n - v3.4.2 之前默认工作目录为: process.cwd()\r\n- env: (object) 环境变量 (默认为: process.env)\r\n- timeout: (number) 超时时间。单位: 毫秒(ms)，0: 表示不设定超时时间。默认为 60000ms(60秒)\r\n- call: (boolean) 是否在命令执行完成后返回所有输出内容\r\n- cb(data, error, finish): (function) 回调函数\r\n - data: stdout.on('data') 命令执行时的输出内容\r\n - error: stderr.on('data') 命令执行出错时的输出内容\r\n - finish: exec.on('exit') 命令执行完毕信号，最终返回 true\r\n- stdin: (object) { write, delay } 延时输入交互数据(v3.2.6 增加)\r\n - write: (string) 延时写入的数据\r\n - delay: (number) 延时时间。单位: 毫秒(ms)，可省略(默认为 2000)\r\n\r\n``` JS example\r\n$exec('ls', {\r\n cwd: './efss', // 命令执行目录\r\n timeout: 5000,\r\n cb(data, error){\r\n error ? console.error(error) : console.log(data)\r\n }\r\n})\r\n\r\n// 如果省略 options 中的所有参数，那么对应输出只能在后台看到\r\n$exec('node -v')\r\n\r\n// 在 Docker 环境在安装 python3，并执行其他 python 文件\r\n$exec('apk add python3', {\r\n timeout: 0,\r\n cb(data, error, finish){\r\n if (finish) {\r\n // 安装完以后可以直接在 JS 中调用。（pyhton 和库安装完成后可在其他脚本中直接调用，不需要再次安装。）\r\n $exec('python3 -u test.py', {\r\n cwd: './script/Shell', // test.py 文件放置的目录。可修改为其他目录，比如 './efss'\r\n cb(data, error){\r\n error ? console.error(error) : console.log(data)\r\n }\r\n })\r\n\r\n // 安装一些 python 库\r\n $exec('pip3 install you-get youtube-dl numpy requests')\r\n } else {\r\n error ? console.error(error) : console.log(data)\r\n }\r\n }\r\n})\r\n\r\n// stdin 延迟输入交互内容 简单示例\r\n$exec('python3 -u askinput.py', {\r\n cwd: './script/Shell',\r\n stdin: {\r\n delay: 3000, // 输入延时时间，单位 ms。可省略\r\n write: 'elecV2P\\nI am fine, thank you.' // 具体输入数据。（根据实际情况进行修改）\r\n },\r\n cb(data, error){\r\n if (error) {\r\n console.error(error)\r\n } else {\r\n console.log(data)\r\n }\r\n }\r\n})\r\n\r\n/* askinput.py 内容\r\nname = input(\"what is your name?\") \r\nprint('nice to meet you,', name)\r\ngreet = input(f\"how are you, {name}?\")\r\nprint(greet)\r\n */\r\n\r\n// 特别使用: 给当前执行命令设置单独日志文件\r\n$exec('ls', {\r\n cwd: './efss', // 命令执行目录\r\n logname: 'ls执行日志', // 命令执行日志保存文件名，可自定义为其他值\r\n from: 'task', // v3.4.5 之前此项必需，且只能为 'task'。v3.4.5 之后可省略\r\n // 当 from 设置为 task 时，实时日志可在 TASK 定时任务界面查看\r\n // cb 函数可省略。日志记录保存在 logname 设置的文件中\r\n})\r\n```\r\n\r\n*如果命令不可执行，尝试先在系统命令行工具下手动输入命令，进行测试*\r\n\r\n**如果 windows 平台出现乱码，尝试命令 *CHCP 65001*。或者修改注册表 Active code page 为 65001（具体操作，善用搜索）** （*尝试过 iconv 转换(< v1.8.2)，弃用*）\r\n\r\n#### **v3.2.8 增加支持运行远程文件**\r\n\r\n``` JS\r\n// 例如:\r\n$exec('python3 -u https://raw.githubusercontent.com/elecV2/elecV2P/master/script/Shell/test.py', {\r\n cwd: './script/Shell', // 命令执行目录\r\n timeout: 5000,\r\n cb(data, error){\r\n error ? console.error(error) : console.log(data)\r\n }\r\n})\r\n/* 说明:\r\n- 当执行命令(command)中包含远程链接时，会自动下载远程文件到 cwd 目录，并将该远程链接替换为下载后的文件地址\r\n - 比如，上面的代码会先下载远程文件 test.py 到 script/Shell 目录，然后命令自动转化为 python3 -u /xxx/script/Shell/test.py\r\n- 远程链接匹配方式: command.match(/ (https?:\\/\\/\\S{4,})/)\r\n- 远程文件执行时默认每次都会重新下载\r\n - 可使用 options.rename: xxx 来重命名下载文件\r\n - 可使用 options.local: true 来跳过下载远程文件，直接以本地文件运行（如果存在的话，如果不存在还是会远程下载\r\n- 如果远程文件下载失败，将会尝试运行本地文件\r\n- 如果不希望对原命令中的远程链接进行下载及替换操作，可使用 options.nohttp: true, 或使用 -http 进行转义\r\n - 注意: 命令中的所有 ' -http' 字符(不含引号)都会被替换为 ' http'\r\n- 以下常用命令已排除远程下载及替换操作:\r\n - curl/wget/git/start (v3.2.9)\r\n - you-get/youtube-dl (v3.3.0)\r\n - aria2c/http/npm/yarn/ping/openssl/telnet/nc/echo (v3.4.2)\r\n - *如果还有其他的常用网络相关命令，欢迎反馈添加*\r\n**/\r\n\r\n// 以 git 等其他常用命令开头，远程链接不会进行自动转换，按原命令处理\r\n$exec('git clone https://github.com/elecV2/elecV2P', {\r\n cwd: 'script/JSFile',\r\n cb(data, error, finish){\r\n error ? console.error(error) : console.log(data)\r\n if (finish) {\r\n console.log('git clone 完成')\r\n }\r\n }\r\n})\r\n\r\n// 其他命令中如果包含远程链接，将会自动下载，并将命令中的远程链接替换为文件下载后的地址\r\n$exec('node https://raw.githubusercontent.com/elecV2/elecV2P/master/script/JSFile/webhook.js', {\r\n // 将自动下载 webhook.js 到 cwd 目录('script/JSFile')，并将远程链接替换为文件下载后的地址 node /xxx/script/JSFile/webhook.js\r\n cwd: 'script/JSFile',\r\n local: true, // true: 当 cwd 目录下存在 webhook.js 时，直接使用本地文件运行，不进行远程下载\r\n // rename: 'testremote.js', // 重命名远程下载文件\r\n cb(data, error){\r\n error ? console.error(error) : console.log(data)\r\n }\r\n})\r\n\r\n$exec('echo -http://127.0.0.1') // 输出结果为: http://127.0.0.1\r\n// 等同于\r\n$exec('echo http://127.0.0.1') // echo 命令不会下载远程文件及替换\r\n\r\n// 使用 cat 命令下载并查看远程文件\r\n$exec('cat http://127.0.0.1/efss/readme.md', {\r\n // 如没有指定 cwd，或指定 cwd 目录不存在时，则使用默认 cwd: script/Shell\r\n // nohttp: true, // 启用此项，表示不转化 http 远程链接，将会搜索文件 'http://127.0.0.1/efss/readme.md'，然后直接报错\r\n // local: true, // 启用此项，表示如果 cwd 目录中存在 readme.md 文件，则不下载(但远程链接会替换为本地文件地址)\r\n cb(data, error){\r\n error ? console.error(error) : console.log(data)\r\n }\r\n})\r\n```\r\n\r\n### $cheerio - HTML处理\r\n\r\n用于对 html 的处理\r\n\r\n``` JS example\r\n// example #1\r\nlet body = $response.body\r\nlet restype = $response.headers['Content-Type']\r\n\r\nif (/html/.test(restype)) {\r\n const $ = $cheerio.load(body)\r\n $('body').text('hello cheerio')\r\n body = $.html()\r\n console.log(body)\r\n}\r\n\r\n$done(body)\r\n\r\n// example #2\r\nconst $ = $cheerio.load(`\r\n - Apple
\r\n - Orange
\r\n - Pear
\r\n
`);\r\n\r\nconst apple = $('.apple', '#fruits').text()\r\nconsole.log(apple)\r\n\r\nconst attr = $('ul .pear').attr('class');\r\nconsole.log(attr)\r\n\r\nconst html = $('#fruits').html();\r\nconsole.log(html)\r\n\r\n$done($('.pear').text())\r\n```\r\n\r\n更多使用方法参考：[cheerio](https://github.com/cheeriojs/cheerio) 官方说明文档\r\n\r\n### $download - 文件下载\r\n\r\n用于直链文件下载，可指定下载目录。如不指定下载目录则保存到默认目录。\r\n默认保存目录为 efss 虚拟目录，如果 efss 目录为空则保存到 web/dist 目录。\r\n\r\n基础用法：\r\n$download(url, options).then(d=>console.log(d)).catch(e=>console.error(e))\r\n\r\n**options** 变量说明：\r\n- 直接省略，表示使用默认目录保存文件\r\n- 字符类型，分两种情况\r\n - 字符表示的是一个已存在的文件夹，则下载到该文件夹，并以 url 的结尾命名文件\r\n - 否则表示的是 **目录(如有)+文件名**\r\n- 对象类型，可接受四个参数: { folder, name, existskip, timeout }\r\n - folder 表示下载目录\r\n - name 表示文件名(其中也可包含目录)\r\n - existskip 当目标文件已存在时不下载(v3.4.9 添加)\r\n - timeout 本次下载的超时时间，单位 ms(v3.5.0 添加)\r\n\r\n下面以几个具体实例进行说明：\r\n\r\n``` JS example\r\n$download('https://raw.githubusercontent.com/elecV2/elecV2P/master/Todo.md').then(d=>console.log(d)).catch(e=>console.error(e))\r\n\r\n// 指定下载目录及文件名\r\n$download('https://raw.githubusercontent.com/elecV2/elecV2P-dei/master/examples/Shell/exam-request.py', './script/Shell/myreq.py').then(d=>console.log(d)).catch(e=>console.error(e))\r\n// 前面一部分 script/Shell 表示保存目录，后面的 myreq.py 表示文件名\r\n// 如果仅有 myreq.py 的话，文件会以该名字保存到默认目录\r\n\r\n// 以 object 方式指定下载目录\r\n$download('https://raw.githubusercontent.com/elecV2/elecV2P-dei/master/examples/JSTEST/boxjs.ev.js', {\r\n folder: './script/JSFile',\r\n name: 'box.js',\r\n existskip: true,\r\n}).then(d=>console.log('文件已下载至: ' + d)).catch(e=>console.error(e))\r\n// 假如将 name 修改为 'test/box.js', 此时文件名中同时包含目录，则会在 script/JSFile 下新建目录 test，然后将文件(box.js)保存到 test 中\r\n```\r\n\r\n#### 特别使用：获取下载进度\r\n\r\n$download(url, options, cb) - 前两项参数不变，增加第三个参数为 callback 函数，callback 函数在下载期间会被多次调用。\r\n\r\ncb(options = {})，传入的 options 参数有如下值：\r\n\r\n- name: 下载的文件名称\r\n- progress: 下载的进度条\r\n- chunk: 第 n 个下载块（仅在下载中存在\r\n- dsize: 文件已下载大小（downloaded size （v3.7.2 增加\r\n- total: 文件总大小（对应为 response.headers['content-length'] 项，不存在时为 NaN（v3.7.2 增加\r\n- start: 开始下载（仅开始下载时存在（对应内容为下载文件的完整保存路径（v3.7.2\r\n- finish: 下载完成后的消息（仅在下载完成后存在（对应内容为下载后文件的完整路径（v3.7.2\r\n\r\n*start 和 finish 内容一样，都表示文件下载到 elecV2P 服务器的绝对路径，只是存在阶段不一样*\r\n\r\n示例:\r\n\r\n``` JS\r\n$download('https://raw.githubusercontent.com/elecV2/elecV2P-dei/master/examples/Shell/elecV2P.py', {\r\n folder: 'script/Shell',\r\n name: 'elecV2P.org.py'\r\n}, (options)=>{\r\n // callback 函数，支持异步函数\r\n if (options.start) {\r\n // 下载开始时存在的参数 opitons.name/progress/chunk/dsize/total/start\r\n // 开始阶段 chunk<=>dsize<=>0\r\n console.log(`开始下载文件 ${options.name} 到 ${options.start}, 文件大小 ${kSize(options.total)}`)\r\n } else if (options.finish) {\r\n // 下载完成时存在的参数 opitons.name/progress/dsize/total/finish\r\n // 完成阶段 dsize<=>total<=>response.headers['content-length'] || NaN\r\n $message.success(`${options.name} 下载完成 ${options.total ? '总大小 ' + kSize(options.total) : ''}`)\r\n console.log(options.name, '已下载至', options.finish)\r\n } else {\r\n // 下载中存在的参数 opitons.name/progress/chunk/dsize/total\r\n options.chunk % 100 === 0 && $message.success(`正在下载 ${options.name} 第 ${options.chunk} 块数据 ${kSize(options.dsize)}/${kSize(options.total)}`, { mid: 'download' })\r\n // console.log(options.progress + '\\r') // 显示下载进度条。（后面的 '/r' 用于在前端页面删除上一条 log 日志）\r\n console.log(options.progress, '\\x1b[F') // v3.7.2 后推荐使用该条代码\r\n }\r\n}).then(d=>console.log(d)).catch(e=>console.error(e))\r\n\r\nfunction kSize(size, k = 1024) {\r\n if (size < k) {\r\n return size + ' B'\r\n }\r\n if (size < k*k) {\r\n return (size/k).toFixed(2) + ' K'\r\n }\r\n if (size < k*k*k) {\r\n return (size/(k*k)).toFixed(2) + ' M'\r\n }\r\n return (size/(k*k*k)).toFixed(2) + ' G'\r\n}\r\n```\r\n\r\n### $evui - 生成一个 UI 界面\r\n\r\n*$evui 的参数传递基于 websocket*\r\n\r\n可接收两个参数：$evui(option, callback)\r\n- option: UI 界面相关参数\r\n- callback: 用于接收处理 UI 界面提交返回的数据。（可省略）\r\n\r\n$evui 返回的是一个 Promise 函数\r\n- resolve 条件: 当 cbable 为 true 时，直到前端关闭窗口。否则，直接 resolve\r\n- reject 条件: 传递参数有误或者 websocket 尚未连接\r\n\r\n``` JS\r\nconst ui = {\r\n id: 'ebcaa4ff', // 给图形界面一个独一无二的 ID。可省略（以下所有参数都可省略，不再重复说明）\r\n title: 'elecV2P windows', // 窗口标题\r\n width: 800, // 窗口宽度\r\n height: 600, // 窗口高度。null 表示自适应高度\r\n content: `显示一张图片
`, // 图形界面显示内容\r\n style: { // 设置一些基础样式\r\n title: \"background: #6B8E23;\", // 设置标题样式\r\n content: \"background: #FF8033; font-size: 32px; text-align: center\", // 设置中间主体内容样式\r\n cbdata: \"height: 220px;\", // 设置返回数据输入框样式\r\n cbbtn: \"width: 220px;\" // 设置提交数据按钮的样式\r\n },\r\n resizable: true, // 窗口是否可以缩放\r\n draggable: true, // 窗口是否可以拖动\r\n cbable: true, // 是否启用 callback 函数，用于接收前端 UI 提交返回的数据\r\n cb(data){ // callback 函数。此项会被 $evui 的第二个参数覆盖(如有)\r\n console.log('data from client:', data)\r\n },\r\n cbdata: 'hello', // 提供给前端 UI 界面的初始数据\r\n cblabel: '提交数据', // 提交按钮显示文字\r\n script: `console.log('hello $evui');alert('hi, elecV2P')`, // v3.2.4 增加支持在前端网页中插入 javascript 代码\r\n}\r\n\r\n$evui(ui, data=>{\r\n // 此为 callback 函数，用于接收处理前端 UI 返回的数据，可省略。如有则会覆盖前一项参数中的 cb 变量(ui.cb)\r\n if (data == 1) {\r\n $feed.push('Get a infomation frome $evui', 'message:' + data)\r\n } else if (/^exec /.test(data)) {\r\n let command = data.split('exec ').pop()\r\n $exec(command, {\r\n cb(data, error){\r\n console.log(error || data)\r\n }\r\n })\r\n } else {\r\n console.log('data from client:', data)\r\n }\r\n}).then(data=>console.log(data)).catch(e=>console.error(e))\r\n\r\n// 发送关闭前端 evui 界面的指令 (v3.4.0 增加)\r\n$ws.send({ type: 'evui', data: { id: 'ebcaa4ff', type: 'close' }})\r\n\r\n// * $ws.send 函数可临时用于服务器通过 websocket 向前端发送数据\r\n```\r\n\r\n效果：\r\n\r\n\r\n\r\n### $message - 给前端网页发送一条消息\r\n\r\n*消息传递基于 websocket*\r\n\r\n共有三种方法:\r\n- success 成功\r\n- error 错误\r\n- loading 加载中\r\n\r\nv3.4.2 增加方法\r\n- close 用于关掉网页消息体\r\n\r\n``` JS\r\n// 基础使用\r\n$message.success('一条来自脚本的消息')\r\n// $message 可接受任意个参数(v3.4.0)\r\n// 当最后一个参数为数字时，表示消息显示时间，单位：秒。\r\n// 最后参数为 object 且包含 secd/url/mid/align 等参数时:\r\n// - secd 消息显示时间，单位: 秒（默认: 消息长度/5 + 已有消息数*3 秒）。 0: 一直显示不关闭\r\n// - url 点击消息后跳转 url（当为 reload 或 refresh 时表示点击强制刷新当前网页 v3.5.2）\r\n// - mid 消息体的 id (v3.4.2 增加)\r\n// - align 消息文字对齐方式（v3.4.4 增加）。默认: center，可设置 left: 左对齐，right: 右对齐。其他值使用默认 center\r\n\r\n$message.error('some wrong is happen', 10)\r\n// 一条错误提醒消息，10 秒后自动关闭\r\n// 第二个参数如果是 0: 表示消息不自动关闭\r\n\r\n$message.loading('等待中...', 0)\r\n\r\n// 最后一个参数为 object 且传递 secd 和 url\r\n$message.success(23, '参数类型和数量不限', true, { hello: 'elecV2P' }, '点击消息\\n可打开 elecV2P Github 主页', { secd: 0, url: \"https://github.com/elecV2/elecV2P\" })\r\n\r\n// v3.4.2 增加关掉前端网页已弹出消息体的功能\r\n$message.loading('等待关闭中...\\n请点击消息右侧进行关闭', {\r\n secd: 0, // 0: 不主动关闭\r\n mid: 'auid', // mid 对应值随意填写\r\n align: 'left', // 文字左对齐\r\n})\r\n\r\n$message.close('auid') // 关掉 mid === 'auid' 的消息体\r\n$message.close() // 关掉所有已弹出的消息体\r\n```\r\n\r\n### $ws - 向前端发送临时数据\r\n\r\n一般用于需要异步或持续向前端发送数据的特殊情况。\r\n\r\n- $ws.send({ type, data }) 通过 websocket 向前端发送数据\r\n- $ws.sse(sseid, data) 通过 server-sent events 向前端发送数据(v3.7.2 添加)\r\n\r\n$ws.send 可使用的 type 类型已在前端定义，以后会整理开放。该方法仅在前端 webUI websocket 已连接的情况有效。通常用于 evui 界面通信中，参考脚本：https://raw.githubusercontent.com/elecV2/elecV2P-dei/master/examples/JSTEST/evui-chatroom.js\r\n\r\n$ws.sse 需要先在前端生成 new EventSource('/sse/elecV2P/' + sseid) 事件，然后可以在事件上自定义数据接收后的处理函数。通常用于 efh 脚本中，参考脚本：https://raw.githubusercontent.com/elecV2/elecV2P-dei/master/examples/JSTEST/efh/kuwo-music.efh （相关资料：[Using server-sent events - MDN](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)）\r\n\r\n**这两个函数发送的消息/数据，会同步发送到所有已连接的客户端**\r\n\r\n### $request/$response\r\n\r\n$request: 存在于通过 RULES/REWRITE/favend 触发的脚本中\r\n$response: 存在于通过 RULES/REWRITE 触发，并且修改时间段为数据返回前的脚本中\r\n\r\n*有 $request 不一定有 $response, 但有 $response 一定有 $request*\r\n\r\n- $request.url : 网络请求完整 URL\r\n- $request.headers