]> git.openstreetmap.org Git - rails.git/blobdiff - app/controllers/user_controller.rb
Merge branch 'master' into openid
[rails.git] / app / controllers / user_controller.rb
index b558311d21c4df4019e5dde63679089c0ffa9567..0459d9a534eb6a581600364ee49e2c6a363eea5a 100644 (file)
@@ -18,81 +18,79 @@ class UserController < ApplicationController
 
   cache_sweeper :user_sweeper, :only => [:account, :set_status, :delete]
 
 
   cache_sweeper :user_sweeper, :only => [:account, :set_status, :delete]
 
+  def terms
+    @title = t 'user.new.title'
+    @legale = params[:legale] || OSM.IPToCountry(request.remote_ip) || APP_CONFIG['default_legale']
+    @text = OSM.legal_text_for_country(@legale)
+
+    if request.xhr?
+      render :update do |page|
+        page.replace_html "contributorTerms", :partial => "terms"
+      end
+    elsif params[:open_id_complete] 
+      # The redirect from the OpenID provider reenters here
+      # again and we need to pass the parameters through to
+      # the open_id_authentication function
+      @user = session.delete(:new_user)
+
+      openid_verify(nil, @user) do |user|
+      end
+
+      if @user.openid_url.nil? or @user.invalid?
+        render :action => 'new'
+      else
+        render :action => 'terms'
+      end
+    else
+      session[:referer] = params[:referer]
+
+      @user = User.new(params[:user])
+      @user.openid_url = nil
+
+      if params[:user][:openid_url] and @user.pass_crypt.empty?
+        # We are creating an account with OpenID and no password
+        # was specified so create a random one
+        @user.pass_crypt = ActiveSupport::SecureRandom.base64(16) 
+        @user.pass_crypt_confirmation = @user.pass_crypt 
+      end
+
+      if @user.valid?
+        if params[:user][:openid_url].nil? or
+            params[:user][:openid_url].empty?
+          # No OpenID so just move on to the terms
+          render :action => 'terms'
+        else
+          # Verify OpenID before moving on
+          session[:new_user] = @user
+          openid_verify(params[:user][:openid_url], @user)
+        end
+      else
+        # Something is wrong, so rerender the form
+        render :action => 'new'
+      end
+    end
+  end
+
   def save
     @title = t 'user.new.title'
 
     if Acl.find_by_address(request.remote_ip, :conditions => {:k => "no_account_creation"})
       render :action => 'new'
   def save
     @title = t 'user.new.title'
 
     if Acl.find_by_address(request.remote_ip, :conditions => {:k => "no_account_creation"})
       render :action => 'new'
+    elsif params[:decline]
+      redirect_to t('user.terms.declined')
     else
     else
-      #The redirect from the OpenID provider reenters here again 
-      #and we need to pass the parameters through to the  
-      #open_id_authentication function a second time 
-      if params[:open_id_complete] 
-        openid_verify('', true) 
-        #We have set the user.openid_url to nil beforehand. If it hasn't 
-        #been set to a new valid openid_url, it means the openid couldn't be validated 
-        if @user.nil? or @user.openid_url.nil? 
-          render :action => 'new' 
-          return 
-        end   
-      else
-        @user = User.new(params[:user])
-
-        @user.status = "pending"
-        @user.data_public = true
-        @user.description = "" if @user.description.nil?
-        @user.creation_ip = request.remote_ip
-        @user.languages = request.user_preferred_languages
-        #Set the openid_url to nil as for one it is used 
-        #to check if the openid could be validated and secondly 
-        #to not get dupplicate conflicts for an empty openid  
-        @user.openid_url = nil
-
-        if (!params[:user][:openid_url].nil? and params[:user][:openid_url].length > 0)
-          if (@user.pass_crypt.nil? or @user.pass_crypt.length == 0)
-            #if the password is empty, but we have a openid 
-            #then generate a random passowrd to disable 
-            #loging in via password 
-            @user.pass_crypt = ActiveSupport::SecureRandom.base64(16) 
-            @user.pass_crypt_confirmation = @user.pass_crypt 
-          end
-          #Validate all of the other fields before
-          #redirecting to the openid provider
-          if !@user.valid?
-            render :action => 'new'
-          else        
-            #TODO: Is it a problem to store the user variable with respect to password safty in the session variables?
-            #Store the user variable in the session for it to be accessible when redirecting back from the openid provider
-            session[:new_usr] = @user
-            begin
-              @norm_openid_url = OpenIdAuthentication.normalize_identifier(params[:user][:openid_url])
-            rescue
-              flash.now[:error] = t 'user.login.openid invalid'
-              render :action => 'new'
-              return
-            end
-            #Verify that the openid provided is valid and that the user is the owner of the id
-            openid_verify(@norm_openid_url, true)
-            #openid_verify can return in two ways:
-            #Either it returns with a redirect to the openid provider who then freshly
-            #redirects back to this url if the openid is valid, or if the openid is not plausible
-            #and no provider for it could be found it just returns
-            #we want to just let the redirect through
-            if response.headers["Location"].nil?
-              render :action => 'new'
-            end
-          end
-          #At this point there was either an error and the page has been rendered,
-          #or there is a redirect to the openid provider and the rest of the method
-          #gets executed whenn this method gets reentered after redirecting back
-          #from the openid provider
-          return
-        end
-      end
+      @user = User.new(params[:user])
+
+      @user.status = "pending"
+      @user.data_public = true
+      @user.description = "" if @user.description.nil?
+      @user.creation_ip = request.remote_ip
+      @user.languages = request.user_preferred_languages
+      @user.terms_agreed = Time.now.getutc
 
       if @user.save
         flash[:notice] = t 'user.new.flash create success message'
 
       if @user.save
         flash[:notice] = t 'user.new.flash create success message'
