ee-core 2.9.2 → 2.10.0

package/services/baseContextClass.js

@@ -1,34 +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;
+'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

@@ -1,41 +1,41 @@
-const EE = require('../ee');
-
-const Services = {
-
-  /**
-   * 获取 all addon instances
-   */  
-  all() {
-    const { CoreApp } = EE;
-    if (!CoreApp) {
-      throw new Error('An unknown error or Services cannot be used by the jobs!');
-    }
-
-    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 actions = name.split('.');
-    let obj = instances;
-    actions.forEach(key => {
-      obj = obj[key];
-    });
-
-    if (!obj) {
-      throw new Error(`Service class '${name}' not exists or do not call directly at the top!`);
-    };
-    return obj;
-  },
-
-};
-
+const EE = require('../ee');
+
+const Services = {
+
+  /**
+   * 获取 all addon instances
+   */  
+  all() {
+    const { CoreApp } = EE;
+    if (!CoreApp) {
+      throw new Error('An unknown error or Services cannot be used by the jobs!');
+    }
+
+    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 actions = name.split('.');
+    let obj = instances;
+    actions.forEach(key => {
+      obj = obj[key];
+    });
+
+    if (!obj) {
+      throw new Error(`Service class '${name}' not exists or do not call directly at the top!`);
+    };
+    return obj;
+  },
+
+};
+
 module.exports = Services;

package/socket/httpServer.js

