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