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

95 lines
2.4 KiB
Ruby
Raw Normal View History

2014-09-02 18:07:02 +05:30
class HelpController < ApplicationController
2016-09-13 17:45:13 +05:30
skip_before_action :authenticate_user!, :reject_blocked!
2015-09-25 12:07:36 +05:30
2015-09-11 14:41:01 +05:30
layout 'help'
2014-09-02 18:07:02 +05:30
def index
2015-09-25 12:07:36 +05:30
@help_index = File.read(Rails.root.join('doc', 'README.md'))
# Prefix Markdown links with `help/` unless they already have been
# See http://rubular.com/r/nwwhzH6Z8X
@help_index.gsub!(/(\]\()(?!help\/)([^\)\(]+)(\))/, '\1help/\2\3')
2014-09-02 18:07:02 +05:30
end
def show
2016-08-24 12:49:21 +05:30
@path = 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
2015-09-11 14:41:01 +05:30
# Note: We are purposefully NOT using `Rails.root.join`
2016-08-24 12:49:21 +05:30
path = File.join(Rails.root, 'doc', "#{@path}.md")
2015-04-26 12:48:37 +05:30
if File.exist?(path)
@markdown = File.read(path)
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
2016-08-24 12:49:21 +05:30
format.any(:png, :gif, :jpeg, :mp4) do
2015-09-11 14:41:01 +05:30
# Note: We are purposefully NOT using `Rails.root.join`
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
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
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
2014-09-02 18:07:02 +05:30
end