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.
20 class User < Principal
29 :firstname_lastname => '#{firstname} #{lastname}',
30 :firstname => '#{firstname}',
31 :lastname_firstname => '#{lastname} #{firstname}',
32 :lastname_coma_firstname => '#{lastname}, #{firstname}',
33 :username => '#{login}'
36 has_and_belongs_to_many :groups, :after_add => Proc.new {|user, group| group.user_added(user)},
37 :after_remove => Proc.new {|user, group| group.user_removed(user)}
38 has_many :issue_categories, :foreign_key => 'assigned_to_id', :dependent => :nullify
39 has_many :changesets, :dependent => :nullify
40 has_one :preference, :dependent => :destroy, :class_name => 'UserPreference'
41 has_one :rss_token, :dependent => :destroy, :class_name => 'Token', :conditions => "action='feeds'"
42 has_one :api_token, :dependent => :destroy, :class_name => 'Token', :conditions => "action='api'"
43 belongs_to :auth_source
45 # Active non-anonymous users scope
46 named_scope :active, :conditions => "#{User.table_name}.status = #{STATUS_ACTIVE}"
50 attr_accessor :password, :password_confirmation
51 attr_accessor :last_before_login_on
52 # Prevents unauthorized assignments
53 attr_protected :login, :admin, :password, :password_confirmation, :hashed_password, :group_ids
55 validates_presence_of :login, :firstname, :lastname, :mail, :if => Proc.new { |user| !user.is_a?(AnonymousUser) }
56 validates_uniqueness_of :login, :if => Proc.new { |user| !user.login.blank? }
57 validates_uniqueness_of :mail, :if => Proc.new { |user| !user.mail.blank? }, :case_sensitive => false
58 # Login must contain lettres, numbers, underscores only
59 validates_format_of :login, :with => /^[a-z0-9_\-@\.]*$/i
60 validates_length_of :login, :maximum => 30
61 validates_format_of :firstname, :lastname, :with => /^[\w\s\'\-\.]*$/i
62 validates_length_of :firstname, :lastname, :maximum => 30
63 validates_format_of :mail, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :allow_nil => true
64 validates_length_of :mail, :maximum => 60, :allow_nil => true
65 validates_confirmation_of :password, :allow_nil => true
68 self.mail_notification = false
73 # update hashed_password if password was set
74 self.hashed_password = User.hash_password(self.password) if self.password
82 def identity_url=(url)
84 write_attribute(:identity_url, '')
87 write_attribute(:identity_url, OpenIdAuthentication.normalize_identifier(url))
88 rescue OpenIdAuthentication::InvalidOpenId
89 # Invlaid url, don't save
92 self.read_attribute(:identity_url)
95 # Returns the user that matches provided login and password, or nil
96 def self.try_to_login(login, password)
97 # Make sure no one can sign in with an empty password
98 return nil if password.to_s.empty?
99 user = find(:first, :conditions => ["login=?", login])
101 # user is already in local database
102 return nil if !user.active?
104 # user has an external authentication method
105 return nil unless user.auth_source.authenticate(login, password)
107 # authentication with local password
108 return nil unless User.hash_password(password) == user.hashed_password
111 # user is not yet registered, try to authenticate with available sources
112 attrs = AuthSource.authenticate(login, password)
116 user.language = Setting.default_language
119 logger.info("User '#{user.login}' created from the LDAP") if logger
123 user.update_attribute(:last_login_on, Time.now) if user && !user.new_record?
129 # Returns the user who matches the given autologin +key+ or nil
130 def self.try_to_autologin(key)
131 tokens = Token.find_all_by_action_and_value('autologin', key)
132 # Make sure there's only 1 token that matches the key
135 if (token.created_on > Setting.autologin.to_i.day.ago) && token.user && token.user.active?
136 token.user.update_attribute(:last_login_on, Time.now)
142 # Return user's full name for display
143 def name(formatter = nil)
145 eval('"' + (USER_FORMATS[formatter] || USER_FORMATS[:firstname_lastname]) + '"')
147 @name ||= eval('"' + (USER_FORMATS[Setting.user_format] || USER_FORMATS[:firstname_lastname]) + '"')
152 self.status == STATUS_ACTIVE
156 self.status == STATUS_REGISTERED
160 self.status == STATUS_LOCKED
163 def check_password?(clear_password)
164 User.hash_password(clear_password) == self.hashed_password
167 # Generate and set a random password. Useful for automated user creation
168 # Based on Token#generate_token_value
171 chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
173 40.times { |i| password << chars[rand(chars.size-1)] }
174 self.password = password
175 self.password_confirmation = password
180 self.preference ||= UserPreference.new(:user => self)
184 @time_zone ||= (self.pref.time_zone.blank? ? nil : ActiveSupport::TimeZone[self.pref.time_zone])
187 def wants_comments_in_reverse_order?
188 self.pref[:comments_sorting] == 'desc'
191 # Return user's RSS key (a 40 chars long string), used to access feeds
193 token = self.rss_token || Token.create(:user => self, :action => 'feeds')
197 # Return user's API key (a 40 chars long string), used to access the API
199 token = self.api_token || self.create_api_token(:action => 'api')
203 # Return an array of project ids for which the user has explicitly turned mail notifications on
204 def notified_projects_ids
205 @notified_projects_ids ||= memberships.select {|m| m.mail_notification?}.collect(&:project_id)
208 def notified_project_ids=(ids)
209 Member.update_all("mail_notification = #{connection.quoted_false}", ['user_id = ?', id])
210 Member.update_all("mail_notification = #{connection.quoted_true}", ['user_id = ? AND project_id IN (?)', id, ids]) if ids && !ids.empty?
211 @notified_projects_ids = nil
212 notified_projects_ids
215 def self.find_by_rss_key(key)
216 token = Token.find_by_value(key)
217 token && token.user.active? ? token.user : nil
220 def self.find_by_api_key(key)
221 token = Token.find_by_action_and_value('api', key)
222 token && token.user.active? ? token.user : nil
225 # Makes find_by_mail case-insensitive
226 def self.find_by_mail(mail)
227 find(:first, :conditions => ["LOWER(mail) = ?", mail.to_s.downcase])
234 # Returns the current day according to user's time zone
239 Time.now.in_time_zone(time_zone).to_date
251 # Return user's roles for project
252 def roles_for_project(project)
254 # No role on archived projects
255 return roles unless project && project.active?
257 # Find project membership
258 membership = memberships.detect {|m| m.project_id == project.id}
260 roles = membership.roles
262 @role_non_member ||= Role.non_member
263 roles << @role_non_member
266 @role_anonymous ||= Role.anonymous
267 roles << @role_anonymous
272 # Return true if the user is a member of project
273 def member_of?(project)
274 !roles_for_project(project).detect {|role| role.member?}.nil?
277 # Return true if the user is allowed to do the specified action on project
279 # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')
280 # * a permission Symbol (eg. :edit_project)
281 def allowed_to?(action, project, options={})
283 # No action allowed on archived projects
284 return false unless project.active?
285 # No action allowed on disabled modules
286 return false unless project.allows_to?(action)
287 # Admin users are authorized for anything else
288 return true if admin?
290 roles = roles_for_project(project)
291 return false unless roles
292 roles.detect {|role| (project.is_public? || role.member?) && role.allowed_to?(action)}
294 elsif options[:global]
295 # Admin users are always authorized
296 return true if admin?
298 # authorize if user has at least one role that has this permission
299 roles = memberships.collect {|m| m.roles}.flatten.uniq
300 roles.detect {|r| r.allowed_to?(action)} || (self.logged? ? Role.non_member.allowed_to?(action) : Role.anonymous.allowed_to?(action))
306 def self.current=(user)
311 @current_user ||= User.anonymous
314 # Returns the anonymous user. If the anonymous user does not exist, it is created. There can be only
315 # one anonymous user per database.
317 anonymous_user = AnonymousUser.find(:first)
318 if anonymous_user.nil?
319 anonymous_user = AnonymousUser.create(:lastname => 'Anonymous', :firstname => '', :mail => '', :login => '', :status => 0)
320 raise 'Unable to create the anonymous user.' if anonymous_user.new_record?
328 # Password length validation based on setting
329 if !password.nil? && password.size < Setting.password_min_length.to_i
330 errors.add(:password, :too_short, :count => Setting.password_min_length.to_i)
336 # Return password digest
337 def self.hash_password(clear_password)
338 Digest::SHA1.hexdigest(clear_password || "")
342 class AnonymousUser < User
344 def validate_on_create
345 # There should be only one AnonymousUser in the database
346 errors.add_to_base 'An anonymous user already exists.' if AnonymousUser.find(:first)
349 def available_custom_fields
353 # Overrides a few properties
354 def logged?; false end
356 def name(*args); I18n.t(:label_user_anonymous) end
358 def time_zone; nil end