user_reference_filter.rb 4.0 KB
Newer Older
1 2
require 'gitlab/markdown'

R
Robert Speicher 已提交
3 4
module Gitlab
  module Markdown
5
    # HTML filter that replaces user or group references with links.
R
Robert Speicher 已提交
6 7
    #
    # A special `@all` reference is also supported.
8
    class UserReferenceFilter < ReferenceFilter
R
Robert Speicher 已提交
9 10 11 12 13 14 15 16 17 18 19 20
      # Public: Find `@user` user references in text
      #
      #   UserReferenceFilter.references_in(text) do |match, username|
      #     "<a href=...>@#{user}</a>"
      #   end
      #
      # text - String text to search.
      #
      # Yields the String match, and the String user name.
      #
      # Returns a String replaced with the return of the block.
      def self.references_in(text)
21
        text.gsub(User.reference_pattern) do |match|
R
Robert Speicher 已提交
22 23 24 25
          yield match, $~[:user]
        end
      end

26 27 28 29 30 31 32
      def self.referenced_by(node)
        if node.has_attribute?('data-group')
          group = Group.find(node.attr('data-group')) rescue nil
          return unless group

          { user: group.users }
        elsif node.has_attribute?('data-user')
33
          { user: LazyReference.new(User, node.attr('data-user')) }
34 35 36 37 38 39 40 41
        elsif node.has_attribute?('data-project')
          project = Project.find(node.attr('data-project')) rescue nil
          return unless project

          { user: project.team.members.flatten }
        end
      end

42
      def self.user_can_reference?(user, node, context)
43 44 45 46 47 48 49 50
        if node.has_attribute?('data-group')
          group = Group.find(node.attr('data-group')) rescue nil
          Ability.abilities.allowed?(user, :read_group, group)
        else
          super
        end
      end

R
Robert Speicher 已提交
51
      def call
52
        replace_text_nodes_matching(User.reference_pattern) do |content|
53
          user_link_filter(content)
R
Robert Speicher 已提交
54
        end
D
Douwe Maan 已提交
55 56 57 58

        replace_link_nodes_with_href(User.reference_pattern) do |link, text|
          user_link_filter(link, link_text: text)
        end
R
Robert Speicher 已提交
59 60 61 62 63 64 65 66 67
      end

      # Replace `@user` user references in text with links to the referenced
      # user's profile page.
      #
      # text - String text to replace references in.
      #
      # Returns a String with `@user` references replaced with links. All links
      # have `gfm` and `gfm-project_member` class names attached for styling.
D
Douwe Maan 已提交
68
      def user_link_filter(text, link_text: nil)
69 70
        self.class.references_in(text) do |match, username|
          if username == 'all'
D
Douwe Maan 已提交
71
            link_to_all(link_text: link_text)
72
          elsif namespace = Namespace.find_by(path: username)
D
Douwe Maan 已提交
73
            link_to_namespace(namespace, link_text: link_text) || match
R
Robert Speicher 已提交
74 75 76 77 78 79
          else
            match
          end
        end
      end

80 81 82
      private

      def urls
D
Douwe Maan 已提交
83
        Gitlab::Application.routes.url_helpers
R
Robert Speicher 已提交
84 85
      end

86 87
      def link_class
        reference_class(:project_member)
R
Robert Speicher 已提交
88 89
      end

D
Douwe Maan 已提交
90
      def link_to_all(link_text: nil)
91 92 93
        project = context[:project]
        url = urls.namespace_project_url(project.namespace, project,
                                         only_path: context[:only_path])
94
        data = data_attribute(project: project.id)
D
Douwe Maan 已提交
95
        text = link_text || User.reference_prefix + 'all'
96 97

        link_tag(url, data, text)
R
Robert Speicher 已提交
98 99
      end

D
Douwe Maan 已提交
100
      def link_to_namespace(namespace, link_text: nil)
101
        if namespace.is_a?(Group)
D
Douwe Maan 已提交
102
          link_to_group(namespace.path, namespace, link_text: link_text)
103
        else
D
Douwe Maan 已提交
104
          link_to_user(namespace.path, namespace, link_text: link_text)
105 106 107
        end
      end

D
Douwe Maan 已提交
108
      def link_to_group(group, namespace, link_text: nil)
109
        url = urls.group_url(group, only_path: context[:only_path])
110
        data = data_attribute(group: namespace.id)
D
Douwe Maan 已提交
111
        text = link_text || Group.reference_prefix + group
112 113

        link_tag(url, data, text)
114 115
      end

D
Douwe Maan 已提交
116
      def link_to_user(user, namespace, link_text: nil)
117
        url = urls.user_url(user, only_path: context[:only_path])
118
        data = data_attribute(user: namespace.owner_id)
D
Douwe Maan 已提交
119
        text = link_text || User.reference_prefix + user
120 121 122 123 124

        link_tag(url, data, text)
      end

      def link_tag(url, data, text)
125
        %(<a href="#{url}" #{data} class="#{link_class}">#{text}</a>)
R
Robert Speicher 已提交
126 127 128 129
      end
    end
  end
end