gina 0.0.9-p91c → 0.1.1-alpha.11

package/framework/v0.1.1-alpha.11/lib/cmd/index.js

@@ -0,0 +1,170 @@
+'use strict';
+/**
+ * Gina.Utils.cmd
+ * Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, extend, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+var cmd = {};
+// cmd options
+cmd.option = [];
+
+
+/**
+ * Set option
+ *
+ * @param {array|string} option
+ * */
+cmd.setOption = function(option) {
+    if (option instanceof Array) {
+        for (var i=0; i<option.length; ++i) {
+            cmd.option[option[i].name] = option[i].content
+        }
+    } else {
+        cmd.option[options.name] = option.content
+    }
+}
+
+cmd.getString = function() {
+    var cmd = process.argv
+        .toString()
+        .replace(/,/g,' ')
+        .replace(/node\s/g, 'gina ');
+        //.replace(/node/g, 'gina');    
+    
+    var cmdArr = cmd.split('/');
+    cmd = cmdArr[cmdArr.length-1];
+    return cmd
+}
+
+
+/**
+ * Get option by name
+ *
+ * @param {string} name
+ *
+ * @returns {string|object} content
+ * */
+cmd.getOption = function(name) {
+    return cmd.option[name]
+}
+
+cmd.getOptions = function() {
+    return cmd.option
+}
+
+
+cmd.onExec = function(client, isFromFramework, opt) {
+    
+    var console = lib.logger;
+    cmd.option = opt;
+        
+    var Proc = require( getPath('gina').lib + '/proc');
+    var self = {};
+
+    cmd.msg = require( _(__dirname + '/framework/msg.json') );
+    self.isFromFramework = opt.isFromFramework || isFromFramework || false;
+    self.isOnlineCommand = opt.isOnlineCommand || false;
+
+    var ignore = function() {
+
+        if (!self.isFromFramework) {
+            var m = cmd.msg.default[0].replace("%command%", cmd.getString());
+            client.write(m)
+        }
+    };
+
+
+    var init = null;
+    if (self.isFromFramework) {
+        
+        init = require('./framework/init')(opt);
+        //Framework CMD.
+        if (opt.task.action == 'start') {
+            // Current version of the framework by default 
+            // But can be overriden with argument: @{version_number}
+            // eg.: gina stop @1.0.0
+            self.version = getEnvVar('GINA_VERSION');
+            // checkcking version number
+            if ( typeof(opt.argv[3]) != 'undefined' && /^@/.test(opt.argv[3]) ) {
+                var err = null;
+                var version = opt.argv[3].replace(/\@/, '');            
+                var shortVersion = version.split('.').splice(0,2).join('.');
+                if ( !/^\d\.\d/.test(shortVersion) ) {
+                    err = new Error('Wrong version: '+ version);
+                    console.log(err.message);
+                    return;
+                }
+                var availableVersions = requireJSON(_(getEnvVar('GINA_HOMEDIR') +'/main.json', true)).frameworks[shortVersion];
+                if ( availableVersions.indexOf(version) < 0 ) {
+                    err = new Error('Version not installed: '+ version);
+                    console.log(err.message);
+                    return;
+                }
+                
+                self.version = version;
+            }
+            
+            init.onComplete( function done(err, run){
+                console.debug('loading task `',  opt.task.topic +':'+ opt.task.action, '`');
+                
+                //Setting master process with its own PID file.                
+                cmd.proc = new Proc('gina-v' + self.version, process);
+                cmd.proc.setMaster(process.pid);
+
+                cmd.proc.onReady( function(err, pid){ //starting others
+
+                    if (!err) {
+                        console.debug('[ '+ pid +' ] registered');
+
+                        opt.pid = process.pid;
+                        run(opt)
+                    } else {
+                        console.error(err.stack)
+                    }
+
+                })
+            })
+        } else { // Offline CMD
+            init.onComplete( function done(err, run, opt){                
+                run(opt)
+            })
+        }
+
+    } else if (self.isOnlineCommand) {
+        var arr = opt.argv[2].split(':');
+        if ( typeof(opt.task) == 'undefined' ) {
+            opt.task = {}
+        }
+        opt.task.topic  = arr[0];
+        opt.task.action = arr[1];
+        
+        console.debug('[ FRAMEWORK ] is starting online CLI '+ arr[0] +':'+arr[1]);
+        
+        init = require('./framework/init')(opt);
+        init.onListen( function done(err, run, opt){            
+            run(opt, cmd)
+        })
+
+    } else {
+        ignore()
+    }
+};
+
+module.exports = cmd

