Class: Sanitize

Inherits:
Object
  • Object
show all
Defined in:
lib/sanitize/config.rb,
lib/sanitize.rb,
lib/sanitize/version.rb,
lib/sanitize/config/basic.rb,
lib/sanitize/config/relaxed.rb,
lib/sanitize/config/restricted.rb

Overview

– Copyright © 2009 Ryan Grove <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ++

Defined Under Namespace

Modules: Config

Constant Summary collapse

REGEX_PROTOCOL =

Matches an attribute value that could be treated by a browser as a URL with a protocol prefix, such as “http:” or “javascript:”. Any string of zero or more characters followed by a colon is considered a match, even if the colon is encoded as an entity and even if it’s an incomplete entity (which IE6 and Opera will still parse).

/^([A-Za-z0-9\+\-\.\&\;\#\s]*?)(?:\:|&#0*58|&#x0*3a)/i
VERSION = 
'1.2.0.dev.20091104'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = {}) ⇒ Sanitize

Returns a new Sanitize object initialized with the settings in config.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/sanitize.rb', line 70

def initialize(config = {})
  # Sanitize configuration.
  @config = Config::DEFAULT.merge(config)
  @config[:transformers] = Array(@config[:transformers])

  # Specific nodes to whitelist (along with all their attributes). This array
  # is generated at runtime by transformers, and is cleared before and after
  # a fragment is cleaned (so it applies only to a specific fragment).
  @whitelist_nodes = []
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



32
33
34
 
# File 'lib/sanitize.rb', line 32

def config
  @config
end

Class Method Details

.clean(html, config = {}) ⇒ Object

Returns a sanitized copy of html, using the settings in config if specified.



47
48
49
50
 
# File 'lib/sanitize.rb', line 47

def self.clean(html, config = {})
  sanitize = Sanitize.new(config)
  sanitize.clean(html)
end

.clean!(html, config = {}) ⇒ Object

Performs Sanitize#clean in place, returning html, or nil if no changes were made.



54
55
56
57
 
# File 'lib/sanitize.rb', line 54

def self.clean!(html, config = {})
  sanitize = Sanitize.new(config)
  sanitize.clean!(html)
end

.clean_node!(node, config = {}) ⇒ Object

Sanitizes the specified Nokogiri::XML::Node and all its children.



60
61
62
63
 
# File 'lib/sanitize.rb', line 60

def self.clean_node!(node, config = {})
  sanitize = Sanitize.new(config)
  sanitize.clean_node!(node)
end

Instance Method Details

#clean(html) ⇒ Object

Returns a sanitized copy of html.



82
83
84
85
 
# File 'lib/sanitize.rb', line 82

def clean(html)
  dupe = html.dup
  clean!(dupe) || dupe
end

#clean!(html) ⇒ Object

Performs clean in place, returning html, or nil if no changes were made.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/sanitize.rb', line 89

def clean!(html)
  @whitelist_nodes = []
  fragment = Nokogiri::HTML::DocumentFragment.parse(html)
  clean_node!(fragment)
  @whitelist_nodes = []

  output_method_params = {:encoding => 'utf-8', :indent => 0}

  if @config[:output] == :xhtml
    output_method = fragment.method(:to_xhtml)
    output_method_params[:save_with] = Nokogiri::XML::Node::SaveOptions::AS_XHTML
  elsif @config[:output] == :html
    output_method = fragment.method(:to_html)
  else
    raise Error, "unsupported output format: #{@config[:output]}"
  end

  result = output_method.call(output_method_params)

  # Nokogiri 1.3.3 (and possibly earlier versions) always returns a US-ASCII
  # string no matter what we ask for. This will be fixed in 1.4.0, but for
  # now we have to hack around it to prevent errors.
  result.force_encoding('utf-8') if RUBY_VERSION >= '1.9'

  return result == html ? nil : html[0, html.length] = result
end

#clean_node!(node) ⇒ Object

Sanitizes the specified Nokogiri::XML::Node and all its children.

Raises:

  • (ArgumentError) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/sanitize.rb', line 117

def clean_node!(node)
  raise ArgumentError unless node.is_a?(Nokogiri::XML::Node)

  node.traverse do |traversed_node|
    if traversed_node.element?
      clean_element!(traversed_node)
    elsif traversed_node.comment?
      traversed_node.unlink unless @config[:allow_comments]
    elsif traversed_node.cdata?
      traversed_node.replace(Nokogiri::XML::Text.new(traversed_node.text,
          traversed_node.document))
    end
  end

  node
end