Welcome to mirror list, hosted at ThFree Co, Russian Federation.

help_controller.rb « controllers « app - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 0e5567c77341fe2b0924e713b5f4ab5585f1eff1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class HelpController < ApplicationController
  def index
  end

  def show
    @filepath = clean_path_info(params[:filepath])
    @format = params[:format]

    respond_to do |format|
      format.md { render_doc }
      format.all { send_file_data }
    end
  end

  def shortcuts
  end

  private

  def render_doc
    if File.exists?(Rails.root.join('doc', @filepath + '.md'))
      render 'show.html.haml'
    else
      not_found!
    end
  end

  def send_file_data
    path = Rails.root.join('doc', "#{@filepath}.#{@format}")
    if File.exists?(path)
      send_file(path, disposition: 'inline')
    else
      head :not_found
    end
  end

  def ui
  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