Skip to content

Commit

Permalink
Update sanitizer in ActionView::Helpers::SanitizeHelper
Browse files Browse the repository at this point in the history
- The sanitizer has been changed to safe_list_sanitizer.
  • Loading branch information
Juanito Fatas authored and kaspth committed Aug 5, 2019
1 parent f64de36 commit 2cd4bce
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 13 deletions.
37 changes: 37 additions & 0 deletions actiontext/app/helpers/action_text/content_helper.rb
@@ -0,0 +1,37 @@
# frozen_string_literal: true

require "rails-html-sanitizer"

module ActionText
module ContentHelper
mattr_accessor(:sanitizer) { Rails::Html::Sanitizer.safe_list_sanitizer.new }
mattr_accessor(:allowed_tags) { sanitizer.class.allowed_tags + [ ActionText::Attachment::TAG_NAME, "figure", "figcaption" ] }
mattr_accessor(:allowed_attributes) { sanitizer.class.allowed_attributes + ActionText::Attachment::ATTRIBUTES }
mattr_accessor(:scrubber)

def render_action_text_content(content)
sanitize_action_text_content(render_action_text_attachments(content))
end

def sanitize_action_text_content(content)
sanitizer.sanitize(content.to_html, tags: allowed_tags, attributes: allowed_attributes, scrubber: scrubber).html_safe
end

def render_action_text_attachments(content)
content.render_attachments do |attachment|
unless attachment.in?(content.gallery_attachments)
attachment.node.tap do |node|
node.inner_html = render(attachment, in_gallery: false).chomp
end
end
end.render_attachment_galleries do |attachment_gallery|
render(layout: attachment_gallery, object: attachment_gallery) do
attachment_gallery.attachments.map do |attachment|
attachment.node.inner_html = render(attachment, in_gallery: true).chomp
attachment.to_html
end.join("").html_safe
end.chomp
end
end
end
end
4 changes: 4 additions & 0 deletions actionview/CHANGELOG.md
@@ -1,3 +1,7 @@
* ActionView::Helpers::SanitizeHelper: support rails-html-sanitizer 1.1.0.

*Juanito Fatas*

* Allow programmatic click events to trigger Rails UJS click handlers.
Programmatic click events (eg. ones generated by `Rails.fire(link, "click")`) don't specify a button. These events were being incorrectly stopped by code meant to ignore scroll wheel and right clicks introduced in #34573.

Expand Down
23 changes: 10 additions & 13 deletions actionview/lib/action_view/helpers/sanitize_helper.rb
Expand Up @@ -17,7 +17,7 @@ module SanitizeHelper
# ASCII, and hex character references to work around these protocol filters.
# All special characters will be escaped.
#
# The default sanitizer is Rails::Html::WhiteListSanitizer. See {Rails HTML
# The default sanitizer is Rails::Html::SafeListSanitizer. See {Rails HTML
# Sanitizers}[https://github.com/rails/rails-html-sanitizer] for more information.
#
# Custom sanitization rules can also be provided.
Expand Down Expand Up @@ -80,12 +80,12 @@ module SanitizeHelper
# config.action_view.sanitized_allowed_tags = ['strong', 'em', 'a']
# config.action_view.sanitized_allowed_attributes = ['href', 'title']
def sanitize(html, options = {})
self.class.white_list_sanitizer.sanitize(html, options).try(:html_safe)
self.class.safe_list_sanitizer.sanitize(html, options).try(:html_safe)
end

# Sanitizes a block of CSS code. Used by +sanitize+ when it comes across a style attribute.
def sanitize_css(style)
self.class.white_list_sanitizer.sanitize_css(style)
self.class.safe_list_sanitizer.sanitize_css(style)
end

# Strips all HTML tags from +html+, including comments and special characters.
Expand Down Expand Up @@ -123,7 +123,7 @@ def strip_links(html)
end

module ClassMethods #:nodoc:
attr_writer :full_sanitizer, :link_sanitizer, :white_list_sanitizer
attr_writer :full_sanitizer, :link_sanitizer, :safe_list_sanitizer

# Vendors the full, link and white list sanitizers.
# Provided strictly for compatibility and can be removed in Rails 5.1.
Expand All @@ -132,11 +132,11 @@ def sanitizer_vendor
end

def sanitized_allowed_tags
sanitizer_vendor.white_list_sanitizer.allowed_tags
sanitizer_vendor.safe_list_sanitizer.allowed_tags
end

def sanitized_allowed_attributes
sanitizer_vendor.white_list_sanitizer.allowed_attributes
sanitizer_vendor.safe_list_sanitizer.allowed_attributes
end

# Gets the Rails::Html::FullSanitizer instance used by +strip_tags+. Replace with
Expand All @@ -145,7 +145,6 @@ def sanitized_allowed_attributes
# class Application < Rails::Application
# config.action_view.full_sanitizer = MySpecialSanitizer.new
# end
#
def full_sanitizer
@full_sanitizer ||= sanitizer_vendor.full_sanitizer.new
end
Expand All @@ -156,20 +155,18 @@ def full_sanitizer
# class Application < Rails::Application
# config.action_view.link_sanitizer = MySpecialSanitizer.new
# end
#
def link_sanitizer
@link_sanitizer ||= sanitizer_vendor.link_sanitizer.new
end

# Gets the Rails::Html::WhiteListSanitizer instance used by sanitize and +sanitize_css+.
# Gets the Rails::Html::SafeListSanitizer instance used by sanitize and +sanitize_css+.
# Replace with any object that responds to +sanitize+.
#
# class Application < Rails::Application
# config.action_view.white_list_sanitizer = MySpecialSanitizer.new
# config.action_view.safe_list_sanitizer = MySpecialSanitizer.new
# end
#
def white_list_sanitizer
@white_list_sanitizer ||= sanitizer_vendor.white_list_sanitizer.new
def safe_list_sanitizer
@safe_list_sanitizer ||= sanitizer_vendor.safe_list_sanitizer.new
end
end
end
Expand Down

0 comments on commit 2cd4bce

Please sign in to comment.