Class: Admin::UsersController

Inherits:
StaffController
  • Object
show all
Defined in:
app/controllers/admin/users_controller.rb

Constant Summary collapse

MAX_SIMILAR_USERS =
10

Instance Method Summary collapse

Instance Method Details

#activateObject



338
339
340
341
342
343
344
345
346
347
# File 'app/controllers/admin/users_controller.rb', line 338

def activate
  guardian.ensure_can_activate!(@user)
  # ensure there is an active email token
  if !@user.email_tokens.active.exists?
    @user.email_tokens.create!(email: @user.email, scope: EmailToken.scopes[:signup])
  end
  @user.activate
  StaffActionLogger.new(current_user).log_user_activate(@user, I18n.t("user.activated_by_staff"))
  render json: success_json
end

#add_groupObject



242
243
244
245
246
247
248
249
250
251
252
253
# File 'app/controllers/admin/users_controller.rb', line 242

def add_group
  group = Group.find(params[:group_id].to_i)
  raise Discourse::NotFound unless group

  return render_json_error(I18n.t("groups.errors.can_not_modify_automatic")) if group.automatic
  guardian.ensure_can_edit!(group)

  group.add(@user)
  GroupActionLogger.new(current_user, group).log_add_user_to_group(@user)

  render body: nil
end

#anonymizeObject



559
560
561
562
563
564
565
566
567
568
569
570
# File 'app/controllers/admin/users_controller.rb', line 559

def anonymize
  guardian.ensure_can_anonymize_user!(@user)
  opts = {}
  opts[:anonymize_ip] = params[:anonymize_ip] if params[:anonymize_ip].present?

  if user = UserAnonymizer.new(@user, current_user, opts).make_anonymous
    render json: success_json.merge(username: user.username)
  else
    render json:
             failed_json.merge(user: AdminDetailedUserSerializer.new(user, root: false).as_json)
  end
end

#approveObject



322
323
324
325
326
327
328
329
330
331
# File 'app/controllers/admin/users_controller.rb', line 322

def approve
  guardian.ensure_can_approve!(@user)

  reviewable =
    ReviewableUser.find_by(target: @user) ||
      Jobs::CreateUserReviewable.new.execute(user_id: @user.id).reviewable

  reviewable.perform(current_user, :approve_user)
  render body: nil
end

#approve_bulkObject



333
334
335
336
# File 'app/controllers/admin/users_controller.rb', line 333

def approve_bulk
  Reviewable.bulk_perform_targets(current_user, :approve_user, "ReviewableUser", params[:users])
  render body: nil
end

#badgesObject



488
489
# File 'app/controllers/admin/users_controller.rb', line 488

def badges
end

#deactivateObject



349
350
351
352
353
354
355
356
357
358
359
# File 'app/controllers/admin/users_controller.rb', line 349

def deactivate
  guardian.ensure_can_deactivate!(@user)
  @user.deactivate(current_user)
  StaffActionLogger.new(current_user).log_user_deactivate(
    @user,
    I18n.t("user.deactivated_by_staff"),
    params.slice(:context),
  )
  refresh_browser @user
  render json: success_json
end

#delete_other_accounts_with_same_ipObject



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'app/controllers/admin/users_controller.rb', line 528

def delete_other_accounts_with_same_ip
  params.require(:ip)
  params.require(:exclude)
  params.require(:order)

  user_destroyer = UserDestroyer.new(current_user)
  options = {
    delete_posts: true,
    block_email: true,
    block_urls: true,
    block_ip: true,
    delete_as_spammer: true,
    context: I18n.t("user.destroy_reasons.same_ip_address", ip_address: params[:ip]),
  }

  AdminUserIndexQuery
    .new(params)
    .find_users(50)
    .each { |user| user_destroyer.destroy(user, options) }

  render json: success_json
end

#delete_posts_batchObject



59
60
61
62
63
64
# File 'app/controllers/admin/users_controller.rb', line 59

def delete_posts_batch
  deleted_posts = @user.delete_posts_in_batches(guardian)
  # staff action logs will have an entry for each post

  render json: { posts_deleted: deleted_posts.length }
end

#destroyObject



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
# File 'app/controllers/admin/users_controller.rb', line 453

def destroy
  user = User.find_by(id: params[:id].to_i)
  guardian.ensure_can_delete_user!(user)

  options = params.slice(:context, :delete_as_spammer)
  %i[delete_posts block_email block_urls block_ip].each do |param_name|
    options[param_name] = ActiveModel::Type::Boolean.new.cast(params[param_name])
  end
  options[:prepare_for_destroy] = true

  hijack do
    begin
      if UserDestroyer.new(current_user).destroy(user, options)
        render json: { deleted: true }
      else
        render json: {
                 deleted: false,
                 user: AdminDetailedUserSerializer.new(user, root: false).as_json,
               }
      end
    rescue UserDestroyer::PostsExistError
      render json: {
               deleted: false,
               message:
                 I18n.t(
                   "user.cannot_delete_has_posts",
                   username: user.username,
                   count: user.posts.joins(:topic).count,
                 ),
             },
             status: 403
    end
  end