package/framework/v0.1.1-alpha.11/lib/cmd/msg.json

@@ -0,0 +1,20 @@
+{
+    "default" : {
+        "0" : "Command not found : %command%",
+        "1" : "gina: argument(s) mismatch !\nTry this to get help: gina -h",
+        "2" : "Argument not found : %arg%"
+    },
+    "basic": {
+        "0" : "basic.help.txt",
+        "1" : "no argument found",
+        "2" : "illegal option",
+        "4" : "Gina Project v",
+        "5" : "Gina Framework not found! Please visite http://www.gina.io/ to get the latest version or try to run : npm install gina"
+    },
+    "app" : {
+        "1" : "%option%: option not found",
+        "2" : "Type %type% not found in command: %command%",
+        "3" : "Check documentation for the right syntax.\nSample command:\n$ gina --start <app_name> <env>",
+        "4" : "Bundle [%app%] not found. May be a problem with your build."
+    }
+}

package/framework/v0.1.1-alpha.11/lib/cmd/port/help.js

@@ -0,0 +1,28 @@
+var fs          = require('fs');
+
+var CmdHelper   = require('./../helper');
+var console     = lib.logger;
+
+/**
+ * Help
+ *
+ * */
+function Help(opt, cmd) {
+    var self = {};
+
+    var init = function() {
+
+        // import CMD helpers
+        new CmdHelper(self, opt.client, { port: opt.debugPort, brkEnabled: opt.debugBrkEnabled });
+
+        // check CMD configuration
+        if ( !isCmdConfigured() ) return false;
+
+
+        getHelp()
+    }
+
+    init()
+};
+
+module.exports = Help

package/framework/v0.1.1-alpha.11/lib/cmd/port/help.txt

@@ -0,0 +1,31 @@
+******************************
+* Port command lines e.g. *
+******************************
+
+
+[ Set a port number ]
+
+    Set or update a port number
+    ----------
+
+    To set a port for an existing bundle, use the following command line.
+    
+    Set default a port number for all your bundle's environments :
+    - If no <port_number> is entered, you will be prompted to enter a port number
+    - If no <protocol> is mentioned, you will be prompted to enter an existing protocol
+    - If no <environment> is mentioned, you will be prompted to enter an existing environment
+
+    $ gina port:set <bundle_name> @<project_name>
+
+    or
+
+    $ gina port:set <protocol>:<port_number> <bundle_name> @<project_name>/<environment>
+    
+        
+[ Listing port numbers ]
+
+    $ gina port:list <bundle_name> @<project_name>
+
+    or
+
+    $ gina port:list <bundle_name> @<project_name>/<environment>

package/framework/v0.1.1-alpha.11/lib/cmd/port/inc/scan.js

