Class: Admin::UsersController

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

Instance Method Summary collapse

Instance Method Details

#activateObject



294
295
296
297
298
299
300
301
302
303
# File 'app/controllers/admin/users_controller.rb', line 294

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



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

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



498
499
500
501
502
503
504
505
506
507
508
509
# File 'app/controllers/admin/users_controller.rb', line 498

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



278
279
280
281
282
283
284
285
286
287
# File 'app/controllers/admin/users_controller.rb', line 278

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



289
290
291
292
# File 'app/controllers/admin/users_controller.rb', line 289

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

#badgesObject



427
428
# File 'app/controllers/admin/users_controller.rb', line 427

def badges
end

#deactivateObject



305
306
307
308
309
310
311
312
313
314
315
# File 'app/controllers/admin/users_controller.rb', line 305

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_associated_accountsObject



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
# File 'app/controllers/admin/users_controller.rb', line 540

def delete_associated_accounts
  guardian.ensure_can_delete_user_associated_accounts!(@user)
  previous_value =
    @user
      .user_associated_accounts
      .select(:provider_name, :provider_uid, :info)
      .map do ||
        {
          provider: .provider_name,
          uid: .provider_uid,
          info: .info,
        }.to_s
      end
      .join(",")
  StaffActionLogger.new(current_user).log_delete_associated_accounts(
    @user,
    previous_value:,
    context: params[:context],
  )
  @user.user_associated_accounts.delete_all
  render json: success_json
end

#delete_other_accounts_with_same_ipObject



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'app/controllers/admin/users_controller.rb', line 467

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



73
74
75
76
77
78
# File 'app/controllers/admin/users_controller.rb', line 73

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



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
# File 'app/controllers/admin/users_controller.rb', line 370

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

#destroy_bulkObject



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'app/controllers/admin/users_controller.rb', line 405

def destroy_bulk
  # capture service_params outside the hijack block to avoid thread safety
  # issues
  service_arg = service_params

  hijack do
    User::BulkDestroy.call(service_arg) do
      on_success { render json: { deleted: true } }

      on_failed_contract do |contract|
        render json: failed_json.merge(errors: contract.errors.full_messages), status: 400
      end

      on_failed_policy(:can_delete_users) do
        render json: failed_json.merge(errors: [I18n.t("user.cannot_bulk_delete")]), status: 403
      end

      on_model_not_found(:users) { render json: failed_json, status: 404 }
    end
  end
end

#disable_second_factorObject



355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'app/controllers/admin/users_controller.rb', line 355

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



175
176
177
178
179
180
181
182
# File 'app/controllers/admin/users_controller.rb', line 175

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



191
192
193
194
195
196
# File 'app/controllers/admin/users_controller.rb', line 191

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 = { include_can_be_deleted: true }
  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



433
434
435
436
437
# File 'app/controllers/admin/users_controller.rb', line 433

def ip_info
  params.require(:ip)

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

#log_outObject



158
159
160
161
162
163
164
165
166
# File 'app/controllers/admin/users_controller.rb', line 158

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



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
# File 'app/controllers/admin/users_controller.rb', line 511

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



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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'app/controllers/admin/users_controller.rb', line 81

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'app/controllers/admin/users_controller.rb', line 225

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



211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'app/controllers/admin/users_controller.rb', line 211

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



527
528
529
530
531
532
# File 'app/controllers/admin/users_controller.rb', line 527

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



168
169
170
171
172
173
# File 'app/controllers/admin/users_controller.rb', line 168

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



184
185
186
187
188
189
# File 'app/controllers/admin/users_controller.rb', line 184

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
# File 'app/controllers/admin/users_controller.rb', line 44

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

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

#silenceObject



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'app/controllers/admin/users_controller.rb', line 317

def silence
  User::Silence.call(service_params) do
    on_success do |full_reason:, user:|
      render_json_dump(
        silence: {
          silenced: true,
          silence_reason: full_reason,
          silenced_till: user.silenced_till,
          silenced_at: user.silenced_at,
          silenced_by: BasicUserSerializer.new(current_user, root: false).as_json,
        },
      )
    end
    on_failed_contract do |contract|
      render json: failed_json.merge(errors: contract.errors.full_messages), status: 400
    end
    on_model_not_found(:user) { raise Discourse::NotFound }
    on_failed_policy(:not_silenced_already) do |policy|
      render json: failed_json.merge(message: policy.reason), status: 409
    end
    on_failed_policy(:can_silence_all_users) { raise Discourse::InvalidAccess.new }
  end
end

#similar_usersObject



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'app/controllers/admin/users_controller.rb', line 56

def similar_users
  @user = User.find_by(id: params[:user_id])
  raise Discourse::NotFound if !@user

  render_json_dump(
    {
      users:
        ActiveModel::ArraySerializer.new(
          @user.similar_users.limit(User::MAX_SIMILAR_USERS),
          each_serializer: SimilarAdminUserSerializer,
          scope: guardian,
          root: false,
        ),
    },
  )
end

#sso_recordObject



534
535
536
537
538
# File 'app/controllers/admin/users_controller.rb', line 534

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

#suspendObject



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'app/controllers/admin/users_controller.rb', line 122

def suspend
  User::Suspend.call(service_params) do
    on_success do |params:, user:, full_reason:|
      render_json_dump(
        suspension: {
          suspend_reason: params.reason,
          full_suspend_reason: full_reason,
          suspended_till: user.suspended_till,
          suspended_at: user.suspended_at,
          suspended_by: BasicUserSerializer.new(current_user, root: false).as_json,
        },
      )
    end
    on_failed_contract do |contract|
      render json: failed_json.merge(errors: contract.errors.full_messages), status: 400
    end
    on_model_not_found(:user) { raise Discourse::NotFound }
    on_failed_policy(:not_suspended_already) do |policy|
      render json: failed_json.merge(message: policy.reason), status: 409
    end
    on_failed_policy(:can_suspend_all_users) { raise Discourse::InvalidAccess.new }
  end
end

#sync_ssoObject



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
# File 'app/controllers/admin/users_controller.rb', line 439

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



430
431
# File 'app/controllers/admin/users_controller.rb', line 430

def tl3_requirements
end

#total_other_accounts_with_same_ipObject



490
491
492
493
494
495
496
# File 'app/controllers/admin/users_controller.rb', line 490

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'app/controllers/admin/users_controller.rb', line 242

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'app/controllers/admin/users_controller.rb', line 263

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



341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'app/controllers/admin/users_controller.rb', line 341

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



146
147
148
149
150
151
152
153
154
155
156
# File 'app/controllers/admin/users_controller.rb', line 146

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