2016-11-15 10:56:29 -05:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-06-07 14:09:25 -04:00
|
|
|
class Api::BaseController < ApplicationController
|
2016-11-09 11:48:44 -05:00
|
|
|
DEFAULT_STATUSES_LIMIT = 20
|
|
|
|
DEFAULT_ACCOUNTS_LIMIT = 40
|
|
|
|
|
2017-06-07 11:23:26 -04:00
|
|
|
include RateLimitHeaders
|
2022-03-01 10:48:58 -05:00
|
|
|
include AccessTokenTrackingConcern
|
2017-06-07 11:23:26 -04:00
|
|
|
|
2017-04-09 16:21:52 -04:00
|
|
|
skip_before_action :store_current_location
|
2020-06-19 13:18:47 -04:00
|
|
|
skip_before_action :require_functional!, unless: :whitelist_mode?
|
2018-08-23 17:26:29 -04:00
|
|
|
|
2019-07-30 05:10:46 -04:00
|
|
|
before_action :require_authenticated_user!, if: :disallow_unauthenticated_api_access?
|
2022-05-26 16:04:05 -04:00
|
|
|
before_action :require_not_suspended!
|
2023-04-19 10:07:29 -04:00
|
|
|
before_action :set_cache_control_defaults
|
2019-05-03 14:39:19 -04:00
|
|
|
|
2018-01-08 14:01:33 -05:00
|
|
|
protect_from_forgery with: :null_session
|
2016-03-07 06:42:33 -05:00
|
|
|
|
2022-12-15 10:40:32 -05:00
|
|
|
content_security_policy do |p|
|
|
|
|
# Set every directive that does not have a fallback
|
|
|
|
p.default_src :none
|
|
|
|
p.frame_ancestors :none
|
|
|
|
p.form_action :none
|
|
|
|
|
|
|
|
# Disable every directive with a fallback to cut on response size
|
|
|
|
p.base_uri false
|
|
|
|
p.font_src false
|
|
|
|
p.img_src false
|
|
|
|
p.style_src false
|
|
|
|
p.media_src false
|
|
|
|
p.frame_src false
|
|
|
|
p.manifest_src false
|
|
|
|
p.connect_src false
|
|
|
|
p.script_src false
|
|
|
|
p.child_src false
|
|
|
|
p.worker_src false
|
|
|
|
end
|
|
|
|
|
2017-02-26 17:23:06 -05:00
|
|
|
rescue_from ActiveRecord::RecordInvalid, Mastodon::ValidationError do |e|
|
2016-09-30 16:31:16 -04:00
|
|
|
render json: { error: e.to_s }, status: 422
|
2016-08-26 13:12:19 -04:00
|
|
|
end
|
|
|
|
|
2019-12-06 16:40:06 -05:00
|
|
|
rescue_from ActiveRecord::RecordNotUnique do
|
|
|
|
render json: { error: 'Duplicate record' }, status: 422
|
|
|
|
end
|
|
|
|
|
2022-10-27 08:30:52 -04:00
|
|
|
rescue_from Date::Error do
|
|
|
|
render json: { error: 'Invalid date supplied' }, status: 422
|
|
|
|
end
|
|
|
|
|
2016-08-26 13:12:19 -04:00
|
|
|
rescue_from ActiveRecord::RecordNotFound do
|
|
|
|
render json: { error: 'Record not found' }, status: 404
|
|
|
|
end
|
|
|
|
|
2017-07-19 19:59:07 -04:00
|
|
|
rescue_from HTTP::Error, Mastodon::UnexpectedResponseError do
|
2016-09-17 11:03:36 -04:00
|
|
|
render json: { error: 'Remote data could not be fetched' }, status: 503
|
|
|
|
end
|
|
|
|
|
2016-10-05 07:26:44 -04:00
|
|
|
rescue_from OpenSSL::SSL::SSLError do
|
|
|
|
render json: { error: 'Remote SSL certificate could not be verified' }, status: 503
|
|
|
|
end
|
|
|
|
|
2017-02-26 17:23:06 -05:00
|
|
|
rescue_from Mastodon::NotPermittedError do
|
2016-12-22 15:34:19 -05:00
|
|
|
render json: { error: 'This action is not allowed' }, status: 403
|
|
|
|
end
|
|
|
|
|
2021-07-21 12:34:39 -04: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-29 19:34:47 -04:00
|
|
|
render json: { error: 'There was a temporary problem serving your request, please try again' }, status: 503
|
|
|
|
end
|
|
|
|
|
2020-03-08 10:17:39 -04:00
|
|
|
rescue_from Mastodon::RateLimitExceededError do
|
|
|
|
render json: { error: I18n.t('errors.429') }, status: 429
|
|
|
|
end
|
|
|
|
|
2022-11-14 02:06:06 -05:00
|
|
|
rescue_from ActionController::ParameterMissing, Mastodon::InvalidParameterError do |e|
|
2019-08-29 19:34:47 -04:00
|
|
|
render json: { error: e.to_s }, status: 400
|
|
|
|
end
|
|
|
|
|
2016-11-21 10:19:35 -05:00
|
|
|
def doorkeeper_unauthorized_render_options(error: nil)
|
|
|
|
{ json: { error: (error.try(:description) || 'Not authorized') } }
|
2016-10-22 13:38:47 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def doorkeeper_forbidden_render_options(*)
|
|
|
|
{ json: { error: 'This action is outside the authorized scopes' } }
|
|
|
|
end
|
|
|
|
|
2016-03-07 06:42:33 -05:00
|
|
|
protected
|
|
|
|
|
2016-11-09 11:48:44 -05:00
|
|
|
def set_pagination_headers(next_path = nil, prev_path = nil)
|
|
|
|
links = []
|
2016-11-15 10:56:29 -05:00
|
|
|
links << [next_path, [%w(rel next)]] if next_path
|
|
|
|
links << [prev_path, [%w(rel prev)]] if prev_path
|
2017-08-18 04:42:59 -04:00
|
|
|
response.headers['Link'] = LinkHeader.new(links) unless links.empty?
|
2016-11-09 11:48:44 -05:00
|
|
|
end
|
|
|
|
|
2017-01-23 22:22:10 -05:00
|
|
|
def limit_param(default_limit)
|
|
|
|
return default_limit unless params[:limit]
|
2020-08-31 21:04:00 -04:00
|
|
|
|
2017-01-23 22:22:10 -05:00
|
|
|
[params[:limit].to_i.abs, default_limit * 2].min
|
|
|
|
end
|
|
|
|
|
2018-09-27 20:23:45 -04:00
|
|
|
def params_slice(*keys)
|
|
|
|
params.slice(*keys).permit(*keys)
|
|
|
|
end
|
|
|
|
|
2016-03-07 06:42:33 -05:00
|
|
|
def current_resource_owner
|
2016-11-23 03:20:34 -05:00
|
|
|
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
2016-03-07 06:42:33 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
def current_user
|
2017-04-18 09:57:46 -04:00
|
|
|
current_resource_owner || super
|
2016-11-08 17:22:44 -05:00
|
|
|
rescue ActiveRecord::RecordNotFound
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2019-07-30 05:10:46 -04:00
|
|
|
def require_authenticated_user!
|
2020-01-23 16:00:13 -05:00
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 401 unless current_user
|
2019-07-30 05:10:46 -04:00
|
|
|
end
|
|
|
|
|
2022-05-26 16:04:05 -04:00
|
|
|
def require_not_suspended!
|
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403 if current_user&.account&.suspended?
|
|
|
|
end
|
|
|
|
|
2016-11-08 17:22:44 -05:00
|
|
|
def require_user!
|
2018-12-25 13:35:26 -05:00
|
|
|
if !current_user
|
|
|
|
render json: { error: 'This method requires an authenticated user' }, status: 422
|
|
|
|
elsif !current_user.confirmed?
|
2019-03-14 00:28:30 -04: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 08:37:58 -04:00
|
|
|
elsif !current_user.functional?
|
|
|
|
render json: { error: 'Your login is currently disabled' }, status: 403
|
2017-08-15 08:14:12 -04:00
|
|
|
else
|
2020-11-12 17:05:01 -05:00
|
|
|
update_user_sign_in
|
2017-08-15 08:14:12 -04:00
|
|
|
end
|
2016-03-07 06:42:33 -05:00
|
|
|
end
|
2016-09-26 17:55:21 -04:00
|
|
|
|
|
|
|
def render_empty
|
|
|
|
render json: {}, status: 200
|
|
|
|
end
|
2018-07-05 12:31:35 -04:00
|
|
|
|
|
|
|
def authorize_if_got_token!(*scopes)
|
|
|
|
doorkeeper_authorize!(*scopes) if doorkeeper_token
|
|
|
|
end
|
2019-05-03 14:39:19 -04:00
|
|
|
|
2023-04-19 10:07:29 -04:00
|
|
|
def set_cache_control_defaults
|
|
|
|
response.cache_control.replace(private: true, no_store: true)
|
2019-05-03 14:39:19 -04:00
|
|
|
end
|
2019-07-30 05:10:46 -04:00
|
|
|
|
|
|
|
def disallow_unauthenticated_api_access?
|
2022-11-05 17:56:03 -04:00
|
|
|
ENV['DISALLOW_UNAUTHENTICATED_API_ACCESS'] == 'true' || Rails.configuration.x.whitelist_mode
|
2019-07-30 05:10:46 -04:00
|
|
|
end
|
2022-09-08 03:44:36 -04:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def respond_with_error(code)
|
|
|
|
render json: { error: Rack::Utils::HTTP_STATUS_CODES[code] }, status: code
|
|
|
|
end
|
2016-03-05 06:50:59 -05:00
|
|
|
end
|