Mark some extra methods as needing write access to the database
[rails.git] / app / controllers / user_controller.rb
1 class UserController < ApplicationController
2   layout :choose_layout
3
4   skip_before_filter :verify_authenticity_token, :only => [:api_details, :api_gpx_files]
5   before_filter :disable_terms_redirect, :only => [:terms, :save, :logout, :api_details]
6   before_filter :authorize, :only => [:api_details, :api_gpx_files]
7   before_filter :authorize_web, :except => [:api_details, :api_gpx_files]
8   before_filter :set_locale, :except => [:api_details, :api_gpx_files]
9   before_filter :require_user, :only => [:account, :go_public, :make_friend, :remove_friend]
10   before_filter :check_database_readable, :except => [:login, :api_details, :api_gpx_files]
11   before_filter :check_database_writable, :only => [:new, :account, :confirm, :confirm_email, :go_public, :make_friend, :remove_friend]
12   before_filter :check_api_readable, :only => [:api_details, :api_gpx_files]
13   before_filter :require_allow_read_prefs, :only => [:api_details]
14   before_filter :require_allow_read_gpx, :only => [:api_gpx_files]
15   before_filter :require_cookies, :only => [:login, :confirm]
16   before_filter :require_administrator, :only => [:set_status, :delete, :list]
17   before_filter :lookup_this_user, :only => [:set_status, :delete]
18
19   cache_sweeper :user_sweeper, :only => [:account, :set_status, :delete]
20
21   def terms
22     @legale = params[:legale] || OSM.IPToCountry(request.remote_ip) || DEFAULT_LEGALE
23     @text = OSM.legal_text_for_country(@legale)
24
25     if request.xhr?
26       render :partial => "terms"
27     elsif using_open_id?
28       # The redirect from the OpenID provider reenters here
29       # again and we need to pass the parameters through to
30       # the open_id_authentication function
31       @user = session.delete(:new_user)
32
33       openid_verify(nil, @user) do |user|
34       end
35
36       if @user.openid_url.nil? or @user.invalid?
37         render :action => 'new'
38       else
39         render :action => 'terms'
40       end
41     elsif params[:user] and Acl.no_account_creation(request.remote_ip, params[:user][:email].split("@").last)
42       render :action => 'blocked'
43     else
44       session[:referer] = params[:referer]
45
46       @title = t 'user.terms.title'
47       @user = User.new(params[:user]) if params[:user]
48
49       if params[:user] and params[:user][:openid_url] and @user.pass_crypt.empty?
50         # We are creating an account with OpenID and no password
51         # was specified so create a random one
52         @user.pass_crypt = SecureRandom.base64(16) 
53         @user.pass_crypt_confirmation = @user.pass_crypt 
54       end
55
56       if @user
57         if @user.invalid?
58           if @user.new_record?
59             # Something is wrong with a new user, so rerender the form
60             render :action => :new
61           else
62             # Error in existing user, so go to account settings
63             flash[:errors] = @user.errors
64             redirect_to :action => :account, :display_name => @user.display_name
65           end
66         elsif @user.terms_agreed?
67           # Already agreed to terms, so just show settings
68           redirect_to :action => :account, :display_name => @user.display_name
69         elsif params[:user] and params[:user][:openid_url] and not params[:user][:openid_url].empty?
70           # Verify OpenID before moving on
71           session[:new_user] = @user
72           openid_verify(params[:user][:openid_url], @user)
73         end
74       else
75         # Not logged in, so redirect to the login page
76         redirect_to :action => :login, :referer => request.fullpath
77       end
78     end
79   end
80
81   def save
82     @title = t 'user.new.title'
83
84     if params[:decline]
85       if @user
86         @user.terms_seen = true
87
88         if @user.save
89           flash[:notice] = t 'user.new.terms declined', :url => t('user.new.terms declined url')
90         end
91
92         if params[:referer]
93           redirect_to params[:referer]
94         else
95           redirect_to :action => :account, :display_name => @user.display_name
96         end
97       else
98         redirect_to t('user.terms.declined')
99       end
100     elsif @user
101       if !@user.terms_agreed?
102         @user.consider_pd = params[:user][:consider_pd]
103         @user.terms_agreed = Time.now.getutc
104         @user.terms_seen = true
105         if @user.save
106           flash[:notice] = t 'user.new.terms accepted'
107         end
108       end
109
110       if params[:referer]
111         redirect_to params[:referer]
112       else
113         redirect_to :action => :account, :display_name => @user.display_name
114       end
115     elsif Acl.no_account_creation(request.remote_ip, params[:user][:email].split("@").last)
116       render :action => 'blocked'
117     else
118       @user = User.new(params[:user])
119
120       @user.status = "pending"
121       @user.data_public = true
122       @user.description = "" if @user.description.nil?
123       @user.creation_ip = request.remote_ip
124       @user.languages = request.user_preferred_languages
125       @user.terms_agreed = Time.now.getutc
126       @user.terms_seen = true
127       @user.openid_url = nil if @user.openid_url and @user.openid_url.empty?
128       
129       if @user.save
130         flash[:piwik_goal] = PIWIK_SIGNUP_GOAL if defined?(PIWIK_SIGNUP_GOAL)
131         flash[:notice] = t 'user.new.flash create success message', :email => @user.email
132         Notifier.signup_confirm(@user, @user.tokens.create(:referer => session.delete(:referer))).deliver
133         session[:token] = @user.tokens.create.token
134         redirect_to :action => 'login', :referer => params[:referer]
135       else
136         render :action => 'new', :referer => params[:referer]
137       end
138     end
139   end
140
141   def account
142     @title = t 'user.account.title'
143     @tokens = @user.oauth_tokens.authorized
144
145     if params[:user] and params[:user][:display_name] and params[:user][:description]
146       @user.display_name = params[:user][:display_name]
147       @user.new_email = params[:user][:new_email]
148
149       if params[:user][:pass_crypt].length > 0 or params[:user][:pass_crypt_confirmation].length > 0
150         @user.pass_crypt = params[:user][:pass_crypt]
151         @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
152       end
153
154       if params[:user][:description] != @user.description
155         @user.description = params[:user][:description]
156         @user.description_format = "markdown"
157       end
158
159       @user.languages = params[:user][:languages].split(",")
160
161       case params[:image_action]
162         when "new" then @user.image = params[:user][:image]
163         when "delete" then @user.image = nil
164       end
165
166       @user.home_lat = params[:user][:home_lat]
167       @user.home_lon = params[:user][:home_lon]
168
169       if params[:user][:preferred_editor] == "default"
170         @user.preferred_editor = nil
171       else
172         @user.preferred_editor = params[:user][:preferred_editor]
173       end
174
175       @user.openid_url = nil if params[:user][:openid_url].blank?
176
177       if params[:user][:openid_url] and
178          params[:user][:openid_url].length > 0 and
179          params[:user][:openid_url] != @user.openid_url
180         # If the OpenID has changed, we want to check that it is a
181         # valid OpenID and one the user has control over before saving
182         # it as a password equivalent for the user.
183         session[:new_user] = @user
184         openid_verify(params[:user][:openid_url], @user)
185       else
186         update_user(@user)
187       end
188     elsif using_open_id?
189       # The redirect from the OpenID provider reenters here
190       # again and we need to pass the parameters through to
191       # the open_id_authentication function
192       @user = session.delete(:new_user)
193       openid_verify(nil, @user) do |user|
194         update_user(user)
195       end
196     end
197   end
198
199   def go_public
200     @user.data_public = true
201     @user.save
202     flash[:notice] = t 'user.go_public.flash success'
203     redirect_to :controller => 'user', :action => 'account', :display_name => @user.display_name
204   end
205
206   def lost_password
207     @title = t 'user.lost_password.title'
208
209     if params[:user] and params[:user][:email]
210       user = User.visible.find_by_email(params[:user][:email])
211
212       if user.nil?
213         users = User.visible.where("LOWER(email) = LOWER(?)", params[:user][:email])
214
215         if users.count == 1
216           user = users.first
217         end
218       end
219
220       if user
221         token = user.tokens.create
222         Notifier.lost_password(user, token).deliver
223         flash[:notice] = t 'user.lost_password.notice email on way'
224         redirect_to :action => 'login'
225       else
226         flash.now[:error] = t 'user.lost_password.notice email cannot find'
227       end
228     end
229   end
230
231   def reset_password
232     @title = t 'user.reset_password.title'
233
234     if params[:token]
235       token = UserToken.find_by_token(params[:token])
236
237       if token
238         @user = token.user
239
240         if params[:user]
241           @user.pass_crypt = params[:user][:pass_crypt]
242           @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
243           @user.status = "active" if @user.status == "pending"
244           @user.email_valid = true
245
246           if @user.save
247             token.destroy
248             flash[:notice] = t 'user.reset_password.flash changed'
249             redirect_to :action => 'login'
250           end
251         end
252       else
253         flash[:error] = t 'user.reset_password.flash token bad'
254         redirect_to :action => 'lost_password'
255       end
256     end
257   end
258
259   def new
260     @title = t 'user.new.title'
261     @referer = params[:referer] || session[:referer]
262
263     if @user
264       # The user is logged in already, so don't show them the signup
265       # page, instead send them to the home page
266       if @referer
267         redirect_to @referer
268       else
269         redirect_to :controller => 'site', :action => 'index'
270       end
271     elsif params.key?(:openid)
272       @user = User.new(:email => params[:email],
273                        :email_confirmation => params[:email],
274                        :display_name => params[:nickname],
275                        :openid_url => params[:openid])
276
277       flash.now[:notice] = t 'user.new.openid association'
278     elsif Acl.no_account_creation(request.remote_ip)
279       render :action => 'blocked'
280     end
281   end
282
283   def login
284     if params[:username] or using_open_id?
285       session[:remember_me] ||= params[:remember_me]
286       session[:referer] ||= params[:referer]
287
288       if using_open_id?
289         openid_authentication(params[:openid_url])
290       else
291         password_authentication(params[:username], params[:password])
292       end
293     elsif params[:notice]
294       flash.now[:notice] = t "user.login.notice_#{params[:notice]}"
295     elsif flash[:notice].nil?
296       flash.now[:notice] =  t 'user.login.notice'
297     end
298   end
299
300   def logout
301     @title = t 'user.logout.title'
302
303     if params[:session] == request.session_options[:id]
304       if session[:token]
305         token = UserToken.find_by_token(session[:token])
306         if token
307           token.destroy
308         end
309         session.delete(:token)
310       end
311       session.delete(:user)
312       session_expires_automatically
313       if params[:referer]
314         redirect_to params[:referer]
315       else
316         redirect_to :controller => 'site', :action => 'index'
317       end
318     end
319   end
320
321   def confirm
322     if request.post?
323       if token = UserToken.find_by_token(params[:confirm_string])
324         if token.user.active?
325           flash[:error] = t('user.confirm.already active')
326           redirect_to :action => 'login'
327         else
328           user = token.user
329           user.status = "active"
330           user.email_valid = true
331           user.save!
332           referer = token.referer
333           token.destroy
334
335           if session[:token] 
336             token = UserToken.find_by_token(session[:token])
337             session.delete(:token)
338           else
339             token = nil
340           end
341
342           if token.nil? or token.user != user
343             flash[:notice] = t('user.confirm.success')
344             redirect_to :action => :login, :referer => referer
345           else
346             token.destroy
347
348             session[:user] = user.id
349             cookies.permanent["_osm_username"] = user.display_name
350
351             if referer.nil?
352               flash[:notice] = t('user.confirm.success') + "<br /><br />" + t('user.confirm.before you start')
353               redirect_to :action => :account, :display_name => user.display_name
354             else
355               flash[:notice] = t('user.confirm.success')
356               redirect_to referer
357             end
358           end
359         end
360       else
361         user = User.find_by_display_name(params[:display_name])
362
363         if user and user.active?
364           flash[:error] = t('user.confirm.already active')
365         elsif user
366           flash[:error] = t('user.confirm.unknown token') + t('user.confirm.reconfirm', :reconfirm => url_for(:action => 'confirm_resend', :display_name => params[:display_name]))
367         else
368           flash[:error] = t('user.confirm.unknown token')
369         end
370
371         redirect_to :action => 'login'
372       end
373     end
374   end
375
376   def confirm_resend
377     if user = User.find_by_display_name(params[:display_name])
378       Notifier.signup_confirm(user, user.tokens.create).deliver
379       flash[:notice] = t 'user.confirm_resend.success', :email => user.email
380     else
381       flash[:notice] = t 'user.confirm_resend.failure', :name => params[:display_name]
382     end
383
384     redirect_to :action => 'login'
385   end
386
387   def confirm_email
388     if request.post?
389       token = UserToken.find_by_token(params[:confirm_string])
390       if token and token.user.new_email?
391         @user = token.user
392         @user.email = @user.new_email
393         @user.new_email = nil
394         @user.email_valid = true
395         if @user.save
396           flash[:notice] = t 'user.confirm_email.success'
397         else
398           flash[:errors] = @user.errors
399         end
400         token.destroy
401         session[:user] = @user.id
402         cookies.permanent["_osm_username"] = @user.display_name
403         redirect_to :action => 'account', :display_name => @user.display_name
404       else
405         flash[:error] = t 'user.confirm_email.failure'
406         redirect_to :action => 'account', :display_name => @user.display_name
407       end
408     end
409   end
410
411   def api_gpx_files
412     doc = OSM::API.new.get_xml_doc
413     @user.traces.each do |trace|
414       doc.root << trace.to_xml_node() if trace.public? or trace.user == @user
415     end
416     render :text => doc.to_s, :content_type => "text/xml"
417   end
418
419   def view
420     @this_user = User.find_by_display_name(params[:display_name])
421
422     if @this_user and
423        (@this_user.visible? or (@user and @user.administrator?))
424       @title = @this_user.display_name
425     else
426       render_unknown_user params[:display_name]
427     end
428   end
429
430   def make_friend
431     if params[:display_name]
432       name = params[:display_name]
433       new_friend = User.active.where(:display_name => name).first
434       friend = Friend.new
435       friend.user_id = @user.id
436       friend.friend_user_id = new_friend.id
437       unless @user.is_friends_with?(new_friend)
438         if friend.save
439           flash[:notice] = t 'user.make_friend.success', :name => name
440           Notifier.friend_notification(friend).deliver
441         else
442           friend.add_error(t('user.make_friend.failed', :name => name))
443         end
444       else
445         flash[:warning] = t 'user.make_friend.already_a_friend', :name => name
446       end
447
448       if params[:referer]
449         redirect_to params[:referer]
450       else
451         redirect_to :controller => 'user', :action => 'view'
452       end
453     end
454   end
455
456   def remove_friend
457     if params[:display_name]
458       name = params[:display_name]
459       friend = User.active.where(:display_name => name).first
460       if @user.is_friends_with?(friend)
461         Friend.delete_all "user_id = #{@user.id} AND friend_user_id = #{friend.id}"
462         flash[:notice] = t 'user.remove_friend.success', :name => friend.display_name
463       else
464         flash[:error] = t 'user.remove_friend.not_a_friend', :name => friend.display_name
465       end
466
467       if params[:referer]
468         redirect_to params[:referer]
469       else
470         redirect_to :controller => 'user', :action => 'view'
471       end
472     end
473   end
474
475   ##
476   # sets a user's status
477   def set_status
478     @this_user.status = params[:status]
479     @this_user.save
480     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
481   end
482
483   ##
484   # delete a user, marking them as deleted and removing personal data
485   def delete
486     @this_user.delete
487     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
488   end
489
490   ##
491   # display a list of users matching specified criteria
492   def list
493     if request.post?
494       ids = params[:user].keys.collect { |id| id.to_i }
495
496       User.update_all("status = 'confirmed'", :id => ids) if params[:confirm]
497       User.update_all("status = 'deleted'", :id => ids) if params[:hide]
498
499       redirect_to url_for(:status => params[:status], :ip => params[:ip], :page => params[:page])
500     else
501       conditions = Hash.new
502       conditions[:status] = params[:status] if params[:status]
503       conditions[:creation_ip] = params[:ip] if params[:ip]
504
505       @user_pages, @users = paginate(:users,
506                                      :conditions => conditions,
507                                      :order => :id,
508                                      :per_page => 50)
509     end
510   end
511
512 private
513
514   ##
515   # handle password authentication
516   def password_authentication(username, password)
517     if user = User.authenticate(:username => username, :password => password)
518       successful_login(user)
519     elsif user = User.authenticate(:username => username, :password => password, :pending => true)
520       failed_login t('user.login.account not active', :reconfirm => url_for(:action => 'confirm_resend', :display_name => user.display_name))
521     elsif User.authenticate(:username => username, :password => password, :suspended => true)
522       failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
523     else
524       failed_login t('user.login.auth failure')
525     end
526   end
527
528   ##
529   # handle OpenID authentication
530   def openid_authentication(openid_url)
531     # If we don't appear to have a user for this URL then ask the
532     # provider for some extra information to help with signup
533     if openid_url and User.find_by_openid_url(openid_url)
534       required = nil
535     else
536       required = [:nickname, :email, "http://axschema.org/namePerson/friendly", "http://axschema.org/contact/email"]
537     end
538
539     # Start the authentication
540     authenticate_with_open_id(openid_expand_url(openid_url), :method => :get, :required => required) do |result, identity_url, sreg, ax|
541       if result.successful?
542         # We need to use the openid url passed back from the OpenID provider
543         # rather than the one supplied by the user, as these can be different.
544         #
545         # For example, you can simply enter yahoo.com in the login box rather
546         # than a user specific url. Only once it comes back from the provider
547         # provider do we know the unique address for the user.
548         if user = User.find_by_openid_url(identity_url)
549           case user.status
550             when "pending" then
551               failed_login t('user.login.account not active')
552             when "active", "confirmed" then
553               successful_login(user)
554             when "suspended" then
555               failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
556             else
557               failed_login t('user.login.auth failure')
558           end
559         else
560           # Guard against not getting any extension data
561           sreg = Hash.new if sreg.nil?
562           ax = Hash.new if ax.nil?
563
564           # We don't have a user registered to this OpenID, so redirect
565           # to the create account page with username and email filled
566           # in if they have been given by the OpenID provider through
567           # the simple registration protocol.
568           nickname = sreg["nickname"] || ax["http://axschema.org/namePerson/friendly"]
569           email = sreg["email"] || ax["http://axschema.org/contact/email"]
570           redirect_to :controller => 'user', :action => 'new', :nickname => nickname, :email => email, :openid => identity_url
571         end
572       elsif result.missing?
573         failed_login t('user.login.openid missing provider')
574       elsif result.invalid?
575         failed_login t('user.login.openid invalid')
576       else
577         failed_login t('user.login.auth failure')
578       end
579     end
580   end
581
582   ##
583   # verify an OpenID URL
584   def openid_verify(openid_url, user)
585     user.openid_url = openid_url
586
587     authenticate_with_open_id(openid_expand_url(openid_url), :method => :get) do |result, identity_url|
588       if result.successful?
589         # We need to use the openid url passed back from the OpenID provider
590         # rather than the one supplied by the user, as these can be different.
591         #
592         # For example, you can simply enter yahoo.com in the login box rather
593         # than a user specific url. Only once it comes back from the provider
594         # provider do we know the unique address for the user.
595         user.openid_url = identity_url
596         yield user
597       elsif result.missing?
598         flash.now[:error] = t 'user.login.openid missing provider'
599       elsif result.invalid?
600         flash.now[:error] = t 'user.login.openid invalid'
601       else
602         flash.now[:error] = t 'user.login.auth failure'
603       end
604     end
605   end
606
607   ##
608   # special case some common OpenID providers by applying heuristics to
609   # try and come up with the correct URL based on what the user entered
610   def openid_expand_url(openid_url)
611     if openid_url.nil?
612       return nil
613     elsif openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
614       # Special case gmail.com as it is potentially a popular OpenID
615       # provider and, unlike yahoo.com, where it works automatically, Google
616       # have hidden their OpenID endpoint somewhere obscure this making it
617       # somewhat less user friendly.
618       return 'https://www.google.com/accounts/o8/id'
619     else
620       return openid_url
621     end
622   end  
623
624   ##
625   # process a successful login
626   def successful_login(user)
627     cookies.permanent["_osm_username"] = user.display_name
628
629     session[:user] = user.id
630     session_expires_after 28.days if session[:remember_me]
631
632     target = session[:referer] || url_for(:controller => :site, :action => :index)
633
634     # The user is logged in, so decide where to send them:
635     #
636     # - If they haven't seen the contributor terms, send them there.
637     # - If they have a block on them, show them that.
638     # - If they were referred to the login, send them back there.
639     # - Otherwise, send them to the home page.
640     if REQUIRE_TERMS_SEEN and not user.terms_seen
641       redirect_to :controller => :user, :action => :terms, :referer => target
642     elsif user.blocked_on_view
643       redirect_to user.blocked_on_view, :referer => target
644     else
645       redirect_to target
646     end
647
648     session.delete(:remember_me)
649     session.delete(:referer)
650   end
651
652   ##
653   # process a failed login
654   def failed_login(message)
655     flash[:error] = message
656
657     redirect_to :action => 'login', :referer =>  session[:referer]
658
659     session.delete(:remember_me)
660     session.delete(:referer)
661   end
662
663   ##
664   # update a user's details
665   def update_user(user)
666     if user.save
667       set_locale
668
669       cookies.permanent["_osm_username"] = user.display_name
670
671       if user.new_email.blank?
672         flash.now[:notice] = t 'user.account.flash update success'
673       else
674         user.email = user.new_email
675
676         if user.valid?
677           flash.now[:notice] = t 'user.account.flash update success confirm needed'
678
679           begin
680             Notifier.email_confirm(user, user.tokens.create).deliver
681           rescue
682             # Ignore errors sending email
683           end
684         else
685           @user.errors.set(:new_email, @user.errors.get(:email))
686           @user.errors.set(:email, [])
687         end
688
689         user.reset_email!
690       end
691     end
692   end
693
694   ##
695   # require that the user is a administrator, or fill out a helpful error message
696   # and return them to the user page.
697   def require_administrator
698     if @user and not @user.administrator?
699       flash[:error] = t('user.filter.not_an_administrator')
700
701       if params[:display_name]
702         redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
703       else
704         redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
705       end
706     elsif not @user
707       redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
708     end
709   end
710
711   ##
712   # ensure that there is a "this_user" instance variable
713   def lookup_this_user
714     @this_user = User.find_by_display_name(params[:display_name])
715   rescue ActiveRecord::RecordNotFound
716     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name] unless @this_user
717   end
718
719   ##
720   # Choose the layout to use. See
721   # https://rails.lighthouseapp.com/projects/8994/tickets/5371-layout-with-onlyexcept-options-makes-other-actions-render-without-layouts
722   def choose_layout
723     oauth_url = url_for(:controller => :oauth, :action => :authorize, :only_path => true)
724
725     if [ 'api_details' ].include? action_name
726       nil
727     elsif params[:referer] and URI.parse(params[:referer]).path == oauth_url
728       'slim'
729     else
730       'site'
731     end
732   end
733
734   ##
735   #
736   def disable_terms_redirect
737     # this is necessary otherwise going to the user terms page, when 
738     # having not agreed already would cause an infinite redirect loop.
739     # it's .now so that this doesn't propagate to other pages.
740     flash.now[:skip_terms] = true
741   end
742 end