ee-bin 2.0.0-beta.2 → 4.0.0

package/tools/encrypt.js

@@ -0,0 +1,179 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const fsPro = require('fs-extra');
+const is = require('is-type-of');
+const bytenode = require('bytenode');
+const JavaScriptObfuscator = require('javascript-obfuscator');
+const globby = require('globby');
+const chalk = require('chalk');
+const { loadConfig } = require('../lib/utils');
+const { extend } = require('../lib/extend');
+
+const EncryptTypes = ['bytecode', 'confusion', 'strict'];
+
+class Encrypt {
+  constructor(options = {}) {
+    // cli args
+    const { config, out, target } = options;
+    this.basePath = process.cwd();
+    this.target = target;
+    
+    const conf = loadConfig(config).encrypt;
+    this.config = conf[target];
+    const outputFolder = out || this.config.encryptDir;
+    this.encryptDir = path.join(this.basePath, outputFolder);
+    this.filesExt = this.config.fileExt;
+    this.type = this.config.type;
+    this.bOpt = this.config.bytecodeOptions;
+    this.cOpt = this.config.confusionOptions;
+    this.cleanFiles = this.config.cleanFiles;
+    this.patterns = this.config.files || null;
+    this.specFiles = this.config.specificFiles;
+
+    this.codefiles = this._initCodeFiles();
+  }
+
+  /**
+   * 初始化需要加密的文件列表
+   */
+  _initCodeFiles() {
+    if (!this.patterns) return;
+
+    const files = globby.sync(this.patterns, { cwd: this.basePath });
+    return files;
+  }
+
+  /**
+   * 加密代码
+   */
+  encrypt() {
+    if (EncryptTypes.indexOf(this.type) == -1) return;
+    if (this.target == 'frontend' && (this.type == 'bytecode' || this.type == 'strict')) return;
+
+    console.log(chalk.blue('[ee-bin] [encrypt] ') + `start ciphering ${this.target}`);
+    for (const file of this.codefiles) {
+      const fullpath = path.join(this.encryptDir, file);
+      if (!fs.statSync(fullpath).isFile()) continue;
+
+      // 特殊文件处理
+      if (this.specFiles.includes(file)) {
+        this.generate(fullpath, 'confusion');
+        continue;
+      }
+
+      this.generate(fullpath);
+    } 
+    console.log(chalk.blue('[ee-bin] [encrypt] ') + 'end ciphering');
+  };
+
+  /**
+   * 递归
+   */
+  loop(dirPath) {
+    let files = [];
+    if (fs.existsSync(dirPath)) {
+      files = fs.readdirSync(dirPath);
+      files.forEach((file, index) => {
+        let curPath = dirPath + '/' + file;        
+        if (fs.statSync(curPath).isDirectory()) {
+          this.loop(curPath);
+        } else {
+          const extname = path.extname(curPath);
+          if (this.filesExt.indexOf(extname) !== -1) {
+            this.generate(curPath);
+          }
+        }
+      });
+    }
+  }
+
+  /**
+   * 生成文件
+   */  
+  generate(curPath, type) {
+    let encryptType = type ? type : this.type;
+
+    let tips = chalk.blue('[ee-bin] [encrypt] ') + 'file: ' + chalk.green(`${curPath}`) + ' ' + chalk.cyan(`(${encryptType})`);
+    console.log(tips);
+    if (encryptType == 'strict') {
+      this.generateJSConfuseFile(curPath);
+      this.generateBytecodeFile(curPath);
+    } else if (encryptType == 'bytecode') {
+      this.generateBytecodeFile(curPath);
+    } else if (encryptType == 'confusion') {
+      this.generateJSConfuseFile(curPath);
+    } else {
+      // none
+    }
+  }
+
+  /**
+   * 使用 javascript-obfuscator 生成压缩/混淆文件
+   */  
+  generateJSConfuseFile(file) {
+    let opt = Object.assign({
+      compact: true,
+      stringArray: true,
+      stringArrayThreshold: 1,
+    }, this.cOpt);
+    
+    let code = fs.readFileSync(file, "utf8");
+    let result = JavaScriptObfuscator.obfuscate(code, opt);
+    fs.writeFileSync(file, result.getObfuscatedCode(), "utf8"); 
+  }
+
+  /**
+   * 生成字节码文件
+   */
+  generateBytecodeFile(curPath) {
+    if (path.extname(curPath) !== '.js') {
+      return
+    }
+    //let jscFile = curPath.replace(/.js/g, '.jsc');
+    let jscFile = curPath + 'c';
+    let opt = Object.assign({
+      filename: curPath,
+      output: jscFile,
+      electron: true
+    }, this.bOpt);
+
+    bytenode.compileFile(opt);
+	  fsPro.removeSync(curPath);
+  }
+}
+
+function encrypt(options = {}) {
+  const electronOpt = extend(true, {
+    target: 'electron',
+  }, options);
+  const electronEpt = new Encrypt(electronOpt);
+  electronEpt.encrypt();
+
+  const frontendOpt = extend(true, {
+    target: 'frontend',
+  }, options);
+  const frontendEpt = new Encrypt(frontendOpt);
+  frontendEpt.encrypt();
+}
+
+function cleanEncrypt(options = {}) {
+  // [todo] 删除前端和主进程代码
+  return;
+  let files = options.dir !== undefined ? options.dir : ['./public/electron'];
+  files = is.string(files) ? [files] : files;
+
+  files.forEach((file) => {
+    const tmpFile = path.join(process.cwd(), file);
+    if (fs.existsSync(tmpFile)) {
+      fsPro.removeSync(tmpFile);
+      console.log(chalk.blue('[ee-bin] [encrypt] ') + 'clean up tmp files: ' + chalk.magenta(`${tmpFile}`));
+    }
+  })
+}
+
+module.exports = {
+  encrypt,
+  cleanEncrypt,
+};

