Module: Mail::ShellEscape
- Defined in:
- lib/mail/core_extensions/shell_escape.rb
Class Method Summary collapse
-
.escape_for_shell(str) ⇒ Object
Escapes a string so that it can be safely used in a Bourne shell command line.
Class Method Details
.escape_for_shell(str) ⇒ Object
Escapes a string so that it can be safely used in a Bourne shell command line.
Note that a resulted string should be used unquoted and is not intended for use in double quotes nor in single quotes.
open("| grep #{Shellwords.escape(pattern)} file") { |pipe|
# ...
}
String#shellescape is a shorthand for this function.
open("| grep #{pattern.shellescape} file") { |pipe|
# ...
}
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/mail/core_extensions/shell_escape.rb', line 25 def escape_for_shell(str) # An empty argument will be skipped, so return empty quotes. return "''" if str.empty? str = str.dup # Process as a single byte sequence because not all shell # implementations are multibyte aware. str.gsub!(/([^A-Za-z0-9_\s\+\-.,:\/@])/n, "\\\\\\1") # A LF cannot be escaped with a backslash because a backslash + LF # combo is regarded as line continuation and simply ignored. str.gsub!(/\n/, "'\n'") return str end |