X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/52611a5bfa69165179bd871b925b5f8b14942e2e..673b58f96f3acfd0281c62a2a7f080825b6fb28b:/app/controllers/application_controller.rb

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 067fc6a51..a24df48e0 100644
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -1,33 +1,27 @@
 class ApplicationController < ActionController::Base
   include SessionPersistence
 
-  protect_from_forgery
+  protect_from_forgery :with => :exception
 
-  before_filter :fetch_body
+  before_action :fetch_body
 
-  if STATUS == :database_readonly or STATUS == :database_offline
-    def self.cache_sweeper(*sweepers)
-    end
-  end
+  attr_accessor :current_user
+  helper_method :current_user
 
   def authorize_web
     if session[:user]
-      @user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
+      self.current_user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
 
-      if @user.display_name != cookies["_osm_username"]
-        logger.info "Session user '#{@user.display_name}' does not match cookie user '#{cookies['_osm_username']}'"
-        reset_session
-        @user = nil
-      elsif @user.status == "suspended"
+      if current_user.status == "suspended"
         session.delete(:user)
         session_expires_automatically
 
         redirect_to :controller => "user", :action => "suspended"
 
-        # don't allow access to any auth-requiring part of the site unless
-        # the new CTs have been seen (and accept/decline chosen).
-      elsif !@user.terms_seen and flash[:skip_terms].nil?
-        flash[:notice] = t 'user.terms.you need to accept or decline'
+      # don't allow access to any auth-requiring part of the site unless
+      # the new CTs have been seen (and accept/decline chosen).
+      elsif !current_user.terms_seen && flash[:skip_terms].nil?
+        flash[:notice] = t "user.terms.you need to accept or decline"
         if params[:referer]
           redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
         else
@@ -35,33 +29,31 @@ class ApplicationController < ActionController::Base
         end
       end
     elsif session[:token]
-      if @user = User.authenticate(:token => session[:token])
-        session[:user] = @user.id
-      end
+      session[:user] = current_user.id if self.current_user = User.authenticate(:token => session[:token])
     end
-  rescue Exception => ex
-    logger.info("Exception authorizing user: #{ex.to_s}")
+  rescue StandardError => ex
+    logger.info("Exception authorizing user: #{ex}")
     reset_session
-    @user = nil
+    self.current_user = nil
   end
 
   def require_user
-    unless @user
+    unless current_user
       if request.get?
-        redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
+        redirect_to :controller => "user", :action => "login", :referer => request.fullpath
       else
-        render :nothing => true, :status => :forbidden
+        head :forbidden
       end
     end
   end
 
   def require_oauth
-    @oauth = @user.access_token(OAUTH_KEY) if @user and defined? OAUTH_KEY
+    @oauth = current_user.access_token(OAUTH_KEY) if current_user && defined? OAUTH_KEY
   end
 
   ##
-  # requires the user to be logged in by the token or HTTP methods, or have an 
-  # OAuth token with the right capability. this method is a bit of a pain to call 
+  # requires the user to be logged in by the token or HTTP methods, or have an
+  # OAuth token with the right capability. this method is a bit of a pain to call
   # directly, since it's cumbersome to call filters with arguments in rails. to
   # make it easier to read and write the code, there are some utility methods
   # below.
@@ -70,8 +62,9 @@ class ApplicationController < ActionController::Base
     # method, otherwise an OAuth token was used, which has to be checked.
     unless current_token.nil?
       unless current_token.read_attribute(cap)
-        report_error "OAuth token doesn't have that capability.", :forbidden
-        return false
+        set_locale
+        report_error t("oauth.permissions.missing"), :forbidden
+        false
       end
     end
   end
@@ -82,10 +75,10 @@ class ApplicationController < ActionController::Base
     if request.cookies["_osm_session"].to_s == ""
       if params[:cookie_test].nil?
         session[:cookie_test] = true
-        redirect_to params.merge(:cookie_test => "true")
-        return false
+        redirect_to params.to_unsafe_h.merge(:cookie_test => "true")
+        false
       else
-        flash.now[:warning] = t 'application.require_cookies.cookies_needed'
+        flash.now[:warning] = t "application.require_cookies.cookies_needed"
       end
     else
       session.delete(:cookie_test)
@@ -96,26 +89,32 @@ class ApplicationController < ActionController::Base
   def require_allow_read_prefs
     require_capability(:allow_read_prefs)
   end
