Read about our upcoming Code of Conduct on this issue

This instance will be upgraded to Heptapod 0.28.1 on 2022-01-26 at 16:00 UTC+1 (a few minutes of down time)

user.rb 27.2 KB
Newer Older
Steven Thonus's avatar
Steven Thonus committed
1
2
require 'carrierwave/orm/activerecord'

gitlabhq's avatar
gitlabhq committed
3
class User < ActiveRecord::Base
4
  extend Gitlab::ConfigHelper
5
6

  include Gitlab::ConfigHelper
7
  include Gitlab::CurrentSettings
8
9
  include Referable
  include Sortable
10
  include CaseSensitivity
11
12
  include TokenAuthenticatable

13
14
  DEFAULT_NOTIFICATION_LEVEL = :participating

15
  add_authentication_token_field :authentication_token
16

17
  default_value_for :admin, false
18
  default_value_for(:external) { current_application_settings.user_default_external }
19
  default_value_for :can_create_group, gitlab_config.default_can_create_group
20
21
  default_value_for :can_create_team, false
  default_value_for :hide_no_ssh_key, false
22
  default_value_for :hide_no_password, false
23
  default_value_for :theme_id, gitlab_config.default_theme
24

25
  attr_encrypted :otp_secret,
26
    key:       Gitlab::Application.secrets.otp_key_base,
27
    mode:      :per_attribute_iv_and_salt,
28
    insecure_mode: true,
29
30
    algorithm: 'aes-256-cbc'

31
  devise :two_factor_authenticatable,
32
         otp_secret_encryption_key: Gitlab::Application.secrets.otp_key_base
Robert Speicher's avatar
Robert Speicher committed
33

34
  devise :two_factor_backupable, otp_number_of_backup_codes: 10
Robert Speicher's avatar
Robert Speicher committed
35
36
  serialize :otp_backup_codes, JSON

37
  devise :lockable, :recoverable, :rememberable, :trackable,
38
    :validatable, :omniauthable, :confirmable, :registerable
gitlabhq's avatar
gitlabhq committed
39

40
  attr_accessor :force_random_password
gitlabhq's avatar
gitlabhq committed
41

42
43
44
  # Virtual attribute for authenticating by either username or email
  attr_accessor :login

45
46
47
48
  #
  # Relations
  #

49
  # Namespace for personal projects
50
  has_one :namespace, -> { where type: nil }, dependent: :destroy, foreign_key: :owner_id
51
52
53

  # Profile
  has_many :keys, dependent: :destroy
54
  has_many :emails, dependent: :destroy
55
  has_many :personal_access_tokens, dependent: :destroy
56
  has_many :identities, dependent: :destroy, autosave: true
57
  has_many :u2f_registrations, dependent: :destroy
58
59

  # Groups
60
  has_many :members, dependent: :destroy
61
  has_many :group_members, -> { where(requested_at: nil) }, dependent: :destroy, source: 'GroupMember'
62
  has_many :groups, through: :group_members
63
64
  has_many :owned_groups, -> { where members: { access_level: Gitlab::Access::OWNER } }, through: :group_members, source: :group
  has_many :masters_groups, -> { where members: { access_level: Gitlab::Access::MASTER } }, through: :group_members, source: :group
65

66
  # Projects
67
68
  has_many :groups_projects,          through: :groups, source: :projects
  has_many :personal_projects,        through: :namespace, source: :projects
69
  has_many :project_members, -> { where(requested_at: nil) }, dependent: :destroy
70
  has_many :projects,                 through: :project_members
71
  has_many :created_projects,         foreign_key: :creator_id, class_name: 'Project'
Ciro Santilli's avatar
Ciro Santilli committed
72
73
  has_many :users_star_projects, dependent: :destroy
  has_many :starred_projects, through: :users_star_projects, source: :project
74

75
  has_many :snippets,                 dependent: :destroy, foreign_key: :author_id
76
77
78
  has_many :issues,                   dependent: :destroy, foreign_key: :author_id
  has_many :notes,                    dependent: :destroy, foreign_key: :author_id
  has_many :merge_requests,           dependent: :destroy, foreign_key: :author_id
79
  has_many :events,                   dependent: :destroy, foreign_key: :author_id
80
  has_many :subscriptions,            dependent: :destroy
81
  has_many :recent_events, -> { order "id DESC" }, foreign_key: :author_id,   class_name: "Event"
