95 lines
2.4 KiB
Ruby
95 lines
2.4 KiB
Ruby
class HelpController < ApplicationController
|
|
skip_before_action :authenticate_user!, :reject_blocked!
|
|
|
|
layout 'help'
|
|
|
|
def index
|
|
@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')
|
|
end
|
|
|
|
def show
|
|
@path = clean_path_info(path_params[:path])
|
|
|
|
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")
|
|
|
|
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
|
|
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]}")
|
|
|
|
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 }
|
|
end
|
|
end
|
|
|
|
def shortcuts
|
|
end
|
|
|
|
def ui
|
|
@user = User.new(id: 0, name: 'John Doe', username: '@johndoe')
|
|
end
|
|
|
|
private
|
|
|
|
def path_params
|
|
params.require(:path)
|
|
|
|
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
|