-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
quote is the feature branch for converting an array of argument strings into a properly quoted command line string Adds control character escaping and Unicode support. quote() passes through Unicode characters, escapes all others quote_ascii() escapes all, including Unicode Author-Rebase-Consent: https://No-rebase.github.io
- Loading branch information
Showing
4 changed files
with
361 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,136 @@ | ||
| 'use strict'; | ||
|
|
||
| module.exports = function quote(xs) { | ||
| return xs.map(function (s) { | ||
| if (s && typeof s === 'object') { | ||
| return s.op.replace(/(.)/g, '\\$1'); | ||
| } | ||
| if ((/["\s]/).test(s) && !(/'/).test(s)) { | ||
| return "'" + s.replace(/(['\\])/g, '\\$1') + "'"; | ||
| // quote - Quotes an array of strings to a strict ASCII representation. | ||
| // Escapes all characters that have special meaning to a shell. | ||
| // Escapes all control characters (0x01-0x1f) to \x?? sequences | ||
| // Drops null characters (0x00), as shells do. | ||
| // Preserves the meaning of operator objects like {op:'glob'} or | ||
| // {op: '|'} | ||
| // Preserves literal Unicode characters | ||
| // Useful when its output will be read in a Unicode capable environment, | ||
| // like an editor, an email, a web page or a UTF-8 capable terminal | ||
| // emulator | ||
| function quote(xs) { | ||
| return xs.map(function (s) { | ||
| if (s && typeof s === 'object') { | ||
| if (s.op === 'glob') { | ||
| return s.pattern; | ||
| } | ||
| return s.op; | ||
| } | ||
| else { | ||
| s = String(s).replace(/\x00/g, ''); // eat \x00 just like the shell. | ||
| if(s === '') { | ||
| return "''"; | ||
| } | ||
| // Enclose strings with metacharacters in single quoted, | ||
| // and escape any single quotes. | ||
| // Match strictly to avoid escaping things that don't need to be. | ||
| // bash: | & ; ( ) < > space tab | ||
| // Also escapes bash curly brace ranges {a..b} {a..z..3} {1..20} {a,b} but not | ||
| // {a...b} or {..a} | ||
| else if ((/(?:["\\$`! |&;\(\)<>#]|{[\d]+\.{2}[\d]+(?:\.\.\d+)?}|{[a-zA-Z].{2}[a-zA-Z](?:\.\.\d+)?}|{[^{]*,[^}]*})/m).test(s)) { | ||
| // If input contains outer single quote, escape each of them individually. | ||
| // eg. 'a b c' -> \''a b c'\' | ||
| var outer_quotes = s.match(/^('*)(.*?)('*)$/s); | ||
|
|
||
| var inner_string = outer_quotes[2].replace(/'/g, '\'\\\'\''); | ||
|
|
||
| // the starting outer quotes individually escaped | ||
| return String(outer_quotes[1]).replace(/(.)/g, '\\$1') + | ||
| // the text inside the outer single quotes is single quoted | ||
| "'" + unprintableEscape(inner_string, "'", false).replace(/(?<!\\)''/g, '') + "'" + | ||
| // "'" + inner_string + "'" + | ||
| // the ending outer quotes individually escaped | ||
| String(outer_quotes[3]).replace(/(.)/g, '\\$1'); | ||
| } | ||
| // Only escape the single quotes in strings without metachars or | ||
| // separators | ||
| return unprintableEscape(String(s).replace(/(')/g, '\\$1'), '', false); | ||
| } | ||
| if ((/["'\s]/).test(s)) { | ||
| return '"' + s.replace(/(["\\$`!])/g, '\\$1') + '"'; | ||
| }).join(' '); | ||
| } | ||
|
|
||
| // quote_ascii - Quotes an array of strings to a strict ASCII representation. | ||
| // Does the same as quote(), except: | ||
| // Escapes Unicode characters to \ux???? sequences | ||
| // Suitable when the output will be read or pasted into an environment which is not | ||
| // UTF-8 capable (eg, some terminal emulators) | ||
| function quote_ascii(xs) { | ||
| return xs.map(function (s) { | ||
| if (s && typeof s === 'object') { | ||
| if (s.op === 'glob') { | ||
| return s.pattern; | ||
| } | ||
| return s.op; | ||
| } | ||
| else { | ||
| s = String(s).replace(/\x00/g, ''); // eat \x00 just like the shell. | ||
| if(s === '') { | ||
| return "''"; | ||
| } | ||
| // Enclose strings with metacharacters in single quoted, | ||
| // and escape any single quotes. | ||
| // Match strictly to avoid escaping things that don't need to be. | ||
| // bash: | & ; ( ) < > space tab | ||
| // Also escapes bash curly brace ranges {a..b} {a..z..3} {1..20} {a,b} but not | ||
| // {a...b} or {..a} | ||
| else if ((/(?:["\\$`! |&;\(\)<>#]|{[\d]+\.{2}[\d]+(?:\.\.\d+)?}|{[a-zA-Z].{2}[a-zA-Z](?:\.\.\d+)?}|{[^{]*,[^}]*})/m).test(s)) { | ||
| // If input contains outer single quote, escape each of them individually. | ||
| // eg. 'a b c' -> \''a b c'\' | ||
| var outer_quotes = s.match(/^('*)(.*?)('*)$/s); | ||
|
|
||
| var inner_string = outer_quotes[2].replace(/'/g, '\'\\\'\''); | ||
|
|
||
| // the starting outer quotes individually escaped | ||
| return String(outer_quotes[1]).replace(/(.)/g, '\\$1') + | ||
| // the text inside the outer single quotes is single quoted | ||
| "'" + unprintableEscape(inner_string, "'", true).replace(/(?<!\\)''/g, '') + "'" + | ||
| // "'" + inner_string + "'" + | ||
| // the ending outer quotes individually escaped | ||
| String(outer_quotes[3]).replace(/(.)/g, '\\$1'); | ||
| } | ||
| // Only escape the single quotes in strings without metachars or | ||
| // separators | ||
| return unprintableEscape(String(s).replace(/(')/g, '\\$1'), '', true); | ||
| } | ||
| return String(s).replace(/([A-Za-z]:)?([#!"$&'()*,:;<=>?@[\\\]^`{|}])/g, '$1\\$2'); | ||
| }).join(' '); | ||
| }).join(' '); | ||
| } | ||
|
|
||
| function padWithLeadingZeros(string) { | ||
| return new Array(5 - string.length).join("0") + string; | ||
| } | ||
|
|
||
| function unicodeCharEscape(charCode) { | ||
| return "\\u" + padWithLeadingZeros(charCode.toString(16)); | ||
| } | ||
|
|
||
| function escapeCtrlChars(charCode) { | ||
| switch (charCode) { | ||
| case 8: return '\\b'; | ||
| case 9: return '\\t'; | ||
| case 10: return '\\n'; | ||
| case 11: return '\\v'; | ||
| case 12: return '\\f'; | ||
| case 13: return '\\r'; | ||
| case 27: return '\\E'; | ||
| default: | ||
| if (charCode < 16) return '\\x0' + charCode.toString(16); | ||
| else return '\\x' + charCode.toString(16); | ||
| } | ||
| } | ||
|
|
||
| function unprintableEscape(string, quote, ascii) { | ||
| return string.split("") | ||
| .map(function (char) { | ||
| var charCode = char.charCodeAt(0); | ||
| return charCode < 32 ? quote + escapeCtrlChars(charCode) + quote : | ||
| (ascii && charCode > 127) ? quote + unicodeCharEscape(charCode) + quote : char; | ||
| }) | ||
| .join(""); | ||
| } | ||
|
|
||
| module.exports = { | ||
| quote_ascii: quote_ascii, | ||
| quote: quote | ||
| }; |
Oops, something went wrong.