annotate app/models/.svn/text-base/user.rb.svn-base @ 507:0c939c159af4 redmine-1.2

Update to Redmine 1.2.1 on 1.2-stable branch (Redmine SVN rev 6270)
author Chris Cannam
date Thu, 14 Jul 2011 10:32:19 +0100
parents cbce1fd3b1b7
children 753f1380d6bc
rev   line source
Chris@0 1 # Redmine - project management software
Chris@441 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
Chris@0 3 #
Chris@0 4 # This program is free software; you can redistribute it and/or
Chris@0 5 # modify it under the terms of the GNU General Public License
Chris@0 6 # as published by the Free Software Foundation; either version 2
Chris@0 7 # of the License, or (at your option) any later version.
Chris@0 8 #
Chris@0 9 # This program is distributed in the hope that it will be useful,
Chris@0 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@0 12 # GNU General Public License for more details.
Chris@0 13 #
Chris@0 14 # You should have received a copy of the GNU General Public License
Chris@0 15 # along with this program; if not, write to the Free Software
Chris@0 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@0 17
Chris@0 18 require "digest/sha1"
Chris@0 19
Chris@0 20 class User < Principal
Chris@119 21 include Redmine::SafeAttributes
Chris@119 22
Chris@0 23 # Account statuses
Chris@0 24 STATUS_ANONYMOUS = 0
Chris@0 25 STATUS_ACTIVE = 1
Chris@0 26 STATUS_REGISTERED = 2
Chris@0 27 STATUS_LOCKED = 3
Chris@0 28
Chris@0 29 USER_FORMATS = {
Chris@0 30 :firstname_lastname => '#{firstname} #{lastname}',
Chris@0 31 :firstname => '#{firstname}',
Chris@0 32 :lastname_firstname => '#{lastname} #{firstname}',
Chris@0 33 :lastname_coma_firstname => '#{lastname}, #{firstname}',
Chris@0 34 :username => '#{login}'
Chris@0 35 }
Chris@0 36
chris@37 37 MAIL_NOTIFICATION_OPTIONS = [
Chris@119 38 ['all', :label_user_mail_option_all],
Chris@119 39 ['selected', :label_user_mail_option_selected],
Chris@119 40 ['only_my_events', :label_user_mail_option_only_my_events],
Chris@119 41 ['only_assigned', :label_user_mail_option_only_assigned],
Chris@119 42 ['only_owner', :label_user_mail_option_only_owner],
Chris@119 43 ['none', :label_user_mail_option_none]
Chris@119 44 ]
chris@37 45
Chris@0 46 has_and_belongs_to_many :groups, :after_add => Proc.new {|user, group| group.user_added(user)},
Chris@0 47 :after_remove => Proc.new {|user, group| group.user_removed(user)}
Chris@0 48 has_many :issue_categories, :foreign_key => 'assigned_to_id', :dependent => :nullify
Chris@0 49 has_many :changesets, :dependent => :nullify
Chris@0 50 has_one :preference, :dependent => :destroy, :class_name => 'UserPreference'
Chris@128 51 has_one :rss_token, :class_name => 'Token', :conditions => "action='feeds'"
Chris@128 52 has_one :api_token, :class_name => 'Token', :conditions => "action='api'"
Chris@0 53 belongs_to :auth_source
Chris@0 54
Chris@0 55 # Active non-anonymous users scope
Chris@0 56 named_scope :active, :conditions => "#{User.table_name}.status = #{STATUS_ACTIVE}"
Chris@0 57
Chris@0 58 acts_as_customizable
Chris@0 59
Chris@0 60 attr_accessor :password, :password_confirmation
Chris@0 61 attr_accessor :last_before_login_on
Chris@0 62 # Prevents unauthorized assignments
Chris@119 63 attr_protected :login, :admin, :password, :password_confirmation, :hashed_password
Chris@0 64
Chris@0 65 validates_presence_of :login, :firstname, :lastname, :mail, :if => Proc.new { |user| !user.is_a?(AnonymousUser) }
Chris@0 66 validates_uniqueness_of :login, :if => Proc.new { |user| !user.login.blank? }, :case_sensitive => false
Chris@0 67 validates_uniqueness_of :mail, :if => Proc.new { |user| !user.mail.blank? }, :case_sensitive => false
Chris@0 68 # Login must contain lettres, numbers, underscores only
Chris@0 69 validates_format_of :login, :with => /^[a-z0-9_\-@\.]*$/i
Chris@0 70 validates_length_of :login, :maximum => 30
Chris@0 71 validates_length_of :firstname, :lastname, :maximum => 30
Chris@0 72 validates_format_of :mail, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :allow_nil => true
Chris@0 73 validates_length_of :mail, :maximum => 60, :allow_nil => true
Chris@0 74 validates_confirmation_of :password, :allow_nil => true
Chris@119 75 validates_inclusion_of :mail_notification, :in => MAIL_NOTIFICATION_OPTIONS.collect(&:first), :allow_blank => true
Chris@0 76
Chris@128 77 before_destroy :remove_references_before_destroy
Chris@128 78
Chris@441 79 named_scope :in_group, lambda {|group|
Chris@441 80 group_id = group.is_a?(Group) ? group.id : group.to_i
Chris@441 81 { :conditions => ["#{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@441 82 }
Chris@441 83 named_scope :not_in_group, lambda {|group|
Chris@441 84 group_id = group.is_a?(Group) ? group.id : group.to_i
Chris@441 85 { :conditions => ["#{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@441 86 }
Chris@441 87
Chris@0 88 def before_create
chris@37 89 self.mail_notification = Setting.default_notification_option if self.mail_notification.blank?
Chris@0 90 true
Chris@0 91 end
Chris@0 92
Chris@0 93 def before_save
Chris@0 94 # update hashed_password if password was set
Chris@245 95 if self.password && self.auth_source_id.blank?
Chris@245 96 salt_password(password)
Chris@245 97 end
Chris@0 98 end
Chris@0 99
Chris@0 100 def reload(*args)
Chris@0 101 @name = nil
Chris@441 102 @projects_by_role = nil
Chris@0 103 super
Chris@0 104 end
Chris@0 105
Chris@1 106 def mail=(arg)
Chris@1 107 write_attribute(:mail, arg.to_s.strip)
Chris@1 108 end
Chris@1 109
Chris@0 110 def identity_url=(url)
Chris@0 111 if url.blank?
Chris@0 112 write_attribute(:identity_url, '')
Chris@0 113 else
Chris@0 114 begin
Chris@0 115 write_attribute(:identity_url, OpenIdAuthentication.normalize_identifier(url))
Chris@0 116 rescue OpenIdAuthentication::InvalidOpenId
Chris@0 117 # Invlaid url, don't save
Chris@0 118 end
Chris@0 119 end
Chris@0 120 self.read_attribute(:identity_url)
Chris@0 121 end
Chris@0 122
Chris@0 123 # Returns the user that matches provided login and password, or nil
Chris@0 124 def self.try_to_login(login, password)
Chris@0 125 # Make sure no one can sign in with an empty password
Chris@0 126 return nil if password.to_s.empty?
Chris@0 127 user = find_by_login(login)
Chris@0 128 if user
Chris@0 129 # user is already in local database
Chris@0 130 return nil if !user.active?
Chris@0 131 if user.auth_source
Chris@0 132 # user has an external authentication method
Chris@0 133 return nil unless user.auth_source.authenticate(login, password)
Chris@0 134 else
Chris@0 135 # authentication with local password
Chris@245 136 return nil unless user.check_password?(password)
Chris@0 137 end
Chris@0 138 else
Chris@0 139 # user is not yet registered, try to authenticate with available sources
Chris@0 140 attrs = AuthSource.authenticate(login, password)
Chris@0 141 if attrs
Chris@0 142 user = new(attrs)
Chris@0 143 user.login = login
Chris@0 144 user.language = Setting.default_language
Chris@0 145 if user.save
Chris@0 146 user.reload
Chris@0 147 logger.info("User '#{user.login}' created from external auth source: #{user.auth_source.type} - #{user.auth_source.name}") if logger && user.auth_source
Chris@0 148 end
Chris@0 149 end
Chris@0 150 end
Chris@0 151 user.update_attribute(:last_login_on, Time.now) if user && !user.new_record?
Chris@0 152 user
Chris@0 153 rescue => text
Chris@0 154 raise text
Chris@0 155 end
Chris@0 156
Chris@0 157 # Returns the user who matches the given autologin +key+ or nil
Chris@0 158 def self.try_to_autologin(key)
Chris@0 159 tokens = Token.find_all_by_action_and_value('autologin', key)
Chris@0 160 # Make sure there's only 1 token that matches the key
Chris@0 161 if tokens.size == 1
Chris@0 162 token = tokens.first
Chris@0 163 if (token.created_on > Setting.autologin.to_i.day.ago) && token.user && token.user.active?
Chris@0 164 token.user.update_attribute(:last_login_on, Time.now)
Chris@0 165 token.user
Chris@0 166 end
Chris@0 167 end
Chris@0 168 end
Chris@0 169
Chris@0 170 # Return user's full name for display
Chris@0 171 def name(formatter = nil)
Chris@0 172 if formatter
Chris@0 173 eval('"' + (USER_FORMATS[formatter] || USER_FORMATS[:firstname_lastname]) + '"')
Chris@0 174 else
Chris@0 175 @name ||= eval('"' + (USER_FORMATS[Setting.user_format] || USER_FORMATS[:firstname_lastname]) + '"')
Chris@0 176 end
Chris@0 177 end
Chris@0 178
Chris@0 179 def active?
Chris@0 180 self.status == STATUS_ACTIVE
Chris@0 181 end
Chris@0 182
Chris@0 183 def registered?
Chris@0 184 self.status == STATUS_REGISTERED
Chris@0 185 end
Chris@0 186
Chris@0 187 def locked?
Chris@0 188 self.status == STATUS_LOCKED
Chris@0 189 end
Chris@0 190
Chris@14 191 def activate
Chris@14 192 self.status = STATUS_ACTIVE
Chris@14 193 end
Chris@14 194
Chris@14 195 def register
Chris@14 196 self.status = STATUS_REGISTERED
Chris@14 197 end
Chris@14 198
Chris@14 199 def lock
Chris@14 200 self.status = STATUS_LOCKED
Chris@14 201 end
Chris@14 202
Chris@14 203 def activate!
Chris@14 204 update_attribute(:status, STATUS_ACTIVE)
Chris@14 205 end
Chris@14 206
Chris@14 207 def register!
Chris@14 208 update_attribute(:status, STATUS_REGISTERED)
Chris@14 209 end
Chris@14 210
Chris@14 211 def lock!
Chris@14 212 update_attribute(:status, STATUS_LOCKED)
Chris@14 213 end
Chris@14 214
Chris@245 215 # Returns true if +clear_password+ is the correct user's password, otherwise false
Chris@0 216 def check_password?(clear_password)
Chris@0 217 if auth_source_id.present?
Chris@0 218 auth_source.authenticate(self.login, clear_password)
Chris@0 219 else
Chris@245 220 User.hash_password("#{salt}#{User.hash_password clear_password}") == hashed_password
Chris@0 221 end
Chris@0 222 end
Chris@245 223
Chris@245 224 # Generates a random salt and computes hashed_password for +clear_password+
Chris@245 225 # The hashed password is stored in the following form: SHA1(salt + SHA1(password))
Chris@245 226 def salt_password(clear_password)
Chris@245 227 self.salt = User.generate_salt
Chris@245 228 self.hashed_password = User.hash_password("#{salt}#{User.hash_password clear_password}")
Chris@245 229 end
Chris@0 230
Chris@0 231 # Does the backend storage allow this user to change their password?
Chris@0 232 def change_password_allowed?
Chris@0 233 return true if auth_source_id.blank?
Chris@0 234 return auth_source.allow_password_changes?
Chris@0 235 end
Chris@0 236
Chris@0 237 # Generate and set a random password. Useful for automated user creation
Chris@0 238 # Based on Token#generate_token_value
Chris@0 239 #
Chris@0 240 def random_password
Chris@0 241 chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
Chris@0 242 password = ''
Chris@0 243 40.times { |i| password << chars[rand(chars.size-1)] }
Chris@0 244 self.password = password
Chris@0 245 self.password_confirmation = password
Chris@0 246 self
Chris@0 247 end
Chris@0 248
Chris@0 249 def pref
Chris@0 250 self.preference ||= UserPreference.new(:user => self)
Chris@0 251 end
Chris@0 252
Chris@0 253 def time_zone
Chris@0 254 @time_zone ||= (self.pref.time_zone.blank? ? nil : ActiveSupport::TimeZone[self.pref.time_zone])
Chris@0 255 end
Chris@0 256
Chris@0 257 def wants_comments_in_reverse_order?
Chris@0 258 self.pref[:comments_sorting] == 'desc'
Chris@0 259 end
Chris@0 260
Chris@0 261 # Return user's RSS key (a 40 chars long string), used to access feeds
Chris@0 262 def rss_key
Chris@0 263 token = self.rss_token || Token.create(:user => self, :action => 'feeds')
Chris@0 264 token.value
Chris@0 265 end
Chris@0 266
Chris@0 267 # Return user's API key (a 40 chars long string), used to access the API
Chris@0 268 def api_key
Chris@0 269 token = self.api_token || self.create_api_token(:action => 'api')
Chris@0 270 token.value
Chris@0 271 end
Chris@0 272
Chris@0 273 # Return an array of project ids for which the user has explicitly turned mail notifications on
Chris@0 274 def notified_projects_ids
Chris@0 275 @notified_projects_ids ||= memberships.select {|m| m.mail_notification?}.collect(&:project_id)
Chris@0 276 end
Chris@0 277
Chris@0 278 def notified_project_ids=(ids)
Chris@0 279 Member.update_all("mail_notification = #{connection.quoted_false}", ['user_id = ?', id])
Chris@0 280 Member.update_all("mail_notification = #{connection.quoted_true}", ['user_id = ? AND project_id IN (?)', id, ids]) if ids && !ids.empty?
Chris@0 281 @notified_projects_ids = nil
Chris@0 282 notified_projects_ids
Chris@0 283 end
Chris@0 284
Chris@128 285 def valid_notification_options
Chris@128 286 self.class.valid_notification_options(self)
Chris@128 287 end
Chris@128 288
chris@37 289 # Only users that belong to more than 1 project can select projects for which they are notified
Chris@128 290 def self.valid_notification_options(user=nil)
chris@37 291 # Note that @user.membership.size would fail since AR ignores
chris@37 292 # :include association option when doing a count
Chris@128 293 if user.nil? || user.memberships.length < 1
Chris@128 294 MAIL_NOTIFICATION_OPTIONS.reject {|option| option.first == 'selected'}
chris@37 295 else
chris@37 296 MAIL_NOTIFICATION_OPTIONS
chris@37 297 end
chris@37 298 end
chris@37 299
Chris@0 300 # Find a user account by matching the exact login and then a case-insensitive
Chris@0 301 # version. Exact matches will be given priority.
Chris@0 302 def self.find_by_login(login)
Chris@0 303 # force string comparison to be case sensitive on MySQL
Chris@0 304 type_cast = (ActiveRecord::Base.connection.adapter_name == 'MySQL') ? 'BINARY' : ''
Chris@0 305
Chris@0 306 # First look for an exact match
Chris@0 307 user = first(:conditions => ["#{type_cast} login = ?", login])
Chris@0 308 # Fail over to case-insensitive if none was found
Chris@0 309 user ||= first(:conditions => ["#{type_cast} LOWER(login) = ?", login.to_s.downcase])
Chris@0 310 end
Chris@0 311
Chris@0 312 def self.find_by_rss_key(key)
Chris@0 313 token = Token.find_by_value(key)
Chris@0 314 token && token.user.active? ? token.user : nil
Chris@0 315 end
Chris@0 316
Chris@0 317 def self.find_by_api_key(key)
Chris@0 318 token = Token.find_by_action_and_value('api', key)
Chris@0 319 token && token.user.active? ? token.user : nil
Chris@0 320 end
Chris@0 321
Chris@0 322 # Makes find_by_mail case-insensitive
Chris@0 323 def self.find_by_mail(mail)
Chris@0 324 find(:first, :conditions => ["LOWER(mail) = ?", mail.to_s.downcase])
Chris@0 325 end
Chris@0 326
Chris@0 327 def to_s
Chris@0 328 name
Chris@0 329 end
Chris@0 330
Chris@0 331 # Returns the current day according to user's time zone
Chris@0 332 def today
Chris@0 333 if time_zone.nil?
Chris@0 334 Date.today
Chris@0 335 else
Chris@0 336 Time.now.in_time_zone(time_zone).to_date
Chris@0 337 end
Chris@0 338 end
Chris@0 339
Chris@0 340 def logged?
Chris@0 341 true
Chris@0 342 end
Chris@0 343
Chris@0 344 def anonymous?
Chris@0 345 !logged?
Chris@0 346 end
Chris@0 347
Chris@0 348 # Return user's roles for project
Chris@0 349 def roles_for_project(project)
Chris@0 350 roles = []
Chris@0 351 # No role on archived projects
Chris@0 352 return roles unless project && project.active?
Chris@0 353 if logged?
Chris@0 354 # Find project membership
Chris@0 355 membership = memberships.detect {|m| m.project_id == project.id}
Chris@0 356 if membership
Chris@0 357 roles = membership.roles
Chris@0 358 else
Chris@0 359 @role_non_member ||= Role.non_member
Chris@0 360 roles << @role_non_member
Chris@0 361 end
Chris@0 362 else
Chris@0 363 @role_anonymous ||= Role.anonymous
Chris@0 364 roles << @role_anonymous
Chris@0 365 end
Chris@0 366 roles
Chris@0 367 end
Chris@0 368
Chris@0 369 # Return true if the user is a member of project
Chris@0 370 def member_of?(project)
Chris@0 371 !roles_for_project(project).detect {|role| role.member?}.nil?
Chris@0 372 end
Chris@0 373
Chris@441 374 # Returns a hash of user's projects grouped by roles
Chris@441 375 def projects_by_role
Chris@441 376 return @projects_by_role if @projects_by_role
Chris@441 377
Chris@441 378 @projects_by_role = Hash.new {|h,k| h[k]=[]}
Chris@441 379 memberships.each do |membership|
Chris@441 380 membership.roles.each do |role|
Chris@441 381 @projects_by_role[role] << membership.project if membership.project
Chris@441 382 end
Chris@441 383 end
Chris@441 384 @projects_by_role.each do |role, projects|
Chris@441 385 projects.uniq!
Chris@441 386 end
Chris@441 387
Chris@441 388 @projects_by_role
Chris@441 389 end
Chris@441 390
chris@37 391 # Return true if the user is allowed to do the specified action on a specific context
chris@37 392 # Action can be:
Chris@0 393 # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')
Chris@0 394 # * a permission Symbol (eg. :edit_project)
chris@37 395 # Context can be:
chris@37 396 # * a project : returns true if user is allowed to do the specified action on this project
Chris@441 397 # * an array of projects : returns true if user is allowed on every project
chris@37 398 # * nil with options[:global] set : check if user has at least one role allowed for this action,
chris@37 399 # or falls back to Non Member / Anonymous permissions depending if the user is logged
Chris@441 400 def allowed_to?(action, context, options={}, &block)
chris@37 401 if context && context.is_a?(Project)
Chris@0 402 # No action allowed on archived projects
chris@37 403 return false unless context.active?
Chris@0 404 # No action allowed on disabled modules
chris@37 405 return false unless context.allows_to?(action)
Chris@0 406 # Admin users are authorized for anything else
Chris@0 407 return true if admin?
Chris@0 408
chris@37 409 roles = roles_for_project(context)
Chris@0 410 return false unless roles
Chris@441 411 roles.detect {|role|
Chris@441 412 (context.is_public? || role.member?) &&
Chris@441 413 role.allowed_to?(action) &&
Chris@441 414 (block_given? ? yield(role, self) : true)
Chris@441 415 }
chris@37 416 elsif context && context.is_a?(Array)
chris@37 417 # Authorize if user is authorized on every element of the array
chris@37 418 context.map do |project|
Chris@441 419 allowed_to?(action, project, options, &block)
chris@37 420 end.inject do |memo,allowed|
chris@37 421 memo && allowed
chris@37 422 end
Chris@0 423 elsif options[:global]
Chris@0 424 # Admin users are always authorized
Chris@0 425 return true if admin?
Chris@0 426
Chris@0 427 # authorize if user has at least one role that has this permission
Chris@0 428 roles = memberships.collect {|m| m.roles}.flatten.uniq
Chris@441 429 roles << (self.logged? ? Role.non_member : Role.anonymous)
Chris@441 430 roles.detect {|role|
Chris@441 431 role.allowed_to?(action) &&
Chris@441 432 (block_given? ? yield(role, self) : true)
Chris@441 433 }
Chris@0 434 else
Chris@0 435 false
Chris@0 436 end
Chris@0 437 end
chris@22 438
chris@22 439 # Is the user allowed to do the specified action on any project?
chris@22 440 # See allowed_to? for the actions and valid options.
Chris@441 441 def allowed_to_globally?(action, options, &block)
Chris@441 442 allowed_to?(action, nil, options.reverse_merge(:global => true), &block)
chris@22 443 end
Chris@119 444
Chris@119 445 safe_attributes 'login',
Chris@119 446 'firstname',
Chris@119 447 'lastname',
Chris@119 448 'mail',
Chris@119 449 'mail_notification',
Chris@119 450 'language',
Chris@119 451 'custom_field_values',
Chris@119 452 'custom_fields',
Chris@119 453 'identity_url'
Chris@119 454
Chris@119 455 safe_attributes 'status',
Chris@119 456 'auth_source_id',
Chris@119 457 :if => lambda {|user, current_user| current_user.admin?}
Chris@119 458
Chris@119 459 safe_attributes 'group_ids',
Chris@119 460 :if => lambda {|user, current_user| current_user.admin? && !user.new_record?}
Chris@0 461
chris@37 462 # Utility method to help check if a user should be notified about an
chris@37 463 # event.
chris@37 464 #
chris@37 465 # TODO: only supports Issue events currently
chris@37 466 def notify_about?(object)
Chris@119 467 case mail_notification
Chris@119 468 when 'all'
chris@37 469 true
Chris@119 470 when 'selected'
Chris@210 471 # user receives notifications for created/assigned issues on unselected projects
Chris@210 472 if object.is_a?(Issue) && (object.author == self || object.assigned_to == self)
Chris@210 473 true
Chris@210 474 else
Chris@210 475 false
Chris@210 476 end
Chris@119 477 when 'none'
chris@37 478 false
Chris@119 479 when 'only_my_events'
chris@37 480 if object.is_a?(Issue) && (object.author == self || object.assigned_to == self)
chris@37 481 true
chris@37 482 else
chris@37 483 false
chris@37 484 end
Chris@119 485 when 'only_assigned'
chris@37 486 if object.is_a?(Issue) && object.assigned_to == self
chris@37 487 true
chris@37 488 else
chris@37 489 false
chris@37 490 end
Chris@119 491 when 'only_owner'
chris@37 492 if object.is_a?(Issue) && object.author == self
chris@37 493 true
chris@37 494 else
chris@37 495 false
chris@37 496 end
chris@37 497 else
chris@37 498 false
chris@37 499 end
chris@37 500 end
chris@37 501
Chris@0 502 def self.current=(user)
Chris@0 503 @current_user = user
Chris@0 504 end
Chris@0 505
Chris@0 506 def self.current
Chris@0 507 @current_user ||= User.anonymous
Chris@0 508 end
Chris@0 509
Chris@0 510 # Returns the anonymous user. If the anonymous user does not exist, it is created. There can be only
Chris@0 511 # one anonymous user per database.
Chris@0 512 def self.anonymous
Chris@0 513 anonymous_user = AnonymousUser.find(:first)
Chris@0 514 if anonymous_user.nil?
Chris@0 515 anonymous_user = AnonymousUser.create(:lastname => 'Anonymous', :firstname => '', :mail => '', :login => '', :status => 0)
Chris@0 516 raise 'Unable to create the anonymous user.' if anonymous_user.new_record?
Chris@0 517 end
Chris@0 518 anonymous_user
Chris@0 519 end
Chris@245 520
Chris@245 521 # Salts all existing unsalted passwords
Chris@245 522 # It changes password storage scheme from SHA1(password) to SHA1(salt + SHA1(password))
Chris@245 523 # This method is used in the SaltPasswords migration and is to be kept as is
Chris@245 524 def self.salt_unsalted_passwords!
Chris@245 525 transaction do
Chris@245 526 User.find_each(:conditions => "salt IS NULL OR salt = ''") do |user|
Chris@245 527 next if user.hashed_password.blank?
Chris@245 528 salt = User.generate_salt
Chris@245 529 hashed_password = User.hash_password("#{salt}#{user.hashed_password}")
Chris@245 530 User.update_all("salt = '#{salt}', hashed_password = '#{hashed_password}'", ["id = ?", user.id] )
Chris@245 531 end
Chris@245 532 end
Chris@245 533 end
Chris@0 534
Chris@0 535 protected
Chris@0 536
Chris@0 537 def validate
Chris@0 538 # Password length validation based on setting
Chris@0 539 if !password.nil? && password.size < Setting.password_min_length.to_i
Chris@0 540 errors.add(:password, :too_short, :count => Setting.password_min_length.to_i)
Chris@0 541 end
Chris@0 542 end
Chris@0 543
Chris@0 544 private
Chris@128 545
Chris@128 546 # Removes references that are not handled by associations
Chris@128 547 # Things that are not deleted are reassociated with the anonymous user
Chris@128 548 def remove_references_before_destroy
Chris@128 549 return if self.id.nil?
Chris@128 550
Chris@128 551 substitute = User.anonymous
Chris@128 552 Attachment.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@128 553 Comment.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@128 554 Issue.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@128 555 Issue.update_all 'assigned_to_id = NULL', ['assigned_to_id = ?', id]
Chris@128 556 Journal.update_all ['user_id = ?', substitute.id], ['user_id = ?', id]
Chris@128 557 JournalDetail.update_all ['old_value = ?', substitute.id.to_s], ["property = 'attr' AND prop_key = 'assigned_to_id' AND old_value = ?", id.to_s]
Chris@128 558 JournalDetail.update_all ['value = ?', substitute.id.to_s], ["property = 'attr' AND prop_key = 'assigned_to_id' AND value = ?", id.to_s]
Chris@128 559 Message.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@128 560 News.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@128 561 # Remove private queries and keep public ones
Chris@128 562 Query.delete_all ['user_id = ? AND is_public = ?', id, false]
Chris@128 563 Query.update_all ['user_id = ?', substitute.id], ['user_id = ?', id]
Chris@128 564 TimeEntry.update_all ['user_id = ?', substitute.id], ['user_id = ?', id]
Chris@128 565 Token.delete_all ['user_id = ?', id]
Chris@128 566 Watcher.delete_all ['user_id = ?', id]
Chris@128 567 WikiContent.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@128 568 WikiContent::Version.update_all ['author_id = ?', substitute.id], ['author_id = ?', id]
Chris@128 569 end
Chris@0 570
Chris@0 571 # Return password digest
Chris@0 572 def self.hash_password(clear_password)
Chris@0 573 Digest::SHA1.hexdigest(clear_password || "")
Chris@0 574 end
Chris@245 575
Chris@245 576 # Returns a 128bits random salt as a hex string (32 chars long)
Chris@245 577 def self.generate_salt
Chris@245 578 ActiveSupport::SecureRandom.hex(16)
Chris@245 579 end
Chris@245 580
Chris@0 581 end
Chris@0 582
Chris@0 583 class AnonymousUser < User
Chris@0 584
Chris@0 585 def validate_on_create
Chris@0 586 # There should be only one AnonymousUser in the database
Chris@0 587 errors.add_to_base 'An anonymous user already exists.' if AnonymousUser.find(:first)
Chris@0 588 end
Chris@0 589
Chris@0 590 def available_custom_fields
Chris@0 591 []
Chris@0 592 end
Chris@0 593
Chris@0 594 # Overrides a few properties
Chris@0 595 def logged?; false end
Chris@0 596 def admin; false end
Chris@0 597 def name(*args); I18n.t(:label_user_anonymous) end
Chris@0 598 def mail; nil end
Chris@0 599 def time_zone; nil end
Chris@0 600 def rss_key; nil end
Chris@128 601
Chris@128 602 # Anonymous user can not be destroyed
Chris@128 603 def destroy
Chris@128 604 false
Chris@128 605 end
Chris@0 606 end