output_safety.rb 4.4 KB
Newer Older
1
require 'erb'
2
require 'active_support/core_ext/kernel/singleton_class'
3 4 5

class ERB
  module Util
6
    HTML_ESCAPE = { '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;', "'" => '&#39;' }
7
    JSON_ESCAPE = { '&' => '\u0026', '>' => '\u003E', '<' => '\u003C' }
8
    HTML_ESCAPE_ONCE_REGEXP = /["><']|&(?!([a-zA-Z]+|(#\d+));)/
9
    JSON_ESCAPE_REGEXP = /[&"><]/
10

11 12 13 14 15 16
    # A utility method for escaping HTML tag characters.
    # This method is also aliased as <tt>h</tt>.
    #
    # In your ERB templates, use this method to escape any unsafe content. For example:
    #   <%=h @person.name %>
    #
17
    #   puts html_escape('is a > 0 & a < 10?')
18 19 20 21 22 23
    #   # => is a &gt; 0 &amp; a &lt; 10?
    def html_escape(s)
      s = s.to_s
      if s.html_safe?
        s
      else
24
        s.gsub(/[&"'><]/, HTML_ESCAPE).html_safe
25 26 27
      end
    end

R
R.T. Lechow 已提交
28
    # Aliasing twice issues a warning "discarding old...". Remove first to avoid it.
29
    remove_method(:h)
30 31 32 33
    alias h html_escape

    module_function :h

34 35 36
    singleton_class.send(:remove_method, :html_escape)
    module_function :html_escape

V
Vijay Dev 已提交
37
    # A utility method for escaping HTML without affecting existing escaped entities.
38
    #
39
    #   html_escape_once('1 < 2 &amp; 3')
40 41
    #   # => "1 &lt; 2 &amp; 3"
    #
42
    #   html_escape_once('&lt;&lt; Accept & Checkout')
43 44
    #   # => "&lt;&lt; Accept &amp; Checkout"
    def html_escape_once(s)
A
Aman Gupta 已提交
45
      result = s.to_s.gsub(HTML_ESCAPE_ONCE_REGEXP, HTML_ESCAPE)
46 47 48 49 50
      s.html_safe? ? result.html_safe : result
    end

    module_function :html_escape_once

51 52
    # A utility method for escaping HTML entities in JSON strings
    # using \uXXXX JavaScript escape sequences for string literals:
53
    #
54
    #   json_escape('is a > 0 & a < 10?')
55
    #   # => is a \u003E 0 \u0026 a \u003C 10?
56
    #
57 58
    # Note that after this operation is performed the output is not
    # valid JSON. In particular double quotes are removed:
59
    #
60
    #   json_escape('{"name":"john","created_at":"2010-04-28T01:39:31Z","id":1}')
61
    #   # => {name:john,created_at:2010-04-28T01:39:31Z,id:1}
62
    def json_escape(s)
A
Aman Gupta 已提交
63
      result = s.to_s.gsub(JSON_ESCAPE_REGEXP, JSON_ESCAPE)
64
      s.html_safe? ? result.html_safe : result
65 66 67 68 69 70
    end

    module_function :json_escape
  end
end

71 72 73 74 75 76
class Object
  def html_safe?
    false
  end
end

77
class Numeric
78 79 80 81 82
  def html_safe?
    true
  end
end

83 84
module ActiveSupport #:nodoc:
  class SafeBuffer < String
A
Alexey Gaziev 已提交
85 86 87 88
    UNSAFE_STRING_METHODS = %w(
      capitalize chomp chop delete downcase gsub lstrip next reverse rstrip
      slice squeeze strip sub succ swapcase tr tr_s upcase prepend
    )
89

90 91 92 93 94
    alias_method :original_concat, :concat
    private :original_concat

    class SafeConcatError < StandardError
      def initialize
95
        super 'Could not concatenate to the buffer because it is not html safe.'
96 97 98
      end
    end

99
    def [](*args)
A
Alexey Gaziev 已提交
100 101
      if args.size < 2
        super
102
      else
A
Alexey Gaziev 已提交
103 104 105 106 107 108 109
        if html_safe?
          new_safe_buffer = super
          new_safe_buffer.instance_eval { @html_safe = true }
          new_safe_buffer
        else
          to_str[*args]
        end
110 111 112
      end
    end

113
    def safe_concat(value)
114
      raise SafeConcatError unless html_safe?
115 116
      original_concat(value)
    end
117

118
    def initialize(*)
119
      @html_safe = true
120 121 122 123 124
      super
    end

    def initialize_copy(other)
      super
125
      @html_safe = other.html_safe?
126 127
    end

A
Akira Matsuda 已提交
128
    def clone_empty
129
      self[0, 0]
A
Akira Matsuda 已提交
130 131
    end

132
    def concat(value)
133
      if !html_safe? || value.html_safe?
134 135 136 137 138
        super(value)
      else
        super(ERB::Util.h(value))
      end
    end
139
    alias << concat
J
Joshua Peek 已提交
140

141 142 143 144
    def +(other)
      dup.concat(other)
    end

145
    def %(args)
146
      args = Array(args).map do |arg|
147 148 149 150 151 152 153 154 155 156
        if !html_safe? || arg.html_safe?
          arg
        else
          ERB::Util.h(arg)
        end
      end

      self.class.new(super(args))
    end

157
    def html_safe?
158
      defined?(@html_safe) && @html_safe
159
    end
J
Joshua Peek 已提交
160

161 162 163
    def to_s
      self
    end
164

165 166 167 168
    def to_param
      to_str
    end

169 170 171 172
    def encode_with(coder)
      coder.represent_scalar nil, to_str
    end

173
    UNSAFE_STRING_METHODS.each do |unsafe_method|
174
      if String.new.respond_to?(unsafe_method) 
175 176
        define_method(unsafe_method) do |*args, &block|
          to_str.send(unsafe_method, *args, &block)
177
        end
178 179
        
        define_method("#{unsafe_method}!") do |*args|
180 181 182
          @html_safe = false
          super(*args)
        end
183
      end
184
    end
185
  end
186
end
J
Joshua Peek 已提交
187

188 189 190 191
class String
  def html_safe
    ActiveSupport::SafeBuffer.new(self)
  end
192
end