# frozen_string_literal: true module Gitlab class Highlight def self.highlight(blob_name, blob_content, language: nil, plain: false) new(blob_name, blob_content, language: language) .highlight(blob_content, continue: false, plain: plain) end def self.too_large?(size) size.to_i > self.file_size_limit end attr_reader :blob_name def initialize(blob_name, blob_content, language: nil) @formatter = Rouge::Formatters::HTMLGitlab @language = language @blob_name = blob_name @blob_content = blob_content end def highlight(text, continue: false, plain: false, context: {}) @context = context plain ||= self.class.too_large?(text.length) highlighted_text = highlight_text(text, continue: continue, plain: plain) highlighted_text = link_dependencies(text, highlighted_text) if blob_name highlighted_text end def lexer @lexer ||= custom_language || begin Rouge::Lexer.guess(filename: @blob_name, source: @blob_content).new rescue Rouge::Guesser::Ambiguous => e e.alternatives.min_by(&:tag) end end private attr_reader :context def self.file_size_limit Gitlab.config.extra['maximum_text_highlight_size_kilobytes'] end private_class_method :file_size_limit def custom_language return unless @language Rouge::Lexer.find_fancy(@language) end 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) @formatter.format(Rouge::Lexers::PlainText.lex(text), **context).html_safe end def highlight_rich(text, continue: true) tag = lexer.tag tokens = lexer.lex(text, continue: continue) Gitlab::RenderTimeout.timeout { @formatter.format(tokens, **context, tag: tag).html_safe } rescue Timeout::Error => e Gitlab::ErrorTracking.track_and_raise_for_dev_exception(e) highlight_plain(text) rescue StandardError highlight_plain(text) end def link_dependencies(text, highlighted_text) Gitlab::DependencyLinker.link(blob_name, text, highlighted_text) end end end