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
|
# frozen_string_literal: true
module API
class MarkdownUploads < ::API::Base
include PaginationParams
feature_category :team_planning
FILENAME_QUERY_PARAM_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(
filename: API::NO_SLASH_URL_PART_REGEX
)
helpers do
def find_uploads(parent)
uploads = Banzai::UploadsFinder.new(parent: parent).execute
uploads.preload_uploaded_by_user
end
def find_upload(parent, upload_id: nil, secret: nil, filename: nil)
finder = Banzai::UploadsFinder.new(parent: parent)
if upload_id
finder.find(upload_id)
else
finder.find_by_secret_and_filename(secret, filename)
end
end
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
desc 'Workhorse authorize the file upload' do
detail 'This feature was introduced in GitLab 13.11'
success code: 200
failure [
{ code: 404, message: 'Not found' }
]
tags %w[projects]
end
post ':id/uploads/authorize' do
require_gitlab_workhorse!
status 200
content_type Gitlab::Workhorse::INTERNAL_API_CONTENT_TYPE
FileUploader.workhorse_authorize(has_length: false, maximum_size: user_project.max_attachment_size)
end
desc 'Upload a file' do
success code: 201, model: Entities::ProjectUpload
failure [
{ code: 404, message: 'Not found' }
]
tags %w[projects]
end
params do
requires :file, types: [Rack::Multipart::UploadedFile, ::API::Validations::Types::WorkhorseFile],
desc: 'The attachment file to be uploaded', documentation: { type: 'file' }
end
post ':id/uploads' do
upload = UploadService.new(user_project, params[:file], uploaded_by_user_id: current_user&.id).execute
present upload, with: Entities::ProjectUpload
end
desc 'Get the list of uploads of a project' do
success code: 200, model: Entities::MarkdownUploadAdmin
failure [
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
is_array true
tags %w[projects]
end
params do
use :pagination
end
get ':id/uploads' do
authorize! :admin_upload, user_project
uploads = find_uploads(user_project)
present paginate(uploads), with: Entities::MarkdownUploadAdmin
end
desc 'Download a single project upload by ID' do
success File
failure [
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[projects]
end
params do
requires :upload_id, type: Integer, desc: 'The ID of a project upload'
end
get ':id/uploads/:upload_id' do
# Fetching uploads by ID is maintainer-only because it can be used to enumerate uploads
# even without the secret
authorize! :admin_upload, user_project
upload = find_upload(user_project, upload_id: params[:upload_id])
present_carrierwave_file!(upload.retrieve_uploader)
end
desc 'Download a single project upload by secret and filename' do
success File
failure [
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[projects]
end
params do
requires :secret, type: String, desc: 'The 32-character secret of a project upload'
requires :filename, type: String, file_path: true, desc: 'The filename of a project upload'
end
get ':id/uploads/:secret/:filename', requirements: FILENAME_QUERY_PARAM_REQUIREMENTS do
authorize! :read_upload, user_project
upload = find_upload(user_project, secret: params[:secret], filename: params[:filename])
present_carrierwave_file!(upload&.retrieve_uploader)
end
desc 'Delete a single project upload by ID' do
success code: 204
failure [
{ code: 400, message: 'Bad request' },
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[projects]
end
params do
requires :upload_id, type: Integer, desc: 'The ID of a project upload'
end
delete ':id/uploads/:upload_id' do
authorize! :destroy_upload, user_project
upload = find_upload(user_project, upload_id: params[:upload_id])
result = Uploads::DestroyService.new(user_project, current_user).execute(upload)
if result[:status] == :success
status 204
else
bad_request!(result[:message])
end
end
desc 'Delete a single project upload by secret and filename' do
success code: 204
failure [
{ code: 400, message: 'Bad request' },
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[projects]
end
params do
requires :secret, type: String, desc: 'The 32-character secret of a project upload'
requires :filename, type: String, file_path: true, desc: 'The filename of a project upload'
end
delete ':id/uploads/:secret/:filename', requirements: FILENAME_QUERY_PARAM_REQUIREMENTS do
authorize! :destroy_upload, user_project
upload = find_upload(user_project, secret: params[:secret], filename: params[:filename])
result = Uploads::DestroyService.new(user_project, current_user).execute(upload)
if result[:status] == :success
status 204
else
bad_request!(result[:message])
end
end
end
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
desc 'Get the list of uploads of a group' do
success code: 200, model: Entities::MarkdownUploadAdmin
failure [
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
is_array true
tags %w[groups]
end
params do
use :pagination
end
get ':id/uploads' do
authorize! :admin_upload, user_group
uploads = find_uploads(user_group)
present paginate(uploads), with: Entities::MarkdownUploadAdmin
end
desc 'Download a single group upload by ID' do
success File
failure [
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[groups]
end
params do
requires :upload_id, type: Integer, desc: 'The ID of a group upload'
end
get ':id/uploads/:upload_id' do
# Fetching uploads by ID is maintainer-only because it can be used to enumerate uploads
# even without the secret
authorize! :admin_upload, user_group
upload = find_upload(user_group, upload_id: params[:upload_id])
present_carrierwave_file!(upload.retrieve_uploader)
end
desc 'Download a single project upload by secret and filename' do
success File
failure [
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[groups]
end
params do
requires :secret, type: String, desc: 'The 32-character secret of a group upload'
requires :filename, type: String, file_path: true, desc: 'The filename of a group upload'
end
get ':id/uploads/:secret/:filename', requirements: FILENAME_QUERY_PARAM_REQUIREMENTS do
authorize! :read_upload, user_group
upload = find_upload(user_group, secret: params[:secret], filename: params[:filename])
present_carrierwave_file!(upload&.retrieve_uploader)
end
desc 'Delete a single group upload' do
success code: 204
failure [
{ code: 400, message: 'Bad request' },
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[groups]
end
params do
requires :upload_id, type: Integer, desc: 'The ID of a group upload'
end
delete ':id/uploads/:upload_id' do
authorize! :destroy_upload, user_group
upload = find_upload(user_group, upload_id: params[:upload_id])
result = Uploads::DestroyService.new(user_group, current_user).execute(upload)
if result[:status] == :success
status 204
else
bad_request!(result[:message])
end
end
desc 'Delete a single group upload by secret and filename' do
success code: 204
failure [
{ code: 400, message: 'Bad request' },
{ code: 403, message: 'Unauthenticated' },
{ code: 404, message: 'Not found' }
]
tags %w[groups]
end
params do
requires :secret, type: String, desc: 'The 32-character secret of a group upload'
requires :filename, type: String, file_path: true, desc: 'The filename of a group upload'
end
delete ':id/uploads/:secret/:filename', requirements: FILENAME_QUERY_PARAM_REQUIREMENTS do
authorize! :destroy_upload, user_group
upload = find_upload(user_group, secret: params[:secret], filename: params[:filename])
result = Uploads::DestroyService.new(user_group, current_user).execute(upload)
if result[:status] == :success
status 204
else
bad_request!(result[:message])
end
end
end
end
end
|
