| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330 |
- 'use strict';
- /**
- * @import {
- * ControlOperator,
- * Env,
- * GlobPattern,
- * ParseEntry,
- * } from './parse' */
- // '<(' is process substitution operator and
- // can be parsed the same as control operator
- var CONTROL = /** @type {const} */ ('(?:') + /** @type {const} */ ([
- '\\|\\|',
- '\\&\\&',
- ';;',
- '\\|\\&',
- '\\<\\(',
- '\\<\\<\\<',
- '>>',
- '>\\&',
- '<\\&',
- '[&;()|<>]'
- ]).join(/** @type {const} */ ('|')) + /** @type {const} */ (')');
- var controlRE = new RegExp('^' + CONTROL + '$');
- var META = /** @type {const} */ ('|&;()<> \\t');
- var SINGLE_QUOTE = /** @type {const} */ ('\'([^\']*?)\'');
- var DOUBLE_QUOTE = /** @type {const} */ ('"((\\\\"|[^"])*?)"');
- var hash = /^#$/;
- var SQ = /** @type {const} */ ("'");
- var DQ = /** @type {const} */ ('"');
- var DS = /** @type {const} */ ('$');
- var TOKEN = '';
- var mult = /** @type {const} */ (0x100000000); // Math.pow(16, 8);
- for (var i = 0; i < 4; i++) {
- TOKEN += (mult * Math.random()).toString(16);
- }
- var startsWithToken = new RegExp('^' + TOKEN);
- /**
- * @param {string} s
- * @param {RegExp} r
- */
- function matchAll(s, r) {
- var origIndex = r.lastIndex;
- var matches = [];
- var matchObj;
- while ((matchObj = r.exec(s))) {
- matches[matches.length] = matchObj;
- if (r.lastIndex === matchObj.index) {
- r.lastIndex += 1;
- }
- }
- r.lastIndex = origIndex;
- return matches;
- }
- /**
- * @param {Env} env
- * @param {string} pre
- * @param {string} key
- */
- function getVar(env, pre, key) {
- var r = typeof env === 'function' ? env(key) : env[key];
- if (typeof r === 'undefined' && key != '') {
- r = '';
- } else if (typeof r === 'undefined') {
- r = '$';
- }
- if (typeof r === 'object') {
- return pre + TOKEN + JSON.stringify(r) + TOKEN;
- }
- return pre + r;
- }
- /**
- * @param {string} string
- * @param {Env} [env]
- * @param {{ escape?: string, splitUnquoted?: boolean | string }} [opts]
- * @returns {ParseEntry[]}
- */
- function parseInternal(string, env, opts) {
- if (!opts) {
- opts = {};
- }
- var BS = opts.escape || '\\';
- var ifs = opts.splitUnquoted === true ? ' \t\n' : (typeof opts.splitUnquoted === 'string' ? opts.splitUnquoted : '');
- var BAREWORD = '(\\' + BS + '[\'"' + META + ']|[^\\s\'"' + META + '])+';
- var chunker = new RegExp([
- '(' + CONTROL + ')', // control chars
- '(' + BAREWORD + '|' + DOUBLE_QUOTE + '|' + SINGLE_QUOTE + ')+'
- ].join('|'), 'g');
- var matches = matchAll(string, chunker);
- if (matches.length === 0) {
- return [];
- }
- if (!env) {
- env = {};
- }
- var commented = false;
- return matches.map(function (match) {
- var s = match[0];
- if (!s || commented) {
- return void undefined;
- }
- if (controlRE.test(s)) {
- return /** @type {ControlOperator} */ ({ op: s });
- }
- // Hand-written scanner/parser for Bash quoting rules:
- //
- // 1. inside single quotes, all characters are printed literally.
- // 2. inside double quotes, all characters are printed literally
- // except variables prefixed by '$' and backslashes followed by
- // either a double quote or another backslash.
- // 3. outside of any quotes, backslashes are treated as escape
- // characters and not printed (unless they are themselves escaped)
- // 4. quote context can switch mid-token if there is no whitespace
- // between the two quote contexts (e.g. all'one'"token" parses as
- // "allonetoken")
- /** @type {string | boolean} */
- var quote = false;
- var esc = false;
- var out = '';
- /** @type {string[]} */
- var words = [];
- var sawQuote = false;
- /** @type {number | null} */
- var pendingNw = null;
- var isGlob = false;
- /** @type {number} */
- var i;
- function parseEnvVar() {
- i += 1;
- /** @type {number | RegExpMatchArray | null} */
- var varend;
- /** @type {string} */
- var varname;
- var char = s.charAt(i);
- if (char === '{') {
- i += 1;
- if (s.charAt(i) === '}') {
- throw new Error('Bad substitution: ' + s.slice(i - 2, i + 1));
- }
- // match braces by depth so a nested `${` keeps its inner `}` from ending the outer substitution
- var depth = 1;
- varend = i;
- while (depth > 0 && varend < s.length) {
- if (s.charAt(varend) === '{' && s.charAt(varend - 1) === '$') {
- depth += 1;
- } else if (s.charAt(varend) === '}') {
- depth -= 1;
- }
- varend += 1;
- }
- if (depth !== 0) {
- throw new Error('Bad substitution: ' + s.slice(i));
- }
- varend -= 1;
- varname = s.slice(i, varend);
- i = varend;
- } else if ((/[*@#?$!_-]/).test(char)) {
- varname = char;
- i += 1;
- } else {
- var slicedFromI = s.slice(i);
- varend = slicedFromI.match(/[^\w\d_]/);
- if (!varend) {
- varname = slicedFromI;
- i = s.length;
- } else {
- varname = slicedFromI.slice(0, varend.index);
- i += /** @type {number} */ (varend.index) - 1;
- }
- }
- return getVar(/** @type {NonNullable<typeof env>} */ (env), '', varname);
- }
- function flushRun() {
- if (pendingNw === null) {
- return;
- }
- if (pendingNw === 0) {
- if (out !== '') {
- words[words.length] = out;
- out = '';
- }
- } else {
- words[words.length] = out;
- out = '';
- for (var fe = 1; fe < pendingNw; fe += 1) {
- words[words.length] = '';
- }
- }
- pendingNw = null;
- }
- for (i = 0; i < s.length; i++) {
- var c = s.charAt(i);
- if (ifs && c !== DS) {
- flushRun();
- }
- isGlob = isGlob || (!quote && (c === '*' || c === '?'));
- if (esc) {
- out += c;
- esc = false;
- } else if (quote) {
- if (c === quote) {
- quote = false;
- } else if (quote == SQ) {
- out += c;
- } else { // Double quote
- if (c === BS) {
- i += 1;
- c = s.charAt(i);
- if (c === DQ || c === BS || c === DS) {
- out += c;
- } else {
- out += BS + c;
- }
- } else if (c === DS) {
- out += parseEnvVar();
- } else {
- out += c;
- }
- }
- } else if (c === DQ || c === SQ) {
- quote = c;
- sawQuote = true;
- } else if (controlRE.test(c)) {
- return /** @type {ControlOperator} */ ({ op: s });
- } else if (hash.test(c)) {
- commented = true;
- var commentObj = { comment: string.slice(match.index + i + 1) };
- if (out.length) {
- return /** @type {const} */ ([out, commentObj]);
- }
- return /** @type {const} */ ([commentObj]);
- } else if (c === BS) {
- esc = true;
- } else if (c === DS) {
- var value = parseEnvVar();
- if (!ifs) {
- out += value;
- } else {
- for (var vi = 0; vi < value.length; vi += 1) {
- var vc = value.charAt(vi);
- if (ifs.indexOf(vc) < 0) {
- flushRun();
- out += vc;
- } else if (pendingNw === null) {
- pendingNw = vc === ' ' || vc === '\t' || vc === '\n' ? 0 : 1;
- } else if (vc !== ' ' && vc !== '\t' && vc !== '\n') {
- pendingNw += 1;
- }
- }
- }
- } else {
- out += c;
- }
- }
- if (isGlob) {
- return /** @type {GlobPattern} */ ({ op: 'glob', pattern: out });
- }
- if (ifs) {
- if (pendingNw !== null && pendingNw > 0) {
- words[words.length] = out;
- out = '';
- for (var te = 1; te < pendingNw; te += 1) {
- words[words.length] = '';
- }
- }
- if (out !== '' || (sawQuote && words.length === 0)) {
- words[words.length] = out;
- }
- return words;
- }
- return out;
- }).reduce(function (prev, arg) { // finalize parsed arguments
- if (typeof arg === 'undefined') {
- return prev;
- }
- /** @type {ParseEntry[]} */ ([]).concat(arg).forEach(function (entry) {
- prev[prev.length] = entry;
- });
- return prev;
- }, /** @type {ParseEntry[]} */ ([]));
- }
- /** @type {typeof import('./parse')} */
- module.exports = function parse(s, env, opts) {
- var mapped = parseInternal(s, env, opts);
- if (typeof env !== 'function') {
- return mapped;
- }
- return mapped.reduce(function (acc, s) {
- if (typeof s === 'object') {
- acc[acc.length] = s;
- return acc;
- }
- var xs = s.split(RegExp('(' + TOKEN + '.*?' + TOKEN + ')', 'g'));
- if (xs.length === 1) {
- acc[acc.length] = xs[0];
- return acc;
- }
- xs.filter(Boolean).forEach(function (x) {
- acc[acc.length] = startsWithToken.test(x)
- ? JSON.parse(x.split(TOKEN)[1])
- : x;
- });
- return acc;
- }, /** @type {ParseEntry[]} */ ([]));
- };
|