user.rb
734 lines
| 23.0 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r2755 | # Redmine - project management software | ||
|
Jean-Philippe Lang
|
r10939 | # Copyright (C) 2006-2013 Jean-Philippe Lang | ||
|
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. | ||||
Toshi MARUYAMA
|
r6387 | # | ||
|
Jean-Philippe Lang
|
r330 | # 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. | ||||
|
Toshi MARUYAMA
|
r6387 | # | ||
|
Jean-Philippe Lang
|
r330 | # 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" | ||||
|
Jean-Philippe Lang
|
r2755 | class User < Principal | ||
|
Jean-Philippe Lang
|
r4378 | include Redmine::SafeAttributes | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r7818 | # Different ways of displaying/sorting users | ||
|
Jean-Philippe Lang
|
r1089 | USER_FORMATS = { | ||
|
Toshi MARUYAMA
|
r10331 | :firstname_lastname => { | ||
| :string => '#{firstname} #{lastname}', | ||||
| :order => %w(firstname lastname id), | ||||
| :setting_order => 1 | ||||
| }, | ||||
|
Jean-Philippe Lang
|
r10548 | :firstname_lastinitial => { | ||
| :string => '#{firstname} #{lastname.to_s.chars.first}.', | ||||
| :order => %w(firstname lastname id), | ||||
| :setting_order => 2 | ||||
| }, | ||||
|
Toshi MARUYAMA
|
r10331 | :firstname => { | ||
| :string => '#{firstname}', | ||||
| :order => %w(firstname id), | ||||
|
Jean-Philippe Lang
|
r10548 | :setting_order => 3 | ||
|
Toshi MARUYAMA
|
r10331 | }, | ||
| :lastname_firstname => { | ||||
| :string => '#{lastname} #{firstname}', | ||||
| :order => %w(lastname firstname id), | ||||
|
Jean-Philippe Lang
|
r10548 | :setting_order => 4 | ||
|
Toshi MARUYAMA
|
r10331 | }, | ||
| :lastname_coma_firstname => { | ||||
| :string => '#{lastname}, #{firstname}', | ||||
| :order => %w(lastname firstname id), | ||||
|
Jean-Philippe Lang
|
r10548 | :setting_order => 5 | ||
|
Toshi MARUYAMA
|
r10331 | }, | ||
|
Toshi MARUYAMA
|
r10332 | :lastname => { | ||
| :string => '#{lastname}', | ||||
| :order => %w(lastname id), | ||||
|
Jean-Philippe Lang
|
r10548 | :setting_order => 6 | ||
|
Toshi MARUYAMA
|
r10332 | }, | ||
|
Toshi MARUYAMA
|
r10331 | :username => { | ||
| :string => '#{login}', | ||||
| :order => %w(login id), | ||||
|
Jean-Philippe Lang
|
r10548 | :setting_order => 7 | ||
|
Toshi MARUYAMA
|
r10331 | }, | ||
|
Jean-Philippe Lang
|
r1089 | } | ||
|
Jean-Philippe Lang
|
r535 | |||
Eric Davis
|
r4102 | MAIL_NOTIFICATION_OPTIONS = [ | ||
|
Jean-Philippe Lang
|
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] | ||||
| ] | ||||
|
Eric Davis
|
r4102 | |||
|
Jean-Philippe Lang
|
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)} | ||||
|
Jean-Philippe Lang
|
r2004 | has_many :changesets, :dependent => :nullify | ||
|
Jean-Philippe Lang
|
r330 | has_one :preference, :dependent => :destroy, :class_name => 'UserPreference' | ||
|
Jean-Philippe Lang
|
r4606 | has_one :rss_token, :class_name => 'Token', :conditions => "action='feeds'" | ||
| has_one :api_token, :class_name => 'Token', :conditions => "action='api'" | ||||
|
Jean-Philippe Lang
|
r330 | belongs_to :auth_source | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r10723 | scope :logged, lambda { where("#{User.table_name}.status <> #{STATUS_ANONYMOUS}") } | ||
| scope :status, lambda {|arg| where(arg.blank? ? nil : {:status => arg.to_i}) } | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r1578 | acts_as_customizable | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r11226 | attr_accessor :password, :password_confirmation, :generate_password | ||
|
Jean-Philippe Lang
|
r330 | attr_accessor :last_before_login_on | ||
| # Prevents unauthorized assignments | ||||
|
Jean-Philippe Lang
|
r4385 | attr_protected :login, :admin, :password, :password_confirmation, :hashed_password | ||
|
Jean-Philippe Lang
|
r8658 | |||
| LOGIN_LENGTH_LIMIT = 60 | ||||
| MAIL_LENGTH_LIMIT = 60 | ||||
|
Jean-Philippe Lang
|
r906 | validates_presence_of :login, :firstname, :lastname, :mail, :if => Proc.new { |user| !user.is_a?(AnonymousUser) } | ||
|
Jean-Philippe Lang
|
r9315 | validates_uniqueness_of :login, :if => Proc.new { |user| user.login_changed? && user.login.present? }, :case_sensitive => false | ||
|
Jean-Philippe Lang
|
r10656 | validates_uniqueness_of :mail, :if => Proc.new { |user| user.mail_changed? && user.mail.present? }, :case_sensitive => false | ||
|
Toshi MARUYAMA
|
r11197 | # Login must contain letters, numbers, underscores only | ||
|
Jean-Philippe Lang
|
r10733 | validates_format_of :login, :with => /\A[a-z0-9_\-@\.]*\z/i | ||
|
Jean-Philippe Lang
|
r8658 | validates_length_of :login, :maximum => LOGIN_LENGTH_LIMIT | ||
|
Jean-Philippe Lang
|
r397 | validates_length_of :firstname, :lastname, :maximum => 30 | ||
|
Jean-Philippe Lang
|
r10733 | validates_format_of :mail, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i, :allow_blank => true | ||
|
Jean-Philippe Lang
|
r8658 | validates_length_of :mail, :maximum => MAIL_LENGTH_LIMIT, :allow_nil => true | ||
|
Jean-Philippe Lang
|
r330 | validates_confirmation_of :password, :allow_nil => true | ||
|
Jean-Philippe Lang
|
r4380 | validates_inclusion_of :mail_notification, :in => MAIL_NOTIFICATION_OPTIONS.collect(&:first), :allow_blank => true | ||
|
Toshi MARUYAMA
|
r7311 | validate :validate_password_length | ||
|
Jean-Philippe Lang
|
r330 | |||
|
Toshi MARUYAMA
|
r6723 | before_create :set_mail_notification | ||
|
Jean-Philippe Lang
|
r11226 | before_save :generate_password_if_needed, :update_hashed_password | ||
|
Jean-Philippe Lang
|
r4606 | before_destroy :remove_references_before_destroy | ||
|
Jean-Philippe Lang
|
r11610 | after_save :update_notified_project_ids | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Toshi MARUYAMA
|
r9355 | scope :in_group, lambda {|group| | ||
|
Jean-Philippe Lang
|
r5030 | group_id = group.is_a?(Group) ? group.id : group.to_i | ||
|
Jean-Philippe Lang
|
r10654 | 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) | ||
|
Jean-Philippe Lang
|
r5030 | } | ||
|
Toshi MARUYAMA
|
r9355 | scope :not_in_group, lambda {|group| | ||
|
Jean-Philippe Lang
|
r5164 | group_id = group.is_a?(Group) ? group.id : group.to_i | ||
|
Jean-Philippe Lang
|
r10654 | 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) | ||
|
Jean-Philippe Lang
|
r5164 | } | ||
|
Jean-Philippe Lang
|
r11029 | scope :sorted, lambda { order(*User.fields_for_order_statement)} | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Toshi MARUYAMA
|
r6723 | def set_mail_notification | ||
|
Eric Davis
|
r4109 | self.mail_notification = Setting.default_notification_option if self.mail_notification.blank? | ||
|
Jean-Philippe Lang
|
r842 | true | ||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Toshi MARUYAMA
|
r6803 | def update_hashed_password | ||
|
Jean-Philippe Lang
|
r330 | # update hashed_password if password was set | ||
|
Jean-Philippe Lang
|
r4816 | if self.password && self.auth_source_id.blank? | ||
| salt_password(password) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r11267 | alias :base_reload :reload | ||
|
Jean-Philippe Lang
|
r2008 | def reload(*args) | ||
| @name = nil | ||||
|
Jean-Philippe Lang
|
r5020 | @projects_by_role = nil | ||
|
Jean-Philippe Lang
|
r11278 | @membership_by_project_id = nil | ||
|
Jean-Philippe Lang
|
r11610 | @notified_projects_ids = nil | ||
| @notified_projects_ids_changed = false | ||||
|
Jean-Philippe Lang
|
r11736 | @builtin_role = nil | ||
|
Jean-Philippe Lang
|
r11267 | base_reload(*args) | ||
|
Jean-Philippe Lang
|
r2008 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r3759 | def mail=(arg) | ||
| write_attribute(:mail, arg.to_s.strip) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Eric Davis
|
r2392 | def identity_url=(url) | ||
|
Jean-Philippe Lang
|
r2415 | if url.blank? | ||
| write_attribute(:identity_url, '') | ||||
| else | ||||
| begin | ||||
| write_attribute(:identity_url, OpenIdAuthentication.normalize_identifier(url)) | ||||
| rescue OpenIdAuthentication::InvalidOpenId | ||||
|
Toshi MARUYAMA
|
r11197 | # Invalid url, don't save | ||
|
Jean-Philippe Lang
|
r2415 | end | ||
|
Eric Davis
|
r2392 | end | ||
| self.read_attribute(:identity_url) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r330 | # Returns the user that matches provided login and password, or nil | ||
|
Jean-Philippe Lang
|
r11716 | def self.try_to_login(login, password, active_only=true) | ||
|
Jean-Philippe Lang
|
r9616 | login = login.to_s | ||
| password = password.to_s | ||||
|
Jean-Philippe Lang
|
r11145 | # Make sure no one can sign in with an empty login or password | ||
| return nil if login.empty? || password.empty? | ||||
|
Jean-Philippe Lang
|
r8910 | user = find_by_login(login) | ||
|
Jean-Philippe Lang
|
r330 | if user | ||
| # user is already in local database | ||||
|
Jean-Philippe Lang
|
r11145 | return nil unless user.check_password?(password) | ||
|
Toshi MARUYAMA
|
r11724 | return nil if !user.active? && active_only | ||
|
Jean-Philippe Lang
|
r330 | else | ||
| # user is not yet registered, try to authenticate with available sources | ||||
| attrs = AuthSource.authenticate(login, password) | ||||
| if attrs | ||||
|
Jean-Philippe Lang
|
r3378 | user = new(attrs) | ||
|
Jean-Philippe Lang
|
r1661 | user.login = login | ||
| user.language = Setting.default_language | ||||
| if user.save | ||||
| user.reload | ||||
|
Eric Davis
|
r3631 | logger.info("User '#{user.login}' created from external auth source: #{user.auth_source.type} - #{user.auth_source.name}") if logger && user.auth_source | ||
|
Jean-Philippe Lang
|
r330 | end | ||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | end | ||
|
Jean-Philippe Lang
|
r11716 | user.update_column(:last_login_on, Time.now) if user && !user.new_record? && user.active? | ||
|
Jean-Philippe Lang
|
r330 | user | ||
|
Jean-Philippe Lang
|
r1330 | rescue => text | ||
| raise text | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r2460 | # Returns the user who matches the given autologin +key+ or nil | ||
| def self.try_to_autologin(key) | ||||
|
Jean-Philippe Lang
|
r11066 | user = Token.find_active_user('autologin', key, Setting.autologin.to_i) | ||
| if user | ||||
| user.update_column(:last_login_on, Time.now) | ||||
| user | ||||
|
Jean-Philippe Lang
|
r2460 | end | ||
| end | ||||
|
Jean-Philippe Lang
|
r7818 | |||
| def self.name_formatter(formatter = nil) | ||||
| USER_FORMATS[formatter || Setting.user_format] || USER_FORMATS[:firstname_lastname] | ||||
| end | ||||
| # Returns an array of fields names than can be used to make an order statement for users | ||||
| # according to how user names are displayed | ||||
| # Examples: | ||||
| # | ||||
| # User.fields_for_order_statement => ['users.login', 'users.id'] | ||||
| # User.fields_for_order_statement('authors') => ['authors.login', 'authors.id'] | ||||
| def self.fields_for_order_statement(table=nil) | ||||
| table ||= table_name | ||||
| name_formatter[:order].map {|field| "#{table}.#{field}"} | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | # Return user's full name for display | ||
|
Jean-Philippe Lang
|
r1089 | def name(formatter = nil) | ||
|
Jean-Philippe Lang
|
r7818 | f = self.class.name_formatter(formatter) | ||
|
Jean-Philippe Lang
|
r2029 | if formatter | ||
|
Jean-Philippe Lang
|
r7818 | eval('"' + f[:string] + '"') | ||
|
Jean-Philippe Lang
|
r2029 | else | ||
|
Jean-Philippe Lang
|
r7818 | @name ||= eval('"' + f[:string] + '"') | ||
|
Jean-Philippe Lang
|
r2029 | end | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r330 | def active? | ||
| self.status == STATUS_ACTIVE | ||||
| end | ||||
| def registered? | ||||
| self.status == STATUS_REGISTERED | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r330 | def locked? | ||
| self.status == STATUS_LOCKED | ||||
| end | ||||
|
Eric Davis
|
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 | ||||
|
Jean-Philippe Lang
|
r4816 | # Returns true if +clear_password+ is the correct user's password, otherwise false | ||
|
Jean-Philippe Lang
|
r330 | def check_password?(clear_password) | ||
|
Eric Davis
|
r3631 | if auth_source_id.present? | ||
| auth_source.authenticate(self.login, clear_password) | ||||
| else | ||||
|
Jean-Philippe Lang
|
r4816 | User.hash_password("#{salt}#{User.hash_password clear_password}") == hashed_password | ||
|
Eric Davis
|
r3631 | end | ||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
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 | ||||
|
Eric Davis
|
r3631 | |||
| # Does the backend storage allow this user to change their password? | ||||
| def change_password_allowed? | ||||
|
Jean-Philippe Lang
|
r8173 | return true if auth_source.nil? | ||
|
Eric Davis
|
r3631 | return auth_source.allow_password_changes? | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Eric Davis
|
r2382 | |||
|
Jean-Philippe Lang
|
r11226 | def generate_password? | ||
| generate_password == '1' || generate_password == true | ||||
| end | ||||
| # Generate and set a random password on given length | ||||
| def random_password(length=40) | ||||
|
Eric Davis
|
r2382 | chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a | ||
|
Jean-Philippe Lang
|
r11226 | chars -= %w(0 O 1 l) | ||
|
Eric Davis
|
r2382 | password = '' | ||
|
Jean-Philippe Lang
|
r11226 | length.times {|i| password << chars[SecureRandom.random_number(chars.size)] } | ||
|
Eric Davis
|
r2382 | self.password = password | ||
| self.password_confirmation = password | ||||
| self | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r330 | def pref | ||
| self.preference ||= UserPreference.new(:user => self) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r904 | def time_zone | ||
|
Jean-Philippe Lang
|
r2132 | @time_zone ||= (self.pref.time_zone.blank? ? nil : ActiveSupport::TimeZone[self.pref.time_zone]) | ||
|
Jean-Philippe Lang
|
r904 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r1183 | def wants_comments_in_reverse_order? | ||
| self.pref[:comments_sorting] == 'desc' | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r663 | # Return user's RSS key (a 40 chars long string), used to access feeds | ||
| def rss_key | ||||
|
Jean-Philippe Lang
|
r9285 | if rss_token.nil? | ||
| create_rss_token(:action => 'feeds') | ||||
| end | ||||
| rss_token.value | ||||
|
Jean-Philippe Lang
|
r336 | end | ||
|
Eric Davis
|
r3103 | |||
| # Return user's API key (a 40 chars long string), used to access the API | ||||
| def api_key | ||||
|
Jean-Philippe Lang
|
r9285 | if api_token.nil? | ||
| create_api_token(:action => 'api') | ||||
| end | ||||
| api_token.value | ||||
|
Eric Davis
|
r3103 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
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 | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r842 | def notified_project_ids=(ids) | ||
|
Jean-Philippe Lang
|
r11610 | @notified_projects_ids_changed = true | ||
| @notified_projects_ids = ids | ||||
| end | ||||
| # Updates per project notifications (after_save callback) | ||||
| def update_notified_project_ids | ||||
| if @notified_projects_ids_changed | ||||
| ids = (mail_notification == 'selected' ? Array.wrap(notified_projects_ids).reject(&:blank?) : []) | ||||
| members.update_all(:mail_notification => false) | ||||
| members.where(:project_id => ids).update_all(:mail_notification => true) if ids.any? | ||||
| end | ||||
|
Jean-Philippe Lang
|
r842 | end | ||
|
Jean-Philippe Lang
|
r11610 | private :update_notified_project_ids | ||
|
Eric Davis
|
r3694 | |||
|
Eric Davis
|
r4110 | def valid_notification_options | ||
|
Jean-Philippe Lang
|
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) | ||||
|
Eric Davis
|
r4110 | # Note that @user.membership.size would fail since AR ignores | ||
| # :include association option when doing a count | ||||
|
Jean-Philippe Lang
|
r4610 | if user.nil? || user.memberships.length < 1 | ||
|
Jean-Philippe Lang
|
r4607 | MAIL_NOTIFICATION_OPTIONS.reject {|option| option.first == 'selected'} | ||
|
Eric Davis
|
r4110 | else | ||
| MAIL_NOTIFICATION_OPTIONS | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r3694 | # Find a user account by matching the exact login and then a case-insensitive | ||
| # version. Exact matches will be given priority. | ||||
|
Eric Davis
|
r3693 | def self.find_by_login(login) | ||
|
Jean-Philippe Lang
|
r10992 | if login.present? | ||
| login = login.to_s | ||||
| # First look for an exact match | ||||
| user = where(:login => login).all.detect {|u| u.login == login} | ||||
| unless user | ||||
| # Fail over to case-insensitive if none was found | ||||
| user = where("LOWER(login) = ?", login.downcase).first | ||||
| end | ||||
| user | ||||
|
Jean-Philippe Lang
|
r8910 | end | ||
|
Eric Davis
|
r3693 | end | ||
|
Jean-Philippe Lang
|
r336 | def self.find_by_rss_key(key) | ||
|
Jean-Philippe Lang
|
r11066 | Token.find_active_user('feeds', key) | ||
|
Jean-Philippe Lang
|
r336 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Eric Davis
|
r3103 | def self.find_by_api_key(key) | ||
|
Jean-Philippe Lang
|
r11066 | Token.find_active_user('api', key) | ||
|
Eric Davis
|
r3103 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r2120 | # Makes find_by_mail case-insensitive | ||
| def self.find_by_mail(mail) | ||||
|
Jean-Philippe Lang
|
r10654 | where("LOWER(mail) = ?", mail.to_s.downcase).first | ||
|
Jean-Philippe Lang
|
r2120 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r9245 | # Returns true if the default admin account can no longer be used | ||
| def self.default_admin_account_changed? | ||||
| !User.active.find_by_login("admin").try(:check_password?, "admin") | ||||
| end | ||||
|
Jean-Philippe Lang
|
r663 | def to_s | ||
| name | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r10462 | CSS_CLASS_BY_STATUS = { | ||
| STATUS_ANONYMOUS => 'anon', | ||||
| STATUS_ACTIVE => 'active', | ||||
| STATUS_REGISTERED => 'registered', | ||||
| STATUS_LOCKED => 'locked' | ||||
| } | ||||
| def css_classes | ||||
| "user #{CSS_CLASS_BY_STATUS[status]}" | ||||
| end | ||||
|
Jean-Philippe Lang
|
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 | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r9543 | # Returns the day of +time+ according to user's time zone | ||
| def time_to_date(time) | ||||
| if time_zone.nil? | ||||
| time.to_date | ||||
| else | ||||
| time.in_time_zone(time_zone).to_date | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r663 | def logged? | ||
| true | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r1657 | def anonymous? | ||
| !logged? | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r11278 | # Returns user's membership for the given project | ||
| # or nil if the user is not a member of project | ||||
| def membership(project) | ||||
| project_id = project.is_a?(Project) ? project.id : project | ||||
| @membership_by_project_id ||= Hash.new {|h, project_id| | ||||
| h[project_id] = memberships.where(:project_id => project_id).first | ||||
| } | ||||
| @membership_by_project_id[project_id] | ||||
| end | ||||
|
Jean-Philippe Lang
|
r11735 | # Returns the user's bult-in role | ||
| def builtin_role | ||||
|
Jean-Philippe Lang
|
r11737 | @builtin_role ||= Role.non_member | ||
|
Jean-Philippe Lang
|
r11735 | end | ||
|
Jean-Philippe Lang
|
r2627 | # Return user's roles for project | ||
| def roles_for_project(project) | ||||
| roles = [] | ||||
|
Jean-Philippe Lang
|
r663 | # No role on archived projects | ||
|
Jean-Philippe Lang
|
r9700 | return roles if project.nil? || project.archived? | ||
|
Jean-Philippe Lang
|
r11737 | if membership = membership(project) | ||
| roles = membership.roles | ||||
|
Jean-Philippe Lang
|
r663 | else | ||
|
Jean-Philippe Lang
|
r11735 | roles << builtin_role | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Jean-Philippe Lang
|
r2627 | roles | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r663 | # Return true if the user is a member of project | ||
| def member_of?(project) | ||||
|
Jean-Philippe Lang
|
r11375 | projects.to_a.include?(project) | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r5020 | # Returns a hash of user's projects grouped by roles | ||
| def projects_by_role | ||||
| return @projects_by_role if @projects_by_role | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r10059 | @projects_by_role = Hash.new([]) | ||
|
Jean-Philippe Lang
|
r5020 | memberships.each do |membership| | ||
|
Jean-Philippe Lang
|
r10059 | if membership.project | ||
| membership.roles.each do |role| | ||||
| @projects_by_role[role] = [] unless @projects_by_role.key?(role) | ||||
| @projects_by_role[role] << membership.project | ||||
| end | ||||
|
Jean-Philippe Lang
|
r5020 | end | ||
| end | ||||
| @projects_by_role.each do |role, projects| | ||||
| projects.uniq! | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r5020 | @projects_by_role | ||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r6186 | # Returns true if user is arg or belongs to arg | ||
| def is_or_belongs_to?(arg) | ||||
| if arg.is_a?(User) | ||||
| self == arg | ||||
| elsif arg.is_a?(Group) | ||||
| arg.users.include?(self) | ||||
| else | ||||
| false | ||||
| end | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
Jean-Baptiste Barth
|
r4113 | # Return true if the user is allowed to do the specified action on a specific context | ||
| # Action can be: | ||||
|
Jean-Philippe Lang
|
r663 | # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit') | ||
| # * a permission Symbol (eg. :edit_project) | ||||
|
Jean-Baptiste Barth
|
r4113 | # Context can be: | ||
| # * a project : returns true if user is allowed to do the specified action on this project | ||||
|
Jean-Philippe Lang
|
r5296 | # * an array of projects : returns true if user is allowed on every project | ||
|
Toshi MARUYAMA
|
r6387 | # * nil with options[:global] set : check if user has at least one role allowed for this action, | ||
|
Jean-Baptiste Barth
|
r4113 | # or falls back to Non Member / Anonymous permissions depending if the user is logged | ||
|
Jean-Philippe Lang
|
r5296 | def allowed_to?(action, context, options={}, &block) | ||
|
Jean-Baptiste Barth
|
r4120 | if context && context.is_a?(Project) | ||
| return false unless context.allows_to?(action) | ||||
|
Jean-Philippe Lang
|
r1297 | # Admin users are authorized for anything else | ||
| return true if admin? | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Baptiste Barth
|
r4120 | roles = roles_for_project(context) | ||
|
Jean-Philippe Lang
|
r2627 | return false unless roles | ||
|
Jean-Philippe Lang
|
r10403 | roles.any? {|role| | ||
|
Jean-Philippe Lang
|
r5296 | (context.is_public? || role.member?) && | ||
| role.allowed_to?(action) && | ||||
| (block_given? ? yield(role, self) : true) | ||||
| } | ||||
|
Jean-Baptiste Barth
|
r4120 | elsif context && context.is_a?(Array) | ||
|
Jean-Philippe Lang
|
r10403 | if context.empty? | ||
| false | ||||
| else | ||||
| # Authorize if user is authorized on every element of the array | ||||
| context.map {|project| allowed_to?(action, project, options, &block)}.reduce(:&) | ||||
|
Jean-Baptiste Barth
|
r4113 | end | ||
|
Jean-Philippe Lang
|
r1297 | elsif options[:global] | ||
|
Jean-Philippe Lang
|
r2651 | # Admin users are always authorized | ||
| return true if admin? | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r1297 | # authorize if user has at least one role that has this permission | ||
|
Jean-Philippe Lang
|
r2627 | roles = memberships.collect {|m| m.roles}.flatten.uniq | ||
|
Jean-Philippe Lang
|
r5296 | roles << (self.logged? ? Role.non_member : Role.anonymous) | ||
|
Jean-Philippe Lang
|
r10403 | roles.any? {|role| | ||
|
Jean-Philippe Lang
|
r5296 | role.allowed_to?(action) && | ||
| (block_given? ? yield(role, self) : true) | ||||
| } | ||||
|
Jean-Philippe Lang
|
r1297 | else | ||
| false | ||||
| end | ||||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Eric Davis
|
r4050 | |||
| # Is the user allowed to do the specified action on any project? | ||||
| # See allowed_to? for the actions and valid options. | ||||
|
Jean-Philippe Lang
|
r5296 | def allowed_to_globally?(action, options, &block) | ||
| allowed_to?(action, nil, options.reverse_merge(:global => true), &block) | ||||
|
Eric Davis
|
r4050 | end | ||
|
Jean-Philippe Lang
|
r4378 | |||
|
Toshi MARUYAMA
|
r11759 | # Returns true if the user is allowed to delete the user's own account | ||
|
Jean-Philippe Lang
|
r9283 | def own_account_deletable? | ||
| Setting.unsubscribe? && | ||||
|
Jean-Philippe Lang
|
r10654 | (!admin? || User.active.where("admin = ? AND id <> ?", true, id).exists?) | ||
|
Jean-Philippe Lang
|
r9283 | end | ||
|
Jean-Philippe Lang
|
r4378 | safe_attributes 'login', | ||
| 'firstname', | ||||
| 'lastname', | ||||
| 'mail', | ||||
| 'mail_notification', | ||||
|
Jean-Philippe Lang
|
r11610 | 'notified_project_ids', | ||
|
Jean-Philippe Lang
|
r4378 | 'language', | ||
| 'custom_field_values', | ||||
| 'custom_fields', | ||||
| 'identity_url' | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r4378 | safe_attributes 'status', | ||
| 'auth_source_id', | ||||
|
Jean-Philippe Lang
|
r11226 | 'generate_password', | ||
|
Jean-Philippe Lang
|
r4378 | :if => lambda {|user, current_user| current_user.admin?} | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r4385 | safe_attributes 'group_ids', | ||
| :if => lambda {|user, current_user| current_user.admin? && !user.new_record?} | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Eric Davis
|
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) | ||||
|
Jean-Philippe Lang
|
r11041 | if mail_notification == 'all' | ||
|
Eric Davis
|
r4104 | true | ||
|
Jean-Philippe Lang
|
r11041 | elsif mail_notification.blank? || mail_notification == 'none' | ||
|
Eric Davis
|
r4104 | false | ||
|
Jean-Philippe Lang
|
r11041 | else | ||
| case object | ||||
| when Issue | ||||
| case mail_notification | ||||
| when 'selected', 'only_my_events' | ||||
| # user receives notifications for created/assigned issues on unselected projects | ||||
| object.author == self || is_or_belongs_to?(object.assigned_to) || is_or_belongs_to?(object.assigned_to_was) | ||||
| when 'only_assigned' | ||||
| is_or_belongs_to?(object.assigned_to) || is_or_belongs_to?(object.assigned_to_was) | ||||
| when 'only_owner' | ||||
| object.author == self | ||||
| end | ||||
| when News | ||||
| # always send to project members except when mail_notification is set to 'none' | ||||
|
Eric Davis
|
r4104 | true | ||
| end | ||||
| end | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r663 | def self.current=(user) | ||
|
Jean-Philippe Lang
|
r10684 | Thread.current[:current_user] = user | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r663 | def self.current | ||
|
Jean-Philippe Lang
|
r10684 | Thread.current[:current_user] ||= User.anonymous | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Eric Davis
|
r2536 | # Returns the anonymous user. If the anonymous user does not exist, it is created. There can be only | ||
| # one anonymous user per database. | ||||
|
Jean-Philippe Lang
|
r663 | def self.anonymous | ||
|
Jean-Philippe Lang
|
r10654 | anonymous_user = AnonymousUser.first | ||
|
Jean-Philippe Lang
|
r906 | 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 | ||||
|
Jean-Philippe Lang
|
r1429 | anonymous_user | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Jean-Philippe Lang
|
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 | ||||
|
Jean-Philippe Lang
|
r10654 | User.where("salt IS NULL OR salt = ''").find_each do |user| | ||
|
Jean-Philippe Lang
|
r4816 | next if user.hashed_password.blank? | ||
| salt = User.generate_salt | ||||
| hashed_password = User.hash_password("#{salt}#{user.hashed_password}") | ||||
|
Jean-Philippe Lang
|
r10655 | User.where(:id => user.id).update_all(:salt => salt, :hashed_password => hashed_password) | ||
|
Jean-Philippe Lang
|
r4816 | end | ||
| end | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r2586 | protected | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Toshi MARUYAMA
|
r7311 | def validate_password_length | ||
|
Jean-Philippe Lang
|
r11226 | return if password.blank? && generate_password? | ||
|
Jean-Philippe Lang
|
r2586 | # 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 | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r2586 | private | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r11226 | def generate_password_if_needed | ||
| if generate_password? && auth_source.nil? | ||||
| length = [Setting.password_min_length.to_i + 2, 10].max | ||||
| random_password(length) | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
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? | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r4606 | 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 | ||||
|
Toshi MARUYAMA
|
r8020 | ::Query.delete_all ['user_id = ? AND is_public = ?', id, false] | ||
| ::Query.update_all ['user_id = ?', substitute.id], ['user_id = ?', id] | ||||
|
Jean-Philippe Lang
|
r4606 | 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 | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r330 | # Return password digest | ||
| def self.hash_password(clear_password) | ||||
| Digest::SHA1.hexdigest(clear_password || "") | ||||
|
Jean-Philippe Lang
|
r5 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r4816 | # Returns a 128bits random salt as a hex string (32 chars long) | ||
| def self.generate_salt | ||||
|
Jean-Philippe Lang
|
r8951 | Redmine::Utils.random_hex(16) | ||
|
Jean-Philippe Lang
|
r4816 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r2 | end | ||
|
Jean-Philippe Lang
|
r663 | |||
| class AnonymousUser < User | ||||
|
Jean-Philippe Lang
|
r8173 | validate :validate_anonymous_uniqueness, :on => :create | ||
|
Toshi MARUYAMA
|
r8176 | |||
|
Jean-Philippe Lang
|
r8173 | def validate_anonymous_uniqueness | ||
|
Jean-Philippe Lang
|
r906 | # There should be only one AnonymousUser in the database | ||
|
Jean-Philippe Lang
|
r10701 | errors.add :base, 'An anonymous user already exists.' if AnonymousUser.exists? | ||
|
Jean-Philippe Lang
|
r904 | end | ||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r1578 | def available_custom_fields | ||
| [] | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r906 | # Overrides a few properties | ||
| def logged?; false end | ||||
| def admin; false end | ||||
|
Jean-Philippe Lang
|
r2910 | def name(*args); I18n.t(:label_user_anonymous) end | ||
|
Jean-Philippe Lang
|
r906 | def mail; nil end | ||
| def time_zone; nil end | ||||
| def rss_key; nil end | ||||
|
Toshi MARUYAMA
|
r6387 | |||
|
Jean-Philippe Lang
|
r9734 | def pref | ||
| UserPreference.new(:user => self) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r11737 | # Returns the user's bult-in role | ||
| def builtin_role | ||||
| @builtin_role ||= Role.anonymous | ||||
| end | ||||
| def membership(*args) | ||||
| nil | ||||
| end | ||||
| def member_of?(*args) | ||||
|
Jean-Philippe Lang
|
r11375 | false | ||
| end | ||||
|
Jean-Philippe Lang
|
r4606 | # Anonymous user can not be destroyed | ||
| def destroy | ||||
| false | ||||
| end | ||||
|
Jean-Philippe Lang
|
r663 | end | ||