2016-11-16 00:56:29 +09:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-06-08 03:09:25 +09:00
|
|
|
class Api::BaseController < ApplicationController
|
2016-11-10 01:48:44 +09:00
|
|
|
DEFAULT_STATUSES_LIMIT = 20
|
|
|
|
DEFAULT_ACCOUNTS_LIMIT = 40
|
|
|
|
|
2023-11-30 23:39:41 +09:00
|
|
|
include Api::RateLimitHeaders
|
|
|
|
include Api::AccessTokenTrackingConcern
|
|
|
|
include Api::CachingConcern
|
2023-11-14 23:34:30 +09:00
|
|
|
include Api::ContentSecurityPolicy
|
2024-03-14 18:09:47 +09:00
|
|
|
include Api::ErrorHandling
|
2017-06-08 00:23:26 +09:00
|
|
|
|
2023-08-03 02:32:48 +09:00
|
|
|
skip_before_action :require_functional!, unless: :limited_federation_mode?
|
2018-08-24 06:26:29 +09:00
|
|
|
|
2019-07-30 18:10:46 +09:00
|
|
|
before_action :require_authenticated_user!, if: :disallow_unauthenticated_api_access?
|
2022-05-27 05:04:05 +09:00
|
|
|
before_action :require_not_suspended!
|
2019-05-04 03:39:19 +09:00
|
|
|
|
2023-04-25 22:41:34 +09:00
|
|
|
vary_by 'Authorization'
|
|
|
|
|
2018-01-09 04:01:33 +09:00
|
|
|
protect_from_forgery with: :null_session
|
2016-03-07 20:42:33 +09:00
|
|
|
|
2016-11-22 00:19:35 +09:00
|
|
|
def doorkeeper_unauthorized_render_options(error: nil)
|
2023-12-02 01:00:44 +09:00
|
|
|
{ json: { error: error.try(:description) || 'Not authorized' } }
|
2016-10-23 02:38:47 +09:00
|
|
|
end
|
|
|
|
|
|
|
|
def doorkeeper_forbidden_render_options(*)
|
|
|
|
{ json: { error: 'This action is outside the authorized scopes' } }
|
|
|
|
end
|
|
|
|
|
2016-03-07 20:42:33 +09:00
|
|
|
protected
|
|
|
|
|
2024-03-13 17:51:44 +09:00
|
|
|
def pagination_max_id
|
|
|
|
pagination_collection.last.id
|
|
|
|
end
|
|
|
|
|
|
|
|
def pagination_since_id
|
|
|
|
pagination_collection.first.id
|
|
|
|
end
|
|
|
|
|
2016-11-10 01:48:44 +09:00
|
|
|
def set_pagination_headers(next_path = nil, prev_path = nil)
|
|
|
|
links = []
|
2016-11-16 00:56:29 +09:00
|
|
|
links << [next_path, [%w(rel next)]] if next_path
|
|
|
|
links << [prev_path, [%w(rel prev)]] if prev_path
|
2017-08-18 17:42:59 +09:00
|
|
|
response.headers['Link'] = LinkHeader.new(links) unless links.empty?
|
2016-11-10 01:48:44 +09:00
|
|
|
end
|
|
|
|
|
2017-01-24 12:22:10 +09:00
|
|
|
def limit_param(default_limit)
|
|
|
|
return default_limit unless params[:limit]
|
2020-09-01 10:04:00 +09:00
|
|
|
|
2017-01-24 12:22:10 +09:00
|
|
|
[params[:limit].to_i.abs, default_limit * 2].min
|
|
|
|
end
|
|
|
|
|
2018-09-28 09:23:45 +09:00
|
|
|
def params_slice(*keys)
|
|
|
|
params.slice(*keys).permit(*keys)
|
|
|
|
end
|
|
|
|
|
2016-03-07 20:42:33 +09:00
|
|
|
def current_resource_owner
|
2016-11-23 17:20:34 +09:00
|
|
|
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
2016-03-07 20:42:33 +09:00
|
|
|
end
|
|
|
|
|
|
|
|
def current_user
|
2017-04-18 22:57:46 +09:00
|
|
|
current_resource_owner || super
|
2016-11-09 07:22:44 +09:00
|
|
|
rescue ActiveRecord::RecordNotFound
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2019-07-30 18:10:46 +09:00
|
|
|
def require_authenticated_user!
|
2020-01-24 06:00:13 +09:00
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 401 unless current_user
|
2019-07-30 18:10:46 +09:00
|
|
|
end
|
|
|
|
|
2022-05-27 05:04:05 +09:00
|
|
|
def require_not_suspended!
|
2023-12-01 00:43:26 +09:00
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403 if current_user&.account&.unavailable?
|
2022-05-27 05:04:05 +09:00
|
|
|
end
|
|
|
|
|
2023-12-19 19:55:39 +09:00
|
|
|
def require_valid_pagination_options!
|
|
|
|
render json: { error: 'Pagination values for `offset` and `limit` must be positive' }, status: 400 if pagination_options_invalid?
|
|
|
|
end
|
|
|
|
|
2016-11-09 07:22:44 +09:00
|
|
|
def require_user!
|
2018-12-26 03:35:26 +09:00
|
|
|
if !current_user
|
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 422
|
|
|
|
elsif !current_user.confirmed?
|
2019-03-14 13:28:30 +09: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 21:37:58 +09:00
|
|
|
elsif !current_user.functional?
|
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403
|
2017-08-15 21:14:12 +09:00
|
|
|
else
|
2020-11-13 07:05:01 +09:00
|
|
|
update_user_sign_in
|
2017-08-15 21:14:12 +09:00
|
|
|
end
|
2016-03-07 20:42:33 +09:00
|
|
|
end
|
2016-09-27 06:55:21 +09:00
|
|
|
|
|
|
|
def render_empty
|
|
|
|
render json: {}, status: 200
|
|
|
|
end
|
2018-07-06 01:31:35 +09:00
|
|
|
|
|
|
|
def authorize_if_got_token!(*scopes)
|
|
|
|
doorkeeper_authorize!(*scopes) if doorkeeper_token
|
|
|
|
end
|
2019-05-04 03:39:19 +09:00
|
|
|
|
2019-07-30 18:10:46 +09:00
|
|
|
def disallow_unauthenticated_api_access?
|
2023-08-03 02:32:48 +09:00
|
|
|
ENV['DISALLOW_UNAUTHENTICATED_API_ACCESS'] == 'true' || Rails.configuration.x.limited_federation_mode
|
2019-07-30 18:10:46 +09:00
|
|
|
end
|
2022-09-08 16:44:36 +09:00
|
|
|
|
|
|
|
private
|
|
|
|
|
2024-03-18 19:11:53 +09:00
|
|
|
def insert_pagination_headers
|
|
|
|
set_pagination_headers(next_path, prev_path)
|
|
|
|
end
|
|
|
|
|
2023-12-19 19:55:39 +09:00
|
|
|
def pagination_options_invalid?
|
|
|
|
params.slice(:limit, :offset).values.map(&:to_i).any?(&:negative?)
|
|
|
|
end
|
|
|
|
|
2022-09-08 16:44:36 +09:00
|
|
|
def respond_with_error(code)
|
|
|
|
render json: { error: Rack::Utils::HTTP_STATUS_CODES[code] }, status: code
|
|
|
|
end
|
2016-03-05 20:50:59 +09:00
|
|
|
end
|