+
   def require_allow_write_prefs
     require_capability(:allow_write_prefs)
   end
+
   def require_allow_write_diary
     require_capability(:allow_write_diary)
   end
+
   def require_allow_write_api
     require_capability(:allow_write_api)
 
-    if REQUIRE_TERMS_AGREED and @user.terms_agreed.nil?
+    if REQUIRE_TERMS_AGREED && current_user.terms_agreed.nil?
       report_error "You must accept the contributor terms before you can edit.", :forbidden
       return false
     end
   end
+
   def require_allow_read_gpx
     require_capability(:allow_read_gpx)
   end
+
   def require_allow_write_gpx
     require_capability(:allow_write_gpx)
   end
+
   def require_allow_write_notes
     require_capability(:allow_write_notes)
   end
@@ -124,64 +123,69 @@ class ApplicationController < ActionController::Base
   # require that the user is a moderator, or fill out a helpful error message
   # and return them to the index for the controller this is wrapped from.
   def require_moderator
-    unless @user.moderator?
+    unless current_user.moderator?
       if request.get?
-        flash[:error] = t('application.require_moderator.not_a_moderator')
-        redirect_to :action => 'index'
+        flash[:error] = t("application.require_moderator.not_a_moderator")
+        redirect_to :action => "index"
       else
-        render :nothing => true, :status => :forbidden
+        head :forbidden
       end
     end
   end
 
   ##
-  # sets up the @user object for use by other methods. this is mostly called
+  # sets up the current_user for use by other methods. this is mostly called
   # from the authorize method, but can be called elsewhere if authorisation
   # is optional.
   def setup_user_auth
     # try and setup using OAuth
-    if not Authenticator.new(self, [:token]).allow?
+    unless Authenticator.new(self, [:token]).allow?
       username, passwd = get_auth_data # parse from headers
       # authenticate per-scheme
-      if username.nil?
-        @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
-      elsif username == 'token'
-        @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
-      else
-        @user = User.authenticate(:username => username, :password => passwd) # basic auth
-      end
+      self.current_user = if username.nil?
+                            nil # no authentication provided - perhaps first connect (client should retry after 401)
+                          elsif username == "token"
+                            User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
+                          else
+                            User.authenticate(:username => username, :password => passwd) # basic auth
+                          end
     end
 
     # have we identified the user?
-    if @user
+    if current_user
       # check if the user has been banned
-      if @user.blocks.active.exists?
-        # NOTE: need slightly more helpful message than this.
-        report_error t('application.setup_user_auth.blocked'), :forbidden
+      user_block = current_user.blocks.active.take
+      unless user_block.nil?
+        set_locale
+        if user_block.zero_hour?
+          report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
+        else
+          report_error t("application.setup_user_auth.blocked"), :forbidden
+        end
       end
 
       # if the user hasn't seen the contributor terms then don't
       # allow editing - they have to go to the web site and see
       # (but can decline) the CTs to continue.
-      if REQUIRE_TERMS_SEEN and not @user.terms_seen and flash[:skip_terms].nil?
+      if REQUIRE_TERMS_SEEN && !current_user.terms_seen && flash[:skip_terms].nil?
         set_locale
-        report_error t('application.setup_user_auth.need_to_see_terms'), :forbidden
+        report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
       end
     end
   end
 
-  def authorize(realm='Web Password', errormessage="Couldn't authenticate you") 
+  def authorize(realm = "Web Password", errormessage = "Couldn't authenticate you")
     # make the @user object from any auth sources we have
     setup_user_auth
 
     # handle authenticate pass/fail
-    unless @user
+    unless current_user
       # no auth, the user does not exist or the password was wrong
-      response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" 
-      render :text => errormessage, :status => :unauthorized
+      response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
+      render :plain => errormessage, :status => :unauthorized
       return false
-    end 
-  end 
+    end
+  end
 
   ##
   # to be used as a before_filter *after* authorize. this checks that
@@ -189,40 +193,48 @@ class ApplicationController < ActionController::Base
   #
   # NOTE: this isn't a very good way of doing it - it duplicates logic
   # from require_moderator - but what we really need to do is a fairly
-  # drastic refactoring based on :format and respond_to? but not a 
+  # drastic refactoring based on :format and respond_to? but not a
   # good idea to do that in this branch.
-  def authorize_moderator(errormessage="Access restricted to moderators") 
+  def authorize_moderator(errormessage = "Access restricted to moderators")
     # check user is a moderator
