user_reference_filter.rb 3.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 26
          yield match, $~[:user]
        end
      end

      def call
27
        replace_text_nodes_matching(User.reference_pattern) do |content|
28
          user_link_filter(content)
R
Robert Speicher 已提交
29 30 31 32 33 34 35 36 37 38 39
        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)
40 41 42 43 44
        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 已提交
45 46 47 48 49 50
          else
            match
          end
        end
      end

51 52 53
      private

      def urls
D
Douwe Maan 已提交
54
        Gitlab::Application.routes.url_helpers
R
Robert Speicher 已提交
55 56
      end

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

61 62 63 64 65 66 67 68 69
      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])

70 71
        text = User.reference_prefix + 'all'
        %(<a href="#{url}" class="#{link_class}">#{text}</a>)
R
Robert Speicher 已提交
72 73
      end

74 75 76 77 78 79 80 81 82
      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)
83
        push_result(:user, *namespace.users)
84

85
        url = urls.group_url(group, only_path: context[:only_path])
86
        data = data_attribute(namespace.id, :group)
87

88
        text = Group.reference_prefix + group
89
        %(<a href="#{url}" #{data} class="#{link_class}">#{text}</a>)
90 91 92 93 94 95
      end

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

        url = urls.user_url(user, only_path: context[:only_path])
96
        data = data_attribute(namespace.owner_id, :user)
97

98
        text = User.reference_prefix + user
99
        %(<a href="#{url}" #{data} class="#{link_class}">#{text}</a>)
R
Robert Speicher 已提交
100 101 102 103
      end
    end
  end
end