2018-10-22 07:00:50 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2013-05-30 23:16:49 +00:00
|
|
|
module Gitlab
|
|
|
|
# Extract possible GFM references from an arbitrary String for further processing.
|
2015-12-15 14:51:16 +00:00
|
|
|
class ReferenceExtractor < Banzai::ReferenceExtractor
|
2019-12-10 15:07:52 +00:00
|
|
|
REFERABLES = %i(user issue label milestone mentioned_user mentioned_group mentioned_project
|
2020-11-17 21:09:19 +00:00
|
|
|
merge_request snippet commit commit_range directly_addressed_user epic iteration vulnerability).freeze
|
2015-12-24 14:33:51 +00:00
|
|
|
attr_accessor :project, :current_user, :author
|
2013-05-30 23:16:49 +00:00
|
|
|
|
2016-05-26 11:16:43 +00:00
|
|
|
def initialize(project, current_user = nil)
|
2015-03-27 10:37:45 +00:00
|
|
|
@project = project
|
2015-03-27 11:58:23 +00:00
|
|
|
@current_user = current_user
|
2015-10-22 13:40:36 +00:00
|
|
|
@references = {}
|
2015-12-15 14:51:16 +00:00
|
|
|
|
|
|
|
super()
|
2015-10-14 19:29:35 +00:00
|
|
|
end
|
2015-10-14 17:27:23 +00:00
|
|
|
|
2015-12-15 14:51:16 +00:00
|
|
|
def analyze(text, context = {})
|
|
|
|
super(text, context.merge(project: project))
|
2013-05-30 23:16:49 +00:00
|
|
|
end
|
|
|
|
|
2021-06-28 21:10:13 +00:00
|
|
|
def references(type, ids_only: false)
|
|
|
|
refs = super(type, project, current_user, ids_only: ids_only)
|
2021-08-26 18:10:35 +00:00
|
|
|
update_visible_nodes_set(refs[:nodes], refs[:visible_nodes])
|
2020-01-30 21:08:47 +00:00
|
|
|
|
|
|
|
refs[:visible]
|
2016-05-26 11:16:43 +00:00
|
|
|
end
|
|
|
|
|
2021-08-26 18:10:35 +00:00
|
|
|
# this method is stateful, it tracks if all nodes from `references`
|
|
|
|
# calls are visible or not
|
|
|
|
def all_visible?
|
|
|
|
not_visible_nodes.empty?
|
|
|
|
end
|
|
|
|
|
2016-12-05 12:12:22 +00:00
|
|
|
def reset_memoized_values
|
|
|
|
@references = {}
|
|
|
|
super()
|
|
|
|
end
|
|
|
|
|
2016-03-07 12:09:53 +00:00
|
|
|
REFERABLES.each do |type|
|
2020-11-17 21:09:19 +00:00
|
|
|
define_method(type.to_s.pluralize) do
|
2016-05-26 11:16:43 +00:00
|
|
|
@references[type] ||= references(type)
|
2015-06-02 11:17:11 +00:00
|
|
|
end
|
2021-06-28 21:10:13 +00:00
|
|
|
|
|
|
|
if %w(mentioned_user mentioned_group mentioned_project).include?(type.to_s)
|
|
|
|
define_method("#{type}_ids") do
|
|
|
|
@references[type] ||= references(type, ids_only: true)
|
|
|
|
end
|
|
|
|
end
|
2013-05-30 23:16:49 +00:00
|
|
|
end
|
2015-12-17 22:08:14 +00:00
|
|
|
|
|
|
|
def issues
|
2020-03-13 06:09:37 +00:00
|
|
|
if project&.external_references_supported?
|
2017-07-10 07:38:42 +00:00
|
|
|
if project.issues_enabled?
|
|
|
|
@references[:all_issues] ||= references(:external_issue) + references(:issue)
|
|
|
|
else
|
|
|
|
@references[:external_issue] ||= references(:external_issue) +
|
|
|
|
references(:issue).select { |i| i.project_id != project.id }
|
|
|
|
end
|
2015-12-17 22:08:14 +00:00
|
|
|
else
|
2016-05-26 11:16:43 +00:00
|
|
|
@references[:issue] ||= references(:issue)
|
2015-12-17 22:08:14 +00:00
|
|
|
end
|
|
|
|
end
|
2015-12-24 14:33:51 +00:00
|
|
|
|
2016-03-07 12:09:53 +00:00
|
|
|
def all
|
2017-08-04 02:20:34 +00:00
|
|
|
REFERABLES.each { |referable| send(referable.to_s.pluralize) } # rubocop:disable GitlabSecurity/PublicSend
|
2016-03-07 12:09:53 +00:00
|
|
|
@references.values.flatten
|
|
|
|
end
|
|
|
|
|
2016-03-18 13:48:55 +00:00
|
|
|
def self.references_pattern
|
|
|
|
return @pattern if @pattern
|
|
|
|
|
2019-10-17 12:07:33 +00:00
|
|
|
patterns = REFERABLES.map do |type|
|
|
|
|
Banzai::ReferenceParser[type].reference_type.to_s.classify.constantize.try(:reference_pattern)
|
|
|
|
end.uniq
|
2016-03-18 13:48:55 +00:00
|
|
|
|
|
|
|
@pattern = Regexp.union(patterns.compact)
|
|
|
|
end
|
2021-08-26 18:10:35 +00:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def update_visible_nodes_set(all, visible)
|
|
|
|
not_visible_nodes.merge(all)
|
|
|
|
not_visible_nodes.subtract(visible)
|
|
|
|
end
|
|
|
|
|
|
|
|
def not_visible_nodes
|
|
|
|
@not_visible_nodes ||= Set.new
|
|
|
|
end
|
2013-05-30 23:16:49 +00:00
|
|
|
end
|
|
|
|
end
|