ee-core 2.0.0-beta.4 → 2.0.0-beta.7

package/{module/socket → socket}/httpServer.js

@@ -10,6 +10,7 @@ const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
 const Log = require('../log');
+const Ps = require('../ps');
 
 /**
  * http server
@@ -19,12 +20,14 @@ class HttpServer {
     this.app = app;
     this.options = this.app.config.httpServer;
 
-    if (!this.options.enable) {
+    if (this.options.enable == false) {
       return;
     }
 
-    let port = process.env.EE_HTTP_PORT ? parseInt(process.env.EE_HTTP_PORT) : parseInt(this.getHttpPort());
-    assert(typeof port === 'number', 'http port required, and must be a number');
+    let port = Ps.getHttpPort();
+    if (!port) {
+      throw new Error('[ee-core] [socket/HttpServer] http port required, and must be a number !');
+    }
 
     this.create();
   }
@@ -33,15 +36,15 @@ class HttpServer {
    * 创建服务
    */
   create () {
-    const self = this;
+    const app = this.app;
     const httpServer = this.options;
     const isHttps = httpServer?.https?.enable ?? false;
     let sslOptions = {};
 
     if (isHttps === true) {
       httpServer.protocol = 'https://';
-      const keyFile = path.join(this.app.config.homeDir, httpServer.https.key);
-      const certFile = path.join(this.app.config.homeDir, httpServer.https.cert);
+      const keyFile = path.join(app.config.homeDir, httpServer.https.key);
+      const certFile = path.join(app.config.homeDir, httpServer.https.cert);
       assert(fs.existsSync(keyFile), 'ssl key file is required');
       assert(fs.existsSync(certFile), 'ssl cert file is required');
 
@@ -56,12 +59,12 @@ class HttpServer {
       .use(cors(corsOptions))
       .use(koaBody(httpServer.body))
       .use(async (ctx, next) => {
-        ctx.eeApp = self.app;
+        ctx.eeApp = app;
         await next();
       })
       .use(this.dispatch);
 
-    let msg = '[ee-core] [socket/httpServer] server is: ' + url;
+    let msg = '[ee-core] [socket/http] server is: ' + url;
     if (isHttps) {
       https.createServer(sslOptions, koaApp.callback()).listen(httpServer.port, (err) => {
         msg = err ? err : msg;
@@ -125,20 +128,11 @@ class HttpServer {
       const result = await fn.call(ctx.eeApp, args);
       ctx.response.body = result;
     } catch (err) {
-      ctx.eeApp.console.error('[ee-core:http:server] throw error:', err);
+      Log.coreLogger.error('[ee-core/httpServer] throw error:', err);
     }
 
     await next();
   }
-
-  /**
-   * 获取http端口
-   */  
-  getHttpPort () {
-    const cdb = this.getCoreDB();
-    const port = cdb.getItem('config').httpServer.port;
-    return parseInt(port);
-  } 
 }
 
 module.exports = HttpServer;

package/socket/index.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const IoServer = require('socket.io');
+const IoClient = require('socket.io-client');
+const Koa = require('koa');
+const EESocketServer = Symbol('Ee#SocketServer');
+const EEIpcServer = Symbol('Ee#IpcServer');
+const EEHttpServer = Symbol('Ee#HttpServer');
+
+const EeSocket = {
+
+  /**
+   * 提供基础库 - 避免用户重复安装
+   */
+  Koa,
+  IoServer,
+  IoClient,
+
+  /**
+   * 启动所有服务
+   */ 
+  startAll(app) {
+    this._createSocketServer(app);
+    this._createHttpServer(app);
+    this._createIpcServer(app);
+  },
+
+  /**
+   * 创建SocketServer
+   */ 
+  _createSocketServer(app) {
+    const SocketServer = require('./socketServer');
+    this[EESocketServer] = new SocketServer(app);
+
+    return this[EESocketServer];
+  },
+
+  /**
+   * 获取 Socket Server
+   */
+  getSocketServer() {
+    return this[EESocketServer] || null;
+  },  
+
+  /**
+   * 创建 Http Server
+   */ 
+  _createHttpServer(app) {
+    const HttpServer = require('./httpServer');
+    this[EEHttpServer] = new HttpServer(app);
+
+    return this[EEHttpServer];
+  },
+
+  /**
+   * 获取 Http Server
+   */
+  getHttpServer() {
+    return this[EEHttpServer] || null;
+  }, 
+
+  /**
+   * 创建 IPC Server
+   */ 
+  _createIpcServer(app) {
+    const IpcServer = require('./ipcServer');
+    this[EEIpcServer] = new IpcServer(app);
+
+    return this[EEIpcServer];
+  },
+
+  /**
+   * 获取 IPC Server
+   */
+  getIpcServer() {
+    return this[EEIpcServer] || null;
+  },   
+
+}
+
+
+module.exports = EeSocket;

package/{module/socket → socket}/io.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ * 该文件将废弃
+ */
+
 const IoServer = require('socket.io');
 const IoClient = require('socket.io-client');
 //const socketServer = require('./socketServer');

package/{module/socket → socket}/ipcServer.js

@@ -15,8 +15,6 @@ class IpcServer {
   }
 
   register () {
-    console.log('[ee-core] [socket/IpcServer] register channels');
-
     const self = this;
     // 遍历方法
     const files = Utils.filePatterns();

package/socket/socketServer.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const { Server } = require('socket.io');
+const is = require('is-type-of');
+const Log = require('../log');
+const Conf = require('../config');
+const Ps = require('../ps');
+const Channel = require('../const/channel');
+
+/**
+ * socket server
+ */
+class SocketServer {
+  constructor (app) {
+    this.app = app;
+    const options = Conf.getValue('socketServer');
+
+    if (options.enable == false) {
+      return;
+    }
+
+    let port = Ps.getSocketPort();
+    if (!port) {
+      throw new Error('[ee-core] [socket/socketServer] socekt port required, and must be a number !');
+    }
+
+    Log.coreLogger.info('[ee-core] [socket/socketServer] port is:', port);
+
+    this.io = new Server(port, options);
+    this.connec();
+  }
+
+  connec () {
+    const app = this.app;
+    this.io.on('connection', (socket) => {
+      const channel = Channel.socketIo.partySoftware;
+      socket.on(channel, async (message, callback) => {
+        Log.coreLogger.info('[ee-core] [socket/socketServer] socket id:' + socket.id + ' message cmd: ' + message.cmd);
+
+        try {
+          // 找函数
+          const cmd = message.cmd;
+          const args = message.params;
+          let fn = null;
+          if (is.string(cmd)) {
+            const actions = cmd.split('.');
+            let obj = app;
+            actions.forEach(key => {
+              obj = obj[key];
+              if (!obj) throw new Error(`class or function '${key}' not exists`);
+            });
+            fn = obj;
+          }
+          if (!fn) throw new Error('function not exists');
+
+          const result = await fn.call(app, args);
+          callback(result);
+        } catch (err) {
+          Log.coreLogger.error('[ee-core] [socket/socketServer] throw error:', err);
+        }
+      });
+    });
+  }
+}
+
+module.exports = SocketServer;

package/{module/storage → storage}/jsondbStorage.js

@@ -90,6 +90,43 @@ class JsondbStorage {
       .get(keyId)
       .value();
   
+    return data;
+  }
+
+  /**
+   * 设置config对象key属性的值
+   */
+  setConfigItem (key, value) {
+    assert(_.isString(key), `key must be a string`);
+    assert(key.length != 0, `key cannot be empty`);
+    assert(!this.storageKey.hasOwnProperty(key), `${key} is not allowed`);
+
+    let cacheKey = this.storageKey.cacheConfig;
+    if (!this.db.has(cacheKey).value()) {
+      this.db.set(cacheKey, {}).write();
+    }
+
+    let keyId = cacheKey + "." + key; 
+    this.db
+      .set(keyId, value)
+      .write();
+  
+    return true;
+  }
+  
+  /**
+   * 获取config对象key属性的值
+   */
+  getConfigItem (key) {
+    assert(_.isString(key), `key must be a string`);
+    assert(key.length != 0, `key cannot be empty`);
+
+    let cacheKey = this.storageKey.cacheConfig;
+    let keyId = cacheKey + "." + key; 
+    const data = this.db
+      .get(keyId)
+      .value();
+  
     return data;
   }   
 }

package/utils/is.js

@@ -0,0 +1,145 @@
+'use strict'
+
+const semver = require('semver')
+const gt = semver.gt
+const lt = semver.lt
+const release = require('os').release
+
+const IS = {
+  // Checks if we are in renderer process
+  renderer() {
+    return process.type === 'renderer'
+  },
+  // Checks if we are in main process
+  main() {
+    return process.type === 'browser'
+  },
+  // Checks if we are under Mac OS
+  osx() {
+    return process.platform === 'darwin'
+  },
+  // Checks if we are under Mac OS
+  macOS() {
+    return this.osx()
+  },
+  // Checks if we are under Windows OS
+  windows() {
+    return process.platform === 'win32'
+  },
+  // Checks if we are under Linux OS
+  linux() {
+    return process.platform === 'linux'
+  },
+  // Checks if we are the processor's arch is x86
+  x86() {
+    return process.arch === 'ia32'
+  },
+  // Checks if we are the processor's arch is x64
+  x64() {
+    return process.arch === 'x64'
+  },
+  // Checks if the app is running in a sandbox on macOS
+  sandbox() {
+    return 'APP_SANDBOX_CONTAINER_ID' in process.env
+  },
+  // Checks if the app is running as a Mac App Store build
+  mas() {
+    return process.mas === true
+  },
+  // Checks if the app is running as a Windows Store (appx) build
+  windowsStore() {
+    return process.windowsStore === true
+  },
+  // checks if all the 'is functions' passed as arguments are true
+  all() {
+    const isFunctions = new Array(arguments.length)
+    for (var i = 0; i < isFunctions.length; i++) {
+      isFunctions[i] = arguments[i]
+    }
+    if (!isFunctions.length) return
+    for (i = 0; i < isFunctions.length; i++) {
+      if (!isFunctions[i]()) return false
+    }
+    return true
+  },
+  // checks if all the 'is functions' passed as arguments are false
+  none() {
+    const isFunctions = new Array(arguments.length)
+    for (var i = 0; i < isFunctions.length; i++) {
+      isFunctions[i] = arguments[i]
+    }
+    if (!isFunctions.length) return
+    for (i = 0; i < isFunctions.length; i++) {
+      if (isFunctions[i]()) return false
+    }
+    return true
+  },
+  // returns true if one of the 'is functions' passed as argument is true
+  one() {
+    const isFunctions = new Array(arguments.length)
+    for (var i = 0; i < isFunctions.length; i++) {
+      isFunctions[i] = arguments[i]
+    }
+    if (!isFunctions.length) return
+    for (i = 0; i < isFunctions.length; i++) {
+      if (isFunctions[i]()) return true
+    }
+    return false
+  },
+  // checks the if the given release is the same of the OS
+  release(requested) {
+    if (this.osx()) {
+      return requested === this._osxRelease()
+    } else if (this.windows()) {
+      requested = requested.split('.')
+      const actual = release().split('.')
+      if (requested.length === 2) {
+        return `${actual[0]}.${actual[1]}` === `${requested[0]}.${requested[1]}`
+      }
+      return `${actual[0]}.${actual[1]}.${actual[2]}` === `${requested[0]}.${requested[1]}.${requested[2]}`
+    } else {
+      // Not implemented for Linux yet
+      return null
+    }
+  },
+  // checks if the given release is greater than the current OS release
+  gtRelease(requested) {
+    if (this.osx()) {
+      return gt(requested, this._osxRelease())
+    } else if (this.windows()) {
+      requested = requested.split('.')
+      const actual = release().split('.')
+      if (requested.length === 2) {
+        return gt(`${requested[0]}.${requested[1]}.0`, `${actual[0]}.${actual[1]}.0`)
+      }
+      return gt(`${requested[0]}.${requested[1]}.${requested[2]}`, `${actual[0]}.${actual[1]}.${actual[2]}`)
+    } else {
+      // Not implemented for Linux yet
+      return null
+    }
+  },
+  // checks if the given release is less than the current OS release
+  ltRelease(requested) {
+    if (this.osx()) {
+      return lt(requested, this._osxRelease())
+    } else if (this.windows()) {
+      requested = requested.split('.')
+      const actual = release().split('.')
+      if (requested.length === 2) {
+        return lt(`${requested[0]}.${requested[1]}.0`, `${actual[0]}.${actual[1]}.0`)
+      }
+      return lt(`${requested[0]}.${requested[1]}.${requested[2]}`, `${actual[0]}.${actual[1]}.${actual[2]}`)
+    } else {
+      // Not implemented for Linux yet
+      return null
+    }
+  },
+
+  // returns the current osx release
+  _osxRelease () {
+    const actual = release().split('.')
+    return `10.${actual[0] - 4}.${actual[1]}`
+  }
+}
+
+module.exports = IS;

package/module/app/index.js

@@ -1,5 +0,0 @@
-const App = {
-
-}  
-
-module.exports = App;

package/module/socket/socketClient.js

@@ -1,49 +0,0 @@
-'use strict';
-
-const assert = require('assert');
-const IoClient = require('socket.io-client');
-const Constants = require('../const');
-const Storage = require('../storage');
-
-class SocketClient {
-  constructor (port) {
-    port = port ? parseInt(port) : this.getSocketcPort();
-
-    assert(typeof port === 'number', 'port required, and must be a number');
-    
-    const url  = 'http://localhost:' + port;
-    console.log('[ee-core] [socket/socketClient] url:', url);
-    this.client = IoClient(url);
-  }
-
-  static getInstance (port) {
-    if (typeof this.instance === 'object') {
-      return this.instance;
-    }
-    this.instance = new SocketClient(port);
-    return this.instance;
-  }
-
-  call (method = '', ...params) {
-    return new Promise((resolve, reject) => {
-      // 获取通信频道
-      const channel = Constants.socketIo.channel.partySoftware;
-      this.client.emit(channel, { cmd: method, params: params }, (response) => {
-        resolve(response);
-      });
-    });
-  }
-
-  getCoreDB () {
-    const coreDB = Storage.connection('system');
-    return coreDB;
-  }
-
-  getSocketcPort () {
-    const cdb = this.getCoreDB();
-    const port = cdb.getItem('config').socketServer.port;
-    return parseInt(port);
-  }
-}
-
-module.exports = SocketClient;

package/module/socket/socketServer.js

@@ -1,76 +0,0 @@
-'use strict';
-
-const assert = require('assert');
-const { Server } = require('socket.io');
-const is = require('is-type-of');
-const Storage = require('../storage');
-const Constants = require('../const');
-const Log = require('../log');
-
-/**
- * socket server
- */
-class SocketServer {
-  constructor (app) {
-    this.app = app;
-    const options = this.app.config.socketServer;
-
-    if (!options.enable) {
-      return;
-    }
-
-    let port = process.env.EE_SOCKET_PORT ? parseInt(process.env.EE_SOCKET_PORT) : parseInt(this.getSocketPort());
-    assert(typeof port === 'number', 'socekt port required, and must be a number');
-    this.consoleLogger.info('[ee-core] [socket/socketServer] port is:', port);
-
-    // let opt = Object.assign({}, options);
-    // delete opt.enable;
-    this.io = new Server(port, options);
-    this.connec();
-  }
-
-  connec () {
-    const self = this;
-    this.io.on('connection', (socket) => {
-      const channel = Constants.socketIo.channel.partySoftware;
-      socket.on(channel, async (message, callback) => {
-        console.log('[ee-core] [socket/socketServer] socket id:' + socket.id + ' message cmd: ' + message.cmd);
-
-        try {
-          // 找函数
-          const cmd = message.cmd;
-          const args = message.params;
-          let fn = null;
-          if (is.string(cmd)) {
-            const actions = cmd.split('.');
-            let obj = self.app;
-            actions.forEach(key => {
-              obj = obj[key];
-              if (!obj) throw new Error(`class or function '${key}' not exists`);
-            });
-            fn = obj;
-          }
-          if (!fn) throw new Error('function not exists');
-
-          const result = await fn.call(self.app, args);
-          callback(result);
-        } catch (err) {
-          Log.coreLogger.error('[ee-core] [socket/socketServer] throw error:', err);
-        }
-      });
-    });
-  }
-
-  getCoreDB () {
-    const coreDB = Storage.connection('system');
-    return coreDB;
-  }
-
-  getSocketPort () {
-    const cdb = this.getCoreDB();
-    const port = cdb.getItem('config').socketServer.port;
-    return port;
-  }
-}
-
-module.exports = SocketServer;

package/module/socket/start.js

@@ -1,22 +0,0 @@
-'use strict';
-
-const SocketServer = require('./socketServer');
-const IpcServer = require('./ipcServer');
-const HttpServer = require('./httpServer');
-
-/**
- * server
- */
-module.exports = (app) => {
-
-  // 启动 socket server
-  new SocketServer(app);
-
-  // 启动 http server
-  new HttpServer(app);  
-
-  // 启动 electron ipc server
-  new IpcServer(app);
-
-}
-