ee-core 2.1.1-beta.5 → 2.2.0-beta.1

package/addon/index.js

@@ -1,30 +1,31 @@
-const EEAddon = Symbol('Ee#Addon');
+const EE = require('../ee');
 
-/**
- * todo 插件模块
- */ 
 const Addon = {
 
   /**
-   * 设置插件对象
+   * 获取 all addon instances
    */  
-  setAddonObject(name, obj) {
-    if (!this[EEAddon]) {
-      this[EEAddon] = new Map();
-    }
-
-    if (!this[EEAddon].has(name)) {
-      this[EEAddon].set(name, obj);
-    }
+  all() {
+    const { CoreApp } = EE;
+    const instances = CoreApp.addon || null;
+    if (!instances) {
+      throw new Error('Addons not exists or do not call directly at the top!');
+    };
+    return instances;
   },
 
   /**
-   * 获取插件对象
+   * 获取 addon instance
    */  
   get(name) {
-    let addon = this[EEAddon].has(name) ? this[EEAddon].get(name): null;
-    return addon;
-  },  
-}  
+    const instances = this.all();
+    const instance = instances[name] || null;
+    if (!instance) {
+      throw new Error(`Addon class '${name}' not exists or do not call directly at the top!`);
+    };
+    return instance;
+  },
+ 
+};
 
 module.exports = Addon;

package/addon/window/index.js

