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