package/tools/{incrUpdater.cjs → incrUpdater.js}

@@ -4,7 +4,7 @@ const path = require('path');
 const fs = require('fs');
 const crypto = require('crypto')
 const chalk = require('chalk');
-const Utils = require('../lib/utils.cjs');
+const { loadConfig, rm, getPackage, writeJsonSync } = require('../lib/utils');
 const admZip = require('adm-zip')
 
 /**
@@ -12,15 +12,15 @@ const admZip = require('adm-zip')
  * @class
  */
 
-module.exports = {
-  
+class IncrUpdater {
+
   /**
    * 执行
    */  
   run(options = {}) {
     console.log('[ee-bin] [updater] Start');
     const { config, asarFile, platform } = options;
-    const binCfg = Utils.loadConfig(config);
+    const binCfg = loadConfig(config);
     const cfg = binCfg.updater;
 
     if (!cfg) {
@@ -28,20 +28,21 @@ module.exports = {
       return;
     }
 
-    if (platform) {
-      this.generateFile(cfg, asarFile, platform);
-    } else {
-      this.generateFileOld(cfg, asarFile);
-    }
+    this.generateFile(cfg, asarFile, platform);
 
     console.log('[ee-bin] [updater] End');
-  },
+  }
 
   /**
    * 生成增量升级文件
    */ 
   generateFile(config, asarFile, platform) {
     const cfg = config[platform];
+    if (!cfg) {
+      console.log(chalk.blue('[ee-bin] [updater] ') + chalk.red(`Error: ${platform} config does not exist`));
+      return;
+    }
+
     let latestVersionInfo = {}
     const homeDir = process.cwd();
     console.log(chalk.blue('[ee-bin] [updater] ') + chalk.green(`${platform} config:`), cfg);
@@ -66,7 +67,7 @@ module.exports = {
       return;
     }
 
-    const packageJson = Utils.getPackage();
+    const packageJson = getPackage();
     const version = packageJson.version;
     let platformForFilename = platform;
     if (platform.indexOf("_") !== -1) {
@@ -79,7 +80,7 @@ module.exports = {
     zipName = path.basename(cfg.output.zip, '.zip') + `-${platformForFilename}-${version}.zip`;
     const asarZipPath = path.join(homeDir, cfg.output.directory, zipName);
     if (fs.existsSync(asarZipPath)) {
-      Utils.rm(asarZipPath);
+      rm(asarZipPath);
     }
     const zip = new admZip();
     // 添加 asar 文件
@@ -114,107 +115,17 @@ module.exports = {
     const jsonName = path.basename(cfg.output.file, '.json') + `-${platformForFilename}.json`;
     latestVersionInfo = item;
     const updaterJsonFilePath = path.join(homeDir, cfg.output.directory, jsonName);
-    Utils.writeJsonSync(updaterJsonFilePath, latestVersionInfo);
+    writeJsonSync(updaterJsonFilePath, latestVersionInfo);
 
     // 删除缓存文件，防止生成的 zip 是旧版本
     if (cfg.cleanCache) {
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'mac'));
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'mac-arm64'));
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'win-unpacked'));
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'win-ia32-unpacked'));
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'linux-unpacked'));
+      rm(path.join(homeDir, cfg.output.directory, 'mac'));
+      rm(path.join(homeDir, cfg.output.directory, 'mac-arm64'));
+      rm(path.join(homeDir, cfg.output.directory, 'win-unpacked'));
+      rm(path.join(homeDir, cfg.output.directory, 'win-ia32-unpacked'));
+      rm(path.join(homeDir, cfg.output.directory, 'linux-unpacked'));
     }  