-        Notifier.deliver_signup_confirm(@user, @user.tokens.create(:referer => params[:referer]))
+        Notifier.deliver_signup_confirm(@user, @user.tokens.create(:referer => session.delete(:referer)))
         redirect_to :action => 'login'
       else
         render :action => 'new'
         redirect_to :action => 'login'
       else
         render :action => 'new'
@@ -104,16 +102,15 @@ class UserController < ApplicationController
     @title = t 'user.account.title'
     @tokens = @user.oauth_tokens.find :all, :conditions => 'oauth_tokens.invalidated_at is null and oauth_tokens.authorized_at is not null'
 
     @title = t 'user.account.title'
     @tokens = @user.oauth_tokens.find :all, :conditions => 'oauth_tokens.invalidated_at is null and oauth_tokens.authorized_at is not null'
 
-    #The redirect from the OpenID provider reenters here again
-    #and we need to pass the parameters through to the 
-    #open_id_authentication function
     if params[:open_id_complete]
     if params[:open_id_complete]
-      openid_verify('', false)
-      @user.save
-      return
-    end
-
-    if params[:user] and params[:user][:display_name] and params[:user][:description]
+      # The redirect from the OpenID provider reenters here
+      # again and we need to pass the parameters through to
+      # the open_id_authentication function
+      @user = session.delete(:new_user)
+      openid_verify(nil, @user) do |user|
+        update_user(user)
+      end
+    elsif params[:user] and params[:user][:display_name] and params[:user][:description]
       @user.display_name = params[:user][:display_name]
       @user.new_email = params[:user][:new_email]
 
       @user.display_name = params[:user][:display_name]
       @user.new_email = params[:user][:new_email]
 
@@ -133,135 +130,21 @@ class UserController < ApplicationController
       @user.home_lat = params[:user][:home_lat]
       @user.home_lon = params[:user][:home_lon]
 
       @user.home_lat = params[:user][:home_lat]
       @user.home_lon = params[:user][:home_lon]
 
