module GitlabMarkdownHelper include Gitlab::Markdown # Use this in places where you would normally use link_to(gfm(...), ...). # # It solves a problem occurring with nested links (i.e. # "outer text gfm ref more outer text"). This will not be # interpreted as intended. Browsers will parse something like # "outer text gfm ref more outer text" (notice the last part is # not linked any more). link_to_gfm corrects that. It wraps all parts to # explicitly produce the correct linking behavior (i.e. # "outer text gfm ref more outer text"). def link_to_gfm(body, url, html_options = {}) return "" if body.blank? escaped_body = if body =~ /^\.*?}m) do |match| "#{match}#{link_to("", url, html_options)[0..-5]}" # "".length +1 end link_to(gfm_body.html_safe, url, html_options) end def markdown(text) unless @markdown gitlab_renderer = Redcarpet::Render::GitlabHTML.new(self, # see https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderers-for-lunch- filter_html: true, with_toc_data: true, hard_wrap: true, safe_links_only: true) @markdown = Redcarpet::Markdown.new(gitlab_renderer, # see https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use no_intra_emphasis: true, tables: true, fenced_code_blocks: true, autolink: true, strikethrough: true, lax_html_blocks: true, space_after_headers: true, superscript: true) end @markdown.render(text).html_safe end def render_wiki_content(wiki_page) if wiki_page.format == :markdown markdown(wiki_page.content) else wiki_page.formatted_content.html_safe end end # text - whole text from a markdown file # project_path_with_namespace - namespace/projectname, eg. gitlabhq/gitlabhq # ref - name of the branch or reference, eg. stable # requested_path - path of request, eg. doc/api/README.md, used in special case when path is pointing to the .md file were the original request is coming from # wiki - whether the markdown is from wiki or not def create_relative_links(text, project, ref, requested_path, wiki = false) @path_to_satellite = project.satellite.path project_path_with_namespace = project.path_with_namespace paths = extract_paths(text) paths.each do |file_path| new_path = rebuild_path(project_path_with_namespace, file_path, requested_path, ref) # Replacing old string with a new one with brackets ]() to prevent replacing occurence of a word # e.g. If we have a markdown like [test](test) this will replace ](test) and not the word test text.gsub!("](#{file_path})", "](/#{new_path})") end text end def extract_paths(markdown_text) all_markdown_paths = pick_out_paths(markdown_text) paths = remove_empty(all_markdown_paths) select_relative(paths) end # Split the markdown text to each line and find all paths, this will match anything with - ]("some_text") def pick_out_paths(markdown_text) markdown_text.split("\n").map { |text| text.scan(/\]\(([^(]+)\)/) } end # Removes any empty result produced by not matching the regexp def remove_empty(paths) paths.reject{|l| l.empty? }.flatten end # Reject any path that contains ignored protocol # eg. reject "https://gitlab.org} but accept "doc/api/README.md" def select_relative(paths) paths.reject{|path| ignored_protocols.map{|protocol| path.include?(protocol)}.any?} end def ignored_protocols ["http://","https://", "ftp://", "mailto:"] end def rebuild_path(path_with_namespace, path, requested_path, ref) file_path = relative_file_path(path, requested_path) [ path_with_namespace, path_with_ref(file_path, ref), file_path ].compact.join("/") end # Checks if the path exists in the repo # eg. checks if doc/README.md exists, if it doesn't then it is a wiki link def path_with_ref(path, ref) if file_exists?(path) "#{local_path(path)}/#{correct_ref(ref)}" else "wikis" end end def relative_file_path(path, requested_path) nested_path = build_nested_path(path, requested_path) return nested_path if file_exists?(nested_path) path end # Covering a special case, when the link is referencing file in the same directory eg: # If we are at doc/api/README.md and the README.md contains relative links like [Users](users.md) # this takes the request path(doc/api/README.md), and replaces the README.md with users.md so the path looks like doc/api/users.md # If we are at doc/api and the README.md shown in below the tree view # this takes the rquest path(doc/api) and adds users.md so the path looks like doc/api/users.md def build_nested_path(path, request_path) return path unless request_path if local_path(request_path) == "tree" base = request_path.split("/").push(path) base.join("/") else base = request_path.split("/") base.pop base.push(path).join("/") end end def file_exists?(path) return false if path.nil? || path.empty? File.exists?(path_on_fs(path)) end # Check if the path is pointing to a directory(tree) or a file(blob) # eg. doc/api is directory and doc/README.md is file def local_path(path) File.directory?(path_on_fs(path)) ? "tree" : "blob" end # Path to the file in the satellites repository on the filesystem def path_on_fs(path) [@path_to_satellite, path].join("/") end # We will assume that if no ref exists we can point to master def correct_ref(ref) ref ? ref : "master" end end