From 1b1ba6b0a51cda30df2fe68fa577f6045d187b86 Mon Sep 17 00:00:00 2001 From: Vinnie Okada Date: Wed, 1 Oct 2014 10:31:13 -0500 Subject: Implement cross-project Markdown references Enable linking to commits, merge requests, and issues in other projects by prepending a namespaced project path to the reference. --- lib/gitlab/markdown.rb | 90 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 59 insertions(+), 31 deletions(-) (limited to 'lib') diff --git a/lib/gitlab/markdown.rb b/lib/gitlab/markdown.rb index d346acf0d32..8380193deb3 100644 --- a/lib/gitlab/markdown.rb +++ b/lib/gitlab/markdown.rb @@ -108,15 +108,18 @@ module Gitlab text end + NAME_STR = '[a-zA-Z][a-zA-Z0-9_\-\.]*' + PROJ_STR = "(?#{NAME_STR}/#{NAME_STR})" + REFERENCE_PATTERN = %r{ (?\W)? # Prefix ( # Reference - @(?[a-zA-Z][a-zA-Z0-9_\-\.]*) # User name + @(?#{NAME_STR}) # User name |(?([A-Z\-]+-)\d+) # JIRA Issue ID - |\#(?([a-zA-Z\-]+-)?\d+) # Issue ID - |!(?\d+) # MR ID + |#{PROJ_STR}?\#(?([a-zA-Z\-]+-)?\d+) # Issue ID + |#{PROJ_STR}?!(?\d+) # MR ID |\$(?\d+) # Snippet ID - |(?[\h]{6,40}) # Commit ID + |(#{PROJ_STR}@)?(?[\h]{6,40}) # Commit ID |(?gfm-extraction-[\h]{6,40}) # Skip gfm extractions. Otherwise will be parsed as commit ) (?\W)? # Suffix @@ -127,38 +130,57 @@ module Gitlab def parse_references(text, project = @project) # parse reference links text.gsub!(REFERENCE_PATTERN) do |match| - prefix = $~[:prefix] - suffix = $~[:suffix] type = TYPES.select{|t| !$~[t].nil?}.first - if type - identifier = $~[type] - - # Avoid HTML entities - if prefix && suffix && prefix[0] == '&' && suffix[-1] == ';' - match - elsif ref_link = reference_link(type, identifier, project) - "#{prefix}#{ref_link}#{suffix}" - else - match - end - else - match + actual_project = project + project_prefix = nil + project_path = $LAST_MATCH_INFO[:project] + if project_path + actual_project = ::Project.find_with_namespace(project_path) + project_prefix = project_path end + + parse_result($LAST_MATCH_INFO, type, + actual_project, project_prefix) || match + end + end + + # Called from #parse_references. Attempts to build a gitlab reference + # link. Returns nil if either +type+ or +project+ are nil, if the match + # string is an HTML entity, or if the reference is invalid. + def parse_result(match_info, type, project, project_prefix) + prefix = match_info[:prefix] + suffix = match_info[:suffix] + + return nil if html_entity?(prefix, suffix) || project.nil? || type.nil? + + identifier = match_info[type] + ref_link = reference_link(type, identifier, project, project_prefix) + + if ref_link + "#{prefix}#{ref_link}#{suffix}" + else + nil end end + # Return true if the +prefix+ and +suffix+ indicate that the matched string + # is an HTML entity like & + def html_entity?(prefix, suffix) + prefix && suffix && prefix[0] == '&' && suffix[-1] == ';' + end + # Private: Dispatches to a dedicated processing method based on reference # # reference - Object reference ("@1234", "!567", etc.) # identifier - Object identifier (Issue ID, SHA hash, etc.) # # Returns string rendered by the processing method - def reference_link(type, identifier, project = @project) - send("reference_#{type}", identifier, project) + def reference_link(type, identifier, project = @project, prefix_text = nil) + send("reference_#{type}", identifier, project, prefix_text) end - def reference_user(identifier, project = @project) + def reference_user(identifier, project = @project, _ = nil) options = html_options.merge( class: "gfm gfm-team_member #{html_options[:class]}" ) @@ -170,17 +192,17 @@ module Gitlab end end - def reference_issue(identifier, project = @project) + def reference_issue(identifier, project = @project, prefix_text = nil) if project.used_default_issues_tracker? || !external_issues_tracker_enabled? if project.issue_exists? identifier url = url_for_issue(identifier, project) - title = title_for_issue(identifier) + title = title_for_issue(identifier, project) options = html_options.merge( title: "Issue: #{title}", class: "gfm gfm-issue #{html_options[:class]}" ) - link_to("##{identifier}", url, options) + link_to("#{prefix_text}##{identifier}", url, options) end else config = Gitlab.config @@ -191,18 +213,19 @@ module Gitlab end end - def reference_merge_request(identifier, project = @project) + def reference_merge_request(identifier, project = @project, + prefix_text = nil) if merge_request = project.merge_requests.find_by(iid: identifier) options = html_options.merge( title: "Merge Request: #{merge_request.title}", class: "gfm gfm-merge_request #{html_options[:class]}" ) url = project_merge_request_url(project, merge_request) - link_to("!#{identifier}", url, options) + link_to("#{prefix_text}!#{identifier}", url, options) end end - def reference_snippet(identifier, project = @project) + def reference_snippet(identifier, project = @project, _ = nil) if snippet = project.snippets.find_by(id: identifier) options = html_options.merge( title: "Snippet: #{snippet.title}", @@ -213,17 +236,22 @@ module Gitlab end end - def reference_commit(identifier, project = @project) + def reference_commit(identifier, project = @project, prefix_text = nil) if project.valid_repo? && commit = project.repository.commit(identifier) options = html_options.merge( title: commit.link_title, class: "gfm gfm-commit #{html_options[:class]}" ) - link_to(identifier, project_commit_url(project, commit), options) + link_to( + "#{prefix_text}#{identifier}", + project_commit_url(project, commit), + options + ) end end - def reference_external_issue(identifier, issue_tracker, project = @project) + def reference_external_issue(identifier, issue_tracker, project = @project, + _ = nil) url = url_for_issue(identifier, project) title = issue_tracker['title'] -- cgit v1.2.1 From 7edc1439fe11e396bb6327a3f50aca5dfe3c411c Mon Sep 17 00:00:00 2001 From: Vinnie Okada Date: Wed, 1 Oct 2014 13:45:26 -0500 Subject: Fix ReferenceExtractor The cross-project reference feature broke the ReferenceExtractor class; this fixes it. --- lib/gitlab/markdown.rb | 8 +++++--- lib/gitlab/reference_extractor.rb | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'lib') diff --git a/lib/gitlab/markdown.rb b/lib/gitlab/markdown.rb index 8380193deb3..51c33f7cb1d 100644 --- a/lib/gitlab/markdown.rb +++ b/lib/gitlab/markdown.rb @@ -146,13 +146,15 @@ module Gitlab end # Called from #parse_references. Attempts to build a gitlab reference - # link. Returns nil if either +type+ or +project+ are nil, if the match - # string is an HTML entity, or if the reference is invalid. + # link. Returns nil if +type+ is nil, if the match string is an HTML + # entity, if the reference is invalid, or if the matched text includes an + # invalid project path. def parse_result(match_info, type, project, project_prefix) prefix = match_info[:prefix] suffix = match_info[:suffix] - return nil if html_entity?(prefix, suffix) || project.nil? || type.nil? + return nil if html_entity?(prefix, suffix) || type.nil? + return nil if project.nil? && !project_prefix.nil? identifier = match_info[type] ref_link = reference_link(type, identifier, project, project_prefix) diff --git a/lib/gitlab/reference_extractor.rb b/lib/gitlab/reference_extractor.rb index 73b19ad55d5..d2f02f712ce 100644 --- a/lib/gitlab/reference_extractor.rb +++ b/lib/gitlab/reference_extractor.rb @@ -51,7 +51,7 @@ module Gitlab private - def reference_link(type, identifier, project) + def reference_link(type, identifier, _, _) # Append identifier to the appropriate collection. send("#{type}s") << identifier end -- cgit v1.2.1 From 2c46c4523fc8aa41cb60e4840af16fdd595f7dd2 Mon Sep 17 00:00:00 2001 From: Vinnie Okada Date: Thu, 2 Oct 2014 13:26:39 -0500 Subject: Track projects in ReferenceExtractor Store both the project and identifier of extracted references. This prevents `ReferenceExtractor` from returning objects in the wrong project for cross-project references. --- lib/gitlab/closing_issue_extractor.rb | 2 +- lib/gitlab/reference_extractor.rb | 52 +++++++++++++++++++++-------------- 2 files changed, 33 insertions(+), 21 deletions(-) (limited to 'lib') diff --git a/lib/gitlab/closing_issue_extractor.rb b/lib/gitlab/closing_issue_extractor.rb index 90f1370c209..401e6e047b1 100644 --- a/lib/gitlab/closing_issue_extractor.rb +++ b/lib/gitlab/closing_issue_extractor.rb @@ -6,7 +6,7 @@ module Gitlab md = ISSUE_CLOSING_REGEX.match(message) if md extractor = Gitlab::ReferenceExtractor.new - extractor.analyze(md[0]) + extractor.analyze(md[0], project) extractor.issues_for(project) else [] diff --git a/lib/gitlab/reference_extractor.rb b/lib/gitlab/reference_extractor.rb index d2f02f712ce..99165950aef 100644 --- a/lib/gitlab/reference_extractor.rb +++ b/lib/gitlab/reference_extractor.rb @@ -9,51 +9,63 @@ module Gitlab @users, @issues, @merge_requests, @snippets, @commits = [], [], [], [], [] end - def analyze(string) - parse_references(string.dup) + def analyze(string, project) + parse_references(string.dup, project) end # Given a valid project, resolve the extracted identifiers of the requested type to # model objects. def users_for(project) - users.map do |identifier| - project.users.where(username: identifier).first + users.map do |entry| + project.users.where(username: entry[:id]).first end.reject(&:nil?) end - def issues_for(project) - issues.map do |identifier| - project.issues.where(iid: identifier).first + def issues_for(project = nil) + issues.map do |entry| + if should_lookup?(project, entry[:project]) + entry[:project].issues.where(iid: entry[:id]).first + end end.reject(&:nil?) end - def merge_requests_for(project) - merge_requests.map do |identifier| - project.merge_requests.where(iid: identifier).first + def merge_requests_for(project = nil) + merge_requests.map do |entry| + if should_lookup?(project, entry[:project]) + entry[:project].merge_requests.where(iid: entry[:id]).first + end end.reject(&:nil?) end def snippets_for(project) - snippets.map do |identifier| - project.snippets.where(id: identifier).first + snippets.map do |entry| + project.snippets.where(id: entry[:id]).first end.reject(&:nil?) end - def commits_for(project) - repo = project.repository - return [] if repo.nil? - - commits.map do |identifier| - repo.commit(identifier) + def commits_for(project = nil) + commits.map do |entry| + repo = entry[:project].repository if entry[:project] + if should_lookup?(project, entry[:project]) + repo.commit(entry[:id]) if repo + end end.reject(&:nil?) end private - def reference_link(type, identifier, _, _) + def reference_link(type, identifier, project, _) # Append identifier to the appropriate collection. - send("#{type}s") << identifier + send("#{type}s") << { project: project, id: identifier } + end + + def should_lookup?(project, entry_project) + if entry_project.nil? + false + else + project.nil? || project.id == entry_project.id + end end end end -- cgit v1.2.1 From bcf88c85597d8a40a209f4aa24cd6015f66d97c6 Mon Sep 17 00:00:00 2001 From: Vinnie Okada Date: Sun, 5 Oct 2014 10:12:53 -0500 Subject: Fix external issue links Display the project path in links to issues in other projects that use an external issue tracker. --- lib/gitlab/markdown.rb | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'lib') diff --git a/lib/gitlab/markdown.rb b/lib/gitlab/markdown.rb index 51c33f7cb1d..9b3e34653af 100644 --- a/lib/gitlab/markdown.rb +++ b/lib/gitlab/markdown.rb @@ -210,7 +210,8 @@ module Gitlab config = Gitlab.config external_issue_tracker = config.issues_tracker[project.issues_tracker] if external_issue_tracker.present? - reference_external_issue(identifier, external_issue_tracker, project) + reference_external_issue(identifier, external_issue_tracker, project, + prefix_text) end end end @@ -253,7 +254,7 @@ module Gitlab end def reference_external_issue(identifier, issue_tracker, project = @project, - _ = nil) + prefix_text = nil) url = url_for_issue(identifier, project) title = issue_tracker['title'] @@ -261,7 +262,7 @@ module Gitlab title: "Issue in #{title}", class: "gfm gfm-issue #{html_options[:class]}" ) - link_to("##{identifier}", url, options) + link_to("#{prefix_text}##{identifier}", url, options) end end end -- cgit v1.2.1 From a9cd3bfaeefcdc9eee594aeca062bb9f0663aaf1 Mon Sep 17 00:00:00 2001 From: Vinnie Okada Date: Sun, 5 Oct 2014 10:16:12 -0500 Subject: Fix external commit links Display the '@' character for links to commits in other projects. --- lib/gitlab/markdown.rb | 1 + 1 file changed, 1 insertion(+) (limited to 'lib') diff --git a/lib/gitlab/markdown.rb b/lib/gitlab/markdown.rb index 9b3e34653af..709a74fe21e 100644 --- a/lib/gitlab/markdown.rb +++ b/lib/gitlab/markdown.rb @@ -245,6 +245,7 @@ module Gitlab title: commit.link_title, class: "gfm gfm-commit #{html_options[:class]}" ) + prefix_text = "#{prefix_text}@" if prefix_text link_to( "#{prefix_text}#{identifier}", project_commit_url(project, commit), -- cgit v1.2.1