Implement auxiliary blob viewers

8 files changed, 147 insertions, 22 deletions

diff --git a/app/models/blob.rb b/app/models/blob.rb
index 8452a96e909..63a81c0e3bd 100644
--- a/app/models/blob.rb
+++ b/app/models/blob.rb
@@ -34,10 +34,13 @@ class Blob < SimpleDelegator
 
     BlobViewer::BinarySTL,
     BlobViewer::TextSTL
-  ].freeze
+  ].sort_by { |v| v.binary? ? 0 : 1 }.freeze
 
-  BINARY_VIEWERS = RICH_VIEWERS.select(&:binary?).freeze
-  TEXT_VIEWERS = RICH_VIEWERS.select(&:text?).freeze
+  AUXILIARY_VIEWERS = [
+    BlobViewer::GitlabCiYml,
+    BlobViewer::RouteMap,
+    BlobViewer::License
+  ].freeze
 
   attr_reader :project
 
@@ -154,6 +157,12 @@ class Blob < SimpleDelegator
     @rich_viewer = rich_viewer_class&.new(self)
   end
 
+  def auxiliary_viewer
+    return @auxiliary_viewer if defined?(@auxiliary_viewer)
+
+    @auxiliary_viewer = auxiliary_viewer_class&.new(self)
+  end
+
   def rendered_as_text?(ignore_errors: true)
     simple_viewer.text? && (ignore_errors || simple_viewer.render_error.nil?)
   end
@@ -180,17 +189,18 @@ class Blob < SimpleDelegator
   end
 
   def rich_viewer_class
+    viewer_class_from(RICH_VIEWERS)
+  end
+
+  def auxiliary_viewer_class
+    viewer_class_from(AUXILIARY_VIEWERS)
+  end
+
+  def viewer_class_from(classes)
     return if empty? || external_storage_error?
 
-    classes =
-      if stored_externally?
-        BINARY_VIEWERS + TEXT_VIEWERS
-      elsif binary?
-        BINARY_VIEWERS
-      else # text
-        TEXT_VIEWERS
-      end
+    verify_binary = !stored_externally?
 
-    classes.find { |viewer_class| viewer_class.can_render?(self) }
+    classes.find { |viewer_class| viewer_class.can_render?(self, verify_binary: verify_binary) }
   end
 end
diff --git a/app/models/blob_viewer/auxiliary.rb b/app/models/blob_viewer/auxiliary.rb
new file mode 100644
index 00000000000..db124397b27
--- /dev/null
+++ b/app/models/blob_viewer/auxiliary.rb
@@ -0,0 +1,12 @@
+module BlobViewer
+  module Auxiliary
+    extend ActiveSupport::Concern
+
+    included do
+      self.loading_partial_name = 'loading_auxiliary'
+      self.type = :auxiliary
+      self.max_size = 100.kilobytes
+      self.absolute_max_size = 100.kilobytes
+    end
+  end
+end
diff --git a/app/models/blob_viewer/base.rb b/app/models/blob_viewer/base.rb
index a8b91d8d6bc..4f38c31714b 100644
--- a/app/models/blob_viewer/base.rb
+++ b/app/models/blob_viewer/base.rb
@@ -1,8 +1,12 @@
 module BlobViewer
   class Base
-    class_attribute :partial_name, :type, :extensions, :client_side, :binary, :switcher_icon, :switcher_title, :max_size, :absolute_max_size
+    PARTIAL_PATH_PREFIX = 'projects/blob/viewers'.freeze
 
-    delegate :partial_path, :rich?, :simple?, :client_side?, :server_side?, :text?, :binary?, to: :class
+    class_attribute :partial_name, :loading_partial_name, :type, :extensions, :file_type, :client_side, :binary, :switcher_icon, :switcher_title, :max_size, :absolute_max_size
+
+    self.loading_partial_name = 'loading'
+
+    delegate :partial_path, :loading_partial_path, :rich?, :simple?, :client_side?, :server_side?, :text?, :binary?, to: :class
 
     attr_reader :blob
     attr_accessor :override_max_size
@@ -12,7 +16,11 @@ module BlobViewer
     end
 
     def self.partial_path
-      "projects/blob/viewers/#{partial_name}"
+      File.join(PARTIAL_PATH_PREFIX, partial_name)
+    end
+
+    def self.loading_partial_path
+      File.join(PARTIAL_PATH_PREFIX, loading_partial_name)
     end
 
     def self.rich?
@@ -23,6 +31,10 @@ module BlobViewer
       type == :simple
     end
 
+    def self.auxiliary?
+      type == :auxiliary
+    end
+
     def self.client_side?
       client_side
     end
@@ -39,8 +51,12 @@ module BlobViewer
       !binary?
     end
 
