ee-core 1.0.0

package/lib/application.js

@@ -0,0 +1,69 @@
+const {app} = require('electron');
+const path = require('path');
+const EeApp = require('./eeApp');
+const debug = require('debug')('ee-core:Appliaction');
+
+class Appliaction extends EeApp {
+  constructor() {
+
+    // 初始化环境变量
+    // const opt = this.initEnv();
+    const { env } = process;
+
+    let options = {
+      env: 'prod',
+      serverScope: '',
+      type: 'application',
+      baseDir: path.join(app.getAppPath(), 'electron'),
+      homeDir: process.cwd(),
+      framework: path.join(process.cwd(), 'node_modules/ee-core'),
+      appName: app.getName(),
+      userHome: app.getPath('home'),
+      appData: app.getPath('appData'),
+      appUserData: app.getPath('userData'),
+      logsDir: app.getPath('logs'),
+      appVersion: app.getVersion()
+    }
+
+    // argv
+    for (let i = 0; i < process.argv.length; i++) {
+      const tmpArgv = process.argv[i]
+      if (tmpArgv.indexOf('--env=') !== -1) {
+        options.env = tmpArgv.substring(6)
+      }
+    }
+
+    // normalize env
+
+    env.NODE_ENV = 'production';
+    env.EE_HOME = options.homeDir;
+    env.EE_SERVER_ENV = options.env;
+    env.EE_SERVER_SCOPE = options.serverScope;
+    env.EE_USER_HOME = options.userHome;
+    env.EE_APP_DATA = options.appData;
+    env.EE_APP_USER_DATA = options.appUserData;
+    env.EE_EGG_PORT = null;
+    env.EE_IPC_PORT = null;
+    env.EGG_SERVER_ENV = options.env;
+    debug('options:%j', options)
+
+    super(options);
+    this.initialize();
+  }
+
+  async initialize () {
+
+    await this.createPorts();
+
+    this.startSocket();
+    //return;
+
+    await this.ready();
+
+    await this.createElectronApp();
+
+    this.catchLog();
+  } 
+}
+
+module.exports = Appliaction;

package/lib/baseApp.js

@@ -0,0 +1,155 @@
+'use strict';
+
+const EeAppCore = require('../core/index').EeCore;
+const EE_PATH = Symbol.for('ee#eePath');
+const path = require('path');
+const EE_LOADER = Symbol.for('ee#loader');
+const AppLoader = require('./appLoader');
+const LOGGERS = Symbol('EeApplication#loggers');
+const ELoggers = require('./logger');
+const HttpClient = require('./httpclient');
+const HTTPCLIENT = Symbol('EeApplication#httpclient');
+
+class BaseApp extends EeAppCore {
+  constructor (options = {}) {
+
+    super(options);
+    
+    this.HttpClient = HttpClient;
+
+    this.loader.loadConfig();
+    
+    // 缓存配置
+    this.getCoreDB().setItem('config', this.config);
+
+    this.loader.load();
+
+    // TODO 这个不行，要么每次new对象，要么所有地方都用同一个实例，否则会出现数据无法刷新的情况
+    //this.coreDB = this.getCoreDB();
+ 
+    this.coreLogger.info('[ee-core:baseApp] start loaded lib modules');
+
+  }
+
+  get [EE_PATH]() {
+    return path.join(__dirname, '..');
+  }
+
+  get [EE_LOADER]() {
+    return AppLoader;
+  }
+
+  /**
+   *  loggers
+   * @member {Object}
+   * @since 1.0.0
+   */
+  get loggers() {
+    if (!this[LOGGERS]) {
+      this[LOGGERS] = ELoggers.getInstance(this.config);
+    }
+    return this[LOGGERS];
+  }
+
+  /**
+   * Get logger by name, it's equal to app.loggers['name'],
+   * but you can extend it with your own logical.
+   * @param {String} name - logger name
+   * @return {Logger} logger
+   */
+  getLogger(name) {
+    return this.loggers[name] || null;
+  }
+
+  /**
+   * application logger, log file is `$HOME/logs/ee.log`
+   * @member {Logger}
+   * @since 1.0.0
+   */
+  get logger() {
+    return this.getLogger('logger');
+  }
+
+  /**
+   * core logger for framework and plugins, log file is `$HOME/logs/ee-core.log`
+   * @member {Logger}
+   * @since 1.0.0
+   */
+  get coreLogger() {
+    return this.getLogger('coreLogger');
+  }
+
+  /**
+   * @class core存储模块
+   * @since 1.0.0
+   */
+  getCoreDB () {
+    const db = require('./storage/index').JsonDB.connection('system');
+    return db;
+  }
+  
+  /**
+   * @class curl
+   * @since 1.0.0
+   */
+  curl(url, opts) {
+    return this.httpclient.request(url, opts);
+  }
+
+  /**
+   * HttpClient instance
+   * @see https://github.com/node-modules/urllib
+   * @member {HttpClient}
+   */
+  get httpclient() {
+    if (!this[HTTPCLIENT]) {
+      this[HTTPCLIENT] = new this.HttpClient(this);
+    }
+    return this[HTTPCLIENT];
+  }
+
+  /**
+   * 调用 egg api
+   */
+  async curlEgg (method, uri, params, timeout = 15000) {
+    let result = null;
+    try {
+      const port = this.config.egg.port;
+      const url = "http://127.0.0.1:" + port + uri;
+      // console.log('[ee:baseApp] [curlEgg] url:', url);
+      const response = await this.curl(url, {
+        method: method,
+        contentType: 'application/json',
+        data: params,
+        dataType: 'json',
+        timeout: timeout,
+      });
+      result = response.data;
+    } catch (err) {
+      this.logger.error('[ee:baseApp] [curlEgg] throw error:', err);
+    }
+
+    return result; 
+  }
+
+  /**
+   * @class socket模块
+   * @since 1.0.0
+   */
+  get socket () {
+    const obj = {
+      ipc: {},
+      server: {}
+    }
+    return obj;
+  }
+
+  /**
+   * core app have been loaded
+   */
+  async ready () {
+    // do some things
+  }
+}
+
+module.exports = BaseApp;

