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