node-automator 1.0.0

package/commands/which.js

@@ -0,0 +1,60 @@
+const { BaseCommand } = require("./base");
+const { exec_shell } = require('../utils/shell_tool');
+const { get_fst_file } = require("../utils/file_tool");
+const path = require("path");
+const fs = require("fs");
+const { warn } = require("../utils/log_tool");
+
+class WhichCommand extends BaseCommand {
+    async execute() {
+        let cmd;
+        switch (process.platform) {
+            case "win32": {
+                cmd = "where";
+                break;
+            }
+            default: {
+                cmd = "which";
+                break;
+            }
+        }
+
+        let file;
+        let stdout = await exec_shell({
+            cmd: `${cmd} ${this.selfData.target}`,
+            capture_stdout: true,
+            ignore_code: true,
+        });
+        if (stdout) {
+            /** @type {string[]} */
+            let files = stdout.split(/[\r\n]{1,2}/);
+            files = files.filter(v => v && v.trim());
+            // windows系统下，优先选择有 .cmd 或者 .exe
+            if (process.platform === "win32") { 
+                let preferExts = ['.exe', '.cmd'];
+                files.sort((a, b) => {
+                    let exta = path.extname(a);
+                    let extb = path.extname(b);
+                    if (preferExts.includes(exta)) {
+                        return -1;
+                    } else if (preferExts.includes(extb)) {
+                        return 1;
+                    }
+                    return 0;
+                });
+            }
+            file = get_fst_file(files);
+            if (file) {
+                file = fs.realpathSync(file);
+            }
+        }
+        if (!file) {
+            warn(`未找到 ${this.selfData.target}`);
+        }
+        return file;
+    }
+}
+
+module.exports = {
+    WhichCommand,
+};

package/commands/write_cache.js

@@ -0,0 +1,16 @@
+const { getCache, setCache } = require("../utils/cache_tool");
+const { BaseCommand } = require("./base");
+
+class WriteCacheCommand extends BaseCommand {
+    async execute() {
+        await setCache(this.selfData.cache_key, this.content, this.selfData.cache_type, this.selfData.cache_param);
+    }
+
+    getRequireContent() {
+        return true;
+    }
+}
+
+module.exports = {
+    WriteCacheCommand,
+};

package/commands/write_cfg.js

@@ -0,0 +1,18 @@
+const { write_with_type } = require("../utils/file_tool");
+const { BaseCommand } = require("./base");
+
+class WriteCfgCommand extends BaseCommand {
+    async execute() {
+        let data = this.selfData;
+        let content = this.content;
+        await write_with_type(content, data.dst, data.type, data.options);
+    }
+
+    getRequireContent() {
+        return true;
+    }
+}
+
+module.exports = {
+    WriteCfgCommand,
+};

package/commands/write_clipboard.js

@@ -0,0 +1,23 @@
+const clipboardy = require('clipboardy');
+const { warn } = require('../utils/log_tool');
+const { BaseCommand } = require('./base');
+
+class WriteClipboard extends BaseCommand {
+    async execute() {
+        let data = this.selfData;
+        let content = typeof this.content === "string" ? this.content : JSON.stringify(this.content);
+        try {
+            clipboardy.writeSync(content);
+        } catch (error) {
+            warn('写入剪切板失败');
+        }
+    }
+
+    getRequireContent() {
+        return true;
+    }
+}
+
+module.exports = {
+    WriteClipboard,
+};

package/commands/write_excel.js

@@ -0,0 +1,17 @@
+const { get_fst_file, get_full_path } = require("../utils/file_tool");
+const { BaseCommand } = require("./base");
+
+class WriteExcelCommand extends BaseCommand {
+    async execute() {
+        let dst = get_full_path(this.selfData.dst);
+        /**
+         * @type {Excel.Workbook}
+         */
+        let workbook = this.selfData.content;
+        await workbook.xlsx.writeFile(dst);
+    }
+}
+
+module.exports = {
+    WriteExcelCommand,
+};

package/commands/write_plain.js

@@ -0,0 +1,18 @@
+const { write_plain } = require("../utils/file_tool");
+const { BaseCommand } = require("./base");
+
+class WritePlainCommand extends BaseCommand {
+    async execute() {
+        let data = this.selfData;
+        let content = this.content;
+        write_plain(data.dst, content, data.options);
+    }
+
+    getRequireContent() {
+        return true;
+    }
+}
+
+module.exports = {
+    WritePlainCommand,
+};

package/commands/zip.js