package/lib/constant.js

@@ -0,0 +1,30 @@
+module.exports = {
+  autoLaunch: {
+    LOGIN_SETTING_OPTIONS: {
+      // For Windows
+      args: [
+        '--opened-at-login=1'
+      ]
+    }
+  },
+  storageKey: {
+    cache: 'cache',
+  },
+  ipcChannels: {
+    appMessage: 'app.message',
+    appUpdater: 'app.updater'
+  },
+  appUpdaterStatus: {
+    error: -1,
+    available: 1,
+    noAvailable: 2,
+    downloading: 3,
+    downloaded: 4,
+  },
+  socketIo: {
+    channel: {
+      eggIoEe: 'c1',
+      eggIoFrotend: 'c2'
+    }
+  }
+};

package/lib/eeApp.js

@@ -0,0 +1,306 @@
+const path = require('path');
+const getPort = require('get-port');
+const {app, BrowserWindow, BrowserView, Menu} = require('electron');
+const BaseApp = require('./baseApp');
+const is = require('is-type-of');
+
+class EeApp extends BaseApp {
+  constructor(options = {}) {
+    super(options);
+
+    this.electron = {
+      mainWindow: null,
+      tray: null
+    };
+
+    //this._mainWindow = null;
+    //this.electron.mainWindow = null;
+
+    //this.electron.tray = null;
+    // global.APP_TRAY = null;
+    //this.preferences = {};
+  }
+
+  /**
+   * 生成端口
+   */
+  async createPorts () {
+    const ipcPort = await getPort();
+    const eggPort = this.config.env === 'prod' ? await getPort() : this.config.egg.port;
+    this.config.egg.port = eggPort;
+    process.env.EE_IPC_PORT = ipcPort;
+    process.env.EE_EGG_PORT = eggPort;
+    this.coreLogger.info('[ee-core:EeApp] [createPorts] ipc port:', ipcPort);
+    this.coreLogger.info('[ee-core:EeApp] [createPorts] egg port:', eggPort);
+    
+    // 更新db配置
+    this.getCoreDB().setItem('ipc_port', ipcPort);
+    this.getCoreDB().setItem('config', this.config);
+  }
+
+  /**
+   * 启动通信模块
+   */
+  startSocket () {
+    const socket = require('./socket/start');
+    socket(this);
+  }
+  
+  /**
+   * 创建electron应用
+   */
+  async createElectronApp () {
+    const self = this;
+    await this.limitOneWindow();
+
+    app.on('second-instance', (event) => {
+      if (self.electron.mainWindow) {
+        if (self.electron.mainWindow.isMinimized()) {
+          self.electron.mainWindow.restore();
+        }
+        self.electron.mainWindow.focus()
+      }
+    })
+  
+    app.whenReady().then(() => {
+      self.createWindow();
+      app.on('activate', function () {
+        if (BrowserWindow.getAllWindows().length === 0) {
+          self.createWindow();
+        }
+      })
+    })
+    
+    app.on('window-all-closed', function () {
+      if (process.platform !== 'darwin') {
+        self.coreLogger.info('[Appliaction] [initialize] window-all-closed quit');
+        self.appQuit();
+      }
+    })
+  }
+    
+  /**
+   * 创建应用主窗口
+   */
+  async createWindow () {
+    const winOptions = this.config.windowsOption;
+    this.electron.mainWindow = new BrowserWindow(winOptions);
+  
+    // DevTools
+    if (!app.isPackaged && this.config.openDevTools) {
+      this.electron.mainWindow.webContents.openDevTools();
+    }
+
+    // 隐藏菜单
+    if (this.config.openAppMenu) {
+      Menu.setApplicationMenu(null);
+    }
+
+    this.loadRemoreWeb();
+
+    this.loadingView(winOptions);
+
+    await this.windowReady();
+  
+    await this.loderPreload();
+    
+    await this.startEggServer(this.config.egg);
+  }
+
+  /**
+   * 加载远程网址
+   */
+  loadRemoreWeb () {
+    const remoteConfig = this.config.remoteUrl;
+    if (remoteConfig.enable) {
+      this.loadMainUrl(remoteConfig.url);
+    }
+  }
+
+  /**
+   * 加载已经实现的功能
+   */
+  async loadPreference () {
+    const preferences = require('./preferences');
+    return await preferences(this);
+  }
+
+  /**
+   * 创建egg服务
+   */  
+  async startEggServer (options) {
+    // egg服务是否开启
+    if (this.config.egg.enable == false) {
+      return;
+    }
+
+    this.coreLogger.info('[ee-core:EeApp] [startServer] options', options);
+    const protocol = 'http://';
+    let startRes = null;
+    let url = null;
+    
+    if (this.config.env === 'prod') {
+      url = protocol + options.hostname + ':' + options.port
+    } else {
+      const developmentModeConfig = this.config.developmentMode;
+      const selectMode = developmentModeConfig.default;
+      const modeInfo = developmentModeConfig.mode[selectMode];
+      url = protocol + modeInfo.hostname + ':' + modeInfo.port;
+    }
+    this.coreLogger.info('[ee-core:EeApp] frontend server :', url)
+    startRes = await this.startEgg(options).then((res) => res, (err) => err);
+    this.coreLogger.info('[ee-core:EeApp] [startServer] egg startRes:', startRes)
+    if (startRes === 'success') {
+      // 是否加载远程网址
+      const remoteConfig = this.config.remoteUrl;
+      if (remoteConfig.enable) {
+        return;
+      }
+      this.loadMainUrl(url);
+    }
+    
+    app.relaunch();
+  }
+
+  /**
+   * 加载loading页面
+   */
+  loadingView (winOptions) {
+    const remoteConfig = this.config.remoteUrl;
+    if (remoteConfig.enable) {
+      return;
+    }
+    const self = this;
+    const loadingBrowserView = new BrowserView();
+    this.electron.mainWindow.setBrowserView(loadingBrowserView);
+    loadingBrowserView.setBounds({
+      x: 0,
+      y: 0,
+      width: winOptions.width,
+      height: winOptions.height
+    });
+
+    // loading html
+    const loadingHtml = path.join('file://', this.config.homeDir, 'public', 'html', 'loading.html');
+    loadingBrowserView.webContents.loadURL(loadingHtml);
+    this.logger.info('loadingHtml:', loadingHtml);
+    
+    this.electron.mainWindow.webContents.on('dom-ready', async (event) => {
+      self.electron.mainWindow.removeBrowserView(loadingBrowserView);
+    });
+  }
+
+  /**
+   * 加载主页面
+   */
+  loadMainUrl (url) {
+    this.electron.mainWindow.loadURL(url);
+  }
+
+  /**
+   * egg
+   */
+  startEgg (argv) {
+    const startCluster = require('egg-cluster').startCluster;
+    
+    let homeDir = this.homeDir;
+    argv.baseDir = homeDir;
+    argv.framework = path.join(homeDir, 'node_modules', 'egg');
+
+    const appName = this.config.name;
+    argv.title = argv.title || `egg-server-${appName}`;
+
+
+    // normalize env
+    // 目前没有用到，不用修改；想要修改的话，区分打包前后的路径？
+    // env.HOME = HOME; // 这个home不能修改，因为自动升级功能会用到（win没有问题，mac有权限问题）
+    //env.NODE_ENV = 'production';
+
+    // 更新缓存配置  
+    this.getCoreDB().setItem('config', this.config);
+
+    const ignoreKeys = [ '_', '$0', 'env', 'daemon', 'stdout', 'stderr', 'timeout', 'ignore-stderr', 'node' ];
+    const clusterOptions = this.stringify(argv, ignoreKeys);
+    const options = JSON.parse(clusterOptions);
+
+    return new Promise((resolve, reject) => {
+      startCluster(options, function(){
+        resolve('success');
+      });
+    });
+  }
+
+  /**
+   * 限制一个窗口
+   */
+  async limitOneWindow () {
+    const gotTheLock = app.requestSingleInstanceLock();
+    if (!gotTheLock) {
+      await this.appQuit();
+    }
+  }
+
+  /**
+   * electron app退出
+   */  
+  async appQuit () {
+    await this.beforeClose();
+    this.electron.mainWindow.destroy();
+    app.quit();
+  }
+
+  /**
+   * 预加载模块
+   */
+  async loderPreload () {
+    let filepath = this.loader.resolveModule(path.join(this.config.baseDir, 'preload', 'index'));
+    if (!filepath) return; 
+    const fileObj = this.loader.loadFile(filepath);
+    if (is.function(fileObj) && !is.generatorFunction(fileObj) && !is.asyncFunction(fileObj)) {
+      fileObj();
+    } else if (is.asyncFunction(fileObj)) {
+      await fileObj();
+    }
+  }  
+
+  /**
+   * 序列化参数
+   */ 
+  stringify(obj, ignore) {
+    const result = {};
+    Object.keys(obj).forEach(key => {
+      if (!ignore.includes(key)) {
+        result[key] = obj[key];
+      }
+    });
+    return JSON.stringify(result);
+  }
+
+  /**
+   * 捕获异常
+   */
+  catchLog () {
+    const self = this;
+    process.on('uncaughtException', function(err) {
+      self.logger.error(err);
+    });
+  }
+
+  /**
+   * 主应用窗口已经创建
+   */
+  async windowReady () {
+    // do some things
+
+  }
+
+  /**
+   * app关闭之前
+   */  
+  async beforeClose () {
+    // do some things
+
+  }  
+}
+
+module.exports = EeApp;

package/lib/helper.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const is = require('electron-is');
+const { app } = require('electron');
+
+/**
+ * application quit
+ * 
+ * @return {undefined}
+ */
+exports.appQuit = function () {
+	MAIN_WINDOW.destroy();
+	app.quit();
+}
+
+/**
+ * get Platform
+ * 
+ * @return {Object}
+ */
+exports.getPlatform = function () {
+	let platform = null;
+	let arch = null;
+	if (is.windows()) {
+		platform = 'windows';
+	} else if (is.macOS()) {
+		platform = 'macOS';
+	} else if (is.linux()) {
+		platform = 'linux';
+	} else {
+		platform = 'other';
+	}
+
+	if (is.x86()) {
+		arch = '32';
+	} else if (is.x64()) {
+		arch = '64';
+	} else if (process.arch == 'arm') {
+		arch = 'arm32';
+	} else if (process.arch == 'arm64') {
+		arch = 'arm64';
+	} else {
+		arch = 'other';
+	}
+
+	const platfromObj = {
+		platform: platform,
+		arch: arch
+	};
+
+	return platfromObj;
+}