debian-mirror-gitlab/lib/gitlab/highlight.rb

133 lines
3.6 KiB
Ruby
Raw Normal View History

2018-12-13 13:39:08 +05:30
# frozen_string_literal: true
2016-01-29 22:53:50 +05:30
module Gitlab
class Highlight
2018-11-08 19:23:39 +05:30
TIMEOUT_BACKGROUND = 30.seconds
2020-11-24 15:15:51 +05:30
TIMEOUT_FOREGROUND = 1.5.seconds
2018-11-08 19:23:39 +05:30
2018-12-13 13:39:08 +05:30
def self.highlight(blob_name, blob_content, language: nil, plain: false)
new(blob_name, blob_content, language: language)
2017-09-10 17:25:29 +05:30
.highlight(blob_content, continue: false, plain: plain)
2016-01-29 22:53:50 +05:30
end
2021-06-08 01:23:25 +05:30
def self.too_large?(size)
2021-09-30 23:02:18 +05:30
return false unless size.to_i > self.file_size_limit
2021-06-08 01:23:25 +05:30
2021-09-30 23:02:18 +05:30
over_highlight_size_limit.increment(source: "file size: #{self.file_size_limit}") if Feature.enabled?(:track_file_size_over_highlight_limit)
2021-06-08 01:23:25 +05:30
true
end
2017-09-10 17:25:29 +05:30
attr_reader :blob_name
2016-01-29 22:53:50 +05:30
2018-12-13 13:39:08 +05:30
def initialize(blob_name, blob_content, language: nil)
2017-08-17 22:00:37 +05:30
@formatter = Rouge::Formatters::HTMLGitlab
2018-12-13 13:39:08 +05:30
@language = language
2016-08-24 12:49:21 +05:30
@blob_name = blob_name
@blob_content = blob_content
2016-01-29 22:53:50 +05:30
end
2021-04-29 21:17:54 +05:30
def highlight(text, continue: false, plain: false, context: {})
@context = context
2021-06-08 01:23:25 +05:30
plain ||= self.class.too_large?(text.length)
2018-12-13 13:39:08 +05:30
2017-09-10 17:25:29 +05:30
highlighted_text = highlight_text(text, continue: continue, plain: plain)
highlighted_text = link_dependencies(text, highlighted_text) if blob_name
highlighted_text
2016-01-29 22:53:50 +05:30
end
2016-08-24 12:49:21 +05:30
def lexer
@lexer ||= custom_language || begin
Rouge::Lexer.guess(filename: @blob_name, source: @blob_content).new
2021-04-29 21:17:54 +05:30
rescue Rouge::Guesser::Ambiguous => e
e.alternatives.min_by(&:tag)
2016-08-24 12:49:21 +05:30
end
end
2016-01-29 22:53:50 +05:30
private
2021-04-29 21:17:54 +05:30
attr_reader :context
2021-09-30 23:02:18 +05:30
def self.file_size_limit
2021-10-27 15:23:28 +05:30
Gitlab.config.extra['maximum_text_highlight_size_kilobytes']
2021-09-30 23:02:18 +05:30
end
private_class_method :file_size_limit
2016-08-24 12:49:21 +05:30
def custom_language
2019-07-07 11:18:12 +05:30
return unless @language
2016-01-29 22:53:50 +05:30
2018-12-13 13:39:08 +05:30
Rouge::Lexer.find_fancy(@language)
2016-01-29 22:53:50 +05:30
end
2017-09-10 17:25:29 +05:30
def highlight_text(text, continue: true, plain: false)
if plain
highlight_plain(text)
else
highlight_rich(text, continue: continue)
end
end
def highlight_plain(text)
2021-11-18 22:05:49 +05:30
@formatter.format(Rouge::Lexers::PlainText.lex(text), **context).html_safe
2017-09-10 17:25:29 +05:30
end
def highlight_rich(text, continue: true)
2021-09-04 01:27:46 +05:30
add_highlight_attempt_metric
2018-11-08 19:23:39 +05:30
tag = lexer.tag
tokens = lexer.lex(text, continue: continue)
2021-11-18 22:05:49 +05:30
Timeout.timeout(timeout_time) { @formatter.format(tokens, **context, tag: tag).html_safe }
2018-11-08 19:23:39 +05:30
rescue Timeout::Error => e
2021-06-08 01:23:25 +05:30
add_highlight_timeout_metric
2020-01-01 13:55:28 +05:30
Gitlab::ErrorTracking.track_and_raise_for_dev_exception(e)
2018-11-08 19:23:39 +05:30
highlight_plain(text)
2021-06-08 01:23:25 +05:30
rescue StandardError
2017-09-10 17:25:29 +05:30
highlight_plain(text)
end
2018-11-08 19:23:39 +05:30
def timeout_time
2020-03-13 15:44:24 +05:30
Gitlab::Runtime.sidekiq? ? TIMEOUT_BACKGROUND : TIMEOUT_FOREGROUND
2018-11-08 19:23:39 +05:30
end
2017-09-10 17:25:29 +05:30
def link_dependencies(text, highlighted_text)
Gitlab::DependencyLinker.link(blob_name, text, highlighted_text)
end
2021-06-08 01:23:25 +05:30
2021-09-04 01:27:46 +05:30
def add_highlight_attempt_metric
return unless Feature.enabled?(:track_highlight_timeouts)
highlighting_attempt.increment(source: (@language || "undefined"))
end
2021-06-08 01:23:25 +05:30
def add_highlight_timeout_metric
return unless Feature.enabled?(:track_highlight_timeouts)
highlight_timeout.increment(source: Gitlab::Runtime.sidekiq? ? "background" : "foreground")
end
2021-09-04 01:27:46 +05:30
def highlighting_attempt
@highlight_attempt ||= Gitlab::Metrics.counter(
:file_highlighting_attempt,
'Counts the times highlighting has been attempted on a file'
)
end
2021-06-08 01:23:25 +05:30
def highlight_timeout
@highlight_timeout ||= Gitlab::Metrics.counter(
:highlight_timeout,
'Counts the times highlights have timed out'
)
end
def self.over_highlight_size_limit
@over_highlight_size_limit ||= Gitlab::Metrics.counter(
:over_highlight_size_limit,
'Count the times files have been over the highlight size limit'
)
end
2016-01-29 22:53:50 +05:30
end
end