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