extensions.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459
  1. /*!
  2. * node-sass: lib/extensions.js
  3. */
  4. var eol = require('os').EOL,
  5. fs = require('fs'),
  6. pkg = require('../package.json'),
  7. mkdir = require('mkdirp'),
  8. path = require('path'),
  9. defaultBinaryDir = path.join(__dirname, '..', 'vendor'),
  10. trueCasePathSync = require('true-case-path');
  11. /**
  12. * Get the human readable name of the Platform that is running
  13. *
  14. * @param {string} platform - An OS platform to match, or null to fallback to
  15. * the current process platform
  16. * @return {Object} The name of the platform if matched, false otherwise
  17. *
  18. * @api public
  19. */
  20. function getHumanPlatform(platform) {
  21. switch (platform || process.platform) {
  22. case 'darwin': return 'OS X';
  23. case 'freebsd': return 'FreeBSD';
  24. case 'linux': return 'Linux';
  25. case 'linux_musl': return 'Linux/musl';
  26. case 'win32': return 'Windows';
  27. default: return false;
  28. }
  29. }
  30. /**
  31. * Provides a more readable version of the architecture
  32. *
  33. * @param {string} arch - An instruction architecture name to match, or null to
  34. * lookup the current process architecture
  35. * @return {Object} The value of the process architecture, or false if unknown
  36. *
  37. * @api public
  38. */
  39. function getHumanArchitecture(arch) {
  40. switch (arch || process.arch) {
  41. case 'ia32': return '32-bit';
  42. case 'x86': return '32-bit';
  43. case 'x64': return '64-bit';
  44. default: return false;
  45. }
  46. }
  47. /**
  48. * Get the friendly name of the Node environment being run
  49. *
  50. * @param {Object} abi - A Node Application Binary Interface value, or null to
  51. * fallback to the current Node ABI
  52. * @return {Object} Returns a string name of the Node environment or false if
  53. * unmatched
  54. *
  55. * @api public
  56. */
  57. function getHumanNodeVersion(abi) {
  58. switch (parseInt(abi || process.versions.modules, 10)) {
  59. case 11: return 'Node 0.10.x';
  60. case 14: return 'Node 0.12.x';
  61. case 42: return 'io.js 1.x';
  62. case 43: return 'io.js 1.1.x';
  63. case 44: return 'io.js 2.x';
  64. case 45: return 'io.js 3.x';
  65. case 46: return 'Node.js 4.x';
  66. case 47: return 'Node.js 5.x';
  67. case 48: return 'Node.js 6.x';
  68. case 49: return 'Electron 1.3.x';
  69. case 50: return 'Electron 1.4.x';
  70. case 51: return 'Node.js 7.x';
  71. case 53: return 'Electron 1.6.x';
  72. case 57: return 'Node.js 8.x';
  73. case 59: return 'Node.js 9.x';
  74. case 64: return 'Node.js 10.x';
  75. case 67: return 'Node.js 11.x';
  76. default: return false;
  77. }
  78. }
  79. /**
  80. * Get a human readable description of where node-sass is running to support
  81. * user error reporting when something goes wrong
  82. *
  83. * @param {string} env - The name of the native bindings that is to be parsed
  84. * @return {string} A description of what os, architecture, and Node version
  85. * that is being run
  86. *
  87. * @api public
  88. */
  89. function getHumanEnvironment(env) {
  90. var binding = env.replace(/_binding\.node$/, ''),
  91. parts = binding.split('-'),
  92. platform = getHumanPlatform(parts[0]),
  93. arch = getHumanArchitecture(parts[1]),
  94. runtime = getHumanNodeVersion(parts[2]);
  95. if (parts.length !== 3) {
  96. return 'Unknown environment (' + binding + ')';
  97. }
  98. if (!platform) {
  99. platform = 'Unsupported platform (' + parts[0] + ')';
  100. }
  101. if (!arch) {
  102. arch = 'Unsupported architecture (' + parts[1] + ')';
  103. }
  104. if (!runtime) {
  105. runtime = 'Unsupported runtime (' + parts[2] + ')';
  106. }
  107. return [
  108. platform, arch, 'with', runtime,
  109. ].join(' ');
  110. }
  111. /**
  112. * Get the value of the binaries under the default path
  113. *
  114. * @return {Array} The currently installed node-sass bindings
  115. *
  116. * @api public
  117. */
  118. function getInstalledBinaries() {
  119. return fs.readdirSync(getBinaryDir());
  120. }
  121. /**
  122. * Check that an environment matches the whitelisted values or the current
  123. * environment if no parameters are passed
  124. *
  125. * @param {string} platform - The name of the OS platform(darwin, win32, etc...)
  126. * @param {string} arch - The instruction set architecture of the Node environment
  127. * @param {string} abi - The Node Application Binary Interface
  128. * @return {Boolean} True, if node-sass supports the current platform, false otherwise
  129. *
  130. * @api public
  131. */
  132. function isSupportedEnvironment(platform, arch, abi) {
  133. return (
  134. false !== getHumanPlatform(platform) &&
  135. false !== getHumanArchitecture(arch) &&
  136. false !== getHumanNodeVersion(abi)
  137. );
  138. }
  139. /**
  140. * Get the value of a CLI argument
  141. *
  142. * @param {String} name
  143. * @param {Array} args
  144. * @api private
  145. */
  146. function getArgument(name, args) {
  147. var flags = args || process.argv.slice(2),
  148. index = flags.lastIndexOf(name);
  149. if (index === -1 || index + 1 >= flags.length) {
  150. return null;
  151. }
  152. return flags[index + 1];
  153. }
  154. /**
  155. * Get binary name.
  156. * If environment variable SASS_BINARY_NAME,
  157. * .npmrc variable sass_binary_name or
  158. * process argument --binary-name is provided,
  159. * return it as is, otherwise make default binary
  160. * name: {platform}-{arch}-{v8 version}.node
  161. *
  162. * @api public
  163. */
  164. function getBinaryName() {
  165. var binaryName,
  166. variant,
  167. platform = process.platform;
  168. if (getArgument('--sass-binary-name')) {
  169. binaryName = getArgument('--sass-binary-name');
  170. } else if (process.env.SASS_BINARY_NAME) {
  171. binaryName = process.env.SASS_BINARY_NAME;
  172. } else if (process.env.npm_config_sass_binary_name) {
  173. binaryName = process.env.npm_config_sass_binary_name;
  174. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryName) {
  175. binaryName = pkg.nodeSassConfig.binaryName;
  176. } else {
  177. variant = getPlatformVariant();
  178. if (variant) {
  179. platform += '_' + variant;
  180. }
  181. binaryName = [
  182. platform, '-',
  183. process.arch, '-',
  184. process.versions.modules
  185. ].join('');
  186. }
  187. return [binaryName, 'binding.node'].join('_');
  188. }
  189. /**
  190. * Determine the URL to fetch binary file from.
  191. * By default fetch from the node-sass distribution
  192. * site on GitHub.
  193. *
  194. * The default URL can be overriden using
  195. * the environment variable SASS_BINARY_SITE,
  196. * .npmrc variable sass_binary_site or
  197. * or a command line option --sass-binary-site:
  198. *
  199. * node scripts/install.js --sass-binary-site http://example.com/
  200. *
  201. * The URL should to the mirror of the repository
  202. * laid out as follows:
  203. *
  204. * SASS_BINARY_SITE/
  205. *
  206. * v3.0.0
  207. * v3.0.0/freebsd-x64-14_binding.node
  208. * ....
  209. * v3.0.0
  210. * v3.0.0/freebsd-ia32-11_binding.node
  211. * v3.0.0/freebsd-x64-42_binding.node
  212. * ... etc. for all supported versions and platforms
  213. *
  214. * @api public
  215. */
  216. function getBinaryUrl() {
  217. var site = getArgument('--sass-binary-site') ||
  218. process.env.SASS_BINARY_SITE ||
  219. process.env.npm_config_sass_binary_site ||
  220. (pkg.nodeSassConfig && pkg.nodeSassConfig.binarySite) ||
  221. 'https://github.com/sass/node-sass/releases/download';
  222. return [site, 'v' + pkg.version, getBinaryName()].join('/');
  223. }
  224. /**
  225. * Get binary dir.
  226. * If environment variable SASS_BINARY_DIR,
  227. * .npmrc variable sass_binary_dir or
  228. * process argument --sass-binary-dir is provided,
  229. * select it by appending binary name, otherwise
  230. * use default binary dir.
  231. * Once the primary selection is made, check if
  232. * callers wants to throw if file not exists before
  233. * returning.
  234. *
  235. * @api public
  236. */
  237. function getBinaryDir() {
  238. var binaryDir;
  239. if (getArgument('--sass-binary-dir')) {
  240. binaryDir = getArgument('--sass-binary-dir');
  241. } else if (process.env.SASS_BINARY_DIR) {
  242. binaryDir = process.env.SASS_BINARY_DIR;
  243. } else if (process.env.npm_config_sass_binary_dir) {
  244. binaryDir = process.env.npm_config_sass_binary_dir;
  245. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryDir) {
  246. binaryDir = pkg.nodeSassConfig.binaryDir;
  247. } else {
  248. binaryDir = defaultBinaryDir;
  249. }
  250. return binaryDir;
  251. }
  252. /**
  253. * Get binary path.
  254. * If environment variable SASS_BINARY_PATH,
  255. * .npmrc variable sass_binary_path or
  256. * process argument --sass-binary-path is provided,
  257. * select it by appending binary name, otherwise
  258. * make default binary path using binary name.
  259. * Once the primary selection is made, check if
  260. * callers wants to throw if file not exists before
  261. * returning.
  262. *
  263. * @api public
  264. */
  265. function getBinaryPath() {
  266. var binaryPath;
  267. if (getArgument('--sass-binary-path')) {
  268. binaryPath = getArgument('--sass-binary-path');
  269. } else if (process.env.SASS_BINARY_PATH) {
  270. binaryPath = process.env.SASS_BINARY_PATH;
  271. } else if (process.env.npm_config_sass_binary_path) {
  272. binaryPath = process.env.npm_config_sass_binary_path;
  273. } else if (pkg.nodeSassConfig && pkg.nodeSassConfig.binaryPath) {
  274. binaryPath = pkg.nodeSassConfig.binaryPath;
  275. } else {
  276. binaryPath = path.join(getBinaryDir(), getBinaryName().replace(/_(?=binding\.node)/, '/'));
  277. }
  278. if (process.versions.modules < 46) {
  279. return binaryPath;
  280. }
  281. try {
  282. return trueCasePathSync(binaryPath) || binaryPath;
  283. } catch (e) {
  284. return binaryPath;
  285. }
  286. }
  287. /**
  288. * An array of paths suitable for use as a local disk cache of the binding.
  289. *
  290. * @return {[]String} an array of paths
  291. * @api public
  292. */
  293. function getCachePathCandidates() {
  294. return [
  295. process.env.npm_config_sass_binary_cache,
  296. process.env.npm_config_cache,
  297. ].filter(function(_) { return _; });
  298. }
  299. /**
  300. * The most suitable location for caching the binding on disk.
  301. *
  302. * Given the candidates directories provided by `getCachePathCandidates()` this
  303. * returns the first writable directory. By treating the candidate directories
  304. * as a prioritised list this method is deterministic, assuming no change to the
  305. * local environment.
  306. *
  307. * @return {String} directory to cache binding
  308. * @api public
  309. */
  310. function getBinaryCachePath() {
  311. var i,
  312. cachePath,
  313. cachePathCandidates = getCachePathCandidates();
  314. for (i = 0; i < cachePathCandidates.length; i++) {
  315. cachePath = path.join(cachePathCandidates[i], pkg.name, pkg.version);
  316. try {
  317. mkdir.sync(cachePath);
  318. return cachePath;
  319. } catch (e) {
  320. // Directory is not writable, try another
  321. }
  322. }
  323. return '';
  324. }
  325. /**
  326. * The cached binding
  327. *
  328. * Check the candidates directories provided by `getCachePathCandidates()` for
  329. * the binding file, if it exists. By treating the candidate directories
  330. * as a prioritised list this method is deterministic, assuming no change to the
  331. * local environment.
  332. *
  333. * @return {String} path to cached binary
  334. * @api public
  335. */
  336. function getCachedBinary() {
  337. var i,
  338. cachePath,
  339. cacheBinary,
  340. cachePathCandidates = getCachePathCandidates(),
  341. binaryName = getBinaryName();
  342. for (i = 0; i < cachePathCandidates.length; i++) {
  343. cachePath = path.join(cachePathCandidates[i], pkg.name, pkg.version);
  344. cacheBinary = path.join(cachePath, binaryName);
  345. if (fs.existsSync(cacheBinary)) {
  346. return cacheBinary;
  347. }
  348. }
  349. return '';
  350. }
  351. /**
  352. * Does the supplied binary path exist
  353. *
  354. * @param {String} binaryPath
  355. * @api public
  356. */
  357. function hasBinary(binaryPath) {
  358. return fs.existsSync(binaryPath);
  359. }
  360. /**
  361. * Get Sass version information
  362. *
  363. * @api public
  364. */
  365. function getVersionInfo(binding) {
  366. return [
  367. ['node-sass', pkg.version, '(Wrapper)', '[JavaScript]'].join('\t'),
  368. ['libsass ', binding.libsassVersion(), '(Sass Compiler)', '[C/C++]'].join('\t'),
  369. ].join(eol);
  370. }
  371. /**
  372. * Gets the platform variant, currently either an empty string or 'musl' for Linux/musl platforms.
  373. *
  374. * @api public
  375. */
  376. function getPlatformVariant() {
  377. var contents = '';
  378. if (process.platform !== 'linux') {
  379. return '';
  380. }
  381. try {
  382. contents = fs.readFileSync(process.execPath);
  383. // Buffer.indexOf was added in v1.5.0 so cast to string for old node
  384. // Delay contents.toStrings because it's expensive
  385. if (!contents.indexOf) {
  386. contents = contents.toString();
  387. }
  388. if (contents.indexOf('libc.musl-x86_64.so.1') !== -1) {
  389. return 'musl';
  390. }
  391. } catch (err) { } // eslint-disable-line no-empty
  392. return '';
  393. }
  394. module.exports.hasBinary = hasBinary;
  395. module.exports.getBinaryUrl = getBinaryUrl;
  396. module.exports.getBinaryName = getBinaryName;
  397. module.exports.getBinaryDir = getBinaryDir;
  398. module.exports.getBinaryPath = getBinaryPath;
  399. module.exports.getBinaryCachePath = getBinaryCachePath;
  400. module.exports.getCachedBinary = getCachedBinary;
  401. module.exports.getCachePathCandidates = getCachePathCandidates;
  402. module.exports.getVersionInfo = getVersionInfo;
  403. module.exports.getHumanEnvironment = getHumanEnvironment;
  404. module.exports.getInstalledBinaries = getInstalledBinaries;
  405. module.exports.isSupportedEnvironment = isSupportedEnvironment;