output_safety.rb 2.7 KB
Newer Older
1
require 'erb'
2
require 'active_support/core_ext/kernel/singleton_class'
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

class ERB
  module Util
    HTML_ESCAPE = { '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;' }
    JSON_ESCAPE = { '&' => '\u0026', '>' => '\u003E', '<' => '\u003C' }

    # 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 %>
    #
    # ==== Example:
    #   puts html_escape("is a > 0 & a < 10?")
    #   # => is a &gt; 0 &amp; a &lt; 10?
    def html_escape(s)
      s = s.to_s
      if s.html_safe?
        s
      else
        s.gsub(/[&"><]/) { |special| HTML_ESCAPE[special] }.html_safe
      end
    end

27
    # Aliasing twice issues a warning "dicarding old...". Remove first to avoid it.
28
    remove_method(:h)
29 30 31 32
    alias h html_escape

    module_function :h

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

36 37
    # A utility method for escaping HTML entities in JSON strings
    # using \uXXXX JavaScript escape sequences for string literals:
38
    #
39 40
    #   json_escape("is a > 0 & a < 10?")
    #   # => is a \u003E 0 \u0026 a \u003C 10?
41
    #
42 43
    # Note that after this operation is performed the output is not
    # valid JSON. In particular double quotes are removed:
44
    #
45
    #   json_escape('{"name":"john","created_at":"2010-04-28T01:39:31Z","id":1}')
46 47
    #   # => {name:john,created_at:2010-04-28T01:39:31Z,id:1}
    #
48 49 50 51 52
    # This method is also aliased as +j+, and available as a helper
    # in Rails templates:
    #
    #   <%=j @person.to_json %>
    #
53 54 55 56 57 58 59 60 61 62
    def json_escape(s)
      s.to_s.gsub(/[&"><]/) { |special| JSON_ESCAPE[special] }
    end

    alias j json_escape
    module_function :j
    module_function :json_escape
  end
end

63 64 65 66 67 68 69 70 71 72 73 74
class Object
  def html_safe?
    false
  end
end

class Fixnum
  def html_safe?
    true
  end
end

75 76 77
module ActiveSupport #:nodoc:
  class SafeBuffer < String
    alias safe_concat concat
78

79 80 81 82 83 84 85
    def concat(value)
      if value.html_safe?
        super(value)
      else
        super(ERB::Util.h(value))
      end
    end
86
    alias << concat
J
Joshua Peek 已提交
87

88 89 90 91 92 93 94 95 96 97 98
    def +(other)
      dup.concat(other)
    end

    def html_safe?
      true
    end

    def html_safe
      self
    end
J
Joshua Peek 已提交
99

100 101 102
    def to_s
      self
    end
103

104 105 106 107 108 109 110 111
    def encode_with(coder)
      coder.represent_scalar nil, to_str
    end

    def to_yaml(*args)
      return super() if defined?(YAML::ENGINE) && !YAML::ENGINE.syck?

      to_str.to_yaml(*args)
112
    end
113
  end
114
end
J
Joshua Peek 已提交
115

116 117 118
class String
  def html_safe!
    raise "You can't call html_safe! on a String"
119
  end
J
Joshua Peek 已提交
120

121 122 123
  def html_safe
    ActiveSupport::SafeBuffer.new(self)
  end
124
end