3rdparty/modules/stdlib/lib/puppet/parser/functions/shell_escape.rb

   1 #
   2 # shell_escape.rb
   3 #
   4
   5 require 'shellwords'
   6
   7 module Puppet::Parser::Functions
   8   newfunction(:shell_escape, :type => :rvalue, :doc => <<-EOS
   9 Escapes a string so that it can be safely used in a Bourne shell command line.
  10
  11 Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single
  12 quotes.
  13
  14 This function behaves the same as ruby's Shellwords.shellescape() function.
  15   EOS
  16   ) do |arguments|
  17
  18     raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
  19
  20     # explicit conversion to string is required for ruby 1.9
  21     string = arguments[0].to_s
  22
  23     result = Shellwords.shellescape(string)
  24
  25     return result
  26   end
  27 end
  28
  29 # vim: set ts=2 sw=2 et :