@@ -0,0 +1,108 @@
+var net     = require('net');
+var console = lib.logger;
+/**
+ * Scan for available port between ranges
+ *
+ * @param {object} [opt]
+ *
+ * @callback cb
+ *  @param {object|bool} err
+ *  @param {array} ports
+ * */
+module.exports = function Scanner(opt, cb){
+
+    var defaultOptions = {
+        // default binding for localhost
+        // remote scan can be added later if needed (e.g: for remote setup)
+        host: 'localhost',
+        start: 3100,
+        end: 3999,// max 65535,
+        timeout: 2000,
+        ignore: [],
+        limit: 1
+    };
+
+    if ( arguments.length < 2 ) {
+        console.warn('no options defined for your scan');
+        cb  = opt;
+        opt = defaultOptions;
+    } else {
+        opt = merge(opt, defaultOptions)
+    }
+
+    console.debug('scan init with options: ', opt);
+
+    var self    = opt
+        , port  = ~~self.start
+        , ports = []
+        , total = ~~opt.limit
+    ;
+
+    var find = function(port) {
+
+        if (port > self.end) { // not available port found
+            console.warn('found '+ ports.length +'/'+ total);
+            var err = new Error('maximum port number reached: '+ self.end);
+            cb(err);
+            return;
+        }
+        
+        // skip port present in the `ignore list`
+        if ( opt.ignore.length > 0 && opt.ignore.indexOf( ''+port ) > -1 ) {
+            port++;
+            find(port);
+            return;
+        }
+        
+        // creating socket
+        var s = new net.Socket();        
+
+        // starting connection
+        s.connect(port, self.host);
+        
+        // just in case
+        s.setTimeout(opt.timeout);
+        s.on('timeout', function() {
+            var err = new Error(self.timeout +' timeout reached');
+            s.destroy(err);
+            cb(err)
+        });
+        
+
+        // No one is listening ... port is available
+        s.on('error', function(err) {
+            s.destroy();   
+            // silently catch all errors - assume the port is closed => available for use
+            if ( /ECONNREFUSED/i.test(err.message) ) {                
+                if ( !opt.ignore.length || opt.ignore.length > 0 && opt.ignore.indexOf( ''+port ) == -1 ) {
+                    ports.push(''+port);
+                    console.debug('available port found '+ port +' ['+ ports.length +'/'+ total +']');
+                    opt.limit--;
+                }
+
+                if (opt.limit <= 0) {
+                    cb(false, ports);
+                } else {
+                    port++;
+                    find(port);
+                }
+                return;
+            } else if (err) {
+                // error not handled - not connection to the network ?
+                console.warn('exeption not handled: '+ err);
+                cb(err);
+                return;
+            } 
+        });
+        
+        // if connection is made, this only means that service is using it
+        s.on('connect', function() {
+            s.destroy();
+            
+            port++;
+            find(port);           
+        })
+    };
+
+    find(port)
+}

package/framework/v0.1.1-alpha.11/lib/cmd/port/list.js

