Chris@1296: # Redmine - project management software
Chris@1296: # Copyright (C) 2006-2012  Jean-Philippe Lang
Chris@1296: #
Chris@1296: # This program is free software; you can redistribute it and/or
Chris@1296: # modify it under the terms of the GNU General Public License
Chris@1296: # as published by the Free Software Foundation; either version 2
Chris@1296: # of the License, or (at your option) any later version.
Chris@1296: #
Chris@1296: # This program is distributed in the hope that it will be useful,
Chris@1296: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1296: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1296: # GNU General Public License for more details.
Chris@1296: #
Chris@1296: # You should have received a copy of the GNU General Public License
Chris@1296: # along with this program; if not, write to the Free Software
Chris@1296: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1296: 
Chris@1296: require "digest/sha1"
Chris@1296: 
Chris@1296: class User < Principal
Chris@1296:   include Redmine::SafeAttributes
Chris@1296: 
Chris@1296:   # Account statuses
Chris@1296:   STATUS_ANONYMOUS  = 0
Chris@1296:   STATUS_ACTIVE     = 1
Chris@1296:   STATUS_REGISTERED = 2
Chris@1296:   STATUS_LOCKED     = 3
Chris@1296: 
Chris@1296:   # Different ways of displaying/sorting users
Chris@1296:   USER_FORMATS = {
Chris@1296:     :firstname_lastname => {
Chris@1296:         :string => '#{firstname} #{lastname}',
Chris@1296:         :order => %w(firstname lastname id),
Chris@1296:         :setting_order => 1
Chris@1296:       },
Chris@1296:     :firstname_lastinitial => {
Chris@1296:         :string => '#{firstname} #{lastname.to_s.chars.first}.',
Chris@1296:         :order => %w(firstname lastname id),
Chris@1296:         :setting_order => 2
Chris@1296:       },
Chris@1296:     :firstname => {
Chris@1296:         :string => '#{firstname}',
Chris@1296:         :order => %w(firstname id),
Chris@1296:         :setting_order => 3
Chris@1296:       },
Chris@1296:     :lastname_firstname => {
Chris@1296:         :string => '#{lastname} #{firstname}',
Chris@1296:         :order => %w(lastname firstname id),
Chris@1296:         :setting_order => 4
Chris@1296:       },
Chris@1296:     :lastname_coma_firstname => {
Chris@1296:         :string => '#{lastname}, #{firstname}',
Chris@1296:         :order => %w(lastname firstname id),
Chris@1296:         :setting_order => 5
Chris@1296:       },
Chris@1296:     :lastname => {
Chris@1296:         :string => '#{lastname}',
Chris@1296:         :order => %w(lastname id),
Chris@1296:         :setting_order => 6
Chris@1296:       },
Chris@1296:     :username => {
Chris@1296:         :string => '#{login}',
Chris@1296:         :order => %w(login id),
Chris@1296:         :setting_order => 7
Chris@1296:       },
Chris@1296:   }
Chris@1296: 
Chris@1296:   MAIL_NOTIFICATION_OPTIONS = [
Chris@1296:     ['all', :label_user_mail_option_all],
Chris@1296:     ['selected', :label_user_mail_option_selected],
Chris@1296:     ['only_my_events', :label_user_mail_option_only_my_events],
Chris@1296:     ['only_assigned', :label_user_mail_option_only_assigned],
Chris@1296:     ['only_owner', :label_user_mail_option_only_owner],
Chris@1296:     ['none', :label_user_mail_option_none]
Chris@1296:   ]
Chris@1296: 
Chris@1296:   has_and_belongs_to_many :groups, :after_add => Proc.new {|user, group| group.user_added(user)},
Chris@1296:                                    :after_remove => Proc.new {|user, group| group.user_removed(user)}
Chris@1296:   has_many :changesets, :dependent => :nullify
Chris@1296:   has_one :preference, :dependent => :destroy, :class_name => 'UserPreference'
Chris@1296:   has_one :rss_token, :class_name => 'Token', :conditions => "action='feeds'"
Chris@1296:   has_one :api_token, :class_name => 'Token', :conditions => "action='api'"
Chris@1296:   belongs_to :auth_source
Chris@1296: 
Chris@1296:   scope :logged, :conditions => "#{User.table_name}.status <> #{STATUS_ANONYMOUS}"
Chris@1296:   scope :status, lambda {|arg| arg.blank? ? {} : {:conditions => {:status => arg.to_i}} }
Chris@1296: 
Chris@1296:   acts_as_customizable
Chris@1296: 
Chris@1296:   attr_accessor :password, :password_confirmation
Chris@1296:   attr_accessor :last_before_login_on
Chris@1296:   # Prevents unauthorized assignments
Chris@1296:   attr_protected :login, :admin, :password, :password_confirmation, :hashed_password
Chris@1296: 
Chris@1296:   LOGIN_LENGTH_LIMIT = 60
Chris@1296:   MAIL_LENGTH_LIMIT = 60
Chris@1296: 
Chris@1296:   validates_presence_of :login, :firstname, :lastname, :mail, :if => Proc.new { |user| !user.is_a?(AnonymousUser) }
Chris@1296:   validates_uniqueness_of :login, :if => Proc.new { |user| user.login_changed? && user.login.present? }, :case_sensitive => false
Chris@1296:   validates_uniqueness_of :mail, :if => Proc.new { |user| user.mail_changed? && user.mail.present? }, :case_sensitive => false
Chris@1296:   # Login must contain lettres, numbers, underscores only
Chris@1296:   validates_format_of :login, :with => /^[a-z0-9_\-@\.]*$/i
Chris@1296:   validates_length_of :login, :maximum => LOGIN_LENGTH_LIMIT
Chris@1296:   validates_length_of :firstname, :lastname, :maximum => 30
Chris@1296:   validates_format_of :mail, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :allow_blank => true
Chris@1296:   validates_length_of :mail, :maximum => MAIL_LENGTH_LIMIT, :allow_nil => true
Chris@1296:   validates_confirmation_of :password, :allow_nil => true
Chris@1296:   validates_inclusion_of :mail_notification, :in => MAIL_NOTIFICATION_OPTIONS.collect(&:first), :allow_blank => true
Chris@1296:   validate :validate_password_length
Chris@1296: 
Chris@1296:   before_create :set_mail_notification
Chris@1296:   before_save   :update_hashed_password
Chris@1296:   before_destroy :remove_references_before_destroy
Chris@1296: 
Chris@1296:   scope :in_group, lambda {|group|
Chris@1296:     group_id = group.is_a?(Group) ? group.id : group.to_i
Chris@1296:     where("#{User.table_name}.id IN (SELECT gu.user_id FROM #{table_name_prefix}groups_users#{table_name_suffix} gu WHERE gu.group_id = ?)", group_id)
Chris@1296:   }
Chris@1296:   scope :not_in_group, lambda {|group|
Chris@1296:     group_id = group.is_a?(Group) ? group.id : group.to_i
Chris@1296:     where("#{User.table_name}.id NOT IN (SELECT gu.user_id FROM #{table_name_prefix}groups_users#{table_name_suffix} gu WHERE gu.group_id = ?)", group_id)
Chris@1296:   }
Chris@1296: 
Chris@1296:   def set_mail_notification
Chris@1296:     self.mail_notification = Setting.default_notification_option if self.mail_notification.blank?
Chris@1296:     true
Chris@1296:   end
Chris@1296: 
Chris@1296:   def update_hashed_password
Chris@1296:     # update hashed_password if password was set
Chris@1296:     if self.password && self.auth_source_id.blank?
Chris@1296:       salt_password(password)
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def reload(*args)
Chris@1296:     @name = nil
Chris@1296:     @projects_by_role = nil
Chris@1296:     super
Chris@1296:   end
Chris@1296: 
Chris@1296:   def mail=(arg)
Chris@1296:     write_attribute(:mail, arg.to_s.strip)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def identity_url=(url)
Chris@1296:     if url.blank?
Chris@1296:       write_attribute(:identity_url, '')
Chris@1296:     else
Chris@1296:       begin
Chris@1296:         write_attribute(:identity_url, OpenIdAuthentication.normalize_identifier(url))
Chris@1296:       rescue OpenIdAuthentication::InvalidOpenId
Chris@1296:         # Invlaid url, don't save
Chris@1296:       end
Chris@1296:     end
Chris@1296:     self.read_attribute(:identity_url)
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns the user that matches provided login and password, or nil
Chris@1296:   def self.try_to_login(login, password)
Chris@1296:     login = login.to_s
Chris@1296:     password = password.to_s
Chris@1296: 
Chris@1296:     # Make sure no one can sign in with an empty password
Chris@1296:     return nil if password.empty?
Chris@1296:     user = find_by_login(login)
Chris@1296:     if user
Chris@1296:       # user is already in local database
Chris@1296:       return nil if !user.active?
Chris@1296:       if user.auth_source
Chris@1296:         # user has an external authentication method
Chris@1296:         return nil unless user.auth_source.authenticate(login, password)
Chris@1296:       else
Chris@1296:         # authentication with local password
Chris@1296:         return nil unless user.check_password?(password)
Chris@1296:       end
Chris@1296:     else
Chris@1296:       # user is not yet registered, try to authenticate with available sources
Chris@1296:       attrs = AuthSource.authenticate(login, password)
Chris@1296:       if attrs
Chris@1296:         user = new(attrs)
Chris@1296:         user.login = login
Chris@1296:         user.language = Setting.default_language
Chris@1296:         if user.save
Chris@1296:           user.reload
Chris@1296:           logger.info("User '#{user.login}' created from external auth source: #{user.auth_source.type} - #{user.auth_source.name}") if logger && user.auth_source
Chris@1296:         end
Chris@1296:       end
Chris@1296:     end
Chris@1296:     user.update_attribute(:last_login_on, Time.now) if user && !user.new_record?
Chris@1296:     user
Chris@1296:   rescue => text
Chris@1296:     raise text
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns the user who matches the given autologin +key+ or nil
Chris@1296:   def self.try_to_autologin(key)
Chris@1296:     tokens = Token.find_all_by_action_and_value('autologin', key.to_s)
Chris@1296:     # Make sure there's only 1 token that matches the key
Chris@1296:     if tokens.size == 1
Chris@1296:       token = tokens.first
Chris@1296:       if (token.created_on > Setting.autologin.to_i.day.ago) && token.user && token.user.active?
Chris@1296:         token.user.update_attribute(:last_login_on, Time.now)
Chris@1296:         token.user
Chris@1296:       end
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def self.name_formatter(formatter = nil)
Chris@1296:     USER_FORMATS[formatter || Setting.user_format] || USER_FORMATS[:firstname_lastname]
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns an array of fields names than can be used to make an order statement for users
Chris@1296:   # according to how user names are displayed
Chris@1296:   # Examples:
Chris@1296:   #
Chris@1296:   #   User.fields_for_order_statement              => ['users.login', 'users.id']
Chris@1296:   #   User.fields_for_order_statement('authors')   => ['authors.login', 'authors.id']
Chris@1296:   def self.fields_for_order_statement(table=nil)
Chris@1296:     table ||= table_name
Chris@1296:     name_formatter[:order].map {|field| "#{table}.#{field}"}
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return user's full name for display
Chris@1296:   def name(formatter = nil)
Chris@1296:     f = self.class.name_formatter(formatter)
Chris@1296:     if formatter
Chris@1296:       eval('"' + f[:string] + '"')
Chris@1296:     else
Chris@1296:       @name ||= eval('"' + f[:string] + '"')
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def active?
Chris@1296:     self.status == STATUS_ACTIVE
Chris@1296:   end
Chris@1296: 
Chris@1296:   def registered?
Chris@1296:     self.status == STATUS_REGISTERED
Chris@1296:   end
Chris@1296: 
Chris@1296:   def locked?
Chris@1296:     self.status == STATUS_LOCKED
Chris@1296:   end
Chris@1296: 
Chris@1296:   def activate
Chris@1296:     self.status = STATUS_ACTIVE
Chris@1296:   end
Chris@1296: 
Chris@1296:   def register
Chris@1296:     self.status = STATUS_REGISTERED
Chris@1296:   end
Chris@1296: 
Chris@1296:   def lock
Chris@1296:     self.status = STATUS_LOCKED
Chris@1296:   end
Chris@1296: 
Chris@1296:   def activate!
Chris@1296:     update_attribute(:status, STATUS_ACTIVE)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def register!
Chris@1296:     update_attribute(:status, STATUS_REGISTERED)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def lock!
Chris@1296:     update_attribute(:status, STATUS_LOCKED)
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns true if +clear_password+ is the correct user's password, otherwise false
Chris@1296:   def check_password?(clear_password)
Chris@1296:     if auth_source_id.present?
Chris@1296:       auth_source.authenticate(self.login, clear_password)
Chris@1296:     else
Chris@1296:       User.hash_password("#{salt}#{User.hash_password clear_password}") == hashed_password
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Generates a random salt and computes hashed_password for +clear_password+
Chris@1296:   # The hashed password is stored in the following form: SHA1(salt + SHA1(password))
Chris@1296:   def salt_password(clear_password)
Chris@1296:     self.salt = User.generate_salt
Chris@1296:     self.hashed_password = User.hash_password("#{salt}#{User.hash_password clear_password}")
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Does the backend storage allow this user to change their password?
Chris@1296:   def change_password_allowed?
Chris@1296:     return true if auth_source.nil?
Chris@1296:     return auth_source.allow_password_changes?
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Generate and set a random password.  Useful for automated user creation
Chris@1296:   # Based on Token#generate_token_value
Chris@1296:   #
Chris@1296:   def random_password
Chris@1296:     chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
Chris@1296:     password = ''
Chris@1296:     40.times { |i| password << chars[rand(chars.size-1)] }
Chris@1296:     self.password = password
Chris@1296:     self.password_confirmation = password
Chris@1296:     self
Chris@1296:   end
Chris@1296: 
Chris@1296:   def pref
Chris@1296:     self.preference ||= UserPreference.new(:user => self)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def time_zone
Chris@1296:     @time_zone ||= (self.pref.time_zone.blank? ? nil : ActiveSupport::TimeZone[self.pref.time_zone])
Chris@1296:   end
Chris@1296: 
Chris@1296:   def wants_comments_in_reverse_order?
Chris@1296:     self.pref[:comments_sorting] == 'desc'
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return user's RSS key (a 40 chars long string), used to access feeds
Chris@1296:   def rss_key
Chris@1296:     if rss_token.nil?
Chris@1296:       create_rss_token(:action => 'feeds')
Chris@1296:     end
Chris@1296:     rss_token.value
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return user's API key (a 40 chars long string), used to access the API
Chris@1296:   def api_key
Chris@1296:     if api_token.nil?
Chris@1296:       create_api_token(:action => 'api')
Chris@1296:     end
Chris@1296:     api_token.value
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return an array of project ids for which the user has explicitly turned mail notifications on
Chris@1296:   def notified_projects_ids
Chris@1296:     @notified_projects_ids ||= memberships.select {|m| m.mail_notification?}.collect(&:project_id)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def notified_project_ids=(ids)
Chris@1296:     Member.update_all("mail_notification = #{connection.quoted_false}", ['user_id = ?', id])
Chris@1296:     Member.update_all("mail_notification = #{connection.quoted_true}", ['user_id = ? AND project_id IN (?)', id, ids]) if ids && !ids.empty?
Chris@1296:     @notified_projects_ids = nil
Chris@1296:     notified_projects_ids
Chris@1296:   end
Chris@1296: 
Chris@1296:   def valid_notification_options
Chris@1296:     self.class.valid_notification_options(self)
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Only users that belong to more than 1 project can select projects for which they are notified
Chris@1296:   def self.valid_notification_options(user=nil)
Chris@1296:     # Note that @user.membership.size would fail since AR ignores
Chris@1296:     # :include association option when doing a count
Chris@1296:     if user.nil? || user.memberships.length < 1
Chris@1296:       MAIL_NOTIFICATION_OPTIONS.reject {|option| option.first == 'selected'}
Chris@1296:     else
Chris@1296:       MAIL_NOTIFICATION_OPTIONS
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Find a user account by matching the exact login and then a case-insensitive
Chris@1296:   # version.  Exact matches will be given priority.
Chris@1296:   def self.find_by_login(login)
Chris@1296:     # First look for an exact match
Chris@1296:     user = where(:login => login).all.detect {|u| u.login == login}
Chris@1296:     unless user
Chris@1296:       # Fail over to case-insensitive if none was found
Chris@1296:       user = where("LOWER(login) = ?", login.to_s.downcase).first
Chris@1296:     end
Chris@1296:     user
Chris@1296:   end
Chris@1296: 
Chris@1296:   def self.find_by_rss_key(key)
Chris@1296:     token = Token.find_by_action_and_value('feeds', key.to_s)
Chris@1296:     token && token.user.active? ? token.user : nil
Chris@1296:   end
Chris@1296: 
Chris@1296:   def self.find_by_api_key(key)
Chris@1296:     token = Token.find_by_action_and_value('api', key.to_s)
Chris@1296:     token && token.user.active? ? token.user : nil
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Makes find_by_mail case-insensitive
Chris@1296:   def self.find_by_mail(mail)
Chris@1296:     where("LOWER(mail) = ?", mail.to_s.downcase).first
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns true if the default admin account can no longer be used
Chris@1296:   def self.default_admin_account_changed?
Chris@1296:     !User.active.find_by_login("admin").try(:check_password?, "admin")
Chris@1296:   end
Chris@1296: 
Chris@1296:   def to_s
Chris@1296:     name
Chris@1296:   end
Chris@1296: 
Chris@1296:   CSS_CLASS_BY_STATUS = {
Chris@1296:     STATUS_ANONYMOUS  => 'anon',
Chris@1296:     STATUS_ACTIVE     => 'active',
Chris@1296:     STATUS_REGISTERED => 'registered',
Chris@1296:     STATUS_LOCKED     => 'locked'
Chris@1296:   }
Chris@1296: 
Chris@1296:   def css_classes
Chris@1296:     "user #{CSS_CLASS_BY_STATUS[status]}"
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns the current day according to user's time zone
Chris@1296:   def today
Chris@1296:     if time_zone.nil?
Chris@1296:       Date.today
Chris@1296:     else
Chris@1296:       Time.now.in_time_zone(time_zone).to_date
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns the day of +time+ according to user's time zone
Chris@1296:   def time_to_date(time)
Chris@1296:     if time_zone.nil?
Chris@1296:       time.to_date
Chris@1296:     else
Chris@1296:       time.in_time_zone(time_zone).to_date
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def logged?
Chris@1296:     true
Chris@1296:   end
Chris@1296: 
Chris@1296:   def anonymous?
Chris@1296:     !logged?
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return user's roles for project
Chris@1296:   def roles_for_project(project)
Chris@1296:     roles = []
Chris@1296:     # No role on archived projects
Chris@1296:     return roles if project.nil? || project.archived?
Chris@1296:     if logged?
Chris@1296:       # Find project membership
Chris@1296:       membership = memberships.detect {|m| m.project_id == project.id}
Chris@1296:       if membership
Chris@1296:         roles = membership.roles
Chris@1296:       else
Chris@1296:         @role_non_member ||= Role.non_member
Chris@1296:         roles << @role_non_member
Chris@1296:       end
Chris@1296:     else
Chris@1296:       @role_anonymous ||= Role.anonymous
Chris@1296:       roles << @role_anonymous
Chris@1296:     end
Chris@1296:     roles
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return true if the user is a member of project
Chris@1296:   def member_of?(project)
Chris@1296:     !roles_for_project(project).detect {|role| role.member?}.nil?
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns a hash of user's projects grouped by roles
Chris@1296:   def projects_by_role
Chris@1296:     return @projects_by_role if @projects_by_role
Chris@1296: 
Chris@1296:     @projects_by_role = Hash.new([])
Chris@1296:     memberships.each do |membership|
Chris@1296:       if membership.project
Chris@1296:         membership.roles.each do |role|
Chris@1296:           @projects_by_role[role] = [] unless @projects_by_role.key?(role)
Chris@1296:           @projects_by_role[role] << membership.project
Chris@1296:         end
Chris@1296:       end
Chris@1296:     end
Chris@1296:     @projects_by_role.each do |role, projects|
Chris@1296:       projects.uniq!
Chris@1296:     end
Chris@1296: 
Chris@1296:     @projects_by_role
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns true if user is arg or belongs to arg
Chris@1296:   def is_or_belongs_to?(arg)
Chris@1296:     if arg.is_a?(User)
Chris@1296:       self == arg
Chris@1296:     elsif arg.is_a?(Group)
Chris@1296:       arg.users.include?(self)
Chris@1296:     else
Chris@1296:       false
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return true if the user is allowed to do the specified action on a specific context
Chris@1296:   # Action can be:
Chris@1296:   # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')
Chris@1296:   # * a permission Symbol (eg. :edit_project)
Chris@1296:   # Context can be:
Chris@1296:   # * a project : returns true if user is allowed to do the specified action on this project
Chris@1296:   # * an array of projects : returns true if user is allowed on every project
Chris@1296:   # * nil with options[:global] set : check if user has at least one role allowed for this action,
Chris@1296:   #   or falls back to Non Member / Anonymous permissions depending if the user is logged
Chris@1296:   def allowed_to?(action, context, options={}, &block)
Chris@1296:     if context && context.is_a?(Project)
Chris@1296:       return false unless context.allows_to?(action)
Chris@1296:       # Admin users are authorized for anything else
Chris@1296:       return true if admin?
Chris@1296: 
Chris@1296:       roles = roles_for_project(context)
Chris@1296:       return false unless roles
Chris@1296:       roles.any? {|role|
Chris@1296:         (context.is_public? || role.member?) &&
Chris@1296:         role.allowed_to?(action) &&
Chris@1296:         (block_given? ? yield(role, self) : true)
Chris@1296:       }
Chris@1296:     elsif context && context.is_a?(Array)
Chris@1296:       if context.empty?
Chris@1296:         false
Chris@1296:       else
Chris@1296:         # Authorize if user is authorized on every element of the array
Chris@1296:         context.map {|project| allowed_to?(action, project, options, &block)}.reduce(:&)
Chris@1296:       end
Chris@1296:     elsif options[:global]
Chris@1296:       # Admin users are always authorized
Chris@1296:       return true if admin?
Chris@1296: 
Chris@1296:       # authorize if user has at least one role that has this permission
Chris@1296:       roles = memberships.collect {|m| m.roles}.flatten.uniq
Chris@1296:       roles << (self.logged? ? Role.non_member : Role.anonymous)
Chris@1296:       roles.any? {|role|
Chris@1296:         role.allowed_to?(action) &&
Chris@1296:         (block_given? ? yield(role, self) : true)
Chris@1296:       }
Chris@1296:     else
Chris@1296:       false
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Is the user allowed to do the specified action on any project?
Chris@1296:   # See allowed_to? for the actions and valid options.
Chris@1296:   def allowed_to_globally?(action, options, &block)
Chris@1296:     allowed_to?(action, nil, options.reverse_merge(:global => true), &block)
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns true if the user is allowed to delete his own account
Chris@1296:   def own_account_deletable?
Chris@1296:     Setting.unsubscribe? &&
Chris@1296:       (!admin? || User.active.where("admin = ? AND id <> ?", true, id).exists?)
Chris@1296:   end
Chris@1296: 
Chris@1296:   safe_attributes 'login',
Chris@1296:     'firstname',
Chris@1296:     'lastname',
Chris@1296:     'mail',
Chris@1296:     'mail_notification',
Chris@1296:     'language',
Chris@1296:     'custom_field_values',
Chris@1296:     'custom_fields',
Chris@1296:     'identity_url'
Chris@1296: 
Chris@1296:   safe_attributes 'status',
Chris@1296:     'auth_source_id',
Chris@1296:     :if => lambda {|user, current_user| current_user.admin?}
Chris@1296: 
Chris@1296:   safe_attributes 'group_ids',
Chris@1296:     :if => lambda {|user, current_user| current_user.admin? && !user.new_record?}
Chris@1296: 
Chris@1296:   # Utility method to help check if a user should be notified about an
Chris@1296:   # event.
Chris@1296:   #
Chris@1296:   # TODO: only supports Issue events currently
Chris@1296:   def notify_about?(object)
Chris@1296:     case mail_notification
Chris@1296:     when 'all'
Chris@1296:       true
Chris@1296:     when 'selected'
Chris@1296:       # user receives notifications for created/assigned issues on unselected projects
Chris@1296:       if object.is_a?(Issue) && (object.author == self || is_or_belongs_to?(object.assigned_to) || is_or_belongs_to?(object.assigned_to_was))
Chris@1296:         true
Chris@1296:       else
Chris@1296:         false
Chris@1296:       end
Chris@1296:     when 'none'
Chris@1296:       false
Chris@1296:     when 'only_my_events'
Chris@1296:       if object.is_a?(Issue) && (object.author == self || is_or_belongs_to?(object.assigned_to) || is_or_belongs_to?(object.assigned_to_was))
Chris@1296:         true
Chris@1296:       else
Chris@1296:         false
Chris@1296:       end
Chris@1296:     when 'only_assigned'
Chris@1296:       if object.is_a?(Issue) && (is_or_belongs_to?(object.assigned_to) || is_or_belongs_to?(object.assigned_to_was))
Chris@1296:         true
Chris@1296:       else
Chris@1296:         false
Chris@1296:       end
Chris@1296:     when 'only_owner'
Chris@1296:       if object.is_a?(Issue) && object.author == self
Chris@1296:         true
Chris@1296:       else
Chris@1296:         false
Chris@1296:       end
Chris@1296:     else
Chris@1296:       false
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def self.current=(user)
Chris@1296:     @current_user = user
Chris@1296:   end
Chris@1296: 
Chris@1296:   def self.current
Chris@1296:     @current_user ||= User.anonymous
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns the anonymous user.  If the anonymous user does not exist, it is created.  There can be only
Chris@1296:   # one anonymous user per database.
Chris@1296:   def self.anonymous
Chris@1296:     anonymous_user = AnonymousUser.first
Chris@1296:     if anonymous_user.nil?
Chris@1296:       anonymous_user = AnonymousUser.create(:lastname => 'Anonymous', :firstname => '', :mail => '', :login => '', :status => 0)
Chris@1296:       raise 'Unable to create the anonymous user.' if anonymous_user.new_record?
Chris@1296:     end
Chris@1296:     anonymous_user
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Salts all existing unsalted passwords
Chris@1296:   # It changes password storage scheme from SHA1(password) to SHA1(salt + SHA1(password))
Chris@1296:   # This method is used in the SaltPasswords migration and is to be kept as is
Chris@1296:   def self.salt_unsalted_passwords!
Chris@1296:     transaction do
Chris@1296:       User.where("salt IS NULL OR salt = ''").find_each do |user|
Chris@1296:         next if user.hashed_password.blank?
Chris@1296:         salt = User.generate_salt
Chris@1296:         hashed_password = User.hash_password("#{salt}#{user.hashed_password}")
Chris@1296:         User.where(:id => user.id).update_all(:salt => salt, :hashed_password => hashed_password)
Chris@1296:       end
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   protected
Chris@1296: 
Chris@1296:   def validate_password_length
Chris@1296:     # Password length validation based on setting
Chris@1296:     if !password.nil? && password.size < Setting.password_min_length.to_i
Chris@1296:       errors.add(:password, :too_short, :count => Setting.password_min_length.to_i)
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   private
Chris@1296: 
Chris@1296:   # Removes references that are not handled by associations
Chris@1296:   # Things that are not deleted are reassociated with the anonymous user
Chris@1296:   def remove_references_before_destroy
Chris@1296:     return if self.id.nil?
Chris@1296: 
Chris@1296:     substitute = User.anonymous
Chris@1296:     Attachment.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@1296:     Comment.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@1296:     Issue.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@1296:     Issue.update_all 'assigned_to_id = NULL', ['assigned_to_id = ?', id]
Chris@1296:     Journal.update_all ['user_id = ?', substitute.id], ['user_id = ?', id]
Chris@1296:     JournalDetail.update_all ['old_value = ?', substitute.id.to_s], ["property = 'attr' AND prop_key = 'assigned_to_id' AND old_value = ?", id.to_s]
Chris@1296:     JournalDetail.update_all ['value = ?', substitute.id.to_s], ["property = 'attr' AND prop_key = 'assigned_to_id' AND value = ?", id.to_s]
Chris@1296:     Message.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@1296:     News.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@1296:     # Remove private queries and keep public ones
Chris@1296:     ::Query.delete_all ['user_id = ? AND is_public = ?', id, false]
Chris@1296:     ::Query.update_all ['user_id = ?', substitute.id], ['user_id = ?', id]
Chris@1296:     TimeEntry.update_all ['user_id = ?', substitute.id], ['user_id = ?', id]
Chris@1296:     Token.delete_all ['user_id = ?', id]
Chris@1296:     Watcher.delete_all ['user_id = ?', id]
Chris@1296:     WikiContent.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@1296:     WikiContent::Version.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Return password digest
Chris@1296:   def self.hash_password(clear_password)
Chris@1296:     Digest::SHA1.hexdigest(clear_password || "")
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Returns a 128bits random salt as a hex string (32 chars long)
Chris@1296:   def self.generate_salt
Chris@1296:     Redmine::Utils.random_hex(16)
Chris@1296:   end
Chris@1296: 
Chris@1296: end
Chris@1296: 
Chris@1296: class AnonymousUser < User
Chris@1296:   validate :validate_anonymous_uniqueness, :on => :create
Chris@1296: 
Chris@1296:   def validate_anonymous_uniqueness
Chris@1296:     # There should be only one AnonymousUser in the database
Chris@1296:     errors.add :base, 'An anonymous user already exists.' if AnonymousUser.find(:first)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def available_custom_fields
Chris@1296:     []
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Overrides a few properties
Chris@1296:   def logged?; false end
Chris@1296:   def admin; false end
Chris@1296:   def name(*args); I18n.t(:label_user_anonymous) end
Chris@1296:   def mail; nil end
Chris@1296:   def time_zone; nil end
Chris@1296:   def rss_key; nil end
Chris@1296: 
Chris@1296:   def pref
Chris@1296:     UserPreference.new(:user => self)
Chris@1296:   end
Chris@1296: 
Chris@1296:   # Anonymous user can not be destroyed
Chris@1296:   def destroy
Chris@1296:     false
Chris@1296:   end
Chris@1296: end