debian-mirror-gitlab/app/controllers/help_controller.rb

126 lines
3.7 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
class HelpController < ApplicationController
2020-04-22 19:07:51 +05:30
skip_before_action :authenticate_user!, unless: :public_visibility_restricted?
2021-04-17 20:07:23 +05:30
skip_before_action :check_two_factor_requirement
2021-01-03 14:25:43 +05:30
feature_category :not_owned
2015-09-25 12:07:36 +05:30
2015-09-11 14:41:01 +05:30
layout 'help'
2018-03-17 18:26:18 +05:30
# Taken from Jekyll
# https://github.com/jekyll/jekyll/blob/3.5-stable/lib/jekyll/document.rb#L13
2019-07-31 22:56:46 +05:30
YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
2018-03-17 18:26:18 +05:30
2014-09-02 18:07:02 +05:30
def index
2018-03-17 18:26:18 +05:30
# Remove YAML frontmatter so that it doesn't look weird
@help_index = File.read(Rails.root.join('doc', 'README.md')).sub(YAML_FRONT_MATTER_REGEXP, '')
2015-09-25 12:07:36 +05:30
2019-07-07 11:18:12 +05:30
# Prefix Markdown links with `help/` unless they are external links.
# '//' not necessarily part of URL, e.g., mailto:mail@example.com
# See https://rubular.com/r/DFHZl5w8d3bpzV
@help_index.gsub!(%r{(?<delim>\]\()(?!\w+:)(?!/)(?<link>[^\)\(]+\))}) do
2017-08-17 22:00:37 +05:30
"#{$~[:delim]}#{Gitlab.config.gitlab.relative_url_root}/help/#{$~[:link]}"
end
2014-09-02 18:07:02 +05:30
end
def show
2019-07-31 22:56:46 +05:30
@path = Rack::Utils.clean_path_info(path_params[:path])
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
respond_to do |format|
format.any(:markdown, :md, :html) do
2021-01-03 14:25:43 +05:30
if redirect_to_documentation_website?
redirect_to documentation_url
2015-04-26 12:48:37 +05:30
else
2021-01-03 14:25:43 +05:30
render_documentation
2015-04-26 12:48:37 +05:30
end
end
2019-12-21 20:55:43 +05:30
# Allow access to specific media files in the doc folder
format.any(:png, :gif, :jpeg, :mp4, :mp3) do
2020-05-24 23:13:21 +05:30
# Note: We are purposefully NOT using `Rails.root.join` because of https://gitlab.com/gitlab-org/gitlab/-/issues/216028.
2016-08-24 12:49:21 +05:30
path = File.join(Rails.root, 'doc', "#{@path}.#{params[:format]}")
2015-04-26 12:48:37 +05:30
if File.exist?(path)
send_file(path, disposition: 'inline')
else
head :not_found
end
end
# Any other format we don't recognize, just respond 404
format.any { head :not_found }
2014-09-02 18:07:02 +05:30
end
end
def shortcuts
end
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
def instance_configuration
@instance_configuration = InstanceConfiguration.new
end
2015-04-26 12:48:37 +05:30
def ui
2016-06-02 11:05:42 +05:30
@user = User.new(id: 0, name: 'John Doe', username: '@johndoe')
2015-04-26 12:48:37 +05:30
end
private
def path_params
2016-08-24 12:49:21 +05:30
params.require(:path)
2015-04-26 12:48:37 +05:30
params
end
2021-01-03 14:25:43 +05:30
def redirect_to_documentation_website?
return false unless Feature.enabled?(:help_page_documentation_redirect)
return false unless Gitlab::UrlSanitizer.valid_web?(documentation_url)
true
end
def documentation_url
return unless documentation_base_url
@documentation_url ||= Gitlab::Utils.append_path(documentation_base_url, documentation_file_path)
end
def documentation_base_url
2021-03-11 19:13:27 +05:30
@documentation_base_url ||= documentation_base_url_from_yml_configuration || documentation_base_url_from_db
end
# DEPRECATED
def documentation_base_url_from_db
Gitlab::CurrentSettings.current_application_settings.help_page_documentation_base_url.presence
end
def documentation_base_url_from_yml_configuration
::Gitlab.config.gitlab_docs.host.presence if ::Gitlab.config.gitlab_docs.enabled
2021-01-03 14:25:43 +05:30
end
def documentation_file_path
@documentation_file_path ||= [version_segment, 'ee', "#{@path}.html"].compact.join('/')
end
def version_segment
return if Gitlab.pre_release?
version = Gitlab.version_info
[version.major, version.minor].join('.')
end
def render_documentation
# Note: We are purposefully NOT using `Rails.root.join` because of https://gitlab.com/gitlab-org/gitlab/-/issues/216028.
path = File.join(Rails.root, 'doc', "#{@path}.md")
if File.exist?(path)
# Remove YAML frontmatter so that it doesn't look weird
@markdown = File.read(path).gsub(YAML_FRONT_MATTER_REGEXP, '')
render 'show.html.haml'
else
# Force template to Haml
render 'errors/not_found.html.haml', layout: 'errors', status: :not_found
end
end
2014-09-02 18:07:02 +05:30
end