class ApplicationController < ActionController::Base
+ include SessionPersistence
protect_from_forgery
- if STATUS == :database_readonly or STATUS == :database_offline
- after_filter :clear_session
- wrap_parameters false
-
- def clear_session
- session.clear
- end
-
- def self.cache_sweeper(*sweepers)
- end
- end
+ before_filter :fetch_body
def authorize_web
if session[:user]
end
def require_user
- redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath unless @user
+ unless @user
+ if request.get?
+ redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
+ else
+ render :text => "", :status => :forbidden
+ end
+ end
+ end
+
+ def require_oauth
+ @oauth = @user.access_token(OAUTH_KEY) if @user and defined? OAUTH_KEY
end
##
def require_allow_write_gpx
require_capability(:allow_write_gpx)
end
+ def require_allow_write_notes
+ require_capability(:allow_write_notes)
+ 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 :text => "", :status => :forbidden
+ end
+ end
+ end
##
# sets up the @user object for use by other methods. this is mostly called
# have we identified the user?
if @user
# check if the user has been banned
- if not @user.active_blocks.empty?
+ if @user.blocks.active.exists?
# NOTE: need slightly more helpful message than this.
report_error t('application.setup_user_auth.blocked'), :forbidden
end
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 STATUS == :database_offline or (need_api and STATUS == :api_offline)
redirect_to :controller => 'site', :action => 'offline'
end
def check_api_readable
- if STATUS == :database_offline or STATUS == :api_offline
+ if api_status == :offline
report_error "Database offline for maintenance", :service_unavailable
return false
end
end
def check_api_writable
- if STATUS == :database_offline or STATUS == :database_readonly or
- STATUS == :api_offline or STATUS == :api_readonly
+ 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?
report_error "You must make your edits public to upload new data", :forbidden
render :text => result.to_s, :content_type => "text/xml"
else
- render :text => message, :status => status
+ render :text => message, :status => status, :content_type => "text/plain"
end
end
def set_locale
response.header['Vary'] = 'Accept-Language'
- if @user
- if !@user.languages.empty?
- request.user_preferred_languages = @user.languages
- response.header['Vary'] = '*'
- elsif !request.user_preferred_languages.empty?
- @user.languages = request.user_preferred_languages
- @user.save
- end
+ if @user && !@user.languages.empty?
+ http_accept_language.user_preferred_languages = @user.languages
+ response.header['Vary'] = '*'
end
- if request.compatible_language_from(I18n.available_locales).nil?
- request.user_preferred_languages = request.user_preferred_languages.collect do |pl|
+ I18n.locale = select_locale
+
+ if @user && @user.languages.empty? && !http_accept_language.user_preferred_languages.empty?
+ @user.languages = http_accept_language.user_preferred_languages
+ @user.save
+ end
+
+ response.headers['Content-Language'] = I18n.locale.to_s
+ end
+
+ def select_locale(locales = I18n.available_locales)
+ if 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 ]
while pl.match(/^(.*)-[^-]+$/)
- pls.push($1) if I18n.available_locales.include?($1.to_sym)
+ pls.push($1) if locales.include?($1) or 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 = request.compatible_language_from(I18n.available_locales) || I18n.default_locale
-
- logger.info "Selected locale #{I18n.locale} from #{request.user_preferred_languages.inspect}"
-
- response.headers['Content-Language'] = I18n.locale.to_s
+ http_accept_language.compatible_language_from(locales) || I18n.default_locale
end
+ helper_method :select_locale
+
def api_call_handle_error
begin
yield
rescue ActiveRecord::RecordNotFound => ex
- render :nothing => true, :status => :not_found
+ render :text => "", :status => :not_found
rescue LibXML::XML::Error, ArgumentError => ex
report_error ex.message, :bad_request
rescue ActiveRecord::RecordInvalid => ex
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}")
rescue ActionView::Template::Error => ex
ex = ex.original_exception
- if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /^Timeout::Error/
+ if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /execution expired/
ex = Timeout::Error.new
end
end
##
- # extend caches_action to include the parameters, locale and logged in
- # status in all cache keys
- def self.caches_action(*actions)
- options = actions.extract_options!
- cache_path = options[:cache_path] || Hash.new
-
- 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)
-
- options[:cache_path] = Proc.new do |controller|
- cache_path.merge(controller.params).merge(:locale => I18n.locale)
- end
-
- actions.push(options)
+ # is the requestor logged in?
+ def logged_in?
+ !@user.nil?
+ end
- super *actions
+ ##
+ # 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
##
- # extend expire_action to expire all variants
- def expire_action(options = {})
- I18n.available_locales.each do |locale|
- super options.merge(:locale => locale)
+ # 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 :text => "", :status => :not_found }
end
end
##
- # is the requestor logged in?
- def logged_in?
- !@user.nil?
+ # 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
+
+ def map_layout
+ request.xhr? ? false : 'map'
end
+ def preferred_editor
+ editor = if params[:editor]
+ params[:editor]
+ elsif @user and @user.preferred_editor
+ @user.preferred_editor
+ else
+ DEFAULT_EDITOR
+ end
+
+ if request.env['HTTP_USER_AGENT'] =~ /MSIE/ and editor == 'id'
+ editor = 'potlatch2'
+ end
+
+ editor
+ end
+
+ helper_method :preferred_editor
+
private
# extract authorisation credentials from headers, returns user = nil if none