82
83
  has_many :assigned_issues,          dependent: :destroy, foreign_key: :assignee_id, class_name: "Issue"
  has_many :assigned_merge_requests,  dependent: :destroy, foreign_key: :assignee_id, class_name: "MergeRequest"
Valery Sizov's avatar
Valery Sizov committed
84
  has_many :oauth_applications, class_name: 'Doorkeeper::Application', as: :owner, dependent: :destroy
85
  has_one  :abuse_report,             dependent: :destroy
86
  has_many :spam_logs,                dependent: :destroy
87
  has_many :builds,                   dependent: :nullify, class_name: 'Ci::Build'
88
  has_many :pipelines,                dependent: :nullify, class_name: 'Ci::Pipeline'
89
  has_many :todos,                    dependent: :destroy
90
  has_many :notification_settings,    dependent: :destroy
91
  has_many :award_emoji,              dependent: :destroy
92

93
94
95
  #
  # Validations
  #
Cyril Jouve's avatar
Cyril Jouve committed
96
  validates :name, presence: true
97
98
  validates :notification_email, presence: true, email: true
  validates :public_email, presence: true, uniqueness: true, email: true, allow_blank: true
99
  validates :bio, length: { maximum: 255 }, allow_blank: true
100
  validates :projects_limit, presence: true, numericality: { greater_than_or_equal_to: 0 }
101
  validates :username,
102
    namespace: true,
103
    presence: true,
104
    uniqueness: { case_sensitive: false }
105

106
  validate :namespace_uniq, if: ->(user) { user.username_changed? }
107
  validate :avatar_type, if: ->(user) { user.avatar.present? && user.avatar_changed? }
108
  validate :unique_email, if: ->(user) { user.email_changed? }
109
  validate :owns_notification_email, if: ->(user) { user.notification_email_changed? }
110
  validate :owns_public_email, if: ->(user) { user.public_email_changed? }
111
  validates :avatar, file_size: { maximum: 200.kilobytes.to_i }
112

113
  before_validation :generate_password, on: :create
114
  before_validation :signup_domain_valid?, on: :create
115
  before_validation :sanitize_attrs
116
  before_validation :set_notification_email, if: ->(user) { user.email_changed? }
117
  before_validation :set_public_email, if: ->(user) { user.public_email_changed? }
118

119
  after_update :update_emails_with_primary_email, if: ->(user) { user.email_changed? }
Nihad Abbasov's avatar
Nihad Abbasov committed
120
  before_save :ensure_authentication_token
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
121
  before_save :ensure_external_user_rights
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
122
  after_save :ensure_namespace_correct
123
  after_initialize :set_projects_limit
124
  before_create :check_confirmation_email
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
125
126
127
  after_create :post_create_hook
  after_destroy :post_destroy_hook

128
  # User's Layout preference
129
  enum layout: [:fixed, :fluid]
130

131
132
  # User's Dashboard preference
  # Note: When adding an option, it MUST go on the end of the array.
133
  enum dashboard: [:projects, :stars, :project_activity, :starred_project_activity, :groups, :todos]
134

135
136
  # User's Project preference
  # Note: When adding an option, it MUST go on the end of the array.
137
  enum project_view: [:readme, :activity, :files]
138

Nihad Abbasov's avatar
Nihad Abbasov committed
139
  alias_attribute :private_token, :authentication_token
140

141
  delegate :path, to: :namespace, allow_nil: true, prefix: true
142

143
144
145
  state_machine :state, initial: :active do
    event :block do
      transition active: :blocked
146
      transition ldap_blocked: :blocked
147
148
    end

149
150
151
152
    event :ldap_block do
      transition active: :ldap_blocked
    end

153
154
    event :activate do
      transition blocked: :active
155
      transition ldap_blocked: :active
156
    end
157
158
159
160
161
162

    state :blocked, :ldap_blocked do
      def blocked?
        true
      end
    end
163
164
  end

165
  mount_uploader :avatar, AvatarUploader
Steven Thonus's avatar
Steven Thonus committed
166

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
167
  # Scopes
168
  scope :admins, -> { where(admin: true) }
169
  scope :blocked, -> { with_states(:blocked, :ldap_blocked) }
170
  scope :external, -> { where(external: true) }
171
  scope :active, -> { with_state(:active) }