-    unless @user.moderator?
-      render :text => errormessage, :status => :forbidden
-      return false
-    end 
-  end 
+    unless current_user.moderator?
+      render :plain => errormessage, :status => :forbidden
+      false
+    end
+  end
 
   def check_database_readable(need_api = false)
-    if STATUS == :database_offline or (need_api and STATUS == :api_offline)
-      redirect_to :controller => 'site', :action => 'offline'
+    if STATUS == :database_offline || (need_api && STATUS == :api_offline)
+      if request.xhr?
+        report_error "Database offline for maintenance", :service_unavailable
+      else
+        redirect_to :controller => "site", :action => "offline"
+      end
     end
   end
 
   def check_database_writable(need_api = false)
-    if STATUS == :database_offline or STATUS == :database_readonly or
-       (need_api and (STATUS == :api_offline or STATUS == :api_readonly))
-      redirect_to :controller => 'site', :action => 'offline'
+    if STATUS == :database_offline || STATUS == :database_readonly ||
+       (need_api && (STATUS == :api_offline || STATUS == :api_readonly))
+      if request.xhr?
+        report_error "Database offline for maintenance", :service_unavailable
+      else
+        redirect_to :controller => "site", :action => "offline"
+      end
     end
   end
 
   def check_api_readable
     if api_status == :offline
       report_error "Database offline for maintenance", :service_unavailable
-      return false
+      false
     end
   end
 
   def check_api_writable
     unless api_status == :online
       report_error "Database offline for maintenance", :service_unavailable
-      return false
+      false
     end
   end
 
@@ -231,7 +243,7 @@ class ApplicationController < ActionController::Base
       :offline
     elsif STATUS == :database_readonly
       :readonly
-    else 
+    else
       :online
     end
   end
@@ -245,102 +257,86 @@ class ApplicationController < ActionController::Base
         status = :readonly
       end
     end
-    return status
+    status
   end
 
   def gpx_status
     status = database_status
-    if status == :online
-      status = :offline if STATUS == :gpx_offline
-    end
-    return status
+    status = :offline if status == :online && STATUS == :gpx_offline
+    status
   end
 
   def require_public_data
-    unless @user.data_public?
+    unless current_user.data_public?
       report_error "You must make your edits public to upload new data", :forbidden
-      return false
+      false
     end
   end
 
   # Report and error to the user
   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
-  #  rather than only a status code and having the web engine make up a 
+  #  rather than only a status code and having the web engine make up a
   #  phrase from that, we can also put the error message into the status
   #  message. For now, rails won't let us)
   def report_error(message, status = :bad_request)
-    # Todo: some sort of escaping of problem characters in the message
-    response.headers['Error'] = message
+    # TODO: some sort of escaping of problem characters in the message
+    response.headers["Error"] = message
 
-    if request.headers['X-Error-Format'] and
-       request.headers['X-Error-Format'].downcase == "xml"
+    if request.headers["X-Error-Format"] &&
+       request.headers["X-Error-Format"].casecmp("xml").zero?
       result = OSM::API.new.get_xml_doc
       result.root.name = "osmError"
       result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
       result.root << (XML::Node.new("message") << message)
 
-      render :text => result.to_s, :content_type => "text/xml"
+      render :xml => result.to_s
     else
-      render :text => message, :status => status
+      render :plain => message, :status => status
     end
   end
-  
-  def set_locale
-    response.header['Vary'] = 'Accept-Language'
-
-    if @user
-      if !@user.languages.empty?
-        request.user_preferred_languages = @user.languages
-        response.header['Vary'] = '*'
-      elsif !request.user_preferred_languages.empty?
-        @user.languages = request.user_preferred_languages
-        @user.save
-      end
-    end
 
-    if request.compatible_language_from(I18n.available_locales).nil?
-      request.user_preferred_languages = request.user_preferred_languages.collect do |pl|
-        pls = [ pl ]
-
-        while pl.match(/^(.*)-[^-]+$/)
-          pls.push($1) if I18n.available_locales.include?($1.to_sym)
-          pl = $1
-        end
+  def preferred_languages
+    @languages ||= if params[:locale]
+                     Locale.list(params[:locale])
+                   elsif current_user
+                     current_user.preferred_languages
+                   else
+                     Locale.list(http_accept_language.user_preferred_languages)
+                   end
+  end
 
