gina 0.1.1-alpha.92 → 0.1.1-alpha.95

package/script/post_install.js

@@ -16,17 +16,57 @@ const { execSync } = require('child_process');
 var isWin32 = function() {
     return (process.platform === 'win32') ? true : false;
 };
+var isWritableSync = function(path) {
+        var canWrite = false;
+        if ( fs.accessSync && typeof(fs.accessSync) != 'undefined' ) {
+            try {
+                fs.accessSync(path, fs.constants.W_OK);
+                canWrite = true;
+            } catch (err) {
+                canWrite = false;
+            }
+        } else { // support for old version of nodejs
+
+            try {
+                canWrite = (fs.statSync(path).mode & (fs.constants.S_IRUSR | fs.constants.S_IRGRP | fs.constants.S_IROTH));
+            } catch (err) {
+                canWrite = false
+            }
+        }
+
+        return canWrite
+    };
+var getUserHome = function() {
+    var home = os.homedir ? os.homedir : function() {
+        var homeDir = process.env[(isWin32()) ? 'USERPROFILE' : 'HOME'];
+
+        if ( !homeDir || homeDir == '' ) {
+            throw new Error('Home directory not defined or not found !');
+        }
+
+        if ( !isWritableSync(homeDir) ) {
+            throw new Error('Home directory found but not writable: need permissions for `'+ homeDir +'`');
+        }
+
+        return homeDir;
+    };
+
+    return home()
+};
+
 // just in case `post_install` is called by hand
 var initialDir = process.cwd();
 var frameworkPath   = __dirname +'/..';
 if ( !fs.existsSync(frameworkPath +'/node_modules/colors') ) {
     process.chdir(frameworkPath);
+
     var oldConfigGlobal = process.env.npm_config_global;
     process.env.npm_config_global=false;
     var cmd = ( isWin32() ) ? 'npm.cmd install colors@1.4.0' : 'npm install colors@1.4.0';
     execSync(cmd);
-    process.chdir(initialDir);
     process.env.npm_config_global=oldConfigGlobal;
+
+    process.chdir(initialDir);
 }
 
 var lib         = require('./lib');
