summaryrefslogtreecommitdiff
path: root/app/controllers/projects/wiki_pages_controller.rb
blob: 0ba397b08f8df9cc6d30bb8c9a57f759d1f8236c (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# frozen_string_literal: true

class Projects::WikiPagesController < Projects::ApplicationController
  include ProjectWikiActions
  include SendsBlob
  include PreviewMarkdown
  include Gitlab::Utils::StrongMemoize

  def self.local_prefixes
    [controller_path, 'shared/wiki']
  end

  before_action :authorize_create_wiki!, only: [:edit, :create, :update]
  before_action :authorize_admin_wiki!, only: :destroy

  before_action :load_page, only: [:show, :edit, :update, :history, :destroy]
  before_action :valid_encoding?,
    if: -> { %w[show edit update].include?(action_name) && load_page }
  before_action only: [:edit, :update], unless: :valid_encoding? do
    redirect_to(project_wiki_path(@project, @page))
  end

  def new
    redirect_to project_wiki_path(@project, SecureRandom.uuid, random_title: true)
  end

  # `#show` handles a number of scenarios:
  #
  # - If `id` matches a WikiPage, then show the wiki page.
  # - If `id` is a file in the wiki repository, then send the file.
  # - If we know the user wants to create a new page with the given `id`,
  #   then display a create form.
  # - Otherwise show the empty wiki page and invite the user to create a page.
  def show
    if @page
      show_page
    elsif file_blob
      show_blob
    elsif should_create_missing_page?
      create_missing_page
    else
      render 'missing_page'
    end
  end

  def edit
  end

  def update
    @page = WikiPages::UpdateService
      .new(@project, current_user, wiki_params)
      .execute(@page)

    return saved(:updated) if @page.valid?

    render 'edit'
  rescue WikiPage::PageChangedError, WikiPage::PageRenameError, Gitlab::Git::Wiki::OperationError => e
    @error = e
    render 'edit'
  end

  def create
    @page = WikiPages::CreateService
      .new(@project, current_user, wiki_params)
      .execute

    return saved(:created) if @page.persisted?

    render action: "edit"
  rescue Gitlab::Git::Wiki::OperationError => e
    @page = project_wiki.build_page(wiki_params)
    @error = e

    render 'edit'
  end

  def history
    if @page
      @page_versions = Kaminari.paginate_array(@page.versions(page: params[:page].to_i),
                                               total_count: @page.count_versions)
        .page(params[:page])
    else
      redirect_to(
        project_wiki_path(@project, :home),
        notice: _("Page not found")
      )
    end
  end

  def destroy
    WikiPages::DestroyService.new(@project, current_user).execute(@page)

    redirect_to project_wiki_path(@project, :home),
                status: 302,
                notice: _("Page was successfully deleted")
  rescue Gitlab::Git::Wiki::OperationError => e
    @error = e
    render 'edit'
  end

  private

  # Callback for PreviewMarkdown
  def preview_markdown_params
    { pipeline: :wiki, project_wiki: project_wiki, page_slug: params[:id] }
  end

  def show_page
    set_encoding_error unless valid_encoding?

    @page_dir = @project_wiki.find_dir(@page.directory) if @page.directory.present?
    @show_children = true

    render 'show'
  end

  def show_blob
    send_blob(@project_wiki.repository, file_blob)
  end

  def should_create_missing_page?
    view_param = @project_wiki.exists? ? 'create' : params[:view]
    view_param == 'create' && can?(current_user, :create_wiki, @project)
  end

  def create_missing_page
    # Assign a title to the WikiPage unless `id` is a randomly generated slug from #new
    title = params[:id] unless params[:random_title].present?

    @page = project_wiki.build_page(title: title)

    render 'edit'
  end

  def wiki_params
    params.require(:wiki_page).permit(:title, :content, :format, :message, :last_commit_sha)
  end

  def load_page
    @page ||= @project_wiki.find_page(*page_params)
  end

  def page_params
    keys = [:id]
    keys << :version_id if params[:action] == 'show'

    params.values_at(*keys)
  end

  def valid_encoding?
    strong_memoize(:valid_encoding) do
      @page.content.encoding == Encoding::UTF_8
    end
  end

  def set_encoding_error
    flash.now[:notice] = _("The content of this page is not encoded in UTF-8. Edits can only be made via the Git repository.")
  end

  def file_blob
    strong_memoize(:file_blob) do
      commit = @project_wiki.repository.commit(@project_wiki.default_branch)

      next unless commit

      @project_wiki.repository.blob_at(commit.id, params[:id])
    end
  end

  def saved(action)
    msg = case action
          when :updated
            _('Wiki was successfully updated')
          when :created
            _('Wiki was successfully created')
          end

    redirect_to(project_wiki_path(@project, @page), notice: msg)
  end
end