86689644c8032b5139aae2dcfa7b5ed1dabd75c8
[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 :update do |page|
27         page.replace_html "contributorTerms", :partial => "terms"
28       end
29     elsif using_open_id?
30       # The redirect from the OpenID provider reenters here
31       # again and we need to pass the parameters through to
32       # the open_id_authentication function
33       @user = session.delete(:new_user)
34
35       openid_verify(nil, @user) do |user|
36       end
37
38       if @user.openid_url.nil? or @user.invalid?
39         render :action => 'new'
40       else
41         render :action => 'terms'
42       end
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 Acl.address(request.remote_ip).where(:k => "no_account_creation").exists?
85       render :action => 'new'
86     elsif params[:decline]
87       if @user
88         @user.terms_seen = true
89
90         if @user.save
91           flash[:notice] = t 'user.new.terms declined', :url => t('user.new.terms declined url')
92         end
93
94         if params[:referer]
95           redirect_to params[:referer]
96         else
97           redirect_to :action => :account, :display_name => @user.display_name
98         end
99       else
100         redirect_to t('user.terms.declined')
101       end
102     elsif @user
103       if !@user.terms_agreed?
104         @user.consider_pd = params[:user][:consider_pd]
105         @user.terms_agreed = Time.now.getutc
106         @user.terms_seen = true
107         if @user.save
108           flash[:notice] = t 'user.new.terms accepted'
109         end
110       end
111
112       if params[:referer]
113         redirect_to params[:referer]
114       else
115         redirect_to :action => :account, :display_name => @user.display_name
116       end
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       @user.description = params[:user][:description]
155       @user.languages = params[:user][:languages].split(",")
156
157       case params[:image_action]
158         when "new" then @user.image = params[:user][:image]
159         when "delete" then @user.image = nil
160       end
161
162       @user.home_lat = params[:user][:home_lat]
163       @user.home_lon = params[:user][:home_lon]
164
165       if params[:user][:preferred_editor] == "default"
166         @user.preferred_editor = nil
167       else
168         @user.preferred_editor = params[:user][:preferred_editor]
169       end
170
171       @user.openid_url = nil if params[:user][:openid_url].empty?
172
173       if params[:user][:openid_url].length > 0 and
174          params[:user][:openid_url] != @user.openid_url
175         # If the OpenID has changed, we want to check that it is a
176         # valid OpenID and one the user has control over before saving
177         # it as a password equivalent for the user.
178         session[:new_user] = @user
179         openid_verify(params[:user][:openid_url], @user)
180       else
181         update_user(@user)
182       end
183     elsif using_open_id?
184       # The redirect from the OpenID provider reenters here
185       # again and we need to pass the parameters through to
186       # the open_id_authentication function
187       @user = session.delete(:new_user)
188       openid_verify(nil, @user) do |user|
189         update_user(user)
190       end
191     else
192       if flash[:errors]
193         flash[:errors].each do |attr,msg|
194           attr = "new_email" if attr == "email" and !@user.new_email.nil?
195           @user.errors.add(attr,msg)
196         end
197       end
198     end
199   end
200
201   def go_public
202     @user.data_public = true
203     @user.save
204     flash[:notice] = t 'user.go_public.flash success'
205     redirect_to :controller => 'user', :action => 'account', :display_name => @user.display_name
206   end
207
208   def lost_password
209     @title = t 'user.lost_password.title'
210
211     if params[:user] and params[:user][:email]
212       user = User.visible.where(:email => params[:user][:email]).first
213
214       if user
215         token = user.tokens.create
216         Notifier.lost_password(user, token).deliver
217         flash[:notice] = t 'user.lost_password.notice email on way'
218         redirect_to :action => 'login'
219       else
220         flash.now[:error] = t 'user.lost_password.notice email cannot find'
221       end
222     end
223   end
224
225   def reset_password
226     @title = t 'user.reset_password.title'
227
228     if params[:token]
229       token = UserToken.find_by_token(params[:token])
230
231       if token
232         @user = token.user
233
234         if params[:user]
235           @user.pass_crypt = params[:user][:pass_crypt]
236           @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
237           @user.status = "active" if @user.status == "pending"
238           @user.email_valid = true
239
240           if @user.save
241             token.destroy
242             flash[:notice] = t 'user.reset_password.flash changed'
243             redirect_to :action => 'login'
244           end
245         end
246       else
247         flash[:error] = t 'user.reset_password.flash token bad'
248         redirect_to :action => 'lost_password'
249       end
250     end
251   end
252
253   def new
254     @title = t 'user.new.title'
255     @referer = params[:referer] || session[:referer]
256     @user = User.new(:email => params[:email],
257                      :email_confirmation => params[:email],
258                      :display_name => params[:nickname],
259                      :openid_url => params[:openid])
260
261     if session[:user]
262       # The user is logged in already, so don't show them the signup
263       # page, instead send them to the home page
264       redirect_to :controller => 'site', :action => 'index'
265     elsif not params['openid'].nil?
266       flash.now[:notice] = t 'user.new.openid association'
267     end
268   end
269
270   def login
271     if params[:username] or using_open_id?
272       session[:remember_me] ||= params[:remember_me]
273       session[:referer] ||= params[:referer]
274
275       if using_open_id?
276         openid_authentication(params[:openid_url])
277       else
278         password_authentication(params[:username], params[:password])
279       end
280     elsif flash[:notice].nil?
281       flash.now[:notice] =  t 'user.login.notice'
282     end
283   end
284
285   def logout
286     @title = t 'user.logout.title'
287
288     if params[:session] == request.session_options[:id]
289       if session[:token]
290         token = UserToken.find_by_token(session[:token])
291         if token
292           token.destroy
293         end
294         session.delete(:token)
295       end
296       session.delete(:user)
297       session_expires_automatically
298       if params[:referer]
299         redirect_to params[:referer]
300       else
301         redirect_to :controller => 'site', :action => 'index'
302       end
303     end
304   end
305
306   def confirm
307     if request.post?
308       if token = UserToken.find_by_token(params[:confirm_string])
309         if token.user.active?
310           flash[:error] = t('user.confirm.already active')
311           redirect_to :action => 'login'
312         else
313           user = token.user
314           user.status = "active"
315           user.email_valid = true
316           user.save!
317           referer = token.referer
318           token.destroy
319
320           if session[:token] 
321             token = UserToken.find_by_token(session[:token])
322             session.delete(:token)
323           else
324             token = nil
325           end
326
327           if token.nil? or token.user != user
328             flash[:notice] = t('user.confirm.success')
329             redirect_to :action => :login, :referer => referer
330           else
331             token.destroy
332
333             session[:user] = user.id
334
335             if referer.nil?
336               flash[:notice] = t('user.confirm.success') + "<br /><br />" + t('user.confirm.before you start')
337               redirect_to :action => :account, :display_name => user.display_name
338             else
339               flash[:notice] = t('user.confirm.success')
340               redirect_to referer
341             end
342           end
343         end
344       else
345         user = User.find_by_display_name(params[:display_name])
346
347         if user and user.active?
348           flash[:error] = t('user.confirm.already active')
349         elsif user
350           flash[:error] = t('user.confirm.unknown token') + t('user.confirm.reconfirm', :reconfirm => url_for(:action => 'confirm_resend', :display_name => params[:display_name]))
351         else
352           flash[:error] = t('user.confirm.unknown token')
353         end
354
355         redirect_to :action => 'login'
356       end
357     end
358   end
359
360   def confirm_resend
361     if user = User.find_by_display_name(params[:display_name])
362       Notifier.signup_confirm(user, user.tokens.create).deliver
363       flash[:notice] = t 'user.confirm_resend.success', :email => user.email
364     else
365       flash[:notice] = t 'user.confirm_resend.failure', :name => params[:display_name]
366     end
367
368     redirect_to :action => 'login'
369   end
370
371   def confirm_email
372     if request.post?
373       token = UserToken.find_by_token(params[:confirm_string])
374       if token and token.user.new_email?
375         @user = token.user
376         @user.email = @user.new_email
377         @user.new_email = nil
378         @user.email_valid = true
379         if @user.save
380           flash[:notice] = t 'user.confirm_email.success'
381         else
382           flash[:errors] = @user.errors
383         end
384         token.destroy
385         session[:user] = @user.id
386         redirect_to :action => 'account', :display_name => @user.display_name
387       else
388         flash[:error] = t 'user.confirm_email.failure'
389         redirect_to :action => 'account', :display_name => @user.display_name
390       end
391     end
392   end
393
394   def api_gpx_files
395     doc = OSM::API.new.get_xml_doc
396     @user.traces.each do |trace|
397       doc.root << trace.to_xml_node() if trace.public? or trace.user == @user
398     end
399     render :text => doc.to_s, :content_type => "text/xml"
400   end
401
402   def view
403     @this_user = User.find_by_display_name(params[:display_name])
404
405     if @this_user and
406        (@this_user.visible? or (@user and @user.administrator?))
407       @title = @this_user.display_name
408     else
409       @title = t 'user.no_such_user.title'
410       @not_found_user = params[:display_name]
411       render :action => 'no_such_user', :status => :not_found
412     end
413   end
414
415   def make_friend
416     if params[:display_name]
417       name = params[:display_name]
418       new_friend = User.active.where(:display_name => name).first
419       friend = Friend.new
420       friend.user_id = @user.id
421       friend.friend_user_id = new_friend.id
422       unless @user.is_friends_with?(new_friend)
423         if friend.save
424           flash[:notice] = t 'user.make_friend.success', :name => name
425           Notifier.friend_notification(friend).deliver
426         else
427           friend.add_error(t('user.make_friend.failed', :name => name))
428         end
429       else
430         flash[:warning] = t 'user.make_friend.already_a_friend', :name => name
431       end
432
433       if params[:referer]
434         redirect_to params[:referer]
435       else
436         redirect_to :controller => 'user', :action => 'view'
437       end
438     end
439   end
440
441   def remove_friend
442     if params[:display_name]
443       name = params[:display_name]
444       friend = User.active.where(:display_name => name).first
445       if @user.is_friends_with?(friend)
446         Friend.delete_all "user_id = #{@user.id} AND friend_user_id = #{friend.id}"
447         flash[:notice] = t 'user.remove_friend.success', :name => friend.display_name
448       else
449         flash[:error] = t 'user.remove_friend.not_a_friend', :name => friend.display_name
450       end
451
452       if params[:referer]
453         redirect_to params[:referer]
454       else
455         redirect_to :controller => 'user', :action => 'view'
456       end
457     end
458   end
459
460   ##
461   # sets a user's status
462   def set_status
463     @this_user.update_attributes(:status => params[:status])
464     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
465   end
466
467   ##
468   # delete a user, marking them as deleted and removing personal data
469   def delete
470     @this_user.delete
471     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
472   end
473
474   ##
475   # display a list of users matching specified criteria
476   def list
477     if request.post?
478       ids = params[:user].keys.collect { |id| id.to_i }
479
480       User.update_all("status = 'confirmed'", :id => ids) if params[:confirm]
481       User.update_all("status = 'deleted'", :id => ids) if params[:hide]
482
483       redirect_to url_for(:status => params[:status], :ip => params[:ip], :page => params[:page])
484     else
485       conditions = Hash.new
486       conditions[:status] = params[:status] if params[:status]
487       conditions[:creation_ip] = params[:ip] if params[:ip]
488
489       @user_pages, @users = paginate(:users,
490                                      :conditions => conditions,
491                                      :order => :id,
492                                      :per_page => 50)
493     end
494   end
495
496 private
497
498   ##
499   # handle password authentication
500   def password_authentication(username, password)
501     if user = User.authenticate(:username => username, :password => password)
502       successful_login(user)
503     elsif user = User.authenticate(:username => username, :password => password, :pending => true)
504       failed_login t('user.login.account not active', :reconfirm => url_for(:action => 'confirm_resend', :display_name => user.display_name))
505     elsif User.authenticate(:username => username, :password => password, :suspended => true)
506       webmaster = link_to t('user.login.webmaster'), "mailto:webmaster@openstreetmap.org"
507       failed_login t('user.login.account suspended', :webmaster => webmaster)
508     else
509       failed_login t('user.login.auth failure')
510     end
511   end
512
513   ##
514   # handle OpenID authentication
515   def openid_authentication(openid_url)
516     # If we don't appear to have a user for this URL then ask the
517     # provider for some extra information to help with signup
518     if openid_url and User.find_by_openid_url(openid_url)
519       required = nil
520     else
521       required = [:nickname, :email, "http://axschema.org/namePerson/friendly", "http://axschema.org/contact/email"]
522     end
523
524     # Start the authentication
525     authenticate_with_open_id(openid_expand_url(openid_url), :required => required) do |result, identity_url, sreg, ax|
526       if result.successful?
527         # We need to use the openid url passed back from the OpenID provider
528         # rather than the one supplied by the user, as these can be different.
529         #
530         # For example, you can simply enter yahoo.com in the login box rather
531         # than a user specific url. Only once it comes back from the provider
532         # provider do we know the unique address for the user.
533         if user = User.find_by_openid_url(identity_url)
534           case user.status
535             when "pending" then
536               failed_login t('user.login.account not active')
537             when "active", "confirmed" then
538               successful_login(user)
539             when "suspended" then
540               webmaster = link_to t('user.login.webmaster'), "mailto:webmaster@openstreetmap.org"
541               failed_login t('user.login.account suspended', :webmaster => webmaster)
542             else
543               failed_login t('user.login.auth failure')
544           end
545         else
546           # Guard against not getting any extension data
547           sreg = Hash.new if sreg.nil?
548           ax = Hash.new if ax.nil?
549
550           # We don't have a user registered to this OpenID, so redirect
551           # to the create account page with username and email filled
552           # in if they have been given by the OpenID provider through
553           # the simple registration protocol.
554           nickname = sreg["nickname"] || ax["http://axschema.org/namePerson/friendly"]
555           email = sreg["email"] || ax["http://axschema.org/contact/email"]
556           redirect_to :controller => 'user', :action => 'new', :nickname => nickname, :email => email, :openid => identity_url
557         end
558       elsif result.missing?
559         failed_login t('user.login.openid missing provider')
560       elsif result.invalid?
561         failed_login t('user.login.openid invalid')
562       else
563         failed_login t('user.login.auth failure')
564       end
565     end
566   end
567
568   ##
569   # verify an OpenID URL
570   def openid_verify(openid_url, user)
571     user.openid_url = openid_url
572
573     authenticate_with_open_id(openid_expand_url(openid_url)) do |result, identity_url|
574       if result.successful?
575         # We need to use the openid url passed back from the OpenID provider
576         # rather than the one supplied by the user, as these can be different.
577         #
578         # For example, you can simply enter yahoo.com in the login box rather
579         # than a user specific url. Only once it comes back from the provider
580         # provider do we know the unique address for the user.
581         user.openid_url = identity_url
582         yield user
583       elsif result.missing?
584         flash.now[:error] = t 'user.login.openid missing provider'
585       elsif result.invalid?
586         flash.now[:error] = t 'user.login.openid invalid'
587       else
588         flash.now[:error] = t 'user.login.auth failure'
589       end
590     end
591   end
592
593   ##
594   # special case some common OpenID providers by applying heuristics to
595   # try and come up with the correct URL based on what the user entered
596   def openid_expand_url(openid_url)
597     if openid_url.nil?
598       return nil
599     elsif openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
600       # Special case gmail.com as it is potentially a popular OpenID
601       # provider and, unlike yahoo.com, where it works automatically, Google
602       # have hidden their OpenID endpoint somewhere obscure this making it
603       # somewhat less user friendly.
604       return 'https://www.google.com/accounts/o8/id'
605     else
606       return openid_url
607     end
608   end  
609
610   ##
611   # process a successful login
612   def successful_login(user)
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.nil? or user.new_email.empty?
654         flash.now[:notice] = t 'user.account.flash update success'
655       else
656         flash.now[:notice] = t 'user.account.flash update success confirm needed'
657
658         begin
659           Notifier.email_confirm(user, user.tokens.create).deliver
660         rescue
661           # Ignore errors sending email
662         end
663       end
664     end
665   end
666
667   ##
668   # require that the user is a administrator, or fill out a helpful error message
669   # and return them to the user page.
670   def require_administrator
671     if @user and not @user.administrator?
672       flash[:error] = t('user.filter.not_an_administrator')
673
674       if params[:display_name]
675         redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
676       else
677         redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
678       end
679     elsif not @user
680       redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
681     end
682   end
683
684   ##
685   # ensure that there is a "this_user" instance variable
686   def lookup_this_user
687     @this_user = User.find_by_display_name(params[:display_name])
688   rescue ActiveRecord::RecordNotFound
689     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name] unless @this_user
690   end
691
692   ##
693   # Choose the layout to use. See
694   # https://rails.lighthouseapp.com/projects/8994/tickets/5371-layout-with-onlyexcept-options-makes-other-actions-render-without-layouts
695   def choose_layout
696     oauth_url = url_for(:controller => :oauth, :action => :oauthorize, :only_path => true)
697
698     if [ 'api_details' ].include? action_name
699       nil
700     elsif params[:referer] and URI.parse(params[:referer]).path == oauth_url
701       'slim'
702     else
703       'site'
704     end
705   end
706
707   ##
708   #
709   def disable_terms_redirect
710     # this is necessary otherwise going to the user terms page, when 
711     # having not agreed already would cause an infinite redirect loop.
712     # it's .now so that this doesn't propagate to other pages.
713     flash.now[:skip_terms] = true
714   end
715 end