@@ -0,0 +1,78 @@
+const { BaseCommand } = require("./base");
+const path = require("path");
+const { get_file_list, get_fst_file, get_full_path, processRename } = require("../utils/file_tool");
+const fs = require("fs");
+const { progress } = require("../utils/display_tool");
+const { Alignment, alignStr } = require("../utils/transform_tool");
+const { clearLine } = require("../utils/interaction_tool");
+const { info } = require("../utils/log_tool");
+
+class ZipCommand extends BaseCommand {
+    async execute() {
+        const AdmZip = require("adm-zip");
+        let data = this.selfData;
+        let files = get_file_list(data.src, undefined, true);
+        let base = data.base;
+        if (base) {
+            base = get_fst_file(base);
+        }
+        // creating archives
+        var zip = new AdmZip();
+        
+        // add file directly
+        // var content = "inner content of the file";
+        // zip.addFile("test.txt", Buffer.alloc(content.length, content), "entry comment goes here");
+        // get everything as a buffer
+        // var willSendthis = zip.toBuffer();
+        // add local file
+        for (let index = 0; index < files.length; index++) {
+            let file = files[index];
+            let zipPath = base ? path.relative(base, path.dirname(file)) : "";
+            if (data.base_range) {
+                let zipPathParts = zipPath.split("\\").slice(...data.base_range);
+                zipPath = path.join(...zipPathParts);
+            }
+            let entryName = path.join(zipPath, path.basename(file));
+            entryName = processRename(entryName, data.options && data.options.rename);
+            let show_src = entryName;
+            progress(index, files.length, {
+                desc: `Add ${show_src}`,
+                depth: 0,
+                align: true,
+            });
+            // zip.addLocalFile(file, zipPath);
+            zip.addFile(entryName, fs.readFileSync(file));
+        }
+        clearLine();
+        progress(files.length, files.length, {
+            desc: `压缩中...`,
+            depth: 0,
+            align: true,
+        });
+        // or write everything to disk
+        if (data.dst) {
+            let dst = get_full_path(data.dst);
+            await new Promise(resolve => {
+                zip.writeZip(dst, (err) => {
+                    if (err) {
+                        throw (err);
+                    }
+                    resolve();
+                });
+            });
+        } else {
+            let buffer = zip.toBuffer();
+            return buffer;
+        }
+        progress(files.length, files.length, {
+            desc: `压缩完成!`,
+            depth: 0,
+            color: 'green',
+        });
+        info("");
+    }
+}
+
+module.exports = {
+    ZipCommand,
+};

package/commands/zip_data.js

@@ -0,0 +1,64 @@
+const { BaseCommand } = require("./base");
+const path = require("path");
+const { get_file_list, get_fst_file, get_full_path, processRename } = require("../utils/file_tool");
+const fs = require("fs");
+const { progress } = require("../utils/display_tool");
+const { Alignment, alignStr } = require("../utils/transform_tool");
+const { clearLine } = require("../utils/interaction_tool");
+const { info } = require("../utils/log_tool");
+
+class ZipDataCommand extends BaseCommand {
+    async execute() {
+        const AdmZip = require("adm-zip");
+        let data = this.selfData;
+        /** @type { {path: string, content: string | Buffer}[] } */
+        let entries = this.selfData.entries;
+        // creating archives
+        var zip = new AdmZip();
+        
+        for (let index = 0; index < entries.length; index++) {
+            let entry = entries[index];
+            let entryName = entry.path;
+            entryName = processRename(entryName, data.options && data.options.rename);
+            let show_src = entryName;
+            progress(index, entries.length, {
+                desc: `Add ${show_src}`,
+                depth: 0,
+                align: true,
+            });
+            // zip.addLocalFile(file, zipPath);
+            zip.addFile(entryName, entry.content);
+        }
+        clearLine();
+        progress(entries.length, entries.length, {
+            desc: `压缩中...`,
+            depth: 0,
+            align: true,
+        });
+        // or write everything to disk
+        if (data.dst) {
+            let dst = get_full_path(data.dst);
+            await new Promise(resolve => {
+                zip.writeZip(dst, (err) => {
+                    if (err) {
+                        throw (err);
+                    }
+                    resolve();
+                });
+            });
+        } else {
+            let buffer = zip.toBuffer();
+            return buffer;
+        }
+        progress(entries.length, entries.length, {
+            desc: `压缩完成!`,
+            depth: 0,
+            color: 'green',
+        });
+        info("");
+    }
+}
+
+module.exports = {
+    ZipDataCommand,
+};

package/examples/print_env.yml

@@ -0,0 +1,3 @@
+- type: print
+  data:
+    key: ENV.USERNAME

package/index.js