skv's avatar
skv committed
172
  scope :not_in_project, ->(project) { project.users.present? ? where("id not in (:ids)", ids: project.users.map(&:id) ) : all }
173
  scope :without_projects, -> { where('id NOT IN (SELECT DISTINCT(user_id) FROM members)') }
174
175
176
177
178
179
180
181
182
183

  def self.with_two_factor
    joins("LEFT OUTER JOIN u2f_registrations AS u2f ON u2f.user_id = users.id").
      where("u2f.id IS NOT NULL OR otp_required_for_login = ?", true).distinct(arel_table[:id])
  end

  def self.without_two_factor
    joins("LEFT OUTER JOIN u2f_registrations AS u2f ON u2f.user_id = users.id").
      where("u2f.id IS NULL AND otp_required_for_login = ?", false)
  end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
184

185
186
187
  #
  # Class methods
  #
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
188
  class << self
189
    # Devise method overridden to allow sign in with email or username
190
191
192
    def find_for_database_authentication(warden_conditions)
      conditions = warden_conditions.dup
      if login = conditions.delete(:login)
Gabriel Mazetto's avatar
Gabriel Mazetto committed
193
        where(conditions).find_by("lower(username) = :value OR lower(email) = :value", value: login.downcase)
194
      else
Gabriel Mazetto's avatar
Gabriel Mazetto committed
195
        find_by(conditions)
196
197
      end
    end
198

Valery Sizov's avatar
Valery Sizov committed
199
200
    def sort(method)
      case method.to_s
201
202
203
204
      when 'recent_sign_in' then reorder(last_sign_in_at: :desc)
      when 'oldest_sign_in' then reorder(last_sign_in_at: :asc)
      else
        order_by(method)
Valery Sizov's avatar
Valery Sizov committed
205
206
207
      end
    end

208
209
    # Find a User by their primary email or any associated secondary email
    def find_by_any_email(email)
210
211
212
213
214
215
216
      sql = 'SELECT *
      FROM users
      WHERE id IN (
        SELECT id FROM users WHERE email = :email
        UNION
        SELECT emails.user_id FROM emails WHERE email = :email
      )
217
218
219
      LIMIT 1;'

      User.find_by_sql([sql, { email: email }]).first
220
    end
221

222
    def filter(filter_name)
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
223
      case filter_name
224
225
226
227
228
229
230
231
232
233
      when 'admins'
        self.admins
      when 'blocked'
        self.blocked
      when 'two_factor_disabled'
        self.without_two_factor
      when 'two_factor_enabled'
        self.with_two_factor
      when 'wop'
        self.without_projects
234
235
      when 'external'
        self.external
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
236
237
238
      else
        self.active
      end
239
240
    end

241
242
243
244
245
246
247
    # Searches users matching the given query.
    #
    # This method uses ILIKE on PostgreSQL and LIKE on MySQL.
    #
    # query - The search query as a String
    #
    # Returns an ActiveRecord::Relation.
248
    def search(query)
249
      table   = arel_table
250
251
252
253
254
255
256
      pattern = "%#{query}%"

      where(
        table[:name].matches(pattern).
          or(table[:email].matches(pattern)).
          or(table[:username].matches(pattern))
      )
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
257
    end
258

259
    def by_login(login)
260
261
262
263
264
265
266
      return nil unless login

      if login.include?('@'.freeze)
        unscoped.iwhere(email: login).take
      else
        unscoped.iwhere(username: login).take
      end
267
268
    end

Robert Speicher's avatar
Robert Speicher committed
269
270
271
272
    def find_by_username!(username)
      find_by!('lower(username) = ?', username.downcase)
    end

Timothy Andrew's avatar
Timothy Andrew committed
273
274
275
276
277
    def find_by_personal_access_token(token_string)
      personal_access_token = PersonalAccessToken.active.find_by_token(token_string) if token_string
      personal_access_token.user if personal_access_token
    end

278
    def by_username_or_id(name_or_id)
Gabriel Mazetto's avatar
Gabriel Mazetto committed
279
      find_by('users.username = ? OR users.id = ?', name_or_id.to_s, name_or_id.to_i)
280
    end
281

Yorick Peterse's avatar
Yorick Peterse committed
282
283
284
285
286
    # Returns a user for the given SSH key.
    def find_by_ssh_key_id(key_id)
      find_by(id: Key.unscoped.select(:user_id).where(id: key_id))
    end

