Class: User

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

Direct Known Subclasses

AnonymousUser

Constant Summary collapse

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
LABEL_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?, #nullify_projects_default_assigned_to, #project_ids, #visible?

Instance Attribute Details

#generate_passwordObject

Returns the value of attribute generate_password


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

def generate_password
  @generate_password
end

#last_before_login_onObject

Returns the value of attribute last_before_login_on


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

def 
  @last_before_login_on
end

#passwordObject

Returns the value of attribute password


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

def password
  @password
end

#password_confirmationObject

Returns the value of attribute password_confirmation


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

def password_confirmation
  @password_confirmation
end

#remote_ipObject

Returns the value of attribute remote_ip


102
103
104
# File 'app/models/user.rb', line 102

def remote_ip
  @remote_ip
end

Class Method Details

.anonymousObject

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


832
833
834
835
836
837
838
839
# File 'app/models/user.rb', line 832

def self.anonymous
  anonymous_user = AnonymousUser.unscoped.find_by(:lastname => 'Anonymous')
  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

.currentObject


826
827
828
# File 'app/models/user.rb', line 826

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

.current=(user) ⇒ Object


822
823
824
# File 'app/models/user.rb', line 822

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)

532
533
534
# File 'app/models/user.rb', line 532

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

273
274
275
276
# File 'app/models/user.rb', line 273

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


522
523
524
# File 'app/models/user.rb', line 522

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.


505
506
507
508
509
510
511
512
513
514
515
516
# File 'app/models/user.rb', line 505

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 = find_by("LOWER(login) = ?", .downcase)
    end
    user
  end
end

.find_by_mail(mail) ⇒ Object

Makes find_by_mail case-insensitive


527
528
529
# File 'app/models/user.rb', line 527

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

.find_by_rss_key(key) ⇒ Object


518
519
520
# File 'app/models/user.rb', line 518

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

.find_or_initialize_by_identity_url(url) ⇒ Object


200
201
202
203
204
205
206
207
# File 'app/models/user.rb', line 200

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

.generate_saltObject

Returns a 128bits random salt as a hex string (32 chars long)


935
936
937
# File 'app/models/user.rb', line 935

def generate_salt
  Redmine::Utils.random_hex(16)
end

.hash_password(clear_password) ⇒ Object

Return password digest


930
931
932
# File 'app/models/user.rb', line 930

def hash_password(clear_password)
  Digest::SHA1.hexdigest(clear_password || "")
end

.name_formatter(formatter = nil) ⇒ Object


263
264
265
# File 'app/models/user.rb', line 263

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


844
845
846
847
848
849
850
851
852
853
854
# File 'app/models/user.rb', line 844

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


255
256
257
258
259
260
261
# File 'app/models/user.rb', line 255

def self.try_to_autologin(key)
  user = Token.find_active_user('autologin', key, Setting.autologin.to_i)
  if user
    user.
    user
  end
end

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

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


223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'app/models/user.rb', line 223

def self.(, password, active_only=true)
   = .to_s.strip
  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. 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


493
494
495
496
497
498
499
500
501
# File 'app/models/user.rb', line 493

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


455
456
457
458
459
460
461
462
463
464
465
466
# File 'app/models/user.rb', line 455

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

#activateObject


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

def activate
  self.status = STATUS_ACTIVE
end

#activate!Object


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

def activate!
  update_attribute(:status, STATUS_ACTIVE)
end

#active?Boolean

Returns:

  • (Boolean)

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

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)

705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
# File 'app/models/user.rb', line 705

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? do |role|
      (context.is_public? || role.member?) &&
      role.allowed_to?(action) &&
      (block_given? ? yield(role, self) : true)
    end
  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 = self.roles.to_a | [builtin_role]
    roles.any? do |role|
      role.allowed_to?(action) &&
      (block_given? ? yield(role, self) : true)
    end
  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)

749
750
751
# File 'app/models/user.rb', line 749

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)

753
754
755
756
757
# File 'app/models/user.rb', line 753

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)

577
578
579
# File 'app/models/user.rb', line 577

def anonymous?
  !logged?
end

#api_keyObject

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


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

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

#base_reloadObject


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

alias :base_reload :reload

#bookmarked_project_idsObject


