X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/cf682f49b37a533e7e7aa5f8ea879ba970e88490..32959aed76917ff14f51acb185484dcc7bb2bfbd:/app/controllers/application_controller.rb diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index c7c6c4add..e5a2b3540 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -1,32 +1,58 @@ -# Filters added to this controller will be run for all controllers in the application. -# Likewise, all the methods added will be available for all controllers. class ApplicationController < ActionController::Base + include SessionPersistence - if OSM_STATUS == :database_readonly or OSM_STATUS == :database_offline - session :off + protect_from_forgery + + before_filter :fetch_body + + if STATUS == :database_readonly or STATUS == :database_offline + def self.cache_sweeper(*sweepers) + end end def authorize_web if session[:user] - @user = User.find(session[:user], :conditions => {:status => ["active", "confirmed", "suspended"]}) - - if @user.status == "suspended" - session[:user] = nil + @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" + 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' + if params[:referer] + redirect_to :controller => "user", :action => "terms", :referer => params[:referer] + else + redirect_to :controller => "user", :action => "terms", :referer => request.fullpath + end end elsif session[:token] - @user = User.authenticate(:token => session[:token]) - session[:user] = @user.id + if @user = User.authenticate(:token => session[:token]) + session[:user] = @user.id + end end rescue Exception => ex logger.info("Exception authorizing user: #{ex.to_s}") + reset_session @user = nil end def require_user - redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri unless @user + unless @user + if request.get? + redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath + else + render :nothing => true, :status => :forbidden + end + end end ## @@ -40,7 +66,7 @@ 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) - render :text => "OAuth token doesn't have that capability.", :status => :forbidden + report_error "OAuth token doesn't have that capability.", :forbidden return false end end @@ -51,11 +77,14 @@ class ApplicationController < ActionController::Base def require_cookies 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 else flash.now[:warning] = t 'application.require_cookies.cookies_needed' end + else + session.delete(:cookie_test) end end @@ -71,6 +100,11 @@ class ApplicationController < ActionController::Base end def require_allow_write_api require_capability(:allow_write_api) + + if REQUIRE_TERMS_AGREED and @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) @@ -79,15 +113,27 @@ class ApplicationController < ActionController::Base require_capability(:allow_write_gpx) end + ## + # 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? + if request.get? + flash[:error] = t('application.require_moderator.not_a_moderator') + redirect_to :action => 'index' + else + render :nothing => true, :status => :forbidden + end + end + end + ## # sets up the @user object 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 oauthenticate - @user = current_token.user - else + if not Authenticator.new(self, [:token]).allow? username, passwd = get_auth_data # parse from headers # authenticate per-scheme if username.nil? @@ -99,10 +145,21 @@ class ApplicationController < ActionController::Base end end - # check if the user has been banned - unless @user.nil? or @user.active_blocks.empty? - # NOTE: need slightly more helpful message than this. - render :text => t('application.setup_user_auth.blocked'), :status => :forbidden + # have we identified the user? + if @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 + 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? + set_locale + report_error t('application.setup_user_auth.need_to_see_terms'), :forbidden + end end end @@ -119,40 +176,82 @@ class ApplicationController < ActionController::Base end end + ## + # to be used as a before_filter *after* authorize. this checks that + # the user is a moderator and, if not, returns a forbidden error. + # + # 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 + # good idea to do that in this branch. + 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 + def check_database_readable(need_api = false) - if OSM_STATUS == :database_offline or (need_api and OSM_STATUS == :api_offline) + if STATUS == :database_offline or (need_api and STATUS == :api_offline) redirect_to :controller => 'site', :action => 'offline' end end def check_database_writable(need_api = false) - if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or - (need_api and (OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly)) + 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' end end def check_api_readable - if OSM_STATUS == :database_offline or OSM_STATUS == :api_offline - response.headers['Error'] = "Database offline for maintenance" - render :nothing => true, :status => :service_unavailable + if api_status == :offline + report_error "Database offline for maintenance", :service_unavailable return false end end def check_api_writable - if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or - OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly - response.headers['Error'] = "Database offline for maintenance" - render :nothing => true, :status => :service_unavailable + unless api_status == :online + report_error "Database offline for maintenance", :service_unavailable return false end end + def database_status + if STATUS == :database_offline + :offline + elsif STATUS == :database_readonly + :readonly + else + :online + end + end + + def api_status + status = database_status + if status == :online + if STATUS == :api_offline + status = :offline + elsif STATUS == :api_readonly + status = :readonly + end + end + return status + end + + def gpx_status + status = database_status + if status == :online + status = :offline if STATUS == :gpx_offline + end + return status + end + def require_public_data unless @user.data_public? - response.headers['Error'] = "You must make your edits public to upload new data" - render :nothing => true, :status => :forbidden + report_error "You must make your edits public to upload new data", :forbidden return false end end @@ -165,7 +264,18 @@ class ApplicationController < ActionController::Base def report_error(message, status = :bad_request) # Todo: some sort of escaping of problem characters in the message response.headers['Error'] = message - render :text => message, :status => status + + if request.headers['X-Error-Format'] and + request.headers['X-Error-Format'].downcase == "xml" + 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" + else + render :text => message, :status => status + end end def set_locale @@ -181,7 +291,25 @@ class ApplicationController < ActionController::Base end end - I18n.locale = request.compatible_language_from(I18n.available_locales) + 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 + + pls + end.flatten + + if @user and not request.compatible_language_from(I18n.available_locales).nil? + @user.languages = request.user_preferred_languages + @user.save + end + end + + I18n.locale = params[:locale] || request.compatible_language_from(I18n.available_locales) || I18n.default_locale response.headers['Content-Language'] = I18n.locale.to_s end @@ -199,7 +327,7 @@ class ApplicationController < ActionController::Base report_error message, :bad_request rescue OSM::APIError => ex report_error ex.message, ex.status - rescue ActionController::UnknownAction => ex + rescue AbstractController::ActionNotFound => ex raise rescue Exception => ex logger.info("API threw unexpected #{ex.class} exception: #{ex.message}") @@ -219,7 +347,7 @@ class ApplicationController < ActionController::Base ## # wrap an api call in a timeout def api_call_timeout - SystemTimer.timeout_after(APP_CONFIG['api_timeout']) do + OSM::Timer.timeout(API_TIMEOUT) do yield end rescue Timeout::Error @@ -229,11 +357,17 @@ class ApplicationController < ActionController::Base ## # wrap a web page in a timeout def web_timeout - SystemTimer.timeout_after(APP_CONFIG['web_timeout']) do + OSM::Timer.timeout(WEB_TIMEOUT) do yield end - rescue ActionView::TemplateError => ex - if ex.original_exception.is_a?(Timeout::Error) + rescue ActionView::Template::Error => ex + ex = ex.original_exception + + if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /^Timeout::Error/ + ex = Timeout::Error.new + end + + if ex.is_a?(Timeout::Error) render :action => "timeout" else raise @@ -249,18 +383,18 @@ class ApplicationController < ActionController::Base options = actions.extract_options! cache_path = options[:cache_path] || Hash.new - options[:cache_path] = Proc.new do |controller| - user = controller.instance_variable_get("@user") - - case - when user.nil? then user = :none - when user.display_name == controller.params[:display_name] then user = :self - when user.administrator? then user = :administrator - when user.moderator? then user = :moderator - else user = :other - end + 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) - cache_path.merge(controller.params).merge(:locale => I18n.locale, :user => user) + options[:cache_path] = Proc.new do |controller| + cache_path.merge(controller.params).merge(:host => SERVER_URL, :locale => I18n.locale) end actions.push(options) @@ -271,8 +405,9 @@ class ApplicationController < ActionController::Base ## # extend expire_action to expire all variants def expire_action(options = {}) - path = ActionCachePath.path_for(self, options, false).gsub('?', '.').gsub(':', '.') - expire_fragment(Regexp.new(Regexp.escape(path) + "\\..*")) + I18n.available_locales.each do |locale| + super options.merge(:host => SERVER_URL, :locale => locale) + end end ## @@ -281,6 +416,39 @@ class ApplicationController < ActionController::Base !@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 + end + + ## + # render a "no such user" page + def render_unknown_user(name) + @title = t "user.no_such_user.title" + @not_found_user = name + + respond_to do |format| + format.html { render :template => "user/no_such_user", :status => :not_found } + format.all { render :nothing => true, :status => :not_found } + end + end + + ## + # Unfortunately if a PUT or POST request that has a body fails to + # read it then Apache will sometimes fail to return the response it + # is given to the client properly, instead erroring: + # + # https://issues.apache.org/bugzilla/show_bug.cgi?id=44782 + # + # To work round this we call rewind on the body here, which is added + # as a filter, to force it to be fetched from Apache into a file. + def fetch_body + request.body.rewind + end + private # extract authorisation credentials from headers, returns user = nil if none @@ -299,4 +467,18 @@ private return [user, pass] end + # used by oauth plugin to get the current user + def current_user + @user + end + + # used by oauth plugin to set the current user + def current_user=(user) + @user=user + end + + # override to stop oauth plugin sending errors + def invalid_oauth_response + end + end