]> git.openstreetmap.org Git - rails.git/blob - app/controllers/application_controller.rb
d987472531e5a147a64325f546936e6bc262e517
[rails.git] / app / controllers / application_controller.rb
1 class ApplicationController < ActionController::Base
2   include SessionPersistence
3
4   protect_from_forgery
5
6   if STATUS == :database_readonly or STATUS == :database_offline
7     def self.cache_sweeper(*sweepers)
8     end
9   end
10
11   def authorize_web
12     if session[:user]
13       @user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
14
15       if @user.display_name != cookies["_osm_username"]
16         logger.info "Session user '#{@user.display_name}' does not match cookie user '#{cookies['_osm_username']}'"
17         reset_session
18         @user = nil
19       elsif @user.status == "suspended"
20         session.delete(:user)
21         session_expires_automatically
22
23         redirect_to :controller => "user", :action => "suspended"
24
25         # don't allow access to any auth-requiring part of the site unless
26         # the new CTs have been seen (and accept/decline chosen).
27       elsif !@user.terms_seen and flash[:skip_terms].nil?
28         flash[:notice] = t 'user.terms.you need to accept or decline'
29         if params[:referer]
30           redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
31         else
32           redirect_to :controller => "user", :action => "terms", :referer => request.fullpath
33         end
34       end
35     elsif session[:token]
36       if @user = User.authenticate(:token => session[:token])
37         session[:user] = @user.id
38       end
39     end
40   rescue Exception => ex
41     logger.info("Exception authorizing user: #{ex.to_s}")
42     reset_session
43     @user = nil
44   end
45
46   def require_user
47     unless @user
48       if request.get?
49         redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
50       else
51         render :nothing => true, :status => :forbidden
52       end
53     end
54   end
55
56   ##
57   # requires the user to be logged in by the token or HTTP methods, or have an 
58   # OAuth token with the right capability. this method is a bit of a pain to call 
59   # directly, since it's cumbersome to call filters with arguments in rails. to
60   # make it easier to read and write the code, there are some utility methods
61   # below.
62   def require_capability(cap)
63     # when the current token is nil, it means the user logged in with a different
64     # method, otherwise an OAuth token was used, which has to be checked.
65     unless current_token.nil?
66       unless current_token.read_attribute(cap)
67         report_error "OAuth token doesn't have that capability.", :forbidden
68         return false
69       end
70     end
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.merge(:cookie_test => "true")
80         return 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   # Utility methods to make the controller filter methods easier to read and write.
90   def require_allow_read_prefs
91     require_capability(:allow_read_prefs)
92   end
93   def require_allow_write_prefs
94     require_capability(:allow_write_prefs)
95   end
96   def require_allow_write_diary
97     require_capability(:allow_write_diary)
98   end
99   def require_allow_write_api
100     require_capability(:allow_write_api)
101
102     if REQUIRE_TERMS_AGREED and @user.terms_agreed.nil?
103       report_error "You must accept the contributor terms before you can edit.", :forbidden
104       return false
105     end
106   end
107   def require_allow_read_gpx
108     require_capability(:allow_read_gpx)
109   end
110   def require_allow_write_gpx
111     require_capability(:allow_write_gpx)
112   end
113
114   ##
115   # require that the user is a moderator, or fill out a helpful error message
116   # and return them to the blocks index.
117   def require_moderator
118     unless @user.moderator?
119       if request.get?
120         flash[:error] = t('application.require_moderator.not_a_moderator')
121         redirect_to :action => 'index'
122       else
123         render :nothing => true, :status => :forbidden
124       end
125     end
126   end
127
128   ##
129   # sets up the @user object for use by other methods. this is mostly called
130   # from the authorize method, but can be called elsewhere if authorisation
131   # is optional.
132   def setup_user_auth
133     # try and setup using OAuth
134     if not Authenticator.new(self, [:token]).allow?
135       username, passwd = get_auth_data # parse from headers
136       # authenticate per-scheme
137       if username.nil?
138         @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
139       elsif username == 'token'
140         @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
141       else
142         @user = User.authenticate(:username => username, :password => passwd) # basic auth
143       end
144     end
145
146     # have we identified the user?
147     if @user
148       # check if the user has been banned
149       if not  @user.active_blocks.empty?
150         # NOTE: need slightly more helpful message than this.
151         report_error t('application.setup_user_auth.blocked'), :forbidden
152       end
153
154       # if the user hasn't seen the contributor terms then don't
155       # allow editing - they have to go to the web site and see
156       # (but can decline) the CTs to continue.
157       if REQUIRE_TERMS_SEEN and not @user.terms_seen and flash[:skip_terms].nil?
158         set_locale
159         report_error t('application.setup_user_auth.need_to_see_terms'), :forbidden
160       end
161     end
162   end
163
164   def authorize(realm='Web Password', errormessage="Couldn't authenticate you") 
165     # make the @user object from any auth sources we have
166     setup_user_auth
167
168     # handle authenticate pass/fail
169     unless @user
170       # no auth, the user does not exist or the password was wrong
171       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" 
172       render :text => errormessage, :status => :unauthorized
173       return false
174     end 
175   end 
176
177   ##
178   # to be used as a before_filter *after* authorize. this checks that
179   # the user is a moderator and, if not, returns a forbidden error.
180   #
181   def authorize_moderator(errormessage="Access restricted to moderators") 
182     # check user is a moderator
183     unless @user.moderator?
184       render :text => errormessage, :status => :forbidden
185       return false
186     end 
187   end 
188
189   def check_database_readable(need_api = false)
190     if STATUS == :database_offline or (need_api and STATUS == :api_offline)
191       redirect_to :controller => 'site', :action => 'offline'
192     end
193   end
194
195   def check_database_writable(need_api = false)
196     if STATUS == :database_offline or STATUS == :database_readonly or
197        (need_api and (STATUS == :api_offline or STATUS == :api_readonly))
198       redirect_to :controller => 'site', :action => 'offline'
199     end
200   end
201
202   def check_api_readable
203     if STATUS == :database_offline or STATUS == :api_offline
204       report_error "Database offline for maintenance", :service_unavailable
205       return false
206     end
207   end
208
209   def check_api_writable
210     if STATUS == :database_offline or STATUS == :database_readonly or
211        STATUS == :api_offline or STATUS == :api_readonly
212       report_error "Database offline for maintenance", :service_unavailable
213       return false
214     end
215   end
216
217   def require_public_data
218     unless @user.data_public?
219       report_error "You must make your edits public to upload new data", :forbidden
220       return false
221     end
222   end
223
224   # Report and error to the user
225   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
226   #  rather than only a status code and having the web engine make up a 
227   #  phrase from that, we can also put the error message into the status
228   #  message. For now, rails won't let us)
229   def report_error(message, status = :bad_request)
230     # Todo: some sort of escaping of problem characters in the message
231     response.headers['Error'] = message
232
233     if request.headers['X-Error-Format'] and
234        request.headers['X-Error-Format'].downcase == "xml"
235       result = OSM::API.new.get_xml_doc
236       result.root.name = "osmError"
237       result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
238       result.root << (XML::Node.new("message") << message)
239
240       render :text => result.to_s, :content_type => "text/xml"
241     else
242       render :text => message, :status => status
243     end
244   end
245   
246   def set_locale
247     response.header['Vary'] = 'Accept-Language'
248
249     if @user
250       if !@user.languages.empty?
251         request.user_preferred_languages = @user.languages
252         response.header['Vary'] = '*'
253       elsif !request.user_preferred_languages.empty?
254         @user.languages = request.user_preferred_languages
255         @user.save
256       end
257     end
258
259     if request.compatible_language_from(I18n.available_locales).nil?
260       request.user_preferred_languages = request.user_preferred_languages.collect do |pl|
261         pls = [ pl ]
262
263         while pl.match(/^(.*)-[^-]+$/)
264           pls.push($1) if I18n.available_locales.include?($1.to_sym)
265           pl = $1
266         end
267
268         pls
269       end.flatten
270
271       if @user and not request.compatible_language_from(I18n.available_locales).nil?
272         @user.languages = request.user_preferred_languages
273         @user.save        
274       end
275     end
276
277     I18n.locale = request.compatible_language_from(I18n.available_locales) || I18n.default_locale
278
279     response.headers['Content-Language'] = I18n.locale.to_s
280   end
281
282   def api_call_handle_error
283     begin
284       yield
285     rescue ActiveRecord::RecordNotFound => ex
286       render :nothing => true, :status => :not_found
287     rescue LibXML::XML::Error, ArgumentError => ex
288       report_error ex.message, :bad_request
289     rescue ActiveRecord::RecordInvalid => ex
290       message = "#{ex.record.class} #{ex.record.id}: "
291       ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
292       report_error message, :bad_request
293     rescue OSM::APIError => ex
294       report_error ex.message, ex.status
295     rescue AbstractController::ActionNotFound => ex
296       raise
297     rescue Exception => ex
298       logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
299       ex.backtrace.each { |l| logger.info(l) }
300       report_error "#{ex.class}: #{ex.message}", :internal_server_error
301     end
302   end
303
304   ##
305   # asserts that the request method is the +method+ given as a parameter
306   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
307   def assert_method(method)
308     ok = request.send((method.to_s.downcase + "?").to_sym)
309     raise OSM::APIBadMethodError.new(method) unless ok
310   end
311
312   ##
313   # wrap an api call in a timeout
314   def api_call_timeout
315     OSM::Timer.timeout(API_TIMEOUT) do
316       yield
317     end
318   rescue Timeout::Error
319     raise OSM::APITimeoutError
320   end
321
322   ##
323   # wrap a web page in a timeout
324   def web_timeout
325     OSM::Timer.timeout(WEB_TIMEOUT) do
326       yield
327     end
328   rescue ActionView::Template::Error => ex
329     ex = ex.original_exception
330
331     if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /^Timeout::Error/
332       ex = Timeout::Error.new
333     end
334
335     if ex.is_a?(Timeout::Error)
336       render :action => "timeout"
337     else
338       raise
339     end
340   rescue Timeout::Error
341     render :action => "timeout"
342   end
343
344   ##
345   # extend caches_action to include the parameters, locale and logged in
346   # status in all cache keys
347   def self.caches_action(*actions)
348     options = actions.extract_options!
349     cache_path = options[:cache_path] || Hash.new
350
351     options[:unless] = case options[:unless]
352                        when NilClass then Array.new
353                        when Array then options[:unless]
354                        else unlessp = [ options[:unless] ]
355                        end
356
357     options[:unless].push(Proc.new do |controller|
358       controller.params.include?(:page)
359     end)
360
361     options[:cache_path] = Proc.new do |controller|
362       cache_path.merge(controller.params).merge(:host => SERVER_URL, :locale => I18n.locale)
363     end
364
365     actions.push(options)
366
367     super *actions
368   end
369
370   ##
371   # extend expire_action to expire all variants
372   def expire_action(options = {})
373     I18n.available_locales.each do |locale|
374       super options.merge(:host => SERVER_URL, :locale => locale)
375     end
376   end
377
378   ##
379   # is the requestor logged in?
380   def logged_in?
381     !@user.nil?
382   end
383
384   ##
385   # ensure that there is a "this_user" instance variable
386   def lookup_this_user
387     unless @this_user = User.active.find_by_display_name(params[:display_name])
388       render_unknown_user params[:display_name]
389     end
390   end
391
392   ##
393   # render a "no such user" page
394   def render_unknown_user(name)
395     @title = t "user.no_such_user.title"
396     @not_found_user = name
397
398     render :template => "user/no_such_user", :status => :not_found
399   end
400   
401 private 
402
403   # extract authorisation credentials from headers, returns user = nil if none
404   def get_auth_data 
405     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 
406       authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split 
407     elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi 
408       authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split 
409     elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
410       authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
411     end 
412     # only basic authentication supported
413     if authdata and authdata[0] == 'Basic' 
414       user, pass = Base64.decode64(authdata[1]).split(':',2)
415     end 
416     return [user, pass] 
417   end 
418
419   # used by oauth plugin to get the current user
420   def current_user
421     @user
422   end
423
424   # used by oauth plugin to set the current user
425   def current_user=(user)
426     @user=user
427   end
428
429   # override to stop oauth plugin sending errors
430   def invalid_oauth_response
431   end
432
433 end