модуль Shellwords

Обрабатывает строки, как оболочка UNIX Bourne

Этот модуль обрабатывает строки в соответствии с правилами разбора слов оболочки UNIX Bourne.

Функция shellwords() первоначально была портирована из shellwords.pl, но была модифицирована для соответствия разделу «Оболочка и утилиты» стандарта IEEE Std 1003.1-2008, издание 2016 [1].

Использование

Вы можете использовать Shellwords для разбора строки в массив, дружественный оболочке Bourne Array.

require 'shellwords'

argv = Shellwords.split('three blind "mice"')
argv #=> ["three", "blind", "mice"]

После того, как вы загрузили Shellwords, вы можете использовать псевдоним split String#shellsplit.

argv = "see how they run".shellsplit
argv #=> ["see", "how", "they", "run"]

Они обрабатывают кавычки как специальные символы, поэтому несовпавшая кавычка вызовет ArgumentError.

argv = "they all ran after the farmer's wife".shellsplit
     #=> ArgumentError: Unmatched quote: ...

Shellwords также предоставляет методы, выполняющие обратное действие. Shellwords.escape, или его псевдоним String#shellescape, экранирует метасимволы оболочки в строке для использования в командной строке.

filename = "special's.txt"

system("cat -- #{filename.shellescape}")
# runs "cat -- special\\'s.txt"

Обратите внимание на символ «–». Без него cat(1) будет рассматривать следующий аргумент как опцию командной строки, если он начинается с «-». Гарантируется, что Shellwords.escape преобразует строку в форму, которую оболочка Bourne распарсит обратно в исходную строку, но ответственность программиста заключается в том, чтобы убедиться, что передача произвольного аргумента команде не нанесёт вреда.

Shellwords также поставляется с расширением ядра для Array, Array#shelljoin.