end

#disable_second_factorObject



438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'app/controllers/admin/users_controller.rb', line 438

def disable_second_factor
  guardian.ensure_can_disable_second_factor!(@user)
  user_second_factor = @user.user_second_factors
  user_security_key = @user.security_keys
  raise Discourse::InvalidParameters if user_second_factor.empty? && user_security_key.empty?

  user_second_factor.destroy_all
  user_security_key.destroy_all
  StaffActionLogger.new(current_user).log_disable_second_factor_auth(@user)

  Jobs.enqueue(:critical_user_email, type: "account_second_factor_disabled", user_id: @user.id)

  render json: success_json
end

#grant_adminObject



219
220
221
222
223
224
225
226
# File 'app/controllers/admin/users_controller.rb', line 219

def grant_admin
  result = run_second_factor!(SecondFactor::Actions::GrantAdmin)
  if result.no_second_factors_enabled?
    render json: success_json.merge(email_confirmation_required: true)
  else
    render json: success_json
  end
end

#grant_moderationObject



235
236
237
238
239
240
# File 'app/controllers/admin/users_controller.rb', line 235

def grant_moderation
  guardian.ensure_can_grant_moderation!(@user)
  @user.grant_moderation!
  StaffActionLogger.new(current_user).log_grant_moderation(@user)
  render_serialized(@user, AdminDetailedUserSerializer, root: false)
end

#indexObject



32
33
34
35
36
37
38
39
40
41
42
# File 'app/controllers/admin/users_controller.rb', line 32

def index
  users = ::AdminUserIndexQuery.new(params).find_users

  opts = {}
  if params[:show_emails] == "true"
    StaffActionLogger.new(current_user).log_show_emails(users, context: request.path)
    opts[:emails_desired] = true
  end

  render_serialized(users, AdminUserListSerializer, opts)
end

#ip_infoObject



494
495
496
497
498
# File 'app/controllers/admin/users_controller.rb', line 494

def ip_info
  params.require(:ip)

  render json: DiscourseIpInfo.get(params[:ip], resolve_hostname: true)
end

#log_outObject



202
203
204
205
206
207
208
209
210
# File 'app/controllers/admin/users_controller.rb', line 202

def log_out
  if @user
    @user.user_auth_tokens.destroy_all
    @user.logged_out
    render json: success_json
  else
    render json: { error: I18n.t("admin_js.admin.users.id_not_found") }, status: 404
  end
end

#mergeObject



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'app/controllers/admin/users_controller.rb', line 572

def merge
  target_username = params.require(:target_username)
  target_user = User.find_by_username(target_username)
  raise Discourse::NotFound if target_user.blank?

  guardian.ensure_can_merge_users!(@user, target_user)

  Jobs.enqueue(
    :merge_user,
    user_id: @user.id,
    target_user_id: target_user.id,
    current_user_id: current_user.id,
  )
  render json: success_json
end

#penalty_historyObject

DELETE action to delete penalty history for a user



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'app/controllers/admin/users_controller.rb', line 67

def penalty_history
  # We don't delete any history, we merely remove the action type
  # with a removed type. It can still be viewed in the logs but
  # will not affect TL3 promotions.
  sql = <<~SQL
    UPDATE user_histories
    SET action = CASE
      WHEN action = :silence_user THEN :removed_silence_user
      WHEN action = :unsilence_user THEN :removed_unsilence_user
      WHEN action = :suspend_user THEN :removed_suspend_user
      WHEN action = :unsuspend_user THEN :removed_unsuspend_user
    END
    WHERE target_user_id = :user_id
      AND action IN (
        :silence_user,
        :suspend_user,
        :unsilence_user,
        :unsuspend_user
      )
  SQL

  DB.exec(
    sql,
    UserHistory
      .actions
      .slice(
        :silence_user,
        :suspend_user,
        :unsilence_user,
        :unsuspend_user,
        :removed_silence_user,
        :removed_unsilence_user,
        :removed_suspend_user,
        :removed_unsuspend_user,
      )
      .merge(user_id: params[:user_id].to_i),
  )

  render json: success_json
end

#primary_groupObject



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'app/controllers/admin/users_controller.rb', line 269

def primary_group
  if params[:primary_group_id].present?
    primary_group_id = params[:primary_group_id].to_i
    if group = Group.find(primary_group_id)
      guardian.ensure_can_change_primary_group!(@user, group)

      @user.primary_group_id = primary_group_id if group.user_ids.include?(@user.id)
    end
  else
    @user.primary_group_id = nil
  end

  @user.save!

  render body: nil
