1 class UserController < ApplicationController
4 skip_before_filter :verify_authenticity_token, :only => [:api_read, :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_read, :api_details, :api_gpx_files]
8 before_filter :set_locale, :except => [:api_read, :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_read, :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_read, :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 around_filter :api_call_handle_error, :only => [:api_read, :api_details, :api_gpx_files]
18 before_filter :lookup_user_by_id, :only => [:api_read]
19 before_filter :lookup_user_by_name, :only => [:set_status, :delete]
21 cache_sweeper :user_sweeper, :only => [:account, :set_status, :delete]
24 @legale = params[:legale] || OSM.IPToCountry(request.remote_ip) || DEFAULT_LEGALE
25 @text = OSM.legal_text_for_country(@legale)
28 render :partial => "terms"
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)
35 openid_verify(nil, @user) do |user|
38 if @user.openid_url.nil? or @user.invalid?
39 render :action => 'new'
41 render :action => 'terms'
43 elsif params[:user] and Acl.no_account_creation(request.remote_ip, params[:user][:email].split("@").last)
44 render :action => 'blocked'
46 session[:referer] = params[:referer]
48 @title = t 'user.terms.title'
49 @user = User.new(params[:user]) if params[:user]
51 if params[:user] and params[:user][:openid_url] and @user.pass_crypt.empty?
52 # We are creating an account with OpenID and no password
53 # was specified so create a random one
54 @user.pass_crypt = SecureRandom.base64(16)
55 @user.pass_crypt_confirmation = @user.pass_crypt
61 # Something is wrong with a new user, so rerender the form
62 render :action => :new
64 # Error in existing user, so go to account settings
65 flash[:errors] = @user.errors
66 redirect_to :action => :account, :display_name => @user.display_name
68 elsif @user.terms_agreed?
69 # Already agreed to terms, so just show settings
70 redirect_to :action => :account, :display_name => @user.display_name
71 elsif params[:user] and params[:user][:openid_url] and not params[:user][:openid_url].empty?
72 # Verify OpenID before moving on
73 session[:new_user] = @user
74 openid_verify(params[:user][:openid_url], @user)
77 # Not logged in, so redirect to the login page
78 redirect_to :action => :login, :referer => request.fullpath
84 @title = t 'user.new.title'
88 @user.terms_seen = true
91 flash[:notice] = t 'user.new.terms declined', :url => t('user.new.terms declined url')
95 redirect_to params[:referer]
97 redirect_to :action => :account, :display_name => @user.display_name
100 redirect_to t('user.terms.declined')
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
108 flash[:notice] = t 'user.new.terms accepted'
113 redirect_to params[:referer]
115 redirect_to :action => :account, :display_name => @user.display_name
117 elsif Acl.no_account_creation(request.remote_ip, params[:user][:email].split("@").last)
118 render :action => 'blocked'
120 @user = User.new(params[:user])
122 @user.status = "pending"
123 @user.data_public = true
124 @user.description = "" if @user.description.nil?
125 @user.creation_ip = request.remote_ip
126 @user.languages = request.user_preferred_languages
127 @user.terms_agreed = Time.now.getutc
128 @user.terms_seen = true
129 @user.openid_url = nil if @user.openid_url and @user.openid_url.empty?
131 if (session[:openid_verified])
132 openid_verified = session.delete(:openid_verified)
133 if (openid_verified[:identity_url]) and (openid_verified[:identity_url] == @user.openid_url) and (openid_verified[:email]) and (openid_verified[:email] == @user.email)
134 # if we have an email from an OpenID provider that we trust to have verified the email for us, then activate the account directly
135 # without doing our own email verification.
136 @user.status = "active"
141 flash[:piwik_goal] = PIWIK_SIGNUP_GOAL if defined?(PIWIK_SIGNUP_GOAL)
142 flash[:notice] = t 'user.new.flash create success message', :email => @user.email
143 if @user.status == "active"
144 Notifier.signup_confirm(@user, nil).deliver
145 successful_login(@user)
147 Notifier.signup_confirm(@user, @user.tokens.create(:referer => session.delete(:referer))).deliver
148 session[:token] = @user.tokens.create.token
149 redirect_to :action => 'login', :referer => params[:referer]
152 render :action => 'new', :referer => params[:referer]
158 @title = t 'user.account.title'
159 @tokens = @user.oauth_tokens.authorized
161 if params[:user] and params[:user][:display_name] and params[:user][:description]
162 if params[:user][:openid_url] and
163 params[:user][:openid_url].length > 0 and
164 params[:user][:openid_url] != @user.openid_url
165 # If the OpenID has changed, we want to check that it is a
166 # valid OpenID and one the user has control over before saving
167 # it as a password equivalent for the user.
168 session[:new_user_settings] = params
169 openid_verify(params[:user][:openid_url], @user)
171 update_user(@user, params)
174 # The redirect from the OpenID provider reenters here
175 # again and we need to pass the parameters through to
176 # the open_id_authentication function
177 settings = session.delete(:new_user_settings)
178 openid_verify(nil, @user) do |user|
179 update_user(user, settings)
185 @user.data_public = true
187 flash[:notice] = t 'user.go_public.flash success'
188 redirect_to :controller => 'user', :action => 'account', :display_name => @user.display_name
192 @title = t 'user.lost_password.title'
194 if params[:user] and params[:user][:email]
195 user = User.visible.find_by_email(params[:user][:email])
198 users = User.visible.where("LOWER(email) = LOWER(?)", params[:user][:email])
206 token = user.tokens.create
207 Notifier.lost_password(user, token).deliver
208 flash[:notice] = t 'user.lost_password.notice email on way'
209 redirect_to :action => 'login'
211 flash.now[:error] = t 'user.lost_password.notice email cannot find'
217 @title = t 'user.reset_password.title'
220 token = UserToken.find_by_token(params[:token])
226 @user.pass_crypt = params[:user][:pass_crypt]
227 @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
228 @user.status = "active" if @user.status == "pending"
229 @user.email_valid = true
233 flash[:notice] = t 'user.reset_password.flash changed'
234 redirect_to :action => 'login'
238 flash[:error] = t 'user.reset_password.flash token bad'
239 redirect_to :action => 'lost_password'
245 @title = t 'user.new.title'
246 @referer = params[:referer] || session[:referer]
249 # The user is logged in already, so don't show them the signup
250 # page, instead send them to the home page
254 redirect_to :controller => 'site', :action => 'index'
256 elsif params.key?(:openid)
257 @user = User.new(:email => params[:email],
258 :email_confirmation => params[:email],
259 :display_name => params[:nickname],
260 :openid_url => params[:openid])
262 flash.now[:notice] = t 'user.new.openid association'
263 elsif Acl.no_account_creation(request.remote_ip)
264 render :action => 'blocked'
269 if params[:username] or using_open_id?
270 session[:remember_me] ||= params[:remember_me]
271 session[:referer] ||= params[:referer]
274 openid_authentication(params[:openid_url])
276 password_authentication(params[:username], params[:password])
282 @title = t 'user.logout.title'
284 if params[:session] == request.session_options[:id]
286 token = UserToken.find_by_token(session[:token])
290 session.delete(:token)
292 session.delete(:user)
293 session_expires_automatically
295 redirect_to params[:referer]
297 redirect_to :controller => 'site', :action => 'index'
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'
310 user.status = "active"
311 user.email_valid = true
313 referer = token.referer
317 token = UserToken.find_by_token(session[:token])
318 session.delete(:token)
323 if token.nil? or token.user != user
324 flash[:notice] = t('user.confirm.success')
325 redirect_to :action => :login, :referer => referer
329 session[:user] = user.id
330 cookies.permanent["_osm_username"] = user.display_name
333 flash[:notice] = t('user.confirm.success') + "<br /><br />" + t('user.confirm.before you start')
334 redirect_to :action => :account, :display_name => user.display_name
336 flash[:notice] = t('user.confirm.success')
342 user = User.find_by_display_name(params[:display_name])
344 if user and user.active?
345 flash[:error] = t('user.confirm.already active')
347 flash[:error] = t('user.confirm.unknown token') + t('user.confirm.reconfirm', :reconfirm => url_for(:action => 'confirm_resend', :display_name => params[:display_name]))
349 flash[:error] = t('user.confirm.unknown token')
352 redirect_to :action => 'login'
358 if user = User.find_by_display_name(params[:display_name])
359 Notifier.signup_confirm(user, user.tokens.create).deliver
360 flash[:notice] = t 'user.confirm_resend.success', :email => user.email
362 flash[:notice] = t 'user.confirm_resend.failure', :name => params[:display_name]
365 redirect_to :action => 'login'
370 token = UserToken.find_by_token(params[:confirm_string])
371 if token and token.user.new_email?
373 @user.email = @user.new_email
374 @user.new_email = nil
375 @user.email_valid = true
377 flash[:notice] = t 'user.confirm_email.success'
379 flash[:errors] = @user.errors
382 session[:user] = @user.id
383 cookies.permanent["_osm_username"] = @user.display_name
384 redirect_to :action => 'account', :display_name => @user.display_name
386 flash[:error] = t 'user.confirm_email.failure'
387 redirect_to :action => 'account', :display_name => @user.display_name
393 render :nothing => true, :status => :gone unless @this_user.visible?
398 render :action => :api_read
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
406 render :text => doc.to_s, :content_type => "text/xml"
410 @this_user = User.find_by_display_name(params[:display_name])
413 (@this_user.visible? or (@user and @user.administrator?))
414 @title = @this_user.display_name
416 render_unknown_user params[:display_name]
421 @new_friend = User.find_by_display_name(params[:display_name])
426 friend.user_id = @user.id
427 friend.friend_user_id = @new_friend.id
428 unless @user.is_friends_with?(@new_friend)
430 flash[:notice] = t 'user.make_friend.success', :name => @new_friend.display_name
431 Notifier.friend_notification(friend).deliver
433 friend.add_error(t('user.make_friend.failed', :name => @new_friend.display_name))
436 flash[:warning] = t 'user.make_friend.already_a_friend', :name => @new_friend.display_name
440 redirect_to params[:referer]
442 redirect_to :controller => 'user', :action => 'view'
446 render_unknown_user params[:display_name]
451 @friend = User.find_by_display_name(params[:display_name])
455 if @user.is_friends_with?(@friend)
456 Friend.delete_all "user_id = #{@user.id} AND friend_user_id = #{@friend.id}"
457 flash[:notice] = t 'user.remove_friend.success', :name => @friend.display_name
459 flash[:error] = t 'user.remove_friend.not_a_friend', :name => @friend.display_name
463 redirect_to params[:referer]
465 redirect_to :controller => 'user', :action => 'view'
469 render_unknown_user params[:display_name]
474 # sets a user's status
476 @this_user.status = params[:status]
478 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
482 # delete a user, marking them as deleted and removing personal data
485 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
489 # display a list of users matching specified criteria
492 ids = params[:user].keys.collect { |id| id.to_i }
494 User.update_all("status = 'confirmed'", :id => ids) if params[:confirm]
495 User.update_all("status = 'deleted'", :id => ids) if params[:hide]
497 redirect_to url_for(:status => params[:status], :ip => params[:ip], :page => params[:page])
499 conditions = Hash.new
500 conditions[:status] = params[:status] if params[:status]
501 conditions[:creation_ip] = params[:ip] if params[:ip]
503 @user_pages, @users = paginate(:users,
504 :conditions => conditions,
513 # handle password authentication
514 def password_authentication(username, password)
515 if user = User.authenticate(:username => username, :password => password)
516 successful_login(user)
517 elsif user = User.authenticate(:username => username, :password => password, :pending => true)
518 failed_login t('user.login.account not active', :reconfirm => url_for(:action => 'confirm_resend', :display_name => user.display_name))
519 elsif User.authenticate(:username => username, :password => password, :suspended => true)
520 failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
522 failed_login t('user.login.auth failure')
527 # handle OpenID authentication
528 def openid_authentication(openid_url)
529 # If we don't appear to have a user for this URL then ask the
530 # provider for some extra information to help with signup
531 if openid_url and User.find_by_openid_url(openid_url)
534 required = [:nickname, :email, "http://axschema.org/namePerson/friendly", "http://axschema.org/contact/email"]
537 # Start the authentication
538 authenticate_with_open_id(openid_expand_url(openid_url), :method => :get, :required => required) do |result, identity_url, sreg, ax|
539 if result.successful?
540 # We need to use the openid url passed back from the OpenID provider
541 # rather than the one supplied by the user, as these can be different.
543 # For example, you can simply enter yahoo.com in the login box rather
544 # than a user specific url. Only once it comes back from the provider
545 # provider do we know the unique address for the user.
546 if user = User.find_by_openid_url(identity_url)
549 failed_login t('user.login.account not active', :reconfirm => url_for(:action => 'confirm_resend', :display_name => user.display_name))
550 when "active", "confirmed" then
551 successful_login(user)
552 when "suspended" then
553 failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
555 failed_login t('user.login.auth failure')
558 # Guard against not getting any extension data
559 sreg = Hash.new if sreg.nil?
560 ax = Hash.new if ax.nil?
562 # We don't have a user registered to this OpenID, so redirect
563 # to the create account page with username and email filled
564 # in if they have been given by the OpenID provider through
565 # the simple registration protocol.
566 nickname = sreg["nickname"] || ax["http://axschema.org/namePerson/friendly"].first
567 email = sreg["email"] || ax["http://axschema.org/contact/email"].first
569 # Check if the openID is from a "trusted" OpenID provider and thus provides a verified email address
570 session[:openid_verified] = openid_email_verified(identity_url, email)
571 redirect_to :controller => 'user', :action => 'new', :nickname => nickname, :email => email, :openid => identity_url
573 elsif result.missing?
574 failed_login t('user.login.openid missing provider')
575 elsif result.invalid?
576 failed_login t('user.login.openid invalid')
578 failed_login t('user.login.auth failure')
584 # verify an OpenID URL
585 def openid_verify(openid_url, user)
586 user.openid_url = openid_url
588 authenticate_with_open_id(openid_expand_url(openid_url), :method => :get) do |result, identity_url|
589 if result.successful?
590 # We need to use the openid url passed back from the OpenID provider
591 # rather than the one supplied by the user, as these can be different.
593 # For example, you can simply enter yahoo.com in the login box rather
594 # than a user specific url. Only once it comes back from the provider
595 # provider do we know the unique address for the user.
596 user.openid_url = identity_url
598 elsif result.missing?
599 flash.now[:error] = t 'user.login.openid missing provider'
600 elsif result.invalid?
601 flash.now[:error] = t 'user.login.openid invalid'
603 flash.now[:error] = t 'user.login.auth failure'
609 # special case some common OpenID providers by applying heuristics to
610 # try and come up with the correct URL based on what the user entered
611 def openid_expand_url(openid_url)
614 elsif openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
615 # Special case gmail.com as it is potentially a popular OpenID
616 # provider and, unlike yahoo.com, where it works automatically, Google
617 # have hidden their OpenID endpoint somewhere obscure this making it
618 # somewhat less user friendly.
619 return 'https://www.google.com/accounts/o8/id'
625 def openid_email_verified(openid_url, email)
626 # OpenID providers Google and Yahoo are guaranteed to return (if at all) an email address that has been verified by
627 # them already. So we can trust the email addresses to be valid and own by the user without having to verify them our
629 # Store the email in the session to compare agains the user set email address during account creation.
630 openid_verified = Hash.new
631 openid_verified[:identity_url] = openid_url
632 if openid_url.match(/https:\/\/www.google.com\/accounts\/o8\/id?(.*)/) or openid_url.match(/https:\/\/me.yahoo.com\/(.*)/)
633 openid_verified[:email] = email
635 return openid_verified
640 # process a successful login
641 def successful_login(user)
642 cookies.permanent["_osm_username"] = user.display_name
644 session[:user] = user.id
645 session_expires_after 28.days if session[:remember_me]
647 target = session[:referer] || url_for(:controller => :site, :action => :index)
649 # The user is logged in, so decide where to send them:
651 # - If they haven't seen the contributor terms, send them there.
652 # - If they have a block on them, show them that.
653 # - If they were referred to the login, send them back there.
654 # - Otherwise, send them to the home page.
655 if REQUIRE_TERMS_SEEN and not user.terms_seen
656 redirect_to :controller => :user, :action => :terms, :referer => target
657 elsif user.blocked_on_view
658 redirect_to user.blocked_on_view, :referer => target
663 session.delete(:remember_me)
664 session.delete(:referer)
668 # process a failed login
669 def failed_login(message)
670 flash[:error] = message
672 redirect_to :action => 'login', :referer => session[:referer]
674 session.delete(:remember_me)
675 session.delete(:referer)
679 # update a user's details
680 def update_user(user, params)
681 user.display_name = params[:user][:display_name]
682 user.new_email = params[:user][:new_email]
684 if params[:user][:pass_crypt].length > 0 or params[:user][:pass_crypt_confirmation].length > 0
685 user.pass_crypt = params[:user][:pass_crypt]
686 user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
689 if params[:user][:description] != user.description
690 user.description = params[:user][:description]
691 user.description_format = "markdown"
694 user.languages = params[:user][:languages].split(",")
696 case params[:image_action]
698 user.image = params[:user][:image]
699 user.image_use_gravatar = false
702 user.image_use_gravatar = false
705 user.image_use_gravatar = true
708 user.home_lat = params[:user][:home_lat]
709 user.home_lon = params[:user][:home_lon]
711 if params[:user][:preferred_editor] == "default"
712 user.preferred_editor = nil
714 user.preferred_editor = params[:user][:preferred_editor]
717 user.openid_url = nil if params[:user][:openid_url].blank?
722 cookies.permanent["_osm_username"] = user.display_name
724 if user.new_email.blank?
725 flash.now[:notice] = t 'user.account.flash update success'
727 user.email = user.new_email
730 flash.now[:notice] = t 'user.account.flash update success confirm needed'
733 Notifier.email_confirm(user, user.tokens.create).deliver
735 # Ignore errors sending email
738 @user.errors.set(:new_email, @user.errors.get(:email))
739 @user.errors.set(:email, [])
748 # require that the user is a administrator, or fill out a helpful error message
749 # and return them to the user page.
750 def require_administrator
751 if @user and not @user.administrator?
752 flash[:error] = t('user.filter.not_an_administrator')
754 if params[:display_name]
755 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
757 redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
760 redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
765 # ensure that there is a "this_user" instance variable
766 def lookup_user_by_id
767 @this_user = User.find(params[:id])
771 # ensure that there is a "this_user" instance variable
772 def lookup_user_by_name
773 @this_user = User.find_by_display_name(params[:display_name])
774 rescue ActiveRecord::RecordNotFound
775 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name] unless @this_user
779 # Choose the layout to use. See
780 # https://rails.lighthouseapp.com/projects/8994/tickets/5371-layout-with-onlyexcept-options-makes-other-actions-render-without-layouts
782 oauth_url = url_for(:controller => :oauth, :action => :authorize, :only_path => true)
784 if [ 'api_details' ].include? action_name
786 elsif params[:referer] and URI.parse(params[:referer]).path == oauth_url
795 def disable_terms_redirect
796 # this is necessary otherwise going to the user terms page, when
797 # having not agreed already would cause an infinite redirect loop.
798 # it's .now so that this doesn't propagate to other pages.
799 flash.now[:skip_terms] = true