856
857
858
859
860
861
# File 'app/models/user.rb', line 856

def bookmarked_project_ids
  project_ids = []
  bookmarked_project_ids = self.pref[:bookmarked_project_ids]
  project_ids = bookmarked_project_ids.split(',') unless bookmarked_project_ids.nil?
  project_ids.map(&:to_i)
end

#builtin_roleObject

Returns the user's bult-in role


601
602
603
# File 'app/models/user.rb', line 601

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)

348
349
350
# File 'app/models/user.rb', line 348

def change_password_allowed?
  auth_source.nil? ? true : 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)

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

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

#convert_time_to_user_timezone(time) ⇒ Object


565
566
567
568
569
570
571
# File 'app/models/user.rb', line 565

def convert_time_to_user_timezone(time)
  if self.time_zone
    time.in_time_zone(self.time_zone)
  else
    time.utc? ? time.localtime : time
  end
end

#css_classesObject


547
548
549
# File 'app/models/user.rb', line 547

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

#delete_autologin_token(value) ⇒ Object


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

def delete_autologin_token(value)
  Token.where(:user_id => id, :action => 'autologin', :value => value).delete_all
end

#delete_session_token(value) ⇒ Object


440
441
442
# File 'app/models/user.rb', line 440

def delete_session_token(value)
  Token.where(:user_id => id, :action => 'session', :value => value).delete_all
end

#force_default_language?Boolean

Returns:

  • (Boolean)

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

def force_default_language?
  Setting.force_default_language_for_loggedin?
end

#generate_autologin_tokenObject

Generates a new autologin token and returns its value


445
446
447
448
# File 'app/models/user.rb', line 445

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

#generate_password?Boolean

Returns:

  • (Boolean)

367
368
369
# File 'app/models/user.rb', line 367

def generate_password?
  ActiveRecord::Type::Boolean.new.deserialize(generate_password)
end

#generate_session_tokenObject

Generates a new session token and returns its value


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

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

#identity_url=(url) ⇒ Object


209
210
211
212
213
214
215
216
217
218
219
220
# File 'app/models/user.rb', line 209

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)

686
687
688
689
690
691
692
693
694
# File 'app/models/user.rb', line 686

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

#languageObject


406
407
408
409
410
411
412
# File 'app/models/user.rb', line 406

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

#lockObject


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

def lock
  self.status = STATUS_LOCKED
end

#lock!Object


320
321
322
# File 'app/models/user.rb', line 320

def lock!
  update_attribute(:status, STATUS_LOCKED)
end

#locked?Boolean

Returns:

  • (Boolean)

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

def locked?
  self.status == STATUS_LOCKED
end

#logged?Boolean

Returns:

  • (Boolean)

573
574
575
# File 'app/models/user.rb', line 573

def logged?
  true
end

#mailObject


183
184
185
# File 'app/models/user.rb', line 183

def mail
  email_address.try(:address)
end

#mail=(arg) ⇒ Object


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

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

#mail_changed?Boolean

Returns:

  • (Boolean)

192
193
194
# File 'app/models/user.rb', line 192

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

#mailsObject


196
197
198
# File 'app/models/user.rb', line 196

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


677
678
679
680
681
682
683
# File 'app/models/user.rb', line 677

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


583
584
585
586
587
588
589
590
591
# File 'app/models/user.rb', line 583

def membership(project)
  project_id = project.is_a?(Project) ? project.id : project

  @membership_by_project_id ||=
    Hash.new do |h, project_id|
      h[project_id] = memberships.where(:project_id => project_id).first
    end
  @membership_by_project_id[project_id]
end

#must_change_password?Boolean

Returns:

  • (Boolean)

363
364
365
# File 'app/models/user.rb', line 363

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

#name(formatter = nil) ⇒ Object

Return user's full name for display


279
280
281
282
283
284
285
286
# File 'app/models/user.rb', line 279

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


473
474
475
476
# File 'app/models/user.rb', line 473

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_idsObject

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


469
470
471
# File 'app/models/user.rb', line 469

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)

794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'app/models/user.rb', line 794

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.previous_assignee)
      when 'only_assigned'
        is_or_belongs_to?(object.assigned_to) || is_or_belongs_to?(object.previous_assignee)
      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

