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   before_action :fetch_body
  14   around_action :better_errors_allow_inline, :if => proc { Rails.env.development? }
  15
  16   attr_accessor :current_user, :oauth_token
  17
  18   helper_method :current_user
  19   helper_method :oauth_token
  20
  21   private
  22
  23   def authorize_web
  24     if session[:user]
  25       self.current_user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
  26
  27       if session[:fingerprint] &&
  28          session[:fingerprint] != current_user.fingerprint
  29         reset_session
  30         self.current_user = nil
  31       elsif current_user.status == "suspended"
  32         session.delete(:user)
  33         session_expires_automatically
  34
  35         redirect_to :controller => "users", :action => "suspended"
  36
  37       # don't allow access to any auth-requiring part of the site unless
  38       # the new CTs have been seen (and accept/decline chosen).
  39       elsif !current_user.terms_seen && flash[:skip_terms].nil?
  40         flash[:notice] = t "users.terms.you need to accept or decline"
  41         if params[:referer]
  42           redirect_to :controller => "users", :action => "terms", :referer => params[:referer]
  43         else
  44           redirect_to :controller => "users", :action => "terms", :referer => request.fullpath
  45         end
  46       end
  47     elsif session[:token]
  48       session[:user] = current_user.id if self.current_user = User.authenticate(:token => session[:token])
  49     end
  50
  51     session[:fingerprint] = current_user.fingerprint if current_user && session[:fingerprint].nil?
  52   rescue StandardError => e
  53     logger.info("Exception authorizing user: #{e}")
  54     reset_session
  55     self.current_user = nil
  56   end
  57
  58   def require_user
  59     unless current_user
  60       if request.get?
  61         redirect_to login_path(:referer => request.fullpath)
  62       else
  63         head :forbidden
  64       end
  65     end
  66   end
  67
  68   def require_oauth
  69     @oauth_token = current_user.oauth_token(Settings.oauth_application) if current_user && Settings.key?(:oauth_application)
  70   end
  71
  72   ##
  73   # require the user to have cookies enabled in their browser
  74   def require_cookies
  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(:only_path => true, :cookie_test => "true")
  79         false
  80       else
  81         flash.now[:warning] = t "application.require_cookies.cookies_needed"
  82       end
  83     else
  84       session.delete(:cookie_test)
  85     end
  86   end
  87
  88   def check_database_readable(need_api: false)
  89     if Settings.status == "database_offline" || (need_api && Settings.status == "api_offline")
  90       if request.xhr?
  91         report_error "Database offline for maintenance", :service_unavailable
  92       else
  93         redirect_to :controller => "site", :action => "offline"
  94       end
  95     end
  96   end
  97
  98   def check_database_writable(need_api: false)
  99     if Settings.status == "database_offline" || Settings.status == "database_readonly" ||
 100        (need_api && (Settings.status == "api_offline" || Settings.status == "api_readonly"))
 101       if request.xhr?
 102         report_error "Database offline for maintenance", :service_unavailable
 103       else
 104         redirect_to :controller => "site", :action => "offline"
 105       end
 106     end
 107   end
 108
 109   def check_api_readable
 110     if api_status == "offline"
 111       report_error "Database offline for maintenance", :service_unavailable
 112       false
 113     end
 114   end
 115
 116   def check_api_writable
 117     unless api_status == "online"
 118       report_error "Database offline for maintenance", :service_unavailable
 119       false
 120     end
 121   end
 122
 123   def database_status
 124     case Settings.status
 125     when "database_offline"
 126       "offline"
 127     when "database_readonly"
 128       "readonly"
 129     else
 130       "online"
 131     end
 132   end
 133
 134   def api_status
 135     status = database_status
 136     if status == "online"
 137       case Settings.status
 138       when "api_offline"
 139         status = "offline"
 140       when "api_readonly"
 141         status = "readonly"
 142       end
 143     end
 144     status
 145   end
 146
 147   def require_public_data
 148     unless current_user.data_public?
 149       report_error "You must make your edits public to upload new data", :forbidden
 150       false
 151     end
 152   end
 153
 154   # Report and error to the user
 155   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
 156   #  rather than only a status code and having the web engine make up a
 157   #  phrase from that, we can also put the error message into the status
 158   #  message. For now, rails won't let us)
 159   def report_error(message, status = :bad_request)
 160     # TODO: some sort of escaping of problem characters in the message
 161     response.headers["Error"] = message
 162
 163     if request.headers["X-Error-Format"]&.casecmp("xml")&.zero?
 164       result = OSM::API.new.xml_doc
 165       result.root.name = "osmError"
 166       result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
 167       result.root << (XML::Node.new("message") << message)
 168
 169       render :xml => result.to_s
 170     else
 171       render :plain => message, :status => status
 172     end
 173   end
 174
 175   def preferred_languages
 176     @preferred_languages ||= if params[:locale]
 177                                Locale.list(params[:locale])
 178                              elsif current_user
 179                                current_user.preferred_languages
 180                              else
 181                                Locale.list(http_accept_language.user_preferred_languages)
 182                              end
 183   end
 184
 185   helper_method :preferred_languages
 186
 187   def set_locale
 188     if current_user&.languages&.empty? && !http_accept_language.user_preferred_languages.empty?
 189       current_user.languages = http_accept_language.user_preferred_languages
 190       current_user.save
 191     end
 192
 193     I18n.locale = Locale.available.preferred(preferred_languages)
 194
 195     response.headers["Vary"] = "Accept-Language"
 196     response.headers["Content-Language"] = I18n.locale.to_s
 197   end
 198
 199   def api_call_handle_error
 200     yield
 201   rescue ActionController::UnknownFormat
 202     head :not_acceptable
 203   rescue ActiveRecord::RecordNotFound => e
 204     head :not_found
 205   rescue LibXML::XML::Error, ArgumentError => e
 206     report_error e.message, :bad_request
 207   rescue ActiveRecord::RecordInvalid => e
 208     message = "#{e.record.class} #{e.record.id}: "
 209     e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
 210     report_error message, :bad_request
 211   rescue OSM::APIError => e
 212     report_error e.message, e.status
 213   rescue AbstractController::ActionNotFound => e
 214     raise
 215   rescue StandardError => e
 216     logger.info("API threw unexpected #{e.class} exception: #{e.message}")
 217     e.backtrace.each { |l| logger.info(l) }
 218     report_error "#{e.class}: #{e.message}", :internal_server_error
 219   end
 220
 221   ##
 222   # asserts that the request method is the +method+ given as a parameter
 223   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
 224   def assert_method(method)
 225     ok = request.send(:"#{method.to_s.downcase}?")
 226     raise OSM::APIBadMethodError, method unless ok
 227   end
 228
 229   ##
 230   # wrap an api call in a timeout
 231   def api_call_timeout(&block)
 232     Timeout.timeout(Settings.api_timeout, Timeout::Error, &block)
 233   rescue Timeout::Error
 234     ActiveRecord::Base.connection.raw_connection.cancel
 235     raise OSM::APITimeoutError
 236   end
 237
 238   ##
 239   # wrap a web page in a timeout
 240   def web_timeout(&block)
 241     Timeout.timeout(Settings.web_timeout, Timeout::Error, &block)
 242   rescue ActionView::Template::Error => e
 243     e = e.cause
 244
 245     if e.is_a?(Timeout::Error) ||
 246        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
 247       ActiveRecord::Base.connection.raw_connection.cancel
 248       render :action => "timeout"
 249     else
 250       raise
 251     end
 252   rescue Timeout::Error
 253     ActiveRecord::Base.connection.raw_connection.cancel
 254     render :action => "timeout"
 255   end
 256
 257   ##
 258   # ensure that there is a "user" instance variable
 259   def lookup_user
 260     render_unknown_user params[:display_name] unless @user = User.active.find_by(:display_name => params[:display_name])
 261   end
 262
 263   ##
 264   # render a "no such user" page
 265   def render_unknown_user(name)
 266     @title = t "users.no_such_user.title"
 267     @not_found_user = name
 268
 269     respond_to do |format|
 270       format.html { render :template => "users/no_such_user", :status => :not_found }
 271       format.all { head :not_found }
 272     end
 273   end
 274
 275   ##
 276   # Unfortunately if a PUT or POST request that has a body fails to
 277   # read it then Apache will sometimes fail to return the response it
 278   # is given to the client properly, instead erroring:
 279   #
 280   #   https://issues.apache.org/bugzilla/show_bug.cgi?id=44782
 281   #
 282   # To work round this we call rewind on the body here, which is added
 283   # as a filter, to force it to be fetched from Apache into a file.
 284   def fetch_body
 285     request.body.rewind
 286   end
 287
 288   def map_layout
 289     append_content_security_policy_directives(
 290       :child_src => %w[http://127.0.0.1:8111 https://127.0.0.1:8112],
 291       :frame_src => %w[http://127.0.0.1:8111 https://127.0.0.1:8112],
 292       :connect_src => [Settings.nominatim_url, Settings.overpass_url, Settings.fossgis_osrm_url, Settings.graphhopper_url],
 293       :form_action => %w[render.openstreetmap.org],
 294       :style_src => %w['unsafe-inline']
 295     )
 296
 297     case Settings.status
 298     when "database_offline", "api_offline"
 299       flash.now[:warning] = t("layouts.osm_offline")
 300     when "database_readonly", "api_readonly"
 301       flash.now[:warning] = t("layouts.osm_read_only")
 302     end
 303
 304     request.xhr? ? "xhr" : "map"
 305   end
 306
 307   def allow_thirdparty_images
 308     append_content_security_policy_directives(:img_src => %w[*])
 309   end
 310
 311   def preferred_editor
 312     if params[:editor]
 313       params[:editor]
 314     elsif current_user&.preferred_editor
 315       current_user.preferred_editor
 316     else
 317       Settings.default_editor
 318     end
 319   end
 320
 321   helper_method :preferred_editor
 322
 323   def update_totp
 324     if Settings.key?(:totp_key)
 325       cookies["_osm_totp_token"] = {
 326         :value => ROTP::TOTP.new(Settings.totp_key, :interval => 3600).now,
 327         :domain => "openstreetmap.org",
 328         :expires => 1.hour.from_now
 329       }
 330     end
 331   end
 332
 333   def better_errors_allow_inline
 334     yield
 335   rescue StandardError
 336     append_content_security_policy_directives(
 337       :script_src => %w['unsafe-inline'],
 338       :style_src => %w['unsafe-inline']
 339     )
 340
 341     raise
 342   end
 343
 344   def current_ability
 345     Ability.new(current_user)
 346   end
 347
 348   def deny_access(_exception)
 349     if doorkeeper_token || current_token
 350       set_locale
 351       report_error t("oauth.permissions.missing"), :forbidden
 352     elsif current_user
 353       set_locale
 354       respond_to do |format|
 355         format.html { redirect_to :controller => "/errors", :action => "forbidden" }
 356         format.any { report_error t("application.permission_denied"), :forbidden }
 357       end
 358     elsif request.get?
 359       respond_to do |format|
 360         format.html { redirect_to login_path(:referer => request.fullpath) }
 361         format.any { head :forbidden }
 362       end
 363     else
 364       head :forbidden
 365     end
 366   end
 367
 368   # extract authorisation credentials from headers, returns user = nil if none
 369   def auth_data
 370     if request.env.key? "X-HTTP_AUTHORIZATION" # where mod_rewrite might have put it
 371       authdata = request.env["X-HTTP_AUTHORIZATION"].to_s.split
 372     elsif request.env.key? "REDIRECT_X_HTTP_AUTHORIZATION" # mod_fcgi
 373       authdata = request.env["REDIRECT_X_HTTP_AUTHORIZATION"].to_s.split
 374     elsif request.env.key? "HTTP_AUTHORIZATION" # regular location
 375       authdata = request.env["HTTP_AUTHORIZATION"].to_s.split
 376     end
 377     # only basic authentication supported
 378     user, pass = Base64.decode64(authdata[1]).split(":", 2) if authdata && authdata[0] == "Basic"
 379     [user, pass]
 380   end
 381
 382   # override to stop oauth plugin sending errors
 383   def invalid_oauth_response; end
 384
 385   # clean any referer parameter
 386   def safe_referer(referer)
 387     begin
 388       referer = URI.parse(referer)
 389
 390       if referer.scheme == "http" || referer.scheme == "https"
 391         referer.scheme = nil
 392         referer.host = nil
 393         referer.port = nil
 394       elsif referer.scheme || referer.host || referer.port
 395         referer = nil
 396       end
 397
 398       referer = nil if referer&.path&.first != "/"
 399     rescue URI::InvalidURIError
 400       referer = nil
 401     end
 402
 403     referer&.to_s
 404   end
 405
 406   def scope_enabled?(scope)
 407     doorkeeper_token&.includes_scope?(scope) || current_token&.includes_scope?(scope)
 408   end
 409
 410   helper_method :scope_enabled?
 411 end