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