dir = "Funny GIFs"
argv = %W[ls -lta -- #{dir}]
system(argv.shelljoin + " | less")
# runs "ls -lta -- Funny\\ GIFs | less"

Вы можете использовать этот метод для построения полной командной строки из массива аргументов.

Авторы

Wakou Aoyama
Akinori MUSHA <knu@iDaemons.org>

Контакты

Akinori MUSHA <knu@iDaemons.org> (текущий разработчик)

Ресурсы

1: IEEE Std 1003.1-2008, издание 2016, раздел «Оболочка и утилиты»

Методы публичного класса

escape(str)

Псевдоним для: shellescape

join(array)

Псевдоним для: shelljoin

shellescape(str) Показать исходный код

# File lib/shellwords.rb, line 148
def shellescape(str)
  str = str.to_s

  # An empty argument will be skipped, so return empty quotes.
  return "''".dup if str.empty?

  str = str.dup

  # Treat multibyte characters as is.  It is the caller's responsibility
  # to encode the string in the right encoding for the shell
  # environment.
  str.gsub!(/[^A-Za-z0-9_\-.,:+\/@\n]/, "\\\\\\&")

  # A LF cannot be escaped with a backslash because a backslash + LF
  # combo is regarded as a line continuation and simply ignored.
  str.gsub!(/\n/, "'\n'")

  return str
end

Экранирует строку, чтобы её можно было безопасно использовать в командной строке оболочки Bourne. str может быть объектом, отличным от строки, который отвечает на to_s.

Обратите внимание, что полученная строка должна использоваться без кавычек и не предназначена для использования в двойных или одинарных кавычках.

argv = Shellwords.escape("It's better to give than to receive")
argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"

String#shellescape — сокращение для этой функции.

argv = "It's better to give than to receive".shellescape
argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"

# Search files in lib for method definitions
pattern = "^[ \t]*def "
open("| grep -Ern -e #{pattern.shellescape} lib") { |grep|
  grep.each_line { |line|
    file, lineno, matched_line = line.split(':', 3)
    # ...
  }
}

Ответственность вызывающей стороны — кодировать строку в правильной кодировке для среды оболочки, где используется эта строка.

Многобайтовые символы обрабатываются как многобайтовые, а не как байты.

Возвращает пустую строку String с кавычками, если у str длина равна нулю.

Также алиасировано как: escape

shelljoin(array) Показать исходный код

# File lib/shellwords.rb, line 194
def shelljoin(array)
  array.map { |arg| shellescape(arg) }.join(' ')
end

Строит строку командной строки из списка аргументов, array.

Все элементы объединяются в одну строку с разделителями пробелов, где каждый элемент экранирован для оболочки Bourne и приведен к строковому виду с использованием to_s.

ary = ["There's", "a", "time", "and", "place", "for", "everything"]
argv = Shellwords.join(ary)
argv #=> "There\\'s a time and place for everything"

Array#shelljoin — сокращение для этой функции.

ary = ["Don't", "rock", "the", "boat"]
argv = ary.shelljoin
argv #=> "Don\\'t rock the boat"

Вы также можете смешивать объекты, отличные от строк, в элементах, как разрешено в Array#join.

output = `#{['ps', '-p', $$].shelljoin}`

Также алиасировано как: join

shellsplit(line) Показать исходный код

# File lib/shellwords.rb, line 88
def shellsplit(line)
  words = []
  field = String.new
  line.scan(/\G\s*(?>([^\s\\\'\"]+)|'([^\']*)'|"((?:[^\"\\]|\\.)*)"|(\\.?)|(\S))(\s|\z)?/m) do
    |word, sq, dq, esc, garbage, sep|
    raise ArgumentError, "Unmatched quote: #{line.inspect}" if garbage
    # 2.2.3 Double-Quotes:
    #
    #   The <backslash> shall retain its special meaning as an
    #   escape character only when followed by one of the following
    #   characters when considered special:
    #
    #   $ ` " \ <newline>
    field << (word || sq || (dq && dq.gsub(/\\([$`"\\\n])/, '\\1')) || esc.gsub(/\\(.)/, '\\1'))
    if sep
      words << field
      field = String.new
    end
  end
  words
end

Разделяет строку на массив токенов так же, как это делает оболочка UNIX Bourne.

argv = Shellwords.split('here are "two words"')
argv #=> ["here", "are", "two words"]

Однако обратите внимание, что это не парсер командной строки. Метасимволы оболочки, кроме одинарных и двойных кавычек и обратной косой черты, не обрабатываются как таковые.

argv = Shellwords.split('ruby my_prog.rb | less')
argv #=> ["ruby", "my_prog.rb", "|", "less"]

String#shellsplit — сокращение для этой функции.

argv = 'here are "two words"'.shellsplit
argv #=> ["here", "are", "two words"]

Также алиасировано как: shellwords, split

shellwords(line)

Псевдоним для: shellsplit

split(line)

Псевдоним для: shellsplit

Методы частного экземпляра

shellescape(str) Показать исходный код

# File lib/shellwords.rb, line 148
def shellescape(str)
  str = str.to_s

  # An empty argument will be skipped, so return empty quotes.
  return "''".dup if str.empty?

  str = str.dup

  # Treat multibyte characters as is.  It is the caller's responsibility
  # to encode the string in the right encoding for the shell
  # environment.
  str.gsub!(/[^A-Za-z0-9_\-.,:+\/@\n]/, "\\\\\\&")

  # A LF cannot be escaped with a backslash because a backslash + LF
  # combo is regarded as a line continuation and simply ignored.
  str.gsub!(/\n/, "'\n'")

  return str
end

argv = Shellwords.escape("It's better to give than to receive")
argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"

String#shellescape — сокращение для этой функции.

argv = "It's better to give than to receive".shellescape
argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"

# Search files in lib for method definitions
pattern = "^[ \t]*def "
open("| grep -Ern -e #{pattern.shellescape} lib") { |grep|
  grep.each_line { |line|
    file, lineno, matched_line = line.split(':', 3)
    # ...
  }
}

Многобайтовые символы обрабатываются как многобайтовые, а не как байты.

Возвращает пустую строку String с кавычками, если у str длина равна нулю.

Также алиасировано как: escape

shelljoin(array) Показать исходный код

# File lib/shellwords.rb, line 194
def shelljoin(array)
  array.map { |arg| shellescape(arg) }.join(' ')
end

Строит строку командной строки из списка аргументов, array.

ary = ["There's", "a", "time", "and", "place", "for", "everything"]
argv = Shellwords.join(ary)
argv #=> "There\\'s a time and place for everything"

Array#shelljoin — сокращение для этой функции.

ary = ["Don't", "rock", "the", "boat"]
argv = ary.shelljoin
argv #=> "Don\\'t rock the boat"

Вы также можете смешивать объекты, отличные от строк, в элементах, как разрешено в Array#join.

output = `#{['ps', '-p', $$].shelljoin}`

Также алиасировано как: join

shellsplit(line) Показать исходный код

# File lib/shellwords.rb, line 88
def shellsplit(line)
  words = []
  field = String.new
  line.scan(/\G\s*(?>([^\s\\\'\"]+)|'([^\']*)'|"((?:[^\"\\]|\\.)*)"|(\\.?)|(\S))(\s|\z)?/m) do
    |word, sq, dq, esc, garbage, sep|
    raise ArgumentError, "Unmatched quote: #{line.inspect}" if garbage
    # 2.2.3 Double-Quotes:
    #
    #   The <backslash> shall retain its special meaning as an
    #   escape character only when followed by one of the following
    #   characters when considered special:
    #
    #   $ ` " \ <newline>
    field << (word || sq || (dq && dq.gsub(/\\([$`"\\\n])/, '\\1')) || esc.gsub(/\\(.)/, '\\1'))
    if sep
      words << field
      field = String.new
    end
  end
  words
end

Разделяет строку на массив токенов так же, как это делает оболочка UNIX Bourne.

argv = Shellwords.split('here are "two words"')
argv #=> ["here", "are", "two words"]

argv = Shellwords.split('ruby my_prog.rb | less')
argv #=> ["ruby", "my_prog.rb", "|", "less"]

String#shellsplit — сокращение для этой функции.

argv = 'here are "two words"'.shellsplit
argv #=> ["here", "are", "two words"]

Также алиасировано как: shellwords, split

shellwords(line)

Псевдоним для: shellsplit

Ruby Core © 1993–2020 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.