Merge remote-tracking branch 'upstream/pull/1580'
[rails.git] / app / controllers / application_controller.rb
1 class ApplicationController < ActionController::Base
2   include SessionPersistence
3
4   protect_from_forgery :with => :exception
5
6   before_action :fetch_body
7
8   attr_accessor :current_user
9   helper_method :current_user
10
11   def authorize_web
12     if session[:user]
13       self.current_user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
14
15       if current_user.status == "suspended"
16         session.delete(:user)
17         session_expires_automatically
18
19         redirect_to :controller => "user", :action => "suspended"
20
21       # don't allow access to any auth-requiring part of the site unless
22       # the new CTs have been seen (and accept/decline chosen).
23       elsif !current_user.terms_seen && flash[:skip_terms].nil?
24         flash[:notice] = t "user.terms.you need to accept or decline"
25         if params[:referer]
26           redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
27         else
28           redirect_to :controller => "user", :action => "terms", :referer => request.fullpath
29         end
30       end
31     elsif session[:token]
32       if self.current_user = User.authenticate(:token => session[:token])
33         session[:user] = current_user.id
34       end
35     end
36   rescue StandardError => ex
37     logger.info("Exception authorizing user: #{ex}")
38     reset_session
39     self.current_user = nil
40   end
41
42   def require_user
43     unless current_user
44       if request.get?
45         redirect_to :controller => "user", :action => "login", :referer => request.fullpath
46       else
47         head :forbidden
48       end
49     end
50   end
51
52   def require_oauth
53     @oauth = current_user.access_token(OAUTH_KEY) if current_user && defined? OAUTH_KEY
54   end
55
56   ##
57   # requires the user to be logged in by the token or HTTP methods, or have an
58   # OAuth token with the right capability. this method is a bit of a pain to call
59   # directly, since it's cumbersome to call filters with arguments in rails. to
60   # make it easier to read and write the code, there are some utility methods
61   # below.
62   def require_capability(cap)
63     # when the current token is nil, it means the user logged in with a different
64     # method, otherwise an OAuth token was used, which has to be checked.
65     unless current_token.nil?
66       unless current_token.read_attribute(cap)
67         set_locale
68         report_error t("oauth.permissions.missing"), :forbidden
69         false
70       end
71     end
72   end
73
74   ##
75   # require the user to have cookies enabled in their browser
76   def require_cookies
77     if request.cookies["_osm_session"].to_s == ""
78       if params[:cookie_test].nil?
79         session[:cookie_test] = true
80         redirect_to params.to_unsafe_h.merge(:cookie_test => "true")
81         false
82       else
83         flash.now[:warning] = t "application.require_cookies.cookies_needed"
84       end
85     else
86       session.delete(:cookie_test)
87     end
88   end
89
90   # Utility methods to make the controller filter methods easier to read and write.
91   def require_allow_read_prefs
92     require_capability(:allow_read_prefs)
93   end
94
95   def require_allow_write_prefs
96     require_capability(:allow_write_prefs)
97   end
98
99   def require_allow_write_diary
100     require_capability(:allow_write_diary)
101   end
102
103   def require_allow_write_api
104     require_capability(:allow_write_api)
105
106     if REQUIRE_TERMS_AGREED && current_user.terms_agreed.nil?
107       report_error "You must accept the contributor terms before you can edit.", :forbidden
108       return false
109     end
110   end
111
112   def require_allow_read_gpx
113     require_capability(:allow_read_gpx)
114   end
115
116   def require_allow_write_gpx
117     require_capability(:allow_write_gpx)
118   end
119
120   def require_allow_write_notes
121     require_capability(:allow_write_notes)
122   end
123
124   ##
125   # require that the user is a moderator, or fill out a helpful error message
126   # and return them to the index for the controller this is wrapped from.
127   def require_moderator
128     unless current_user.moderator?
129       if request.get?
130         flash[:error] = t("application.require_moderator.not_a_moderator")
131         redirect_to :action => "index"
132       else
133         head :forbidden
134       end
135     end
136   end
137
138   ##
139   # sets up the current_user for use by other methods. this is mostly called
140   # from the authorize method, but can be called elsewhere if authorisation
141   # is optional.
142   def setup_user_auth
143     # try and setup using OAuth
144     unless Authenticator.new(self, [:token]).allow?
145       username, passwd = get_auth_data # parse from headers
146       # authenticate per-scheme
147       self.current_user = if username.nil?
148                             nil # no authentication provided - perhaps first connect (client should retry after 401)
149                           elsif username == "token"
150                             User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
151                           else
152                             User.authenticate(:username => username, :password => passwd) # basic auth
153                           end
154     end
155
156     # have we identified the user?
157     if current_user
158       # check if the user has been banned
159       user_block = current_user.blocks.active.take
160       unless user_block.nil?
161         set_locale
162         if user_block.zero_hour?
163           report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
164         else
165           report_error t("application.setup_user_auth.blocked"), :forbidden
166         end
167       end
168
169       # if the user hasn't seen the contributor terms then don't
170       # allow editing - they have to go to the web site and see
171       # (but can decline) the CTs to continue.
172       if REQUIRE_TERMS_SEEN && !current_user.terms_seen && flash[:skip_terms].nil?
173         set_locale
174         report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
175       end
176     end
177   end
178
179   def authorize(realm = "Web Password", errormessage = "Couldn't authenticate you")
180     # make the @user object from any auth sources we have
181     setup_user_auth
182
183     # handle authenticate pass/fail
184     unless current_user
185       # no auth, the user does not exist or the password was wrong
186       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
187       render :plain => errormessage, :status => :unauthorized
188       return false
189     end
190   end
191
192   ##
193   # to be used as a before_filter *after* authorize. this checks that
194   # the user is a moderator and, if not, returns a forbidden error.
195   #
196   # NOTE: this isn't a very good way of doing it - it duplicates logic
197   # from require_moderator - but what we really need to do is a fairly
198   # drastic refactoring based on :format and respond_to? but not a
199   # good idea to do that in this branch.
200   def authorize_moderator(errormessage = "Access restricted to moderators")
201     # check user is a moderator
202     unless current_user.moderator?
203       render :plain => errormessage, :status => :forbidden
204       false
205     end
206   end
207
208   def check_database_readable(need_api = false)
209     if STATUS == :database_offline || (need_api && STATUS == :api_offline)
210       if request.xhr?
211         report_error "Database offline for maintenance", :service_unavailable
212       else
213         redirect_to :controller => "site", :action => "offline"
214       end
215     end
216   end
217
218   def check_database_writable(need_api = false)
219     if STATUS == :database_offline || STATUS == :database_readonly ||
220        (need_api && (STATUS == :api_offline || STATUS == :api_readonly))
221       if request.xhr?
222         report_error "Database offline for maintenance", :service_unavailable
223       else
224         redirect_to :controller => "site", :action => "offline"
225       end
226     end
227   end
228
229   def check_api_readable
230     if api_status == :offline
231       report_error "Database offline for maintenance", :service_unavailable
232       false
233     end
234   end
235
236   def check_api_writable
237     unless api_status == :online
238       report_error "Database offline for maintenance", :service_unavailable
239       false
240     end
241   end
242
243   def database_status
244     if STATUS == :database_offline
245       :offline
246     elsif STATUS == :database_readonly
247       :readonly
248     else
249       :online
250     end
251   end
252
253   def api_status
254     status = database_status
255     if status == :online
256       if STATUS == :api_offline
257         status = :offline
258       elsif STATUS == :api_readonly
259         status = :readonly
260       end
261     end
262     status
263   end
264
265   def gpx_status
266     status = database_status
267     status = :offline if status == :online && STATUS == :gpx_offline
268     status
269   end
270
271   def require_public_data
272     unless current_user.data_public?
273       report_error "You must make your edits public to upload new data", :forbidden
274       false
275     end
276   end
277
278   # Report and error to the user
279   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
280   #  rather than only a status code and having the web engine make up a
281   #  phrase from that, we can also put the error message into the status
282   #  message. For now, rails won't let us)
283   def report_error(message, status = :bad_request)
284     # TODO: some sort of escaping of problem characters in the message
285     response.headers["Error"] = message
286
287     if request.headers["X-Error-Format"] &&
288        request.headers["X-Error-Format"].casecmp("xml").zero?
289       result = OSM::API.new.get_xml_doc
290       result.root.name = "osmError"
291       result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
292       result.root << (XML::Node.new("message") << message)
293
294       render :xml => result.to_s
295     else
296       render :plain => message, :status => status
297     end
298   end
299
300   def preferred_languages
301     @languages ||= if params[:locale]
302                      Locale.list(params[:locale])
303                    elsif current_user
304                      current_user.preferred_languages
305                    else
306                      Locale.list(http_accept_language.user_preferred_languages)
307                    end
308   end
309
310   helper_method :preferred_languages
311
312   def set_locale
313     if current_user && current_user.languages.empty? && !http_accept_language.user_preferred_languages.empty?
314       current_user.languages = http_accept_language.user_preferred_languages
315       current_user.save
316     end
317
318     I18n.locale = Locale.available.preferred(preferred_languages)
319
320     response.headers["Vary"] = "Accept-Language"
321     response.headers["Content-Language"] = I18n.locale.to_s
322   end
323
324   def api_call_handle_error
325     yield
326   rescue ActiveRecord::RecordNotFound => ex
327     head :not_found
328   rescue LibXML::XML::Error, ArgumentError => ex
329     report_error ex.message, :bad_request
330   rescue ActiveRecord::RecordInvalid => ex
331     message = "#{ex.record.class} #{ex.record.id}: "
332     ex.record.errors.each { |attr, msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
333     report_error message, :bad_request
334   rescue OSM::APIError => ex
335     report_error ex.message, ex.status
336   rescue AbstractController::ActionNotFound => ex
337     raise
338   rescue StandardError => ex
339     logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
340     ex.backtrace.each { |l| logger.info(l) }
341     report_error "#{ex.class}: #{ex.message}", :internal_server_error
342   end
343
344   ##
345   # asserts that the request method is the +method+ given as a parameter
346   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
347   def assert_method(method)
348     ok = request.send((method.to_s.downcase + "?").to_sym)
349     raise OSM::APIBadMethodError, method unless ok
350   end
351
352   ##
353   # wrap an api call in a timeout
354   def api_call_timeout
355     OSM::Timer.timeout(API_TIMEOUT, Timeout::Error) do
356       yield
357     end
358   rescue Timeout::Error
359     raise OSM::APITimeoutError
360   end
361
362   ##
363   # wrap a web page in a timeout
364   def web_timeout
365     OSM::Timer.timeout(WEB_TIMEOUT, Timeout::Error) do
366       yield
367     end
368   rescue ActionView::Template::Error => ex
369     ex = ex.original_exception
370
371     if ex.is_a?(Timeout::Error) ||
372        (ex.is_a?(ActiveRecord::StatementInvalid) && ex.message =~ /execution expired/)
373       render :action => "timeout"
374     else
375       raise
376     end
377   rescue Timeout::Error
378     render :action => "timeout"
379   end
380
381   ##
382   # ensure that there is a "this_user" instance variable
383   def lookup_this_user
384     unless @this_user = User.active.find_by(:display_name => params[:display_name])
385       render_unknown_user params[:display_name]
386     end
387   end
388
389   ##
390   # render a "no such user" page
391   def render_unknown_user(name)
392     @title = t "user.no_such_user.title"
393     @not_found_user = name
394
395     respond_to do |format|
396       format.html { render :template => "user/no_such_user", :status => :not_found }
397       format.all { head :not_found }
398     end
399   end
400
401   ##
402   # Unfortunately if a PUT or POST request that has a body fails to
403   # read it then Apache will sometimes fail to return the response it
404   # is given to the client properly, instead erroring:
405   #
406   #   https://issues.apache.org/bugzilla/show_bug.cgi?id=44782
407   #
408   # To work round this we call rewind on the body here, which is added
409   # as a filter, to force it to be fetched from Apache into a file.
410   def fetch_body
411     request.body.rewind
412   end
413
414   def map_layout
415     append_content_security_policy_directives(
416       :connect_src => %w[nominatim.openstreetmap.org overpass-api.de router.project-osrm.org valhalla.mapzen.com],
417       :script_src => %w[graphhopper.com open.mapquestapi.com],
418       :img_src => %w[developer.mapquest.com]
419     )
420
421     if STATUS == :database_offline || STATUS == :api_offline
422       flash.now[:warning] = t("layouts.osm_offline")
423     elsif STATUS == :database_readonly || STATUS == :api_readonly
424       flash.now[:warning] = t("layouts.osm_read_only")
425     end
426
427     request.xhr? ? "xhr" : "map"
428   end
429
430   def preferred_editor
431     editor = if params[:editor]
432                params[:editor]
433              elsif current_user && current_user.preferred_editor
434                current_user.preferred_editor
435              else
436                DEFAULT_EDITOR
437              end
438
439     editor
440   end
441
442   helper_method :preferred_editor
443
444   def update_totp
445     if defined?(TOTP_KEY)
446       cookies["_osm_totp_token"] = {
447         :value => ROTP::TOTP.new(TOTP_KEY, :interval => 3600).now,
448         :domain => "openstreetmap.org",
449         :expires => 1.hour.from_now
450       }
451     end
452   end
453
454   private
455
456   # extract authorisation credentials from headers, returns user = nil if none
457   def get_auth_data
458     if request.env.key? "X-HTTP_AUTHORIZATION" # where mod_rewrite might have put it
459       authdata = request.env["X-HTTP_AUTHORIZATION"].to_s.split
460     elsif request.env.key? "REDIRECT_X_HTTP_AUTHORIZATION" # mod_fcgi
461       authdata = request.env["REDIRECT_X_HTTP_AUTHORIZATION"].to_s.split
462     elsif request.env.key? "HTTP_AUTHORIZATION" # regular location
463       authdata = request.env["HTTP_AUTHORIZATION"].to_s.split
464     end
465     # only basic authentication supported
466     if authdata && authdata[0] == "Basic"
467       user, pass = Base64.decode64(authdata[1]).split(":", 2)
468     end
469     [user, pass]
470   end
471
472   # override to stop oauth plugin sending errors
473   def invalid_oauth_response; end
474 end