gina 0.1.1-alpha.16 → 0.1.1-alpha.161

package/framework/{v0.1.1-alpha.16 → v0.1.1-alpha.161}/lib/cmd/index.js

@@ -1,7 +1,7 @@
 'use strict';
 /**
  * Gina.Utils.cmd
- * Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
+ * Copyright (c) 2009-2023 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
@@ -37,7 +37,7 @@ cmd.setOption = function(option) {
             cmd.option[option[i].name] = option[i].content
         }
     } else {
-        cmd.option[options.name] = option.content
+        cmd.option[options.name] = option.content// jshint ignore:line
     }
 }
 
@@ -46,8 +46,8 @@ cmd.getString = function() {
         .toString()
         .replace(/,/g,' ')
         .replace(/node\s/g, 'gina ');
-        //.replace(/node/g, 'gina');    
-    
+        //.replace(/node/g, 'gina');
+
     var cmdArr = cmd.split('/');
     cmd = cmdArr[cmdArr.length-1];
     return cmd
@@ -71,14 +71,14 @@ cmd.getOptions = function() {
 
 
 cmd.onExec = function(client, isFromFramework, opt) {
-    
-    var console = lib.logger;
+
+    var console = lib.logger;// jshint ignore:line
     cmd.option = opt;
-        
-    var Proc = require( getPath('gina').lib + '/proc');
+
+    var Proc = require( getPath('gina').lib + '/proc');// jshint ignore:line
     var self = {};
 
-    cmd.msg = require( _(__dirname + '/framework/msg.json') );
+    cmd.msg = require( _(__dirname + '/framework/msg.json') );// jshint ignore:line
     self.isFromFramework = opt.isFromFramework || isFromFramework || false;
     self.isOnlineCommand = opt.isOnlineCommand || false;
 
@@ -93,38 +93,38 @@ cmd.onExec = function(client, isFromFramework, opt) {
 
     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 
+            // 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');
+            self.version = getEnvVar('GINA_VERSION');// jshint ignore:line
             // checkcking version number
             if ( typeof(opt.argv[3]) != 'undefined' && /^@/.test(opt.argv[3]) ) {
                 var err = null;
-                var version = opt.argv[3].replace(/\@/, '');            
+                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];
+                var availableVersions = requireJSON(_(getEnvVar('GINA_HOMEDIR') +'/main.json', true)).frameworks[shortVersion];// jshint ignore:line
                 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.                
+
+                //Setting master process with its own PID file.
                 cmd.proc = new Proc('gina-v' + self.version, process);
                 cmd.proc.setMaster(process.pid);
 
@@ -142,7 +142,7 @@ cmd.onExec = function(client, isFromFramework, opt) {
                 })
             })
         } else { // Offline CMD
-            init.onComplete( function done(err, run, opt){                
+            init.onComplete( function done(err, run, opt){
                 run(opt)
             })
         }
@@ -154,11 +154,11 @@ cmd.onExec = function(client, isFromFramework, opt) {
         }
         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){            
+        init.onListen( function done(err, run, opt){
             run(opt, cmd)
         })
 

package/framework/{v0.1.1-alpha.16 → v0.1.1-alpha.161}/lib/cmd/port/inc/scan.js

@@ -15,8 +15,11 @@ module.exports = function Scanner(opt, cb){
         // default binding for localhost
         // remote scan can be added later if needed (e.g: for remote setup)
         host: 'localhost',
+        startFrom: null,
         start: 3100,
-        end: 3999,// max 65535,
+        // max 65535, but user assigned == 49151 - see [RFC6335](https://www.rfc-editor.org/rfc/rfc6335.html)
+        end: null,
+        maxEnd: 49151,
         timeout: 2000,
         ignore: [],
         limit: 1
@@ -29,6 +32,17 @@ module.exports = function Scanner(opt, cb){
     } else {
         opt = merge(opt, defaultOptions)
     }
+    if (opt.startFrom) {
+        opt.startFrom = ~~opt.startFrom;
+        if (opt.start < opt.startFrom ) {
+            opt.start = opt.startFrom;
+        }
+    }
+    opt.end = (~~(opt.start)+899) // shouldn't it be opt.limit+1 ?
+
+    // just in caes
+    opt.end = ~~(opt.end);
+    opt.ignore.sort();
 
     console.debug('scan init with options: ', opt);
 
@@ -46,20 +60,19 @@ module.exports = function Scanner(opt, cb){
             cb(err);
             return;
         }
-        
+
         // skip port present in the `ignore list`
-        if ( opt.ignore.length > 0 && opt.ignore.indexOf( ''+port ) > -1 ) {
+        if ( opt.ignore.length > 0 && opt.ignore.indexOf( port ) > -1 ) {
             port++;
-            find(port);
-            return;
+            return find(port);
         }
-        
+
         // creating socket
-        var s = new net.Socket();        
+        var s = new net.Socket();
 
         // starting connection
         s.connect(port, self.host);
-        
+
         // just in case
         s.setTimeout(opt.timeout);
         s.on('timeout', function() {
@@ -67,15 +80,17 @@ module.exports = function Scanner(opt, cb){
             s.destroy(err);
             cb(err)
         });
-        
+
 
         // No one is listening ... port is available
         s.on('error', function(err) {
-            s.destroy();   
+            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);
+            if ( /ECONNREFUSED/i.test(err.message) ) {
+                if ( !opt.ignore.length || opt.ignore.length > 0 && opt.ignore.indexOf( port ) == -1 ) {
+                    // ports.push(''+port);
+                    ports.push(port);
+                    ports.sort();
                     console.debug('available port found '+ port +' ['+ ports.length +'/'+ total +']');
                     opt.limit--;
                 }
@@ -92,15 +107,15 @@ module.exports = function Scanner(opt, cb){
                 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.161/lib/cmd/port/list.js

@@ -0,0 +1,446 @@
+var fs = require('fs');
+
+var CmdHelper = require('./../helper');
+var console = lib.logger;
+var Collection = lib.Collection;
+
+/**
+ * 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>
+ *
+ * You can also filter
+ *  gina port:list @<project_name> --format=json,null,2 --protocol=http/2.0 --scheme=https --bundle=frontend,backend
+ *
+ *
+ * You can also export the output to a file with: `--filename`
+ *  gina port:list @<project_name> --format=conf --protocol=http/2.0 --scheme=https --filename=$HOME/my_ports.conf
+ * */
+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    = {
+            format: null
+            , formatOutReplacement: null
+            , formatOutSpacing: 0
+            , selectedProtocoles: null // array if assigned
+            , selectedSchemes: null // array if assigned
+            , selectedBundles: null // array if assigned
+            , filename: null
+        }
+        , 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;
+
+        var isListingAll = false;
+
+        for (let i=3, len=process.argv.length; i<len; i++) {
+            if ( /^\-\-format\=/.test(process.argv[i]) ) {
+                // e.g:
+                // --format=json
+                // --format=json,null,2
+                // --format=conf
+                let format  = process.argv[i].split(/\=/);
+                self.format = format[1]; // by default;
+                if ( /\,/.test(format[1]) ) {
+                    let formating = format[1].split(/\,/g);
+                    self.format = formating[0];
+                    self.formatOutReplacement = /^null$/i.test(formating[1]) ? null : formating[1] || null;
+                    self.formatOutSpacing = ~~formating[2] || 0;
+                }
+
+            }
+
+            if ( /^\-\-filename\=/.test(process.argv[i]) ) {
+                // e.g:
+                // --format=json --filename=$HOME/sample.json
+                self.filename = process.argv[i].split(/\=/)[1];
+            }
+
+            if ( /^\-\-protocol\=/.test(process.argv[i]) ) {
+                // e.g:
+                // --protocol=http/2.0,ftp
+                self.selectedProtocoles = process.argv[i].split(/\=/)[1].split(/\,/);
+                self.selectedProtocoles.sort();
+            }
+
+            if ( /^\-\-scheme\=/.test(process.argv[i]) ) {
+                // e.g:
+                // --scheme=https
+                self.selectedSchemes = process.argv[i].split(/\=/)[1].split(/\,/);
+                self.selectedSchemes.sort();
+            }
+
+            if ( /^\-\-bundle\=/.test(process.argv[i]) ) {
+                // e.g:
+                // --bundle=frontend,backend
+                self.selectedBundles = process.argv[i].split(/\=/)[1].split(/\,/);
+
+                if ( /\-\-debug\-ports\=/.test(process.argv.join(',')) ) {
+                    // e.g:
+                    // --debug-ports=5656,5858
+                    self.selectedDebugPorts = {};
+                    var selectedDebugPorts = process.argv.join(';');
+                    var found = selectedDebugPorts.match(/\-\-debug-ports\=[,0-9]+/);
+                    selectedDebugPorts = null;
+                    if (found) {
+                        selectedDebugPorts = found[0].split('\=')[1].split(',')
+                    }
+                    // console.log(selectedDebugPorts)
+                    for (let i = 0, len = self.selectedBundles.length; i<len; i++) {
+                        if ( typeof(selectedDebugPorts[i]) == 'undefined' ) {
+                            continue;
+                        }
+                        self.selectedDebugPorts[self.selectedBundles[i]] = ~~(selectedDebugPorts[i]);
+                    }
+                }
+            }
+
+
+
+            if ( /^\-\-all\=/.test(process.argv[i]) || !self.projectName ) {
+                isListingAll = true;
+            }
+        }
+
+
+        if (!self.name && !self.projectName || isListingAll) {
+            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 outputTo = function(data) {
+
+        var targetObj = null;
+        if (self.filename) {
+            targetObj = new _(self.filename);
+            if ( targetObj.existsSync() ) {
+                targetObj.rmSync()
+            }
+        }
+        if ( /^conf$/.test(self.format) ) {
+            if (typeof(data) != 'string' ) {
+                var str = '', i = 0, len = data.length;
+                while (i<len) {
+                    let d = data[i];
+                    str += d.env +'_'+ d.bundle +'_'+ d.protocol +'_'+ d.scheme +'='+ d.port +':'+ d.port +'\n';
+                    // Adding debug port
+                    if (
+                        typeof(self.selectedDebugPorts) != 'undefined'
+                        && typeof(self.selectedDebugPorts[d.bundle]) != 'undefined'
+                    ) {
+                        str += d.env +'_'+ d.bundle +'_debug_port='+ d.debug_port +':'+ d.debug_port +'\n';
+                    }
+                    i++;
+                }
+
+                data = str.replace(/\n$/, '');
+            }
+
+            if (self.filename) {
+                var filename = targetObj.toString();
+                // save to ~/.gina/ports.reverse.json
+                lib.generator.createFileFromDataSync( data, filename );
+                console.log('Saved to `'+ filename +'`');
+                return;
+            }
+
+            return process.stdout.write(data);
+        }
+
+        if ( /^json$/.test(self.format) ) {
+            data = JSON.stringify(data, self.formatOutReplacement, self.formatOutSpacing);
+
+            if (self.filename) {
+                var filename = targetObj.toString();
+                // save to ~/.gina/ports.reverse.json
+                lib.generator.createFileFromDataSync( data, filename );
+                console.log('Saved to `'+ filename +'`');
+                return;
+            }
+
+            return process.stdout.write(data);
+        }
+
+
+
+        console.log(data)
+    }
+
+
+    var listAll = function() {
+
+        var projects  = self.projects
+            , list      = []
+            , p         = null
+            , re        = null
+            , found     = false
+            , strTmp    = ''
+            , str       = ''
+        ;
+
+        for (p in projects) {
+            list.push(p)
+        }
+        list.sort();
+
+        var jsonCollection =  new Collection([]);
+        p = 0;
+        for (; p < list.length; ++p) {
+            let projectName = list[p];
+            let project     = projects[projectName];
+            let protocols   = project.protocols;
+            let schemes     = project.schemes;
+
+            re = new RegExp('\@' + projectName + '\/', '');// searching by projectName
+            str += '------------------------------------\n\r';
+            if (!project.exists || project.exists && protocols.length == 0) {
+                str += '?! '
+            }
+            str += projectName + '\n\r';
+            str += '------------------------------------\n\r';
+            strTmp = '';
+            found = false;
+            for (let i = 0, len = protocols.length; i < len; ++i) {
+                let protocol = protocols[i];
+                if (
+                    self.selectedProtocoles
+                    && self.selectedProtocoles.indexOf(protocol) < 0
+                ) {
+                    continue;
+                }
+
+                strTmp += '[ '+ protocol +' ]\n\r';
+                for (let s = 0, sLen = schemes.length; s < sLen; ++s) {
+                    let scheme = schemes[s];
+                    if (
+                        self.selectedSchemes
+                        && self.selectedSchemes.indexOf(scheme) < 0
+                    ) {
+                        continue;
+                    }
+                    strTmp += '  [ '+ scheme +' ]\n\r';
+
+                    for (let port in self.portsData[ protocol ][ scheme ]) {
+                        let bundleEnv = self.portsData[protocols[i]][scheme][port].replace(re, ':').split(/\:/);
+                        let _bundle = bundleEnv[0];
+                        let _env = bundleEnv[1];
+                        if (_bundle && self.selectedBundles && self.selectedBundles.indexOf(_bundle.split(/\@/)[0]) < 0) {
+                            continue;
+                        }
+
+                        let re2 = new RegExp(_bundle +'\@' + projectName + '\/'+ _env, '');// searching by projectName
+                        // if (re.test(self.portsData[protocol][scheme][port]) ) {
+                        if (re2.test(self.portsData[protocol][scheme][port])) {
+                            found = true;
+                            strTmp += '\n\r    - ' + port + '  ' + self.portsData[protocol][scheme][port].replace(re, ' (') + ')';
+
+                            let jsonPort  = {protocol: protocol, project: projectName};
+                            jsonPort.scheme = scheme;
+                            jsonPort.port = ~~port;
+                            jsonPort.bundle = _bundle;
+                            jsonPort.env = _env;
+                            // Adding debug port
+                            if (
+                                typeof(self.selectedDebugPorts) != 'undefined'
+                                && typeof(self.selectedDebugPorts[_bundle]) != 'undefined'
+                            ) {
+                                jsonPort.debug_port = self.selectedDebugPorts[_bundle];
+                            }
+
+                            if ( !jsonCollection.findOne({ "port": ~~port }) ) {
+                                jsonCollection = jsonCollection.insert(jsonPort);
+                            }
+                        }
+                    }
+                    strTmp += '\n\r'
+                }
+                strTmp += '\n\r'
+            }
+
+            if (found) {
+                str += strTmp
+            }
+
+            str += '\n\r'
+        }
+
+        if ( /^(conf|json)$/.test(self.format) ) {
+            str = jsonCollection.orderBy({env: 'asc'}, {bundle: 'asc'}).toRaw();
+        }
+
+        outputTo(str);
+    }
+
+    var listProjectOnly = function() {
+
+        var protocols   = self.protocols
+            , schemes   = self.schemes
+            , str       = ''
+            , re        = null
+        ;
+
+        var jsonCollection =  new Collection([]);
+        for (let i = 0, len = protocols.length; i < len; ++i) {
+            let protocol = protocols[i];
+            if (
+                self.selectedProtocoles
+                && self.selectedProtocoles.indexOf(protocol) < 0
+            ) {
+                continue;
+            }
+            str += '[ ' + protocol + ' ]\n\r';
+            for (let s = 0, sLen = schemes.length; s < sLen; ++s) {
+                let scheme = schemes[s];
+                if (
+                    self.selectedSchemes
+                    && self.selectedSchemes.indexOf(scheme) < 0
+                ) {
+                    continue;
+                }
+                str += '  [ ' + scheme + ' ]\n\r';
+                re = new RegExp('\@' + self.projectName + '\/', '');// searching by projectName
+                for (let port in self.portsData[protocol][scheme]) {
+                    let bundleEnv = self.portsData[protocol][scheme][port].replace(re, ':').split(/\:/);
+                    let _bundle = bundleEnv[0];
+                    let _env = bundleEnv[1];
+                    if (_bundle && self.selectedBundles && self.selectedBundles.indexOf(_bundle.split(/\@/)[0]) < 0) {
+                        continue;
+                    }
+
+                    let re2 = new RegExp(_bundle +'\@' + self.projectName + '\/'+ _env, '');// searching by projectName
+                    if (re2.test(self.portsData[protocol][scheme][port])) {
+
+                        str += '\n\r    - ' + port + '  ' + self.portsData[protocol][scheme][port].replace(re, ' (') + ')';
+
+                        let jsonPort  = {protocol: protocol, project: self.projectName};
+                        jsonPort.scheme = scheme;
+                        jsonPort.port = ~~port;
+                        jsonPort.bundle = _bundle;
+                        jsonPort.env = _env;
+                        // Adding debug port
+                        if (
+                            typeof(self.selectedDebugPorts) != 'undefined'
+                            && typeof(self.selectedDebugPorts[_bundle]) != 'undefined'
+                        ) {
+                            jsonPort.debug_port = self.selectedDebugPorts[_bundle];
+                        }
+                        if ( !jsonCollection.findOne({ "port": ~~port }) ) {
+                            jsonCollection = jsonCollection.insert(jsonPort);
+                        }
+                    }
+                }
+                str += '\n\r';
+            }
+            str += '\n\r';
+
+        }
+
+        if ( /^(conf|json)$/.test(self.format) ) {
+            str = jsonCollection.orderBy({env: 'asc'}, {bundle: 'asc'}).toRaw();
+        }
+
+        outputTo(str);
+    };
+
+    var listBundleOnly = function() {
+
+        var protocols   = self.protocols
+            , schemes   = self.schemes
+            , found     = false
+            , str       = ''
+            , re        = null
+        ;
+
+        var jsonCollection =  new Collection([]);
+        for (let i = 0, len = protocols.length; i < len; ++i) {
+            let protocol = protocols[i];
+            str += '[ '+ protocol +' ]\n\r';
+            for (let s = 0, sLen = schemes.length; s < sLen; ++s) {
+                let scheme = schemes[s];
+                let bundle = self.name;
+                found = false;
+                // re = new RegExp('^' + bundle + '\@', '');// searching by bundle name
+                re = new RegExp('^' + bundle + '\@' + self.projectName + '\/', '');// searching by projectName
+                for (let port in self.portsData[protocol][scheme]) {
+
+                    let bundleEnv = self.portsData[protocol][scheme][port].replace(re, '\:').split(/\:/);
+                    let _bundle = bundleEnv[0] || bundle;
+                    let _env = bundleEnv[1];
+
+                    let re2 = new RegExp(_bundle +'\@' + self.projectName + '\/'+ _env, '');// searching by <bundle>@<projectName>
+                    if (re2.test(self.portsData[protocol][scheme][port])) {
+                        str +=  '    ' +scheme+ ' ' + port + '  ' + bundle + ' ' + self.portsData[protocol][scheme][port].replace(re, '').replace(/[-_a-z 0-9]+\//i, '(') + ')';
+                        found = true;
+
+                        let jsonPort  = {protocol: protocol, project: self.projectName};
+                        jsonPort.scheme = scheme;
+                        jsonPort.port = ~~port;
+                        jsonPort.bundle = _bundle;
+                        jsonPort.env = _env;
+                        // Adding debug port
+                        if (
+                            typeof(self.selectedDebugPorts) != 'undefined'
+                            && typeof(self.selectedDebugPorts[_bundle]) != 'undefined'
+                        ) {
+                            jsonPort.debug_port = self.selectedDebugPorts[_bundle];
+                        }
+                        if ( !jsonCollection.findOne({ "port": ~~port }) ) {
+                            jsonCollection = jsonCollection.insert(jsonPort);
+                        }
+
+                        break;
+                    }
+                }
+
+                if (found) {
+                    str += '\n\r'
+                }
+
+            }
+        }
+
+        if ( /^(conf|json)$/.test(self.format) ) {
+            str = jsonCollection.orderBy({env: 'asc'}, {bundle: 'asc'}).toRaw();
+        }
+
+        outputTo(str);
+    };
+
+    init()
+};
+
+module.exports = List