@@ -0,0 +1,109 @@
+// 控制台文本颜色
+const path = require("path");
+require("colors");
+const {
+    argv,
+} = require('yargs');
+require('dotenv').config({
+    path: argv.dotenv || path.resolve(process.cwd(), '.env'),
+    override: true,
+});
+
+// 禁用其他打印
+console.log = () => {};
+console.warn = () => {};
+console.info = () => {};
+console.error = () => {};
+
+const mgr = require("./commands/mgr");
+const {
+    getLastError,
+    info,
+    setLogLevel,
+    LogLevel,
+    success,
+    error,
+    getLastErrorCode,
+    error2,
+} = require("./utils/log_tool");
+const {
+    showAlert,
+    showNotify
+} = require("./utils/alert_tool");
+const {
+    parse
+} = require("./utils/parse_tool");
+const {
+    shareData
+} = require("./commands/share_data");
+const { decode } = require('./utils/base64_tool');
+
+process.on('exit', (code) => {
+    if (!code) {
+        success(`>>> 任务结束 <<<`);
+    } else {
+        error(`>>> 任务异常结束 #${code} <<<`);
+    }
+});
+
+setLogLevel(argv.LOG_LEVEL || LogLevel.INFO);
+mgr.init();
+
+/** @return {Promise<string>} */
+async function getCfgs() {
+    let cfgs = argv._[0];
+    if (cfgs) return cfgs;
+    return new Promise((resolve) => {
+        process.stdin.on("data", data => {
+            // 标准输入模式,启用全自动
+            shareData.FULL_AUTOMATIC = 1;
+            resolve(data.toString().trim());
+        });
+    });
+}
+async function MainProcess() {
+    let lastError = null;
+    const cfgs = await getCfgs();
+    try {
+        if (cfgs.indexOf(".") != -1) {
+            await mgr.exec([{
+                type: "exec_from_file",
+                data: {
+                    src: cfgs
+                }
+            }], 0, false);
+        } else {
+            await mgr.exec(await parse(decode(cfgs), 'yaml'), 0);
+        }
+        lastError = getLastError();
+        lastError = lastError && lastError.message || lastError;
+    } catch (err) {
+        lastError = err.message || err;
+    }
+    let code = lastError ? (getLastErrorCode() || 1) : 0;
+    let extname = path.extname(argv.$0);
+    let hasError = code != 0;
+    info("");
+    if (hasError) {
+        error2(lastError);
+    }
+    if (shareData.VERBOSE) {
+        // 非代码启动，需要暂停
+        if (extname != ".js") {
+            let title = `${shareData.TITLE || "任务即将结束"}`;
+            await showAlert(hasError ? "error" : "info", hasError ? `✖ 失败, ${lastError}` : "✔ 成功!", title);
+        } else {
+            await showNotify({
+                title: `${shareData.TITLE || cfgs}`,
+                message: hasError ? lastError : `任务即将结束`,
+                icon: shareData.AUTOMATOR_ROOT + (hasError ? "/assets/error.png" : "/assets/success.png"),
+            });
+        }
+    }
+    // 手动调用 exit, 会导致异步的定时器事件失效
+    // process.exit(code);
+    process.exitCode = code;
+}
+
+
+MainProcess();

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "node-automator",
+  "version": "1.0.0",
+  "description": "Execute automation with yaml configuration(compatible with json)",
+  "main": "index.js",
+  "repository": {
+    "url": "https://gitee.com/TsubasaYeung/node-automator.git",
+    "type": "git"
+  },
+  "scripts": {
+    "test": "node . ./examples/print_env.yml"
+  },
+  "keywords": [
+    "node-automator"
+  ],
+  "author": "TsubasaYeung",
+  "license": "ISC",
+  "dependencies": {
+    "adm-zip": "^0.5.1",
+    "await-event-emitter": "^2.0.2",
+    "change-case": "^4.1.2",
+    "chardet": "^1.3.0",
+    "cheerio": "^1.0.0-rc.12",
+    "clipboardy": "^2.3.0",
+    "colors": "^1.4.0",
+    "cos-nodejs-sdk-v5": "^2.11.6",
+    "dotenv": "^16.1.4",
+    "emailjs": "^4.0.2",
+    "exceljs": "^4.3.0",
+    "ftp": "^0.3.10",
+    "glob": "^7.1.6",
+    "html-to-text": "^8.2.0",
+    "iconv-lite": "^0.6.2",
+    "image-size": "^1.0.0",
+    "jimp": "^0.22.10",
+    "json-stable-stringify": "^1.0.1",
+    "jwt-js": "^0.5.0",
+    "keypress": "^0.2.1",
+    "log4js": "^6.3.0",
+    "luaparse": "^0.3.1",
+    "mail-watcher": "^0.6.1",
+    "markdown-table": "^2.0.0",
+    "mysql": "^2.18.1",
+    "node-localstorage": "^2.1.6",
+    "node-notifier": "^9.0.1",
+    "open": "^7.3.1",
+    "parse-markdown-table": "^0.0.4",
+    "persist-path": "^1.0.2",
+    "request": "^2.88.2",
+    "request-progress": "^3.0.0",
+    "spreadsheet-column": "^1.1.1",
+    "strip-json-comments": "^3.1.1",
+    "temp": "^0.9.4",
+    "typescript-plus": "^3.1.5",
+    "websocket": "^1.0.34",
+    "xlsx": "^0.17.0",
+    "xml-js": "^1.6.11",
+    "xmldom": "^0.4.0",
+    "yaml": "^1.10.0",
+    "yamljs": "^0.3.0",
+    "yargs": "^16.2.0"
+  }
+}

