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