X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/a5b784bdf7e093c76d0c09c56ae274c93c4cb956..ef7f3d800cbdd49b692df10d312e5fd880e2e938:/app/controllers/application_controller.rb diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index 97ab5abfc..e3f0391d1 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -9,33 +9,29 @@ class ApplicationController < ActionController::Base if session[:user] @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" + if @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? + # 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 && 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 + end elsif session[:token] if @user = User.authenticate(:token => session[:token]) session[:user] = @user.id end end rescue Exception => ex - logger.info("Exception authorizing user: #{ex.to_s}") + logger.info("Exception authorizing user: #{ex}") reset_session @user = nil end @@ -51,12 +47,12 @@ class ApplicationController < ActionController::Base end def require_oauth - @oauth = @user.access_token(OAUTH_KEY) if @user and defined? OAUTH_KEY + @oauth = @user.access_token(OAUTH_KEY) if @user && defined? OAUTH_KEY end ## - # requires the user to be logged in by the token or HTTP methods, or have an - # OAuth token with the right capability. this method is a bit of a pain to call + # requires the user to be logged in by the token or HTTP methods, or have an + # OAuth token with the right capability. this method is a bit of a pain to call # directly, since it's cumbersome to call filters with arguments in rails. to # make it easier to read and write the code, there are some utility methods # below. @@ -77,7 +73,7 @@ class ApplicationController < ActionController::Base if request.cookies["_osm_session"].to_s == "" if params[:cookie_test].nil? session[:cookie_test] = true - redirect_to params.merge(:cookie_test => "true") + redirect_to Hash[params].merge(:cookie_test => "true") return false else flash.now[:warning] = t 'application.require_cookies.cookies_needed' @@ -91,26 +87,32 @@ class ApplicationController < ActionController::Base def require_allow_read_prefs require_capability(:allow_read_prefs) end + def require_allow_write_prefs require_capability(:allow_write_prefs) end + def require_allow_write_diary require_capability(:allow_write_diary) end + def require_allow_write_api require_capability(:allow_write_api) - if REQUIRE_TERMS_AGREED and @user.terms_agreed.nil? + if REQUIRE_TERMS_AGREED && @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) end + def require_allow_write_gpx require_capability(:allow_write_gpx) end + def require_allow_write_notes require_capability(:allow_write_notes) end @@ -135,7 +137,7 @@ class ApplicationController < ActionController::Base # is optional. def setup_user_auth # try and setup using OAuth - if not Authenticator.new(self, [:token]).allow? + unless Authenticator.new(self, [:token]).allow? username, passwd = get_auth_data # parse from headers # authenticate per-scheme if username.nil? @@ -158,25 +160,25 @@ class ApplicationController < ActionController::Base # 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? + if REQUIRE_TERMS_SEEN && !@user.terms_seen && flash[:skip_terms].nil? set_locale report_error t('application.setup_user_auth.need_to_see_terms'), :forbidden end end end - def authorize(realm='Web Password', errormessage="Couldn't authenticate you") + def authorize(realm = 'Web Password', errormessage = "Couldn't authenticate you") # make the @user object from any auth sources we have setup_user_auth # handle authenticate pass/fail unless @user # no auth, the user does not exist or the password was wrong - response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" + response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" render :text => errormessage, :status => :unauthorized return false - end - end + end + end ## # to be used as a before_filter *after* authorize. this checks that @@ -184,26 +186,34 @@ class ApplicationController < ActionController::Base # # 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 + # 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") + 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 + end + end def check_database_readable(need_api = false) - if STATUS == :database_offline or (need_api and STATUS == :api_offline) - redirect_to :controller => 'site', :action => 'offline' + if STATUS == :database_offline || (need_api && STATUS == :api_offline) + if request.xhr? + report_error "Database offline for maintenance", :service_unavailable + else + redirect_to :controller => 'site', :action => 'offline' + end end end def check_database_writable(need_api = false) - 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' + if STATUS == :database_offline || STATUS == :database_readonly || + (need_api && (STATUS == :api_offline || STATUS == :api_readonly)) + if request.xhr? + report_error "Database offline for maintenance", :service_unavailable + else + redirect_to :controller => 'site', :action => 'offline' + end end end @@ -226,7 +236,7 @@ class ApplicationController < ActionController::Base :offline elsif STATUS == :database_readonly :readonly - else + else :online end end @@ -240,7 +250,7 @@ class ApplicationController < ActionController::Base status = :readonly end end - return status + status end def gpx_status @@ -248,7 +258,7 @@ class ApplicationController < ActionController::Base if status == :online status = :offline if STATUS == :gpx_offline end - return status + status end def require_public_data @@ -260,14 +270,14 @@ class ApplicationController < ActionController::Base # Report and error to the user # (If anyone ever fixes Rails so it can set a http status "reason phrase", - # rather than only a status code and having the web engine make up a + # rather than only a status code and having the web engine make up a # phrase from that, we can also put the error message into the status # message. For now, rails won't let us) def report_error(message, status = :bad_request) # Todo: some sort of escaping of problem characters in the message response.headers['Error'] = message - if request.headers['X-Error-Format'] and + if request.headers['X-Error-Format'] && request.headers['X-Error-Format'].downcase == "xml" result = OSM::API.new.get_xml_doc result.root.name = "osmError" @@ -279,7 +289,7 @@ class ApplicationController < ActionController::Base render :text => message, :status => status, :content_type => "text/plain" end end - + def set_locale response.header['Vary'] = 'Accept-Language' @@ -300,15 +310,15 @@ class ApplicationController < ActionController::Base def select_locale(locales = I18n.available_locales) if params[:locale] - http_accept_language.user_preferred_languages = [ params[:locale] ] + http_accept_language.user_preferred_languages = [params[:locale]] end if http_accept_language.compatible_language_from(locales).nil? http_accept_language.user_preferred_languages = http_accept_language.user_preferred_languages.collect do |pl| - pls = [ pl ] + pls = [pl] while pl.match(/^(.*)-[^-]+$/) - pls.push($1) if locales.include?($1) or locales.include?($1.to_sym) + pls.push($1) if locales.include?($1) || locales.include?($1.to_sym) pl = $1 end @@ -322,25 +332,23 @@ class ApplicationController < ActionController::Base helper_method :select_locale def api_call_handle_error - begin - yield - rescue ActiveRecord::RecordNotFound => ex - render :text => "", :status => :not_found - rescue LibXML::XML::Error, ArgumentError => ex - report_error ex.message, :bad_request - rescue ActiveRecord::RecordInvalid => ex - message = "#{ex.record.class} #{ex.record.id}: " - ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" } - report_error message, :bad_request - rescue OSM::APIError => ex - report_error ex.message, ex.status - rescue AbstractController::ActionNotFound => ex - raise - rescue Exception => ex - logger.info("API threw unexpected #{ex.class} exception: #{ex.message}") - ex.backtrace.each { |l| logger.info(l) } - report_error "#{ex.class}: #{ex.message}", :internal_server_error - end + yield + rescue ActiveRecord::RecordNotFound => ex + render :text => "", :status => :not_found + rescue LibXML::XML::Error, ArgumentError => ex + report_error ex.message, :bad_request + rescue ActiveRecord::RecordInvalid => ex + message = "#{ex.record.class} #{ex.record.id}: " + ex.record.errors.each { |attr, msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" } + report_error message, :bad_request + rescue OSM::APIError => ex + report_error ex.message, ex.status + rescue AbstractController::ActionNotFound => ex + raise + rescue Exception => ex + logger.info("API threw unexpected #{ex.class} exception: #{ex.message}") + ex.backtrace.each { |l| logger.info(l) } + report_error "#{ex.class}: #{ex.message}", :internal_server_error end ## @@ -348,7 +356,7 @@ class ApplicationController < ActionController::Base # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get. def assert_method(method) ok = request.send((method.to_s.downcase + "?").to_sym) - raise OSM::APIBadMethodError.new(method) unless ok + fail OSM::APIBadMethodError.new(method) unless ok end ## @@ -370,7 +378,7 @@ class ApplicationController < ActionController::Base rescue ActionView::Template::Error => ex ex = ex.original_exception - if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /execution expired/ + if ex.is_a?(ActiveRecord::StatementInvalid) && ex.message =~ /execution expired/ ex = Timeout::Error.new end @@ -423,19 +431,19 @@ class ApplicationController < ActionController::Base end def map_layout - request.xhr? ? false : 'map' + request.xhr? ? 'xhr' : 'map' end def preferred_editor editor = if params[:editor] - params[:editor] - elsif @user and @user.preferred_editor - @user.preferred_editor - else - DEFAULT_EDITOR + params[:editor] + elsif @user && @user.preferred_editor + @user.preferred_editor + else + DEFAULT_EDITOR end - if request.env['HTTP_USER_AGENT'] =~ /MSIE/ and editor == 'id' + if request.env['HTTP_USER_AGENT'] =~ /MSIE|Trident/ && editor == 'id' editor = 'potlatch2' end @@ -444,23 +452,23 @@ class ApplicationController < ActionController::Base helper_method :preferred_editor -private + private # extract authorisation credentials from headers, returns user = nil if none - def get_auth_data - if request.env.has_key? 'X-HTTP_AUTHORIZATION' # where mod_rewrite might have put it - authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split - elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION' # mod_fcgi - authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split - elsif request.env.has_key? 'HTTP_AUTHORIZATION' # regular location + def get_auth_data + if request.env.key? 'X-HTTP_AUTHORIZATION' # where mod_rewrite might have put it + authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split + elsif request.env.key? 'REDIRECT_X_HTTP_AUTHORIZATION' # mod_fcgi + authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split + elsif request.env.key? 'HTTP_AUTHORIZATION' # regular location authdata = request.env['HTTP_AUTHORIZATION'].to_s.split - end + end # only basic authentication supported - if authdata and authdata[0] == 'Basic' - user, pass = Base64.decode64(authdata[1]).split(':',2) - end - return [user, pass] - end + if authdata && authdata[0] == 'Basic' + user, pass = Base64.decode64(authdata[1]).split(':', 2) + end + [user, pass] + end # used by oauth plugin to get the current user def current_user @@ -469,11 +477,10 @@ private # used by oauth plugin to set the current user def current_user=(user) - @user=user + @user = user end # override to stop oauth plugin sending errors def invalid_oauth_response end - end