gitlab-org--gitlab-foss/app/controllers/help_controller.rb

110 lines
3 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
class HelpController < ApplicationController
skip_before_action :authenticate_user!
2015-09-08 09:42:30 -04:00
layout 'help'
2015-04-30 15:28:07 -04:00
# Taken from Jekyll
# https://github.com/jekyll/jekyll/blob/3.5-stable/lib/jekyll/document.rb#L13
2018-01-27 00:35:53 -05:00
YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
def index
# 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 00:24:17 -04:00
# 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
"#{$~[:delim]}#{Gitlab.config.gitlab.relative_url_root}/help/#{$~[:link]}"
end
end
2013-06-06 06:19:23 -04:00
2014-04-18 11:21:21 -04:00
def show
2016-07-11 15:12:55 -04:00
@path = clean_path_info(path_params[:path])
2014-04-18 11:21:21 -04:00
2015-04-15 12:45:31 -04:00
respond_to do |format|
format.any(:markdown, :md, :html) do
# Note: We are purposefully NOT using `Rails.root.join`
path = File.join(Rails.root, 'doc', "#{@path}.md")
2015-04-15 12:45:31 -04:00
if File.exist?(path)
# Remove YAML frontmatter so that it doesn't look weird
@markdown = File.read(path).gsub(YAML_FRONT_MATTER_REGEXP, '')
2015-04-15 12:45:31 -04:00
render 'show.html.haml'
else
# Force template to Haml
render 'errors/not_found.html.haml', layout: 'errors', status: 404
end
end
# Allow access to images in the doc folder
format.any(:png, :gif, :jpeg, :mp4) do
# Note: We are purposefully NOT using `Rails.root.join`
path = File.join(Rails.root, 'doc', "#{@path}.#{params[:format]}")
2015-04-15 12:45:31 -04: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 11:21:21 -04:00
end
end
def shortcuts
2013-06-30 15:10:52 -04:00
end
2015-03-08 17:46:22 -04:00
def instance_configuration
@instance_configuration = InstanceConfiguration.new
end
2015-03-08 17:46:22 -04:00
def ui
2016-04-16 16:00:30 -04:00
@user = User.new(id: 0, name: 'John Doe', username: '@johndoe')
2015-03-08 17:46:22 -04:00
end
private
2015-04-15 12:45:31 -04:00
def path_params
params.require(:path)
2015-04-15 12:45:31 -04:00
params
end
PATH_SEPS = Regexp.union(*[::File::SEPARATOR, ::File::ALT_SEPARATOR].compact)
# Taken from ActionDispatch::FileHandler
# Cleans up the path, to prevent directory traversal outside the doc folder.
def clean_path_info(path_info)
parts = path_info.split(PATH_SEPS)
clean = []
# Walk over each part of the path
parts.each do |part|
# Turn `one//two` or `one/./two` into `one/two`.
next if part.empty? || part == '.'
if part == '..'
# Turn `one/two/../` into `one`
clean.pop
else
# Add simple folder names to the clean path.
clean << part
end
end
# If the path was an absolute path (i.e. `/` or `/one/two`),
# add `/` to the front of the clean path.
clean.unshift '/' if parts.empty? || parts.first.empty?
# Join all the clean path parts by the path separator.
::File.join(*clean)
end
end