docbrown/app/labor/markdown_parser.rb
rhymes 6553f08d94 Rubocop cleanups (#1415)
* Update rubocop-todo.yml with new violations

* Fix Layout/EmptyLine* rules

* Fix Layout/Indentation* rules

* Fix remaining Layout/* rules

* Fix Lint/DuplicateMethods by removing unused accessor

* Fix Lint/IneffectiveAccessModifier

* Fix Lint/MissingCopEnableDirective

* Re-run rubocop auto gen config

* Fix Layout/RescueEnsureAlignment

* Fix Naming/* rules

* Fix some RSpec/* rules

* Fix typos

* Fix RSpec/LetBeforeExamples

* Series should only be an attr_writer, not an attr_accessor

* Fix RSpec/InstanceVariable

* Fix RSpec/InstanceVariable

* Fix RSpec/RepeatedDescription and RSpec/RepeatedExample

* Fix Style/ClassAndModuleChildren

* Fix Style/ConditionalAssignment

* Fix some Style/* rules

* Trigger Travis CI build because failing tests are not failing locally

* Revert "Fix Style/ClassAndModuleChildren"

This reverts commit 1686801d8a1516ba1894f79e24401a20dea65f99.
2019-01-02 11:20:02 -05:00

221 lines
6.8 KiB
Ruby

class MarkdownParser
include ApplicationHelper
include CloudinaryHelper
def initialize(content)
@content = content
end
def finalize
renderer = Redcarpet::Render::HTMLRouge.new(hard_wrap: true, filter_html: false)
markdown = Redcarpet::Markdown.new(renderer, REDCARPET_CONFIG)
catch_xss_attempts(@content)
escaped_content = escape_liquid_tags_in_codeblock(@content)
html = markdown.render(escaped_content)
sanitized_content = sanitize_rendered_markdown(html)
begin
parsed_liquid = Liquid::Template.parse(sanitized_content)
rescue StandardError => e
raise StandardError, e.message
end
html = markdown.render(parsed_liquid.render)
html = remove_nested_linebreak_in_list(html)
html = prefix_all_images(html)
html = wrap_all_images_in_links(html)
html = wrap_all_tables(html)
html = remove_empty_paragraphs(html)
wrap_mentions_with_links!(html)
end
def calculate_reading_time
word_count = @content.split(/\W+/).count
(word_count / 275.0).ceil
end
def evaluate_markdown
return if @content.blank?
renderer = Redcarpet::Render::HTMLRouge.new(hard_wrap: true, filter_html: false)
markdown = Redcarpet::Markdown.new(renderer, REDCARPET_CONFIG)
allowed_tags = %w(strong abbr aside em p h1 h2 h3 h4 h5 h6 i u b code pre
br ul ol li small sup sub img a span hr blockquote)
allowed_attributes = %w(href strong em ref rel src title alt class)
ActionController::Base.helpers.sanitize markdown.render(@content).html_safe,
tags: allowed_tags,
attributes: allowed_attributes
end
def evaluate_limited_markdown
return if @content.blank?
renderer = Redcarpet::Render::HTMLRouge.new(hard_wrap: true, filter_html: false)
markdown = Redcarpet::Markdown.new(renderer, REDCARPET_CONFIG)
allowed_tags = %w(strong i u b em p br code)
allowed_attributes = %w(href strong em ref rel src title alt class)
ActionController::Base.helpers.sanitize markdown.render(@content).html_safe,
tags: allowed_tags,
attributes: allowed_attributes
end
def evaluate_inline_markdown
return if @content.blank?
renderer_options = {
hard_wrap: true,
filter_html: false,
link_attributes: { rel: "noopener noreferrer", target: "_blank" }
}
renderer = Redcarpet::Render::HTMLRouge.new(renderer_options)
markdown = Redcarpet::Markdown.new(renderer, REDCARPET_CONFIG)
ActionController::Base.helpers.sanitize(markdown.render(@content).html_safe,
tags: %w(strong i u b em code a br pre), attributes: %w(href rel target))
end
def tags_used
return [] unless @content.present?
cleaned_parsed = escape_liquid_tags_in_codeblock(@content)
tags = []
Liquid::Template.parse(cleaned_parsed).root.nodelist.each do |node|
if node.class.superclass.to_s == LiquidTagBase.to_s
tags << node.class
end
end
tags.uniq
end
def prefix_all_images(html, width = 880)
# wrap with Cloudinary or allow if from giphy or githubusercontent.com
doc = Nokogiri::HTML.fragment(html)
doc.css("img").each do |img|
src = img.attr("src")
next unless src
# allow image to render as-is
next if allowed_image_host?(src)
img["src"] = if giphy_img?(src)
src.gsub("https://media.", "https://i.")
else
img_of_size(src, width)
end
end
doc.to_html
end
private
def catch_xss_attempts(markdown)
bad_xss = ['src="data', "src='data", "src='&", 'src="&', "data:text/html"]
bad_xss.each do |xss_attempt|
raise if markdown.include?(xss_attempt)
end
end
def allowed_image_host?(src)
# GitHub camo image won't parse but should be safe to host direct
src.start_with?("https://camo.githubusercontent.com/")
end
def giphy_img?(source)
uri = URI.parse(source)
return false if uri.scheme != "https"
return false if uri.userinfo || uri.fragment || uri.query
return false if uri.host != "media.giphy.com" && uri.host != "i.giphy.com"
return false if uri.port != 443 # I think it has to be this if its https?
uri.path.ends_with?(".gif")
end
def remove_nested_linebreak_in_list(html)
html_doc = Nokogiri::HTML(html)
html_doc.xpath("//*[self::ul or self::ol or self::li]/br").each(&:remove)
html_doc.to_html
end
def escape_liquid_tags_in_codeblock(content)
# Escape BOTH codeblock and inline code
content.gsub(/`{3}.*?`{3}|`{1}.+?`{1}/m) do |codeblock|
if codeblock.include?("```")
"\n{% raw %}\n" + codeblock + "\n{% endraw %}\n"
else
"{% raw %}" + codeblock + "{% endraw %}"
end
# Below is the old implementation that replaces all liquid tag.
# codeblock.gsub(/{%.{1,}[^}]{2}%}/) do |liquid_tag|
# liquid_tag.gsub(/{%/, '{{ "{%').gsub(/%}/, '" }}%}')
# end
end
end
def wrap_mentions_with_links!(html)
html_doc = Nokogiri::HTML(html)
html_doc.xpath("//body/*[not (@class='highlight')]").each do |el|
el.children.each do |child|
if child.text?
new_child = child.text.gsub(/\B@[a-z0-9_-]+/i) do |s|
user_link_if_exists(s)
end
child.replace(new_child) if new_child != child.text
end
end
end
html_doc.to_html
end
def user_link_if_exists(mention)
username = mention.gsub("@", "").downcase
if User.find_by_username(username)
<<~HTML
<a class='comment-mentioned-user' href='#{ApplicationConfig['APP_PROTOCOL']}#{ApplicationConfig['APP_DOMAIN']}/#{username}'>@#{username}</a>
HTML
else
mention
end
end
def img_of_size(source, width = 880)
quality = if source && (source.include? ".gif")
66
else
"auto"
end
cl_image_path(source,
type: "fetch",
width: width,
crop: "limit",
quality: quality,
flags: "progressive",
fetch_format: "auto",
sign_url: true).gsub(",", "%2C")
end
def wrap_all_images_in_links(html)
doc = Nokogiri::HTML.fragment(html)
doc.search("p img").each do |i|
unless i.parent.name == "a"
i.swap("<a href='#{i.attr('src')}' class='article-body-image-wrapper'>#{i}</a>")
end
end
doc.to_html
end
def remove_empty_paragraphs(html)
doc = Nokogiri::HTML.fragment(html)
doc.css("p").select { |p| all_children_are_blank?(p) }.each(&:remove)
doc.to_html
end
def wrap_all_tables(html)
doc = Nokogiri::HTML.fragment(html)
doc.search("table").each { |i| i.swap("<div class='table-wrapper-paragraph'>#{i}</div>") }
doc.to_html
end
def all_children_are_blank?(node)
node.children.all? { |child| blank?(child) }
end
def blank?(node)
(node.text? && node.content.strip == "") || (node.element? && node.name == "br")
end
end