-    def self.can_render?(blob)
-      !extensions || extensions.include?(blob.extension)
+    def self.can_render?(blob, verify_binary: true)
+      return false if verify_binary && binary? != blob.binary?
+      return true if extensions&.include?(blob.extension)
+      return true if file_type && Gitlab::FileDetector.type_of(blob.path) == file_type
+
+      false
     end
 
     def too_large?
@@ -83,9 +99,7 @@ module BlobViewer
     end
 
     def prepare!
-      if server_side? && blob.project
-        blob.load_all_data!(blob.project.repository)
-      end
+      # To be overridden by subclasses
     end
 
     private
diff --git a/app/models/blob_viewer/gitlab_ci_yml.rb b/app/models/blob_viewer/gitlab_ci_yml.rb
new file mode 100644
index 00000000000..81afab2f49b
--- /dev/null
+++ b/app/models/blob_viewer/gitlab_ci_yml.rb
@@ -0,0 +1,23 @@
+module BlobViewer
+  class GitlabCiYml < Base
+    include ServerSide
+    include Auxiliary
+
+    self.partial_name = 'gitlab_ci_yml'
+    self.loading_partial_name = 'gitlab_ci_yml_loading'
+    self.file_type = :gitlab_ci
+    self.binary = false
+
+    def validation_message
+      return @validation_message if defined?(@validation_message)
+
+      prepare!
+
+      @validation_message = Ci::GitlabCiYamlProcessor.validation_message(blob.data)
+    end
+
+    def valid?
+      validation_message.blank?
+    end
+  end
+end
diff --git a/app/models/blob_viewer/license.rb b/app/models/blob_viewer/license.rb
new file mode 100644
index 00000000000..3ad49570c88
--- /dev/null
+++ b/app/models/blob_viewer/license.rb
@@ -0,0 +1,23 @@
+module BlobViewer
+  class License < Base
+    # We treat the License viewer as if it renders the content client-side,
+    # so that it doesn't attempt to load the entire blob contents and is
+    # rendered synchronously instead of loaded asynchronously.
+    include ClientSide
+    include Auxiliary
+
+    self.partial_name = 'license'
+    self.file_type = :license
+    self.binary = false
+
+    def license
+      blob.project.repository.license
+    end
+
+    def render_error
+      return if license
+
+      :unknown_license
+    end
+  end
+end
diff --git a/app/models/blob_viewer/route_map.rb b/app/models/blob_viewer/route_map.rb
new file mode 100644
index 00000000000..1ca730c1ea0
--- /dev/null
+++ b/app/models/blob_viewer/route_map.rb
@@ -0,0 +1,30 @@
+module BlobViewer
+  class RouteMap < Base
+    include ServerSide
+    include Auxiliary
+
+    self.partial_name = 'route_map'
+    self.loading_partial_name = 'route_map_loading'
+    self.file_type = :route_map
+    self.binary = false
+
+    def validation_message
+      return @validation_message if defined?(@validation_message)
+
+      prepare!
+
+      @validation_message =
+        begin
+          Gitlab::RouteMap.new(blob.data)
+
+          nil
+        rescue Gitlab::RouteMap::FormatError => e
+          e.message
+        end
+    end
+
+    def valid?
+      validation_message.blank?
+    end
+  end
+end
diff --git a/app/models/blob_viewer/server_side.rb b/app/models/blob_viewer/server_side.rb
index 899107d02ea..e8c5c17b824 100644
--- a/app/models/blob_viewer/server_side.rb
+++ b/app/models/blob_viewer/server_side.rb
@@ -7,5 +7,11 @@ module BlobViewer
       self.max_size = 2.megabytes
       self.absolute_max_size = 5.megabytes
     end
+
+    def prepare!
+      if blob.project
+        blob.load_all_data!(blob.project.repository)
+      end
+    end
   end
 end
diff --git a/app/models/repository.rb b/app/models/repository.rb
index 9d9d94c4486..2aec7237640 100644
--- a/app/models/repository.rb
+++ b/app/models/repository.rb
@@ -549,6 +549,13 @@ class Repository
   end
   cache_method :license_key
 
+  def license
+    return @license if defined?(@license)
+    return unless license_key
+
+    @license = Licensee::License.new(license_key)
+  end
+
   def gitignore
     file_on_head(:gitignore)
   end
@@ -1083,8 +1090,8 @@ class Repository
 
   def file_on_head(type)
     if head = tree(:head)
-      head.blobs.find do |file|
-        Gitlab::FileDetector.type_of(file.name) == type
+      head.blobs.find do |blob|
+        Gitlab::FileDetector.type_of(blob.path) == type
       end
     end
   end