-        pls
-      end.flatten
+  helper_method :preferred_languages
 
-      if @user and not request.compatible_language_from(I18n.available_locales).nil?
-        @user.languages = request.user_preferred_languages
-        @user.save        
-      end
+  def set_locale
+    if current_user && current_user.languages.empty? && !http_accept_language.user_preferred_languages.empty?
+      current_user.languages = http_accept_language.user_preferred_languages
+      current_user.save
     end
 
-    I18n.locale = params[:locale] || request.compatible_language_from(I18n.available_locales) || I18n.default_locale
+    I18n.locale = Locale.available.preferred(preferred_languages)
 
-    response.headers['Content-Language'] = I18n.locale.to_s
+    response.headers["Vary"] = "Accept-Language"
+    response.headers["Content-Language"] = I18n.locale.to_s
   end
 
   def api_call_handle_error
-    begin
-      yield
-    rescue ActiveRecord::RecordNotFound => ex
-      render :nothing => true, :status => :not_found
-    rescue LibXML::XML::Error, ArgumentError => ex
-      report_error ex.message, :bad_request
-    rescue ActiveRecord::RecordInvalid => ex
-      message = "#{ex.record.class} #{ex.record.id}: "
-      ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
-      report_error message, :bad_request
-    rescue OSM::APIError => ex
-      report_error ex.message, ex.status
-    rescue AbstractController::ActionNotFound => ex
-      raise
-    rescue Exception => ex
-      logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
-      ex.backtrace.each { |l| logger.info(l) }
-      report_error "#{ex.class}: #{ex.message}", :internal_server_error
-    end
+    yield
+  rescue ActiveRecord::RecordNotFound => ex
+    head :not_found
+  rescue LibXML::XML::Error, ArgumentError => ex
+    report_error ex.message, :bad_request
+  rescue ActiveRecord::RecordInvalid => ex
+    message = "#{ex.record.class} #{ex.record.id}: "
+    ex.record.errors.each { |attr, msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
+    report_error message, :bad_request
+  rescue OSM::APIError => ex
+    report_error ex.message, ex.status
+  rescue AbstractController::ActionNotFound => ex
+    raise
+  rescue StandardError => ex
+    logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
+    ex.backtrace.each { |l| logger.info(l) }
+    report_error "#{ex.class}: #{ex.message}", :internal_server_error
   end
 
   ##
@@ -348,13 +344,13 @@ class ApplicationController < ActionController::Base
   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
   def assert_method(method)
     ok = request.send((method.to_s.downcase + "?").to_sym)
-    raise OSM::APIBadMethodError.new(method) unless ok
+    raise OSM::APIBadMethodError, method unless ok
   end
 
   ##
   # wrap an api call in a timeout
   def api_call_timeout
-    OSM::Timer.timeout(API_TIMEOUT) do
+    OSM::Timer.timeout(API_TIMEOUT, Timeout::Error) do
       yield
     end
   rescue Timeout::Error
@@ -364,17 +360,14 @@ class ApplicationController < ActionController::Base
   ##
   # wrap a web page in a timeout
   def web_timeout
-    OSM::Timer.timeout(WEB_TIMEOUT) do
+    OSM::Timer.timeout(WEB_TIMEOUT, Timeout::Error) do
       yield
     end
   rescue ActionView::Template::Error => ex
-    ex = ex.original_exception
+    ex = ex.cause
 
-    if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /^Timeout::Error/
-      ex = Timeout::Error.new
-    end
-
-    if ex.is_a?(Timeout::Error)
+    if ex.is_a?(Timeout::Error) ||
+       (ex.is_a?(ActiveRecord::StatementInvalid) && ex.message =~ /execution expired/)
       render :action => "timeout"
     else
       raise
@@ -383,52 +376,10 @@ class ApplicationController < ActionController::Base
     render :action => "timeout"
   end
 
-  ##
-  # extend caches_action to include the parameters, locale and logged in
-  # status in all cache keys
-  def self.caches_action(*actions)
-    options = actions.extract_options!
-    cache_path = options[:cache_path] || Hash.new
-
-    options[:unless] = case options[:unless]
-                       when NilClass then Array.new
-                       when Array then options[:unless]
-                       else unlessp = [ options[:unless] ]
-                       end
-
-    options[:unless].push(Proc.new do |controller|
-      controller.params.include?(:page)
-    end)
-
-    options[:cache_path] = Proc.new do |controller|
-      cache_path.merge(controller.params).merge(:host => SERVER_URL, :locale => I18n.locale)
-    end
-
-    actions.push(options)
-
-    super *actions
-  end
-
-  ##
-  # extend expire_action to expire all variants
-  def expire_action(options = {})
-    I18n.available_locales.each do |locale|
-      super options.merge(:host => SERVER_URL, :locale => locale)
-    end
-  end
-
-  ##
-  # is the requestor logged in?
-  def logged_in?
-    !@user.nil?
-  end
-
   ##
   # ensure that there is a "this_user" instance variable
   def lookup_this_user
-    unless @this_user = User.active.find_by_display_name(params[:display_name])
-      render_unknown_user params[:display_name]
-    end
+    render_unknown_user params[:display_name] unless @this_user = User.active.find_by(:display_name => params[:display_name])
   end
 
   ##
@@ -439,7 +390,7 @@ class ApplicationController < ActionController::Base
 
     respond_to do |format|
       format.html { render :template => "user/no_such_user", :status => :not_found }
-      format.all { render :nothing => true, :status => :not_found }
+      format.all { head :not_found }
     end
   end
 
@@ -456,36 +407,68 @@ class ApplicationController < ActionController::Base
     request.body.rewind
   end
 
-private 
+  def map_layout
+    append_content_security_policy_directives(
+      :child_src => %w[127.0.0.1:8111],
+      :connect_src => %w[nominatim.openstreetmap.org overpass-api.de router.project-osrm.org],
+      :form_action => %w[render.openstreetmap.org],
+      :script_src => %w[graphhopper.com open.mapquestapi.com],
+      :img_src => %w[developer.mapquest.com]
+    )
 
-  # extract authorisation credentials from headers, returns user = nil if none
-  def get_auth_data 
-    if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 
-      authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split 
-    elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi 
-      authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split 
-    elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
-      authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
-    end 
-    # only basic authentication supported
-    if authdata and authdata[0] == 'Basic' 
-      user, pass = Base64.decode64(authdata[1]).split(':',2)
-    end 
-    return [user, pass] 
-  end 
+    if STATUS == :database_offline || STATUS == :api_offline
+      flash.now[:warning] = t("layouts.osm_offline")
+    elsif STATUS == :database_readonly || STATUS == :api_readonly
+      flash.now[:warning] = t("layouts.osm_read_only")
+    end
 
-  # used by oauth plugin to get the current user
-  def current_user
-    @user
+    request.xhr? ? "xhr" : "map"
   end
 
-  # used by oauth plugin to set the current user
-  def current_user=(user)
-    @user=user
+  def allow_thirdparty_images
+    append_content_security_policy_directives(:img_src => %w[*])
   end
 
-  # override to stop oauth plugin sending errors
-  def invalid_oauth_response
+  def preferred_editor
+    editor = if params[:editor]
+               params[:editor]
+             elsif current_user && current_user.preferred_editor
+               current_user.preferred_editor
+             else
+               DEFAULT_EDITOR
+             end
+
+    editor
+  end
+
+  helper_method :preferred_editor
+
+  def update_totp
+    if defined?(TOTP_KEY)
+      cookies["_osm_totp_token"] = {
+        :value => ROTP::TOTP.new(TOTP_KEY, :interval => 3600).now,
+        :domain => "openstreetmap.org",
+        :expires => 1.hour.from_now
+      }
+    end
   end
 
+  private
+
+  # extract authorisation credentials from headers, returns user = nil if none
+  def get_auth_data
+    if request.env.key? "X-HTTP_AUTHORIZATION" # where mod_rewrite might have put it
+      authdata = request.env["X-HTTP_AUTHORIZATION"].to_s.split
+    elsif request.env.key? "REDIRECT_X_HTTP_AUTHORIZATION" # mod_fcgi
+      authdata = request.env["REDIRECT_X_HTTP_AUTHORIZATION"].to_s.split
+    elsif request.env.key? "HTTP_AUTHORIZATION" # regular location
+      authdata = request.env["HTTP_AUTHORIZATION"].to_s.split
+    end
+    # only basic authentication supported
+    user, pass = Base64.decode64(authdata[1]).split(":", 2) if authdata && authdata[0] == "Basic"
+    [user, pass]
+  end
+
+  # override to stop oauth plugin sending errors
+  def invalid_oauth_response; end
 end