148 lines
4.4 KiB
Ruby
148 lines
4.4 KiB
Ruby
module Banzai
|
|
module Filter
|
|
# HTML filter that replaces user or group references with links.
|
|
#
|
|
# A special `@all` reference is also supported.
|
|
class UserReferenceFilter < ReferenceFilter
|
|
self.reference_type = :user
|
|
|
|
# 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)
|
|
text.gsub(User.reference_pattern) do |match|
|
|
yield match, $~[:user]
|
|
end
|
|
end
|
|
|
|
def call
|
|
return doc if project.nil?
|
|
|
|
ref_pattern = User.reference_pattern
|
|
ref_pattern_start = /\A#{ref_pattern}\z/
|
|
|
|
nodes.each do |node|
|
|
if text_node?(node)
|
|
replace_text_when_pattern_matches(node, ref_pattern) do |content|
|
|
user_link_filter(content)
|
|
end
|
|
elsif element_node?(node)
|
|
yield_valid_link(node) do |link, text|
|
|
if link =~ ref_pattern_start
|
|
replace_link_node_with_href(node, link) do
|
|
user_link_filter(link, link_text: text)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
doc
|
|
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, link_text: nil)
|
|
self.class.references_in(text) do |match, username|
|
|
if username == 'all'
|
|
link_to_all(link_text: link_text)
|
|
elsif namespace = namespaces[username]
|
|
link_to_namespace(namespace, link_text: link_text) || match
|
|
else
|
|
match
|
|
end
|
|
end
|
|
end
|
|
|
|
# Returns a Hash containing all Namespace objects for the username
|
|
# references in the current document.
|
|
#
|
|
# The keys of this Hash are the namespace paths, the values the
|
|
# corresponding Namespace objects.
|
|
def namespaces
|
|
@namespaces ||=
|
|
Namespace.where(path: usernames).each_with_object({}) do |row, hash|
|
|
hash[row.path] = row
|
|
end
|
|
end
|
|
|
|
# Returns all usernames referenced in the current document.
|
|
def usernames
|
|
refs = Set.new
|
|
|
|
nodes.each do |node|
|
|
node.to_html.scan(User.reference_pattern) do
|
|
refs << $~[:user]
|
|
end
|
|
end
|
|
|
|
refs.to_a
|
|
end
|
|
|
|
private
|
|
|
|
def urls
|
|
Gitlab::Routing.url_helpers
|
|
end
|
|
|
|
def link_class
|
|
reference_class(:project_member)
|
|
end
|
|
|
|
def link_to_all(link_text: nil)
|
|
project = context[:project]
|
|
author = context[:author]
|
|
|
|
url = urls.namespace_project_url(project.namespace, project,
|
|
only_path: context[:only_path])
|
|
|
|
data = data_attribute(project: project.id, author: author.try(:id))
|
|
text = link_text || User.reference_prefix + 'all'
|
|
|
|
link_tag(url, data, text, 'All Project and Group Members')
|
|
end
|
|
|
|
def link_to_namespace(namespace, link_text: nil)
|
|
if namespace.is_a?(Group)
|
|
link_to_group(namespace.path, namespace, link_text: link_text)
|
|
else
|
|
link_to_user(namespace.path, namespace, link_text: link_text)
|
|
end
|
|
end
|
|
|
|
def link_to_group(group, namespace, link_text: nil)
|
|
url = urls.group_url(group, only_path: context[:only_path])
|
|
data = data_attribute(group: namespace.id)
|
|
text = link_text || Group.reference_prefix + group
|
|
|
|
link_tag(url, data, text, namespace.name)
|
|
end
|
|
|
|
def link_to_user(user, namespace, link_text: nil)
|
|
url = urls.user_url(user, only_path: context[:only_path])
|
|
data = data_attribute(user: namespace.owner_id)
|
|
text = link_text || User.reference_prefix + user
|
|
|
|
link_tag(url, data, text, namespace.owner_name)
|
|
end
|
|
|
|
def link_tag(url, data, text, title)
|
|
%(<a href="#{url}" #{data} class="#{link_class}" title="#{escape_once(title)}">#{escape_once(text)}</a>)
|
|
end
|
|
end
|
|
end
|
|
end
|