Read about our upcoming Code of Conduct on this issue

helpers.rb 12.2 KB
Newer Older
1
2
module API
  module Helpers
3
4
    include Gitlab::Utils

5
6
    PRIVATE_TOKEN_HEADER = "HTTP_PRIVATE_TOKEN"
    PRIVATE_TOKEN_PARAM = :private_token
7
    SUDO_HEADER = "HTTP_SUDO"
8
9
    SUDO_PARAM = :sudo

Nick Thomas's avatar
Nick Thomas committed
10
11
12
13
14
15
16
17
18
    def private_token
      params[PRIVATE_TOKEN_PARAM] || env[PRIVATE_TOKEN_HEADER]
    end

    def warden
      env['warden']
    end

    # Check the Rails session for valid authentication details
19
20
21
    #
    # Until CSRF protection is added to the API, disallow this method for
    # state-changing endpoints
Nick Thomas's avatar
Nick Thomas committed
22
    def find_user_from_warden
23
      warden.try(:authenticate) if %w[GET HEAD].include?(env['REQUEST_METHOD'])
Nick Thomas's avatar
Nick Thomas committed
24
25
    end

26
27
28
29
30
    def declared_params(options = {})
      options = { include_parent_namespaces: false }.merge(options)
      declared(params, options).to_h.symbolize_keys
    end

31
    def find_user_by_private_token
Nick Thomas's avatar
Nick Thomas committed
32
33
34
35
      token = private_token
      return nil unless token.present?

      User.find_by_authentication_token(token) || User.find_by_personal_access_token(token)
36
37
38
    end

    def current_user
Nick Thomas's avatar
Nick Thomas committed
39
40
41
      @current_user ||= find_user_by_private_token
      @current_user ||= doorkeeper_guard
      @current_user ||= find_user_from_warden
42

43
      unless @current_user && Gitlab::UserAccess.new(@current_user).allowed?
44
45
46
47
48
49
50
        return nil
      end

      identifier = sudo_identifier()

      # If the sudo is the current user do nothing
      if identifier && !(@current_user.id == identifier || @current_user.username == identifier)
51
        forbidden!('Must be admin to use sudo') unless @current_user.is_admin?
52
53
54
55
56
57
58
        @current_user = User.by_username_or_id(identifier)
        not_found!("No user id or username for: #{identifier}") if @current_user.nil?
      end

      @current_user
    end

59
    def sudo_identifier
60
61
62
63
64
65
66
67
68
69
70
      identifier ||= params[SUDO_PARAM] || env[SUDO_HEADER]

      # Regex for integers
      if !!(identifier =~ /\A[0-9]+\z/)
        identifier.to_i
      else
        identifier
      end
    end

    def user_project
71
      @project ||= find_project!(params[:id])
72
73
    end

74
75
76
77
    def available_labels
      @available_labels ||= LabelsFinder.new(current_user, project_id: user_project.id).execute
    end

78
    def find_project(id)
79
80
81
82
83
84
85
86
87
      if id =~ /^\d+$/
        Project.find_by(id: id)
      else
        Project.find_with_namespace(id)
      end
    end

    def find_project!(id)
      project = find_project(id)
88

89
      if can?(current_user, :read_project, project)
90
91
        project
      else
92
        not_found!('Project')
93
94
95
      end
    end

96
97
    def project_service(project = user_project)
      @project_service ||= project.find_or_initialize_service(params[:service_slug].underscore)
98
99
100
101
102
103
104
105
106
107
      @project_service || not_found!("Service")
    end

    def service_attributes
      @service_attributes ||= project_service.fields.inject([]) do |arr, hash|
        arr << hash[:name].to_sym
      end
    end

    def find_group(id)
108
109
110
      if id =~ /^\d+$/
        Group.find_by(id: id)
      else
111
        Group.find_by_full_path(id)
112
113
114
115
116
      end
    end

    def find_group!(id)
      group = find_group(id)
117
118
119
120
121
122
123
124

      if can?(current_user, :read_group, group)
        group
      else
        not_found!('Group')
      end
    end

125
    def find_project_label(id)
126
      label = available_labels.find_by_id(id) || available_labels.find_by_title(id)
127
128
129
130
      label || not_found!('Label')
    end

    def find_project_issue(id)
131
      IssuesFinder.new(current_user, project_id: user_project.id).find(id)
132
133
    end

