1 class ApplicationController < ActionController::Base
2 include SessionPersistence
6 before_filter :fetch_body
8 if STATUS == :database_readonly or STATUS == :database_offline
9 def self.cache_sweeper(*sweepers)
15 @user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
17 if @user.display_name != cookies["_osm_username"]
18 logger.info "Session user '#{@user.display_name}' does not match cookie user '#{cookies['_osm_username']}'"
21 elsif @user.status == "suspended"
23 session_expires_automatically
25 redirect_to :controller => "user", :action => "suspended"
27 # don't allow access to any auth-requiring part of the site unless
28 # the new CTs have been seen (and accept/decline chosen).
29 elsif !@user.terms_seen and flash[:skip_terms].nil?
30 flash[:notice] = t 'user.terms.you need to accept or decline'
32 redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
34 redirect_to :controller => "user", :action => "terms", :referer => request.fullpath
38 if @user = User.authenticate(:token => session[:token])
39 session[:user] = @user.id
42 rescue Exception => ex
43 logger.info("Exception authorizing user: #{ex.to_s}")
51 redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
53 render :nothing => true, :status => :forbidden
59 @oauth = @user.access_token(OAUTH_KEY) if @user and defined? OAUTH_KEY
63 # requires the user to be logged in by the token or HTTP methods, or have an
64 # OAuth token with the right capability. this method is a bit of a pain to call
65 # directly, since it's cumbersome to call filters with arguments in rails. to
66 # make it easier to read and write the code, there are some utility methods
68 def require_capability(cap)
69 # when the current token is nil, it means the user logged in with a different
70 # method, otherwise an OAuth token was used, which has to be checked.
71 unless current_token.nil?
72 unless current_token.read_attribute(cap)
73 report_error "OAuth token doesn't have that capability.", :forbidden
80 # require the user to have cookies enabled in their browser
82 if request.cookies["_osm_session"].to_s == ""
83 if params[:cookie_test].nil?
84 session[:cookie_test] = true
85 redirect_to params.merge(:cookie_test => "true")
88 flash.now[:warning] = t 'application.require_cookies.cookies_needed'
91 session.delete(:cookie_test)
95 # Utility methods to make the controller filter methods easier to read and write.
96 def require_allow_read_prefs
97 require_capability(:allow_read_prefs)
99 def require_allow_write_prefs
100 require_capability(:allow_write_prefs)
102 def require_allow_write_diary
103 require_capability(:allow_write_diary)
105 def require_allow_write_api
106 require_capability(:allow_write_api)
108 if REQUIRE_TERMS_AGREED and @user.terms_agreed.nil?
109 report_error "You must accept the contributor terms before you can edit.", :forbidden
113 def require_allow_read_gpx
114 require_capability(:allow_read_gpx)
116 def require_allow_write_gpx
117 require_capability(:allow_write_gpx)
119 def require_allow_write_notes
120 require_capability(:allow_write_notes)
124 # require that the user is a moderator, or fill out a helpful error message
125 # and return them to the index for the controller this is wrapped from.
126 def require_moderator
127 unless @user.moderator?
129 flash[:error] = t('application.require_moderator.not_a_moderator')
130 redirect_to :action => 'index'
132 render :nothing => true, :status => :forbidden
138 # sets up the @user object for use by other methods. this is mostly called
139 # from the authorize method, but can be called elsewhere if authorisation
142 # try and setup using OAuth
143 if not Authenticator.new(self, [:token]).allow?
144 username, passwd = get_auth_data # parse from headers
145 # authenticate per-scheme
147 @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
148 elsif username == 'token'
149 @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
151 @user = User.authenticate(:username => username, :password => passwd) # basic auth
155 # have we identified the user?
157 # check if the user has been banned
158 if @user.blocks.active.exists?
159 # NOTE: need slightly more helpful message than this.
160 report_error t('application.setup_user_auth.blocked'), :forbidden
163 # if the user hasn't seen the contributor terms then don't
164 # allow editing - they have to go to the web site and see
165 # (but can decline) the CTs to continue.
166 if REQUIRE_TERMS_SEEN and not @user.terms_seen and flash[:skip_terms].nil?
168 report_error t('application.setup_user_auth.need_to_see_terms'), :forbidden
173 def authorize(realm='Web Password', errormessage="Couldn't authenticate you")
174 # make the @user object from any auth sources we have
177 # handle authenticate pass/fail
179 # no auth, the user does not exist or the password was wrong
180 response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
181 render :text => errormessage, :status => :unauthorized
187 # to be used as a before_filter *after* authorize. this checks that
188 # the user is a moderator and, if not, returns a forbidden error.
190 # NOTE: this isn't a very good way of doing it - it duplicates logic
191 # from require_moderator - but what we really need to do is a fairly
192 # drastic refactoring based on :format and respond_to? but not a
193 # good idea to do that in this branch.
194 def authorize_moderator(errormessage="Access restricted to moderators")
195 # check user is a moderator
196 unless @user.moderator?
197 render :text => errormessage, :status => :forbidden
202 def check_database_readable(need_api = false)
203 if STATUS == :database_offline or (need_api and STATUS == :api_offline)
204 redirect_to :controller => 'site', :action => 'offline'
208 def check_database_writable(need_api = false)
209 if STATUS == :database_offline or STATUS == :database_readonly or
210 (need_api and (STATUS == :api_offline or STATUS == :api_readonly))
211 redirect_to :controller => 'site', :action => 'offline'
215 def check_api_readable
216 if STATUS == :database_offline or STATUS == :api_offline
217 report_error "Database offline for maintenance", :service_unavailable
222 def check_api_writable
223 if STATUS == :database_offline or STATUS == :database_readonly or
224 STATUS == :api_offline or STATUS == :api_readonly
225 report_error "Database offline for maintenance", :service_unavailable
230 def require_public_data
231 unless @user.data_public?
232 report_error "You must make your edits public to upload new data", :forbidden
237 # Report and error to the user
238 # (If anyone ever fixes Rails so it can set a http status "reason phrase",
239 # rather than only a status code and having the web engine make up a
240 # phrase from that, we can also put the error message into the status
241 # message. For now, rails won't let us)
242 def report_error(message, status = :bad_request)
243 # Todo: some sort of escaping of problem characters in the message
244 response.headers['Error'] = message
246 if request.headers['X-Error-Format'] and
247 request.headers['X-Error-Format'].downcase == "xml"
248 result = OSM::API.new.get_xml_doc
249 result.root.name = "osmError"
250 result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
251 result.root << (XML::Node.new("message") << message)
253 render :text => result.to_s, :content_type => "text/xml"
255 render :text => message, :status => status
260 response.header['Vary'] = 'Accept-Language'
263 if !@user.languages.empty?
264 request.user_preferred_languages = @user.languages
265 response.header['Vary'] = '*'
266 elsif !request.user_preferred_languages.empty?
267 @user.languages = request.user_preferred_languages
272 if request.compatible_language_from(I18n.available_locales).nil?
273 request.user_preferred_languages = request.user_preferred_languages.collect do |pl|
276 while pl.match(/^(.*)-[^-]+$/)
277 pls.push($1) if I18n.available_locales.include?($1.to_sym)
284 if @user and not request.compatible_language_from(I18n.available_locales).nil?
285 @user.languages = request.user_preferred_languages
290 I18n.locale = params[:locale] || request.compatible_language_from(I18n.available_locales) || I18n.default_locale
292 response.headers['Content-Language'] = I18n.locale.to_s
295 def api_call_handle_error
298 rescue ActiveRecord::RecordNotFound => ex
299 render :nothing => true, :status => :not_found
300 rescue LibXML::XML::Error, ArgumentError => ex
301 report_error ex.message, :bad_request
302 rescue ActiveRecord::RecordInvalid => ex
303 message = "#{ex.record.class} #{ex.record.id}: "
304 ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
305 report_error message, :bad_request
306 rescue OSM::APIError => ex
307 report_error ex.message, ex.status
308 rescue AbstractController::ActionNotFound => ex
310 rescue Exception => ex
311 logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
312 ex.backtrace.each { |l| logger.info(l) }
313 report_error "#{ex.class}: #{ex.message}", :internal_server_error
318 # asserts that the request method is the +method+ given as a parameter
319 # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
320 def assert_method(method)
321 ok = request.send((method.to_s.downcase + "?").to_sym)
322 raise OSM::APIBadMethodError.new(method) unless ok
326 # wrap an api call in a timeout
328 OSM::Timer.timeout(API_TIMEOUT) do
331 rescue Timeout::Error
332 raise OSM::APITimeoutError
336 # wrap a web page in a timeout
338 OSM::Timer.timeout(WEB_TIMEOUT) do
341 rescue ActionView::Template::Error => ex
342 ex = ex.original_exception
344 if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /^Timeout::Error/
345 ex = Timeout::Error.new
348 if ex.is_a?(Timeout::Error)
349 render :action => "timeout"
353 rescue Timeout::Error
354 render :action => "timeout"
358 # extend caches_action to include the parameters, locale and logged in
359 # status in all cache keys
360 def self.caches_action(*actions)
361 options = actions.extract_options!
362 cache_path = options[:cache_path] || Hash.new
364 options[:unless] = case options[:unless]
365 when NilClass then Array.new
366 when Array then options[:unless]
367 else unlessp = [ options[:unless] ]
370 options[:unless].push(Proc.new do |controller|
371 controller.params.include?(:page)
374 options[:cache_path] = Proc.new do |controller|
375 cache_path.merge(controller.params).merge(:host => SERVER_URL, :locale => I18n.locale)
378 actions.push(options)
384 # extend expire_action to expire all variants
385 def expire_action(options = {})
386 I18n.available_locales.each do |locale|
387 super options.merge(:host => SERVER_URL, :locale => locale)
392 # is the requestor logged in?
398 # ensure that there is a "this_user" instance variable
400 unless @this_user = User.active.find_by_display_name(params[:display_name])
401 render_unknown_user params[:display_name]
406 # render a "no such user" page
407 def render_unknown_user(name)
408 @title = t "user.no_such_user.title"
409 @not_found_user = name
411 respond_to do |format|
412 format.html { render :template => "user/no_such_user", :status => :not_found }
413 format.all { render :nothing => true, :status => :not_found }
418 # Unfortunately if a PUT or POST request that has a body fails to
419 # read it then Apache will sometimes fail to return the response it
420 # is given to the client properly, instead erroring:
422 # https://issues.apache.org/bugzilla/show_bug.cgi?id=44782
424 # To work round this we call rewind on the body here, which is added
425 # as a filter, to force it to be fetched from Apache into a file.
432 # extract authorisation credentials from headers, returns user = nil if none
434 if request.env.has_key? 'X-HTTP_AUTHORIZATION' # where mod_rewrite might have put it
435 authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split
436 elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION' # mod_fcgi
437 authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split
438 elsif request.env.has_key? 'HTTP_AUTHORIZATION' # regular location
439 authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
441 # only basic authentication supported
442 if authdata and authdata[0] == 'Basic'
443 user, pass = Base64.decode64(authdata[1]).split(':',2)
448 # used by oauth plugin to get the current user
453 # used by oauth plugin to set the current user
454 def current_user=(user)
458 # override to stop oauth plugin sending errors
459 def invalid_oauth_response