@@ -0,0 +1,176 @@
+var fs = require('fs');
+
+var CmdHelper = require('./../helper');
+var console = lib.logger;
+
+/**
+ * List ports for a given bundle, a given project & a given env
+ *
+ * e.g.
+ *  gina port:list
+ *  gina port:list @<project_name>
+ *  gina port:list <bundle> @<project_name>
+ *
+ * */
+function List(opt, cmd) {
+
+    // self will be pre filled if you call `new CmdHelper(self, opt.client, { port: opt.debugPort, brkEnabled: opt.debugBrkEnabled })`
+    var self = {}, local = {};
+
+    var init = function() {
+
+        // import CMD helpers
+        new CmdHelper(self, opt.client, { port: opt.debugPort, brkEnabled: opt.debugBrkEnabled });
+
+        // check CMD configuration
+        if (!isCmdConfigured()) return false;
+
+
+        if (!self.name && !self.projectName) {
+            listAll()
+        } else if (self.projectName && isDefined(self.projectName) && !self.name) {
+            listProjectOnly()
+        } else if (typeof (self.name) != 'undefined' && isValidName(self.name)) {
+            listBundleOnly()
+        } else {
+            console.error('[ ' + self.name + ' ] is not a valid project name.');
+            process.exit(1)
+        }
+    }
+
+    //  check if bundle is defined
+    var isDefined = function(name) {
+        if (typeof (self.projects[name]) != 'undefined') {
+            return true
+        }
+        return false
+    }
+
+    var isValidName = function(name) {
+        if (name == undefined) return false;
+
+        self.name = name.replace(/\@/, '');
+        var patt = /^[a-z0-9_.]/;
+        return patt.test(self.name)
+    }
+
+
+    var listAll = function() {
+        
+        var protocols   = self.protocols
+            , schemes   = self.schemes
+            , projects  = self.projects
+            , list      = []
+            , p         = ''
+            , re        = null
+            , found     = false
+            , strTmp    = ''
+            , str       = '';
+
+        for (p in projects) {
+            list.push(p)
+        }
+        list.sort();
+
+        p = 0;
+        for (; p < list.length; ++p) {
+            
+            re = new RegExp('\@' + list[p] + '\/', '');// searching by projectName
+            str += '------------------------------------\n\r';
+            if (!projects[list[p]].exists || projects[list[p]].exists && protocols.length == 0) {
+                str += '?! '
+            }
+            str += list[p] + '\n\r';
+            str += '------------------------------------\n\r';
+            strTmp = '';
+            found = false;
+            for (var i = 0, len = protocols.length; i < len; ++i) {
+                
+                strTmp += '[ '+ protocols[i]+' ]\n\r';
+                for (var s = 0, sLen = schemes.length; s < sLen; ++s) {
+                    strTmp += '  [ '+ schemes[s]+' ]\n\r';
+                    
+                    for (var port in self.portsData[ protocols[i] ][ schemes[s] ]) {
+                        if (re.test(self.portsData[protocols[i]][schemes[s]][port]) ) {
+                            found = true;
+                            strTmp += '\n\r    - ' + port + '  ' + self.portsData[protocols[i]][schemes[s]][port].replace(re, ' (') + ')'
+                        }
+                    }                    
+                    strTmp += '\n\r'
+                }                
+                strTmp += '\n\r'
+            }
+            
+            if (found) {
+                str += strTmp
+            } 
+            
+            str += '\n\r'
+        }
+
+        console.log(str)
+    }
+
+    var listProjectOnly = function() {
+
+        var protocols = self.protocols
+            , schemes = self.schemes
+            , str = ''
+            , re = null;
+
+        for (var i = 0, len = protocols.length; i < len; ++i) {
+            str += '[ ' + protocols[i] + ' ]\n\r';
+            for (var s = 0, sLen = schemes.length; s < sLen; ++s) {
+                str += '  [ ' + schemes[s] + ' ]\n\r';
+                
+                re = new RegExp('\@' + self.projectName + '\/', '');// searching by projectName
+                for (var port in self.portsData[protocols[i]][schemes[s]]) {
+                    if (re.test(self.portsData[protocols[i]][schemes[s]][port])) {
+                        str += '\n\r    - ' + port + '  ' + self.portsData[protocols[i]][schemes[s]][port].replace(re, ' (') + ')'
+                    }
+                }
+                str += '\n\r'
+            }            
+            str += '\n\r'
+        }
+
+        console.log(str)
+    };
+
+    var listBundleOnly = function() {
+
+        var protocols   = self.protocols
+            , schemes   = self.schemes
+            , scheme    = null
+            , found     = false
+            , str       = ''
+            , re        = null;
+
+        for (var i = 0, len = protocols.length; i < len; ++i) {
+            str += '[ '+ protocols[i] +' ]\n\r';
+            for (var s = 0, sLen = schemes.length; s < sLen; ++s) {
+                found = false;
+                re = new RegExp('^' + self.name + '\@', '');// searching by bundle name
+                for (var port in self.portsData[protocols[i]][schemes[s]]) {
+                    if (re.test(self.portsData[protocols[i]][schemes[s]][port])) {
+                        str +=  '    ' +schemes[s]+ ' ' + port + '  ' + self.name + ' ' + self.portsData[protocols[i]][schemes[s]][port].replace(re, '').replace(/[-_a-z 0-9]+\//i, '(') + ')';
+                        found = true;
+                        break;
+                    }
+                }
+                
+                if (found) {
+                    str += '\n\r'
+                }
+                    
+            }            
+        }
+
+
+        console.log(str)
+    };
+
+    init()
+};
+
+module.exports = List