e4ac6bbf82
Fix invalid Atom feeds when using emoji, horizontal rules, or images This is a fix for issues #880, #723, #1113. Markdown must be rendered to XHTML, not HTML, when generating summary content for Atom feeds. Otherwise, content-less tags like *img* and *hr* are not terminated and make the Atom XML invalid. Such tags are generated when issue descriptions, merge request descriptions, comments, or commit messages use emoji, horizontal rules, or images. To pass this option through from the relevant Haml templates to the proper place in the `gfm()` method, a new method `gfm_with_options()` is introduced. It reuses the options dictionary passed to `markdown()` and interprets options `xhtml` and `parse_tasks` from it (the latter was a convenient replacement for `gfm_with_tasks()`). `xhtml` is already interpreted by Redcarpet::Render::HTML, but that alone was not sufficient, because the post-processing in `gfm()` would convert its XHTML tags back to HTML. I found no way of passing additional optional options to the existing `gfm()` method without requiring updates to existing callers and without getting in the way of the existing optional arguments, but maybe someone who knows more about Ruby than I can think of one. Thorough review appreciated since this is the first time I have used Ruby. See merge request !344
72 lines
2.3 KiB
Ruby
72 lines
2.3 KiB
Ruby
class Redcarpet::Render::GitlabHTML < Redcarpet::Render::HTML
|
|
|
|
attr_reader :template
|
|
alias_method :h, :template
|
|
|
|
def initialize(template, color_scheme, options = {})
|
|
@template = template
|
|
@color_scheme = color_scheme
|
|
@project = @template.instance_variable_get("@project")
|
|
@options = options.dup
|
|
super options
|
|
end
|
|
|
|
def preprocess(full_document)
|
|
# Redcarpet doesn't allow SMB links when `safe_links_only` is enabled.
|
|
# FTP links are allowed, so we trick Redcarpet.
|
|
full_document.gsub("smb://", "ftp://smb:")
|
|
end
|
|
|
|
# If project has issue number 39, apostrophe will be linked in
|
|
# regular text to the issue as Redcarpet will convert apostrophe to
|
|
# #39;
|
|
# We replace apostrophe with right single quote before Redcarpet
|
|
# does the processing and put the apostrophe back in postprocessing.
|
|
# This only influences regular text, code blocks are untouched.
|
|
def normal_text(text)
|
|
return text unless text.present?
|
|
text.gsub("'", "’")
|
|
end
|
|
|
|
# Stolen from Rugments::Plugins::Redcarpet as this module is not required
|
|
# from Rugments's gem root.
|
|
def block_code(code, language)
|
|
lexer = Rugments::Lexer.find_fancy(language, code) || Rugments::Lexers::PlainText
|
|
|
|
# XXX HACK: Redcarpet strips hard tabs out of code blocks,
|
|
# so we assume you're not using leading spaces that aren't tabs,
|
|
# and just replace them here.
|
|
if lexer.tag == 'make'
|
|
code.gsub! /^ /, "\t"
|
|
end
|
|
|
|
formatter = Rugments::Formatters::HTML.new(
|
|
cssclass: "code highlight #{@color_scheme} #{lexer.tag}"
|
|
)
|
|
formatter.format(lexer.lex(code))
|
|
end
|
|
|
|
def link(link, title, content)
|
|
h.link_to_gfm(content, link, title: title)
|
|
end
|
|
|
|
def header(text, level)
|
|
if @options[:no_header_anchors]
|
|
"<h#{level}>#{text}</h#{level}>"
|
|
else
|
|
id = ActionController::Base.helpers.strip_tags(h.gfm(text)).downcase() \
|
|
.gsub(/[^a-z0-9_-]/, '-').gsub(/-+/, '-').gsub(/^-/, '').gsub(/-$/, '')
|
|
"<h#{level} id=\"#{id}\">#{text}<a href=\"\##{id}\"></a></h#{level}>"
|
|
end
|
|
end
|
|
|
|
def postprocess(full_document)
|
|
full_document.gsub!("ftp://smb:", "smb://")
|
|
|
|
full_document.gsub!("’", "'")
|
|
unless @template.instance_variable_get("@project_wiki") || @project.nil?
|
|
full_document = h.create_relative_links(full_document)
|
|
end
|
|
h.gfm_with_options(full_document, @options)
|
|
end
|
|
end
|