2018-09-14 05:42:05 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2012-01-18 20:15:45 +00:00
|
|
|
class HelpController < ApplicationController
|
2020-04-15 15:09:17 +00:00
|
|
|
skip_before_action :authenticate_user!, unless: :public_visibility_restricted?
|
2015-09-08 13:42:30 +00:00
|
|
|
|
2015-05-01 08:39:11 +00:00
|
|
|
layout 'help'
|
2015-04-30 19:28:07 +00:00
|
|
|
|
2017-09-18 19:50:05 +00:00
|
|
|
# Taken from Jekyll
|
|
|
|
# https://github.com/jekyll/jekyll/blob/3.5-stable/lib/jekyll/document.rb#L13
|
2019-05-05 10:19:14 +00:00
|
|
|
YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
|
2017-09-18 19:50:05 +00:00
|
|
|
|
2012-01-18 20:15:45 +00:00
|
|
|
def index
|
2017-09-18 19:50:05 +00:00
|
|
|
# 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-23 04:24:17 +00:00
|
|
|
|
2019-02-11 21:20:39 +00:00
|
|
|
# Prefix Markdown links with `help/` unless they are external links.
|
|
|
|
# '//' not necessarily part of URL, e.g., mailto:mail@example.com
|
2019-02-12 11:44:14 +00:00
|
|
|
# See https://rubular.com/r/DFHZl5w8d3bpzV
|
|
|
|
@help_index.gsub!(%r{(?<delim>\]\()(?!\w+:)(?!/)(?<link>[^\)\(]+\))}) do
|
2016-12-01 11:07:52 +00:00
|
|
|
"#{$~[:delim]}#{Gitlab.config.gitlab.relative_url_root}/help/#{$~[:link]}"
|
|
|
|
end
|
2012-01-18 20:15:45 +00:00
|
|
|
end
|
2013-06-06 10:19:23 +00:00
|
|
|
|
2014-04-18 15:21:21 +00:00
|
|
|
def show
|
2019-04-03 20:59:14 +00:00
|
|
|
@path = Rack::Utils.clean_path_info(path_params[:path])
|
2014-04-18 15:21:21 +00:00
|
|
|
|
2015-04-15 16:45:31 +00:00
|
|
|
respond_to do |format|
|
|
|
|
format.any(:markdown, :md, :html) do
|
2020-04-30 09:09:39 +00:00
|
|
|
# Note: We are purposefully NOT using `Rails.root.join` because of https://gitlab.com/gitlab-org/gitlab/-/issues/216028.
|
2016-05-16 22:06:26 +00:00
|
|
|
path = File.join(Rails.root, 'doc', "#{@path}.md")
|
2015-04-15 16:45:31 +00:00
|
|
|
|
|
|
|
if File.exist?(path)
|
2017-09-18 19:50:05 +00:00
|
|
|
# Remove YAML frontmatter so that it doesn't look weird
|
|
|
|
@markdown = File.read(path).gsub(YAML_FRONT_MATTER_REGEXP, '')
|
2015-04-15 16:45:31 +00:00
|
|
|
|
|
|
|
render 'show.html.haml'
|
|
|
|
else
|
|
|
|
# Force template to Haml
|
2019-11-17 12:06:19 +00:00
|
|
|
render 'errors/not_found.html.haml', layout: 'errors', status: :not_found
|
2015-04-15 16:45:31 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-10-09 12:06:13 +00:00
|
|
|
# Allow access to specific media files in the doc folder
|
|
|
|
format.any(:png, :gif, :jpeg, :mp4, :mp3) do
|
2020-04-30 09:09:39 +00:00
|
|
|
# Note: We are purposefully NOT using `Rails.root.join` because of https://gitlab.com/gitlab-org/gitlab/-/issues/216028.
|
2016-05-16 22:06:26 +00:00
|
|
|
path = File.join(Rails.root, 'doc', "#{@path}.#{params[:format]}")
|
2015-04-15 16:45:31 +00:00
|
|
|
|
|
|
|
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-04-18 15:21:21 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-04-15 16:24:44 +00:00
|
|
|
def shortcuts
|
2013-06-30 19:10:52 +00:00
|
|
|
end
|
2015-03-08 21:46:22 +00:00
|
|
|
|
2017-08-24 14:34:36 +00:00
|
|
|
def instance_configuration
|
|
|
|
@instance_configuration = InstanceConfiguration.new
|
|
|
|
end
|
|
|
|
|
2015-03-08 21:46:22 +00:00
|
|
|
def ui
|
2016-04-16 20:00:30 +00:00
|
|
|
@user = User.new(id: 0, name: 'John Doe', username: '@johndoe')
|
2015-03-08 21:46:22 +00:00
|
|
|
end
|
2015-04-10 16:16:46 +00:00
|
|
|
|
2015-04-15 16:24:44 +00:00
|
|
|
private
|
|
|
|
|
2015-04-15 16:45:31 +00:00
|
|
|
def path_params
|
2016-05-16 22:06:26 +00:00
|
|
|
params.require(:path)
|
2015-04-15 16:45:31 +00:00
|
|
|
|
|
|
|
params
|
|
|
|
end
|
2012-01-18 20:15:45 +00:00
|
|
|
end
|