5104715552b1bd77d5be860b0e0a18d9c852de58
[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
257     if @user
258       # The user is logged in already, so don't show them the signup
259       # page, instead send them to the home page
260       if @referer
261         redirect_to @referer
262       else
263         redirect_to :controller => 'site', :action => 'index'
264       end
265     elsif params.key?(:openid)
266       @user = User.new(:email => params[:email],
267                        :email_confirmation => params[:email],
268                        :display_name => params[:nickname],
269                        :openid_url => params[:openid])
270
271       flash.now[:notice] = t 'user.new.openid association'
272     end
273   end
274
275   def login
276     if params[:username] or using_open_id?
277       session[:remember_me] ||= params[:remember_me]
278       session[:referer] ||= params[:referer]
279
280       if using_open_id?
281         openid_authentication(params[:openid_url])
282       else
283         password_authentication(params[:username], params[:password])
284       end
285     elsif flash[:notice].nil?
286       flash.now[:notice] =  t 'user.login.notice'
287     end
288   end
289
290   def logout
291     @title = t 'user.logout.title'
292
293     if params[:session] == request.session_options[:id]
294       if session[:token]
295         token = UserToken.find_by_token(session[:token])
296         if token
297           token.destroy
298         end
299         session.delete(:token)
300       end
301       session.delete(:user)
302       session_expires_automatically
303       if params[:referer]
304         redirect_to params[:referer]
305       else
306         redirect_to :controller => 'site', :action => 'index'
307       end
308     end
309   end
310
311   def confirm
312     if request.post?
313       if token = UserToken.find_by_token(params[:confirm_string])
314         if token.user.active?
315           flash[:error] = t('user.confirm.already active')
316           redirect_to :action => 'login'
317         else
318           user = token.user
319           user.status = "active"
320           user.email_valid = true
321           user.save!
322           referer = token.referer
323           token.destroy
324
325           if session[:token] 
326             token = UserToken.find_by_token(session[:token])
327             session.delete(:token)
328           else
329             token = nil
330           end
331
332           if token.nil? or token.user != user
333             flash[:notice] = t('user.confirm.success')
334             redirect_to :action => :login, :referer => referer
335           else
336             token.destroy
337
338             session[:user] = user.id
339             cookies["_osm_username"] = user.display_name
340
341             if referer.nil?
342               flash[:notice] = t('user.confirm.success') + "<br /><br />" + t('user.confirm.before you start')
343               redirect_to :action => :account, :display_name => user.display_name
344             else
345               flash[:notice] = t('user.confirm.success')
346               redirect_to referer
347             end
348           end
349         end
350       else
351         user = User.find_by_display_name(params[:display_name])
352
353         if user and user.active?
354           flash[:error] = t('user.confirm.already active')
355         elsif user
356           flash[:error] = t('user.confirm.unknown token') + t('user.confirm.reconfirm', :reconfirm => url_for(:action => 'confirm_resend', :display_name => params[:display_name]))
357         else
358           flash[:error] = t('user.confirm.unknown token')
359         end
360
361         redirect_to :action => 'login'
362       end
363     end
364   end
365
366   def confirm_resend
367     if user = User.find_by_display_name(params[:display_name])
368       Notifier.signup_confirm(user, user.tokens.create).deliver
369       flash[:notice] = t 'user.confirm_resend.success', :email => user.email
370     else
371       flash[:notice] = t 'user.confirm_resend.failure', :name => params[:display_name]
372     end
373
374     redirect_to :action => 'login'
375   end
376
377   def confirm_email
378     if request.post?
379       token = UserToken.find_by_token(params[:confirm_string])
380       if token and token.user.new_email?
381         @user = token.user
382         @user.email = @user.new_email
383         @user.new_email = nil
384         @user.email_valid = true
385         if @user.save
386           flash[:notice] = t 'user.confirm_email.success'
387         else
388           flash[:errors] = @user.errors
389         end
390         token.destroy
391         session[:user] = @user.id
392         cookies["_osm_username"] = @user.display_name
393         redirect_to :action => 'account', :display_name => @user.display_name
394       else
395         flash[:error] = t 'user.confirm_email.failure'
396         redirect_to :action => 'account', :display_name => @user.display_name
397       end
398     end
399   end
400
401   def api_gpx_files
402     doc = OSM::API.new.get_xml_doc
403     @user.traces.each do |trace|
404       doc.root << trace.to_xml_node() if trace.public? or trace.user == @user
405     end
406     render :text => doc.to_s, :content_type => "text/xml"
407   end
408
409   def view
410     @this_user = User.find_by_display_name(params[:display_name])
411
412     if @this_user and
413        (@this_user.visible? or (@user and @user.administrator?))
414       @title = @this_user.display_name
415     else
416       @title = t 'user.no_such_user.title'
417       @not_found_user = params[:display_name]
418       render :action => 'no_such_user', :status => :not_found
419     end
420   end
421
422   def make_friend
423     if params[:display_name]
424       name = params[:display_name]
425       new_friend = User.active.where(:display_name => name).first
426       friend = Friend.new
427       friend.user_id = @user.id
428       friend.friend_user_id = new_friend.id
429       unless @user.is_friends_with?(new_friend)
430         if friend.save
431           flash[:notice] = t 'user.make_friend.success', :name => name
432           Notifier.friend_notification(friend).deliver
433         else
434           friend.add_error(t('user.make_friend.failed', :name => name))
435         end
436       else
437         flash[:warning] = t 'user.make_friend.already_a_friend', :name => name
438       end
439
440       if params[:referer]
441         redirect_to params[:referer]
442       else
443         redirect_to :controller => 'user', :action => 'view'
444       end
445     end
446   end
447
448   def remove_friend
449     if params[:display_name]
450       name = params[:display_name]
451       friend = User.active.where(:display_name => name).first
452       if @user.is_friends_with?(friend)
453         Friend.delete_all "user_id = #{@user.id} AND friend_user_id = #{friend.id}"
454         flash[:notice] = t 'user.remove_friend.success', :name => friend.display_name
455       else
456         flash[:error] = t 'user.remove_friend.not_a_friend', :name => friend.display_name
457       end
458
459       if params[:referer]
460         redirect_to params[:referer]
461       else
462         redirect_to :controller => 'user', :action => 'view'
463       end
464     end
465   end
466
467   ##
468   # sets a user's status
469   def set_status
470     @this_user.update_attributes(:status => params[:status])
471     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
472   end
473
474   ##
475   # delete a user, marking them as deleted and removing personal data
476   def delete
477     @this_user.delete
478     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
479   end
480
481   ##
482   # display a list of users matching specified criteria
483   def list
484     if request.post?
485       ids = params[:user].keys.collect { |id| id.to_i }
486
487       User.update_all("status = 'confirmed'", :id => ids) if params[:confirm]
488       User.update_all("status = 'deleted'", :id => ids) if params[:hide]
489
490       redirect_to url_for(:status => params[:status], :ip => params[:ip], :page => params[:page])
491     else
492       conditions = Hash.new
493       conditions[:status] = params[:status] if params[:status]
494       conditions[:creation_ip] = params[:ip] if params[:ip]
495
496       @user_pages, @users = paginate(:users,
497                                      :conditions => conditions,
498                                      :order => :id,
499                                      :per_page => 50)
500     end
501   end
502
503 private
504
505   ##
506   # handle password authentication
507   def password_authentication(username, password)
508     if user = User.authenticate(:username => username, :password => password)
509       successful_login(user)
510     elsif user = User.authenticate(:username => username, :password => password, :pending => true)
511       failed_login t('user.login.account not active', :reconfirm => url_for(:action => 'confirm_resend', :display_name => user.display_name))
512     elsif User.authenticate(:username => username, :password => password, :suspended => true)
513       webmaster = link_to t('user.login.webmaster'), "mailto:webmaster@openstreetmap.org"
514       failed_login t('user.login.account suspended', :webmaster => webmaster)
515     else
516       failed_login t('user.login.auth failure')
517     end
518   end
519
520   ##
521   # handle OpenID authentication
522   def openid_authentication(openid_url)
523     # If we don't appear to have a user for this URL then ask the
524     # provider for some extra information to help with signup
525     if openid_url and User.find_by_openid_url(openid_url)
526       required = nil
527     else
528       required = [:nickname, :email, "http://axschema.org/namePerson/friendly", "http://axschema.org/contact/email"]
529     end
530
531     # Start the authentication
532     authenticate_with_open_id(openid_expand_url(openid_url), :method => :get, :required => required) do |result, identity_url, sreg, ax|
533       if result.successful?
534         # We need to use the openid url passed back from the OpenID provider
535         # rather than the one supplied by the user, as these can be different.
536         #
537         # For example, you can simply enter yahoo.com in the login box rather
538         # than a user specific url. Only once it comes back from the provider
539         # provider do we know the unique address for the user.
540         if user = User.find_by_openid_url(identity_url)
541           case user.status
542             when "pending" then
543               failed_login t('user.login.account not active')
544             when "active", "confirmed" then
545               successful_login(user)
546             when "suspended" then
547               webmaster = link_to t('user.login.webmaster'), "mailto:webmaster@openstreetmap.org"
548               failed_login t('user.login.account suspended', :webmaster => webmaster)
549             else
550               failed_login t('user.login.auth failure')
551           end
552         else
553           # Guard against not getting any extension data
554           sreg = Hash.new if sreg.nil?
555           ax = Hash.new if ax.nil?
556
557           # We don't have a user registered to this OpenID, so redirect
558           # to the create account page with username and email filled
559           # in if they have been given by the OpenID provider through
560           # the simple registration protocol.
561           nickname = sreg["nickname"] || ax["http://axschema.org/namePerson/friendly"]
562           email = sreg["email"] || ax["http://axschema.org/contact/email"]
563           redirect_to :controller => 'user', :action => 'new', :nickname => nickname, :email => email, :openid => identity_url
564         end
565       elsif result.missing?
566         failed_login t('user.login.openid missing provider')
567       elsif result.invalid?
568         failed_login t('user.login.openid invalid')
569       else
570         failed_login t('user.login.auth failure')
571       end
572     end
573   end
574
575   ##
576   # verify an OpenID URL
577   def openid_verify(openid_url, user)
578     user.openid_url = openid_url
579
580     authenticate_with_open_id(openid_expand_url(openid_url), :method => :get) do |result, identity_url|
581       if result.successful?
582         # We need to use the openid url passed back from the OpenID provider
583         # rather than the one supplied by the user, as these can be different.
584         #
585         # For example, you can simply enter yahoo.com in the login box rather
586         # than a user specific url. Only once it comes back from the provider
587         # provider do we know the unique address for the user.
588         user.openid_url = identity_url
589         yield user
590       elsif result.missing?
591         flash.now[:error] = t 'user.login.openid missing provider'
592       elsif result.invalid?
593         flash.now[:error] = t 'user.login.openid invalid'
594       else
595         flash.now[:error] = t 'user.login.auth failure'
596       end
597     end
598   end
599
600   ##
601   # special case some common OpenID providers by applying heuristics to
602   # try and come up with the correct URL based on what the user entered
603   def openid_expand_url(openid_url)
604     if openid_url.nil?
605       return nil
606     elsif openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
607       # Special case gmail.com as it is potentially a popular OpenID
608       # provider and, unlike yahoo.com, where it works automatically, Google
609       # have hidden their OpenID endpoint somewhere obscure this making it
610       # somewhat less user friendly.
611       return 'https://www.google.com/accounts/o8/id'
612     else
613       return openid_url
614     end
615   end  
616
617   ##
618   # process a successful login
619   def successful_login(user)
620     cookies["_osm_username"] = user.display_name
621
622     session[:user] = user.id
623     session_expires_after 1.month if session[:remember_me]
624
625     target = session[:referer] || url_for(:controller => :site, :action => :index)
626
627     # The user is logged in, so decide where to send them:
628     #
629     # - If they haven't seen the contributor terms, send them there.
630     # - If they have a block on them, show them that.
631     # - If they were referred to the login, send them back there.
632     # - Otherwise, send them to the home page.
633     if REQUIRE_TERMS_SEEN and not user.terms_seen
634       redirect_to :controller => :user, :action => :terms, :referer => target
635     elsif user.blocked_on_view
636       redirect_to user.blocked_on_view, :referer => target
637     else
638       redirect_to target
639     end
640
641     session.delete(:remember_me)
642     session.delete(:referer)
643   end
644
645   ##
646   # process a failed login
647   def failed_login(message)
648     flash[:error] = message
649
650     redirect_to :action => 'login', :referer =>  session[:referer]
651
652     session.delete(:remember_me)
653     session.delete(:referer)
654   end
655
656   ##
657   # update a user's details
658   def update_user(user)
659     if user.save
660       set_locale
661
662       if user.new_email.nil? or user.new_email.empty?
663         flash.now[:notice] = t 'user.account.flash update success'
664       else
665         flash.now[:notice] = t 'user.account.flash update success confirm needed'
666
667         begin
668           Notifier.email_confirm(user, user.tokens.create).deliver
669         rescue
670           # Ignore errors sending email
671         end
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