annotate app/models/.svn/text-base/user.rb.svn-base @ 904:0a8317a50fa0 redmine-1.1

Close obsolete branch redmine-1.1
author Chris Cannam
date Fri, 14 Jan 2011 12:53:21 +0000
parents af80e5618e9b
children cd2282d2aa55
rev   line source
Chris@0 1 # Redmine - project management software
Chris@0 2 # Copyright (C) 2006-2009 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@117 21 include Redmine::SafeAttributes
Chris@117 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@117 38 ['all', :label_user_mail_option_all],
Chris@117 39 ['selected', :label_user_mail_option_selected],
Chris@117 40 ['only_my_events', :label_user_mail_option_only_my_events],
Chris@117 41 ['only_assigned', :label_user_mail_option_only_assigned],
Chris@117 42 ['only_owner', :label_user_mail_option_only_owner],
Chris@117 43 ['none', :label_user_mail_option_none]
Chris@117 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@0 51 has_one :rss_token, :dependent => :destroy, :class_name => 'Token', :conditions => "action='feeds'"
Chris@0 52 has_one :api_token, :dependent => :destroy, :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@117 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_format_of :firstname, :lastname, :with => /^[\w\s\'\-\.]*$/i
Chris@0 72 validates_length_of :firstname, :lastname, :maximum => 30
Chris@0 73 validates_format_of :mail, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :allow_nil => true
Chris@0 74 validates_length_of :mail, :maximum => 60, :allow_nil => true
Chris@0 75 validates_confirmation_of :password, :allow_nil => true
Chris@117 76 validates_inclusion_of :mail_notification, :in => MAIL_NOTIFICATION_OPTIONS.collect(&:first), :allow_blank => true
Chris@0 77
Chris@0 78 def before_create
chris@37 79 self.mail_notification = Setting.default_notification_option if self.mail_notification.blank?
Chris@0 80 true
Chris@0 81 end
Chris@0 82
Chris@0 83 def before_save
Chris@0 84 # update hashed_password if password was set
Chris@0 85 self.hashed_password = User.hash_password(self.password) if self.password && self.auth_source_id.blank?
Chris@0 86 end
Chris@0 87
Chris@0 88 def reload(*args)
Chris@0 89 @name = nil
Chris@0 90 super
Chris@0 91 end
Chris@0 92
Chris@1 93 def mail=(arg)
Chris@1 94 write_attribute(:mail, arg.to_s.strip)
Chris@1 95 end
Chris@1 96
Chris@0 97 def identity_url=(url)
Chris@0 98 if url.blank?
Chris@0 99 write_attribute(:identity_url, '')
Chris@0 100 else
Chris@0 101 begin
Chris@0 102 write_attribute(:identity_url, OpenIdAuthentication.normalize_identifier(url))
Chris@0 103 rescue OpenIdAuthentication::InvalidOpenId
Chris@0 104 # Invlaid url, don't save
Chris@0 105 end
Chris@0 106 end
Chris@0 107 self.read_attribute(:identity_url)
Chris@0 108 end
Chris@0 109
Chris@0 110 # Returns the user that matches provided login and password, or nil
Chris@0 111 def self.try_to_login(login, password)
Chris@0 112 # Make sure no one can sign in with an empty password
Chris@0 113 return nil if password.to_s.empty?
Chris@0 114 user = find_by_login(login)
Chris@0 115 if user
Chris@0 116 # user is already in local database
Chris@0 117 return nil if !user.active?
Chris@0 118 if user.auth_source
Chris@0 119 # user has an external authentication method
Chris@0 120 return nil unless user.auth_source.authenticate(login, password)
Chris@0 121 else
Chris@0 122 # authentication with local password
Chris@0 123 return nil unless User.hash_password(password) == user.hashed_password
Chris@0 124 end
Chris@0 125 else
Chris@0 126 # user is not yet registered, try to authenticate with available sources
Chris@0 127 attrs = AuthSource.authenticate(login, password)
Chris@0 128 if attrs
Chris@0 129 user = new(attrs)
Chris@0 130 user.login = login
Chris@0 131 user.language = Setting.default_language
Chris@0 132 if user.save
Chris@0 133 user.reload
Chris@0 134 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 135 end
Chris@0 136 end
Chris@0 137 end
Chris@0 138 user.update_attribute(:last_login_on, Time.now) if user && !user.new_record?
Chris@0 139 user
Chris@0 140 rescue => text
Chris@0 141 raise text
Chris@0 142 end
Chris@0 143
Chris@0 144 # Returns the user who matches the given autologin +key+ or nil
Chris@0 145 def self.try_to_autologin(key)
Chris@0 146 tokens = Token.find_all_by_action_and_value('autologin', key)
Chris@0 147 # Make sure there's only 1 token that matches the key
Chris@0 148 if tokens.size == 1
Chris@0 149 token = tokens.first
Chris@0 150 if (token.created_on > Setting.autologin.to_i.day.ago) && token.user && token.user.active?
Chris@0 151 token.user.update_attribute(:last_login_on, Time.now)
Chris@0 152 token.user
Chris@0 153 end
Chris@0 154 end
Chris@0 155 end
Chris@0 156
Chris@0 157 # Return user's full name for display
Chris@0 158 def name(formatter = nil)
Chris@0 159 if formatter
Chris@0 160 eval('"' + (USER_FORMATS[formatter] || USER_FORMATS[:firstname_lastname]) + '"')
Chris@0 161 else
Chris@0 162 @name ||= eval('"' + (USER_FORMATS[Setting.user_format] || USER_FORMATS[:firstname_lastname]) + '"')
Chris@0 163 end
Chris@0 164 end
Chris@0 165
Chris@0 166 def active?
Chris@0 167 self.status == STATUS_ACTIVE
Chris@0 168 end
Chris@0 169
Chris@0 170 def registered?
Chris@0 171 self.status == STATUS_REGISTERED
Chris@0 172 end
Chris@0 173
Chris@0 174 def locked?
Chris@0 175 self.status == STATUS_LOCKED
Chris@0 176 end
Chris@0 177
Chris@14 178 def activate
Chris@14 179 self.status = STATUS_ACTIVE
Chris@14 180 end
Chris@14 181
Chris@14 182 def register
Chris@14 183 self.status = STATUS_REGISTERED
Chris@14 184 end
Chris@14 185
Chris@14 186 def lock
Chris@14 187 self.status = STATUS_LOCKED
Chris@14 188 end
Chris@14 189
Chris@14 190 def activate!
Chris@14 191 update_attribute(:status, STATUS_ACTIVE)
Chris@14 192 end
Chris@14 193
Chris@14 194 def register!
Chris@14 195 update_attribute(:status, STATUS_REGISTERED)
Chris@14 196 end
Chris@14 197
Chris@14 198 def lock!
Chris@14 199 update_attribute(:status, STATUS_LOCKED)
Chris@14 200 end
Chris@14 201
Chris@0 202 def check_password?(clear_password)
Chris@0 203 if auth_source_id.present?
Chris@0 204 auth_source.authenticate(self.login, clear_password)
Chris@0 205 else
Chris@0 206 User.hash_password(clear_password) == self.hashed_password
Chris@0 207 end
Chris@0 208 end
Chris@0 209
Chris@0 210 # Does the backend storage allow this user to change their password?
Chris@0 211 def change_password_allowed?
Chris@0 212 return true if auth_source_id.blank?
Chris@0 213 return auth_source.allow_password_changes?
Chris@0 214 end
Chris@0 215
Chris@0 216 # Generate and set a random password. Useful for automated user creation
Chris@0 217 # Based on Token#generate_token_value
Chris@0 218 #
Chris@0 219 def random_password
Chris@0 220 chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
Chris@0 221 password = ''
Chris@0 222 40.times { |i| password << chars[rand(chars.size-1)] }
Chris@0 223 self.password = password
Chris@0 224 self.password_confirmation = password
Chris@0 225 self
Chris@0 226 end
Chris@0 227
Chris@0 228 def pref
Chris@0 229 self.preference ||= UserPreference.new(:user => self)
Chris@0 230 end
Chris@0 231
Chris@0 232 def time_zone
Chris@0 233 @time_zone ||= (self.pref.time_zone.blank? ? nil : ActiveSupport::TimeZone[self.pref.time_zone])
Chris@0 234 end
Chris@0 235
Chris@0 236 def wants_comments_in_reverse_order?
Chris@0 237 self.pref[:comments_sorting] == 'desc'
Chris@0 238 end
Chris@0 239
Chris@0 240 # Return user's RSS key (a 40 chars long string), used to access feeds
Chris@0 241 def rss_key
Chris@0 242 token = self.rss_token || Token.create(:user => self, :action => 'feeds')
Chris@0 243 token.value
Chris@0 244 end
Chris@0 245
Chris@0 246 # Return user's API key (a 40 chars long string), used to access the API
Chris@0 247 def api_key
Chris@0 248 token = self.api_token || self.create_api_token(:action => 'api')
Chris@0 249 token.value
Chris@0 250 end
Chris@0 251
Chris@0 252 # Return an array of project ids for which the user has explicitly turned mail notifications on
Chris@0 253 def notified_projects_ids
Chris@0 254 @notified_projects_ids ||= memberships.select {|m| m.mail_notification?}.collect(&:project_id)
Chris@0 255 end
Chris@0 256
Chris@0 257 def notified_project_ids=(ids)
Chris@0 258 Member.update_all("mail_notification = #{connection.quoted_false}", ['user_id = ?', id])
Chris@0 259 Member.update_all("mail_notification = #{connection.quoted_true}", ['user_id = ? AND project_id IN (?)', id, ids]) if ids && !ids.empty?
Chris@0 260 @notified_projects_ids = nil
Chris@0 261 notified_projects_ids
Chris@0 262 end
Chris@0 263
chris@37 264 # Only users that belong to more than 1 project can select projects for which they are notified
chris@37 265 def valid_notification_options
chris@37 266 # Note that @user.membership.size would fail since AR ignores
chris@37 267 # :include association option when doing a count
chris@37 268 if memberships.length < 1
Chris@117 269 MAIL_NOTIFICATION_OPTIONS.delete_if {|option| option.first == 'selected'}
chris@37 270 else
chris@37 271 MAIL_NOTIFICATION_OPTIONS
chris@37 272 end
chris@37 273 end
chris@37 274
Chris@0 275 # Find a user account by matching the exact login and then a case-insensitive
Chris@0 276 # version. Exact matches will be given priority.
Chris@0 277 def self.find_by_login(login)
Chris@0 278 # force string comparison to be case sensitive on MySQL
Chris@0 279 type_cast = (ActiveRecord::Base.connection.adapter_name == 'MySQL') ? 'BINARY' : ''
Chris@0 280
Chris@0 281 # First look for an exact match
Chris@0 282 user = first(:conditions => ["#{type_cast} login = ?", login])
Chris@0 283 # Fail over to case-insensitive if none was found
Chris@0 284 user ||= first(:conditions => ["#{type_cast} LOWER(login) = ?", login.to_s.downcase])
Chris@0 285 end
Chris@0 286
Chris@0 287 def self.find_by_rss_key(key)
Chris@0 288 token = Token.find_by_value(key)
Chris@0 289 token && token.user.active? ? token.user : nil
Chris@0 290 end
Chris@0 291
Chris@0 292 def self.find_by_api_key(key)
Chris@0 293 token = Token.find_by_action_and_value('api', key)
Chris@0 294 token && token.user.active? ? token.user : nil
Chris@0 295 end
Chris@0 296
Chris@0 297 # Makes find_by_mail case-insensitive
Chris@0 298 def self.find_by_mail(mail)
Chris@0 299 find(:first, :conditions => ["LOWER(mail) = ?", mail.to_s.downcase])
Chris@0 300 end
Chris@0 301
Chris@0 302 def to_s
Chris@0 303 name
Chris@0 304 end
Chris@0 305
Chris@0 306 # Returns the current day according to user's time zone
Chris@0 307 def today
Chris@0 308 if time_zone.nil?
Chris@0 309 Date.today
Chris@0 310 else
Chris@0 311 Time.now.in_time_zone(time_zone).to_date
Chris@0 312 end
Chris@0 313 end
Chris@0 314
Chris@0 315 def logged?
Chris@0 316 true
Chris@0 317 end
Chris@0 318
Chris@0 319 def anonymous?
Chris@0 320 !logged?
Chris@0 321 end
Chris@0 322
Chris@0 323 # Return user's roles for project
Chris@0 324 def roles_for_project(project)
Chris@0 325 roles = []
Chris@0 326 # No role on archived projects
Chris@0 327 return roles unless project && project.active?
Chris@0 328 if logged?
Chris@0 329 # Find project membership
Chris@0 330 membership = memberships.detect {|m| m.project_id == project.id}
Chris@0 331 if membership
Chris@0 332 roles = membership.roles
Chris@0 333 else
Chris@0 334 @role_non_member ||= Role.non_member
Chris@0 335 roles << @role_non_member
Chris@0 336 end
Chris@0 337 else
Chris@0 338 @role_anonymous ||= Role.anonymous
Chris@0 339 roles << @role_anonymous
Chris@0 340 end
Chris@0 341 roles
Chris@0 342 end
Chris@0 343
Chris@0 344 # Return true if the user is a member of project
Chris@0 345 def member_of?(project)
Chris@0 346 !roles_for_project(project).detect {|role| role.member?}.nil?
Chris@0 347 end
Chris@0 348
chris@37 349 # Return true if the user is allowed to do the specified action on a specific context
chris@37 350 # Action can be:
Chris@0 351 # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')
Chris@0 352 # * a permission Symbol (eg. :edit_project)
chris@37 353 # Context can be:
chris@37 354 # * a project : returns true if user is allowed to do the specified action on this project
chris@37 355 # * a group of projects : returns true if user is allowed on every project
chris@37 356 # * nil with options[:global] set : check if user has at least one role allowed for this action,
chris@37 357 # or falls back to Non Member / Anonymous permissions depending if the user is logged
chris@37 358 def allowed_to?(action, context, options={})
chris@37 359 if context && context.is_a?(Project)
Chris@0 360 # No action allowed on archived projects
chris@37 361 return false unless context.active?
Chris@0 362 # No action allowed on disabled modules
chris@37 363 return false unless context.allows_to?(action)
Chris@0 364 # Admin users are authorized for anything else
Chris@0 365 return true if admin?
Chris@0 366
chris@37 367 roles = roles_for_project(context)
Chris@0 368 return false unless roles
chris@37 369 roles.detect {|role| (context.is_public? || role.member?) && role.allowed_to?(action)}
Chris@0 370
chris@37 371 elsif context && context.is_a?(Array)
chris@37 372 # Authorize if user is authorized on every element of the array
chris@37 373 context.map do |project|
chris@37 374 allowed_to?(action,project,options)
chris@37 375 end.inject do |memo,allowed|
chris@37 376 memo && allowed
chris@37 377 end
Chris@0 378 elsif options[:global]
Chris@0 379 # Admin users are always authorized
Chris@0 380 return true if admin?
Chris@0 381
Chris@0 382 # authorize if user has at least one role that has this permission
Chris@0 383 roles = memberships.collect {|m| m.roles}.flatten.uniq
Chris@0 384 roles.detect {|r| r.allowed_to?(action)} || (self.logged? ? Role.non_member.allowed_to?(action) : Role.anonymous.allowed_to?(action))
Chris@0 385 else
Chris@0 386 false
Chris@0 387 end
Chris@0 388 end
chris@22 389
chris@22 390 # Is the user allowed to do the specified action on any project?
chris@22 391 # See allowed_to? for the actions and valid options.
chris@22 392 def allowed_to_globally?(action, options)
chris@22 393 allowed_to?(action, nil, options.reverse_merge(:global => true))
chris@22 394 end
Chris@117 395
Chris@117 396 safe_attributes 'login',
Chris@117 397 'firstname',
Chris@117 398 'lastname',
Chris@117 399 'mail',
Chris@117 400 'mail_notification',
Chris@117 401 'language',
Chris@117 402 'custom_field_values',
Chris@117 403 'custom_fields',
Chris@117 404 'identity_url'
Chris@117 405
Chris@117 406 safe_attributes 'status',
Chris@117 407 'auth_source_id',
Chris@117 408 :if => lambda {|user, current_user| current_user.admin?}
Chris@117 409
Chris@117 410 safe_attributes 'group_ids',
Chris@117 411 :if => lambda {|user, current_user| current_user.admin? && !user.new_record?}
Chris@0 412
chris@37 413 # Utility method to help check if a user should be notified about an
chris@37 414 # event.
chris@37 415 #
chris@37 416 # TODO: only supports Issue events currently
chris@37 417 def notify_about?(object)
Chris@117 418 case mail_notification
Chris@117 419 when 'all'
chris@37 420 true
Chris@117 421 when 'selected'
chris@37 422 # Handled by the Project
Chris@117 423 when 'none'
chris@37 424 false
Chris@117 425 when 'only_my_events'
chris@37 426 if object.is_a?(Issue) && (object.author == self || object.assigned_to == self)
chris@37 427 true
chris@37 428 else
chris@37 429 false
chris@37 430 end
Chris@117 431 when 'only_assigned'
chris@37 432 if object.is_a?(Issue) && object.assigned_to == self
chris@37 433 true
chris@37 434 else
chris@37 435 false
chris@37 436 end
Chris@117 437 when 'only_owner'
chris@37 438 if object.is_a?(Issue) && object.author == self
chris@37 439 true
chris@37 440 else
chris@37 441 false
chris@37 442 end
chris@37 443 else
chris@37 444 false
chris@37 445 end
chris@37 446 end
chris@37 447
Chris@0 448 def self.current=(user)
Chris@0 449 @current_user = user
Chris@0 450 end
Chris@0 451
Chris@0 452 def self.current
Chris@0 453 @current_user ||= User.anonymous
Chris@0 454 end
Chris@0 455
Chris@0 456 # Returns the anonymous user. If the anonymous user does not exist, it is created. There can be only
Chris@0 457 # one anonymous user per database.
Chris@0 458 def self.anonymous
Chris@0 459 anonymous_user = AnonymousUser.find(:first)
Chris@0 460 if anonymous_user.nil?
Chris@0 461 anonymous_user = AnonymousUser.create(:lastname => 'Anonymous', :firstname => '', :mail => '', :login => '', :status => 0)
Chris@0 462 raise 'Unable to create the anonymous user.' if anonymous_user.new_record?
Chris@0 463 end
Chris@0 464 anonymous_user
Chris@0 465 end
Chris@0 466
Chris@0 467 protected
Chris@0 468
Chris@0 469 def validate
Chris@0 470 # Password length validation based on setting
Chris@0 471 if !password.nil? && password.size < Setting.password_min_length.to_i
Chris@0 472 errors.add(:password, :too_short, :count => Setting.password_min_length.to_i)
Chris@0 473 end
Chris@0 474 end
Chris@0 475
Chris@0 476 private
Chris@0 477
Chris@0 478 # Return password digest
Chris@0 479 def self.hash_password(clear_password)
Chris@0 480 Digest::SHA1.hexdigest(clear_password || "")
Chris@0 481 end
Chris@0 482 end
Chris@0 483
Chris@0 484 class AnonymousUser < User
Chris@0 485
Chris@0 486 def validate_on_create
Chris@0 487 # There should be only one AnonymousUser in the database
Chris@0 488 errors.add_to_base 'An anonymous user already exists.' if AnonymousUser.find(:first)
Chris@0 489 end
Chris@0 490
Chris@0 491 def available_custom_fields
Chris@0 492 []
Chris@0 493 end
Chris@0 494
Chris@0 495 # Overrides a few properties
Chris@0 496 def logged?; false end
Chris@0 497 def admin; false end
Chris@0 498 def name(*args); I18n.t(:label_user_anonymous) end
Chris@0 499 def mail; nil end
Chris@0 500 def time_zone; nil end
Chris@0 501 def rss_key; nil end
Chris@0 502 end