-  },
-
-  /**
-   * 将废弃
-   */ 
-  generateFileOld(cfg, asarFile) {
-    var latestVersionInfo = {}
-    const homeDir = process.cwd();
-    console.log(chalk.blue('[ee-bin] [updater] ') + chalk.green('config:'), cfg);
-
-    let asarFilePath = "";
-    if (asarFile) {
-      asarFilePath = path.normalize(path.join(homeDir, asarFile));
-    } else if (Array.isArray(cfg.asarFile)) {  
-      // 检查文件列表，如果存在就跳出
-      for (const filep of cfg.asarFile) {
-        asarFilePath = path.normalize(path.join(homeDir, filep));
-        if (fs.existsSync(asarFilePath)) {
-          break;
-        }
-      }
-    } else {
-      asarFilePath = path.normalize(path.join(homeDir, cfg.asarFile));
-    }
-
-    if (!fs.existsSync(asarFilePath)) {
-      console.log(chalk.blue('[ee-bin] [updater] ') + chalk.red(`Error: ${asarFilePath} does not exist`));
-      return;
-    }
-
-    const packageJson = Utils.getPackage();
-    const version = packageJson.version;
-    const platformForFilename = Utils.getPlatform("-");
-    const platformForKey = Utils.getPlatform("_");
-
-    // 生成 zip
-    let zipName = "";
-    if (cfg.output.noPlatform === true) {
-      zipName = path.basename(cfg.output.zip, '.zip') + `-${version}.zip`;
-    } else {
-      zipName = path.basename(cfg.output.zip, '.zip') + `-${platformForFilename}-${version}.zip`;
-    }
-    
-    const asarZipPath = path.join(homeDir, cfg.output.directory, zipName);
-    if (fs.existsSync(asarZipPath) && cfg.cleanCache) {
-      Utils.rm(asarZipPath);
-    }
-    const zip = new admZip();
-    zip.addLocalFile(asarFilePath); 
-    zip.writeZip(asarZipPath, (err) => {
-      if (err) {
-        console.log(chalk.blue('[ee-bin] [updater] create zip ') + chalk.red(`Error: ${err}`));
-      }
-    });
-
-    const sha1 = this.generateSha1(asarFilePath);
-    const date = this._getFormattedDate();
-    const fileStat = fs.statSync(asarFilePath);
-
-    const item = {
-      version: version,
-      file: zipName,
-      size: fileStat.size,
-      sha1: sha1,
-      releaseDate: date,
-    };
-    let jsonName = "";
-    if (cfg.output.noPlatform === true) {
-      jsonName = cfg.output.file;
-      latestVersionInfo = item;
-    } else {
-      // 生成与系统有关的文件
-      jsonName = path.basename(cfg.output.file, '.json') + `-${platformForFilename}.json`;
-      if (platformForKey !== "") {
-        latestVersionInfo[platformForKey] = item;
-      } else {
-        console.log(chalk.blue('[ee-bin] [updater] ') + chalk.red(`Error: ${platformForFilename} is not supported`));
-      }
-    }
-
-    const updaterJsonFilePath = path.join(homeDir, cfg.output.directory, jsonName);
-    Utils.writeJsonSync(updaterJsonFilePath, latestVersionInfo);
-
-    // 删除缓存文件，防止生成的 zip 是旧版本
-    if (cfg.cleanCache) {
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'mac'));
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'mac-arm64'));
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'win-unpacked'));
-      Utils.rm(path.join(homeDir, cfg.output.directory, 'linux-unpacked'));
-    }  
-  },
+  }
   
   generateSha1(filepath = "") {
     let sha1 = '';
@@ -239,7 +150,7 @@ module.exports = {
       console.log(chalk.blue('[ee-bin] [updater] ') + chalk.red(`Error: ${error}`));
     }
     return sha1;
-  },
+  }
 
   _getFormattedDate() {
     const date = new Date(); // 获取当前日期
@@ -248,5 +159,10 @@ module.exports = {
     const day = date.getDate().toString().padStart(2, '0'); // 获取日
   
     return `${year}-${month}-${day}`; 
-  }
+  }  
+}
+
+module.exports = {
+  IncrUpdater,
+  incrUpdater: new IncrUpdater()
 }