287
288
    def build_user(attrs = {})
      User.new(attrs)
289
    end
290
291
292
293

    def reference_prefix
      '@'
    end
294
295
296
297
298
299
300
301

    # Pattern used to extract `@user` user references from text
    def reference_pattern
      %r{
        #{Regexp.escape(reference_prefix)}
        (?<user>#{Gitlab::Regex::NAMESPACE_REGEX_STR})
      }x
    end
vsizov's avatar
vsizov committed
302
  end
randx's avatar
randx committed
303

304
305
306
  #
  # Instance methods
  #
307
308
309
310
311

  def to_param
    username
  end

312
313
314
315
  def to_reference(_from_project = nil)
    "#{self.class.reference_prefix}#{username}"
  end

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
316
317
  def generate_password
    if self.force_random_password
318
      self.password = self.password_confirmation = Devise.friendly_token.first(Devise.password_length.min)
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
319
    end
randx's avatar
randx committed
320
  end
321

322
  def generate_reset_token
Marin Jankovski's avatar
Marin Jankovski committed
323
    @reset_token, enc = Devise.token_generator.generate(self.class, :reset_password_token)
324
325
326
327

    self.reset_password_token   = enc
    self.reset_password_sent_at = Time.now.utc

Marin Jankovski's avatar
Marin Jankovski committed
328
    @reset_token
329
330
  end

331
  def check_confirmation_email
332
    skip_confirmation! unless current_application_settings.send_user_confirmation_email
333
334
  end

335
336
337
338
  def recently_sent_password_reset?
    reset_password_sent_at.present? && reset_password_sent_at >= 1.minute.ago
  end

Robert Speicher's avatar
Robert Speicher committed
339
  def disable_two_factor!
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
    transaction do
      update_attributes(
        otp_required_for_login:      false,
        encrypted_otp_secret:        nil,
        encrypted_otp_secret_iv:     nil,
        encrypted_otp_secret_salt:   nil,
        otp_grace_period_started_at: nil,
        otp_backup_codes:            nil
      )
      self.u2f_registrations.destroy_all
    end
  end

  def two_factor_enabled?
    two_factor_otp_enabled? || two_factor_u2f_enabled?
  end

  def two_factor_otp_enabled?
    self.otp_required_for_login?
  end

  def two_factor_u2f_enabled?
    self.u2f_registrations.exists?
Robert Speicher's avatar
Robert Speicher committed
363
364
  end

365
  def namespace_uniq
366
    # Return early if username already failed the first uniqueness validation
367
368
    return if self.errors.key?(:username) &&
      self.errors[:username].include?('has already been taken')
369

370
    namespace_name = self.username
371
372
    existing_namespace = Namespace.by_path(namespace_name)
    if existing_namespace && existing_namespace != self.namespace
373
      self.errors.add(:username, 'has already been taken')
374
375
    end
  end
376

377
378
379
380
381
382
  def avatar_type
    unless self.avatar.image?
      self.errors.add :avatar, "only images allowed"
    end
  end

383
  def unique_email
384
385
386
    if !self.emails.exists?(email: self.email) && Email.exists?(email: self.email)
      self.errors.add(:email, 'has already been taken')
    end
387
388
  end

389
  def owns_notification_email
390
391
    return if self.temp_oauth_email?

392
393
394
    self.errors.add(:notification_email, "is not an email you own") unless self.all_emails.include?(self.notification_email)
  end

395
  def owns_public_email
396
397
    return if self.public_email.blank?

398
399
400
401
402
403
404
405
    self.errors.add(:public_email, "is not an email you own") unless self.all_emails.include?(self.public_email)
  end

  def update_emails_with_primary_email
    primary_email_record = self.emails.find_by(email: self.email)
    if primary_email_record
      primary_email_record.destroy
      self.emails.create(email: self.email_was)
406

407
408
409
410
      self.update_secondary_emails!
    end
  end

411
412
  # Returns the groups a user has access to
  def authorized_groups
413
    union = Gitlab::SQL::Union.
414
      new([groups.select(:id), authorized_projects.select(:namespace_id)])
415

416
    Group.where("namespaces.id IN (#{union.to_sql})")
417
418
  end

419
  # Returns projects user is authorized to access.
420
421
  #
  # If you change the logic of this method, please also update `Project#authorized_for_user`
422
423
  def authorized_projects(min_access_level = nil)
    Project.where("projects.id IN (#{projects_union(min_access_level).to_sql})")
424
425
  end

426
427
  def viewable_starred_projects
    starred_projects.where("projects.visibility_level IN (?) OR projects.id IN (#{projects_union.to_sql})",
Sean McGivern's avatar
Sean McGivern committed
428
                           [Project::PUBLIC, Project::INTERNAL])
429
430
  end

431
  def owned_projects
432
    @owned_projects ||=
433
434
      Project.where('namespace_id IN (?) OR namespace_id = ?',
                    owned_groups.select(:id), namespace.id).joins(:namespace)
435
436
  end

437
438
439
440
  # Returns projects which user can admin issues on (for example to move an issue to that project).
  #
  # This logic is duplicated from `Ability#project_abilities` into a SQL form.
  def projects_where_can_admin_issues
Felipe Artur's avatar
Felipe Artur committed
441
    authorized_projects(Gitlab::Access::REPORTER).non_archived.with_issues_enabled
442
443
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
444
445
446
447
448
449
450
451
  def is_admin?
    admin
  end

  def require_ssh_key?
    keys.count == 0
  end

452
453
454
455
  def require_password?
    password_automatically_set? && !ldap_user?
  end

456
  def can_change_username?
457
    gitlab_config.username_changing_enabled
458
459
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
460
  def can_create_project?
461
    projects_limit_left > 0
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
462
463
464
  end

  def can_create_group?
465
    can?(:create_group, nil)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
466
467
  end

468
469
470
471
  def can_select_namespace?
    several_namespaces? || admin
  end

472
  def can?(action, subject)
http://jneen.net/'s avatar
http://jneen.net/ committed
473
    Ability.allowed?(self, action, subject)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
474
475
476
477
478
479
480
  end

  def first_name
    name.split.first unless name.blank?
  end

  def cared_merge_requests
481
    MergeRequest.cared(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
482
483
  end

484
  def projects_limit_left
485
    projects_limit - personal_projects.count
486
487
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
488
489
  def projects_limit_percent
    return 100 if projects_limit.zero?
490
    (personal_projects.count.to_f / projects_limit) * 100
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
491
492
  end

493
  def recent_push(project_ids = nil)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
494
495
    # Get push events not earlier than 2 hours ago
    events = recent_events.code_push.where("created_at > ?", Time.now - 2.hours)
496
    events = events.where(project_id: project_ids) if project_ids
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
497

498
499
500
501
502
    # Use the latest event that has not been pushed or merged recently
    events.recent.find do |event|
      project = Project.find_by_id(event.project_id)
      next unless project

Paco Guzman's avatar
Paco Guzman committed
503
      if project.repository.branch_exists?(event.branch_name)
504
505
506
507
508
509
        merge_requests = MergeRequest.where("created_at >= ?", event.created_at).
            where(source_project_id: project.id,
                  source_branch: event.branch_name)
        merge_requests.empty?
      end
    end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
510
511
512
513
514
515
516
  end

  def projects_sorted_by_activity
    authorized_projects.sorted_by_activity
  end

  def several_namespaces?
517
    owned_groups.any? || masters_groups.any?
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
518
519
520
521
522
  end

  def namespace_id
    namespace.try :id
  end
523

524
525
526
  def name_with_username
    "#{name} (#{username})"
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
527

528
  def already_forked?(project)
529
530
531
    !!fork_of(project)
  end

532
  def fork_of(project)
533
534
535
536
537
538
539
540
    links = ForkedProjectLink.where(forked_from_project_id: project, forked_to_project_id: personal_projects)

    if links.any?
      links.first.forked_to_project
    else
      nil
    end
  end
541
542

  def ldap_user?
543
544
545
546
547
    identities.exists?(["provider LIKE ? AND extern_uid IS NOT NULL", "ldap%"])
  end

  def ldap_identity
    @ldap_identity ||= identities.find_by(["provider LIKE ?", "ldap%"])
548
  end
549

550
  def project_deploy_keys
551
    DeployKey.unscoped.in_projects(self.authorized_projects.pluck(:id)).distinct(:id)
552
553
  end

554
  def accessible_deploy_keys
555
556
557
558
559
    @accessible_deploy_keys ||= begin
      key_ids = project_deploy_keys.pluck(:id)
      key_ids.push(*DeployKey.are_public.pluck(:id))
      DeployKey.where(id: key_ids)
    end
560
  end
561
562

  def created_by
skv's avatar
skv committed
563
    User.find_by(id: created_by_id) if created_by_id
564
  end
565
566

  def sanitize_attrs
567
    %w(name username skype linkedin twitter).each do |attr|
568
569
570
571
      value = self.send(attr)
      self.send("#{attr}=", Sanitize.clean(value)) if value.present?
    end
  end
572

573
574
  def set_notification_email
    if self.notification_email.blank? || !self.all_emails.include?(self.notification_email)
575
      self.notification_email = self.email
576
577
578
    end
  end

579
580
  def set_public_email
    if self.public_email.blank? || !self.all_emails.include?(self.public_email)
581
      self.public_email = ''
582
583
584
    end
  end

585
586
587
588
589
590
  def update_secondary_emails!
    self.set_notification_email
    self.set_public_email
    self.save if self.notification_email_changed? || self.public_email_changed?
  end

591
  def set_projects_limit
592
593
594
595
596
    # `User.select(:id)` raises
    # `ActiveModel::MissingAttributeError: missing attribute: projects_limit`
    # without this safeguard!
    return unless self.has_attribute?(:projects_limit)

597
598
599
600
601
602
    connection_default_value_defined = new_record? && !projects_limit_changed?
    return unless self.projects_limit.nil? || connection_default_value_defined

    self.projects_limit = current_application_settings.default_projects_limit
  end

603
  def requires_ldap_check?
604
605
606
    if !Gitlab.config.ldap.enabled
      false
    elsif ldap_user?
607
608
609
610
611
612
      !last_credential_check_at || (last_credential_check_at + 1.hour) < Time.now
    else
      false
    end
  end

Jacob Vosmaer's avatar
Jacob Vosmaer committed
613
614
615
616
617
618
619
  def try_obtain_ldap_lease
    # After obtaining this lease LDAP checks will be blocked for 600 seconds
    # (10 minutes) for this user.
    lease = Gitlab::ExclusiveLease.new("user_ldap_check:#{id}", timeout: 600)
    lease.try_obtain
  end

620
621
622
623
624
  def solo_owned_groups
    @solo_owned_groups ||= owned_groups.select do |group|
      group.owners == [self]
    end
  end
625
626

  def with_defaults
627
628
    User.defaults.each do |k, v|
      self.send("#{k}=", v)
629
    end
630
631

    self
632
  end
633

634
635
636
637
  def can_leave_project?(project)
    project.namespace != namespace &&
      project.project_member(self)
  end
638
639
640
641
642
643
644
645
646
647
648
649
650
651

  # Reset project events cache related to this user
  #
  # Since we do cache @event we need to reset cache in special cases:
  # * when the user changes their avatar
  # Events cache stored like  events/23-20130109142513.
  # The cache key includes updated_at timestamp.
  # Thus it will automatically generate a new fragment
  # when the event is updated because the key changes.
  def reset_events_cache
    Event.where(author_id: self.id).
      order('id DESC').limit(1000).
      update_all(updated_at: Time.now)
  end
Jerome Dalbert's avatar
Jerome Dalbert committed
652
653

  def full_website_url
654
    return "http://#{website_url}" if website_url !~ /\Ahttps?:\/\//
Jerome Dalbert's avatar
Jerome Dalbert committed
655
656
657
658
659

    website_url
  end

  def short_website_url
660
    website_url.sub(/\Ahttps?:\/\//, '')
Jerome Dalbert's avatar
Jerome Dalbert committed
661
  end
GitLab's avatar
GitLab committed
662

663
  def all_ssh_keys
664
    keys.map(&:publishable_key)
665
  end
666
667

  def temp_oauth_email?
668
    email.start_with?('temp-email-for-oauth')
669
670
  end

671
  def avatar_url(size = nil, scale = 2)
672
    if self[:avatar].present?
673
      [gitlab_config.url, avatar.url].join
674
    else
675
      GravatarService.new.execute(email, size, scale)
676
677
    end
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
678

679
  def all_emails
680
681
682
683
    all_emails = []
    all_emails << self.email unless self.temp_oauth_email?
    all_emails.concat(self.emails.map(&:email))
    all_emails
684
685
  end

Kirill Zaitsev's avatar
Kirill Zaitsev committed
686
687
688
689
690
691
692
693
  def hook_attrs
    {
      name: name,
      username: username,
      avatar_url: avatar_url
    }
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
694
695
696
697
698
699
700
701
702
703
704
  def ensure_namespace_correct
    # Ensure user has namespace
    self.create_namespace!(path: self.username, name: self.username) unless self.namespace

    if self.username_changed?
      self.namespace.update_attributes(path: self.username, name: self.username)
    end
  end

  def post_create_hook
    log_info("User \"#{self.name}\" (#{self.email}) was created")
705
    notification_service.new_user(self, @reset_token) if self.created_by_id
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
706
707
708
709
710
711
712
713
    system_hook_service.execute_hooks_for(self, :create)
  end

  def post_destroy_hook
    log_info("User \"#{self.name}\" (#{self.email})  was removed")
    system_hook_service.execute_hooks_for(self, :destroy)
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
714
  def notification_service
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
715
716
717
    NotificationService.new
  end

718
  def log_info(message)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
719
720
721
722
723
724
    Gitlab::AppLogger.info message
  end

  def system_hook_service
    SystemHooksService.new
  end
Ciro Santilli's avatar
Ciro Santilli committed
725
726

  def starred?(project)
727
    starred_projects.exists?(project.id)
Ciro Santilli's avatar
Ciro Santilli committed
728
729
730
  end

  def toggle_star(project)
731
732
733
734
735
736
737
738
739
    UsersStarProject.transaction do
      user_star_project = users_star_projects.
          where(project: project, user: self).lock(true).first

      if user_star_project
        user_star_project.destroy
      else
        UsersStarProject.create!(project: project, user: self)
      end
Ciro Santilli's avatar
Ciro Santilli committed
740
741
    end
  end
742
743

  def manageable_namespaces
744
    @manageable_namespaces ||= [namespace] + owned_groups + masters_groups
745
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
746

747
748
749
750
751
752
  def namespaces
    namespace_ids = groups.pluck(:id)
    namespace_ids.push(namespace.id)
    Namespace.where(id: namespace_ids)
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
753
754
755
  def oauth_authorized_tokens
    Doorkeeper::AccessToken.where(resource_owner_id: self.id, revoked_at: nil)
  end
756

757
758
759
760
761
762
763
764
765
  # Returns the projects a user contributed to in the last year.
  #
  # This method relies on a subquery as this performs significantly better
  # compared to a JOIN when coupled with, for example,
  # `Project.visible_to_user`. That is, consider the following code:
  #
  #     some_user.contributed_projects.visible_to_user(other_user)
  #
  # If this method were to use a JOIN the resulting query would take roughly 200
766
  # ms on a database with a similar size to GitLab.com's database. On the other
767
768
769
770
  # hand, using a subquery means we can get the exact same data in about 40 ms.
  def contributed_projects
    events = Event.select(:project_id).
      contributions.where(author_id: self).
771
      where("created_at > ?", Time.now - 1.year).
772
      uniq.
773
774
775
      reorder(nil)

    Project.where(id: events)
776
  end
777

778
779
780
  def can_be_removed?
    !solo_owned_groups.present?
  end
781
782

  def ci_authorized_runners
783
    @ci_authorized_runners ||= begin
784
785
      runner_ids = Ci::RunnerProject.
        where("ci_runner_projects.gl_project_id IN (#{ci_projects_union.to_sql})").
786
        select(:runner_id)
787
788
      Ci::Runner.specific.where(id: runner_ids)
    end
789
  end
790

791
792
793
794
  def notification_settings_for(source)
    notification_settings.find_or_initialize_by(source: source)
  end

795
796
797
  # Lazy load global notification setting
  # Initializes User setting with Participating level if setting not persisted
  def global_notification_setting
798
799
800
801
802
803
    return @global_notification_setting if defined?(@global_notification_setting)

    @global_notification_setting = notification_settings.find_or_initialize_by(source: nil)
    @global_notification_setting.update_attributes(level: NotificationSetting.levels[DEFAULT_NOTIFICATION_LEVEL]) unless @global_notification_setting.persisted?

    @global_notification_setting
804
805
  end

Josh Frye's avatar
Josh Frye committed
806
807
  def assigned_open_merge_request_count(force: false)
    Rails.cache.fetch(['users', id, 'assigned_open_merge_request_count'], force: force) do
808
809
810
811
      assigned_merge_requests.opened.count
    end
  end

Josh Frye's avatar
Josh Frye committed
812
813
  def assigned_open_issues_count(force: false)
    Rails.cache.fetch(['users', id, 'assigned_open_issues_count'], force: force) do
814
815
      assigned_issues.opened.count
    end
816
817
  end

Josh Frye's avatar
Josh Frye committed
818
819
820
821
822
  def update_cache_counts
    assigned_open_merge_request_count(force: true)
    assigned_open_issues_count(force: true)
  end

823
824
  def todos_done_count(force: false)
    Rails.cache.fetch(['users', id, 'todos_done_count'], force: force) do
825
      TodosFinder.new(self, state: :done).execute.count
826
827
828
829
830
    end
  end

  def todos_pending_count(force: false)
    Rails.cache.fetch(['users', id, 'todos_pending_count'], force: force) do
831
      TodosFinder.new(self, state: :pending).execute.count
832
833
834
835
836
837
838
839
    end
  end

  def update_todos_count_cache
    todos_done_count(force: true)
    todos_pending_count(force: true)
  end

840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
  # This is copied from Devise::Models::Lockable#valid_for_authentication?, as our auth
  # flow means we don't call that automatically (and can't conveniently do so).
  #
  # See:
  #   <https://github.com/plataformatec/devise/blob/v4.0.0/lib/devise/models/lockable.rb#L92>
  #
  def increment_failed_attempts!
    self.failed_attempts ||= 0
    self.failed_attempts += 1
    if attempts_exceeded?
      lock_access! unless access_locked?
    else
      save(validate: false)
    end
  end

856
857
  private

858
  def projects_union(min_access_level = nil)
859
860
861
862
863
864
    relations = [personal_projects.select(:id),
                 groups_projects.select(:id),
                 projects.select(:id),
                 groups.joins(:shared_projects).select(:project_id)]

    if min_access_level
865
      scope = { access_level: Gitlab::Access.all_values.select { |access| access >= min_access_level } }
866
867
      relations = [relations.shift] + relations.map { |relation| relation.where(members: scope) }
    end
868
869

    Gitlab::SQL::Union.new(relations)
870
  end
871
872
873
874
875
876
877
878
879

  def ci_projects_union
    scope  = { access_level: [Gitlab::Access::MASTER, Gitlab::Access::OWNER] }
    groups = groups_projects.where(members: scope)
    other  = projects.where(members: scope)

    Gitlab::SQL::Union.new([personal_projects.select(:id), groups.select(:id),
                            other.select(:id)])
  end
Valery Sizov's avatar
Valery Sizov committed
880
881
882
883
884

  # Added according to https://github.com/plataformatec/devise/blob/7df57d5081f9884849ca15e4fde179ef164a575f/README.md#activejob-integration
  def send_devise_notification(notification, *args)
    devise_mailer.send(notification, self, *args).deliver_later
  end
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
885
886
887
888
889
890
891

  def ensure_external_user_rights
    return unless self.external?

    self.can_create_group   = false
    self.projects_limit     = 0
  end
892

893
894
895
896
897
898
  def signup_domain_valid?
    valid = true
    error = nil

    if current_application_settings.domain_blacklist_enabled?
      blocked_domains = current_application_settings.domain_blacklist
899
      if domain_matches?(blocked_domains, self.email)
900
901
902
903
904
        error = 'is not from an allowed domain.'
        valid = false
      end
    end

905
    allowed_domains = current_application_settings.domain_whitelist
906
    unless allowed_domains.blank?
907
      if domain_matches?(allowed_domains, self.email)
908
909
        valid = true
      else
910
        error = "domain is not authorized for sign-up"
911
912
913
914
915
916
917
918
        valid = false
      end
    end

    self.errors.add(:email, error) unless valid

    valid
  end
919

920
  def domain_matches?(email_domains, email)
921
922
923
924
925
926
927
    signup_domain = Mail::Address.new(email).domain
    email_domains.any? do |domain|
      escaped = Regexp.escape(domain).gsub('\*', '.*?')
      regexp = Regexp.new "^#{escaped}$", Regexp::IGNORECASE
      signup_domain =~ regexp
    end
  end
gitlabhq's avatar
gitlabhq committed
928
end