1 # Redmine - project management software
2 # Copyright (C) 2006-2009 Jean-Philippe Lang
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 class AccountController < ApplicationController
20 include CustomFieldsHelper
22 # prevents login action to be filtered by check_if_login_required application scope filter
23 skip_before_filter :check_if_login_required
25 # Login request and validation
29 self.logged_user = nil
32 if Setting.openid? && using_open_id?
33 open_id_authenticate(params[:openid_url])
35 password_authentication
40 # Log out current user and redirect to welcome page
42 cookies.delete :autologin
43 Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin']) if User.current.logged?
44 self.logged_user = nil
48 # Enable user to choose a new password
50 redirect_to(home_url) && return unless Setting.lost_password?
52 @token = Token.find_by_action_and_value("recovery", params[:token])
53 redirect_to(home_url) && return unless @token and !@token.expired?
56 @user.password, @user.password_confirmation = params[:new_password], params[:new_password_confirmation]
59 flash[:notice] = l(:notice_account_password_updated)
60 redirect_to :action => 'login'
64 render :template => "account/password_recovery"
68 user = User.find_by_mail(params[:mail])
69 # user not found in db
70 (flash.now[:error] = l(:notice_account_unknown_email); return) unless user
71 # user uses an external authentification
72 (flash.now[:error] = l(:notice_can_t_change_password); return) if user.auth_source_id
73 # create a new token for password recovery
74 token = Token.new(:user => user, :action => "recovery")
76 Mailer.deliver_lost_password(token)
77 flash[:notice] = l(:notice_account_lost_email_sent)
78 redirect_to :action => 'login'
85 # User self-registration
87 redirect_to(home_url) && return unless Setting.self_registration? || session[:auth_source_registration]
89 session[:auth_source_registration] = nil
90 @user = User.new(:language => Setting.default_language)
92 @user = User.new(params[:user])
94 @user.status = User::STATUS_REGISTERED
95 if session[:auth_source_registration]
96 @user.status = User::STATUS_ACTIVE
97 @user.login = session[:auth_source_registration][:login]
98 @user.auth_source_id = session[:auth_source_registration][:auth_source_id]
100 session[:auth_source_registration] = nil
101 self.logged_user = @user
102 flash[:notice] = l(:notice_account_activated)
103 redirect_to :controller => 'my', :action => 'account'
106 @user.login = params[:user][:login]
107 @user.password, @user.password_confirmation = params[:password], params[:password_confirmation]
109 case Setting.self_registration
111 register_by_email_activation(@user)
113 register_automatically(@user)
115 register_manually_by_administrator(@user)
121 # Token based account activation
123 redirect_to(home_url) && return unless Setting.self_registration? && params[:token]
124 token = Token.find_by_action_and_value('register', params[:token])
125 redirect_to(home_url) && return unless token and !token.expired?
127 redirect_to(home_url) && return unless user.status == User::STATUS_REGISTERED
128 user.status = User::STATUS_ACTIVE
131 flash[:notice] = l(:notice_account_activated)
133 redirect_to :action => 'login'
138 def password_authentication
139 user = User.try_to_login(params[:username], params[:password])
143 elsif user.new_record?
144 onthefly_creation_failed(user, {:login => user.login, :auth_source_id => user.auth_source_id })
147 successful_authentication(user)
152 def open_id_authenticate(openid_url)
153 authenticate_with_open_id(openid_url, :required => [:nickname, :fullname, :email], :return_to => signin_url) do |result, identity_url, registration|
154 if result.successful?
155 user = User.find_or_initialize_by_identity_url(identity_url)
157 # Self-registration off
158 redirect_to(home_url) && return unless Setting.self_registration?
161 user.login = registration['nickname'] unless registration['nickname'].nil?
162 user.mail = registration['email'] unless registration['email'].nil?
163 user.firstname, user.lastname = registration['fullname'].split(' ') unless registration['fullname'].nil?
165 user.status = User::STATUS_REGISTERED
167 case Setting.self_registration
169 register_by_email_activation(user) do
170 onthefly_creation_failed(user)
173 register_automatically(user) do
174 onthefly_creation_failed(user)
177 register_manually_by_administrator(user) do
178 onthefly_creation_failed(user)
184 successful_authentication(user)
193 def successful_authentication(user)
195 self.logged_user = user
196 # generate a key and set cookie if autologin
197 if params[:autologin] && Setting.autologin?
198 token = Token.create(:user => user, :action => 'autologin')
199 cookies[:autologin] = { :value => token.value, :expires => 1.year.from_now }
201 call_hook(:controller_account_success_authentication_after, {:user => user })
202 redirect_back_or_default :controller => 'my', :action => 'page'
205 # Onthefly creation failed, display the registration form to fill/fix attributes
206 def onthefly_creation_failed(user, auth_source_options = { })
208 session[:auth_source_registration] = auth_source_options unless auth_source_options.empty?
209 render :action => 'register'
212 def invalid_credentials
213 flash.now[:error] = l(:notice_account_invalid_creditentials)
216 # Register a user for email activation.
218 # Pass a block for behavior when a user fails to save
219 def register_by_email_activation(user, &block)
220 token = Token.new(:user => user, :action => "register")
221 if user.save and token.save
222 Mailer.deliver_register(token)
223 flash[:notice] = l(:notice_account_register_done)
224 redirect_to :action => 'login'
226 yield if block_given?
230 # Automatically register a user
232 # Pass a block for behavior when a user fails to save
233 def register_automatically(user, &block)
234 # Automatic activation
235 user.status = User::STATUS_ACTIVE
236 user.last_login_on = Time.now
238 self.logged_user = user
239 flash[:notice] = l(:notice_account_activated)
240 redirect_to :controller => 'my', :action => 'account'
242 yield if block_given?
246 # Manual activation by the administrator
248 # Pass a block for behavior when a user fails to save
249 def register_manually_by_administrator(user, &block)
251 # Sends an email to the administrators
252 Mailer.deliver_account_activation_request(user)
255 yield if block_given?
260 flash[:notice] = l(:notice_account_pending)
261 redirect_to :action => 'login'