d470f3d195
This commit changes the way certain documents are rendered (currently only Notes) and how documents are redacted. Previously both rendering and redacting would run on a per document basis. The result of this was that for every document we'd have to run countless queries just to figure out if we could display a set of links or not. This commit changes things around so that redacting Markdown documents is no longer tied into the html-pipeline Gem. This in turn allows it to redact multiple documents in a single pass, thus reducing the number of queries needed. In turn rendering issue/merge request notes has been adjusted to take advantage of this new setup. Instead of rendering Markdown somewhere deep down in a view the Markdown is rendered and redacted in the controller (taking the current user and all that into account). This has been done in such a way that the "markdown()" helper method can still be used on its own. This particular commit also paves the way for caching rendered HTML on object level. Right now there's an accessor method Note#note_html which is used for setting/getting the rendered HTML. Once we cache HTML on row level we can simply change this field to be a column and call a "save" whenever needed and we're pretty much done.
69 lines
1.8 KiB
Ruby
69 lines
1.8 KiB
Ruby
module Banzai
|
|
# Class for removing Markdown references a certain user is not allowed to
|
|
# view.
|
|
class Redactor
|
|
attr_reader :user, :project
|
|
|
|
# project - A Project to use for redacting links.
|
|
# user - The currently logged in user (if any).
|
|
def initialize(project, user = nil)
|
|
@project = project
|
|
@user = user
|
|
end
|
|
|
|
# Redacts the references in the given Array of documents.
|
|
#
|
|
# This method modifies the given documents in-place.
|
|
#
|
|
# documents - A list of HTML documents containing references to redact.
|
|
#
|
|
# Returns the documents passed as the first argument.
|
|
def redact(documents)
|
|
nodes = documents.flat_map do |document|
|
|
Querying.css(document, 'a.gfm[data-reference-type]')
|
|
end
|
|
|
|
redact_nodes(nodes)
|
|
|
|
documents
|
|
end
|
|
|
|
# Redacts the given nodes
|
|
#
|
|
# nodes - An Array of HTML nodes to redact.
|
|
def redact_nodes(nodes)
|
|
visible = nodes_visible_to_user(nodes)
|
|
|
|
nodes.each do |node|
|
|
unless visible.include?(node)
|
|
# The reference should be replaced by the original text,
|
|
# which is not always the same as the rendered text.
|
|
text = node.attr('data-original') || node.text
|
|
node.replace(text)
|
|
end
|
|
end
|
|
end
|
|
|
|
# Returns the nodes visible to the current user.
|
|
#
|
|
# nodes - The input nodes to check.
|
|
#
|
|
# Returns a new Array containing the visible nodes.
|
|
def nodes_visible_to_user(nodes)
|
|
per_type = Hash.new { |h, k| h[k] = [] }
|
|
visible = Set.new
|
|
|
|
nodes.each do |node|
|
|
per_type[node.attr('data-reference-type')] << node
|
|
end
|
|
|
|
per_type.each do |type, nodes|
|
|
parser = Banzai::ReferenceParser[type].new(project, user)
|
|
|
|
visible.merge(parser.nodes_visible_to_user(user, nodes))
|
|
end
|
|
|
|
visible
|
|
end
|
|
end
|
|
end
|