]> git.openstreetmap.org Git - rails.git/blob - app/controllers/user_controller.rb
Make sure the ID of OpenID URL fields is openid_url
[rails.git] / app / controllers / user_controller.rb
1 class UserController < ApplicationController
2   layout :choose_layout
3
4   before_filter :disable_terms_redirect, :only => [:terms, :save, :logout, :api_details]
5   before_filter :authorize, :only => [:api_details, :api_gpx_files]
6   before_filter :authorize_web, :except => [:api_details, :api_gpx_files]
7   before_filter :set_locale, :except => [:api_details, :api_gpx_files]
8   before_filter :require_user, :only => [:account, :go_public, :make_friend, :remove_friend]
9   before_filter :check_database_readable, :except => [:api_details, :api_gpx_files]
10   before_filter :check_database_writable, :only => [:login, :new, :account, :go_public, :make_friend, :remove_friend]
11   before_filter :check_api_readable, :only => [:api_details, :api_gpx_files]
12   before_filter :require_allow_read_prefs, :only => [:api_details]
13   before_filter :require_allow_read_gpx, :only => [:api_gpx_files]
14   before_filter :require_cookies, :only => [:login, :confirm]
15   before_filter :require_administrator, :only => [:set_status, :delete, :list]
16   before_filter :lookup_this_user, :only => [:set_status, :delete]
17
18   filter_parameter_logging :password, :pass_crypt, :pass_crypt_confirmation
19
20   cache_sweeper :user_sweeper, :only => [:account, :set_status, :delete], :unless => STATUS == :database_offline
21
22   def terms
23     @legale = params[:legale] || OSM.IPToCountry(request.remote_ip) || DEFAULT_LEGALE
24     @text = OSM.legal_text_for_country(@legale)
25
26     if request.xhr?
27       render :update do |page|
28         page.replace_html "contributorTerms", :partial => "terms"
29       end
30     elsif using_open_id?
31       # The redirect from the OpenID provider reenters here
32       # again and we need to pass the parameters through to
33       # the open_id_authentication function
34       @user = session.delete(:new_user)
35
36       openid_verify(nil, @user) do |user|
37       end
38
39       if @user.openid_url.nil? or @user.invalid?
40         render :action => 'new'
41       else
42         render :action => 'terms'
43       end
44     else
45       session[:referer] = params[:referer]
46
47       @title = t 'user.terms.title'
48       @user = User.new(params[:user]) if params[:user]
49
50       if params[:user] and params[:user][:openid_url] and @user.pass_crypt.empty?
51         # We are creating an account with OpenID and no password
52         # was specified so create a random one
53         @user.pass_crypt = ActiveSupport::SecureRandom.base64(16) 
54         @user.pass_crypt_confirmation = @user.pass_crypt 
55       end
56
57       if @user
58         if @user.invalid?
59           if @user.new_record?
60             # Something is wrong with a new user, so rerender the form
61             render :action => :new
62           else
63             # Error in existing user, so go to account settings
64             flash[:errors] = @user.errors
65             redirect_to :action => :account, :display_name => @user.display_name
66           end
67         elsif @user.terms_agreed?
68           # Already agreed to terms, so just show settings
69           redirect_to :action => :account, :display_name => @user.display_name
70         elsif params[:user] and params[:user][:openid_url] and not params[:user][:openid_url].empty?
71           # Verify OpenID before moving on
72           session[:new_user] = @user
73           openid_verify(params[:user][:openid_url], @user)
74         end
75       else
76         # Not logged in, so redirect to the login page
77         redirect_to :action => :login, :referer => request.request_uri
78       end
79     end
80   end
81
82   def save
83     @title = t 'user.new.title'
84
85     if Acl.find_by_address(request.remote_ip, :conditions => {:k => "no_account_creation"})
86       render :action => 'new'
87     elsif params[:decline]
88       if @user
89         @user.terms_seen = true
90
91         if @user.save
92           flash[:notice] = t 'user.new.terms declined', :url => t('user.new.terms declined url')
93         end
94
95         if params[:referer]
96           redirect_to params[:referer]
97         else
98           redirect_to :action => :account, :display_name => @user.display_name
99         end
100       else
101         redirect_to t('user.terms.declined')
102       end
103     elsif @user
104       if !@user.terms_agreed?
105         @user.consider_pd = params[:user][:consider_pd]
106         @user.terms_agreed = Time.now.getutc
107         @user.terms_seen = true
108         if @user.save
109           flash[:notice] = t 'user.new.terms accepted'
110         end
111       end
112
113       if params[:referer]
114         redirect_to params[:referer]
115       else
116         redirect_to :action => :account, :display_name => @user.display_name
117       end
118     else
119       @user = User.new(params[:user])
120
121       @user.status = "pending"
122       @user.data_public = true
123       @user.description = "" if @user.description.nil?
124       @user.creation_ip = request.remote_ip
125       @user.languages = request.user_preferred_languages
126       @user.terms_agreed = Time.now.getutc
127       @user.terms_seen = true
128       @user.openid_url = nil if @user.openid_url and @user.openid_url.empty?
129       
130       if @user.save
131         flash[:notice] = t 'user.new.flash create success message', :email => @user.email
132         Notifier.deliver_signup_confirm(@user, @user.tokens.create(:referer => session.delete(:referer)))
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.find :all, :conditions => 'oauth_tokens.invalidated_at is null and oauth_tokens.authorized_at is not null'
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.find_by_email(params[:user][:email], :conditions => {:status => ["pending", "active", "confirmed"]})
213
214       if user
215         token = user.tokens.create
216         Notifier.deliver_lost_password(user, token)
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 session[: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       redirect_to :controller => 'site', :action => 'index'
261     elsif not params['openid'].nil?
262       flash.now[:notice] = t 'user.new.openid association'
263     end
264   end
265
266   def login
267     if params[:username] or using_open_id?
268       session[:remember_me] ||= params[:remember_me]
269       session[:referer] ||= params[:referer]
270
271       if using_open_id?
272         openid_authentication(params[:openid_url])
273       else
274         password_authentication(params[:username], params[:password])
275       end
276     elsif flash[:notice].nil?
277       flash.now[:notice] =  t 'user.login.notice'
278     end
279   end
280
281   def logout
282     @title = t 'user.logout.title'
283
284     if params[:session] == request.session_options[:id]
285       if session[:token]
286         token = UserToken.find_by_token(session[:token])
287         if token
288           token.destroy
289         end
290         session.delete(:token)
291       end
292       session.delete(:user)
293       session_expires_automatically
294       if params[:referer]
295         redirect_to params[:referer]
296       else
297         redirect_to :controller => 'site', :action => 'index'
298       end
299     end
300   end
301
302   def confirm
303     if request.post?
304       if token = UserToken.find_by_token(params[:confirm_string])
305         if token.user.active?
306           flash[:error] = t('user.confirm.already active')
307           redirect_to :action => 'login'
308         else
309           user = token.user
310           user.status = "active"
311           user.email_valid = true
312           user.save!
313           referer = token.referer
314           token.destroy
315
316           if session[:token] 
317             token = UserToken.find_by_token(session[:token])
318             session.delete(:token)
319           else
320             token = nil
321           end
322
323           if token.nil? or token.user != user
324             flash[:notice] = t('user.confirm.success')
325             redirect_to :action => :login, :referer => referer
326           else
327             token.destroy
328
329             session[:user] = user.id
330
331             if referer.nil?
332               flash[:notice] = t('user.confirm.success') + "<br /><br />" + t('user.confirm.before you start')
333               redirect_to :action => :account, :display_name => user.display_name
334             else
335               flash[:notice] = t('user.confirm.success')
336               redirect_to referer
337             end
338           end
339         end
340       else
341         user = User.find_by_display_name(params[:display_name])
342
343         if user and user.active?
344           flash[:error] = t('user.confirm.already active')
345         elsif user
346           flash[:error] = t('user.confirm.unknown token') + t('user.confirm.reconfirm', :reconfirm => url_for(:action => 'confirm_resend', :display_name => params[:display_name]))
347         else
348           flash[:error] = t('user.confirm.unknown token')
349         end
350
351         redirect_to :action => 'login'
352       end
353     end
354   end
355
356   def confirm_resend
357     if user = User.find_by_display_name(params[:display_name])
358       Notifier.deliver_signup_confirm(user, user.tokens.create)
359       flash[:notice] = t 'user.confirm_resend.success', :email => user.email
360     else
361       flash[:notice] = t 'user.confirm_resend.failure', :name => params[:display_name]
362     end
363
364     redirect_to :action => 'login'
365   end
366
367   def confirm_email
368     if request.post?
369       token = UserToken.find_by_token(params[:confirm_string])
370       if token and token.user.new_email?
371         @user = token.user
372         @user.email = @user.new_email
373         @user.new_email = nil
374         @user.email_valid = true
375         if @user.save
376           flash[:notice] = t 'user.confirm_email.success'
377         else
378           flash[:errors] = @user.errors
379         end
380         token.destroy
381         session[:user] = @user.id
382         redirect_to :action => 'account', :display_name => @user.display_name
383       else
384         flash[:error] = t 'user.confirm_email.failure'
385         redirect_to :action => 'account', :display_name => @user.display_name
386       end
387     end
388   end
389
390   def api_gpx_files
391     doc = OSM::API.new.get_xml_doc
392     @user.traces.each do |trace|
393       doc.root << trace.to_xml_node() if trace.public? or trace.user == @user
394     end
395     render :text => doc.to_s, :content_type => "text/xml"
396   end
397
398   def view
399     @this_user = User.find_by_display_name(params[:display_name])
400
401     if @this_user and
402        (@this_user.visible? or (@user and @user.administrator?))
403       @title = @this_user.display_name
404     else
405       @title = t 'user.no_such_user.title'
406       @not_found_user = params[:display_name]
407       render :action => 'no_such_user', :status => :not_found
408     end
409   end
410
411   def make_friend
412     if params[:display_name]
413       name = params[:display_name]
414       new_friend = User.find_by_display_name(name, :conditions => {:status => ["active", "confirmed"]})
415       friend = Friend.new
416       friend.user_id = @user.id
417       friend.friend_user_id = new_friend.id
418       unless @user.is_friends_with?(new_friend)
419         if friend.save
420           flash[:notice] = t 'user.make_friend.success', :name => name
421           Notifier.deliver_friend_notification(friend)
422         else
423           friend.add_error(t('user.make_friend.failed', :name => name))
424         end
425       else
426         flash[:warning] = t 'user.make_friend.already_a_friend', :name => name
427       end
428
429       if params[:referer]
430         redirect_to params[:referer]
431       else
432         redirect_to :controller => 'user', :action => 'view'
433       end
434     end
435   end
436
437   def remove_friend
438     if params[:display_name]
439       name = params[:display_name]
440       friend = User.find_by_display_name(name, :conditions => {:status => ["active", "confirmed"]})
441       if @user.is_friends_with?(friend)
442         Friend.delete_all "user_id = #{@user.id} AND friend_user_id = #{friend.id}"
443         flash[:notice] = t 'user.remove_friend.success', :name => friend.display_name
444       else
445         flash[:error] = t 'user.remove_friend.not_a_friend', :name => friend.display_name
446       end
447
448       if params[:referer]
449         redirect_to params[:referer]
450       else
451         redirect_to :controller => 'user', :action => 'view'
452       end
453     end
454   end
455
456   ##
457   # sets a user's status
458   def set_status
459     @this_user.update_attributes(:status => params[:status])
460     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
461   end
462
463   ##
464   # delete a user, marking them as deleted and removing personal data
465   def delete
466     @this_user.delete
467     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
468   end
469
470   ##
471   # display a list of users matching specified criteria
472   def list
473     if request.post?
474       ids = params[:user].keys.collect { |id| id.to_i }
475
476       User.update_all("status = 'confirmed'", :id => ids) if params[:confirm]
477       User.update_all("status = 'deleted'", :id => ids) if params[:hide]
478
479       redirect_to url_for(:status => params[:status], :ip => params[:ip], :page => params[:page])
480     else
481       conditions = Hash.new
482       conditions[:status] = params[:status] if params[:status]
483       conditions[:creation_ip] = params[:ip] if params[:ip]
484
485       @user_pages, @users = paginate(:users,
486                                      :conditions => conditions,
487                                      :order => :id,
488                                      :per_page => 50)
489     end
490   end
491
492 private
493
494   ##
495   # handle password authentication
496   def password_authentication(username, password)
497     if user = User.authenticate(:username => username, :password => password)
498       successful_login(user)
499     elsif user = User.authenticate(:username => username, :password => password, :pending => true)
500       failed_login t('user.login.account not active', :reconfirm => url_for(:action => 'confirm_resend', :display_name => user.display_name))
501     elsif User.authenticate(:username => username, :password => password, :suspended => true)
502       webmaster = link_to t('user.login.webmaster'), "mailto:webmaster@openstreetmap.org"
503       failed_login t('user.login.account suspended', :webmaster => webmaster)
504     else
505       failed_login t('user.login.auth failure')
506     end
507   end
508
509   ##
510   # handle OpenID authentication
511   def openid_authentication(openid_url)
512     # If we don't appear to have a user for this URL then ask the
513     # provider for some extra information to help with signup
514     if openid_url and User.find_by_openid_url(openid_url)
515       required = nil
516     else
517       required = [:nickname, :email, "http://axschema.org/namePerson/friendly", "http://axschema.org/contact/email"]
518     end
519
520     # Start the authentication
521     authenticate_with_open_id(openid_expand_url(openid_url), :required => required) do |result, identity_url, sreg, ax|
522       if result.successful?
523         # We need to use the openid url passed back from the OpenID provider
524         # rather than the one supplied by the user, as these can be different.
525         #
526         # For example, you can simply enter yahoo.com in the login box rather
527         # than a user specific url. Only once it comes back from the provider
528         # provider do we know the unique address for the user.
529         if user = User.find_by_openid_url(identity_url)
530           case user.status
531             when "pending" then
532               failed_login t('user.login.account not active')
533             when "active", "confirmed" then
534               successful_login(user)
535             when "suspended" then
536               webmaster = link_to t('user.login.webmaster'), "mailto:webmaster@openstreetmap.org"
537               failed_login t('user.login.account suspended', :webmaster => webmaster)
538             else
539               failed_login t('user.login.auth failure')
540           end
541         else
542           # Guard against not getting any extension data
543           sreg = Hash.new if sreg.nil?
544           ax = Hash.new if ax.nil?
545
546           # We don't have a user registered to this OpenID, so redirect
547           # to the create account page with username and email filled
548           # in if they have been given by the OpenID provider through
549           # the simple registration protocol.
550           nickname = sreg["nickname"] || ax["http://axschema.org/namePerson/friendly"]
551           email = sreg["email"] || ax["http://axschema.org/contact/email"]
552           redirect_to :controller => 'user', :action => 'new', :nickname => nickname, :email => email, :openid => identity_url
553         end
554       elsif result.missing?
555         failed_login t('user.login.openid missing provider')
556       elsif result.invalid?
557         failed_login t('user.login.openid invalid')
558       else
559         failed_login t('user.login.auth failure')
560       end
561     end
562   end
563
564   ##
565   # verify an OpenID URL
566   def openid_verify(openid_url, user)
567     user.openid_url = openid_url
568
569     authenticate_with_open_id(openid_expand_url(openid_url)) do |result, identity_url|
570       if result.successful?
571         # We need to use the openid url passed back from the OpenID provider
572         # rather than the one supplied by the user, as these can be different.
573         #
574         # For example, you can simply enter yahoo.com in the login box rather
575         # than a user specific url. Only once it comes back from the provider
576         # provider do we know the unique address for the user.
577         user.openid_url = identity_url
578         yield user
579       elsif result.missing?
580         flash.now[:error] = t 'user.login.openid missing provider'
581       elsif result.invalid?
582         flash.now[:error] = t 'user.login.openid invalid'
583       else
584         flash.now[:error] = t 'user.login.auth failure'
585       end
586     end
587   end
588
589   ##
590   # special case some common OpenID providers by applying heuristics to
591   # try and come up with the correct URL based on what the user entered
592   def openid_expand_url(openid_url)
593     if openid_url.nil?
594       return nil
595     elsif openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
596       # Special case gmail.com as it is potentially a popular OpenID
597       # provider and, unlike yahoo.com, where it works automatically, Google
598       # have hidden their OpenID endpoint somewhere obscure this making it
599       # somewhat less user friendly.
600       return 'https://www.google.com/accounts/o8/id'
601     else
602       return openid_url
603     end
604   end  
605
606   ##
607   # process a successful login
608   def successful_login(user)
609     session[:user] = user.id
610     session_expires_after 1.month if session[:remember_me]
611
612     target = session[:referer] || url_for(:controller => :site, :action => :index)
613
614     # The user is logged in, so decide where to send them:
615     #
616     # - If they haven't seen the contributor terms, send them there.
617     # - If they have a block on them, show them that.
618     # - If they were referred to the login, send them back there.
619     # - Otherwise, send them to the home page.
620     if REQUIRE_TERMS_SEEN and not user.terms_seen
621       redirect_to :controller => :user, :action => :terms, :referer => target
622     elsif user.blocked_on_view
623       redirect_to user.blocked_on_view, :referer => target
624     else
625       redirect_to target
626     end
627
628     session.delete(:remember_me)
629     session.delete(:referer)
630   end
631
632   ##
633   # process a failed login
634   def failed_login(message)
635     flash[:error] = message
636
637     redirect_to :action => 'login', :referer =>  session[:referer]
638
639     session.delete(:remember_me)
640     session.delete(:referer)
641   end
642
643   ##
644   # update a user's details
645   def update_user(user)
646     if user.save
647       set_locale
648
649       if user.new_email.nil? or user.new_email.empty?
650         flash.now[:notice] = t 'user.account.flash update success'
651       else
652         flash.now[:notice] = t 'user.account.flash update success confirm needed'
653
654         begin
655           Notifier.deliver_email_confirm(user, user.tokens.create)
656         rescue
657           # Ignore errors sending email
658         end
659       end
660     end
661   end
662
663   ##
664   # require that the user is a administrator, or fill out a helpful error message
665   # and return them to the user page.
666   def require_administrator
667     if @user and not @user.administrator?
668       flash[:error] = t('user.filter.not_an_administrator')
669
670       if params[:display_name]
671         redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
672       else
673         redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri
674       end
675     elsif not @user
676       redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri
677     end
678   end
679
680   ##
681   # ensure that there is a "this_user" instance variable
682   def lookup_this_user
683     @this_user = User.find_by_display_name(params[:display_name])
684   rescue ActiveRecord::RecordNotFound
685     redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name] unless @this_user
686   end
687
688   ##
689   # Choose the layout to use. See
690   # https://rails.lighthouseapp.com/projects/8994/tickets/5371-layout-with-onlyexcept-options-makes-other-actions-render-without-layouts
691   def choose_layout
692     oauth_url = url_for(:controller => :oauth, :action => :oauthorize, :only_path => true)
693
694     if [ 'api_details' ].include? action_name
695       nil
696     elsif params[:referer] and URI.parse(params[:referer]).path == oauth_url
697       'slim'
698     else
699       'site'
700     end
701   end
702
703   ##
704   #
705   def disable_terms_redirect
706     # this is necessary otherwise going to the user terms page, when 
707     # having not agreed already would cause an infinite redirect loop.
708     # it's .now so that this doesn't propagate to other pages.
709     flash.now[:skip_terms] = true
710   end
711 end