summaryrefslogtreecommitdiff
path: root/lib/banzai/redactor.rb
blob: ffd267d5e9ae48421f8868c1099d73fc0d670363 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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