-      @user.openid_url = nil if (params[:user][:openid_url].length == 0)
-
-      if @user.save
-        set_locale
-
-        if @user.new_email.nil? or @user.new_email.empty?
-          flash[:notice] = t 'user.account.flash update success'
-        else
-          flash[:notice] = t 'user.account.flash update success confirm needed'
-
-          begin
-            Notifier.deliver_email_confirm(@user, @user.tokens.create)
-          rescue
-            # Ignore errors sending email
-          end
-        end
-
-        redirect_to :action => "account", :display_name => @user.display_name
-      end
-
-      if (params[:user][:openid_url].length > 0)
-        begin
-          @norm_openid_url = OpenIdAuthentication.normalize_identifier(params[:user][:openid_url])
-          if (@norm_openid_url != @user.openid_url)
-            #If the OpenID has changed, we want to check that it is a valid OpenID and one
-            #the user has control over before saving the openID as a password equivalent for
-            #the user.
-            openid_verify(@norm_openid_url, false)
-          end
-        rescue
-          flash.now[:error] = t 'user.login.openid invalid'
-        end
-      end
-
-    else
-      if flash[:errors]
-        flash[:errors].each do |attr,msg|
-          attr = "new_email" if attr == "email"
-          @user.errors.add(attr,msg)
-        end
-      end
-    end
-  end
-
-  def openid_specialcase_mapping(openid_url)
-    #Special case gmail.com, as it is pontentially a popular OpenID provider and unlike
-    #yahoo.com, where it works automatically, Google have hidden their OpenID endpoint
-    #somewhere obscure making it less userfriendly.
-    if (openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/) )
-      return 'https://www.google.com/accounts/o8/id'
-    end
-
-    return nil
-  end  
+      @user.openid_url = nil if params[:user][:openid_url].empty?
 
 
-  def openid_verify(openid_url,account_create)
-    authenticate_with_open_id(openid_url) do |result, identity_url|
-      if result.successful?
-        #We need to use the openid url passed back from the OpenID provider
-        #rather than the one supplied by the user, as these can be different.
-        #e.g. one can simply enter yahoo.com in the login box, i.e. no user specific url
-        #only once it comes back from the OpenID provider do we know the unique address for
-        #the user.
-        @user = session[:new_usr] unless @user #this is used for account creation when the user is not yet in the database
-        @user.openid_url = identity_url
-      elsif result.missing?
-        mapped_id = openid_specialcase_mapping(openid_url)
-        if mapped_id
-          openid_verify(mapped_id, account_create)
-        else
-          flash.now[:error] = t 'user.login.openid missing provider'
-        end
-      elsif result.invalid?
-        flash.now[:error] = t 'user.login.openid invalid'
+      if params[:user][:openid_url].length > 0 and
+         params[:user][:openid_url] != @user.openid_url
+        # If the OpenID has changed, we want to check that it is a
+        # valid OpenID and one the user has control over before saving
+        # it as a password equivalent for the user.
+        session[:new_user] = @user
+        openid_verify(params[:user][:openid_url], @user)
       else
       else
-        flash.now[:error] = t 'user.login.auth failure'
+        update_user(@user)
       end
     end
   end
 
       end
     end
   end
 
-  def open_id_authentication(openid_url)
-    #TODO: only ask for nickname and email, if we don't already have a user for that openID, in which case
-    #email and nickname are already filled out. I don't know how to do that with ruby syntax though, as we
-    #don't want to duplicate the do block
-    #On the other hand it also doesn't matter too much if we ask every time, as the OpenID provider should
-    #remember these results, and shouldn't repromt the user for these data each time.
-    user = nil
-    authenticate_with_open_id(openid_url, :return_to => request.protocol + request.host_with_port + '/login?referer=' + params[:referer], :optional => [:nickname, :email]) do |result, identity_url, registration|
-      if result.successful?
-        #We need to use the openid url passed back from the OpenID provider
-        #rather than the one supplied by the user, as these can be different.
-        #e.g. one can simply enter yahoo.com in the login box, i.e. no user specific url
-        #only once it comes back from the OpenID provider do we know the unique address for
-        #the user.
-        user = User.find_by_openid_url(identity_url)
-        if user
-          if user.visible? and user.active?
-            session[:user] = user.id
-            session_expires_after 1.month if session[:remember]
-            return user
-          else
-            user = nil
-            flash.now[:error] = t 'user.login.account not active'
-          end
-        else
-          #We don't have a user registered to this OpenID. Redirect to the create account page
-          #with username and email filled in if they have been given by the OpenID provider through
-          #the simple registration protocol
-          redirect_to :controller => 'user', :action => 'new', :nickname => registration['nickname'], :email => registration['email'], :openid => identity_url
-        end
-      else if result.missing?
-             #Try and apply some heuristics to make common cases more userfriendly
-             mapped_id = openid_specialcase_mapping(openid_url)
-             if mapped_id
-               open_id_authentication(mapped_id)
-             else
-               flash.now[:error] = t 'user.login.openid missing provider'
-             end
-           else if result.invalid?
-                  flash.now[:error] = t 'user.login.openid invalid'
-                else
-                  flash.now[:error] = t 'user.login.auth failure'
-                end
-           end
-      end
-    end
-    return user
-  end
-
   def go_public
     @user.data_public = true
     @user.save
   def go_public
     @user.data_public = true
     @user.save
