1 class ApplicationController < ActionController::Base
2 include SessionPersistence
4 protect_from_forgery :with => :exception
6 before_action :fetch_body
8 attr_accessor :current_user
9 helper_method :current_user
13 self.current_user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
15 if current_user.status == "suspended"
17 session_expires_automatically
19 redirect_to :controller => "user", :action => "suspended"
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"
26 redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
28 redirect_to :controller => "user", :action => "terms", :referer => request.fullpath
32 session[:user] = current_user.id if self.current_user = User.authenticate(:token => session[:token])
34 rescue StandardError => ex
35 logger.info("Exception authorizing user: #{ex}")
37 self.current_user = nil
43 redirect_to :controller => "user", :action => "login", :referer => request.fullpath
51 @oauth = current_user.access_token(OAUTH_KEY) if current_user && defined? OAUTH_KEY
55 # requires the user to be logged in by the token or HTTP methods, or have an
56 # OAuth token with the right capability. this method is a bit of a pain to call
57 # directly, since it's cumbersome to call filters with arguments in rails. to
58 # make it easier to read and write the code, there are some utility methods
60 def require_capability(cap)
61 # when the current token is nil, it means the user logged in with a different
62 # method, otherwise an OAuth token was used, which has to be checked.
63 unless current_token.nil?
64 unless current_token.read_attribute(cap)
66 report_error t("oauth.permissions.missing"), :forbidden
73 # require the user to have cookies enabled in their browser
75 if request.cookies["_osm_session"].to_s == ""
76 if params[:cookie_test].nil?
77 session[:cookie_test] = true
78 redirect_to params.to_unsafe_h.merge(:cookie_test => "true")
81 flash.now[:warning] = t "application.require_cookies.cookies_needed"
84 session.delete(:cookie_test)
88 # Utility methods to make the controller filter methods easier to read and write.
89 def require_allow_read_prefs
90 require_capability(:allow_read_prefs)
93 def require_allow_write_prefs
94 require_capability(:allow_write_prefs)
97 def require_allow_write_diary
98 require_capability(:allow_write_diary)
101 def require_allow_write_api
102 require_capability(:allow_write_api)
104 if REQUIRE_TERMS_AGREED && current_user.terms_agreed.nil?
105 report_error "You must accept the contributor terms before you can edit.", :forbidden
110 def require_allow_read_gpx
111 require_capability(:allow_read_gpx)
114 def require_allow_write_gpx
115 require_capability(:allow_write_gpx)
118 def require_allow_write_notes
119 require_capability(:allow_write_notes)
123 # require that the user is a moderator, or fill out a helpful error message
124 # and return them to the index for the controller this is wrapped from.
125 def require_moderator
126 unless current_user.moderator?
128 flash[:error] = t("application.require_moderator.not_a_moderator")
129 redirect_to :action => "index"
137 # sets up the current_user for use by other methods. this is mostly called
138 # from the authorize method, but can be called elsewhere if authorisation
141 # try and setup using OAuth
142 unless Authenticator.new(self, [:token]).allow?
143 username, passwd = get_auth_data # parse from headers
144 # authenticate per-scheme
145 self.current_user = if username.nil?
146 nil # no authentication provided - perhaps first connect (client should retry after 401)
147 elsif username == "token"
148 User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
150 User.authenticate(:username => username, :password => passwd) # basic auth
154 # have we identified the user?
156 # check if the user has been banned
157 user_block = current_user.blocks.active.take
158 unless user_block.nil?
160 if user_block.zero_hour?
161 report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
163 report_error t("application.setup_user_auth.blocked"), :forbidden
167 # if the user hasn't seen the contributor terms then don't
168 # allow editing - they have to go to the web site and see
169 # (but can decline) the CTs to continue.
170 if REQUIRE_TERMS_SEEN && !current_user.terms_seen && flash[:skip_terms].nil?
172 report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
177 def authorize(realm = "Web Password", errormessage = "Couldn't authenticate you")
178 # make the current_user object from any auth sources we have
181 # handle authenticate pass/fail
183 # no auth, the user does not exist or the password was wrong
184 response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
185 render :plain => errormessage, :status => :unauthorized
191 # to be used as a before_filter *after* authorize. this checks that
192 # the user is a moderator and, if not, returns a forbidden error.
194 # NOTE: this isn't a very good way of doing it - it duplicates logic
195 # from require_moderator - but what we really need to do is a fairly
196 # drastic refactoring based on :format and respond_to? but not a
197 # good idea to do that in this branch.
198 def authorize_moderator(errormessage = "Access restricted to moderators")
199 # check user is a moderator
200 unless current_user.moderator?
201 render :plain => errormessage, :status => :forbidden
206 def check_database_readable(need_api = false)
207 if STATUS == :database_offline || (need_api && STATUS == :api_offline)
209 report_error "Database offline for maintenance", :service_unavailable
211 redirect_to :controller => "site", :action => "offline"
216 def check_database_writable(need_api = false)
217 if STATUS == :database_offline || STATUS == :database_readonly ||
218 (need_api && (STATUS == :api_offline || STATUS == :api_readonly))
220 report_error "Database offline for maintenance", :service_unavailable
222 redirect_to :controller => "site", :action => "offline"
227 def check_api_readable
228 if api_status == :offline
229 report_error "Database offline for maintenance", :service_unavailable
234 def check_api_writable
235 unless api_status == :online
236 report_error "Database offline for maintenance", :service_unavailable
242 if STATUS == :database_offline
244 elsif STATUS == :database_readonly
252 status = database_status
254 if STATUS == :api_offline
256 elsif STATUS == :api_readonly
264 status = database_status
265 status = :offline if status == :online && STATUS == :gpx_offline
269 def require_public_data
270 unless current_user.data_public?
271 report_error "You must make your edits public to upload new data", :forbidden
276 # Report and error to the user
277 # (If anyone ever fixes Rails so it can set a http status "reason phrase",
278 # rather than only a status code and having the web engine make up a
279 # phrase from that, we can also put the error message into the status
280 # message. For now, rails won't let us)
281 def report_error(message, status = :bad_request)
282 # TODO: some sort of escaping of problem characters in the message
283 response.headers["Error"] = message
285 if request.headers["X-Error-Format"] &&
286 request.headers["X-Error-Format"].casecmp("xml").zero?
287 result = OSM::API.new.get_xml_doc
288 result.root.name = "osmError"
289 result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
290 result.root << (XML::Node.new("message") << message)
292 render :xml => result.to_s
294 render :plain => message, :status => status
298 def preferred_languages
299 @preferred_languages ||= if params[:locale]
300 Locale.list(params[:locale])
302 current_user.preferred_languages
304 Locale.list(http_accept_language.user_preferred_languages)
308 helper_method :preferred_languages
311 if current_user && current_user.languages.empty? && !http_accept_language.user_preferred_languages.empty?
312 current_user.languages = http_accept_language.user_preferred_languages
316 I18n.locale = Locale.available.preferred(preferred_languages)
318 response.headers["Vary"] = "Accept-Language"
319 response.headers["Content-Language"] = I18n.locale.to_s
322 def api_call_handle_error
324 rescue ActiveRecord::RecordNotFound => ex
326 rescue LibXML::XML::Error, ArgumentError => ex
327 report_error ex.message, :bad_request
328 rescue ActiveRecord::RecordInvalid => ex
329 message = "#{ex.record.class} #{ex.record.id}: "
330 ex.record.errors.each { |attr, msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
331 report_error message, :bad_request
332 rescue OSM::APIError => ex
333 report_error ex.message, ex.status
334 rescue AbstractController::ActionNotFound => ex
336 rescue StandardError => ex
337 logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
338 ex.backtrace.each { |l| logger.info(l) }
339 report_error "#{ex.class}: #{ex.message}", :internal_server_error
343 # asserts that the request method is the +method+ given as a parameter
344 # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
345 def assert_method(method)
346 ok = request.send((method.to_s.downcase + "?").to_sym)
347 raise OSM::APIBadMethodError, method unless ok
351 # wrap an api call in a timeout
353 OSM::Timer.timeout(API_TIMEOUT, Timeout::Error) do
356 rescue Timeout::Error
357 raise OSM::APITimeoutError
361 # wrap a web page in a timeout
363 OSM::Timer.timeout(WEB_TIMEOUT, Timeout::Error) do
366 rescue ActionView::Template::Error => ex
369 if ex.is_a?(Timeout::Error) ||
370 (ex.is_a?(ActiveRecord::StatementInvalid) && ex.message =~ /execution expired/)
371 render :action => "timeout"
375 rescue Timeout::Error
376 render :action => "timeout"
380 # ensure that there is a "user" instance variable
382 render_unknown_user params[:display_name] unless @user = User.active.find_by(:display_name => params[:display_name])
386 # render a "no such user" page
387 def render_unknown_user(name)
388 @title = t "user.no_such_user.title"
389 @not_found_user = name
391 respond_to do |format|
392 format.html { render :template => "user/no_such_user", :status => :not_found }
393 format.all { head :not_found }
398 # Unfortunately if a PUT or POST request that has a body fails to
399 # read it then Apache will sometimes fail to return the response it
400 # is given to the client properly, instead erroring:
402 # https://issues.apache.org/bugzilla/show_bug.cgi?id=44782
404 # To work round this we call rewind on the body here, which is added
405 # as a filter, to force it to be fetched from Apache into a file.
411 append_content_security_policy_directives(
412 :child_src => %w[http://127.0.0.1:8111 https://127.0.0.1:8112],
413 :frame_src => %w[http://127.0.0.1:8111 https://127.0.0.1:8112],
414 :connect_src => %w[nominatim.openstreetmap.org overpass-api.de router.project-osrm.org],
415 :form_action => %w[render.openstreetmap.org],
416 :script_src => %w[graphhopper.com open.mapquestapi.com],
417 :img_src => %w[developer.mapquest.com]
420 if STATUS == :database_offline || STATUS == :api_offline
421 flash.now[:warning] = t("layouts.osm_offline")
422 elsif STATUS == :database_readonly || STATUS == :api_readonly
423 flash.now[:warning] = t("layouts.osm_read_only")
426 request.xhr? ? "xhr" : "map"
429 def allow_thirdparty_images
430 append_content_security_policy_directives(:img_src => %w[*])
434 editor = if params[:editor]
436 elsif current_user && current_user.preferred_editor
437 current_user.preferred_editor
445 helper_method :preferred_editor
448 if defined?(TOTP_KEY)
449 cookies["_osm_totp_token"] = {
450 :value => ROTP::TOTP.new(TOTP_KEY, :interval => 3600).now,
451 :domain => "openstreetmap.org",
452 :expires => 1.hour.from_now
459 # extract authorisation credentials from headers, returns user = nil if none
461 if request.env.key? "X-HTTP_AUTHORIZATION" # where mod_rewrite might have put it
462 authdata = request.env["X-HTTP_AUTHORIZATION"].to_s.split
463 elsif request.env.key? "REDIRECT_X_HTTP_AUTHORIZATION" # mod_fcgi
464 authdata = request.env["REDIRECT_X_HTTP_AUTHORIZATION"].to_s.split
465 elsif request.env.key? "HTTP_AUTHORIZATION" # regular location
466 authdata = request.env["HTTP_AUTHORIZATION"].to_s.split
468 # only basic authentication supported
469 user, pass = Base64.decode64(authdata[1]).split(":", 2) if authdata && authdata[0] == "Basic"
473 # override to stop oauth plugin sending errors
474 def invalid_oauth_response; end