app/controllers/application_controller.rb

   1 # frozen_string_literal: true
   2
   3 class ApplicationController < ActionController::Base
   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", "appleid.apple.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 site_layout
  43     turbo_frame_request? ? "turbo_frame" : "site"
  44   end
  45
  46   def authorize_web(skip_terms: false)
  47     if session[:user]
  48       self.current_user = User.find_by(:id => session[:user], :status => %w[active confirmed suspended])
  49
  50       if session[:fingerprint] &&
  51          session[:fingerprint] != current_user.fingerprint
  52         reset_session
  53         self.current_user = nil
  54       elsif current_user.status == "suspended"
  55         session.delete(:user)
  56         session_expires_automatically
  57
  58         redirect_to :controller => "users", :action => "suspended"
  59
  60       # don't allow access to any auth-requiring part of the site unless
  61       # the new CTs have been seen (and accept/decline chosen).
  62       elsif !current_user.terms_seen && !skip_terms
  63         flash[:notice] = t "accounts.terms.show.you need to accept or decline"
  64         if params[:referer]
  65           redirect_to account_terms_path(:referer => params[:referer])
  66         else
  67           redirect_to account_terms_path(:referer => request.fullpath)
  68         end
  69       end
  70     end
  71
  72     session[:fingerprint] = current_user.fingerprint if current_user && session[:fingerprint].nil?
  73   rescue StandardError => e
  74     logger.info("Exception authorizing user: #{e}")
  75     reset_session
  76     self.current_user = nil
  77   end
  78
  79   def require_user
  80     unless current_user
  81       response.headers["Cache-Control"] = "private, no-store"
  82
  83       if request.get?
  84         redirect_to login_path(:referer => request.fullpath)
  85       else
  86         head :forbidden
  87       end
  88     end
  89   end
  90
  91   def require_oauth
  92     @oauth_token = current_user.oauth_token(Settings.oauth_application) if current_user && Settings.key?(:oauth_application)
  93   end
  94
  95   ##
  96   # require the user to have cookies enabled in their browser
  97   def require_cookies
  98     if request.cookies["_osm_session"].to_s == ""
  99       if params[:cookie_test].nil?
 100         session[:cookie_test] = true
 101         redirect_to params.to_unsafe_h.merge(:only_path => true, :cookie_test => "true")
 102         false
 103       else
 104         flash.now[:warning] = t "application.require_cookies.cookies_needed"
 105       end
 106     else
 107       session.delete(:cookie_test)
 108     end
 109   end
 110
 111   def check_database_readable(need_api: false)
 112     if Settings.status == "database_offline" || (need_api && Settings.status == "api_offline")
 113       if request.xhr?
 114         report_error "Database offline for maintenance", :service_unavailable
 115       else
 116         redirect_to :controller => "site", :action => "offline"
 117       end
 118     end
 119   end
 120
 121   def check_database_writable(need_api: false)
 122     if Settings.status == "database_offline" || Settings.status == "database_readonly" ||
 123        (need_api && %w[api_offline api_readonly].include?(Settings.status))
 124       if request.xhr?
 125         report_error "Database offline for maintenance", :service_unavailable
 126       else
 127         redirect_to :controller => "site", :action => "offline"
 128       end
 129     end
 130   end
 131
 132   def check_api_readable
 133     report_error "Database offline for maintenance", :service_unavailable if api_status == "offline"
 134   end
 135
 136   def check_api_writable
 137     report_error "Database offline for maintenance", :service_unavailable unless api_status == "online"
 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     report_error "You must make your edits public to upload new data", :forbidden unless current_user.data_public?
 166   end
 167
 168   # Report and error to the user
 169   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
 170   #  rather than only a status code and having the web engine make up a
 171   #  phrase from that, we can also put the error message into the status
 172   #  message. For now, rails won't let us)
 173   def report_error(message, status = :bad_request)
 174     # TODO: some sort of escaping of problem characters in the message
 175     response.headers["Error"] = message
 176
 177     if request.headers["X-Error-Format"]&.casecmp?("xml")
 178       result = OSM::API.new.xml_doc
 179       result.root.name = "osmError"
 180       result.root << (LibXML::XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
 181       result.root << (LibXML::XML::Node.new("message") << message)
 182
 183       render :xml => result.to_s
 184     else
 185       render :plain => message, :status => status
 186     end
 187   end
 188
 189   def preferred_languages
 190     @preferred_languages ||= if params[:locale]
 191                                Locale.list(params[:locale])
 192                              elsif current_user
 193                                current_user.preferred_languages
 194                              elsif request.cookies["_osm_locale"]
 195                                Locale.list(request.cookies["_osm_locale"])
 196                              else
 197                                Locale.list(http_accept_language.user_preferred_languages)
 198                              end
 199   end
 200
 201   helper_method :preferred_languages
 202
 203   def set_locale
 204     if current_user&.languages&.empty? && !http_accept_language.user_preferred_languages.empty?
 205       current_user.languages = http_accept_language.user_preferred_languages
 206       current_user.save
 207     end
 208
 209     I18n.locale = Locale.available.preferred(preferred_languages)
 210
 211     response.headers["Vary"] = "Accept-Language"
 212     response.headers["Content-Language"] = I18n.locale.to_s
 213   end
 214
 215   ##
 216   # wrap a web page in a timeout
 217   def web_timeout(&)
 218     raise Timeout::Error if Settings.web_timeout.negative?
 219
 220     Timeout.timeout(Settings.web_timeout, &)
 221   rescue ActionView::Template::Error => e
 222     e = e.cause
 223
 224     if e.is_a?(Timeout::Error) ||
 225        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
 226       respond_to_timeout
 227     else
 228       raise
 229     end
 230   rescue Timeout::Error
 231     respond_to_timeout
 232   end
 233
 234   def respond_to_timeout
 235     ActiveRecord::Base.connection.raw_connection.cancel
 236     render :action => "timeout", :status => :gateway_timeout
 237   end
 238
 239   ##
 240   # Unfortunately if a PUT or POST request that has a body fails to
 241   # read it then Apache will sometimes fail to return the response it
 242   # is given to the client properly, instead erroring:
 243   #
 244   #   https://issues.apache.org/bugzilla/show_bug.cgi?id=44782
 245   #
 246   # To work round this we call close on the body here, which is added
 247   # as a filter, to let Apache know we are done with it.
 248   def close_body
 249     request.body&.close
 250   end
 251
 252   def map_layout
 253     policy = request.content_security_policy.clone
 254     policy.connect_src(*policy.connect_src, "http://127.0.0.1:8111", "https://vector.openstreetmap.org", "https://api.maptiler.com",
 255                        "https://tile.thunderforest.com", "https://render.openstreetmap.org", Settings.nominatim_url, Settings.overpass_url,
 256                        Settings.fossgis_osrm_url, Settings.graphhopper_url, Settings.fossgis_valhalla_url, Settings.wikidata_api_url)
 257     policy.form_action(*policy.form_action, "render.openstreetmap.org", "tile.thunderforest.com")
 258     policy.img_src(*policy.img_src, Settings.wikimedia_commons_url, "upload.wikimedia.org")
 259     policy.script_src(*policy.script_src, :wasm_unsafe_eval)
 260     policy.style_src(*policy.style_src, :unsafe_inline)
 261
 262     request.content_security_policy = policy
 263
 264     flash.now[:warning] = { :partial => "layouts/offline_flash" } unless api_status == "online"
 265
 266     request.xhr? ? "xhr" : "map"
 267   end
 268
 269   def preferred_editor
 270     if params[:editor]
 271       params[:editor]
 272     elsif current_user&.preferred_editor
 273       current_user.preferred_editor
 274     else
 275       Settings.default_editor
 276     end
 277   end
 278
 279   helper_method :preferred_editor
 280
 281   def update_totp
 282     if Settings.key?(:totp_key)
 283       cookies["_osm_totp_token"] = {
 284         :value => ROTP::TOTP.new(Settings.totp_key, :interval => 3600).now,
 285         :domain => "openstreetmap.org",
 286         :expires => 1.hour.from_now
 287       }
 288     end
 289   end
 290
 291   def current_ability
 292     Ability.new(current_user)
 293   end
 294
 295   def deny_access(_exception)
 296     if current_user
 297       set_locale
 298       respond_to do |format|
 299         format.html { redirect_to :controller => "/errors", :action => "forbidden" }
 300         format.any { report_error t("application.permission_denied"), :forbidden }
 301       end
 302     elsif request.get?
 303       respond_to do |format|
 304         format.html { redirect_to login_path(:referer => request.fullpath) }
 305         format.any { head :forbidden }
 306       end
 307     else
 308       head :forbidden
 309     end
 310   end
 311
 312   def invalid_parameter(_exception)
 313     if request.get?
 314       respond_to do |format|
 315         format.html { redirect_to :controller => "/errors", :action => "bad_request" }
 316         format.any { head :bad_request }
 317       end
 318     else
 319       head :bad_request
 320     end
 321   end
 322
 323   # clean any referer parameter
 324   def safe_referer(referer)
 325     begin
 326       referer = URI.parse(referer)
 327
 328       if %w[http https].include?(referer.scheme)
 329         referer.scheme = nil
 330         referer.host = nil
 331         referer.port = nil
 332       elsif referer.scheme || referer.host || referer.port
 333         referer = nil
 334       end
 335
 336       referer = nil if referer&.path&.first != "/"
 337     rescue URI::InvalidURIError
 338       referer = nil
 339     end
 340
 341     referer&.to_s
 342   end
 343 end