user.rb
572 lines
| 18.7 KiB
| text/x-ruby
|
RubyLexer
|
r2755 | # Redmine - project management software | ||
# Copyright (C) 2006-2009 Jean-Philippe Lang | ||||
|
r330 | # | ||
# This program is free software; you can redistribute it and/or | ||||
# modify it under the terms of the GNU General Public License | ||||
# as published by the Free Software Foundation; either version 2 | ||||
# of the License, or (at your option) any later version. | ||||
# | ||||
# This program is distributed in the hope that it will be useful, | ||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
# GNU General Public License for more details. | ||||
# | ||||
# You should have received a copy of the GNU General Public License | ||||
# along with this program; if not, write to the Free Software | ||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||||
require "digest/sha1" | ||||
|
r2755 | class User < Principal | ||
|
r4378 | include Redmine::SafeAttributes | ||
|
r535 | # Account statuses | ||
|
r906 | STATUS_ANONYMOUS = 0 | ||
|
r535 | STATUS_ACTIVE = 1 | ||
STATUS_REGISTERED = 2 | ||||
STATUS_LOCKED = 3 | ||||
|
r1089 | |||
USER_FORMATS = { | ||||
:firstname_lastname => '#{firstname} #{lastname}', | ||||
:firstname => '#{firstname}', | ||||
:lastname_firstname => '#{lastname} #{firstname}', | ||||
:lastname_coma_firstname => '#{lastname}, #{firstname}', | ||||
:username => '#{login}' | ||||
} | ||||
|
r535 | |||
|
r4102 | MAIL_NOTIFICATION_OPTIONS = [ | ||
|
r4380 | ['all', :label_user_mail_option_all], | ||
['selected', :label_user_mail_option_selected], | ||||
['only_my_events', :label_user_mail_option_only_my_events], | ||||
['only_assigned', :label_user_mail_option_only_assigned], | ||||
['only_owner', :label_user_mail_option_only_owner], | ||||
['none', :label_user_mail_option_none] | ||||
] | ||||
|
r4102 | |||
|
r2755 | has_and_belongs_to_many :groups, :after_add => Proc.new {|user, group| group.user_added(user)}, | ||
:after_remove => Proc.new {|user, group| group.user_removed(user)} | ||||
|
r574 | has_many :issue_categories, :foreign_key => 'assigned_to_id', :dependent => :nullify | ||
|
r2004 | has_many :changesets, :dependent => :nullify | ||
|
r330 | has_one :preference, :dependent => :destroy, :class_name => 'UserPreference' | ||
|
r4606 | has_one :rss_token, :class_name => 'Token', :conditions => "action='feeds'" | ||
has_one :api_token, :class_name => 'Token', :conditions => "action='api'" | ||||
|
r330 | belongs_to :auth_source | ||
|
r2077 | # Active non-anonymous users scope | ||
named_scope :active, :conditions => "#{User.table_name}.status = #{STATUS_ACTIVE}" | ||||
|
r1578 | acts_as_customizable | ||
|
r330 | attr_accessor :password, :password_confirmation | ||
attr_accessor :last_before_login_on | ||||
# Prevents unauthorized assignments | ||||
|
r4385 | attr_protected :login, :admin, :password, :password_confirmation, :hashed_password | ||
|
r330 | |||
|
r906 | validates_presence_of :login, :firstname, :lastname, :mail, :if => Proc.new { |user| !user.is_a?(AnonymousUser) } | ||
|
r3693 | validates_uniqueness_of :login, :if => Proc.new { |user| !user.login.blank? }, :case_sensitive => false | ||
|
r2251 | validates_uniqueness_of :mail, :if => Proc.new { |user| !user.mail.blank? }, :case_sensitive => false | ||
|
r330 | # Login must contain lettres, numbers, underscores only | ||
|
r906 | validates_format_of :login, :with => /^[a-z0-9_\-@\.]*$/i | ||
|
r397 | validates_length_of :login, :maximum => 30 | ||
validates_length_of :firstname, :lastname, :maximum => 30 | ||||
|
r906 | validates_format_of :mail, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :allow_nil => true | ||
validates_length_of :mail, :maximum => 60, :allow_nil => true | ||||
|
r330 | validates_confirmation_of :password, :allow_nil => true | ||
|
r4380 | validates_inclusion_of :mail_notification, :in => MAIL_NOTIFICATION_OPTIONS.collect(&:first), :allow_blank => true | ||
|
r330 | |||
|
r4606 | before_destroy :remove_references_before_destroy | ||
|
r842 | def before_create | ||
|
r4109 | self.mail_notification = Setting.default_notification_option if self.mail_notification.blank? | ||
|
r842 | true | ||
end | ||||
|
r330 | def before_save | ||
# update hashed_password if password was set | ||||
|
r4816 | if self.password && self.auth_source_id.blank? | ||
salt_password(password) | ||||
end | ||||
|
r330 | end | ||
|
r2008 | |||
def reload(*args) | ||||
@name = nil | ||||
super | ||||
end | ||||
|
r330 | |||
|
r3759 | def mail=(arg) | ||
write_attribute(:mail, arg.to_s.strip) | ||||
end | ||||
|
r2392 | def identity_url=(url) | ||
|
r2415 | if url.blank? | ||
write_attribute(:identity_url, '') | ||||
else | ||||
begin | ||||
write_attribute(:identity_url, OpenIdAuthentication.normalize_identifier(url)) | ||||
rescue OpenIdAuthentication::InvalidOpenId | ||||
# Invlaid url, don't save | ||||
end | ||||
|
r2392 | end | ||
self.read_attribute(:identity_url) | ||||
end | ||||
|
r330 | # Returns the user that matches provided login and password, or nil | ||
def self.try_to_login(login, password) | ||||
|
r1217 | # Make sure no one can sign in with an empty password | ||
return nil if password.to_s.empty? | ||||
|
r3693 | user = find_by_login(login) | ||
|
r330 | if user | ||
# user is already in local database | ||||
return nil if !user.active? | ||||
if user.auth_source | ||||
# user has an external authentication method | ||||
return nil unless user.auth_source.authenticate(login, password) | ||||
else | ||||
# authentication with local password | ||||
|
r4816 | return nil unless user.check_password?(password) | ||
|
r330 | end | ||
else | ||||
# user is not yet registered, try to authenticate with available sources | ||||
attrs = AuthSource.authenticate(login, password) | ||||
if attrs | ||||
|
r3378 | user = new(attrs) | ||
|
r1661 | user.login = login | ||
user.language = Setting.default_language | ||||
if user.save | ||||
user.reload | ||||
|
r3631 | logger.info("User '#{user.login}' created from external auth source: #{user.auth_source.type} - #{user.auth_source.name}") if logger && user.auth_source | ||
|
r330 | end | ||
end | ||||
end | ||||
|
r1661 | user.update_attribute(:last_login_on, Time.now) if user && !user.new_record? | ||
|
r330 | user | ||
|
r1330 | rescue => text | ||
raise text | ||||
|
r330 | end | ||
|
r2460 | |||
# Returns the user who matches the given autologin +key+ or nil | ||||
def self.try_to_autologin(key) | ||||
|
r2643 | tokens = Token.find_all_by_action_and_value('autologin', key) | ||
# Make sure there's only 1 token that matches the key | ||||
if tokens.size == 1 | ||||
token = tokens.first | ||||
if (token.created_on > Setting.autologin.to_i.day.ago) && token.user && token.user.active? | ||||
token.user.update_attribute(:last_login_on, Time.now) | ||||
token.user | ||||
end | ||||
|
r2460 | end | ||
end | ||||
|
r330 | |||
# Return user's full name for display | ||||
|
r1089 | def name(formatter = nil) | ||
|
r2029 | if formatter | ||
eval('"' + (USER_FORMATS[formatter] || USER_FORMATS[:firstname_lastname]) + '"') | ||||
else | ||||
@name ||= eval('"' + (USER_FORMATS[Setting.user_format] || USER_FORMATS[:firstname_lastname]) + '"') | ||||
end | ||||
|
r330 | end | ||
def active? | ||||
self.status == STATUS_ACTIVE | ||||
end | ||||
def registered? | ||||
self.status == STATUS_REGISTERED | ||||
end | ||||
def locked? | ||||
self.status == STATUS_LOCKED | ||||
end | ||||
|
r3792 | def activate | ||
self.status = STATUS_ACTIVE | ||||
end | ||||
def register | ||||
self.status = STATUS_REGISTERED | ||||
end | ||||
def lock | ||||
self.status = STATUS_LOCKED | ||||
end | ||||
def activate! | ||||
update_attribute(:status, STATUS_ACTIVE) | ||||
end | ||||
def register! | ||||
update_attribute(:status, STATUS_REGISTERED) | ||||
end | ||||
def lock! | ||||
update_attribute(:status, STATUS_LOCKED) | ||||
end | ||||
|
r4816 | # Returns true if +clear_password+ is the correct user's password, otherwise false | ||
|
r330 | def check_password?(clear_password) | ||
|
r3631 | if auth_source_id.present? | ||
auth_source.authenticate(self.login, clear_password) | ||||
else | ||||
|
r4816 | User.hash_password("#{salt}#{User.hash_password clear_password}") == hashed_password | ||
|
r3631 | end | ||
end | ||||
|
r4816 | |||
# Generates a random salt and computes hashed_password for +clear_password+ | ||||
# The hashed password is stored in the following form: SHA1(salt + SHA1(password)) | ||||
def salt_password(clear_password) | ||||
self.salt = User.generate_salt | ||||
self.hashed_password = User.hash_password("#{salt}#{User.hash_password clear_password}") | ||||
end | ||||
|
r3631 | |||
# Does the backend storage allow this user to change their password? | ||||
def change_password_allowed? | ||||
return true if auth_source_id.blank? | ||||
return auth_source.allow_password_changes? | ||||
|
r330 | end | ||
|
r2382 | |||
# Generate and set a random password. Useful for automated user creation | ||||
# Based on Token#generate_token_value | ||||
# | ||||
def random_password | ||||
chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a | ||||
password = '' | ||||
40.times { |i| password << chars[rand(chars.size-1)] } | ||||
self.password = password | ||||
self.password_confirmation = password | ||||
self | ||||
end | ||||
|
r330 | |||
def pref | ||||
self.preference ||= UserPreference.new(:user => self) | ||||
end | ||||
|
r336 | |||
|
r904 | def time_zone | ||
|
r2132 | @time_zone ||= (self.pref.time_zone.blank? ? nil : ActiveSupport::TimeZone[self.pref.time_zone]) | ||
|
r904 | end | ||
|
r1183 | def wants_comments_in_reverse_order? | ||
self.pref[:comments_sorting] == 'desc' | ||||
end | ||||
|
r663 | # Return user's RSS key (a 40 chars long string), used to access feeds | ||
def rss_key | ||||
token = self.rss_token || Token.create(:user => self, :action => 'feeds') | ||||
token.value | ||||
|
r336 | end | ||
|
r3103 | |||
# Return user's API key (a 40 chars long string), used to access the API | ||||
def api_key | ||||
|
r3151 | token = self.api_token || self.create_api_token(:action => 'api') | ||
|
r3103 | token.value | ||
end | ||||
|
r336 | |||
|
r842 | # Return an array of project ids for which the user has explicitly turned mail notifications on | ||
def notified_projects_ids | ||||
@notified_projects_ids ||= memberships.select {|m| m.mail_notification?}.collect(&:project_id) | ||||
end | ||||
def notified_project_ids=(ids) | ||||
Member.update_all("mail_notification = #{connection.quoted_false}", ['user_id = ?', id]) | ||||
Member.update_all("mail_notification = #{connection.quoted_true}", ['user_id = ? AND project_id IN (?)', id, ids]) if ids && !ids.empty? | ||||
@notified_projects_ids = nil | ||||
notified_projects_ids | ||||
end | ||||
|
r3694 | |||
|
r4110 | def valid_notification_options | ||
|
r4610 | self.class.valid_notification_options(self) | ||
end | ||||
# Only users that belong to more than 1 project can select projects for which they are notified | ||||
def self.valid_notification_options(user=nil) | ||||
|
r4110 | # Note that @user.membership.size would fail since AR ignores | ||
# :include association option when doing a count | ||||
|
r4610 | if user.nil? || user.memberships.length < 1 | ||
|
r4607 | MAIL_NOTIFICATION_OPTIONS.reject {|option| option.first == 'selected'} | ||
|
r4110 | else | ||
MAIL_NOTIFICATION_OPTIONS | ||||
end | ||||
end | ||||
|
r3694 | # Find a user account by matching the exact login and then a case-insensitive | ||
# version. Exact matches will be given priority. | ||||
|
r3693 | def self.find_by_login(login) | ||
|
r3699 | # force string comparison to be case sensitive on MySQL | ||
type_cast = (ActiveRecord::Base.connection.adapter_name == 'MySQL') ? 'BINARY' : '' | ||||
|
r3693 | # First look for an exact match | ||
|
r3699 | user = first(:conditions => ["#{type_cast} login = ?", login]) | ||
|
r3693 | # Fail over to case-insensitive if none was found | ||
|
r3699 | user ||= first(:conditions => ["#{type_cast} LOWER(login) = ?", login.to_s.downcase]) | ||
|
r3693 | end | ||
|
r336 | def self.find_by_rss_key(key) | ||
token = Token.find_by_value(key) | ||||
token && token.user.active? ? token.user : nil | ||||
end | ||||
|
r511 | |||
|
r3103 | def self.find_by_api_key(key) | ||
token = Token.find_by_action_and_value('api', key) | ||||
token && token.user.active? ? token.user : nil | ||||
end | ||||
|
r2120 | # Makes find_by_mail case-insensitive | ||
def self.find_by_mail(mail) | ||||
find(:first, :conditions => ["LOWER(mail) = ?", mail.to_s.downcase]) | ||||
end | ||||
|
r431 | |||
|
r663 | def to_s | ||
name | ||||
end | ||||
|
r2898 | # Returns the current day according to user's time zone | ||
def today | ||||
if time_zone.nil? | ||||
Date.today | ||||
else | ||||
Time.now.in_time_zone(time_zone).to_date | ||||
end | ||||
end | ||||
|
r663 | def logged? | ||
true | ||||
end | ||||
|
r1657 | def anonymous? | ||
!logged? | ||||
end | ||||
|
r2627 | # Return user's roles for project | ||
def roles_for_project(project) | ||||
roles = [] | ||||
|
r663 | # No role on archived projects | ||
|
r2627 | return roles unless project && project.active? | ||
|
r915 | if logged? | ||
# Find project membership | ||||
membership = memberships.detect {|m| m.project_id == project.id} | ||||
if membership | ||||
|
r2627 | roles = membership.roles | ||
|
r915 | else | ||
@role_non_member ||= Role.non_member | ||||
|
r2627 | roles << @role_non_member | ||
|
r915 | end | ||
|
r663 | else | ||
|
r915 | @role_anonymous ||= Role.anonymous | ||
|
r2627 | roles << @role_anonymous | ||
|
r663 | end | ||
|
r2627 | roles | ||
|
r663 | end | ||
# Return true if the user is a member of project | ||||
def member_of?(project) | ||||
|
r2627 | !roles_for_project(project).detect {|role| role.member?}.nil? | ||
|
r663 | end | ||
|
r4113 | # Return true if the user is allowed to do the specified action on a specific context | ||
# Action can be: | ||||
|
r663 | # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit') | ||
# * a permission Symbol (eg. :edit_project) | ||||
|
r4113 | # Context can be: | ||
# * a project : returns true if user is allowed to do the specified action on this project | ||||
# * a group of projects : returns true if user is allowed on every project | ||||
# * nil with options[:global] set : check if user has at least one role allowed for this action, | ||||
# or falls back to Non Member / Anonymous permissions depending if the user is logged | ||||
|
r4120 | def allowed_to?(action, context, options={}) | ||
if context && context.is_a?(Project) | ||||
|
r1297 | # No action allowed on archived projects | ||
|
r4120 | return false unless context.active? | ||
|
r1297 | # No action allowed on disabled modules | ||
|
r4120 | return false unless context.allows_to?(action) | ||
|
r1297 | # Admin users are authorized for anything else | ||
return true if admin? | ||||
|
r4120 | roles = roles_for_project(context) | ||
|
r2627 | return false unless roles | ||
|
r4120 | roles.detect {|role| (context.is_public? || role.member?) && role.allowed_to?(action)} | ||
|
r1297 | |||
|
r4120 | elsif context && context.is_a?(Array) | ||
|
r4113 | # Authorize if user is authorized on every element of the array | ||
|
r4120 | context.map do |project| | ||
allowed_to?(action,project,options) | ||||
end.inject do |memo,allowed| | ||||
memo && allowed | ||||
|
r4113 | end | ||
|
r1297 | elsif options[:global] | ||
|
r2651 | # Admin users are always authorized | ||
return true if admin? | ||||
|
r1297 | # authorize if user has at least one role that has this permission | ||
|
r2627 | roles = memberships.collect {|m| m.roles}.flatten.uniq | ||
|
r1777 | roles.detect {|r| r.allowed_to?(action)} || (self.logged? ? Role.non_member.allowed_to?(action) : Role.anonymous.allowed_to?(action)) | ||
|
r1297 | else | ||
false | ||||
end | ||||
|
r663 | end | ||
|
r4050 | |||
# Is the user allowed to do the specified action on any project? | ||||
# See allowed_to? for the actions and valid options. | ||||
def allowed_to_globally?(action, options) | ||||
allowed_to?(action, nil, options.reverse_merge(:global => true)) | ||||
end | ||||
|
r4378 | |||
safe_attributes 'login', | ||||
'firstname', | ||||
'lastname', | ||||
'mail', | ||||
'mail_notification', | ||||
'language', | ||||
'custom_field_values', | ||||
'custom_fields', | ||||
'identity_url' | ||||
safe_attributes 'status', | ||||
'auth_source_id', | ||||
:if => lambda {|user, current_user| current_user.admin?} | ||||
|
r663 | |||
|
r4385 | safe_attributes 'group_ids', | ||
:if => lambda {|user, current_user| current_user.admin? && !user.new_record?} | ||||
|
r4104 | # Utility method to help check if a user should be notified about an | ||
# event. | ||||
# | ||||
# TODO: only supports Issue events currently | ||||
def notify_about?(object) | ||||
|
r4380 | case mail_notification | ||
when 'all' | ||||
|
r4104 | true | ||
|
r4380 | when 'selected' | ||
|
r4641 | # user receives notifications for created/assigned issues on unselected projects | ||
if object.is_a?(Issue) && (object.author == self || object.assigned_to == self) | ||||
true | ||||
else | ||||
false | ||||
end | ||||
|
r4380 | when 'none' | ||
|
r4104 | false | ||
|
r4380 | when 'only_my_events' | ||
|
r4104 | if object.is_a?(Issue) && (object.author == self || object.assigned_to == self) | ||
true | ||||
else | ||||
false | ||||
end | ||||
|
r4380 | when 'only_assigned' | ||
|
r4104 | if object.is_a?(Issue) && object.assigned_to == self | ||
true | ||||
else | ||||
false | ||||
end | ||||
|
r4380 | when 'only_owner' | ||
|
r4104 | if object.is_a?(Issue) && object.author == self | ||
true | ||||
else | ||||
false | ||||
end | ||||
else | ||||
false | ||||
end | ||||
end | ||||
|
r663 | def self.current=(user) | ||
@current_user = user | ||||
end | ||||
def self.current | ||||
|
r906 | @current_user ||= User.anonymous | ||
|
r663 | end | ||
|
r2536 | # Returns the anonymous user. If the anonymous user does not exist, it is created. There can be only | ||
# one anonymous user per database. | ||||
|
r663 | def self.anonymous | ||
|
r906 | anonymous_user = AnonymousUser.find(:first) | ||
if anonymous_user.nil? | ||||
anonymous_user = AnonymousUser.create(:lastname => 'Anonymous', :firstname => '', :mail => '', :login => '', :status => 0) | ||||
raise 'Unable to create the anonymous user.' if anonymous_user.new_record? | ||||
end | ||||
|
r1429 | anonymous_user | ||
|
r663 | end | ||
|
r4816 | |||
# Salts all existing unsalted passwords | ||||
# It changes password storage scheme from SHA1(password) to SHA1(salt + SHA1(password)) | ||||
# This method is used in the SaltPasswords migration and is to be kept as is | ||||
def self.salt_unsalted_passwords! | ||||
transaction do | ||||
User.find_each(:conditions => "salt IS NULL OR salt = ''") do |user| | ||||
next if user.hashed_password.blank? | ||||
salt = User.generate_salt | ||||
hashed_password = User.hash_password("#{salt}#{user.hashed_password}") | ||||
User.update_all("salt = '#{salt}', hashed_password = '#{hashed_password}'", ["id = ?", user.id] ) | ||||
end | ||||
end | ||||
end | ||||
|
r663 | |||
|
r2586 | protected | ||
def validate | ||||
# Password length validation based on setting | ||||
if !password.nil? && password.size < Setting.password_min_length.to_i | ||||
errors.add(:password, :too_short, :count => Setting.password_min_length.to_i) | ||||
end | ||||
end | ||||
private | ||||
|
r4606 | |||
# Removes references that are not handled by associations | ||||
# Things that are not deleted are reassociated with the anonymous user | ||||
def remove_references_before_destroy | ||||
return if self.id.nil? | ||||
substitute = User.anonymous | ||||
Attachment.update_all ['author_id = ?', substitute.id], ['author_id = ?', id] | ||||
Comment.update_all ['author_id = ?', substitute.id], ['author_id = ?', id] | ||||
Issue.update_all ['author_id = ?', substitute.id], ['author_id = ?', id] | ||||
Issue.update_all 'assigned_to_id = NULL', ['assigned_to_id = ?', id] | ||||
Journal.update_all ['user_id = ?', substitute.id], ['user_id = ?', id] | ||||
JournalDetail.update_all ['old_value = ?', substitute.id.to_s], ["property = 'attr' AND prop_key = 'assigned_to_id' AND old_value = ?", id.to_s] | ||||
JournalDetail.update_all ['value = ?', substitute.id.to_s], ["property = 'attr' AND prop_key = 'assigned_to_id' AND value = ?", id.to_s] | ||||
Message.update_all ['author_id = ?', substitute.id], ['author_id = ?', id] | ||||
News.update_all ['author_id = ?', substitute.id], ['author_id = ?', id] | ||||
# Remove private queries and keep public ones | ||||
Query.delete_all ['user_id = ? AND is_public = ?', id, false] | ||||
Query.update_all ['user_id = ?', substitute.id], ['user_id = ?', id] | ||||
TimeEntry.update_all ['user_id = ?', substitute.id], ['user_id = ?', id] | ||||
Token.delete_all ['user_id = ?', id] | ||||
Watcher.delete_all ['user_id = ?', id] | ||||
WikiContent.update_all ['author_id = ?', substitute.id], ['author_id = ?', id] | ||||
WikiContent::Version.update_all ['author_id = ?', substitute.id], ['author_id = ?', id] | ||||
end | ||||
|
r2755 | |||
|
r330 | # Return password digest | ||
def self.hash_password(clear_password) | ||||
Digest::SHA1.hexdigest(clear_password || "") | ||||
|
r5 | end | ||
|
r4816 | |||
# Returns a 128bits random salt as a hex string (32 chars long) | ||||
def self.generate_salt | ||||
ActiveSupport::SecureRandom.hex(16) | ||||
end | ||||
|
r2 | end | ||
|
r663 | |||
class AnonymousUser < User | ||||
|
r906 | def validate_on_create | ||
# There should be only one AnonymousUser in the database | ||||
errors.add_to_base 'An anonymous user already exists.' if AnonymousUser.find(:first) | ||||
|
r904 | end | ||
|
r1578 | def available_custom_fields | ||
[] | ||||
end | ||||
|
r906 | # Overrides a few properties | ||
def logged?; false end | ||||
def admin; false end | ||||
|
r2910 | def name(*args); I18n.t(:label_user_anonymous) end | ||
|
r906 | def mail; nil end | ||
def time_zone; nil end | ||||
def rss_key; nil end | ||||
|
r4606 | |||
# Anonymous user can not be destroyed | ||||
def destroy | ||||
false | ||||
end | ||||
|
r663 | end | ||