2016-11-16 02:56:29 +11:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-06-08 04:09:25 +10:00
|
|
|
class Api::BaseController < ApplicationController
|
2016-11-10 03:48:44 +11:00
|
|
|
DEFAULT_STATUSES_LIMIT = 20
|
|
|
|
DEFAULT_ACCOUNTS_LIMIT = 40
|
|
|
|
|
2023-12-01 01:39:41 +11:00
|
|
|
include Api::RateLimitHeaders
|
|
|
|
include Api::AccessTokenTrackingConcern
|
|
|
|
include Api::CachingConcern
|
2023-11-15 01:34:30 +11:00
|
|
|
include Api::ContentSecurityPolicy
|
2017-06-08 01:23:26 +10:00
|
|
|
|
2023-08-03 03:32:48 +10:00
|
|
|
skip_before_action :require_functional!, unless: :limited_federation_mode?
|
2018-08-24 07:26:29 +10:00
|
|
|
|
2019-07-30 19:10:46 +10:00
|
|
|
before_action :require_authenticated_user!, if: :disallow_unauthenticated_api_access?
|
2022-05-27 06:04:05 +10:00
|
|
|
before_action :require_not_suspended!
|
2019-05-04 04:39:19 +10:00
|
|
|
|
2023-04-25 23:41:34 +10:00
|
|
|
vary_by 'Authorization'
|
|
|
|
|
2018-01-09 06:01:33 +11:00
|
|
|
protect_from_forgery with: :null_session
|
2016-03-07 22:42:33 +11:00
|
|
|
|
2017-02-27 09:23:06 +11:00
|
|
|
rescue_from ActiveRecord::RecordInvalid, Mastodon::ValidationError do |e|
|
2016-10-01 06:31:16 +10:00
|
|
|
render json: { error: e.to_s }, status: 422
|
2016-08-27 03:12:19 +10:00
|
|
|
end
|
|
|
|
|
2019-12-07 08:40:06 +11:00
|
|
|
rescue_from ActiveRecord::RecordNotUnique do
|
|
|
|
render json: { error: 'Duplicate record' }, status: 422
|
|
|
|
end
|
|
|
|
|
2022-10-27 23:30:52 +11:00
|
|
|
rescue_from Date::Error do
|
|
|
|
render json: { error: 'Invalid date supplied' }, status: 422
|
|
|
|
end
|
|
|
|
|
2016-08-27 03:12:19 +10:00
|
|
|
rescue_from ActiveRecord::RecordNotFound do
|
|
|
|
render json: { error: 'Record not found' }, status: 404
|
|
|
|
end
|
|
|
|
|
2017-07-20 09:59:07 +10:00
|
|
|
rescue_from HTTP::Error, Mastodon::UnexpectedResponseError do
|
2016-09-18 01:03:36 +10:00
|
|
|
render json: { error: 'Remote data could not be fetched' }, status: 503
|
|
|
|
end
|
|
|
|
|
2016-10-05 22:26:44 +11:00
|
|
|
rescue_from OpenSSL::SSL::SSLError do
|
|
|
|
render json: { error: 'Remote SSL certificate could not be verified' }, status: 503
|
|
|
|
end
|
|
|
|
|
2017-02-27 09:23:06 +11:00
|
|
|
rescue_from Mastodon::NotPermittedError do
|
2016-12-23 07:34:19 +11:00
|
|
|
render json: { error: 'This action is not allowed' }, status: 403
|
|
|
|
end
|
|
|
|
|
2021-07-22 02:34:39 +10:00
|
|
|
rescue_from Seahorse::Client::NetworkingError do |e|
|
|
|
|
Rails.logger.warn "Storage server error: #{e}"
|
|
|
|
render json: { error: 'There was a temporary problem serving your request, please try again' }, status: 503
|
|
|
|
end
|
|
|
|
|
|
|
|
rescue_from Mastodon::RaceConditionError, Stoplight::Error::RedLight do
|
2019-08-30 09:34:47 +10:00
|
|
|
render json: { error: 'There was a temporary problem serving your request, please try again' }, status: 503
|
|
|
|
end
|
|
|
|
|
2020-03-09 01:17:39 +11:00
|
|
|
rescue_from Mastodon::RateLimitExceededError do
|
|
|
|
render json: { error: I18n.t('errors.429') }, status: 429
|
|
|
|
end
|
|
|
|
|
2022-11-14 18:06:06 +11:00
|
|
|
rescue_from ActionController::ParameterMissing, Mastodon::InvalidParameterError do |e|
|
2019-08-30 09:34:47 +10:00
|
|
|
render json: { error: e.to_s }, status: 400
|
|
|
|
end
|
|
|
|
|
2016-11-22 02:19:35 +11:00
|
|
|
def doorkeeper_unauthorized_render_options(error: nil)
|
2023-12-02 03:00:44 +11:00
|
|
|
{ json: { error: error.try(:description) || 'Not authorized' } }
|
2016-10-23 04:38:47 +11:00
|
|
|
end
|
|
|
|
|
|
|
|
def doorkeeper_forbidden_render_options(*)
|
|
|
|
{ json: { error: 'This action is outside the authorized scopes' } }
|
|
|
|
end
|
|
|
|
|
2016-03-07 22:42:33 +11:00
|
|
|
protected
|
|
|
|
|
2016-11-10 03:48:44 +11:00
|
|
|
def set_pagination_headers(next_path = nil, prev_path = nil)
|
|
|
|
links = []
|
2016-11-16 02:56:29 +11:00
|
|
|
links << [next_path, [%w(rel next)]] if next_path
|
|
|
|
links << [prev_path, [%w(rel prev)]] if prev_path
|
2017-08-18 18:42:59 +10:00
|
|
|
response.headers['Link'] = LinkHeader.new(links) unless links.empty?
|
2016-11-10 03:48:44 +11:00
|
|
|
end
|
|
|
|
|
2017-01-24 14:22:10 +11:00
|
|
|
def limit_param(default_limit)
|
|
|
|
return default_limit unless params[:limit]
|
2020-09-01 11:04:00 +10:00
|
|
|
|
2017-01-24 14:22:10 +11:00
|
|
|
[params[:limit].to_i.abs, default_limit * 2].min
|
|
|
|
end
|
|
|
|
|
2018-09-28 10:23:45 +10:00
|
|
|
def params_slice(*keys)
|
|
|
|
params.slice(*keys).permit(*keys)
|
|
|
|
end
|
|
|
|
|
2016-03-07 22:42:33 +11:00
|
|
|
def current_resource_owner
|
2016-11-23 19:20:34 +11:00
|
|
|
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
2016-03-07 22:42:33 +11:00
|
|
|
end
|
|
|
|
|
|
|
|
def current_user
|
2017-04-18 23:57:46 +10:00
|
|
|
current_resource_owner || super
|
2016-11-09 09:22:44 +11:00
|
|
|
rescue ActiveRecord::RecordNotFound
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2019-07-30 19:10:46 +10:00
|
|
|
def require_authenticated_user!
|
2020-01-24 08:00:13 +11:00
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 401 unless current_user
|
2019-07-30 19:10:46 +10:00
|
|
|
end
|
|
|
|
|
2022-05-27 06:04:05 +10:00
|
|
|
def require_not_suspended!
|
2023-12-01 02:43:26 +11:00
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403 if current_user&.account&.unavailable?
|
2022-05-27 06:04:05 +10:00
|
|
|
end
|
|
|
|
|
2023-12-19 21:55:39 +11: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 09:22:44 +11:00
|
|
|
def require_user!
|
2018-12-26 05:35:26 +11:00
|
|
|
if !current_user
|
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 422
|
|
|
|
elsif !current_user.confirmed?
|
2019-03-14 15:28:30 +11: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 22:37:58 +10:00
|
|
|
elsif !current_user.functional?
|
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403
|
2017-08-15 22:14:12 +10:00
|
|
|
else
|
2020-11-13 09:05:01 +11:00
|
|
|
update_user_sign_in
|
2017-08-15 22:14:12 +10:00
|
|
|
end
|
2016-03-07 22:42:33 +11:00
|
|
|
end
|
2016-09-27 07:55:21 +10:00
|
|
|
|
|
|
|
def render_empty
|
|
|
|
render json: {}, status: 200
|
|
|
|
end
|
2018-07-06 02:31:35 +10:00
|
|
|
|
|
|
|
def authorize_if_got_token!(*scopes)
|
|
|
|
doorkeeper_authorize!(*scopes) if doorkeeper_token
|
|
|
|
end
|
2019-05-04 04:39:19 +10:00
|
|
|
|
2019-07-30 19:10:46 +10:00
|
|
|
def disallow_unauthenticated_api_access?
|
2023-08-03 03:32:48 +10:00
|
|
|
ENV['DISALLOW_UNAUTHENTICATED_API_ACCESS'] == 'true' || Rails.configuration.x.limited_federation_mode
|
2019-07-30 19:10:46 +10:00
|
|
|
end
|
2022-09-08 17:44:36 +10:00
|
|
|
|
|
|
|
private
|
|
|
|
|
2023-12-19 21:55:39 +11:00
|
|
|
def pagination_options_invalid?
|
|
|
|
params.slice(:limit, :offset).values.map(&:to_i).any?(&:negative?)
|
|
|
|
end
|
|
|
|
|
2022-09-08 17:44:36 +10:00
|
|
|
def respond_with_error(code)
|
|
|
|
render json: { error: Rack::Utils::HTTP_STATUS_CODES[code] }, status: code
|
|
|
|
end
|
2016-03-05 22:50:59 +11:00
|
|
|
end
|