2016-11-15 08:56:29 -07:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-06-07 12:09:25 -06:00
|
|
|
class Api::BaseController < ApplicationController
|
2016-11-09 09:48:44 -07:00
|
|
|
DEFAULT_STATUSES_LIMIT = 20
|
|
|
|
DEFAULT_ACCOUNTS_LIMIT = 40
|
|
|
|
|
2023-11-30 07:39:41 -07:00
|
|
|
include Api::RateLimitHeaders
|
|
|
|
include Api::AccessTokenTrackingConcern
|
|
|
|
include Api::CachingConcern
|
2023-11-14 07:34:30 -07:00
|
|
|
include Api::ContentSecurityPolicy
|
2024-03-14 03:09:47 -06:00
|
|
|
include Api::ErrorHandling
|
2024-04-17 03:22:45 -06:00
|
|
|
include Api::Pagination
|
2017-06-07 09:23:26 -06:00
|
|
|
|
2023-08-02 11:32:48 -06:00
|
|
|
skip_before_action :require_functional!, unless: :limited_federation_mode?
|
2018-08-23 15:26:29 -06:00
|
|
|
|
2019-07-30 03:10:46 -06:00
|
|
|
before_action :require_authenticated_user!, if: :disallow_unauthenticated_api_access?
|
2022-05-26 14:04:05 -06:00
|
|
|
before_action :require_not_suspended!
|
2019-05-03 12:39:19 -06:00
|
|
|
|
2023-04-25 07:41:34 -06:00
|
|
|
vary_by 'Authorization'
|
|
|
|
|
2018-01-08 12:01:33 -07:00
|
|
|
protect_from_forgery with: :null_session
|
2016-03-07 04:42:33 -07:00
|
|
|
|
2016-11-21 08:19:35 -07:00
|
|
|
def doorkeeper_unauthorized_render_options(error: nil)
|
2023-12-01 09:00:44 -07:00
|
|
|
{ json: { error: error.try(:description) || 'Not authorized' } }
|
2016-10-22 11:38:47 -06:00
|
|
|
end
|
|
|
|
|
|
|
|
def doorkeeper_forbidden_render_options(*)
|
|
|
|
{ json: { error: 'This action is outside the authorized scopes' } }
|
|
|
|
end
|
|
|
|
|
2016-03-07 04:42:33 -07:00
|
|
|
protected
|
|
|
|
|
2024-07-30 02:39:11 -06:00
|
|
|
def limit_param(default_limit, max_limit = nil)
|
2017-01-23 20:22:10 -07:00
|
|
|
return default_limit unless params[:limit]
|
2020-08-31 19:04:00 -06:00
|
|
|
|
2024-07-30 02:39:11 -06:00
|
|
|
[params[:limit].to_i.abs, max_limit || (default_limit * 2)].min
|
2017-01-23 20:22:10 -07:00
|
|
|
end
|
|
|
|
|
2018-09-27 18:23:45 -06:00
|
|
|
def params_slice(*keys)
|
|
|
|
params.slice(*keys).permit(*keys)
|
|
|
|
end
|
|
|
|
|
2016-03-07 04:42:33 -07:00
|
|
|
def current_resource_owner
|
2016-11-23 01:20:34 -07:00
|
|
|
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
2016-03-07 04:42:33 -07:00
|
|
|
end
|
|
|
|
|
|
|
|
def current_user
|
2017-04-18 07:57:46 -06:00
|
|
|
current_resource_owner || super
|
2016-11-08 15:22:44 -07:00
|
|
|
rescue ActiveRecord::RecordNotFound
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2019-07-30 03:10:46 -06:00
|
|
|
def require_authenticated_user!
|
2020-01-23 14:00:13 -07:00
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 401 unless current_user
|
2019-07-30 03:10:46 -06:00
|
|
|
end
|
|
|
|
|
2022-05-26 14:04:05 -06:00
|
|
|
def require_not_suspended!
|
2023-11-30 08:43:26 -07:00
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403 if current_user&.account&.unavailable?
|
2022-05-26 14:04:05 -06:00
|
|
|
end
|
|
|
|
|
2016-11-08 15:22:44 -07:00
|
|
|
def require_user!
|
2018-12-25 11:35:26 -07:00
|
|
|
if !current_user
|
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 422
|
|
|
|
elsif !current_user.confirmed?
|
2019-03-13 22:28:30 -06:00
|
|
|
render json: { error: 'Your login is missing a confirmed e-mail address' }, status: 403
|
|
|
|
elsif !current_user.approved?
|
|
|
|
render json: { error: 'Your login is currently pending approval' }, status: 403
|
2020-09-15 06:37:58 -06:00
|
|
|
elsif !current_user.functional?
|
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403
|
2017-08-15 06:14:12 -06:00
|
|
|
else
|
2020-11-12 15:05:01 -07:00
|
|
|
update_user_sign_in
|
2017-08-15 06:14:12 -06:00
|
|
|
end
|
2016-03-07 04:42:33 -07:00
|
|
|
end
|
2016-09-26 15:55:21 -06:00
|
|
|
|
|
|
|
def render_empty
|
|
|
|
render json: {}, status: 200
|
|
|
|
end
|
2018-07-05 10:31:35 -06:00
|
|
|
|
|
|
|
def authorize_if_got_token!(*scopes)
|
|
|
|
doorkeeper_authorize!(*scopes) if doorkeeper_token
|
|
|
|
end
|
2019-05-03 12:39:19 -06:00
|
|
|
|
2019-07-30 03:10:46 -06:00
|
|
|
def disallow_unauthenticated_api_access?
|
2023-08-02 11:32:48 -06:00
|
|
|
ENV['DISALLOW_UNAUTHENTICATED_API_ACCESS'] == 'true' || Rails.configuration.x.limited_federation_mode
|
2019-07-30 03:10:46 -06:00
|
|
|
end
|
2022-09-08 01:44:36 -06:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def respond_with_error(code)
|
|
|
|
render json: { error: Rack::Utils::HTTP_STATUS_CODES[code] }, status: code
|
|
|
|
end
|
2016-03-05 04:50:59 -07:00
|
|
|
end
|