gamerpc 8.0.8 → 9.0.1

package/src/remote.js

@@ -0,0 +1,637 @@
+/**
+ * Remote - 远程连接器基类 (基于 V8.0.8 + HTTPS 支持)
+ * 
+ * 根据创建参数，可分别支持 WS、Socket、HTTP 三种常用通讯模式，
+ * 支持 Notify、JSONP、Watching 等报文通讯模式。
+ * 支持 LBS 重定向功能和 HTTPS 协议。
+ */
+const { stringify, NotifyType, extendObj, CommStatus, clone, ReturnCodeName, ReturnCode, CommMode, io } = require('./utils/util');
+const EventEmitter = require('events').EventEmitter;
+const Indicator = require('./utils/Indicator');
+
+class Remote {
+    constructor(options) {
+        this.rpcMode = CommMode.post;
+        this.loginMode = Indicator.inst();
+        this.configOri = options;                   //读取并保存初始配置，不会修改
+        this.config = clone(this.configOri);        //复制一份配置信息，有可能修改
+        this.notifyHandles = {};
+        this.userInfo = {};
+        //事件管理器
+        this.events = new EventEmitter();
+        //状态管理器
+        this.status = Indicator.inst(options.status);
+
+        //两阶段登录时，用户输入验证码时提交此事件
+        this.events.on('authcode', async code => {
+            console.log('gameconn: commit authcode', code);
+            await this.setSign(code).login();
+        })
+    }
+
+    /**
+     * 修改通讯模式
+     * @param {*} $mode     通讯模式
+     * @param {*} cb        建立连接时的回调
+     */
+    setmode($mode) {
+        this.rpcMode = $mode;
+        return this;
+    }
+
+    /**
+     * 创建通讯连接组件
+     * 支持直接 IP:Port 或通过 url 字段指定完整地址
+     */
+    async createSocket() {
+        let port = this.config.webserver.port;
+        let host = this.config.webserver.host;
+        let url = this.config.webserver.url;
+
+        this.close();
+
+        if(!url) {
+            this.socket = io(`${this.config.UrlHead}://${host}:${port}`, {'force new connection': true});
+        } else {
+            this.socket = io(`${this.config.UrlHead}://${url}`, {'force new connection': true});
+        }
+        this.socket.on('notify', ret => {//监听推送消息
+            if(this.notifyHandles[ret.type]) {
+                this.notifyHandles[ret.type](ret.info);
+            }
+            else if(!!this.notifyHandles['0']){
+                this.notifyHandles['0'](ret.info);
+            }
+        })
+        .on('disconnect', ()=>{//断线重连
+            console.log('gameconn: socket disconnected');
+            this.events.emit('comm', {status: 'disconnect'});
+            this.socket.needConnect = true;
+            setTimeout(()=>{
+                if(!!this.socket.needConnect) {
+                    this.socket.needConnect = false;
+                    this.socket.connect();
+                }
+            }, 1500);
+        }).on('connect', () => { //连接消息
+            console.log('gameconn: socket connected');
+            this.events.emit('comm', {status: 'connect'});
+        }).on('error', () => {
+            this.events.emit('comm', {status: 'error'});
+        });
+
+        let self = this;
+        let prom = new Promise(resolve => {
+            self.events.on('comm', async msg => {
+                if(msg.status == 'connect') {
+                    resolve();
+                }
+            })
+        });
+        return prom;
+    }
+
+    /**
+     * 获取签名数据集
+     */
+    async getSign() {
+        console.log('gameconn: getSign');
+        let router = this.userInfo.openid.split('.')[0];
+        let msg = await this.getRequest({}, router);
+
+        if(!msg) {
+            return false;
+        }
+
+        this.userInfo.auth = msg;
+
+        console.log('gameconn: getSign', msg);
+
+        return true;
+    }
+
+    /**
+     * 设置验证码
+     * @param {*} code 
+     */
+    setSign(code) {
+        if(!!this.userInfo) {
+            if(this.loginMode.check(CommStatus.reqSign)) {
+                this.status.set(CommStatus.signCode);
+                this.userInfo.auth = this.userInfo.auth || {};
+                this.userInfo.auth.captcha = code;
+            }
+        }
+        return this;
+    }
+
+    /**
+     * 登录并获得令牌
+     */
+    async getToken() {
+        if(!this.userInfo 
+            || (this.loginMode.check(CommStatus.reqLb) && !this.status.check(CommStatus.lb)) 
+            || (this.loginMode.check(CommStatus.reqSign) && !this.status.check(CommStatus.signCode)
+            || this.status.check(CommStatus.logined))
+        ) {
+            return false;
+        }
+
+        console.log('gameconn: getToken');
+        let msg = await this.fetching({
+            'func': 'login.UserLogin',
+            "oemInfo": this.userInfo,
+        });
+
+        if(!!msg) {
+            console.log('gameconn: getToken', msg.code);
+            if(msg.code == ReturnCode.Success && !!msg.data) {
+                if(typeof msg.data == 'object') {
+                    extendObj(this.userInfo, msg.data);
+                }
+                this.status.set(CommStatus.logined);
+                this.events.emit('logined', {code:0, data:{currentAuthority: this.userInfo.currentAuthority}});
+    
+                return true;
+            } else {
+                this.events.emit('logined', {code: msg.code});
+            }
+        } else {
+            console.log('gameconn: getToken failed');
+            this.events.emit('logined', {code:-1});
+        }
+        return false;
+    }
+
+    /**
+     * 清空先前的缓存状态
+     */
+    clearCache() {
+        if(this.userInfo) {
+            this.userInfo.token = null; 
+        }
+    }
+
+    /**
+     * 执行负载均衡流程
+     * @param {*} ui 
+     */
+    async setLB(force) {
+        if(!this.userInfo) {
+            return false;
+        }
+
+        if(!force && this.status.check(CommStatus.lb)) {
+            return true;
+        }
+
+        this.clearCache();
+        this.status.init();
+
+        console.log('gameconn: lb');
+        let msg = await this.locate(this.configOri.webserver.host, this.configOri.webserver.port, this.configOri.webserver.url).getRequest({"func": "lb.getServerInfo", "oemInfo":{"domain": this.userInfo.domain, "openid": this.userInfo.openid}});
+
+        if(!!msg && msg.code == ReturnCode.Success) {
+            console.log('gameconn: lb', msg.data);
+            this.status.set(CommStatus.lb);
+            this.locate(msg.data.ip, msg.data.port, msg.data.url);
+            return true;
+        }
+
+        console.log('gameconn: lb failed');
+        return false;
+    }
+
+    /**
+     * 登录流程
+     * @param {Object} options
+     * @param {Boolean} options.force 强制登录
+     */
+    async login(options) {
+        options = options || {};
+        if(options.force) {
+            this.clearCache();
+            this.status.init();
+        }
+
+        if(options.domain) {
+            let authmode = options.openid.split('.')[0];
+            switch(authmode) {
+                case 'bxs': {
+                    this.setUserInfo({
+                        domain: options.domain,
+                        openid: options.openid,
+                        openkey: options.openkey,
+                        auth: options.auth,
+                    }, CommStatus.reqLb);
+
+                    break;
+                }
+
+                case 'authwx': {
+                    this.setUserInfo({
+                        domain: options.domain,
+                        openkey: options.openkey,
+                    }, CommStatus.reqLb | CommStatus.reqOpenId);
+
+                    break;
+                }
+
+                case 'auth2step': {
+                    this.setUserInfo({
+                        domain: options.domain,
+                        openid: options.openid,
+                        openkey: options.openkey,
+                        addrType: options.addrType,
+                        address: options.address,
+                    }, CommStatus.reqLb | CommStatus.reqSign);
+
+                    break;
+                }
+
+                case 'authpwd': {
+                    this.setUserInfo({
+                        domain: options.domain,
+                        openid: options.openid,
+                        openkey: options.openkey,
+                    }, CommStatus.reqLb);
+
+                    break;
+                }
+
+                default: {
+                    this.setUserInfo({
+                        domain: options.domain || 'official',
+                        openid: options.openid,
+                        openkey: options.openkey,
+                    });
+                    break;
+                }
+            }
+        }
+
+        if(this.status.check(CommStatus.logined)) {
+            return false;
+        }
+
+        if(!this.userInfo) {
+            return false;
+        }
+
+        if(this.loginMode.check(CommStatus.reqLb)) {
+            if(!this.status.check(CommStatus.lb)) {
+                if(!(await this.setLB())) {
+                    throw(new Error('lb error'));
+                } else {
+                    this.status.set(CommStatus.lb);
+                }
+            }
+        }
+
+        if(this.loginMode.check(CommStatus.reqSign)) {
+            if(!this.status.check(CommStatus.sign)) {
+                if(!(await this.getSign())) {
+                    throw(new Error('get sign error'));
+                } else {
+                    this.status.set(CommStatus.sign);
+                    return true;
+                }
+            } else {
+                return await this.getToken();
+            }
+        } else {
+            return await this.getToken();
+        }
+    }
+
+    /**
+     * 设置用户信息
+     * @param {Object} ui {openid}
+     * @param {Number} st 登录流程描述符
+     */
+    setUserInfo(ui, st) {
+        this.userInfo = this.userInfo || {};
+
+        this.clearCache();
+
+        if(!!st) {
+            this.loginMode.init(st);
+        }
+
+        extendObj(this.userInfo, ui);
+
+        return this;
+    }
+
+    /**
+     * 设置服务端推送报文的监控句柄，支持链式调用
+     * @param cb            回调
+     * @param etype
+     * @returns {Remote}
+     */
+    watch(cb, etype = '0') {
+        this.notifyHandles[etype] = cb;
+        return this;
+    }
+    /**
+     * 移除监控句柄
+     * @param {*} etype 
+     */
+    unWatch(etype) {
+        if(!!this.notifyHandles[etype]) {
+            delete this.notifyHandles[etype];
+        }
+        return this;
+    }
+
+    /**
+     * 判断返回值是否成功
+     * @param msg       网络报文
+     * @param out       强制打印日志
+     * @returns {*}
+     */
+    isSuccess(msg, out=false) {
+        if(!msg) {
+            return false;
+        }
+
+        msg.msg = ReturnCodeName[msg.code];
+
+        if((msg.code != ReturnCode.Success) || out){
+            this.log(msg);
+        }
+
+        return msg.code == ReturnCode.Success;
+    }
+
+    /**
+     * 直接打印各种对象
+     * @param val
+     */
+    log(val){
+        if(!val){
+            console.log('undefined');
+            return;
+        }
+
+        if(!!val.code){
+            val.msg = ReturnCodeName[val.code];
+        }
+
+        switch(typeof val){
+            case 'number':
+            case 'string':
+            case 'boolean':
+                console.log(val);
+                break;
+            case 'function':
+                console.log(val());
+                break;
+            case 'undefined':
+                console.log('err: undefined');
+                break;
+            default:
+                console.log(JSON.stringify(val));
+                break;
+        }
+    }
+
+    get newone(){
+        return new Remote(this.configOri).setmode(this.rpcMode);
+    }
+
+    get new(){
+        return new Remote(this.configOri).setmode(this.rpcMode);
+    }
+
+    /**
+     * 等待指定时长
+     * @param {Number} time 等待时长(毫秒) 
+     */
+    async wait (time) {
+        await (async (time) => {return new Promise(resolve => {setTimeout(resolve, time);});})(time);
+    }
+
+    /**
+     * 为了提供node下的兼容性而添加的属性设定函数
+     * @param {*} fn 
+     */
+    setFetch(fn) {
+        this.fetch = fn;
+        return this;
+    }
+
+    /**
+     * 向服务端提交请求,默认JSONP模式
+     * @param params        命令参数，JSON对象
+     * @param callback      回调函数
+     * @returns {*}
+     */
+    async fetching(params) {
+        this.parseParams(params);
+
+        if(this.loginMode.check(CommStatus.reqLb) && !this.status.check(CommStatus.lb)) {
+            await this.setLB();
+        }
+
+        switch(this.rpcMode) {
+            case CommMode.ws:
+                if(!this.socket) {
+                    await this.createSocket();
+                }
+                return new Promise((resolve, reject) => {
+                    this.socket.emit('req', params, msg => {
+                        resolve(msg);
+                    });
+                });
+
+            case CommMode.get:
+                return this.getRequest(params);
+
+            case CommMode.post:
+                return this.postRequest(params);
+        }
+
+        return Promise.reject();
+    }
+
+    /**
+     * 设定远程服务器地址
+     * @param host
+     * @param port
+     * @param url   完整 URL 地址（用于 HTTPS 代理等场景）
+     * @returns {Remote}
+     */
+    locate(host, port, url) {
+        this.config.webserver.host = host;
+        this.config.webserver.port = port;
+        this.config.webserver.url = url;    
+
+        return this;
+    }
+
+    /**
+     * 关闭长连接
+     */
+    close() {
+        if(this.socket){
+            this.socket.removeAllListeners();
+            this.socket.disconnect();
+            this.socket = null;
+        }
+
+        return this;
+    }
+
+    /**
+     * 彻底清除连接器历史数据，包括通讯状态、运行数据缓存，只保留最原始的配置信息
+     */
+    init() {
+        this.close();
+
+        this.config = clone(this.configOri);
+        this.userInfo = {};
+        this.status.init();
+        this.loginMode.init();
+        
+        return this;
+    }
+
+    /**
+     * 参数调整
+     * @param params
+     */
+    parseParams(params) {
+        params.func = !!params.func ? params.func : 'index.login';
+        let arr = params.func.split('.');
+        if(arr.length > 1) {
+            params.control = arr[0];
+            params.action = arr[1];
+        } else {
+            params.action = arr[0];
+        }
+
+        params.oemInfo = {
+            domain: this.userInfo.domain,
+            openid: this.userInfo.openid,
+        };
+
+        if(this.userInfo.openkey) {
+            params.oemInfo.openkey = this.userInfo.openkey;
+        }
+        if(this.userInfo.token) {
+            params.oemInfo.token = this.userInfo.token;
+        }
+        if(this.userInfo.addrType) {
+            params.oemInfo.addrType = this.userInfo.addrType;
+        }
+        if(this.userInfo.address) {
+            params.oemInfo.address = this.userInfo.address;
+        }
+        if(this.userInfo.auth) {
+            params.oemInfo.auth = this.userInfo.auth;
+        }
+    }
+
+    /**
+     * 以 GET 方式访问远程API
+     * @param {*} url       远程地址
+     */
+    async get(url) {
+        const newOptions = { json: true, method: 'GET', mode: 'cors', };
+        
+        newOptions.headers = {
+            Accept: 'application/json',
+            'Content-Type': 'application/json; charset=utf-8',
+        };
+
+        if(this.fetch) {
+            let ret = await this.fetch(url, newOptions);
+            return await ret.json();
+        }
+        else {
+            let ret = await fetch(url, newOptions);
+            return await ret.json();
+        }
+    }
+
+    /**
+     * 以 POST 方式访问远程API
+     * @param {*} url       远程地址
+     * @param {*} options   body
+     */
+    async post(url, options) {
+        const newOptions = { json: true, method: 'POST', mode: 'cors', body: JSON.stringify(options) };
+        
+        newOptions.headers = {
+            Accept: 'application/json',
+            'Content-Type': 'application/json; charset=utf-8',
+        };
+
+        try {
+            if(this.fetch) {
+                let ret = await this.fetch(url, newOptions);
+                return await ret.json();
+            }
+            else {
+                let ret = await fetch(url, newOptions);
+                return await ret.json();
+            }
+        }
+        catch(e) {
+            console.error(e);
+        }
+    }
+  
+    /**
+     * (内部函数)发起基于Http协议的GET RPC请求
+     * @param params
+     */
+    async getRequest(params, authControl) {
+        this.parseParams(params);
+
+        let url = null;
+        if(!this.config.webserver.url) {
+            let port = !!params.port ? params.port : this.config.webserver.port;
+            url = !!authControl ? `${this.config.UrlHead}://${this.config.webserver.host}:${port}/${authControl}` : `${this.config.UrlHead}://${this.config.webserver.host}:${port}/index.html`;
+        } else {
+            url = !!authControl ? `${this.config.UrlHead}://${this.config.webserver.url}/${authControl}` : `${this.config.UrlHead}://${this.config.webserver.url}/index.html`;
+        }
+
+        url += "?" + Object.keys(params).reduce((ret, next)=>{
+            if(ret != '') { 
+                ret += '&';
+            }
+            return ret + next + "=" + ((typeof params[next]) == "object" ? encodeURIComponent(JSON.stringify(params[next])) : encodeURIComponent(params[next]));
+        }, '');
+
+        return this.get(url);
+    }
+
+    /**
+     * (内部函数)发起基于Http协议的POST RPC请求
+     * @param params
+     */
+    async postRequest(params, authControl) {
+        this.parseParams(params);
+
+        let url = null;
+        if(!this.config.webserver.url) {
+            let port = !!params.port ? params.port : this.config.webserver.port;
+            url = !!authControl ? `${this.config.UrlHead}://${this.config.webserver.host}:${port}/${authControl}` : `${this.config.UrlHead}://${this.config.webserver.host}:${port}/index.html`;
+        } else {
+            url = !!authControl ? `${this.config.UrlHead}://${this.config.webserver.url}/${authControl}` : `${this.config.UrlHead}://${this.config.webserver.url}/index.html`;
+        }
+
+        return this.post(url, params);
+    }
+}
+
+// 静态常量挂载（精简版，仅保留游戏云需要的）
+Remote.prototype.CommMode = CommMode;
+Remote.prototype.stringify = stringify;
+Remote.prototype.CommStatus = CommStatus;
+Remote.prototype.ReturnCode = ReturnCode;
+Remote.prototype.NotifyType = NotifyType;
+
+module.exports = Remote;