end

#remove_groupObject



255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'app/controllers/admin/users_controller.rb', line 255

def remove_group
  group = Group.find(params[:group_id].to_i)
  raise Discourse::NotFound unless group

  return render_json_error(I18n.t("groups.errors.can_not_modify_automatic")) if group.automatic
  guardian.ensure_can_edit!(group)

  if group.remove(@user)
    GroupActionLogger.new(current_user, group).log_remove_user_from_group(@user)
  end

  render body: nil
end

#reset_bounce_scoreObject



588
589
590
591
592
593
# File 'app/controllers/admin/users_controller.rb', line 588

def reset_bounce_score
  guardian.ensure_can_reset_bounce_score!(@user)
  @user.user_stat&.reset_bounce_score!
  StaffActionLogger.new(current_user).log_reset_bounce_score(@user)
  render json: success_json
end

#revoke_adminObject



212
213
214
215
216
217
# File 'app/controllers/admin/users_controller.rb', line 212

def revoke_admin
  guardian.ensure_can_revoke_admin!(@user)
  @user.revoke_admin!
  StaffActionLogger.new(current_user).log_revoke_admin(@user)
  render_serialized(@user, AdminDetailedUserSerializer, root: false)
end

#revoke_moderationObject



228
229
230
231
232
233
# File 'app/controllers/admin/users_controller.rb', line 228

def revoke_moderation
  guardian.ensure_can_revoke_moderation!(@user)
  @user.revoke_moderation!
  StaffActionLogger.new(current_user).log_revoke_moderation(@user)
  render_serialized(@user, AdminDetailedUserSerializer, root: false)
end

#showObject



44
45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'app/controllers/admin/users_controller.rb', line 44

def show
  @user = User.find_by(id: params[:id])
  raise Discourse::NotFound unless @user

  similar_users = User.real.where.not(id: @user.id).where(ip_address: @user.ip_address)

  render_serialized(
    @user,
    AdminDetailedUserSerializer,
    root: false,
    similar_users: similar_users.limit(MAX_SIMILAR_USERS),
    similar_users_count: similar_users.count,
  )
end

#silenceObject



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'app/controllers/admin/users_controller.rb', line 361

def silence
  guardian.ensure_can_silence_user! @user

  if @user.silenced?
    silenced_record = @user.silenced_record
    message =
      I18n.t(
        "user.already_silenced",
        staff: silenced_record.acting_user.username,
        time_ago:
          AgeWords.time_ago_in_words(
            silenced_record.created_at,
            true,
            scope: :"datetime.distance_in_words_verbose",
          ),
      )
    return render json: failed_json.merge(message: message), status: 409
  end

  all_users = [@user]
  if Array === params[:other_user_ids]
    all_users.concat(User.where(id: params[:other_user_ids]).to_a)
    all_users.uniq!
  end

  user_history = nil

  all_users.each do |user|
    silencer =
      UserSilencer.new(
        user,
        current_user,
        silenced_till: params[:silenced_till],
        reason: params[:reason],
        message_body: params[:message],
        keep_posts: true,
        post_id: params[:post_id],
      )

    if silencer.silence
      user_history = silencer.user_history
      Jobs.enqueue(
        :critical_user_email,
        type: "account_silenced",
        user_id: user.id,
        user_history_id: user_history.id,
      )
    end
  end

  perform_post_action

  render_json_dump(
    silence: {
      silenced: true,
      silence_reason: user_history.try(:details),
      silenced_till: @user.silenced_till,
      silenced_at: @user.silenced_at,
      silenced_by: BasicUserSerializer.new(current_user, root: false).as_json,
    },
  )
end

#sso_recordObject



595
596
597
598
599
# File 'app/controllers/admin/users_controller.rb', line 595

def sso_record
  guardian.ensure_can_delete_sso_record!(@user)
  @user.single_sign_on_record.destroy!
  render json: success_json
end

#suspendObject



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'app/controllers/admin/users_controller.rb', line 108