@@ -316,63 +199,29 @@ class UserController < ApplicationController
 
   def new
     @title = t 'user.new.title'
 
   def new
     @title = t 'user.new.title'
+    @referer = params[:referer] || session[:referer]
 
 
-    # The user is logged in already, so don't show them the signup
-    # page, instead send them to the home page
-    redirect_to :controller => 'site', :action => 'index' if session[:user]
-
-    @nickname = params['nickname']
-    @email = params['email']
-    @openID = params['openid']
-       
-    if !params['openid'].nil?
+    if session[:user]
+      # The user is logged in already, so don't show them the signup
+      # page, instead send them to the home page
+      redirect_to :controller => 'site', :action => 'index'
+    elsif not params['openid'].nil?
       flash.now[:notice] = t 'user.new.openid association'
     end
   end
 
   def login
       flash.now[:notice] = t 'user.new.openid association'
     end
   end
 
   def login
-    @title = t 'user.login.title'
-
-    #The redirect from the OpenID provider reenters here again
-    #and we need to pass the parameters through to the 
-    # open_id_authentication function
-    if params[:open_id_complete]
-      user = open_id_authentication('')
-    elsif params[:user]
-      if !params[:user][:openid_url].nil? and !params[:user][:openid_url].empty?
-        session[:remember] = params[:remember_me]
-        #construct the openid request. This will redirect to the OpenID server to ask for validation
-        #The external OpenID server will then redirect back to the login method and reenters at the top
-        open_id_authentication(params[:user][:openid_url])
-        return
-      else
-        email_or_display_name = params[:user][:email]
-        pass = params[:user][:password]
-
-        if user = User.authenticate(:username => email_or_display_name, :password => pass)
-          session[:user] = user.id
-          session_expires_after 1.month if params[:remember_me]
-        elsif User.authenticate(:username => email_or_display_name, :password => pass, :pending => true)
-          flash.now[:error] = t 'user.login.account not active'
-        elsif User.authenticate(:username => email_or_display_name, :password => pass, :suspended => true)
-          flash.now[:error] = t 'user.login.account suspended'
-        else
-          flash.now[:error] = t 'user.login.auth failure'
-        end
-      end
-    end
+    if request.post?
+      session[:remember_me] ||= params[:remember_me]
+      session[:referer] ||= params[:referer]
 
 
-    if user
-      # The user is logged in, if the referer param exists, redirect
-      # them to that unless they've also got a block on them, in
-      # which case redirect them to the block so they can clear it.
-      if user.blocked_on_view
-        redirect_to user.blocked_on_view, :referrer => params[:referrer]
-      elsif params[:referer]
-        redirect_to params[:referer]
+      if using_open_id?(params[:openid_url])
+        openid_authentication(params[:openid_url])
       else
       else
-        redirect_to :controller => 'site', :action => 'index'
+        password_authentication(params[:username], params[:password])
       end
       end
+    else
+      @title = t 'user.login.title'
     end
   end
 
     end
   end
 
@@ -546,6 +395,164 @@ class UserController < ApplicationController
 
 private
 
 
 private
 
