]> git.openstreetmap.org Git - rails.git/blob - app/controllers/application_controller.rb
Merge pull request #5390 from AntonKhorev/trace-resourceful-routes
[rails.git] / app / controllers / application_controller.rb
1 class ApplicationController < ActionController::Base
2   require "timeout"
3
4   include SessionPersistence
5
6   protect_from_forgery :with => :exception
7
8   add_flash_types :warning, :error
9
10   rescue_from CanCan::AccessDenied, :with => :deny_access
11   check_authorization
12
13   rescue_from RailsParam::InvalidParameterError, :with => :invalid_parameter
14
15   before_action :fetch_body
16
17   attr_accessor :current_user, :oauth_token
18
19   helper_method :current_user
20   helper_method :oauth_token
21
22   def self.allow_thirdparty_images(**options)
23     content_security_policy(options) do |policy|
24       policy.img_src("*", :data)
25     end
26   end
27
28   def self.allow_social_login(**options)
29     content_security_policy(options) do |policy|
30       policy.form_action(*policy.form_action, "accounts.google.com", "*.facebook.com", "login.microsoftonline.com", "github.com", "meta.wikimedia.org")
31     end
32   end
33
34   def self.allow_all_form_action(**options)
35     content_security_policy(options) do |policy|
36       policy.form_action(nil)
37     end
38   end
39
40   private
41
42   def authorize_web
43     if session[:user]
44       self.current_user = User.find_by(:id => session[:user], :status => %w[active confirmed suspended])
45
46       if session[:fingerprint] &&
47          session[:fingerprint] != current_user.fingerprint
48         reset_session
49         self.current_user = nil
50       elsif current_user.status == "suspended"
51         session.delete(:user)
52         session_expires_automatically
53
54         redirect_to :controller => "users", :action => "suspended"
55
56       # don't allow access to any auth-requiring part of the site unless
57       # the new CTs have been seen (and accept/decline chosen).
58       elsif !current_user.terms_seen && flash[:skip_terms].nil?
59         flash[:notice] = t "users.terms.you need to accept or decline"
60         if params[:referer]
61           redirect_to :controller => "users", :action => "terms", :referer => params[:referer]
62         else
63           redirect_to :controller => "users", :action => "terms", :referer => request.fullpath
64         end
65       end
66     end
67
68     session[:fingerprint] = current_user.fingerprint if current_user && session[:fingerprint].nil?
69   rescue StandardError => e
70     logger.info("Exception authorizing user: #{e}")
71     reset_session
72     self.current_user = nil
73   end
74
75   def require_user
76     unless current_user
77       if request.get?
78         redirect_to login_path(:referer => request.fullpath)
79       else
80         head :forbidden
81       end
82     end
83   end
84
85   def require_oauth
86     @oauth_token = current_user.oauth_token(Settings.oauth_application) if current_user && Settings.key?(:oauth_application)
87   end
88
89   ##
90   # require the user to have cookies enabled in their browser
91   def require_cookies
92     if request.cookies["_osm_session"].to_s == ""
93       if params[:cookie_test].nil?
94         session[:cookie_test] = true
95         redirect_to params.to_unsafe_h.merge(:only_path => true, :cookie_test => "true")
96         false
97       else
98         flash.now[:warning] = t "application.require_cookies.cookies_needed"
99       end
100     else
101       session.delete(:cookie_test)
102     end
103   end
104
105   def check_database_readable(need_api: false)
106     if Settings.status == "database_offline" || (need_api && Settings.status == "api_offline")
107       if request.xhr?
108         report_error "Database offline for maintenance", :service_unavailable
109       else
110         redirect_to :controller => "site", :action => "offline"
111       end
112     end
113   end
114
115   def check_database_writable(need_api: false)
116     if Settings.status == "database_offline" || Settings.status == "database_readonly" ||
117        (need_api && (Settings.status == "api_offline" || Settings.status == "api_readonly"))
118       if request.xhr?
119         report_error "Database offline for maintenance", :service_unavailable
120       else
121         redirect_to :controller => "site", :action => "offline"
122       end
123     end
124   end
125
126   def check_api_readable
127     if api_status == "offline"
128       report_error "Database offline for maintenance", :service_unavailable
129       false
130     end
131   end
132
133   def check_api_writable
134     unless api_status == "online"
135       report_error "Database offline for maintenance", :service_unavailable
136       false
137     end
138   end
139
140   def database_status
141     case Settings.status
142     when "database_offline"
143       "offline"
144     when "database_readonly"
145       "readonly"
146     else
147       "online"
148     end
149   end
150
151   def api_status
152     status = database_status
153     if status == "online"
154       case Settings.status
155       when "api_offline"
156         status = "offline"
157       when "api_readonly"
158         status = "readonly"
159       end
160     end
161     status
162   end
163
164   def require_public_data
165     unless current_user.data_public?
166       report_error "You must make your edits public to upload new data", :forbidden
167       false
168     end
169   end
170
171   # Report and error to the user
172   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
173   #  rather than only a status code and having the web engine make up a
174   #  phrase from that, we can also put the error message into the status
175   #  message. For now, rails won't let us)
176   def report_error(message, status = :bad_request)
177     # TODO: some sort of escaping of problem characters in the message
178     response.headers["Error"] = message
179
180     if request.headers["X-Error-Format"]&.casecmp?("xml")
181       result = OSM::API.new.xml_doc
182       result.root.name = "osmError"
183       result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
184       result.root << (XML::Node.new("message") << message)
185
186       render :xml => result.to_s
187     else
188       render :plain => message, :status => status
189     end
190   end
191
192   def preferred_languages
193     @preferred_languages ||= if params[:locale]
194                                Locale.list(params[:locale])
195                              elsif current_user
196                                current_user.preferred_languages
197                              else
198                                Locale.list(http_accept_language.user_preferred_languages)
199                              end
200   end
201
202   helper_method :preferred_languages
203
204   def set_locale
205     if current_user&.languages&.empty? && !http_accept_language.user_preferred_languages.empty?
206       current_user.languages = http_accept_language.user_preferred_languages
207       current_user.save
208     end
209
210     I18n.locale = Locale.available.preferred(preferred_languages)
211
212     response.headers["Vary"] = "Accept-Language"
213     response.headers["Content-Language"] = I18n.locale.to_s
214   end
215
216   ##
217   # wrap a web page in a timeout
218   def web_timeout(&)
219     raise Timeout::Error if Settings.web_timeout.negative?
220
221     Timeout.timeout(Settings.web_timeout, &)
222   rescue ActionView::Template::Error => e
223     e = e.cause
224
225     if e.is_a?(Timeout::Error) ||
226        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
227       respond_to_timeout
228     else
229       raise
230     end
231   rescue Timeout::Error
232     respond_to_timeout
233   end
234
235   def respond_to_timeout
236     ActiveRecord::Base.connection.raw_connection.cancel
237     render :action => "timeout", :status => :gateway_timeout
238   end
239
240   ##
241   # Unfortunately if a PUT or POST request that has a body fails to
242   # read it then Apache will sometimes fail to return the response it
243   # is given to the client properly, instead erroring:
244   #
245   #   https://issues.apache.org/bugzilla/show_bug.cgi?id=44782
246   #
247   # To work round this we call rewind on the body here, which is added
248   # as a filter, to force it to be fetched from Apache into a file.
249   def fetch_body
250     request.body.rewind
251   end
252
253   def map_layout
254     policy = request.content_security_policy.clone
255
256     policy.connect_src(*policy.connect_src, "http://127.0.0.1:8111", Settings.nominatim_url, Settings.overpass_url, Settings.fossgis_osrm_url, Settings.graphhopper_url, Settings.fossgis_valhalla_url)
257     policy.form_action(*policy.form_action, "render.openstreetmap.org")
258     policy.style_src(*policy.style_src, :unsafe_inline)
259
260     request.content_security_policy = policy
261
262     case Settings.status
263     when "database_offline", "api_offline"
264       flash.now[:warning] = t("layouts.osm_offline")
265     when "database_readonly", "api_readonly"
266       flash.now[:warning] = t("layouts.osm_read_only")
267     end
268
269     request.xhr? ? "xhr" : "map"
270   end
271
272   def preferred_editor
273     if params[:editor]
274       params[:editor]
275     elsif current_user&.preferred_editor
276       current_user.preferred_editor
277     else
278       Settings.default_editor
279     end
280   end
281
282   helper_method :preferred_editor
283
284   def update_totp
285     if Settings.key?(:totp_key)
286       cookies["_osm_totp_token"] = {
287         :value => ROTP::TOTP.new(Settings.totp_key, :interval => 3600).now,
288         :domain => "openstreetmap.org",
289         :expires => 1.hour.from_now
290       }
291     end
292   end
293
294   def current_ability
295     Ability.new(current_user)
296   end
297
298   def deny_access(_exception)
299     if doorkeeper_token
300       set_locale
301       report_error t("oauth.permissions.missing"), :forbidden
302     elsif current_user
303       set_locale
304       respond_to do |format|
305         format.html { redirect_to :controller => "/errors", :action => "forbidden" }
306         format.any { report_error t("application.permission_denied"), :forbidden }
307       end
308     elsif request.get?
309       respond_to do |format|
310         format.html { redirect_to login_path(:referer => request.fullpath) }
311         format.any { head :forbidden }
312       end
313     else
314       head :forbidden
315     end
316   end
317
318   def invalid_parameter(_exception)
319     if request.get?
320       respond_to do |format|
321         format.html { redirect_to :controller => "/errors", :action => "bad_request" }
322         format.any { head :bad_request }
323       end
324     else
325       head :bad_request
326     end
327   end
328
329   # clean any referer parameter
330   def safe_referer(referer)
331     begin
332       referer = URI.parse(referer)
333
334       if referer.scheme == "http" || referer.scheme == "https"
335         referer.scheme = nil
336         referer.host = nil
337         referer.port = nil
338       elsif referer.scheme || referer.host || referer.port
339         referer = nil
340       end
341
342       referer = nil if referer&.path&.first != "/"
343     rescue URI::InvalidURIError
344       referer = nil
345     end
346
347     referer&.to_s
348   end
349
350   def scope_enabled?(scope)
351     doorkeeper_token&.includes_scope?(scope)
352   end
353
354   helper_method :scope_enabled?
355 end