def suspend
  guardian.ensure_can_suspend!(@user)

  if @user.suspended?
    suspend_record = @user.suspend_record
    message =
      I18n.t(
        "user.already_suspended",
        staff: suspend_record.acting_user.username,
        time_ago:
          AgeWords.time_ago_in_words(
            suspend_record.created_at,
            true,
            scope: :"datetime.distance_in_words_verbose",
          ),
      )
    return render json: failed_json.merge(message: message), status: 409
  end

  params.require(%i[suspend_until reason])

  all_users = [@user]
  if Array === params[:other_user_ids]
    all_users.concat(User.where(id: params[:other_user_ids]).to_a)
    all_users.uniq!
  end

  user_history = nil

  all_users.each do |user|
    user.suspended_till = params[:suspend_until]
    user.suspended_at = DateTime.now

    message = params[:message]

    User.transaction do
      user.save!

      user_history =
        StaffActionLogger.new(current_user).log_user_suspend(
          user,
          params[:reason],
          message: message,
          post_id: params[:post_id],
        )
    end
    user.logged_out

    if message.present?
      Jobs.enqueue(
        :critical_user_email,
        type: "account_suspended",
        user_id: user.id,
        user_history_id: user_history.id,
      )
    end

    DiscourseEvent.trigger(
      :user_suspended,
      user: user,
      reason: params[:reason],
      message: message,
      user_history: user_history,
      post_id: params[:post_id],
      suspended_till: params[:suspend_until],
      suspended_at: DateTime.now,
    )
  end

  perform_post_action

  render_json_dump(
    suspension: {
      suspend_reason: params[:reason],
      full_suspend_reason: user_history.try(:details),
      suspended_till: @user.suspended_till,
      suspended_at: @user.suspended_at,
      suspended_by: BasicUserSerializer.new(current_user, root: false).as_json,
    },
  )
end

#sync_ssoObject



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# File 'app/controllers/admin/users_controller.rb', line 500

def sync_sso
  return render body: nil, status: 404 unless SiteSetting.enable_discourse_connect

  begin
    sso =
      DiscourseConnect.parse(
        "sso=#{params[:sso]}&sig=#{params[:sig]}",
        secure_session: secure_session,
      )
  rescue DiscourseConnect::ParseError
    return(
      render json: failed_json.merge(message: I18n.t("discourse_connect.login_error")),
             status: 422
    )
  end

  begin
    user = sso.lookup_or_create_user
    DiscourseEvent.trigger(:sync_sso, user)
    render_serialized(user, AdminDetailedUserSerializer, root: false)
  rescue ActiveRecord::RecordInvalid => ex
    render json: failed_json.merge(message: ex.message), status: 403
  rescue DiscourseConnect::BlankExternalId => ex
    render json: failed_json.merge(message: I18n.t("discourse_connect.blank_id_error")),
           status: 422
  end
end

#tl3_requirementsObject



491
492
# File 'app/controllers/admin/users_controller.rb', line 491

def tl3_requirements
end

#total_other_accounts_with_same_ipObject



551
552
553
554
555
556
557
# File 'app/controllers/admin/users_controller.rb', line 551

def total_other_accounts_with_same_ip
  params.require(:ip)
  params.require(:exclude)
  params.require(:order)

  render json: { total: AdminUserIndexQuery.new(params).count_users }
end

#trust_levelObject



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'app/controllers/admin/users_controller.rb', line 286

def trust_level
  guardian.ensure_can_change_trust_level!(@user)
  level = params[:level].to_i

  if @user.manual_locked_trust_level.nil?
    if [0, 1, 2].include?(level) && Promotion.public_send("tl#{level + 1}_met?", @user)
      @user.manual_locked_trust_level = level
      @user.save
    elsif level == 3 && Promotion.tl3_lost?(@user)
      @user.manual_locked_trust_level = level
      @user.save
    end
  end

  @user.change_trust_level!(level, log_action_for: current_user)

  render_serialized(@user, AdminUserSerializer)
rescue Discourse::InvalidAccess => e
  render_json_error(e.message)
end

#trust_level_lockObject



307
308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'app/controllers/admin/users_controller.rb', line 307

def trust_level_lock
  guardian.ensure_can_change_trust_level!(@user)

  new_lock = params[:locked].to_s
  return render_json_error I18n.t("errors.invalid_boolean") unless new_lock =~ /true|false/

  @user.manual_locked_trust_level = (new_lock == "true") ? @user.trust_level : nil
  @user.save

  StaffActionLogger.new(current_user).log_lock_trust_level(@user)
  Promotion.recalculate(@user, current_user)

  render body: nil
end

#unsilenceObject



424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'app/controllers/admin/users_controller.rb', line 424

def unsilence
  guardian.ensure_can_unsilence_user! @user
  UserSilencer.unsilence(@user, current_user)

  render_json_dump(
    unsilence: {
      silenced: false,
      silence_reason: nil,
      silenced_till: nil,
      silenced_at: nil,
    },
  )
end

#unsuspendObject



190
191
192
193
194
195
196
197
198
199
200
# File 'app/controllers/admin/users_controller.rb', line 190

def unsuspend
  guardian.ensure_can_suspend!(@user)
  @user.suspended_till = nil
  @user.suspended_at = nil
  @user.save!
  StaffActionLogger.new(current_user).log_user_unsuspend(@user)

  DiscourseEvent.trigger(:user_unsuspended, user: @user)

  render_json_dump(suspension: { suspended_till: nil, suspended_at: nil })
end