134
135
136
137
138
139
140
141
142
143
    def paginate(relation)
      relation.page(params[:page]).per(params[:per_page].to_i).tap do |data|
        add_pagination_headers(data)
      end
    end

    def authenticate!
      unauthorized! unless current_user
    end

144
145
146
147
    def authenticate_non_get!
      authenticate! unless %w[GET HEAD].include?(route.route_method)
    end

148
149
150
151
152
153
154
155
    def authenticate_by_gitlab_shell_token!
      input = params['secret_token'].try(:chomp)
      unless Devise.secure_compare(secret_token, input)
        unauthorized!
      end
    end

    def authenticated_as_admin!
156
      authenticate!
157
158
159
      forbidden! unless current_user.is_admin?
    end

160
    def authorize!(action, subject = nil)
161
      forbidden! unless can?(current_user, action, subject)
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    end

    def authorize_push_project
      authorize! :push_code, user_project
    end

    def authorize_admin_project
      authorize! :admin_project, user_project
    end

    def require_gitlab_workhorse!
      unless env['HTTP_GITLAB_WORKHORSE'].present?
        forbidden!('Request should be executed via GitLab Workhorse')
      end
    end

    def can?(object, action, subject)
http://jneen.net/'s avatar
http://jneen.net/ committed
179
      Ability.allowed?(object, action, subject)
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
    end

    # Checks the occurrences of required attributes, each attribute must be present in the params hash
    # or a Bad Request error is invoked.
    #
    # Parameters:
    #   keys (required) - A hash consisting of keys that must be present
    def required_attributes!(keys)
      keys.each do |key|
        bad_request!(key) unless params[key].present?
      end
    end

    def attributes_for_keys(keys, custom_params = nil)
      params_hash = custom_params || params
      attrs = {}
      keys.each do |key|
        if params_hash[key].present? or (params_hash.has_key?(key) and params_hash[key] == false)
          attrs[key] = params_hash[key]
        end
      end
      ActionController::Parameters.new(attrs).permit!
    end

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
    # Checks the occurrences of datetime attributes, each attribute if present in the params hash must be in ISO 8601
    # format (YYYY-MM-DDTHH:MM:SSZ) or a Bad Request error is invoked.
    #
    # Parameters:
    #   keys (required) - An array consisting of elements that must be parseable as dates from the params hash
    def datetime_attributes!(*keys)
      keys.each do |key|
        begin
          params[key] = Time.xmlschema(params[key]) if params[key].present?
        rescue ArgumentError
          message = "\"" + key.to_s + "\" must be a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"
          render_api_error!(message, 400)
        end
      end
    end

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
    def issuable_order_by
      if params["order_by"] == 'updated_at'
        'updated_at'
      else
        'created_at'
      end
    end

    def issuable_sort
      if params["sort"] == 'asc'
        :asc
      else
        :desc
      end
    end

    def filter_by_iid(items, iid)
      items.where(iid: iid)
    end

    # error helpers

    def forbidden!(reason = nil)
      message = ['403 Forbidden']
      message << " - #{reason}" if reason
      render_api_error!(message.join(' '), 403)
    end

    def bad_request!(attribute)
      message = ["400 (Bad request)"]
      message << "\"" + attribute.to_s + "\" not given"
      render_api_error!(message.join(' '), 400)
    end

    def not_found!(resource = nil)
      message = ["404"]
      message << resource if resource
      message << "Not Found"
      render_api_error!(message.join(' '), 404)
    end

    def unauthorized!
      render_api_error!('401 Unauthorized', 401)
    end

    def not_allowed!
      render_api_error!('405 Method Not Allowed', 405)
    end

    def conflict!(message = nil)
      render_api_error!(message || '409 Conflict', 409)
    end

    def file_to_large!
      render_api_error!('413 Request Entity Too Large', 413)
    end

    def not_modified!
      render_api_error!('304 Not Modified', 304)
    end

281
282
283
284
    def no_content!
      render_api_error!('204 No Content', 204)
    end

285
286
287
288
289
290
291
292
293
294
    def render_validation_error!(model)
      if model.errors.any?
        render_api_error!(model.errors.messages || '400 Bad Request', 400)
      end
    end

    def render_api_error!(message, status)
      error!({ 'message' => message }, status)
    end

Stan Hu's avatar
Stan Hu committed
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
    def handle_api_exception(exception)
      if sentry_enabled? && report_exception?(exception)
        define_params_for_grape_middleware
        sentry_context
        Raven.capture_exception(exception)
      end

      # lifted from https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb#L60
      trace = exception.backtrace

      message = "\n#{exception.class} (#{exception.message}):\n"
      message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
      message << "  " << trace.join("\n  ")

      API.logger.add Logger::FATAL, message
      rack_response({ 'message' => '500 Internal Server Error' }.to_json, 500)
    end