#notify_about_high_priority_issues?Boolean

Returns:

  • (Boolean)

818
819
820
# File 'app/models/user.rb', line 818

def notify_about_high_priority_issues?
  self.pref.notify_about_high_priority_issues
end

#own_account_deletable?Boolean

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

Returns:

  • (Boolean)

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

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

#password_expired?Boolean

Returns true if the user password has expired

Returns:

  • (Boolean)

353
354
355
356
357
358
359
360
361
# File 'app/models/user.rb', line 353

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

#prefObject


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

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

#project_ids_by_roleObject

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.


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
# File 'app/models/user.rb', line 634

def project_ids_by_role
  # Clear project condition for when called from chained scopes
  # eg. project.children.visible(user)
  Project.unscoped do
    return @project_ids_by_role if @project_ids_by_role

    group_class = anonymous? ? GroupAnonymous.unscoped : GroupNonMember.unscoped
    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
end

#projects_by_roleObject

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


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

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


372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'app/models/user.rb', line 372

def random_password(length=40)
  chars_list = [('A'..'Z').to_a, ('a'..'z').to_a, ('0'..'9').to_a]
  # auto-generated passwords contain special characters only when admins
  # require users to use passwords which contains special characters
  if Setting.password_required_char_classes.include?('special_chars')
    chars_list << ("\x20".."\x7e").to_a.select {|c| c =~ Setting::PASSWORD_CHAR_CLASSES['special_chars']}
  end
  chars_list.each {|v| v.reject! {|c| %(0O1l|'"`*).include?(c)}}

  password = +''
  chars_list.each do |chars|
    password << chars[SecureRandom.random_number(chars.size)]
    length -= 1
  end
  chars = chars_list.flatten
  length.times {password << chars[SecureRandom.random_number(chars.size)]}
  password = password.split('').shuffle(random: SecureRandom).join
  self.password = password
  self.password_confirmation = password
  self
end

#registerObject


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

def register
  self.status = STATUS_REGISTERED
end

#register!Object


316
317
318
# File 'app/models/user.rb', line 316

def register!
  update_attribute(:status, STATUS_REGISTERED)
end

#registered?Boolean

Returns:

  • (Boolean)

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

def registered?
  self.status == STATUS_REGISTERED
end

#reload(*args) ⇒ Object


169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'app/models/user.rb', line 169

def reload(*args)
  @name = nil
  @roles = 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

#rolesObject


593
594
595
596
597
598
# File 'app/models/user.rb', line 593

def roles
  @roles ||=
    Role.joins(members: :project).
      where(["#{Project.table_name}.status <> ?", Project::STATUS_ARCHIVED]).
        where(Member.arel_table[:user_id].eq(id)).distinct
end

#roles_for_project(project) ⇒ Object

Return user's roles for project


606
607
608
609
610
611
612
613
614
615
616
617
# File 'app/models/user.rb', line 606

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_keyObject

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


419
420
421
422
423
424
# File 'app/models/user.rb', line 419

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))


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

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_notificationObject


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

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


561
562
563
# File 'app/models/user.rb', line 561

def time_to_date(time)
  self.convert_time_to_user_timezone(time).to_date
end

#time_zoneObject


398
399
400
# File 'app/models/user.rb', line 398

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

#to_sObject


536
537
538
# File 'app/models/user.rb', line 536

def to_s
  name
end

#todayObject

Returns the current day according to user's time zone


552
553
554
555
556
557
558
# File 'app/models/user.rb', line 552

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

#update_hashed_passwordObject


161
162
163
164
165
166
# File 'app/models/user.rb', line 161

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

#update_last_login_on!Object


324
325
326
327
328
# File 'app/models/user.rb', line 324

def 
  return if .present? &&  >= 1.minute.ago

  update_column(:last_login_on, Time.now)
end

#valid_notification_optionsObject


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

def valid_notification_options
  self.class.valid_notification_options(self)
end

#visible_project_idsObject

Returns the ids of visible projects


672
673
674
# File 'app/models/user.rb', line 672

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

#wants_comments_in_reverse_order?Boolean

Returns:

  • (Boolean)

414
415
416
# File 'app/models/user.rb', line 414

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