user_reference_filter.rb 2.9 KB
Newer Older
R
Robert Speicher 已提交
1 2
module Gitlab
  module Markdown
3
    # HTML filter that replaces user or group references with links.
R
Robert Speicher 已提交
4 5
    #
    # A special `@all` reference is also supported.
6
    class UserReferenceFilter < ReferenceFilter
R
Robert Speicher 已提交
7 8 9 10 11 12 13 14 15 16 17 18
      # 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)
19
        text.gsub(User.reference_pattern) do |match|
R
Robert Speicher 已提交
20 21 22 23 24
          yield match, $~[:user]
        end
      end

      def call
25
        replace_text_nodes_matching(User.reference_pattern) do |content|
26
          user_link_filter(content)
R
Robert Speicher 已提交
27 28 29 30 31 32 33 34 35 36 37
        end
      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.
      def user_link_filter(text)
38 39 40 41 42
        self.class.references_in(text) do |match, username|
          if username == 'all'
            link_to_all
          elsif namespace = Namespace.find_by(path: username)
            link_to_namespace(namespace) || match
R
Robert Speicher 已提交
43 44 45 46 47 48
          else
            match
          end
        end
      end

49 50 51 52
      private

      def urls
        Rails.application.routes.url_helpers
R
Robert Speicher 已提交
53 54
      end

55 56
      def link_class
        reference_class(:project_member)
R
Robert Speicher 已提交
57 58
      end

59 60 61 62 63 64 65 66 67 68
      def link_to_all
        project = context[:project]

        # FIXME (rspeicher): Law of Demeter
        push_result(:user, *project.team.members.flatten)

        url = urls.namespace_project_url(project.namespace, project,
                                         only_path: context[:only_path])

        %(<a href="#{url}" class="#{link_class}">@all</a>)
R
Robert Speicher 已提交
69 70
      end

71 72 73 74 75 76 77 78 79
      def link_to_namespace(namespace)
        if namespace.is_a?(Group)
          link_to_group(namespace.path, namespace)
        else
          link_to_user(namespace.path, namespace)
        end
      end

      def link_to_group(group, namespace)
80
        return unless user_can_reference_group?(namespace)
81

82
        push_result(:user, *namespace.users)
83

84 85 86
        url = urls.group_url(group, only_path: context[:only_path])

        %(<a href="#{url}" class="#{link_class}">@#{group}</a>)
87 88 89 90 91 92 93 94
      end

      def link_to_user(user, namespace)
        push_result(:user, namespace.owner)

        url = urls.user_url(user, only_path: context[:only_path])

        %(<a href="#{url}" class="#{link_class}">@#{user}</a>)
R
Robert Speicher 已提交
95
      end
96

97
      def user_can_reference_group?(group)
98 99
        Ability.abilities.allowed?(context[:current_user], :read_group, group)
      end
R
Robert Speicher 已提交
100 101 102
    end
  end
end