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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
|
# frozen_string_literal: true
module WikiActions
include DiffHelper
include PreviewMarkdown
include SendsBlob
include Gitlab::Utils::StrongMemoize
include ProductAnalyticsTracking
extend ActiveSupport::Concern
RESCUE_GIT_TIMEOUTS_IN = %w[show edit history diff pages].freeze
included do
content_security_policy do |p|
next if p.directives.blank?
default_frame_src = p.directives['frame-src'] || p.directives['default-src']
frame_src_values = Array.wrap(default_frame_src) | ['https://embed.diagrams.net'].compact
p.frame_src(*frame_src_values)
end
before_action { respond_to :html }
before_action :authorize_read_wiki!
before_action :authorize_create_wiki!, only: [:edit, :create, :destroy]
before_action :wiki
before_action :page, only: [:show, :edit, :update, :history, :destroy, :diff]
before_action :load_sidebar, except: [:pages]
before_action :set_content_class
before_action do
push_frontend_feature_flag(:preserve_unchanged_markdown, @group)
end
before_action only: [:show, :edit, :update] do
@valid_encoding = valid_encoding?
end
before_action only: [:edit, :update], unless: :valid_encoding? do
if params[:id].present?
redirect_to wiki_page_path(wiki, page || params[:id])
else
redirect_to wiki_path(wiki)
end
end
track_event :show, name: 'wiki_action'
helper_method :view_file_button, :diff_file_html_data
rescue_from ::Gitlab::Git::CommandTimedOut do |exc|
raise exc unless RESCUE_GIT_TIMEOUTS_IN.include?(action_name)
render 'shared/wikis/git_error'
end
rescue_from Gitlab::Git::Repository::NoRepository do
@error = _('Could not access the Wiki Repository at this time.')
render 'shared/wikis/empty'
end
end
def new
redirect_to wiki_page_path(wiki, SecureRandom.uuid, random_title: true)
end
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def pages
@wiki_entries = WikiDirectory.group_pages(wiki_pages)
render 'shared/wikis/pages'
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
# `#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.
#
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def show
if page
set_encoding_error unless valid_encoding?
# Assign vars expected by MarkupHelper
@ref = params[:version_id]
@path = page.path
Gitlab::UsageDataCounters::WikiPageCounter.count(:view)
render 'shared/wikis/show'
elsif file_blob
# This is needed by [GitLab JH](https://gitlab.com/gitlab-jh/gitlab/-/issues/247)
send_wiki_file_blob(wiki, file_blob)
elsif show_create_form?
# Assign a title to the WikiPage unless `id` is a randomly generated slug from #new
title = params[:id] unless params[:random_title].present?
@page = build_page(title: title)
render 'shared/wikis/edit'
else
render 'shared/wikis/empty'
end
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
def edit
render 'shared/wikis/edit'
end
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def update
return render('shared/wikis/empty') unless can?(current_user, :create_wiki, container)
response = WikiPages::UpdateService.new(
container: container,
current_user: current_user,
params: wiki_params
).execute(page)
@page = response.payload[:page]
if response.success?
flash[:toast] = _('Wiki page was successfully updated.')
redirect_to(
wiki_page_path(wiki, page)
)
else
@error = response.message
render 'shared/wikis/edit'
end
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def create
response = WikiPages::CreateService.new(container: container, current_user: current_user, params: wiki_params).execute
@page = response.payload[:page]
if response.success?
flash[:toast] = _('Wiki page was successfully created.')
redirect_to(
wiki_page_path(wiki, page)
)
else
render 'shared/wikis/edit'
end
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def history
if page
@commits = Kaminari.paginate_array(page.versions(page: params[:page].to_i), total_count: page.count_versions)
.page(params[:page])
render 'shared/wikis/history'
else
redirect_to(
wiki_path(wiki),
notice: _("Page not found")
)
end
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def diff
return render_404 unless page
apply_diff_view_cookie!
@diffs = page.diffs(diff_options)
@diff_notes_disabled = true
render 'shared/wikis/diff'
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def destroy
return render_404 unless page
response = WikiPages::DestroyService.new(container: container, current_user: current_user).execute(page)
if response.success?
flash[:toast] = _("Wiki page was successfully deleted.")
redirect_to wiki_path(wiki), status: :found
else
@error = response.message
render 'shared/wikis/edit'
end
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
def git_access
render 'shared/wikis/git_access'
end
private
def container
raise NotImplementedError
end
def show_create_form?
can?(current_user, :create_wiki, container) &&
page.nil? &&
# Always show the create form when the wiki has had at least one page created.
# Otherwise, we only show the form when the user has navigated from
# the 'empty wiki' page
(wiki.exists? || params[:view] == 'create')
end
def wiki
strong_memoize(:wiki) do
wiki = Wiki.for_container(container, current_user)
wiki.create_wiki_repository
wiki
end
rescue Wiki::CouldNotCreateWikiError
flash[:notice] = _("Could not create Wiki Repository at this time. Please try again later.")
redirect_to container
false
end
def page
strong_memoize(:page) do
wiki.find_page(*page_params, load_content: load_content?)
end
end
# rubocop:disable Gitlab/ModuleWithInstanceVariables
def load_sidebar
@sidebar_page = wiki.find_sidebar(params[:version_id])
unless @sidebar_page # Fallback to default sidebar
@sidebar_wiki_entries, @sidebar_limited = wiki.sidebar_entries
end
rescue ::Gitlab::Git::CommandTimedOut => e
@sidebar_error = e
end
# rubocop:enable Gitlab/ModuleWithInstanceVariables
def wiki_pages
strong_memoize(:wiki_pages) do
Kaminari.paginate_array(
wiki.list_pages(direction: params[:direction])
).page(params[:page])
end
end
def wiki_params
params.require(:wiki).permit(:title, :content, :format, :message, :last_commit_sha)
end
def build_page(args = {})
WikiPage.new(wiki).tap do |page|
page.update_attributes(args) # rubocop:disable Rails/ActiveRecordAliases
end
end
def page_params
keys = [:id]
keys << :version_id if %w[show diff].include?(params[:action])
params.values_at(*keys)
end
def valid_encoding?
page_encoding == Encoding::UTF_8
end
def page_encoding
strong_memoize(:page_encoding) { page&.content&.encoding }
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 = wiki.repository.commit(wiki.default_branch)
next unless commit
wiki.repository.blob_at(commit.id, params[:id])
end
end
def set_content_class
@content_class = 'limit-container-width' unless fluid_layout # rubocop:disable Gitlab/ModuleWithInstanceVariables
end
# Override CommitsHelper#view_file_button
def view_file_button(commit_sha, *args)
path = wiki_page_path(wiki, page, version_id: page.version.id)
helpers.link_to(path, class: 'btn') do
helpers.raw(_('View page @ ')) + helpers.content_tag(:span, Commit.truncate_sha(commit_sha), class: 'commit-sha')
end
end
# Override DiffHelper#diff_file_html_data
def diff_file_html_data(_project, _diff_file_path, diff_commit_id)
{
blob_diff_path: wiki_page_path(wiki, page, action: :diff, version_id: diff_commit_id),
view: diff_view
}
end
def send_wiki_file_blob(wiki, file_blob)
send_blob(wiki.repository, file_blob)
end
def load_content?
return false if %w[history destroy diff show].include?(params[:action])
true
end
end
WikiActions.prepend_mod
|