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 => [:new, :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]
22 @legale = params[:legale] || OSM.IPToCountry(request.remote_ip) || DEFAULT_LEGALE
23 @text = OSM.legal_text_for_country(@legale)
26 render :partial => "terms"
28 @title = t 'user.terms.title'
30 if @user and @user.terms_agreed?
31 # Already agreed to terms, so just show settings
32 redirect_to :action => :account, :display_name => @user.display_name
33 elsif @user.nil? and session[:new_user].nil?
34 redirect_to :action => :login, :referer => request.fullpath
40 @title = t 'user.new.title'
44 @user.terms_seen = true
47 flash[:notice] = t 'user.new.terms declined', :url => t('user.new.terms declined url')
51 redirect_to params[:referer]
53 redirect_to :action => :account, :display_name => @user.display_name
56 redirect_to t('user.terms.declined')
59 if !@user.terms_agreed?
60 @user.consider_pd = params[:user][:consider_pd]
61 @user.terms_agreed = Time.now.getutc
62 @user.terms_seen = true
64 flash[:notice] = t 'user.new.terms accepted'
69 redirect_to params[:referer]
71 redirect_to :action => :account, :display_name => @user.display_name
74 @user = session.delete(:new_user)
76 if check_signup_allowed(@user.email)
77 @user.data_public = true
78 @user.description = "" if @user.description.nil?
79 @user.creation_ip = request.remote_ip
80 @user.languages = http_accept_language.user_preferred_languages
81 @user.terms_agreed = Time.now.getutc
82 @user.terms_seen = true
83 @user.openid_url = nil if @user.openid_url and @user.openid_url.empty?
86 flash[:piwik_goal] = PIWIK["goals"]["signup"] if defined?(PIWIK)
88 referer = welcome_path
91 uri = URI(session[:referer])
92 /map=(.*)\/(.*)\/(.*)/.match(uri.fragment) do |m|
93 editor = Rack::Utils.parse_query(uri.query).slice('editor')
94 referer = welcome_path({'zoom' => m[1],
96 'lon' => m[3]}.merge(editor))
102 if @user.status == "active"
103 session[:referer] = referer
104 successful_login(@user)
106 session[:token] = @user.tokens.create.token
107 Notifier.signup_confirm(@user, @user.tokens.create(:referer => referer)).deliver
108 redirect_to :action => 'confirm', :display_name => @user.display_name
111 render :action => 'new', :referer => params[:referer]
118 @title = t 'user.account.title'
119 @tokens = @user.oauth_tokens.authorized
121 if params[:user] and params[:user][:display_name] and params[:user][:description]
122 if params[:user][:openid_url] and
123 params[:user][:openid_url].length > 0 and
124 params[:user][:openid_url] != @user.openid_url
125 # If the OpenID has changed, we want to check that it is a
126 # valid OpenID and one the user has control over before saving
127 # it as a password equivalent for the user.
128 session[:new_user_settings] = params
129 openid_verify(params[:user][:openid_url], @user)
131 update_user(@user, params)
134 # The redirect from the OpenID provider reenters here
135 # again and we need to pass the parameters through to
136 # the open_id_authentication function
137 settings = session.delete(:new_user_settings)
138 openid_verify(nil, @user) do |user|
139 update_user(user, settings)
145 @user.data_public = true
147 flash[:notice] = t 'user.go_public.flash success'
148 redirect_to :controller => 'user', :action => 'account', :display_name => @user.display_name
152 @title = t 'user.lost_password.title'
154 if params[:user] and params[:user][:email]
155 user = User.visible.find_by_email(params[:user][:email])
158 users = User.visible.where("LOWER(email) = LOWER(?)", params[:user][:email])
166 token = user.tokens.create
167 Notifier.lost_password(user, token).deliver
168 flash[:notice] = t 'user.lost_password.notice email on way'
169 redirect_to :action => 'login'
171 flash.now[:error] = t 'user.lost_password.notice email cannot find'
177 @title = t 'user.reset_password.title'
180 token = UserToken.find_by_token(params[:token])
186 @user.pass_crypt = params[:user][:pass_crypt]
187 @user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
188 @user.status = "active" if @user.status == "pending"
189 @user.email_valid = true
193 flash[:notice] = t 'user.reset_password.flash changed'
194 redirect_to :action => 'login'
198 flash[:error] = t 'user.reset_password.flash token bad'
199 redirect_to :action => 'lost_password'
205 @title = t 'user.new.title'
206 @referer = params[:referer] || session[:referer]
209 # The redirect from the OpenID provider reenters here
210 # again and we need to pass the parameters through to
211 # the open_id_authentication function
212 @user = session.delete(:new_user)
214 openid_verify(nil, @user) do |user, verified_email|
215 user.status = "active" if user.email == verified_email
218 if @user.openid_url.nil? or @user.invalid?
219 render :action => 'new'
221 session[:new_user] = @user
222 redirect_to :action => 'terms'
225 # The user is logged in already, so don't show them the signup
226 # page, instead send them to the home page
230 redirect_to :controller => 'site', :action => 'index'
232 elsif params.key?(:openid)
233 @user = User.new(:email => params[:email],
234 :email_confirmation => params[:email],
235 :display_name => params[:nickname],
236 :openid_url => params[:openid])
238 flash.now[:notice] = t 'user.new.openid association'
245 @user = User.new(user_params)
247 if check_signup_allowed(@user.email)
248 session[:referer] = params[:referer]
250 @user.status = "pending"
252 if @user.openid_url.present? && @user.pass_crypt.empty?
253 # We are creating an account with OpenID and no password
254 # was specified so create a random one
255 @user.pass_crypt = SecureRandom.base64(16)
256 @user.pass_crypt_confirmation = @user.pass_crypt
260 # Something is wrong with a new user, so rerender the form
261 render :action => "new"
262 elsif @user.openid_url.present?
263 # Verify OpenID before moving on
264 session[:new_user] = @user
265 openid_verify(@user.openid_url, @user)
267 # Save the user record
268 session[:new_user] = @user
269 redirect_to :action => :terms
275 if params[:username] or using_open_id?
276 session[:remember_me] ||= params[:remember_me]
277 session[:referer] ||= params[:referer]
280 openid_authentication(params[:openid_url])
282 password_authentication(params[:username], params[:password])
288 @title = t 'user.logout.title'
290 if params[:session] == request.session_options[:id]
292 token = UserToken.find_by_token(session[:token])
296 session.delete(:token)
298 session.delete(:user)
299 session_expires_automatically
301 redirect_to params[:referer]
303 redirect_to :controller => 'site', :action => 'index'
310 token = UserToken.find_by_token(params[:confirm_string])
311 if token && token.user.active?
312 flash[:error] = t('user.confirm.already active')
313 redirect_to :action => 'login'
314 elsif !token || token.expired?
315 flash[:error] = t('user.confirm.unknown token')
316 redirect_to :action => 'confirm'
319 user.status = "active"
320 user.email_valid = true
322 referer = token.referer
326 token = UserToken.find_by_token(session[:token])
327 session.delete(:token)
332 if token.nil? or token.user != user
333 flash[:notice] = t('user.confirm.success')
334 redirect_to :action => :login, :referer => referer
338 session[:user] = user.id
339 cookies.permanent["_osm_username"] = user.display_name
341 redirect_to referer || welcome_path
345 user = User.find_by_display_name(params[:display_name])
346 if !user || user.active?
347 redirect_to root_path
353 if user = User.find_by_display_name(params[:display_name])
354 Notifier.signup_confirm(user, user.tokens.create).deliver
355 flash[:notice] = t 'user.confirm_resend.success', :email => user.email
357 flash[:notice] = t 'user.confirm_resend.failure', :name => params[:display_name]
360 redirect_to :action => 'login'
365 token = UserToken.find_by_token(params[:confirm_string])
366 if token and token.user.new_email?
368 @user.email = @user.new_email
369 @user.new_email = nil
370 @user.email_valid = true
372 flash[:notice] = t 'user.confirm_email.success'
374 flash[:errors] = @user.errors
377 session[:user] = @user.id
378 cookies.permanent["_osm_username"] = @user.display_name
379 redirect_to :action => 'account', :display_name => @user.display_name
381 flash[:error] = t 'user.confirm_email.failure'
382 redirect_to :action => 'account', :display_name => @user.display_name
388 render :text => "", :status => :gone unless @this_user.visible?
393 render :action => :api_read
397 doc = OSM::API.new.get_xml_doc
398 @user.traces.each do |trace|
399 doc.root << trace.to_xml_node() if trace.public? or trace.user == @user
401 render :text => doc.to_s, :content_type => "text/xml"
405 @this_user = User.find_by_display_name(params[:display_name])
408 (@this_user.visible? or (@user and @user.administrator?))
409 @title = @this_user.display_name
411 render_unknown_user params[:display_name]
416 @new_friend = User.find_by_display_name(params[:display_name])
421 friend.user_id = @user.id
422 friend.friend_user_id = @new_friend.id
423 unless @user.is_friends_with?(@new_friend)
425 flash[:notice] = t 'user.make_friend.success', :name => @new_friend.display_name
426 Notifier.friend_notification(friend).deliver
428 friend.add_error(t('user.make_friend.failed', :name => @new_friend.display_name))
431 flash[:warning] = t 'user.make_friend.already_a_friend', :name => @new_friend.display_name
435 redirect_to params[:referer]
437 redirect_to :controller => 'user', :action => 'view'
441 render_unknown_user params[:display_name]
446 @friend = User.find_by_display_name(params[:display_name])
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
454 flash[:error] = t 'user.remove_friend.not_a_friend', :name => @friend.display_name
458 redirect_to params[:referer]
460 redirect_to :controller => 'user', :action => 'view'
464 render_unknown_user params[:display_name]
469 # sets a user's status
471 @this_user.status = params[:status]
473 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
477 # delete a user, marking them as deleted and removing personal data
480 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
484 # display a list of users matching specified criteria
487 ids = params[:user].keys.collect { |id| id.to_i }
489 User.update_all("status = 'confirmed'", :id => ids) if params[:confirm]
490 User.update_all("status = 'deleted'", :id => ids) if params[:hide]
492 redirect_to url_for(:status => params[:status], :ip => params[:ip], :page => params[:page])
494 conditions = Hash.new
495 conditions[:status] = params[:status] if params[:status]
496 conditions[:creation_ip] = params[:ip] if params[:ip]
498 @user_pages, @users = paginate(:users,
499 :conditions => conditions,
508 # handle password authentication
509 def password_authentication(username, password)
510 if user = User.authenticate(:username => username, :password => password)
511 successful_login(user)
512 elsif user = User.authenticate(:username => username, :password => password, :pending => true)
513 unconfirmed_login(user)
514 elsif User.authenticate(:username => username, :password => password, :suspended => true)
515 failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
517 failed_login t('user.login.auth failure')
522 # handle OpenID authentication
523 def openid_authentication(openid_url)
524 # If we don't appear to have a user for this URL then ask the
525 # provider for some extra information to help with signup
526 if openid_url and User.find_by_openid_url(openid_url)
529 required = [:nickname, :email, "http://axschema.org/namePerson/friendly", "http://axschema.org/contact/email"]
532 # Start the authentication
533 authenticate_with_open_id(openid_expand_url(openid_url), :method => :get, :required => required) do |result, identity_url, sreg, ax|
534 if result.successful?
535 # We need to use the openid url passed back from the OpenID provider
536 # rather than the one supplied by the user, as these can be different.
538 # For example, you can simply enter yahoo.com in the login box rather
539 # than a user specific url. Only once it comes back from the provider
540 # provider do we know the unique address for the user.
541 if user = User.find_by_openid_url(identity_url)
544 unconfirmed_login(user)
545 when "active", "confirmed" then
546 successful_login(user)
547 when "suspended" then
548 failed_login t('user.login.account is suspended', :webmaster => "mailto:webmaster@openstreetmap.org")
550 failed_login t('user.login.auth failure')
553 # Guard against not getting any extension data
554 sreg = Hash.new if sreg.nil?
555 ax = Hash.new if ax.nil?
557 # We don't have a user registered to this OpenID, so redirect
558 # to the create account page with username and email filled
559 # in if they have been given by the OpenID provider through
560 # the simple registration protocol.
561 nickname = sreg["nickname"] || ax["http://axschema.org/namePerson/friendly"].first
562 email = sreg["email"] || ax["http://axschema.org/contact/email"].first
564 redirect_to :controller => 'user', :action => 'new', :nickname => nickname, :email => email, :openid => identity_url
566 elsif result.missing?
567 failed_login t('user.login.openid missing provider')
568 elsif result.invalid?
569 failed_login t('user.login.openid invalid')
571 failed_login t('user.login.auth failure')
577 # verify an OpenID URL
578 def openid_verify(openid_url, user)
579 user.openid_url = openid_url
581 authenticate_with_open_id(openid_expand_url(openid_url), :method => :get, :required => [:email, "http://axschema.org/contact/email"]) do |result, identity_url, sreg, ax|
582 if result.successful?
583 # Do we trust the emails this provider returns?
584 if openid_email_verified(identity_url)
585 # Guard against not getting any extension data
586 sreg = Hash.new if sreg.nil?
587 ax = Hash.new if ax.nil?
589 # Get the verified email
590 verified_email = sreg["email"] || ax["http://axschema.org/contact/email"].first
593 # We need to use the openid url passed back from the OpenID provider
594 # rather than the one supplied by the user, as these can be different.
596 # For example, you can simply enter yahoo.com in the login box rather
597 # than a user specific url. Only once it comes back from the provider
598 # provider do we know the unique address for the user.
599 user.openid_url = identity_url
600 yield user, verified_email
601 elsif result.missing?
602 flash.now[:error] = t 'user.login.openid missing provider'
603 elsif result.invalid?
604 flash.now[:error] = t 'user.login.openid invalid'
606 flash.now[:error] = t 'user.login.auth failure'
612 # special case some common OpenID providers by applying heuristics to
613 # try and come up with the correct URL based on what the user entered
614 def openid_expand_url(openid_url)
617 elsif openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
618 # Special case gmail.com as it is potentially a popular OpenID
619 # provider and, unlike yahoo.com, where it works automatically, Google
620 # have hidden their OpenID endpoint somewhere obscure this making it
621 # somewhat less user friendly.
622 return 'https://www.google.com/accounts/o8/id'
629 # check if we trust an OpenID provider to return a verified
630 # email, so that we can skpi verifying it ourselves
631 def openid_email_verified(openid_url)
632 openid_url.match(/https:\/\/www.google.com\/accounts\/o8\/id?(.*)/) or
633 openid_url.match(/https:\/\/me.yahoo.com\/(.*)/)
637 # process a successful login
638 def successful_login(user)
639 cookies.permanent["_osm_username"] = user.display_name
641 session[:user] = user.id
642 session_expires_after 28.days if session[:remember_me]
644 target = session[:referer] || url_for(:controller => :site, :action => :index)
646 # The user is logged in, so decide where to send them:
648 # - If they haven't seen the contributor terms, send them there.
649 # - If they have a block on them, show them that.
650 # - If they were referred to the login, send them back there.
651 # - Otherwise, send them to the home page.
652 if REQUIRE_TERMS_SEEN and not user.terms_seen
653 redirect_to :controller => :user, :action => :terms, :referer => target
654 elsif user.blocked_on_view
655 redirect_to user.blocked_on_view, :referer => target
660 session.delete(:remember_me)
661 session.delete(:referer)
665 # process a failed login
666 def failed_login(message)
667 flash[:error] = message
669 redirect_to :action => 'login', :referer => session[:referer]
671 session.delete(:remember_me)
672 session.delete(:referer)
677 def unconfirmed_login(user)
678 redirect_to :action => 'confirm', :display_name => user.display_name
680 session.delete(:remember_me)
681 session.delete(:referer)
685 # update a user's details
686 def update_user(user, params)
687 user.display_name = params[:user][:display_name]
688 user.new_email = params[:user][:new_email]
690 if params[:user][:pass_crypt].length > 0 or params[:user][:pass_crypt_confirmation].length > 0
691 user.pass_crypt = params[:user][:pass_crypt]
692 user.pass_crypt_confirmation = params[:user][:pass_crypt_confirmation]
695 if params[:user][:description] != user.description
696 user.description = params[:user][:description]
697 user.description_format = "markdown"
700 user.languages = params[:user][:languages].split(",")
702 case params[:image_action]
704 user.image = params[:user][:image]
705 user.image_use_gravatar = false
708 user.image_use_gravatar = false
711 user.image_use_gravatar = true
714 user.home_lat = params[:user][:home_lat]
715 user.home_lon = params[:user][:home_lon]
717 if params[:user][:preferred_editor] == "default"
718 user.preferred_editor = nil
720 user.preferred_editor = params[:user][:preferred_editor]
723 user.openid_url = nil if params[:user][:openid_url].blank?
728 cookies.permanent["_osm_username"] = user.display_name
730 if user.new_email.blank? or user.new_email == user.email
731 flash.now[:notice] = t 'user.account.flash update success'
733 user.email = user.new_email
736 flash.now[:notice] = t 'user.account.flash update success confirm needed'
739 Notifier.email_confirm(user, user.tokens.create).deliver
741 # Ignore errors sending email
744 @user.errors.set(:new_email, @user.errors.get(:email))
745 @user.errors.set(:email, [])
754 # require that the user is a administrator, or fill out a helpful error message
755 # and return them to the user page.
756 def require_administrator
757 if @user and not @user.administrator?
758 flash[:error] = t('user.filter.not_an_administrator')
760 if params[:display_name]
761 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name]
763 redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
766 redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
771 # ensure that there is a "this_user" instance variable
772 def lookup_user_by_id
773 @this_user = User.find(params[:id])
777 # ensure that there is a "this_user" instance variable
778 def lookup_user_by_name
779 @this_user = User.find_by_display_name(params[:display_name])
780 rescue ActiveRecord::RecordNotFound
781 redirect_to :controller => 'user', :action => 'view', :display_name => params[:display_name] unless @this_user
785 # Choose the layout to use. See
786 # https://rails.lighthouseapp.com/projects/8994/tickets/5371-layout-with-onlyexcept-options-makes-other-actions-render-without-layouts
788 oauth_url = url_for(:controller => :oauth, :action => :authorize, :only_path => true)
790 if [ 'api_details' ].include? action_name
792 elsif params[:referer] and URI.parse(params[:referer]).path == oauth_url
801 def disable_terms_redirect
802 # this is necessary otherwise going to the user terms page, when
803 # having not agreed already would cause an infinite redirect loop.
804 # it's .now so that this doesn't propagate to other pages.
805 flash.now[:skip_terms] = true
809 # return permitted user parameters
811 params.require(:user).permit(:email, :email_confirmation, :display_name, :openid_url, :pass_crypt, :pass_crypt_confirmation)
816 def check_signup_allowed(email = nil)
820 domain = email.split("@").last
823 if blocked = Acl.no_account_creation(request.remote_ip, domain)
824 logger.info "Blocked signup from #{request.remote_ip} for #{email}"
826 render :action => 'blocked'