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   after_action :close_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(skip_terms: false)
  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 && !skip_terms
  59         flash[:notice] = t "accounts.terms.show.you need to accept or decline"
  60         if params[:referer]
  61           redirect_to account_terms_path(:referer => params[:referer])
  62         else
  63           redirect_to account_terms_path(: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 && %w[api_offline api_readonly].include?(Settings.status))
 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     report_error "Database offline for maintenance", :service_unavailable if api_status == "offline"
 128   end
 129
 130   def check_api_writable
 131     report_error "Database offline for maintenance", :service_unavailable unless api_status == "online"
 132   end
 133
 134   def database_status
 135     case Settings.status
 136     when "database_offline"
 137       "offline"
 138     when "database_readonly"
 139       "readonly"
 140     else
 141       "online"
 142     end
 143   end
 144
 145   def api_status
 146     status = database_status
 147     if status == "online"
 148       case Settings.status
 149       when "api_offline"
 150         status = "offline"
 151       when "api_readonly"
 152         status = "readonly"
 153       end
 154     end
 155     status
 156   end
 157
 158   def require_public_data
 159     report_error "You must make your edits public to upload new data", :forbidden unless current_user.data_public?
 160   end
 161
 162   # Report and error to the user
 163   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
 164   #  rather than only a status code and having the web engine make up a
 165   #  phrase from that, we can also put the error message into the status
 166   #  message. For now, rails won't let us)
 167   def report_error(message, status = :bad_request)
 168     # TODO: some sort of escaping of problem characters in the message
 169     response.headers["Error"] = message
 170
 171     if request.headers["X-Error-Format"]&.casecmp?("xml")
 172       result = OSM::API.new.xml_doc
 173       result.root.name = "osmError"
 174       result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
 175       result.root << (XML::Node.new("message") << message)
 176
 177       render :xml => result.to_s
 178     else
 179       render :plain => message, :status => status
 180     end
 181   end
 182
 183   def preferred_languages
 184     @preferred_languages ||= if params[:locale]
 185                                Locale.list(params[:locale])
 186                              elsif current_user
 187                                current_user.preferred_languages
 188                              elsif request.cookies["_osm_locale"]
 189                                Locale.list(request.cookies["_osm_locale"])
 190                              else
 191                                Locale.list(http_accept_language.user_preferred_languages)
 192                              end
 193   end
 194
 195   helper_method :preferred_languages
 196
 197   def set_locale
 198     if current_user&.languages&.empty? && !http_accept_language.user_preferred_languages.empty?
 199       current_user.languages = http_accept_language.user_preferred_languages
 200       current_user.save
 201     end
 202
 203     I18n.locale = Locale.available.preferred(preferred_languages)
 204
 205     response.headers["Vary"] = "Accept-Language"
 206     response.headers["Content-Language"] = I18n.locale.to_s
 207   end
 208
 209   ##
 210   # wrap a web page in a timeout
 211   def web_timeout(&)
 212     raise Timeout::Error if Settings.web_timeout.negative?
 213
 214     Timeout.timeout(Settings.web_timeout, &)
 215   rescue ActionView::Template::Error => e
 216     e = e.cause
 217
 218     if e.is_a?(Timeout::Error) ||
 219        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
 220       respond_to_timeout
 221     else
 222       raise
 223     end
 224   rescue Timeout::Error
 225     respond_to_timeout
 226   end
 227
 228   def respond_to_timeout
 229     ActiveRecord::Base.connection.raw_connection.cancel
 230     render :action => "timeout", :status => :gateway_timeout
 231   end
 232
 233   ##
 234   # Unfortunately if a PUT or POST request that has a body fails to
 235   # read it then Apache will sometimes fail to return the response it
 236   # is given to the client properly, instead erroring:
 237   #
 238   #   https://issues.apache.org/bugzilla/show_bug.cgi?id=44782
 239   #
 240   # To work round this we call close on the body here, which is added
 241   # as a filter, to let Apache know we are done with it.
 242   def close_body
 243     request.body&.close
 244   end
 245
 246   def map_layout
 247     policy = request.content_security_policy.clone
 248
 249     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)
 250     policy.form_action(*policy.form_action, "render.openstreetmap.org")
 251     policy.style_src(*policy.style_src, :unsafe_inline)
 252
 253     request.content_security_policy = policy
 254
 255     flash.now[:warning] = { :partial => "layouts/offline_flash" } unless api_status == "online"
 256
 257     request.xhr? ? "xhr" : "map"
 258   end
 259
 260   def preferred_editor
 261     if params[:editor]
 262       params[:editor]
 263     elsif current_user&.preferred_editor
 264       current_user.preferred_editor
 265     else
 266       Settings.default_editor
 267     end
 268   end
 269
 270   def preferred_color_scheme(subject)
 271     if current_user
 272       current_user.preferences.find_by(:k => "#{subject}.color_scheme")&.v || "auto"
 273     else
 274       "auto"
 275     end
 276   end
 277
 278   helper_method :preferred_editor, :preferred_color_scheme
 279
 280   def update_totp
 281     if Settings.key?(:totp_key)
 282       cookies["_osm_totp_token"] = {
 283         :value => ROTP::TOTP.new(Settings.totp_key, :interval => 3600).now,
 284         :domain => "openstreetmap.org",
 285         :expires => 1.hour.from_now
 286       }
 287     end
 288   end
 289
 290   def current_ability
 291     Ability.new(current_user)
 292   end
 293
 294   def deny_access(_exception)
 295     if current_user
 296       set_locale
 297       respond_to do |format|
 298         format.html { redirect_to :controller => "/errors", :action => "forbidden" }
 299         format.any { report_error t("application.permission_denied"), :forbidden }
 300       end
 301     elsif request.get?
 302       respond_to do |format|
 303         format.html { redirect_to login_path(:referer => request.fullpath) }
 304         format.any { head :forbidden }
 305       end
 306     else
 307       head :forbidden
 308     end
 309   end
 310
 311   def invalid_parameter(_exception)
 312     if request.get?
 313       respond_to do |format|
 314         format.html { redirect_to :controller => "/errors", :action => "bad_request" }
 315         format.any { head :bad_request }
 316       end
 317     else
 318       head :bad_request
 319     end
 320   end
 321
 322   # clean any referer parameter
 323   def safe_referer(referer)
 324     begin
 325       referer = URI.parse(referer)
 326
 327       if %w[http https].include?(referer.scheme)
 328         referer.scheme = nil
 329         referer.host = nil
 330         referer.port = nil
 331       elsif referer.scheme || referer.host || referer.port
 332         referer = nil
 333       end
 334
 335       referer = nil if referer&.path&.first != "/"
 336     rescue URI::InvalidURIError
 337       referer = nil
 338     end
 339
 340     referer&.to_s
 341   end
 342 end