@@ -46,79 +86,196 @@ var helpers = null;
  * */
 function PostInstall() {
 
-    var self = {}, _this = this;
+    var self = {};
 
-    //Initialize post installation scripts.
-    var init = function() {
-        self.isWin32 = isWin32();//getEnvVar('GINA_IS_WIN32');
-        self.path = getEnvVar('GINA_FRAMEWORK');
-        self.gina = getEnvVar('GINA_DIR');
-        self.root = self.gina; // by default
-        self.isGlobalInstall = false;
-        self.prefix = process.env.npm_config_prefix || execSync('npm config get prefix').toString().replace(/\n/g, '');
-        self.isCustomPrefix = false;
+    var configure = function() {
+
+        // TODO - handle windows case
+        if ( /^true$/i.test(isWin32()) ) {
+            throw new Error('Windows in not yet fully supported. Thank you for your patience');
+        }
+
+        self.isWin32            = isWin32();
+        self.isGlobalInstall    = process.env.npm_config_global || false;
+        self.isResetNeeded      = process.env.npm_config_reset || false;
+        self.defaultPrefix      = execSync('npm config get prefix').toString().replace(/\n$/g, '');
+        var pkg = null;
+        try {
+            pkg = execSync('npm list -g gina --long --json').toString().replace(/\n$/g, '');
+        } catch(err) {
+            throw err
+        }
+        self.optionalPrefix     = JSON.parse(pkg).dependencies.gina.config.optionalPrefix.replace(/^\~/, getUserHome());
 
+        // `process.env.npm_config_prefix` is only retrieved on `npm install gina`
+        // and it should always be equal to `self.defaultPrefix`
+        self.prefix             = process.env.npm_config_prefix || self.defaultPrefix;
+        self.isCustomPrefix     = false;
+        self.isGinaInstalled    = false;
+
+        // Overriding thru passed arguments
         var args = process.argv, i = 0, len = args.length;
         for (; i < len; ++i) {
             if ( /^(\-g|\-\-global)$/.test(args[i]) ) {
                 self.isGlobalInstall = true;
                 continue;
             }
+
+            if ( /^\-\-reset$/.test(args[i]) ) {
+                self.isResetNeeded = true;
+                continue;
+            }
+
             if ( /^\-\-prefix\=/.test(args[i] ) ) {
                 self.isCustomPrefix = true;
                 self.prefix = args[i].split(/\=/)[1];
+                self.prefix = self.prefix.replace(/^\~/, getUserHome());
                 continue;
             }
         }
 
-        if (
-            // process.env.npm_config_prefix
-            // &&
-            self.prefix != process.env.npm_config_prefix
-        ) {
-            // self.prefix = process.env.npm_config_prefix;
-            self.isCustomPrefix = true;
+        // For local install
+        console.debug('self.isGlobalInstall => '+ self.isGlobalInstall);
+        if ( !self.isGlobalInstall ) {
+            console.warn('Local installation is not fully supported at the moment.');
+            console.warn('You are encouraged to use `npm install -g gina`\nor, if you are trying to link gina to your project, use `npm link gina` if Gina has already been installed globally\n');
+            // Just in case someone is trying to run pre_install from the `gina` module
+            if (!/node\_modules(\\\\|\/)gina$/.test(process.cwd())) {
+                self.prefix = process.cwd();
+            }
         }
 
-        if ( !self.isGlobalInstall ) { // none global install
-            // process.env.npm_config_prefix = process.cwd();
-            self.prefix = process.cwd();
-            // self.root = process.cwd(); // project path
-            // console.error('local installation is not supported for this version at the moment.');
-            // console.info('please use `npm install -g gina`');
-            // process.exit(1);
+        // checking permission
+        var hasPermissionsForBin = isWritableSync(self.prefix + ( isWin32() ? '\\' : '/' ) + 'bin');
+        var hasPermissionsForLib = isWritableSync(self.prefix + ( isWin32() ? '\\' : '/' ) + 'lib');
+        var hasPermissionsForVar = isWritableSync(self.prefix + ( isWin32() ? '\\' : '/' ) + 'var');
+        if ( !hasPermissionsForBin || !hasPermissionsForLib || !hasPermissionsForVar) {
+            if (!hasPermissionsForBin) {
+                console.warn('Path not accessible or missing: '+ self.prefix + ( isWin32() ? '\\' : '/' ) + 'bin')
+            }
+            if (!hasPermissionsForLib) {
+                console.warn('Path not accessible or missing: '+ self.prefix + ( isWin32() ? '\\' : '/' ) + 'lib')
+            }
+            if (!hasPermissionsForVar) {
+                console.warn('Path not accessible or missing: '+ self.prefix + ( isWin32() ? '\\' : '/' ) + 'var')
+            }
+
+            console.warn('You do not have sufficient permissions. Switching to `--prefix='+ self.optionalPrefix +'`');
+            process.env.npm_config_prefix = self.prefix = self.optionalPrefix;
         }
-        // setEnvVar('GINA_PREFIX', self.prefix); // for the `helper.js`
 
-        // check for ~/.gina (first installation ?)
-        var ginaHomeDir = getUserHome() + ( isWin32() ? '\\.gina' : '/.gina' );
-        self.version = require( self.gina + ( isWin32() ? '\\' : '/' ) +'package.json' ).version;
-        self.shortVersion = self.version.split('.');
-        self.shortVersion.splice(2);
-        self.shortVersion = self.shortVersion.join('.');
+        if ( self.prefix != self.defaultPrefix ) {
+            self.isCustomPrefix = true;
+        }
 
+        self.gina = __dirname +'/..';
+        // tying to figure out if gina is already install the given prefix
+        var hasFoundGina = pkg;
+        try {
+            hasFoundGina = JSON.parse(hasFoundGina);
+            if ( hasFoundGina.dependencies && typeof(hasFoundGina.dependencies.gina) != 'undefined' ) {
+                self.isGinaInstalled = true;
+                self.versionPath = self.gina;
+                self.versionPath += (isWin32()) ? '\\framework\\' : '/framework/';
+                self.version = hasFoundGina.dependencies.gina.version;
+                self.versionPath += 'v'+ self.version;
+
+                self.shortVersion = self.version.split('.');
+                self.shortVersion.splice(2);
+                self.shortVersion = self.shortVersion.join('.');
+
+                console.debug('Install path => '+ hasFoundGina.dependencies.gina.path);
+
+                // OK ... found installed gina but on a different prefix
+                // In this case, let's assume that it is not really installed
+                if ( !new RegExp('^'+ self.prefix).test(hasFoundGina.dependencies.gina.path) ) {
+                    self.isGinaInstalled = false;
+                }
+            }
+        } catch (err) {}
+
+        console.debug('self.defaultPrefix => '+ self.defaultPrefix);
+        console.debug('self.optionalPrefix  => '+ self.optionalPrefix );
+        console.debug('self.prefix => '+ self.prefix);
+        console.debug('self.isCustomPrefix => ', self.isCustomPrefix);
+        // only available when running the script with NPM
+        console.debug('process.env.npm_config_prefix => '+ process.env.npm_config_prefix);
+    }
 
+    //Initialize post installation scripts.
+    var init = function() {
+        // self.isWin32 = isWin32();//getEnvVar('GINA_IS_WIN32');
+        // self.versionPath = getEnvVar('GINA_FRAMEWORK');
+        // self.gina = getEnvVar('GINA_DIR');
+        // self.root = self.gina; // by default
+        // self.isGlobalInstall = false;
+        // self.prefix = process.env.npm_config_prefix || execSync('npm config get prefix').toString().replace(/\n$/g, '');
+        // self.isCustomPrefix = false;
+
+        // var args = process.argv, i = 0, len = args.length;
+        // for (; i < len; ++i) {
+        //     if ( /^(\-g|\-\-global)$/.test(args[i]) ) {
+        //         self.isGlobalInstall = true;
+        //         continue;
+        //     }
+        //     if ( /^\-\-prefix\=/.test(args[i] ) ) {
+        //         self.isCustomPrefix = true;
+        //         self.prefix = args[i].split(/\=/)[1];
+        //         continue;
+        //     }
+        // }
 
-        var frameworkVersionPath   = __dirname +'/../framework/v'+ self.version;
-        helpers = require(frameworkVersionPath+ '/helpers');
+        // if (
+        //     // process.env.npm_config_prefix
+        //     // &&
+        //     self.prefix != process.env.npm_config_prefix
+        // ) {
+        //     // self.prefix = process.env.npm_config_prefix;
+        //     self.isCustomPrefix = true;
+        // }
 
-        // if not found -> skip because it means that gina might not be installed or configured yet
-        if ( !new _(ginaHomeDir).existsSync() ) {
-            new _(ginaHomeDir).mkdirSync()
-        }
-        if ( !new _(ginaHomeDir +'/'+ self.shortVersion ).existsSync() ) {
-            new _(ginaHomeDir +'/'+ self.shortVersion).mkdirSync()
-        }
+        // if ( !self.isGlobalInstall ) { // none global install
+        //     // process.env.npm_config_prefix = process.cwd();
+        //     self.prefix = process.cwd();
+        //     // self.root = process.cwd(); // project path
+        //     // console.error('local installation is not supported for this version at the moment.');
+        //     // console.info('please use `npm install -g gina`');
+        //     // process.exit(1);
+        // }
+        // // setEnvVar('GINA_PREFIX', self.prefix); // for the `helper.js`
 
-        console.debug('Is this for Windows ? ' +  self.isWin32);
+        // // check for ~/.gina (first installation ?)
+        // var ginaHomeDir = getUserHome() + ( isWin32() ? '\\.gina' : '/.gina' );
+        // self.version = require( self.gina + ( isWin32() ? '\\' : '/' ) +'package.json' ).version;
+        // self.shortVersion = self.version.split('.');
+        // self.shortVersion.splice(2);
+        // self.shortVersion = self.shortVersion.join('.');
 
 
 
-        console.debug('prefix path: ' + self.prefix);
-        console.debug('framework path: ' + self.gina);
-        console.debug('framework version path: ' + self.path);
-        console.debug('cwd path: ' + self.root );
-        console.debug('this is a global install ...');
+        // var frameworkVersionPath   = __dirname +'/../framework/v'+ self.version;
+        // helpers = require(frameworkVersionPath+ '/helpers');
+
+        // // if not found -> skip because it means that gina might not be installed or configured yet
+        // if ( !new _(ginaHomeDir).existsSync() ) {
+        //     new _(ginaHomeDir).mkdirSync()
+        // }
+        // if ( !new _(ginaHomeDir +'/'+ self.shortVersion ).existsSync() ) {
+        //     new _(ginaHomeDir +'/'+ self.shortVersion).mkdirSync()
+        // }
+
+        // console.debug('Is this for Windows ? ' +  self.isWin32);
+
+
+
+        // console.debug('prefix path: ' + self.prefix);
+        // console.debug('framework path: ' + self.gina);
+        // console.debug('framework version path: ' + self.versionPath);
+        // console.debug('cwd path: ' + self.root );
+        // console.debug('this is a global install ...');
+
+        configure();
+        helpers = require(self.versionPath+ '/helpers');
 
         begin(0);
     }
@@ -206,7 +363,7 @@ function PostInstall() {
         var version = self.version;
         console.debug('writting version number: '+ version);
 
-        var target = _(self.path + '/VERSION');
+        var target = _(self.versionPath + '/VERSION');
         try {
             if ( fs.existsSync(target) ) {
                 fs.unlinkSync(target)
@@ -243,15 +400,16 @@ function PostInstall() {
 
 
             if ( !self.isGlobalInstall() ) {
-                new _(cli, true).symlinkSync(  _(self.prefix +'/', true) )
-            } else {
-                new _(cli, true).symlinkSync( _(self.prefix +'/bin/', true) )
+                new _(cli, true).symlinkSync(  _(self.prefix +'/gina', true) )
             }
+            // else {
+            //     new _(cli, true).symlinkSync( _(self.prefix +'/bin/', true) )
+            // }
 
 
             // var cmd = 'ln -s '+ self.gina +'/bin/gina '+ binPath;
             // console.debug('running: '+ cmd);
-            // run(cmd, { cwd: _(self.path), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
+            // run(cmd, { cwd: _(self.versionPath), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
             //     .onData(function(data){
             //         console.info(data)
             //     })
@@ -266,7 +424,7 @@ function PostInstall() {
             //
             // TODO - remove this part for the next version
             // cmd = 'ln -s '+ self.gina +'/bin/cli-debug '+ binPath +'/gina-debug';
-            // run(cmd, { cwd: _(self.path), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
+            // run(cmd, { cwd: _(self.versionPath), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
             //     .onData(function(data){
             //         console.info(data)
             //     })
@@ -284,30 +442,42 @@ function PostInstall() {
 
     //Creating framework command line file for nix.
     var createGinaFile = function(win32Name, callback) {
+        // Created by NPM for global installations
+        if (self.isGlobalInstall) {
+            return callback(false);
+        }
+
         console.info('Current prefix: '+ self.prefix );
-        console.info('Creating framework command line: '+  _(self.gina + '/package.json', true) );
-        var name = require( _(self.gina + '/package.json') ).name;
+        console.info('Current package.json: '+  _(self.gina + '/package.json', true) );
+
+        var name = require( _(self.gina + '/package.json', true) ).name;
         console.info('Package name: '+ name );
+        console.info('Creating framework command line:');
+        var appPath = process.cwd();
+        // _( self.gina.substring(0, (self.gina.length - ("node_modules/" + name + '/').length)) );
 
-        var appPath = _( self.gina.substring(0, (self.gina.length - ("node_modules/" + name + '/').length)) );
 
-        var source = _(self.path + '/core/template/command/gina.tpl');
-        var target = _(appPath +'/'+ name);
-        if ( typeof(win32Name) != 'undefined') {
+        console.debug('App path: '+ appPath);
+        var source = _(self.versionPath + '/core/template/command/gina.tpl', true);
+        console.debug('Source: '+ source);
+        var target = _(appPath +'/'+ name, true);
+        console.debug('Target: '+ target);
+
+        if ( win32Name && typeof(win32Name) != 'undefined') {
             target = _(appPath +'/'+ win32Name)
         }
         //Will override.
         console.info('linking to binaries dir: '+ source +' -> '+ target);
-        if ( typeof(callback) != 'undefined') {
+        if ( callback && typeof(callback) != 'undefined') {
             if ( !self.isGlobalInstall ) { // local install only
                 lib.generator.createFileFromTemplate(source, target, function onGinaFileCreated(err) {
-                    callback(err)
+                    return callback(err)
 
                 })
             } else {
 
                 // configureGina();
-                callback(false)
+                return callback(false)
             }
         } else {
             if ( !self.isGlobalInstall ) {
@@ -321,7 +491,7 @@ function PostInstall() {
 
     self.createGinaFileForPlatform = async function(done) {
         console.info('Creating platform file');
-        var name = require( _(self.path + '/package.json') ).name;
+        var name = require( _(self.versionPath + '/package.json') ).name;
 
         var filename = ( (self.isWin32) ? '.' : '' ) + name;
 
@@ -333,7 +503,7 @@ function PostInstall() {
                 }
 
                 // this is done to allow multiple calls of post_install.js
-                var filename = _(self.path + '/SUCCESS');
+                var filename = _(self.versionPath + '/SUCCESS');
                 var installed = fs.existsSync( filename );
                 if (installed) {
                     fs.unlinkSync( filename );
@@ -355,7 +525,7 @@ function PostInstall() {
                 if ( !hasNodeModulesSync() ) {
                     return npmInstall(done)
                 } else {
-                    var target = new _(self.path + '/node_modules');
+                    var target = new _(self.versionPath + '/node_modules');
                     console.debug('replacing: ', target.toString() );
                     return target
                         .rm( function onRemove(err) {
@@ -371,8 +541,9 @@ function PostInstall() {
         }
 
         if (self.isWin32) {
-            var appPath = _( self.path.substring(0, (self.path.length - ("node_modules/" + name + '/').length)) );
-            var source = _(self.path + '/core/template/command/gina.bat.tpl');
+            // var appPath = _( self.versionPath.substring(0, (self.versionPath.length - ("node_modules/" + name + '/').length)) );
+            var appPath = process.cwd()
+            var source = _(self.versionPath + '/core/template/command/gina.bat.tpl');
             var target = _(appPath +'/'+ name + '.bat');
             if ( fs.existsSync(target) ) {
                 fs.unlinkSync(target);
@@ -393,42 +564,43 @@ function PostInstall() {
 
 
     var hasNodeModulesSync = function() {
-        return fs.existsSync( _(self.path + '/node_modules') )
+        return fs.existsSync( _(self.versionPath + '/node_modules') )
     }
 
 
     var npmInstall = function(done) {
 
-        console.info('now installing modules: please, wait ...');
+        console.info('Now installing modules: please, wait ...');
         console.info('Prefix ('+ self.isCustomPrefix +'): '+ self.prefix);
         var initialDir = process.cwd();
 
 
         var cmd = ( isWin32() ) ? 'npm.cmd install' : 'npm install';
 
-        process.chdir( self.path );
+        process.chdir( self.versionPath );
+
         console.info('running: `'+ cmd +'` from '+ process.cwd() );
         console.info('running using TMPDIR: '+  _(getTmpDir(), true) );
-
-        process.env.npm_config_global=false;
+        var oldConfigGlobal = process.env.npm_config_global;
+        process.env.npm_config_global = false;
         execSync(cmd);
 
-        // var deps = require(_(self.path + '/package.json', true)).dependencies;
+        // var deps = require(_(self.versionPath + '/package.json', true)).dependencies;
         // for (let d in deps) {
         //     try {
-        //         console.info('running: `'+ cmd +' '+ d +'@"'+ deps[d] +'"` from '+ self.path );
+        //         console.info('running: `'+ cmd +' '+ d +'@"'+ deps[d] +'"` from '+ self.versionPath );
         //         execSync(cmd +' '+ d +'@"'+ deps[d] +'"');
         //     } catch (err) {
         //         return done(err)
         //     }
         // }
         process.chdir(initialDir);
-        process.env.npm_config_global=true;
+        process.env.npm_config_global = oldConfigGlobal;
 
         done()
 
 
-        // run(cmd, { cwd: _(self.path), tmp: _(getTmpDir(), true), outToProcessSTD: true })
+        // run(cmd, { cwd: _(self.versionPath), tmp: _(getTmpDir(), true), outToProcessSTD: true })
         //     .onData(function onData(data){
         //         console.info(data)
         //     })
@@ -594,7 +766,7 @@ function PostInstall() {
     //     }
     //     // from `/usr/local` -> `~/.npm-global`
     //     var cmd = 'npm config set prefix '+ getUserHome() +'/.npm-global';
-    //     await promisify(run)(cmd, { cwd: _(self.path), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
+    //     await promisify(run)(cmd, { cwd: _(self.versionPath), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
     //         .catch(function onError(err){
     //             if (err) {
     //                 console.warn('try to run: sudo ' + cmd);
@@ -606,7 +778,7 @@ function PostInstall() {
     //     var profilePathObj = new _(profilePath);
     //     if ( !profilePathObj.existsSync() ) {
     //         cmd = 'touch '+ profilePath;
-    //         await promisify(run)(cmd, { cwd: _(self.path), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
+    //         await promisify(run)(cmd, { cwd: _(self.versionPath), tmp: _(self.root +'/tmp'), outToProcessSTD: true })
     //             .catch(function onError(err){
     //                 if (err) {
     //                     console.warn('try to run: sudo ' + cmd);
@@ -668,15 +840,17 @@ function PostInstall() {
             // intercept & remove existing symlinks or old versions dir
             try {
                 if ( fs.lstatSync( _(frameworkPath +'/'+ dir, true) ).isSymbolicLink() ) {
-                    new _(frameworkPath +'/'+ dir, true).rmSync();
-                    console.debug('Removing Symlink: '+ dir);
+                    console.debug('Removing Symlink: '+ _(frameworkPath +'/'+ dir, true) );
+                    // new _(frameworkPath +'/'+ dir, true).rmSync();
+                    fs.unlinkSync(_(frameworkPath +'/'+ dir, true));
                     continue;
                 }
-                else if (
+
+                if (
                     dir != currentVersion
                     && fs.lstatSync( _(frameworkPath +'/'+ dir, true) ).isDirectory()
                 ) {
-                    console.debug('Removing old version: '+ dir);
+                    console.debug('Removing old version: '+ _(frameworkPath +'/'+ dir, true));
                     new _(frameworkPath +'/'+ dir, true).rmSync()
                 }
             } catch (e) {
@@ -714,10 +888,10 @@ function PostInstall() {
 
 
         // Update middleware file
-        var filename = _(self.path) + '/MIDDLEWARE';
+        var filename = _(self.versionPath) + '/MIDDLEWARE';
         var msg = "Gina's command line tool has been installed.";
 
-        var deps = require(_(self.path) + '/package.json').dependecies;
+        var deps = require(_(self.versionPath) + '/package.json').dependecies;
 
         var version = require( _(self.gina + '/package.json') ).version;
         var middleware = 'isaac@'+version; // by default
@@ -728,7 +902,7 @@ function PostInstall() {
             }
         }
 
-        var expressPackage = _(self.path + '/node_modules/express/package.json');
+        var expressPackage = _(self.versionPath + '/node_modules/express/package.json');
         if ( typeof(middleware) == 'undefined' && fs.existsSync(expressPackage) ) {
             middleware = require(expressPackage).version;
             middleware = 'express@' + middleware;
@@ -745,7 +919,7 @@ function PostInstall() {
                     if (err) {
                         return done(err)
                     }
-                    console.info('def !== middleware case');
+                    console.debug('def !== middleware case');
                     // execSync(self.prefix +'/bin/gina framework:set --prefix='+ self.prefix);
                     console.info(msg);
                     done()