Class: User

Inherits:
Principal show all
Includes:
Redmine::SafeAttributes
Defined in:
app/models/user.rb

Direct Known Subclasses

AnonymousUser

Constant Summary

USER_FORMATS =

Different ways of displaying/sorting users

{
  :firstname_lastname => {
      :string => '#{firstname} #{lastname}',
      :order => %w(firstname lastname id),
      :setting_order => 1
    },
  :firstname_lastinitial => {
      :string => '#{firstname} #{lastname.to_s.chars.first}.',
      :order => %w(firstname lastname id),
      :setting_order => 2
    },
  :firstinitial_lastname => {
      :string => '#{firstname.to_s.gsub(/(([[:alpha:]])[[:alpha:]]*\.?)/, \'\2.\')} #{lastname}',
      :order => %w(firstname lastname id),
      :setting_order => 2
    },
  :firstname => {
      :string => '#{firstname}',
      :order => %w(firstname id),
      :setting_order => 3
    },
  :lastname_firstname => {
      :string => '#{lastname} #{firstname}',
      :order => %w(lastname firstname id),
      :setting_order => 4
    },
  :lastnamefirstname => {
      :string => '#{lastname}#{firstname}',
      :order => %w(lastname firstname id),
      :setting_order => 5
    },
  :lastname_comma_firstname => {
      :string => '#{lastname}, #{firstname}',
      :order => %w(lastname firstname id),
      :setting_order => 6
    },
  :lastname => {
      :string => '#{lastname}',
      :order => %w(lastname id),
      :setting_order => 7
    },
  :username => {
      :string => '#{login}',
      :order => %w(login id),
      :setting_order => 8
    },
}
MAIL_NOTIFICATION_OPTIONS = 
[
  ['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]
]
LOGIN_LENGTH_LIMIT = 
60
MAIL_LENGTH_LIMIT = 
60
CSS_CLASS_BY_STATUS = 
{
  STATUS_ANONYMOUS  => 'anon',
  STATUS_ACTIVE     => 'active',
  STATUS_REGISTERED => 'registered',
  STATUS_LOCKED     => 'locked'
}

Constants inherited from Principal

Principal::STATUS_ACTIVE, Principal::STATUS_ANONYMOUS, Principal::STATUS_LOCKED, Principal::STATUS_REGISTERED

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::SafeAttributes

#delete_unsafe_attributes, included, #safe_attribute?, #safe_attribute_names, #safe_attributes=

Methods inherited from Principal

#<=>, detect_by_keyword, #member_of?, #project_ids, #visible?

Instance Attribute Details

#generate_password ⇒ Object

Returns the value of attribute generate_password



98
99
100
 
# File 'app/models/user.rb', line 98

def generate_password
  @generate_password
end

#last_before_login_on ⇒ Object

Returns the value of attribute last_before_login_on



99
100
101
 
# File 'app/models/user.rb', line 99

def 
  @last_before_login_on
end

#password ⇒ Object

Returns the value of attribute password



98
99
100
 
# File 'app/models/user.rb', line 98

def password
  @password
end

#password_confirmation ⇒ Object

Returns the value of attribute password_confirmation



98
99
100
 
# File 'app/models/user.rb', line 98

def password_confirmation
  @password_confirmation
end

#remote_ip ⇒ Object

Returns the value of attribute remote_ip



100
101
102
 
# File 'app/models/user.rb', line 100

def remote_ip
  @remote_ip
end

Class Method Details

.anonymous ⇒ Object

Returns the anonymous user. If the anonymous user does not exist, it is created. There can be only one anonymous user per database.



771
772
773
774
775
776
777
778
 
# File 'app/models/user.rb', line 771

def self.anonymous
  anonymous_user = AnonymousUser.unscoped.first
  if anonymous_user.nil?
    anonymous_user = AnonymousUser.unscoped.create(:lastname => 'Anonymous', :firstname => '', :login => '', :status => 0)
    raise 'Unable to create the anonymous user.' if anonymous_user.new_record?
  end
  anonymous_user
end

.current ⇒ Object 



765
766
767
 
# File 'app/models/user.rb', line 765

def self.current
  RequestStore.store[:current_user] ||= User.anonymous
end

.current=(user) ⇒ Object 



761
762
763
 
# File 'app/models/user.rb', line 761

def self.current=(user)
  RequestStore.store[:current_user] = user
end

.default_admin_account_changed? ⇒ Boolean

Returns true if the default admin account can no longer be used

Returns:

  • (Boolean) 


493
494
495
 
# File 'app/models/user.rb', line 493

def self.
  !User.active.("admin").try(:check_password?, "admin")
end

.fields_for_order_statement(table = nil) ⇒ Object

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']


265
266
267
268
 
# File 'app/models/user.rb', line 265

def self.fields_for_order_statement(table=nil)
  table ||= table_name
  name_formatter[:order].map {|field| "#{table}.#{field}"}
end

.find_by_api_key(key) ⇒ Object 



483
484
485
 
# File 'app/models/user.rb', line 483

def self.find_by_api_key(key)
  Token.find_active_user('api', key)
end

.find_by_login(login) ⇒ Object

Find a user account by matching the exact login and then a case-insensitive version. Exact matches will be given priority.



466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'app/models/user.rb', line 466

def self.()
   = Redmine::CodesetUtil.replace_invalid_utf8(.to_s)
  if .present?
    # First look for an exact match
    user = where(:login => ).detect {|u| u. == }
    unless user
      # Fail over to case-insensitive if none was found
      user = where("LOWER(login) = ?", .downcase).first
    end
    user
  end
end

.find_by_mail(mail) ⇒ Object

Makes find_by_mail case-insensitive



488
489
490
 
# File 'app/models/user.rb', line 488

def self.find_by_mail(mail)
  having_mail(mail).first
end

.find_by_rss_key(key) ⇒ Object 



479
480
481
 
# File 'app/models/user.rb', line 479

def self.find_by_rss_key(key)
  Token.find_active_user('feeds', key)
end

.find_or_initialize_by_identity_url(url) ⇒ Object 



193
194
195
196
197
198
199
200
 
# File 'app/models/user.rb', line 193

def self.find_or_initialize_by_identity_url(url)
  user = where(:identity_url => url).first
  unless user
    user = User.new
    user.identity_url = url
  end
  user
end

.name_formatter(formatter = nil) ⇒ Object 



255
256
257
 
# File 'app/models/user.rb', line 255

def self.name_formatter(formatter = nil)
  USER_FORMATS[formatter || Setting.user_format] || USER_FORMATS[:firstname_lastname]
end

.salt_unsalted_passwords! ⇒ Object

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



783
784
785
786
787
788
789
790
791
792
 
# File 'app/models/user.rb', line 783

def self.salt_unsalted_passwords!
  transaction do
    User.where("salt IS NULL OR salt = ''").find_each do |user|
      next if user.hashed_password.blank?
      salt = User.generate_salt
      hashed_password = User.hash_password("#{salt}#{user.hashed_password}")
      User.where(:id => user.id).update_all(:salt => salt, :hashed_password => hashed_password)
    end
  end
end

.try_to_autologin(key) ⇒ Object

Returns the user who matches the given autologin key or nil



247
248
249
250
251
252
253
 
# File 'app/models/user.rb', line 247

def self.try_to_autologin(key)
  user = Token.find_active_user('autologin', key, Setting.autologin.to_i)
  if user
    user.update_column(:last_login_on, Time.now)
    user
  end
end

.try_to_login(login, password, active_only = true) ⇒ Object

Returns the user that matches provided login and password, or nil



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'app/models/user.rb', line 216

def self.(, password, active_only=true)
   = .to_s
  password = password.to_s

  # Make sure no one can sign in with an empty login or password
  return nil if .empty? || password.empty?
  user = ()
  if user
    # user is already in local database
    return nil unless user.check_password?(password)
    return nil if !user.active? && active_only
  else
    # user is not yet registered, try to authenticate with available sources
    attrs = AuthSource.authenticate(, password)
    if attrs
      user = new(attrs)
      user. = 
      user.language = Setting.default_language
      if user.save
        user.reload
        logger.info("User '#{user.}' created from external auth source: #{user.auth_source.type} - #{user.auth_source.name}") if logger && user.auth_source
      end
    end
  end
  user.update_column(:last_login_on, Time.now) if user && !user.new_record? && user.active?
  user
rescue => text
  raise text
end

.valid_notification_options(user = nil) ⇒ Object

Only users that belong to more than 1 project can select projects for which they are notified



454
455
456
457
458
459
460
461
462
 
# File 'app/models/user.rb', line 454

def self.valid_notification_options(user=nil)
  # Note that @user.membership.size would fail since AR ignores
  # :include association option when doing a count
  if user.nil? || user.memberships.length < 1
    MAIL_NOTIFICATION_OPTIONS.reject {|option| option.first == 'selected'}
  else
    MAIL_NOTIFICATION_OPTIONS
  end
end

.verify_session_token(user_id, token) ⇒ Object

Returns true if token is a valid session token for the user whose id is user_id



416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'app/models/user.rb', line 416

def self.verify_session_token(user_id, token)
  return false if user_id.blank? || token.blank?

  scope = Token.where(:user_id => user_id, :value => token.to_s, :action => 'session')
  if Setting.session_lifetime?
    scope = scope.where("created_on > ?", Setting.session_lifetime.to_i.minutes.ago)
  end
  if Setting.session_timeout?
    scope = scope.where("updated_on > ?", Setting.session_timeout.to_i.minutes.ago)
  end
  scope.update_all(:updated_on => Time.now) == 1
end

Instance Method Details

#activate ⇒ Object 



292
293
294
 
# File 'app/models/user.rb', line 292

def activate
  self.status = STATUS_ACTIVE
end

#activate! ⇒ Object 



304
305
306
 
# File 'app/models/user.rb', line 304

def activate!
  update_attribute(:status, STATUS_ACTIVE)
end

#active? ⇒ Boolean

Returns:

  • (Boolean) 


280
281
282
 
# File 'app/models/user.rb', line 280

def active?
  self.status == STATUS_ACTIVE
end

#allowed_to?(action, context, options = {}, &block) ⇒ Boolean

Return true if the user is allowed to do the specified action on a specific context Action can be:

  • a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')

  • a permission Symbol (eg. :edit_project)

Context can be:

  • a project : returns true if user is allowed to do the specified action on this project

  • an array of projects : returns true if user is allowed on every project

  • nil with options set : check if user has at least one role allowed for this action, or falls back to Non Member / Anonymous permissions depending if the user is logged

Returns:

  • (Boolean) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'app/models/user.rb', line 649

def allowed_to?(action, context, options={}, &block)
  if context && context.is_a?(Project)
    return false unless context.allows_to?(action)
    # Admin users are authorized for anything else
    return true if admin?

    roles = roles_for_project(context)
    return false unless roles
    roles.any? {|role|
      (context.is_public? || role.member?) &&
      role.allowed_to?(action) &&
      (block_given? ? yield(role, self) : true)
    }
  elsif context && context.is_a?(Array)
    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(:&)
    end
  elsif context
    raise ArgumentError.new("#allowed_to? context argument must be a Project, an Array of projects or nil")
  elsif options[:global]
    # Admin users are always authorized
    return true if admin?

    # authorize if user has at least one role that has this permission
    roles = memberships.collect {|m| m.roles}.flatten.uniq
    roles << (self.logged? ? Role.non_member : Role.anonymous)
    roles.any? {|role|
      role.allowed_to?(action) &&
      (block_given? ? yield(role, self) : true)
    }
  else
    false
  end
end

#allowed_to_globally?(action, options = {}, &block) ⇒ Boolean

Is the user allowed to do the specified action on any project? See allowed_to? for the actions and valid options.

NB: this method is not used anywhere in the core codebase as of 2.5.2, but it's used by many plugins so if we ever want to remove it it has to be carefully deprecated for a version or two.

Returns:

  • (Boolean) 


693
694
695
 
# File 'app/models/user.rb', line 693

def allowed_to_globally?(action, options={}, &block)
  allowed_to?(action, nil, options.reverse_merge(:global => true), &block)
end

#allowed_to_view_all_time_entries?(context) ⇒ Boolean

Returns:

  • (Boolean) 


697
698
699
700
701
 
# File 'app/models/user.rb', line 697

def allowed_to_view_all_time_entries?(context)
  allowed_to?(:view_time_entries, context) do |role, user|
    role.time_entries_visibility == 'all'
  end
end

#anonymous? ⇒ Boolean

Returns:

  • (Boolean) 


534
535
536
 
# File 'app/models/user.rb', line 534

def anonymous?
  !logged?
end

#api_key ⇒ Object

Return user's API key (a 40 chars long string), used to access the API



402
403
404
405
406
407
 
# File 'app/models/user.rb', line 402

def api_key
  if api_token.nil?
    create_api_token(:action => 'api')
  end
  api_token.value
end

#base_reload ⇒ Object 



162
 
# File 'app/models/user.rb', line 162

alias :base_reload :reload

#builtin_role ⇒ Object

Returns the user's bult-in role



550
551
552
 
# File 'app/models/user.rb', line 550

def builtin_role
  @builtin_role ||= Role.non_member
end

#change_password_allowed? ⇒ Boolean

Does the backend storage allow this user to change their password?

Returns:

  • (Boolean) 


334
335
336
337
 
# File 'app/models/user.rb', line 334

def change_password_allowed?
  return true if auth_source.nil?
  return auth_source.allow_password_changes?
end

#check_password?(clear_password) ⇒ Boolean

Returns true if clear_password is the correct user's password, otherwise false

Returns:

  • (Boolean) 


317
318
319
320
321
322
323
 
# File 'app/models/user.rb', line 317

def check_password?(clear_password)
  if auth_source_id.present?
    auth_source.authenticate(self., clear_password)
  else
    User.hash_password("#{salt}#{User.hash_password clear_password}") == hashed_password
  end
end

#css_classes ⇒ Object 



508
509
510
 
# File 'app/models/user.rb', line 508

def css_classes
  "user #{CSS_CLASS_BY_STATUS[status]}"
end

#force_default_language? ⇒ Boolean

Returns:

  • (Boolean) 


377
378
379
 
# File 'app/models/user.rb', line 377

def force_default_language?
  Setting.force_default_language_for_loggedin?
end

#generate_password? ⇒ Boolean

Returns:

  • (Boolean) 


354
355
356
 
# File 'app/models/user.rb', line 354

def generate_password?
  generate_password == '1' || generate_password == true
end

#generate_session_token ⇒ Object

Generates a new session token and returns its value



410
411
412
413
 
# File 'app/models/user.rb', line 410

def generate_session_token
  token = Token.create!(:user_id => id, :action => 'session')
  token.value
end

#identity_url=(url) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'app/models/user.rb', line 202

def identity_url=(url)
  if url.blank?
    write_attribute(:identity_url, '')
  else
    begin
      write_attribute(:identity_url, OpenIdAuthentication.normalize_identifier(url))
    rescue OpenIdAuthentication::InvalidOpenId
      # Invalid url, don't save
    end
  end
  self.read_attribute(:identity_url)
end

#is_or_belongs_to?(arg) ⇒ Boolean

Returns true if user is arg or belongs to arg

Returns:

  • (Boolean) 


630
631
632
633
634
635
636
637
638
 
# File 'app/models/user.rb', line 630

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

#language ⇒ Object 



381
382
383
384
385
386
387
 
# File 'app/models/user.rb', line 381

def language
  if force_default_language?
    Setting.default_language
  else
    super
  end
end

#lock ⇒ Object 



300
301
302
 
# File 'app/models/user.rb', line 300

def lock
  self.status = STATUS_LOCKED
end

#lock! ⇒ Object 



312
313
314
 
# File 'app/models/user.rb', line 312

def lock!
  update_attribute(:status, STATUS_LOCKED)
end

#locked? ⇒ Boolean

Returns:

  • (Boolean) 


288
289
290
 
# File 'app/models/user.rb', line 288

def locked?
  self.status == STATUS_LOCKED
end

#logged? ⇒ Boolean

Returns:

  • (Boolean) 


530
531
532
 
# File 'app/models/user.rb', line 530

def logged?
  true
end

#mail ⇒ Object 



176
177
178
 
# File 'app/models/user.rb', line 176

def mail
  email_address.try(:address)
end

#mail=(arg) ⇒ Object 



180
181
182
183
 
# File 'app/models/user.rb', line 180

def mail=(arg)
  email = email_address || build_email_address
  email.address = arg
end

#mail_changed? ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
 
# File 'app/models/user.rb', line 185

def mail_changed?
  email_address.try(:address_changed?)
end

#mails ⇒ Object 



189
190
191
 
# File 'app/models/user.rb', line 189

def mails
  email_addresses.pluck(:address)
end

#managed_roles(project) ⇒ Object

Returns the roles that the user is allowed to manage for the given project



621
622
623
624
625
626
627
 
# File 'app/models/user.rb', line 621

def managed_roles(project)
  if admin?
    @managed_roles ||= Role.givable.to_a
  else
    membership(project).try(:managed_roles) || []
  end
end

#membership(project) ⇒ Object

Returns user's membership for the given project or nil if the user is not a member of project



540
541
542
543
544
545
546
547
 
# File 'app/models/user.rb', line 540

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

#must_change_password? ⇒ Boolean

Returns:

  • (Boolean) 


350
351
352
 
# File 'app/models/user.rb', line 350

def must_change_password?
  (must_change_passwd? || password_expired?) && change_password_allowed?
end

#name(formatter = nil) ⇒ Object

Return user's full name for display



271
272
273
274
275
276
277
278
 
# File 'app/models/user.rb', line 271

def name(formatter = nil)
  f = self.class.name_formatter(formatter)
  if formatter
    eval('"' + f[:string] + '"')
  else
    @name ||= eval('"' + f[:string] + '"')
  end
end

#notified_project_ids=(ids) ⇒ Object 



434
435
436
437
 
# File 'app/models/user.rb', line 434

def notified_project_ids=(ids)
  @notified_projects_ids_changed = true
  @notified_projects_ids = ids.map(&:to_i).uniq.select {|n| n > 0}
end

#notified_projects_ids ⇒ Object

Return an array of project ids for which the user has explicitly turned mail notifications on



430
431
432
 
# File 'app/models/user.rb', line 430

def notified_projects_ids
  @notified_projects_ids ||= memberships.select {|m| m.mail_notification?}.collect(&:project_id)
end

#notify_about?(object) ⇒ Boolean

Utility method to help check if a user should be notified about an event.

TODO: only supports Issue events currently

Returns:

  • (Boolean) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'app/models/user.rb', line 737

def notify_about?(object)
  if mail_notification == 'all'
    true
  elsif mail_notification.blank? || mail_notification == 'none'
    false
  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'
      true
    end
  end
end

#own_account_deletable? ⇒ Boolean

Returns true if the user is allowed to delete the user's own account

Returns:

  • (Boolean) 


704
705
706
707
 
# File 'app/models/user.rb', line 704

def 
  Setting.unsubscribe? &&
    (!admin? || User.active.where("admin = ? AND id <> ?", true, id).exists?)
end

#password_expired? ⇒ Boolean

Returns true if the user password has expired

Returns:

  • (Boolean) 


340
341
342
343
344
345
346
347
348
 
# File 'app/models/user.rb', line 340

def password_expired?
  period = Setting.password_max_age.to_i
  if period.zero?
    false
  else
    changed_on = self.passwd_changed_on || Time.at(0)
    changed_on < period.days.ago
  end
end

#pref ⇒ Object 



369
370
371
 
# File 'app/models/user.rb', line 369

def pref
  self.preference ||= UserPreference.new(:user => self)
end

#project_ids_by_role ⇒ Object

Returns a hash of project ids grouped by roles. Includes the projects that the user is a member of and the projects that grant custom permissions to the builtin groups.



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'app/models/user.rb', line 582

def project_ids_by_role
  return @project_ids_by_role if @project_ids_by_role

  group_class = anonymous? ? GroupAnonymous : GroupNonMember
  group_id = group_class.pluck(:id).first

  members = Member.joins(:project, :member_roles).
    where("#{Project.table_name}.status <> 9").
    where("#{Member.table_name}.user_id = ? OR (#{Project.table_name}.is_public = ? AND #{Member.table_name}.user_id = ?)", self.id, true, group_id).
    pluck(:user_id, :role_id, :project_id)

  hash = {}
  members.each do |user_id, role_id, project_id|
    # Ignore the roles of the builtin group if the user is a member of the project
    next if user_id != id && project_ids.include?(project_id)

    hash[role_id] ||= []
    hash[role_id] << project_id
  end

  result = Hash.new([])
  if hash.present?
    roles = Role.where(:id => hash.keys).to_a
    hash.each do |role_id, proj_ids|
      role = roles.detect {|r| r.id == role_id}
      if role
        result[role] = proj_ids.uniq
      end
    end
  end
  @project_ids_by_role = result
end

#projects_by_role ⇒ Object

Returns a hash of user's projects grouped by roles TODO: No longer used, should be deprecated



569
570
571
572
573
574
575
576
577
 
# File 'app/models/user.rb', line 569

def projects_by_role
  return @projects_by_role if @projects_by_role

  result = Hash.new([])
  project_ids_by_role.each do |role, ids|
    result[role] = Project.where(:id => ids).to_a
  end
  @projects_by_role = result
end

#random_password(length = 40) ⇒ Object

Generate and set a random password on given length



359
360
361
362
363
364
365
366
367
 
# File 'app/models/user.rb', line 359

def random_password(length=40)
  chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
  chars -= %w(0 O 1 l)
  password = ''
  length.times {|i| password << chars[SecureRandom.random_number(chars.size)] }
  self.password = password
  self.password_confirmation = password
  self
end

#register ⇒ Object 



296
297
298
 
# File 'app/models/user.rb', line 296

def register
  self.status = STATUS_REGISTERED
end

#register! ⇒ Object 



308
309
310
 
# File 'app/models/user.rb', line 308

def register!
  update_attribute(:status, STATUS_REGISTERED)
end

#registered? ⇒ Boolean

Returns:

  • (Boolean) 


284
285
286
 
# File 'app/models/user.rb', line 284

def registered?
  self.status == STATUS_REGISTERED
end

#reload(*args) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'app/models/user.rb', line 163

def reload(*args)
  @name = nil
  @projects_by_role = nil
  @project_ids_by_role = nil
  @membership_by_project_id = nil
  @notified_projects_ids = nil
  @notified_projects_ids_changed = false
  @builtin_role = nil
  @visible_project_ids = nil
  @managed_roles = nil
  base_reload(*args)
end

#roles_for_project(project) ⇒ Object

Return user's roles for project



555
556
557
558
559
560
561
562
563
564
565
 
# File 'app/models/user.rb', line 555

def roles_for_project(project)
  # No role on archived projects
  return [] if project.nil? || project.archived?
  if membership = membership(project)
    membership.roles.to_a
  elsif project.is_public?
    project.override_roles(builtin_role)
  else
    []
  end
end

#rss_key ⇒ Object

Return user's RSS key (a 40 chars long string), used to access feeds



394
395
396
397
398
399
 
# File 'app/models/user.rb', line 394

def rss_key
  if rss_token.nil?
    create_rss_token(:action => 'feeds')
  end
  rss_token.value
end

#salt_password(clear_password) ⇒ Object

Generates a random salt and computes hashed_password for clear_password The hashed password is stored in the following form: SHA1(salt + SHA1(password))



327
328
329
330
331
 
# File 'app/models/user.rb', line 327

def salt_password(clear_password)
  self.salt = User.generate_salt
  self.hashed_password = User.hash_password("#{salt}#{User.hash_password clear_password}")
  self.passwd_changed_on = Time.now.change(:usec => 0)
end

#set_mail_notification ⇒ Object 



150
151
152
153
 
# File 'app/models/user.rb', line 150

def set_mail_notification
  self.mail_notification = Setting.default_notification_option if self.mail_notification.blank?
  true
end

#time_to_date(time) ⇒ Object

Returns the day of time according to user's time zone



522
523
524
525
526
527
528
 
# File 'app/models/user.rb', line 522

def time_to_date(time)
  if time_zone.nil?
    time.to_date
  else
    time.in_time_zone(time_zone).to_date
  end
end

#time_zone ⇒ Object 



373
374
375
 
# File 'app/models/user.rb', line 373

def time_zone
  @time_zone ||= (self.pref.time_zone.blank? ? nil : ActiveSupport::TimeZone[self.pref.time_zone])
end

#to_s ⇒ Object 



497
498
499
 
# File 'app/models/user.rb', line 497

def to_s
  name
end

#today ⇒ Object

Returns the current day according to user's time zone



513
514
515
516
517
518
519
 
# File 'app/models/user.rb', line 513

def today
  if time_zone.nil?
    Date.today
  else
    time_zone.today
  end
end

#update_hashed_password ⇒ Object 



155
156
157
158
159
160
 
# File 'app/models/user.rb', line 155

def update_hashed_password
  # update hashed_password if password was set
  if self.password && self.auth_source_id.blank?
    salt_password(password)
  end
end

#valid_notification_options ⇒ Object 



449
450
451
 
# File 'app/models/user.rb', line 449

def valid_notification_options
  self.class.valid_notification_options(self)
end

#visible_project_ids ⇒ Object

Returns the ids of visible projects



616
617
618
 
# File 'app/models/user.rb', line 616

def visible_project_ids
  @visible_project_ids ||= Project.visible(self).pluck(:id)
end

#wants_comments_in_reverse_order? ⇒ Boolean

Returns:

  • (Boolean) 


389
390
391
 
# File 'app/models/user.rb', line 389

def wants_comments_in_reverse_order?
  self.pref[:comments_sorting] == 'desc'
end