在 macOS 中创建一个 shell 转义的 POSIX 路径

Question

我需要从完整的 POSIX 路径（从根目录开始）创建一个字符串，以便将它可以直接粘贴到像 bash 这样的 Unix shell 中，例如在Terminal.app 中，不需要在路径周围加上引号。

（我实际上并没有将字符串传递给 shell，而是需要它来将其传递给另一个程序。该程序期望路径的格式与您将文件拖入 Terminal.app 时所获得的形式相同.)

为此，我需要通过在字符串中添加反斜杠来转义至少所有空格。还有更多字符。

例如这条路径：

/directory/-as"<>' *+

转义如下：

/directory/-as\"\<\>\'\ \*+

执行该转换的安全算法是什么？我可以转义每一个字符，但这太过分了。

似乎没有框架函数可以做到这一点，所以我需要用字符串操作替换。

为了保守（对于最流行的 shell），在避免明显不必要的转义的同时，应该转义哪些字符集？

Answer 1

作为记录，Terminal.app 在将文件名放入其窗口时会转义以下非控制 ASCII 字符：

空格

!"#$%&'()*,:;?[]`{|}~

而且这些都没有转义：

控制代码（00-1F 和 7F）

字母数字

+-.@^_

下面是执行替换的代码：

NSString* shellPathFromPOSIXPath (NSString *path)
{
    static NSRegularExpression *regex = nil;
    if (!regex) {
        NSString *pattern =
          @"([ !\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\,\\:\\;\\<\\=\\>\\?\\[\\]\\`\\{\\|\\}\\~])";
        regex =
          [NSRegularExpression regularExpressionWithPattern:pattern options:0 error:nil];
    }
    NSString *result =
      [regex stringByReplacingMatchesInString:path
                                      options:0
                                        range:NSMakeRange(0, path.length)
                                 withTemplate:@"\\\\$1"];
    return result;
}

Answer 2

最好将整个内容放在单引号中，而不是为单个字符添加反斜杠；那么您需要转义的唯一字符是字符串中存在的单引号。

Python standard library's implementation 作为示例提供，可以轻松地用任何其他只有基本原语的语言重新实现，内容如下：

def quote(s):
    """Return a shell-escaped version of the string *s*."""
    if not s:
        return "''"
    if _find_unsafe(s) is None:
        return s

    # use single quotes, and put single quotes into double quotes
    # the string $'b is then quoted as '$'"'"'b'
    return "'" + s.replace("'", "'\"'\"'") + "'"

也就是说，一般算法如下：

• 空字符串变为''（一对文字单引号）。
• 已知安全的字符串（尽管最安全的做法是根本不尝试为此实现代码路径，尤其是当 shell 经常在未定义的空间中实现自己的语法扩展时）可以裸露/不带引号发出。
• 否则，在前面加上一个'，发出您的输入字符串，将所有's 替换为文字字符串'"'"'，然后附加一个最终的'。

就是这样。您不需要转义反斜杠（它们是单引号内的文字）、换行符（同样）或其他任何内容。