@@ -18,6 +18,12 @@ class WinAddon {
    * @since 1.0.0
    */
   create(name, opt) {
+
+    // todo 判断name是否唯一
+    // if (this.windowContentsIdMap.hasOwnProperty(name)) {
+    //   throw new Error(`[addon] [window] Name: ${name} already exists!`);
+    // }
+
     const options = Object.assign({
       x: 10,
       y: 10,
@@ -74,7 +80,7 @@ class WinAddon {
    * @function 
    * @since 1.0.0
    */
-  registerWCid (name, id) {
+  registerWCid(name, id) {
     this.windowContentsIdMap[name] = id;
   }
 
@@ -84,7 +90,7 @@ class WinAddon {
    * @function 
    * @since 1.0.0
    */
-   removeWCid (name) {
+   removeWCid(name) {
     delete this.windowContentsIdMap[name];
   }  
 }

package/ee/application.js

@@ -5,6 +5,7 @@ const debug = require('debug')('ee-core:Appliaction');
 const EeApp = require('./eeApp');
 const Utils = require('../utils');
 const Ps = require('../ps');
+const EE = require('./index');
 
 class Appliaction extends EeApp {
   constructor() {
@@ -71,6 +72,10 @@ class Appliaction extends EeApp {
     debug('options:%j', options)
 
     super(options);
+
+    // 设置全局this
+    EE.CoreApp = this;
+
     this.initialize();
   }
 

package/ee/baseApp.js

@@ -22,9 +22,6 @@ class BaseApp extends EeAppCore {
     this.loader.load();
 
     this.HttpClient = HttpClient;
-
-    // TODO 这个不行，要么每次new对象，要么所有地方都用同一个实例，否则会出现数据无法刷新的情况
-    //this.coreDB = this.getCoreDB();
   }
 
   get [EE_PATH]() {

package/ee/eeApp.js

@@ -1,14 +1,15 @@
 const path = require('path');
 const fs = require('fs');
 const assert = require('assert');
-const { app } = require('electron');
 const is = require('is-type-of');
 const Koa = require('koa');
 const koaServe = require('koa-static');
 const https = require('https');
 const BaseApp = require('./baseApp');
 const Log = require('../log');
-const Electron = require('../electron');
+const CoreElectron = require('../electron');
+const CoreElectronApp = require('../electron/app');
+const CoreElectronWindow = require('../electron/window');
 const Conf = require('../config');
 const Ps = require('../ps');
 const Socket = require('../socket');
@@ -18,14 +19,15 @@ class EeApp extends BaseApp {
   constructor(options = {}) {
     super(options);
 
-    this.electron = Electron;
+    // 兼容旧的api
+    this.electron = CoreElectron;
     this.mainWindow;
   }
 
   /**
    * 生成端口
    */
-  async createPorts () {
+  async createPorts() {
     const mainPort = await GetPort({port: this.config.mainServer.port});
     process.env.EE_MAIN_PORT = mainPort;
     this.config.mainServer.port = mainPort;
@@ -49,46 +51,17 @@ class EeApp extends BaseApp {
   /**
    * 启动通信模块
    */
-  async startSocket () {
+  async startSocket() {
     Socket.startAll(this);
   }
   
   /**
    * 创建electron应用
    */
-  async createElectronApp () {
-    const self = this;
-
-    const gotTheLock = app.requestSingleInstanceLock();
-    if (!gotTheLock) {
-      await this.appQuit();
-      return;
-    }
-
-    app.on('second-instance', (event) => {
-      self.restoreMainWindow();
-    })
-  
-    app.whenReady().then(() => {
-      self.createWindow();
-      app.on('activate', () => {
-        self.restoreMainWindow();
-      })
-    })
-    
-    app.on('window-all-closed', () => {
-      if (process.platform !== 'darwin') {
-        Log.coreLogger.info('[ee-core] [lib/eeApp] window-all-closed quit');
-        self.appQuit();
-      }
-    })
-
-    app.on('before-quit', () => {
-      Electron.extra.closeWindow = true;
-    })
-
-    if (this.config.hardGpu.enable == false) {
-      app.disableHardwareAcceleration();
+  async createElectronApp() {
+    const newApp = CoreElectronApp.create();
+    if (!newApp) {
+      return
     }
 
     await this.electronAppReady();
@@ -97,10 +70,10 @@ class EeApp extends BaseApp {
   /**
    * 创建应用主窗口
    */
-  async createWindow () {
+  async createWindow() {
 
     // 初始化一个主窗口
-    this.mainWindow = Electron.getMainWindow();
+    this.mainWindow = CoreElectronWindow.getMainWindow();
 
     await this.windowReady();
   
@@ -111,23 +84,10 @@ class EeApp extends BaseApp {
     this.selectAppType();
   }
 
-  /**
-   * 还原窗口
-   */
-  restoreMainWindow () {
-    if (this.mainWindow) {
-      if (this.mainWindow.isMinimized()) {
-        this.mainWindow.restore();
-      }
-      this.mainWindow.show();
-      this.mainWindow.focus();
-    }
-  }
-
   /**
    * 应用类型 （远程、html、单页应用）
    */
-  selectAppType () {
+  selectAppType() {
     let type = '';
     let url = '';
 
@@ -167,7 +127,7 @@ class EeApp extends BaseApp {
   /**
    * 加载本地前端资源
    */
-  loadLocalWeb (mode, staticDir, hostInfo) {
+  loadLocalWeb(mode, staticDir, hostInfo) {
     const self = this;
     if (!staticDir) {
       staticDir = path.join(this.config.homeDir, 'public', 'dist')
@@ -210,7 +170,7 @@ class EeApp extends BaseApp {
   /**
    * 主页面
    */
-  loadMainUrl (type, url) {
+  loadMainUrl(type, url) {
     const mainServer = this.config.mainServer;
     Log.coreLogger.info('[ee-core] [main] Env: %s, Type: %s', this.config.env, type);
     Log.coreLogger.info('[ee-core] [main] App running at: %s', url);
@@ -220,15 +180,15 @@ class EeApp extends BaseApp {
   /**
    * electron app退出
    */  
-  async appQuit () {
+  async appQuit() {
     await this.beforeClose();
-    app.quit();
+    CoreElectronApp.quit();
   }
 
   /**
    * 加载插件
    */
-  async _loderAddons () {
+  async _loderAddons() {
     this.loader.loadAddons();
 
     // 注册主窗口Contents id
@@ -243,7 +203,7 @@ class EeApp extends BaseApp {
   /**
    * 预加载模块
    */
-  async _loderPreload () {
+  async _loderPreload() {
     let filepath = this.loader.resolveModule(path.join(this.config.baseDir, 'preload', 'index'));
     if (!filepath) return; 
     const fileObj = this.loader.loadFile(filepath);
@@ -254,46 +214,24 @@ class EeApp extends BaseApp {
     }
   }
 
-  /**
-   * 序列化参数
-   */ 
-  stringify(obj, ignore) {
-    const result = {};
-    Object.keys(obj).forEach(key => {
-      if (!ignore.includes(key)) {
-        result[key] = obj[key];
-      }
-    });
-    return JSON.stringify(result);
-  }
-
-  /**
-   * 捕获异常（废弃）
-   */
-  async catchLog () {
-    process.on('uncaughtException', function(err) {
-      Log.coreLogger.error(err);
-    });
-  }
-
   /**
    * electron app已经准备好，主窗口还未创建
    */
-  async electronAppReady () {
+  async electronAppReady() {
     // do some things
   }
 
   /**
    * 主应用窗口已经创建
    */
-  async windowReady () {
+  async windowReady() {
     // do some things
   }
 
   /**
    * app关闭之前
    */  
-  async beforeClose () {
+  async beforeClose() {
     // do some things
   }  
 }

package/ee/index.js

@@ -1,6 +1,10 @@
 const Utils = require('../utils');
 const EEApplication = Symbol('Ee#Application');
+const BuiltInApp = Symbol('Ee#BuiltInApp');
 
+/**
+ * EE
+ */
 const EE = {
 
   /**
@@ -12,7 +16,7 @@ const EE = {
   },
 
   /**
-   * 设置app对象
+   * 设置实例化app对象
    */  
   set app(appObject) {
     if (!this[EEApplication]) {
@@ -21,12 +25,28 @@ const EE = {
   },
 
   /**
-   * 获取app对象
+   * 获取实例化app对象
    */  
   get app() {
     return this[EEApplication] || null;
   },
 
+  /**
+   * 设置全局this到CoreApp (eeApp)
+   */  
+  set CoreApp(obj) {
+    if (!this[BuiltInApp]) {
+      this[BuiltInApp] = obj;
+    }
+  },
+
+  /**
+   * 获取 CoreApp (eeApp)
+   */  
+  get CoreApp() {
+    return this[BuiltInApp] || null;
+  },
+
   /**
    * 是否加密
    */  

package/electron/app/index.js

@@ -0,0 +1,62 @@
+const { app } = require('electron');
+const Window = require('../window');
+const EE = require('../../ee');
+const Log = require('../../log');
+const Electron = require('../index');
+const UtilsIs = require('../../utils/is');
+
+/**
+ * CoreElectronApp (框架封装的electron app对象)
+ */
+const CoreElectronApp = {
+
+  /**
+   * 创建electron应用
+   */
+  async create() {
+    const { CoreApp } = EE;
+
+    const gotTheLock = app.requestSingleInstanceLock();
+    if (!gotTheLock) {
+      app.quit();
+      return;
+    }
+
+    app.on('second-instance', (event) => {
+      Window.restoreMainWindow();
+    })
+  
+    app.whenReady().then(() => {
+      CoreApp.createWindow();
+      app.on('activate', () => {
+        Window.restoreMainWindow();
+      })
+    })
+    
+    app.on('window-all-closed', () => {
+      if (!UtilsIs.macOS) {
+        Log.coreLogger.info('[ee-core] [lib/eeApp] window-all-closed quit');
+        CoreApp.appQuit();
+      }
+    })
+
+    app.on('before-quit', () => {
+      Electron.extra.closeWindow = true;
+    })
+
+    if (CoreApp.config.hardGpu.enable == false) {
+      app.disableHardwareAcceleration();
+    }
+
+    return app;
+  },
+
+  /**
+   * 退出app
+   */
+  quit() {
+    app.quit();
+  }
+}
+
+module.exports = CoreElectronApp;

package/electron/index.js

@@ -1,24 +1,12 @@
 const Window = require('./window');
-const EEMainWindow = Symbol('Ee#electron#mainWindow');
 
 const Electron = {
 
-  /**
-   * 获取 mainWindow
-   */
-  getMainWindow() {
-    if (!this[EEMainWindow]) {
-      this[EEMainWindow] = Window.createWindow();
-    }
-
-    return this[EEMainWindow] || null;
-  },
-
   /**
    * 兼容1.x版本api
    */
   get mainWindow() {
-    return this.getMainWindow();
+    return Window.getMainWindow();
   },
 
   /**
@@ -26,7 +14,7 @@ const Electron = {
    */
   extra: {
     closeWindow: false,
-  },  
+  }, 
 };
 
 module.exports = Electron;

package/electron/{window.js → window/index.js}

@@ -1,13 +1,25 @@
-const {app, BrowserWindow, Menu} = require('electron');
-const Conf = require('../config');
-const Ps = require('../ps');
+const { app, BrowserWindow, Menu } = require('electron');
+const Conf = require('../../config');
+const Ps = require('../../ps');
+const EEMainWindow = Symbol('Ee#electron#mainWindow');
 
 const Window = {
 
+  /**
+   * 获取 mainWindow
+   */
+  getMainWindow() {
+    if (!this[EEMainWindow]) {
+      this[EEMainWindow] = this.createMainWindow();
+    }
+
+    return this[EEMainWindow] || null;
+  },
+
   /**
    * 创建应用主窗口
    */
-  createWindow () {
+  createMainWindow() {
 
     // todo
     // const protocolName = 'eefile';
@@ -18,7 +30,8 @@ const Window = {
     // });
 
     const config = Conf.all();
-    let win = new BrowserWindow(config.windowsOption);
+    const win = new BrowserWindow(config.windowsOption);
+    this[EEMainWindow] = win;
 
     // 菜单显示/隐藏
     if (config.openAppMenu === 'dev-show' && Ps.isProd()) {
@@ -37,9 +50,20 @@ const Window = {
     }
 
     return win;
-  }
-
+  },
 
+  /**
+   * 还原窗口
+   */
+  restoreMainWindow() {
+    if (this[EEMainWindow]) {
+      if (this[EEMainWindow].isMinimized()) {
+        this[EEMainWindow].restore();
+      }
+      this[EEMainWindow].show();
+      this[EEMainWindow].focus();
+    }
+  }
 };
 
 module.exports = Window;

package/electron/window/winState.js

@@ -0,0 +1,186 @@
+'use strict';
+
+const path = require('path');
+const electron = require('electron');
+const jsonfile = require('jsonfile');
+const mkdirp = require('mkdirp');
+
+module.exports = function (options) {
+  const app = electron.app || electron.remote.app;
+  const screen = electron.screen || electron.remote.screen;
+  let state;
+  let winRef;
+  let stateChangeTimer;
+  const eventHandlingDelay = 100;
+  const config = Object.assign({
+    file: 'window-state.json',
+    path: app.getPath('userData'),
+    maximize: true,
+    fullScreen: true
+  }, options);
+  const fullStoreFileName = path.join(config.path, config.file);
+
+  function isNormal(win) {
+    return !win.isMaximized() && !win.isMinimized() && !win.isFullScreen();
+  }
+
+  function hasBounds() {
+    return state &&
+      Number.isInteger(state.x) &&
+      Number.isInteger(state.y) &&
+      Number.isInteger(state.width) && state.width > 0 &&
+      Number.isInteger(state.height) && state.height > 0;
+  }
+
+  function resetStateToDefault() {
+    const displayBounds = screen.getPrimaryDisplay().bounds;
+
+    // Reset state to default values on the primary display
+    state = {
+      width: config.defaultWidth || 800,
+      height: config.defaultHeight || 600,
+      x: 0,
+      y: 0,
+      displayBounds
+    };
+  }
+
+  function windowWithinBounds(bounds) {
+    return (
+      state.x >= bounds.x &&
+      state.y >= bounds.y &&
+      state.x + state.width <= bounds.x + bounds.width &&
+      state.y + state.height <= bounds.y + bounds.height
+    );
+  }
+
+  function ensureWindowVisibleOnSomeDisplay() {
+    const visible = screen.getAllDisplays().some(display => {
+      return windowWithinBounds(display.bounds);
+    });
+
+    if (!visible) {
+      // Window is partially or fully not visible now.
+      // Reset it to safe defaults.
+      return resetStateToDefault();
+    }
+  }
+
+  function validateState() {
+    const isValid = state && (hasBounds() || state.isMaximized || state.isFullScreen);
+    if (!isValid) {
+      state = null;
+      return;
+    }
+
+    if (hasBounds() && state.displayBounds) {
+      ensureWindowVisibleOnSomeDisplay();
+    }
+  }
+
+  function updateState(win) {
+    win = win || winRef;
+    if (!win) {
+      return;
+    }
+    // Don't throw an error when window was closed
+    try {
+      const winBounds = win.getBounds();
+      if (isNormal(win)) {
+        state.x = winBounds.x;
+        state.y = winBounds.y;
+        state.width = winBounds.width;
+        state.height = winBounds.height;
+      }
+      state.isMaximized = win.isMaximized();
+      state.isFullScreen = win.isFullScreen();
+      state.displayBounds = screen.getDisplayMatching(winBounds).bounds;
+    } catch (err) {}
+  }
+
+  function saveState(win) {
+    // Update window state only if it was provided
+    if (win) {
+      updateState(win);
+    }
+
+    // Save state
+    try {
+      mkdirp.sync(path.dirname(fullStoreFileName));
+      jsonfile.writeFileSync(fullStoreFileName, state);
+    } catch (err) {
+      // Don't care
+    }
+  }
+
+  function stateChangeHandler() {
+    // Handles both 'resize' and 'move'
+    clearTimeout(stateChangeTimer);
+    stateChangeTimer = setTimeout(updateState, eventHandlingDelay);
+  }
+
+  function closeHandler() {
+    updateState();
+  }
+
+  function closedHandler() {
+    // Unregister listeners and save state
+    unmanage();
+    saveState();
+  }
+
+  function manage(win) {
+    if (config.maximize && state.isMaximized) {
+      win.maximize();
+    }
+    if (config.fullScreen && state.isFullScreen) {
+      win.setFullScreen(true);
+    }
+    win.on('resize', stateChangeHandler);
+    win.on('move', stateChangeHandler);
+    win.on('close', closeHandler);
+    win.on('closed', closedHandler);
+    winRef = win;
+  }
+
+  function unmanage() {
+    if (winRef) {
+      winRef.removeListener('resize', stateChangeHandler);
+      winRef.removeListener('move', stateChangeHandler);
+      clearTimeout(stateChangeTimer);
+      winRef.removeListener('close', closeHandler);
+      winRef.removeListener('closed', closedHandler);
+      winRef = null;
+    }
+  }
+
+  // Load previous state
+  try {
+    state = jsonfile.readFileSync(fullStoreFileName);
+  } catch (err) {
+    // Don't care
+  }
+
+  // Check state validity
+  validateState();
+
+  // Set state fallback values
+  state = Object.assign({
+    width: config.defaultWidth || 800,
+    height: config.defaultHeight || 600
+  }, state);
+
+  return {
+    get x() { return state.x; },
+    get y() { return state.y; },
+    get width() { return state.width; },
+    get height() { return state.height; },
+    get displayBounds() { return state.displayBounds; },
+    get isMaximized() { return state.isMaximized; },
+    get isFullScreen() { return state.isFullScreen; },
+    saveState,
+    unmanage,
+    manage,
+    resetStateToDefault
+  };
+};

package/index.js

@@ -12,13 +12,13 @@ const EE = require('./ee');
  * @member {Controller} EeCore#Controller
  * @since 1.0.0
  */
-const Controller = require('./controller');
+const Controller = require('./controller/baseContextClass');
 
 /**
  * @member {Service} EeCore#Service
  * @since 1.0.0
  */
-const Service = require('./service');
+const Service = require('./services/baseContextClass');
 
 /**
  * @member {Storage}

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "ee-core",
-  "version": "2.1.1-beta.5",
+  "version": "2.2.0-beta.1",
   "description": "ee core",
   "main": "index.js",
   "scripts": {
-    "publish-beta": "npm publish --tag beta",
-    "publish": "npm publish",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",

package/services/baseContextClass.js

@@ -0,0 +1,34 @@
+'use strict';
+
+/**
+ * BaseContextClass is a base class that can be extended,
+ * it's instantiated in context level,
+ * {@link Helper}, {@link Service} is extending it.
+ */
+class BaseContextClass {
+
+  /**
+   * @class
+   * @param {Context} ctx - context instance
+   * @since 1.0.0
+   */
+  constructor(ctx) {
+    /**
+     * @member {Application} BaseContextClass#app
+     * @since 1.0.0
+     */
+    this.app = ctx;
+    /**
+     * @member {Config} BaseContextClass#config
+     * @since 1.0.0
+     */
+    this.config = ctx.config;
+    /**
+     * @member {Service} BaseContextClass#service
+     * @since 1.0.0
+     */
+    this.service = ctx.service;
+  }
+}
+
+module.exports = BaseContextClass;

package/services/index.js

@@ -0,0 +1,31 @@
+const EE = require('../ee');
+
+const Services = {
+
+  /**
+   * 获取 all addon instances
+   */  
+  all() {
+    const { CoreApp } = EE;
+    const instances = CoreApp.service || null;
+    if (!instances) {
+      throw new Error('Services not exists or do not call directly at the top!');
+    };
+    return instances;
+  },
+
+  /**
+   * 获取 addon instance
+   */  
+  get(name) {
+    const instances = this.all();
+    const instance = instances[name] || null;
+    if (!instance) {
+      throw new Error(`Service class '${name}' not exists or do not call directly at the top!`);
+    };
+    return instance;
+  },
+
+};
+
+module.exports = Services;