package/tools/move.js

@@ -0,0 +1,69 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const fsPro = require('fs-extra');
+const chalk = require('chalk');
+const { loadConfig, rm } = require('../lib/utils');
+
+const homeDir = process.cwd();
+
+// 移动资源
+function move(options = {}) {
+  console.log('[ee-bin] [move] Start moving resources');
+  const { config, flag } = options;
+  const binCfg = loadConfig(config);
+  const moveConfig = binCfg.move;
+  
+  let flags;
+  const flagString = flag.trim();
+  if (flagString.indexOf(',') !== -1) {
+    flags = flagString.split(',');
+  } else {
+    flags = [flagString];
+  }
+
+  for (let i = 0; i < flags.length; i++) {
+    let f = flags[i];
+    let cfg = moveConfig[f];
+
+    if (!cfg) {
+      console.log(chalk.blue('[ee-bin] [move] ') + chalk.red(`Error: ${f} config does not exist` ));
+      return;
+    }
+
+    const { src, dest, dist, target } = cfg;
+    const source = dist ? dist : src;
+    const destination = target ? target : dest;
+
+    console.log(chalk.blue('[ee-bin] [move] ') + chalk.green(`Move flag: ${f}`));
+    console.log(chalk.blue('[ee-bin] [move] ') + chalk.green('config:'), cfg);
+
+    const srcResource = path.join(homeDir, source);
+    if (!fs.existsSync(srcResource)) {
+      const errorTips = chalk.bgRed('Error') + ` ${source} resource does not exist !`;
+      console.error(errorTips);
+      return
+    }
+
+    // clear the historical resource and copy it to the ee resource directory
+    const destResource = path.join(homeDir, destination);
+    if (fs.statSync(srcResource).isDirectory() && !fs.existsSync(destResource)) {
+      fs.mkdirSync(destResource, {recursive: true, mode: 0o777});
+    } else {
+      rm(destResource);
+      console.log('[ee-bin] [move] Clear history resources:', destResource);
+    }
+
+    fsPro.copySync(srcResource, destResource);
+
+    // [todo] go project, special treatment of package.json, reserved only necessary
+    console.log(`[ee-bin] [move] Copy ${srcResource} to ${destResource}`);
+  }
+
+  console.log('[ee-bin] [move] End');
+}
+
+module.exports = {
+  move
+}