+  ##
+  # handle password authentication
+  def password_authentication(username, password)
+    if user = User.authenticate(:username => username, :password => password)
+      successful_login(user)
+    elsif User.authenticate(:username => username, :password => password, :pending => true)
+      failed_login t('user.login.account not active')
+    elsif User.authenticate(:username => username, :password => password, :suspended => true)
+      failed_login t('user.login.account suspended')
+    else
+      failed_login t('user.login.auth failure')
+    end
+  end
+
+  ##
+  # handle OpenID authentication
+  def openid_authentication(openid_url)
+    # If we don't appear to have a user for this URL then ask the
+    # provider for some extra information to help with signup
+    if openid_url and User.find_by_openid_url(openid_url)
+      optional = nil
+    else
+      optional = [:nickname, :email]
+    end
+
+    # Start the authentication
+    authenticate_with_open_id(openid_url, :optional => optional) do |result, identity_url, registration|
+      if result.successful?
+        # We need to use the openid url passed back from the OpenID provider
+        # rather than the one supplied by the user, as these can be different.
+        #
+        # For example, you can simply enter yahoo.com in the login box rather
+        # than a user specific url. Only once it comes back from the provider
+        # provider do we know the unique address for the user.
+        if user = User.find_by_openid_url(identity_url)
+          case user.status
+            when "pending" then failed_login t('user.login.account not active')
+            when "active", "confirmed" then successful_login(user)
+            when "suspended" then failed_login t('user.login.account suspended')
+            else failed_login t('user.login.auth failure')
+          end
+        else
+          # We don't have a user registered to this OpenID, so redirect
+          # to the create account page with username and email filled
+          # in if they have been given by the OpenID provider through
+          # the simple registration protocol.
+          redirect_to :controller => 'user', :action => 'new', :nickname => registration['nickname'], :email => registration['email'], :openid => identity_url
+        end
+      elsif result.missing?
+        # Try and apply some heuristics to make common cases more user friendly
+        if openid_url = openid_alternate_url(openid_url)
+          openid_authentication(openid_url)
+        else
+          failed_login t('user.login.openid missing provider')
+        end
+      elsif result.invalid?
+        failed_login t('user.login.openid invalid')
+      else
+        failed_login t('user.login.auth failure')
+      end
+    end
+  end
+
+  ##
+  # verify an OpenID URL
+  def openid_verify(openid_url, user)
+    user.openid_url = openid_url
+
+    authenticate_with_open_id(openid_url) do |result, identity_url|
+      if result.successful?
+        # We need to use the openid url passed back from the OpenID provider
+        # rather than the one supplied by the user, as these can be different.
+        #
+        # For example, you can simply enter yahoo.com in the login box rather
+        # than a user specific url. Only once it comes back from the provider
+        # provider do we know the unique address for the user.
+        user.openid_url = identity_url
+        yield user
+      elsif result.missing?
+        # Try and apply some heuristics to make common cases more user friendly
+        if openid_url = openid_alternate_url(openid_url)
+          openid_verify(openid_url, user)
+        else
+          flash.now[:error] = t 'user.login.openid missing provider'
+        end
+      elsif result.invalid?
+        flash.now[:error] = t 'user.login.openid invalid'
+      else
+        flash.now[:error] = t 'user.login.auth failure'
+      end
+    end
+  end
+
+  ##
+  # special case some common OpenID providers by applying heuristics
+  # to try and come up with an alternate URL if the supplied one fails
+  def openid_alternate_url(openid_url)
+    # Special case gmail.com as it is potentially a popular OpenID
+    # provider and, unlike yahoo.com, where it works automatically, Google
+    # have hidden their OpenID endpoint somewhere obscure this making it
+    # somewhat less user friendly.
+    if openid_url.match(/(.*)gmail.com(\/?)$/) or openid_url.match(/(.*)googlemail.com(\/?)$/)
+      return 'https://www.google.com/accounts/o8/id'
+    else
+      return nil
+    end
+  end  
+
+  ##
+  # process a successful login
+  def successful_login(user)
+    session[:user] = user.id
+
+    session_expires_after 1.month if session[:remember_me]
+
+    if user.blocked_on_view
+      redirect_to user.blocked_on_view, :referer => params[:referer]
+    elsif session[:referer]
+      redirect_to session[:referer]
+    else
+      redirect_to :controller => 'site', :action => 'index'
+    end
+
+    session.delete(:remember_me)
+    session.delete(:referer)
+  end
+
+  ##
+  # process a failed login
+  def failed_login(message)
+    flash[:error] = message
+
+    redirect_to :action => 'login', :referer =>  session[:referer]
+
+    session.delete(:remember_me)
+    session.delete(:referer)
+  end
+
+  ##
+  # update a user's details
+  def update_user(user)
+    if user.save
+      set_locale
+
+      if user.new_email.nil? or user.new_email.empty?
+        flash.now[:notice] = t 'user.account.flash update success'
+      else
+        flash.now[:notice] = t 'user.account.flash update success confirm needed'
+
+        begin
+          Notifier.deliver_email_confirm(user, user.tokens.create)
+        rescue
+          # Ignore errors sending email
+        end
+      end
+    end
+  end
+
   ##
   # require that the user is a administrator, or fill out a helpful error message
   # and return them to the user page.
   ##
   # require that the user is a administrator, or fill out a helpful error message
   # and return them to the user page.