313
314
315
316
317
318
319
320
321
322
323
    # Projects helpers

    def filter_projects(projects)
      if params[:search].present?
        projects = projects.search(params[:search])
      end

      if params[:visibility].present?
        projects = projects.search_by_visibility(params[:visibility])
      end

Robert Schilling's avatar
Robert Schilling committed
324
325
      projects = projects.where(archived: params[:archived])
      projects.reorder(params[:order_by] => params[:sort])
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
    end

    # file helpers

    def uploaded_file(field, uploads_path)
      if params[field]
        bad_request!("#{field} is not a file") unless params[field].respond_to?(:filename)
        return params[field]
      end

      return nil unless params["#{field}.path"] && params["#{field}.name"]

      # sanitize file paths
      # this requires all paths to exist
      required_attributes! %W(#{field}.path)
      uploads_path = File.realpath(uploads_path)
      file_path = File.realpath(params["#{field}.path"])
      bad_request!('Bad file path') unless file_path.start_with?(uploads_path)

      UploadedFile.new(
        file_path,
        params["#{field}.name"],
        params["#{field}.type"] || 'application/octet-stream',
      )
    end

    def present_file!(path, filename, content_type = 'application/octet-stream')
      filename ||= File.basename(path)
      header['Content-Disposition'] = "attachment; filename=#{filename}"
      header['Content-Transfer-Encoding'] = 'binary'
      content_type content_type

      # Support download acceleration
      case headers['X-Sendfile-Type']
      when 'X-Sendfile'
        header['X-Sendfile'] = path
        body
      else
        file FileStreamer.new(path)
      end
    end

    private

    def add_pagination_headers(paginated_data)
      header 'X-Total',       paginated_data.total_count.to_s
      header 'X-Total-Pages', paginated_data.total_pages.to_s
      header 'X-Per-Page',    paginated_data.limit_value.to_s
      header 'X-Page',        paginated_data.current_page.to_s
      header 'X-Next-Page',   paginated_data.next_page.to_s
      header 'X-Prev-Page',   paginated_data.prev_page.to_s
      header 'Link',          pagination_links(paginated_data)
    end

    def pagination_links(paginated_data)
      request_url = request.url.split('?').first
      request_params = params.clone
      request_params[:per_page] = paginated_data.limit_value

      links = []

      request_params[:page] = paginated_data.current_page - 1
      links << %(<#{request_url}?#{request_params.to_query}>; rel="prev") unless paginated_data.first_page?

      request_params[:page] = paginated_data.current_page + 1
      links << %(<#{request_url}?#{request_params.to_query}>; rel="next") unless paginated_data.last_page?

      request_params[:page] = 1
      links << %(<#{request_url}?#{request_params.to_query}>; rel="first")

      request_params[:page] = paginated_data.total_pages
      links << %(<#{request_url}?#{request_params.to_query}>; rel="last")

      links.join(', ')
    end

    def secret_token
403
      Gitlab::Shell.secret_token
404
405
    end

406
407
408
    def send_git_blob(repository, blob)
      env['api.format'] = :txt
      content_type 'text/plain'
Douwe Maan's avatar
Douwe Maan committed
409
      header(*Gitlab::Workhorse.send_git_blob(repository, blob))
410
411
412
    end

    def send_git_archive(repository, ref:, format:)
Douwe Maan's avatar
Douwe Maan committed
413
      header(*Gitlab::Workhorse.send_git_archive(repository, ref: ref, format: format))
414
    end
415
416
417
418
419
420
421
422

    def issue_entity(project)
      if project.has_external_issue_tracker?
        Entities::ExternalIssue
      else
        Entities::Issue
      end
    end
Stan Hu's avatar
Stan Hu committed
423
424
425
426
427
428
429
430
431
432
433
434
435
436

    # The Grape Error Middleware only has access to env but no params. We workaround this by
    # defining a method that returns the right value.
    def define_params_for_grape_middleware
      self.define_singleton_method(:params) { Rack::Request.new(env).params.symbolize_keys }
    end

    # We could get a Grape or a standard Ruby exception. We should only report anything that
    # is clearly an error.
    def report_exception?(exception)
      return true unless exception.respond_to?(:status)

      exception.status == 500
    end
437
438
  end
end