Chris@1517: # Redmine - project management software
Chris@1517: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1517: #
Chris@1517: # This program is free software; you can redistribute it and/or
Chris@1517: # modify it under the terms of the GNU General Public License
Chris@1517: # as published by the Free Software Foundation; either version 2
Chris@1517: # of the License, or (at your option) any later version.
Chris@1517: #
Chris@1517: # This program is distributed in the hope that it will be useful,
Chris@1517: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1517: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1517: # GNU General Public License for more details.
Chris@1517: #
Chris@1517: # You should have received a copy of the GNU General Public License
Chris@1517: # along with this program; if not, write to the Free Software
Chris@1517: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1517: 
Chris@1517: class AccountController < ApplicationController
Chris@1517:   helper :custom_fields
Chris@1517:   include CustomFieldsHelper
Chris@1517: 
Chris@1517:   # prevents login action to be filtered by check_if_login_required application scope filter
Chris@1517:   skip_before_filter :check_if_login_required, :check_password_change
Chris@1517: 
Chris@1517:   # Overrides ApplicationController#verify_authenticity_token to disable
Chris@1517:   # token verification on openid callbacks
Chris@1517:   def verify_authenticity_token
Chris@1517:     unless using_open_id?
Chris@1517:       super
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Login request and validation
Chris@1517:   def login
Chris@1517:     if request.get?
Chris@1517:       if User.current.logged?
Chris@1517:         redirect_back_or_default home_url, :referer => true
Chris@1517:       end
Chris@1517:     else
Chris@1517:       authenticate_user
Chris@1517:     end
Chris@1517:   rescue AuthSourceException => e
Chris@1517:     logger.error "An error occured when authenticating #{params[:username]}: #{e.message}"
Chris@1517:     render_error :message => e.message
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Log out current user and redirect to welcome page
Chris@1517:   def logout
Chris@1517:     if User.current.anonymous?
Chris@1517:       redirect_to home_url
Chris@1517:     elsif request.post?
Chris@1517:       logout_user
Chris@1517:       redirect_to home_url
Chris@1517:     end
Chris@1517:     # display the logout form
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Lets user choose a new password
Chris@1517:   def lost_password
Chris@1517:     (redirect_to(home_url); return) unless Setting.lost_password?
Chris@1517:     if params[:token]
Chris@1517:       @token = Token.find_token("recovery", params[:token].to_s)
Chris@1517:       if @token.nil? || @token.expired?
Chris@1517:         redirect_to home_url
Chris@1517:         return
Chris@1517:       end
Chris@1517:       @user = @token.user
Chris@1517:       unless @user && @user.active?
Chris@1517:         redirect_to home_url
Chris@1517:         return
Chris@1517:       end
Chris@1517:       if request.post?
Chris@1517:         @user.password, @user.password_confirmation = params[:new_password], params[:new_password_confirmation]
Chris@1517:         if @user.save
Chris@1517:           @token.destroy
Chris@1517:           flash[:notice] = l(:notice_account_password_updated)
Chris@1517:           redirect_to signin_path
Chris@1517:           return
Chris@1517:         end
Chris@1517:       end
Chris@1517:       render :template => "account/password_recovery"
Chris@1517:       return
Chris@1517:     else
Chris@1517:       if request.post?
Chris@1517:         user = User.find_by_mail(params[:mail].to_s)
Chris@1517:         # user not found
Chris@1517:         unless user
Chris@1517:           flash.now[:error] = l(:notice_account_unknown_email)
Chris@1517:           return
Chris@1517:         end
Chris@1517:         unless user.active?
Chris@1517:           handle_inactive_user(user, lost_password_path)
Chris@1517:           return
Chris@1517:         end
Chris@1517:         # user cannot change its password
Chris@1517:         unless user.change_password_allowed?
Chris@1517:           flash.now[:error] = l(:notice_can_t_change_password)
Chris@1517:           return
Chris@1517:         end
Chris@1517:         # create a new token for password recovery
Chris@1517:         token = Token.new(:user => user, :action => "recovery")
Chris@1517:         if token.save
Chris@1517:           Mailer.lost_password(token).deliver
Chris@1517:           flash[:notice] = l(:notice_account_lost_email_sent)
Chris@1517:           redirect_to signin_path
Chris@1517:           return
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   # User self-registration
Chris@1517:   def register
Chris@1517:     (redirect_to(home_url); return) unless Setting.self_registration? || session[:auth_source_registration]
Chris@1517:     if request.get?
Chris@1517:       session[:auth_source_registration] = nil
Chris@1517:       @user = User.new(:language => current_language.to_s)
Chris@1517:     else
Chris@1517:       user_params = params[:user] || {}
Chris@1517:       @user = User.new
Chris@1517:       @user.safe_attributes = user_params
Chris@1517:       @user.admin = false
Chris@1517:       @user.register
Chris@1517:       if session[:auth_source_registration]
Chris@1517:         @user.activate
Chris@1517:         @user.login = session[:auth_source_registration][:login]
Chris@1517:         @user.auth_source_id = session[:auth_source_registration][:auth_source_id]
Chris@1517:         if @user.save
Chris@1517:           session[:auth_source_registration] = nil
Chris@1517:           self.logged_user = @user
Chris@1517:           flash[:notice] = l(:notice_account_activated)
Chris@1517:           redirect_to my_account_path
Chris@1517:         end
Chris@1517:       else
Chris@1517:         @user.login = params[:user][:login]
Chris@1517:         unless user_params[:identity_url].present? && user_params[:password].blank? && user_params[:password_confirmation].blank?
Chris@1517:           @user.password, @user.password_confirmation = user_params[:password], user_params[:password_confirmation]
Chris@1517:         end
Chris@1517: 
Chris@1517:         case Setting.self_registration
Chris@1517:         when '1'
Chris@1517:           register_by_email_activation(@user)
Chris@1517:         when '3'
Chris@1517:           register_automatically(@user)
Chris@1517:         else
Chris@1517:           register_manually_by_administrator(@user)
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Token based account activation
Chris@1517:   def activate
Chris@1517:     (redirect_to(home_url); return) unless Setting.self_registration? && params[:token].present?
Chris@1517:     token = Token.find_token('register', params[:token].to_s)
Chris@1517:     (redirect_to(home_url); return) unless token and !token.expired?
Chris@1517:     user = token.user
Chris@1517:     (redirect_to(home_url); return) unless user.registered?
Chris@1517:     user.activate
Chris@1517:     if user.save
Chris@1517:       token.destroy
Chris@1517:       flash[:notice] = l(:notice_account_activated)
Chris@1517:     end
Chris@1517:     redirect_to signin_path
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Sends a new account activation email
Chris@1517:   def activation_email
Chris@1517:     if session[:registered_user_id] && Setting.self_registration == '1'
Chris@1517:       user_id = session.delete(:registered_user_id).to_i
Chris@1517:       user = User.find_by_id(user_id)
Chris@1517:       if user && user.registered?
Chris@1517:         register_by_email_activation(user)
Chris@1517:         return
Chris@1517:       end
Chris@1517:     end
Chris@1517:     redirect_to(home_url)
Chris@1517:   end
Chris@1517: 
Chris@1517:   private
Chris@1517: 
Chris@1517:   def authenticate_user
Chris@1517:     if Setting.openid? && using_open_id?
Chris@1517:       open_id_authenticate(params[:openid_url])
Chris@1517:     else
Chris@1517:       password_authentication
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def password_authentication
Chris@1517:     user = User.try_to_login(params[:username], params[:password], false)
Chris@1517: 
Chris@1517:     if user.nil?
Chris@1517:       invalid_credentials
Chris@1517:     elsif user.new_record?
Chris@1517:       onthefly_creation_failed(user, {:login => user.login, :auth_source_id => user.auth_source_id })
Chris@1517:     else
Chris@1517:       # Valid user
Chris@1517:       if user.active?
Chris@1517:         successful_authentication(user)
Chris@1517:       else
Chris@1517:         handle_inactive_user(user)
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def open_id_authenticate(openid_url)
Chris@1517:     back_url = signin_url(:autologin => params[:autologin])
Chris@1517:     authenticate_with_open_id(
Chris@1517:           openid_url, :required => [:nickname, :fullname, :email],
Chris@1517:           :return_to => back_url, :method => :post
Chris@1517:     ) do |result, identity_url, registration|
Chris@1517:       if result.successful?
Chris@1517:         user = User.find_or_initialize_by_identity_url(identity_url)
Chris@1517:         if user.new_record?
Chris@1517:           # Self-registration off
Chris@1517:           (redirect_to(home_url); return) unless Setting.self_registration?
Chris@1517:           # Create on the fly
Chris@1517:           user.login = registration['nickname'] unless registration['nickname'].nil?
Chris@1517:           user.mail = registration['email'] unless registration['email'].nil?
Chris@1517:           user.firstname, user.lastname = registration['fullname'].split(' ') unless registration['fullname'].nil?
Chris@1517:           user.random_password
Chris@1517:           user.register
Chris@1517:           case Setting.self_registration
Chris@1517:           when '1'
Chris@1517:             register_by_email_activation(user) do
Chris@1517:               onthefly_creation_failed(user)
Chris@1517:             end
Chris@1517:           when '3'
Chris@1517:             register_automatically(user) do
Chris@1517:               onthefly_creation_failed(user)
Chris@1517:             end
Chris@1517:           else
Chris@1517:             register_manually_by_administrator(user) do
Chris@1517:               onthefly_creation_failed(user)
Chris@1517:             end
Chris@1517:           end
Chris@1517:         else
Chris@1517:           # Existing record
Chris@1517:           if user.active?
Chris@1517:             successful_authentication(user)
Chris@1517:           else
Chris@1517:             handle_inactive_user(user)
Chris@1517:           end
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def successful_authentication(user)
Chris@1517:     logger.info "Successful authentication for '#{user.login}' from #{request.remote_ip} at #{Time.now.utc}"
Chris@1517:     # Valid user
Chris@1517:     self.logged_user = user
Chris@1517:     # generate a key and set cookie if autologin
Chris@1517:     if params[:autologin] && Setting.autologin?
Chris@1517:       set_autologin_cookie(user)
Chris@1517:     end
Chris@1517:     call_hook(:controller_account_success_authentication_after, {:user => user })
Chris@1517:     redirect_back_or_default my_page_path
Chris@1517:   end
Chris@1517: 
Chris@1517:   def set_autologin_cookie(user)
Chris@1517:     token = Token.create(:user => user, :action => 'autologin')
Chris@1517:     cookie_options = {
Chris@1517:       :value => token.value,
Chris@1517:       :expires => 1.year.from_now,
Chris@1517:       :path => (Redmine::Configuration['autologin_cookie_path'] || '/'),
Chris@1517:       :secure => (Redmine::Configuration['autologin_cookie_secure'] ? true : false),
Chris@1517:       :httponly => true
Chris@1517:     }
Chris@1517:     cookies[autologin_cookie_name] = cookie_options
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Onthefly creation failed, display the registration form to fill/fix attributes
Chris@1517:   def onthefly_creation_failed(user, auth_source_options = { })
Chris@1517:     @user = user
Chris@1517:     session[:auth_source_registration] = auth_source_options unless auth_source_options.empty?
Chris@1517:     render :action => 'register'
Chris@1517:   end
Chris@1517: 
Chris@1517:   def invalid_credentials
Chris@1517:     logger.warn "Failed login for '#{params[:username]}' from #{request.remote_ip} at #{Time.now.utc}"
Chris@1517:     flash.now[:error] = l(:notice_account_invalid_creditentials)
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Register a user for email activation.
Chris@1517:   #
Chris@1517:   # Pass a block for behavior when a user fails to save
Chris@1517:   def register_by_email_activation(user, &block)
Chris@1517:     token = Token.new(:user => user, :action => "register")
Chris@1517:     if user.save and token.save
Chris@1517:       Mailer.register(token).deliver
Chris@1517:       flash[:notice] = l(:notice_account_register_done, :email => user.mail)
Chris@1517:       redirect_to signin_path
Chris@1517:     else
Chris@1517:       yield if block_given?
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Automatically register a user
Chris@1517:   #
Chris@1517:   # Pass a block for behavior when a user fails to save
Chris@1517:   def register_automatically(user, &block)
Chris@1517:     # Automatic activation
Chris@1517:     user.activate
Chris@1517:     user.last_login_on = Time.now
Chris@1517:     if user.save
Chris@1517:       self.logged_user = user
Chris@1517:       flash[:notice] = l(:notice_account_activated)
Chris@1517:       redirect_to my_account_path
Chris@1517:     else
Chris@1517:       yield if block_given?
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Manual activation by the administrator
Chris@1517:   #
Chris@1517:   # Pass a block for behavior when a user fails to save
Chris@1517:   def register_manually_by_administrator(user, &block)
Chris@1517:     if user.save
Chris@1517:       # Sends an email to the administrators
Chris@1517:       Mailer.account_activation_request(user).deliver
Chris@1517:       account_pending(user)
Chris@1517:     else
Chris@1517:       yield if block_given?
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def handle_inactive_user(user, redirect_path=signin_path)
Chris@1517:     if user.registered?
Chris@1517:       account_pending(user, redirect_path)
Chris@1517:     else
Chris@1517:       account_locked(user, redirect_path)
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def account_pending(user, redirect_path=signin_path)
Chris@1517:     if Setting.self_registration == '1'
Chris@1517:       flash[:error] = l(:notice_account_not_activated_yet, :url => activation_email_path)
Chris@1517:       session[:registered_user_id] = user.id
Chris@1517:     else
Chris@1517:       flash[:error] = l(:notice_account_pending)
Chris@1517:     end
Chris@1517:     redirect_to redirect_path
Chris@1517:   end
Chris@1517: 
Chris@1517:   def account_locked(user, redirect_path=signin_path)
Chris@1517:     flash[:error] = l(:notice_account_locked)
Chris@1517:     redirect_to redirect_path
Chris@1517:   end
Chris@1517: end