package/tools/serve.js

@@ -0,0 +1,240 @@
+'use strict';
+
+const debug = require('debug')('ee-bin:serve');
+const path = require('path');
+const fsPro = require('fs-extra');
+const { loadConfig } = require('../lib/utils');
+const is = require('is-type-of');
+const chalk = require('chalk');
+const crossSpawn = require('cross-spawn');
+const { buildSync } = require('esbuild');
+const chokidar = require('chokidar');
+
+class ServeProcess {
+
+  constructor() {
+    process.env.NODE_ENV = 'prod'; // dev / prod
+    this.execProcess = {};
+    this.electronDir = './electron';
+    this.defaultBundleDir = './public/electron';
+  }
+
+  /**
+   * 启动前端、主进程服务
+   */
+  dev(options = {}) {
+    // 设置一个环境变量
+    process.env.NODE_ENV = 'dev';
+    const { config, serve } = options;
+    const binCfg = loadConfig(config);
+    const binCmd = 'dev';
+    const binCmdConfig = binCfg[binCmd];
+
+    let command = serve;
+    if (!command) {
+      command = Object.keys(binCmdConfig).join();
+    }
+    const opt = {
+      binCmd,
+      binCmdConfig,
+      command,
+    }
+
+    // build electron main code 
+    const cmds = this._formatCmds(command);
+    if (cmds.indexOf("electron") !== -1) {
+      // watche electron main code
+      const electronConfig = binCmdConfig.electron;
+      if (electronConfig.watch) {
+        const cmd = 'electron';
+        const watcher = chokidar.watch([this.electronDir], {
+          persistent: true
+        });
+        watcher.on('change', async (f) => {
+          console.log(chalk.blue('[ee-bin] [dev] ') + `File ${f} has been changed`);
+          console.log(chalk.blue('[ee-bin] [dev] ') + `Restart ${cmd}`);
+
+          // rebuild code
+          this.bundle(binCfg.build.electron);
+          let subPorcess = this.execProcess[cmd];
+          subPorcess.kill();
+          delete this.execProcess[cmd];
+  
+          // restart electron command
+          let onlyElectronOpt = {
+            binCmd,
+            binCmdConfig,
+            command: cmd,
+          }
+          this.multiExec(onlyElectronOpt);
+        });
+      }
+
+      // When starting for the first time, build the code for the electron directory
+      this.bundle(binCfg.build.electron);
+    }
+
+    this.multiExec(opt);
+  }
+
+  /**
+   * 启动主进程服务
+   */
+  start(options = {}) {
+    const { config } = options;
+    const binCfg = loadConfig(config);
+    const binCmd = 'start';
+    const binCmdConfig = {
+      start: binCfg[binCmd]
+    };
+
+    const opt = {
+      binCmd,
+      binCmdConfig,
+      command: binCmd,
+    }
+    this.multiExec(opt);
+  }
+
+  sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+  }
+
+  /**
+   * 构建
+   */
+  build(options = {}) {
+    const { config, cmds, env } = options;
+    process.env.NODE_ENV = env;
+    const binCfg = loadConfig(config);
+    const binCmd = 'build';
+    const binCmdConfig = binCfg[binCmd];
+
+    if (!cmds || cmds == "") {
+      const tip = chalk.bgYellow('Warning') + ' Please modify the ' + chalk.blue('build') + ' property in the bin file';
+      console.log(tip);
+      return
+    }
+
+    if (cmds.indexOf("electron") !== -1) {
+      this.bundle(binCmdConfig.electron);
+      return;
+    }
+
+    const opt = {
+      binCmd,
+      binCmdConfig,
+      command: cmds,
+    }
+    this.multiExec(opt);
+  }
+
+  /**
+   * 执行自定义命令
+   */
+  exec(options = {}) {
+    const { config, cmds } = options;
+    const binCfg = loadConfig(config);
+    const binCmd = 'exec';
+    const binCmdConfig = binCfg[binCmd];
+
+    const opt = {
+      binCmd,
+      binCmdConfig,
+      command: cmds,
+    }
+    this.multiExec(opt);
+  }
+
+  /**
+   * 支持多个命令
+   */
+  multiExec(opt = {}) {
+    //console.log('multiExec opt:', opt)
+    const { binCmd, binCmdConfig, command } = opt;
+    const cmds = this._formatCmds(command);
+
+    for (let i = 0; i < cmds.length; i++) {
+      let cmd = cmds[i];
+      const cfg = binCmdConfig[cmd];
+
+      if (!cfg) {
+        console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.red(`Error: [${binCmd} ${cmd}] config does not exist` ));
+        continue;
+      }
+
+      // frontend 如果是 file:// 协议，则不启动
+      if (binCmd == 'dev' && cmd == 'frontend' && cfg.protocol == 'file://') {
+        continue;
+      }
+
+      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + "Run " + chalk.green(`[${binCmd} ${cmd}]` + " command"));
+      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.green('config:'), JSON.stringify(cfg));
+
+      const execDir = path.join(process.cwd(), cfg.directory);
+      const execArgs = is.string(cfg.args) ? [cfg.args] : cfg.args;
+      const stdio = cfg.stdio ? cfg.stdio: 'inherit';
+
+      const handler = cfg.sync ? crossSpawn.sync : crossSpawn;
+
+      this.execProcess[cmd] = handler(
+        cfg.cmd,
+        execArgs,
+        { stdio: stdio, cwd: execDir, maxBuffer: 1024 * 1024 * 1024 },
+      );
+      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + 'The ' + chalk.green(`[${binCmd} ${cmd}]`) + ` command is ${cfg.sync ? 'run completed' : 'running'}`);
+
+      if(!cfg.sync) {
+        this.execProcess[cmd].on('exit', () => {
+          if (cmd == 'electron') {
+            console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.green('Press "CTRL+C" to exit'));
+            return
+          }
+          console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + 'The ' + chalk.green(`[${binCmd} ${cmd}]`) + ' command has been executed and exited');
+        });
+      }
+    }
+  } 
+  
+  // esbuild
+  bundle(bundleConfig) {
+    const { bundleType } = bundleConfig;
+    if (bundleType == 'copy') {
+      const srcResource = path.join(process.cwd(), this.electronDir);
+      const destResource = path.join(process.cwd(), this.defaultBundleDir);
+      fsPro.removeSync(destResource);
+      fsPro.copySync(srcResource, destResource);
+    } else {
+      const esbuildOptions = bundleConfig[bundleConfig.type];
+      // todo 不压缩
+      // if (this.isDev()) {
+      //   esbuildOptions.minify = false;
+      // }
+      debug('esbuild options:%O', esbuildOptions);
+      buildSync(esbuildOptions);
+    }
+  }
+
+  // format commands
+  _formatCmds(command) {
+    let cmds;
+    const cmdString = command.trim();
+    if (cmdString.indexOf(',') !== -1) {
+      cmds = cmdString.split(',');
+    } else {
+      cmds = [cmdString];
+    }
+
+    return cmds;
+  }
+  
+  // env
+  isDev() {
+    return process.env.NODE_ENV === 'dev';
+  }
+}
+
+module.exports = {
+  ServeProcess,
+  serveProcess: new ServeProcess()
+}