@@ -1,147 +1,147 @@
-'use strict';
-
-const assert = require('assert');
-const is = require('is-type-of');
-const Koa = require('koa');
-const cors = require('koa2-cors');
-const koaBody = require('koa-body');
-const https = require('https');
-const fs = require('fs');
-const path = require('path');
-const _ = require('lodash');
-const Log = require('../log');
-const Ps = require('../ps');
-
-/**
- * http server
- */
-class HttpServer {
-  constructor (app) {
-    this.app = app;
-    this.options = this.app.config.httpServer;
-
-    if (this.options.enable == false) {
-      return;
-    }
-
-    let port = Ps.getHttpPort();
-    if (!port) {
-      throw new Error('[ee-core] [socket/HttpServer] http port required, and must be a number !');
-    }
-
-    this._create();
-  }
-
-  /**
-   * 创建服务
-   */
-  _create () {
-    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(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');
-
-      sslOptions.key = fs.readFileSync(keyFile);
-      sslOptions.cert = fs.readFileSync(certFile);
-    }
-    const url = httpServer.protocol + httpServer.host + ':' + httpServer.port;
-    const corsOptions = httpServer.cors;
-
-    const koaApp = new Koa();
-    koaApp
-      .use(cors(corsOptions))
-      .use(koaBody(httpServer.body))
-      .use(async (ctx, next) => {
-        ctx.eeApp = app;
-        await next();
-      })
-      .use(this._dispatch);
-
-    let msg = '[ee-core] [socket/http] server is: ' + url;
-
-    const listenOpt = {
-      host: httpServer.host,
-      port: httpServer.port
-    }
-    if (isHttps) {
-      https.createServer(sslOptions, koaApp.callback()).listen(listenOpt, (err) => {
-        msg = err ? err : msg;
-        Log.coreLogger.info(msg);
-      });
-    } else {
-      koaApp.listen(listenOpt, (e) => {
-        msg = e ? e : msg;
-        Log.coreLogger.info(msg);
-      });
-    }  
-  }
-
-  /**
-   * 路由分发
-   */
-  async _dispatch (ctx, next) {
-    const config = ctx.eeApp.config.httpServer;
-    let uriPath = ctx.request.path;
-    const method = ctx.request.method;
-    let params = ctx.request.query;
-    params = is.object(params) ? JSON.parse(JSON.stringify(params)) : {};
-    const body = ctx.request.body;
-    const files = ctx.request.files;
-
-    // 默认
-    ctx.response.status = 200;
-
-    // 添加到全局属性
-    ctx.eeApp.request = ctx.request;
-    ctx.eeApp.response = ctx.response;
-
-    try {
-      // 找函数
-      // 去除开头的 '/'
-      if (uriPath.indexOf('/') == 0) {
-        uriPath = uriPath.substring(1);
-      }
-      // 过滤
-      if (_.includes(config.filterRequest.uris, uriPath)) {
-        ctx.response.body = config.filterRequest.returnData;
-        await next();
-        return
-      }
-      if (uriPath.slice(0, 10) != 'controller') {
-        uriPath = 'controller/' + uriPath;
-      }
-      const cmd = uriPath.split('/').join('.');
-      const args = (method == 'POST') ? (ctx.request.header['content-type'] && ctx.request.header['content-type'].startsWith('multipart/form-data;') ? files : body) : params;
-      args.files = ctx.request.files;
-      args.body = ctx.request.body;
-      args.query = ctx.request.query;
-      let fn = null;
-      if (is.string(cmd)) {
-        const actions = cmd.split('.');
-        let obj = ctx.eeApp;
-        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(ctx.eeApp, args);
-      ctx.response.body = result;
-    } catch (err) {
-      Log.coreLogger.error('[ee-core/httpServer] throw error:', err);
-    }
-
-    await next();
-  }
-}
-
-module.exports = HttpServer;
+'use strict';
+
+const assert = require('assert');
+const is = require('is-type-of');
+const Koa = require('koa');
+const cors = require('koa2-cors');
+const koaBody = require('koa-body');
+const https = require('https');
+const fs = require('fs');
+const path = require('path');
+const _ = require('lodash');
+const Log = require('../log');
+const Ps = require('../ps');
+
+/**
+ * http server
+ */
+class HttpServer {
+  constructor (app) {
+    this.app = app;
+    this.options = this.app.config.httpServer;
+
+    if (this.options.enable == false) {
+      return;
+    }
+
+    let port = Ps.getHttpPort();
+    if (!port) {
+      throw new Error('[ee-core] [socket/HttpServer] http port required, and must be a number !');
+    }
+
+    this._create();
+  }
+
+  /**
+   * 创建服务
+   */
+  _create () {
+    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(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');
+
+      sslOptions.key = fs.readFileSync(keyFile);
+      sslOptions.cert = fs.readFileSync(certFile);
+    }
+    const url = httpServer.protocol + httpServer.host + ':' + httpServer.port;
+    const corsOptions = httpServer.cors;
+
+    const koaApp = new Koa();
+    koaApp
+      .use(cors(corsOptions))
+      .use(koaBody(httpServer.body))
+      .use(async (ctx, next) => {
+        ctx.eeApp = app;
+        await next();
+      })
+      .use(this._dispatch);
+
+    let msg = '[ee-core] [socket/http] server is: ' + url;
+
+    const listenOpt = {
+      host: httpServer.host,
+      port: httpServer.port
+    }
+    if (isHttps) {
+      https.createServer(sslOptions, koaApp.callback()).listen(listenOpt, (err) => {
+        msg = err ? err : msg;
+        Log.coreLogger.info(msg);
+      });
+    } else {
+      koaApp.listen(listenOpt, (e) => {
+        msg = e ? e : msg;
+        Log.coreLogger.info(msg);
+      });
+    }  
+  }
+
+  /**
+   * 路由分发
+   */
+  async _dispatch (ctx, next) {
+    const config = ctx.eeApp.config.httpServer;
+    let uriPath = ctx.request.path;
+    const method = ctx.request.method;
+    let params = ctx.request.query;
+    params = is.object(params) ? JSON.parse(JSON.stringify(params)) : {};
+    const body = ctx.request.body;
+    const files = ctx.request.files;
+
+    // 默认
+    ctx.response.status = 200;
+
+    // 添加到全局属性
+    ctx.eeApp.request = ctx.request;
+    ctx.eeApp.response = ctx.response;
+
+    try {
+      // 找函数
+      // 去除开头的 '/'
+      if (uriPath.indexOf('/') == 0) {
+        uriPath = uriPath.substring(1);
+      }
+      // 过滤
+      if (_.includes(config.filterRequest.uris, uriPath)) {
+        ctx.response.body = config.filterRequest.returnData;
+        await next();
+        return
+      }
+      if (uriPath.slice(0, 10) != 'controller') {
+        uriPath = 'controller/' + uriPath;
+      }
+      const cmd = uriPath.split('/').join('.');
+      const args = (method == 'POST') ? (ctx.request.header['content-type'] && ctx.request.header['content-type'].startsWith('multipart/form-data;') ? files : body) : params;
+      args.files = ctx.request.files;
+      args.body = ctx.request.body;
+      args.query = ctx.request.query;
+      let fn = null;
+      if (is.string(cmd)) {
+        const actions = cmd.split('.');
+        let obj = ctx.eeApp;
+        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(ctx.eeApp, args);
+      ctx.response.body = result;
+    } catch (err) {
+      Log.coreLogger.error('[ee-core/httpServer] throw error:', err);
+    }
+
+    await next();
+  }
+}
+
+module.exports = HttpServer;

package/socket/index.js

@@ -1,82 +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;
-  },   
-
-}
-
-
+'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/socket/io.js

@@ -1,28 +1,28 @@
-'use strict';
-
-/**
- * 该文件将废弃
- */
-
-const IoServer = require('socket.io');
-const IoClient = require('socket.io-client');
-//const socketServer = require('./socketServer');
-// const socketClient = require('./socketClient');
-const Koa = require('koa');
-
-const EeSocket = {
-  getServer: () => {
-    //return socketServer.getInstance();
-  },
-  getClient: () => {
-    //return socketClient.getInstance();
-  }
-}
-
-
-module.exports = {
-  IoServer,
-  IoClient,
-  EeSocket,
-  Koa
+'use strict';
+
+/**
+ * 该文件将废弃
+ */
+
+const IoServer = require('socket.io');
+const IoClient = require('socket.io-client');
+//const socketServer = require('./socketServer');
+// const socketClient = require('./socketClient');
+const Koa = require('koa');
+
+const EeSocket = {
+  getServer: () => {
+    //return socketServer.getInstance();
+  },
+  getClient: () => {
+    //return socketClient.getInstance();
+  }
+}
+
+
+module.exports = {
+  IoServer,
+  IoClient,
+  EeSocket,
+  Koa
 };