]> git.openstreetmap.org Git - rails.git/blob - app/controllers/api_controller.rb
Don't show types twice in issue type select
[rails.git] / app / controllers / api_controller.rb
1 class ApiController < ApplicationController
2   skip_before_action :verify_authenticity_token
3
4   before_action :check_api_readable
5
6   around_action :api_call_handle_error, :api_call_timeout
7
8   private
9
10   ##
11   # Set allowed request formats if no explicit format has been
12   # requested via a URL suffix. Allowed formats are taken from
13   # any HTTP Accept header with XML as the default.
14   def set_request_formats
15     unless params[:format]
16       accept_header = request.headers["HTTP_ACCEPT"]
17
18       if accept_header
19         # Some clients (such asJOSM) send Accept headers which cannot be
20         # parse by Rails, for example:
21         #
22         #   Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
23         #
24         # where both "*" and ".2" as a quality do not adhere to the syntax
25         # described in RFC 7231, section 5.3.1, etc.
26         #
27         # As a workaround, and for back compatibility, default to XML format.
28         mimetypes = begin
29           Mime::Type.parse(accept_header)
30         rescue Mime::Type::InvalidMimeType
31           Array(Mime[:xml])
32         end
33
34         # Allow XML and JSON formats, and treat an all formats wildcard
35         # as XML for backwards compatibility - all other formats are discarded
36         # which will result in a 406 Not Acceptable response being sent
37         formats = mimetypes.map do |mime|
38           if mime.symbol == :xml || mime == "*/*" then :xml
39           elsif mime.symbol == :json then :json
40           end
41         end
42       else
43         # Default to XML if no accept header was sent - this includes
44         # the unit tests which don't set one by default
45         formats = Array(:xml)
46       end
47
48       request.formats = formats.compact
49     end
50   end
51
52   def authorize(errormessage = "Couldn't authenticate you")
53     # make the current_user object from any auth sources we have
54     setup_user_auth
55
56     # handle authenticate pass/fail
57     unless current_user
58       # no auth, the user does not exist or the password was wrong
59       render :plain => errormessage, :status => :unauthorized
60
61       false
62     end
63   end
64
65   def current_ability
66     # Use capabilities from the oauth token if it exists and is a valid access token
67     if doorkeeper_token&.accessible?
68       ApiAbility.new(nil).merge(ApiCapability.new(doorkeeper_token))
69     else
70       ApiAbility.new(current_user)
71     end
72   end
73
74   def deny_access(_exception)
75     if doorkeeper_token
76       set_locale
77       report_error t("oauth.permissions.missing"), :forbidden
78     elsif current_user
79       head :forbidden
80     else
81       head :unauthorized
82     end
83   end
84
85   def gpx_status
86     status = database_status
87     status = "offline" if status == "online" && Settings.status == "gpx_offline"
88     status
89   end
90
91   ##
92   # sets up the current_user for use by other methods. this is mostly called
93   # from the authorize method, but can be called elsewhere if authorisation
94   # is optional.
95   def setup_user_auth
96     logger.info " setup_user_auth"
97     # try and setup using OAuth
98     self.current_user = User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token&.accessible?
99
100     # have we identified the user?
101     if current_user
102       # check if the user has been banned
103       user_block = current_user.blocks.active.take
104       unless user_block.nil?
105         set_locale
106         if user_block.zero_hour?
107           report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
108         else
109           report_error t("application.setup_user_auth.blocked"), :forbidden
110         end
111       end
112
113       # if the user hasn't seen the contributor terms then don't
114       # allow editing - they have to go to the web site and see
115       # (but can decline) the CTs to continue.
116       if !current_user.terms_seen && flash[:skip_terms].nil?
117         set_locale
118         report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
119       end
120     end
121   end
122
123   def api_call_handle_error
124     yield
125   rescue ActionController::UnknownFormat
126     head :not_acceptable
127   rescue ActiveRecord::RecordNotFound => e
128     head :not_found
129   rescue LibXML::XML::Error, ArgumentError => e
130     report_error e.message, :bad_request
131   rescue ActiveRecord::RecordInvalid => e
132     message = "#{e.record.class} #{e.record.id}: "
133     e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
134     report_error message, :bad_request
135   rescue OSM::APIError => e
136     report_error e.message, e.status
137   rescue AbstractController::ActionNotFound, CanCan::AccessDenied => e
138     raise
139   rescue StandardError => e
140     logger.info("API threw unexpected #{e.class} exception: #{e.message}")
141     e.backtrace.each { |l| logger.info(l) }
142     report_error "#{e.class}: #{e.message}", :internal_server_error
143   end
144
145   ##
146   # wrap an api call in a timeout
147   def api_call_timeout(&)
148     Timeout.timeout(Settings.api_timeout, &)
149   rescue ActionView::Template::Error => e
150     e = e.cause
151
152     if e.is_a?(Timeout::Error) ||
153        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
154       ActiveRecord::Base.connection.raw_connection.cancel
155       raise OSM::APITimeoutError
156     else
157       raise
158     end
159   rescue Timeout::Error
160     ActiveRecord::Base.connection.raw_connection.cancel
161     raise OSM::APITimeoutError
162   end
163
164   ##
165   # check the api change rate limit
166   def check_rate_limit(new_changes = 1)
167     max_changes = ActiveRecord::Base.connection.select_value(
168       "SELECT api_rate_limit($1)", "api_rate_limit", [current_user.id]
169     )
170
171     raise OSM::APIRateLimitExceeded if new_changes > max_changes
172   end
173 end