'use strict' const fs = require('graceful-fs') const path = require('path') const log = require('npmlog') const os = require('os') const processRelease = require('./process-release') const win = process.platform === 'win32' const findNodeDirectory = require('./find-node-directory') const createConfigGypi = require('./create-config-gypi') const msgFormat = require('util').format var findPython = require('./find-python') if (win) { var findVisualStudio = require('./find-visualstudio') } function configure (gyp, argv, callback) { var python var buildDir = path.resolve('build') var buildBinsDir = path.join(buildDir, 'node_gyp_bins') var configNames = ['config.gypi', 'common.gypi'] var configs = [] var nodeDir var release = processRelease(argv, gyp, process.version, process.release) findPython(gyp.opts.python, function (err, found) { if (err) { callback(err) } else { python = found getNodeDir() } }) function getNodeDir () { // 'python' should be set by now process.env.PYTHON = python if (gyp.opts.nodedir) { // --nodedir was specified. use that for the dev files nodeDir = gyp.opts.nodedir.replace(/^~/, os.homedir()) log.verbose('get node dir', 'compiling against specified --nodedir dev files: %s', nodeDir) createBuildDir() } else { // if no --nodedir specified, ensure node dependencies are installed if ('v' + release.version !== process.version) { // if --target was given, then determine a target version to compile for log.verbose('get node dir', 'compiling against --target node version: %s', release.version) } else { // if no --target was specified then use the current host node version log.verbose('get node dir', 'no --target version specified, falling back to host node version: %s', release.version) } if (!release.semver) { // could not parse the version string with semver return callback(new Error('Invalid version number: ' + release.version)) } // If the tarball option is set, always remove and reinstall the headers // into devdir. Otherwise only install if they're not already there. gyp.opts.ensure = !gyp.opts.tarball gyp.commands.install([release.version], function (err) { if (err) { return callback(err) } log.verbose('get node dir', 'target node version installed:', release.versionDir) nodeDir = path.resolve(gyp.devDir, release.versionDir) createBuildDir() }) } } function createBuildDir () { log.verbose('build dir', 'attempting to create "build" dir: %s', buildDir) const deepestBuildDirSubdirectory = win ? buildDir : buildBinsDir fs.mkdir(deepestBuildDirSubdirectory, { recursive: true }, function (err, isNew) { if (err) { return callback(err) } log.verbose( 'build dir', '"build" dir needed to be created?', isNew ? 'Yes' : 'No' ) if (win) { findVisualStudio(release.semver, gyp.opts.msvs_version, createConfigFile) } else { createPythonSymlink() createConfigFile() } }) } function createPythonSymlink () { const symlinkDestination = path.join(buildBinsDir, 'python3') log.verbose('python symlink', `creating symlink to "${python}" at "${symlinkDestination}"`) fs.unlink(symlinkDestination, function (err) { if (err && err.code !== 'ENOENT') { log.verbose('python symlink', 'error when attempting to remove existing symlink') log.verbose('python symlink', err.stack, 'errno: ' + err.errno) } fs.symlink(python, symlinkDestination, function (err) { if (err) { log.verbose('python symlink', 'error when attempting to create Python symlink') log.verbose('python symlink', err.stack, 'errno: ' + err.errno) } }) }) } function createConfigFile (err, vsInfo) { if (err) { return callback(err) } if (process.platform === 'win32') { process.env.GYP_MSVS_VERSION = Math.min(vsInfo.versionYear, 2015) process.env.GYP_MSVS_OVERRIDE_PATH = vsInfo.path } createConfigGypi({ gyp, buildDir, nodeDir, vsInfo }).then(configPath => { configs.push(configPath) findConfigs() }).catch(err => { callback(err) }) } function findConfigs () { var name = configNames.shift() if (!name) { return runGyp() } var fullPath = path.resolve(name) log.verbose(name, 'checking for gypi file: %s', fullPath) fs.stat(fullPath, function (err) { if (err) { if (err.code === 'ENOENT') { findConfigs() // check next gypi filename } else { callback(err) } } else { log.verbose(name, 'found gypi file') configs.push(fullPath) findConfigs() } }) } function runGyp (err) { if (err) { return callback(err) } if (!~argv.indexOf('-f') && !~argv.indexOf('--format')) { if (win) { log.verbose('gyp', 'gyp format was not specified; forcing "msvs"') // force the 'make' target for non-Windows argv.push('-f', 'msvs') } else { log.verbose('gyp', 'gyp format was not specified; forcing "make"') // force the 'make' target for non-Windows argv.push('-f', 'make') } } // include all the ".gypi" files that were found configs.forEach(function (config) { argv.push('-I', config) }) // For AIX and z/OS we need to set up the path to the exports file // which contains the symbols needed for linking. var nodeExpFile if (process.platform === 'aix' || process.platform === 'os390' || process.platform === 'os400') { var ext = process.platform === 'os390' ? 'x' : 'exp' var nodeRootDir = findNodeDirectory() var candidates if (process.platform === 'aix' || process.platform === 'os400') { candidates = [ 'include/node/node', 'out/Release/node', 'out/Debug/node', 'node' ].map(function (file) { return file + '.' + ext }) } else { candidates = [ 'out/Release/lib.target/libnode', 'out/Debug/lib.target/libnode', 'out/Release/obj.target/libnode', 'out/Debug/obj.target/libnode', 'lib/libnode' ].map(function (file) { return file + '.' + ext }) } var logprefix = 'find exports file' nodeExpFile = findAccessibleSync(logprefix, nodeRootDir, candidates) if (nodeExpFile !== undefined) { log.verbose(logprefix, 'Found exports file: %s', nodeExpFile) } else { var msg = msgFormat('Could not find node.%s file in %s', ext, nodeRootDir) log.error(logprefix, 'Could not find exports file') return callback(new Error(msg)) } } // For z/OS we need to set up the path to zoslib include directory, // which contains headers included in v8config.h. var zoslibIncDir if (process.platform === 'os390') { logprefix = "find zoslib's zos-base.h:" let msg var zoslibIncPath = process.env.ZOSLIB_INCLUDES if (zoslibIncPath) { zoslibIncPath = findAccessibleSync(logprefix, zoslibIncPath, ['zos-base.h']) if (zoslibIncPath === undefined) { msg = msgFormat('Could not find zos-base.h file in the directory set ' + 'in ZOSLIB_INCLUDES environment variable: %s; set it ' + 'to the correct path, or unset it to search %s', process.env.ZOSLIB_INCLUDES, nodeRootDir) } } else { candidates = [ 'include/node/zoslib/zos-base.h', 'include/zoslib/zos-base.h', 'zoslib/include/zos-base.h', 'install/include/node/zoslib/zos-base.h' ] zoslibIncPath = findAccessibleSync(logprefix, nodeRootDir, candidates) if (zoslibIncPath === undefined) { msg = msgFormat('Could not find any of %s in directory %s; set ' + 'environmant variable ZOSLIB_INCLUDES to the path ' + 'that contains zos-base.h', candidates.toString(), nodeRootDir) } } if (zoslibIncPath !== undefined) { zoslibIncDir = path.dirname(zoslibIncPath) log.verbose(logprefix, "Found zoslib's zos-base.h in: %s", zoslibIncDir) } else if (release.version.split('.')[0] >= 16) { // zoslib is only shipped in Node v16 and above. log.error(logprefix, msg) return callback(new Error(msg)) } } // this logic ported from the old `gyp_addon` python file var gypScript = path.resolve(__dirname, '..', 'gyp', 'gyp_main.py') var addonGypi = path.resolve(__dirname, '..', 'addon.gypi') var commonGypi = path.resolve(nodeDir, 'include/node/common.gypi') fs.stat(commonGypi, function (err) { if (err) { commonGypi = path.resolve(nodeDir, 'common.gypi') } var outputDir = 'build' if (win) { // Windows expects an absolute path outputDir = buildDir } var nodeGypDir = path.resolve(__dirname, '..') var nodeLibFile = path.join(nodeDir, !gyp.opts.nodedir ? '<(target_arch)' : '$(Configuration)', release.name + '.lib') argv.push('-I', addonGypi) argv.push('-I', commonGypi) argv.push('-Dlibrary=shared_library') argv.push('-Dvisibility=default') argv.push('-Dnode_root_dir=' + nodeDir) if (process.platform === 'aix' || process.platform === 'os390' || process.platform === 'os400') { argv.push('-Dnode_exp_file=' + nodeExpFile) if (process.platform === 'os390' && zoslibIncDir) { argv.push('-Dzoslib_include_dir=' + zoslibIncDir) } } argv.push('-Dnode_gyp_dir=' + nodeGypDir) // Do this to keep Cygwin environments happy, else the unescaped '\' gets eaten up, // resulting in bad paths, Ex c:parentFolderfolderanotherFolder instead of c:\parentFolder\folder\anotherFolder if (win) { nodeLibFile = nodeLibFile.replace(/\\/g, '\\\\') } argv.push('-Dnode_lib_file=' + nodeLibFile) argv.push('-Dmodule_root_dir=' + process.cwd()) argv.push('-Dnode_engine=' + (gyp.opts.node_engine || process.jsEngine || 'v8')) argv.push('--depth=.') argv.push('--no-parallel') // tell gyp to write the Makefile/Solution files into output_dir argv.push('--generator-output', outputDir) // tell make to write its output into the same dir argv.push('-Goutput_dir=.') // enforce use of the "binding.gyp" file argv.unshift('binding.gyp') // execute `gyp` from the current target nodedir argv.unshift(gypScript) // make sure python uses files that came with this particular node package var pypath = [path.join(__dirname, '..', 'gyp', 'pylib')] if (process.env.PYTHONPATH) { pypath.push(process.env.PYTHONPATH) } process.env.PYTHONPATH = pypath.join(win ? ';' : ':') var cp = gyp.spawn(python, argv) cp.on('exit', onCpExit) }) } function onCpExit (code) { if (code !== 0) { callback(new Error('`gyp` failed with exit code: ' + code)) } else { // we're done callback() } } } /** * Returns the first file or directory from an array of candidates that is * readable by the current user, or undefined if none of the candidates are * readable. */ function findAccessibleSync (logprefix, dir, candidates) { for (var next = 0; next < candidates.length; next++) { var candidate = path.resolve(dir, candidates[next]) try { var fd = fs.openSync(candidate, 'r') } catch (e) { // this candidate was not found or not readable, do nothing log.silly(logprefix, 'Could not open %s: %s', candidate, e.message) continue } fs.closeSync(fd) log.silly(logprefix, 'Found readable %s', candidate) return candidate } return undefined } module.exports = configure module.exports.test = { findAccessibleSync: findAccessibleSync } module.exports.usage = 'Generates ' + (win ? 'MSVC project files' : 'a Makefile') + ' for the current module'