package/utils/alert_tool.js

@@ -0,0 +1,133 @@
+const {
+    shareData
+} = require('../commands/share_data');
+const {
+    copy,
+    get_fst_file,
+    write_plain
+} = require('./file_tool');
+const {
+    warn
+} = require('./log_tool');
+const {
+    exec_shell
+} = require('./shell_tool');
+const notifier = require('node-notifier');
+
+/**
+ * 
+ * @param { "error" | "info" | "warning" | ""} type
+ * @param {string} message
+ * @param {string} title
+ * @returns {boolean} 是否点击OK
+ */
+async function showAlert(type = "info", message, title = "提示") {
+    let os_name = process.platform;
+    let str = message;
+    let cmd = [];
+    let cwd = shareData.AUTOMATOR_ROOT;
+    if (os_name == 'linux') {
+        str = str.replace(/[<>]/g, '');
+        cmd.push('zenity');
+        cmd.push('--' + type);
+        cmd.push('--text') && cmd.push(str);
+        cmd.push('--title') && cmd.push(title);
+        if (str.length > 30) cmd.push('--width') && cmd.push('300');
+        // return codes in macOS are exactly as in Linux
+        // 0 for 'OK', 1 for 'Cancel'
+    } else if (os_name == 'darwin') {
+
+        switch (type) { // Set dialog icon
+            case 'error':
+                type = 0;
+                break;
+            case 'info':
+                type = 1;
+                break;
+            case 'warning':
+                type = 2;
+                break;
+            default:
+                type = '';
+        }
+
+        str = str.replace(/"/g, "'"); // double quotes to single quotes
+        cmd.push('osascript') && cmd.push('-e');
+        var script = 'tell app \"System Events\" to display dialog ';
+        script += '\"' + str + '\" with title \"' + title + '\" buttons \"OK\"';
+        script += ' with icon ' + type;
+        cmd.push(script);
+
+    } else { // windows
+
+        // return codes for Windows (default value minus 1)
+        // defaults in https://www.tutorialspoint.com/vbscript/vbscript_dialog_boxes.htm
+
+        // 0 - vbOK
+        // 1 - vbCancel
+        // 2 - vbAbort
+        // 3 - vbRetry
+        // 4 - vbIgnore
+        // 5 - vbYes
+        // 6 - vbNo
+
+        switch (type) { // Set MsgBox icon
+            case 'error':
+                type = 16;
+                break;
+            case 'info':
+                type = 64;
+                break;
+            case 'warning':
+                type = 48;
+                break;
+            default:
+                type = 0;
+        }
+
+        str = str.replace(/"/g, "'"); // double quotes to single quotes
+
+        // msgbox.vbs script from http://stackoverflow.com/questions/774175
+        cmd.push('cscript');
+
+        let vbs_file = `${shareData.AUTOMATOR_ROOT}/scripts/msgbox.vbs`;
+        let exist = get_fst_file(vbs_file);
+        if (!exist) {
+            // 本地不存在脚本需要生成
+            write_plain(vbs_file, `Set objArgs = WScript.Arguments
+messageText = objArgs(0)
+messageType = objArgs(1)
+messageTitle = objArgs(2)
+retValue = MsgBox(messageText, messageType, messageTitle)
+WScript.Quit (retValue - 1)`);
+        }
+        cmd.push(vbs_file);
+        cmd.push(str) && cmd.push(type) && cmd.push(title);
+
+    }
+    let ret = await exec_shell({
+        cmd: cmd,
+        cwd: cwd,
+        capture_stdout: true,
+    });
+    return ret;
+}
+
+async function showNotify(data) {
+    let options = Object.assign({
+        title: "",
+        message: "<空>",
+        // actions: ["OK"],
+    }, data);
+    let ret = await new Promise(resolve => {
+        notifier.notify(options, (err, resp, meta) => {
+            resolve(meta.button);
+        });
+    });
+    return ret;
+}
+
+module.exports = {
+    showAlert,
+    showNotify,
+};

package/utils/base64_tool.js

@@ -0,0 +1,13 @@
+function decode(input) {
+    return decodeURIComponent(escape(atob(input)))
+}
+
+function encode(input) {
+    return btoa(unescape(encodeURIComponent(input)))
+}
+
+
+module.exports = {
+    decode,
+    encode,
+};