Class: StaffActionLogger

Inherits:
Object
  • Object
show all
Defined in:
app/services/staff_action_logger.rb

Overview

Responsible for logging the actions of admins and moderators.

Constant Summary collapse

USER_FIELDS =
%i[id username name created_at trust_level last_seen_at last_emailed_at]
BADGE_FIELDS =
%i[
  id
  name
  description
  long_description
  icon
  image_upload_id
  badge_type_id
  badge_grouping_id
  query
  allow_title
  multiple_grant
  listable
  target_posts
  enabled
  auto_revoke
  show_posts
  system
]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(admin) ⇒ StaffActionLogger

Returns a new instance of StaffActionLogger.



9
10
11
12
# File 'app/services/staff_action_logger.rb', line 9

def initialize(admin)
  @admin = admin
  raise Discourse::InvalidParameters.new(:admin) unless @admin && @admin.is_a?(User)
end

Class Method Details

.base_attrsObject



5
6
7
# File 'app/services/staff_action_logger.rb', line 5

def self.base_attrs
  %i[topic_id post_id context subject ip_address previous_value new_value]
end

Instance Method Details

#edit_directory_columns_details(column_data, directory_column) ⇒ Object



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'app/services/staff_action_logger.rb', line 49

def edit_directory_columns_details(column_data, directory_column)
  directory_column = directory_column.attributes.transform_values(&:to_s)
  previous_value = directory_column
  new_value = directory_column.clone

  directory_column.each do |key, value|
    if column_data[key] != value && column_data[key].present?
      new_value[key] = column_data[key]
    elsif key != "name"
      previous_value.delete key
      new_value.delete key
    end
  end

  [previous_value.to_json, new_value.to_json]
end

#log_add_email(user) ⇒ Object



925
926
927
928
929
930
931
932
933
# File 'app/services/staff_action_logger.rb', line 925

def log_add_email(user)
  raise Discourse::InvalidParameters.new(:user) unless user

  UserHistory.create!(
    action: UserHistory.actions[:add_email],
    acting_user_id: @admin.id,
    target_user_id: user.id,
  )
end

#log_api_key(api_key, action, opts = {}) ⇒ Object



875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'app/services/staff_action_logger.rb', line 875

def log_api_key(api_key, action, opts = {})
  opts[:changes]&.delete("key") # Do not log the full key

  history_params = params(opts).merge(action: action, subject: api_key.truncated_key)

  if opts[:changes]
    old_values, new_values = get_changes(opts[:changes])
    history_params[:previous_value] = old_values&.join(", ") if opts[:changes].keys.exclude?("id")
    history_params[:new_value] = new_values&.join(", ")
  end

  UserHistory.create!(history_params)
end

#log_api_key_restore(api_key) ⇒ Object



899
900
901
902
903
904
905
906
907
# File 'app/services/staff_action_logger.rb', line 899

def log_api_key_restore(api_key)
  UserHistory.create!(
    params.merge(
      subject: api_key.truncated_key,
      action: UserHistory.actions[:api_key_update],
      details: I18n.t("staff_action_logs.api_key.restored"),
    ),
  )
end

#log_api_key_revoke(api_key) ⇒ Object



889
890
891
892
893
894
895
896
897
# File 'app/services/staff_action_logger.rb', line 889

def log_api_key_revoke(api_key)
  UserHistory.create!(
    params.merge(
      subject: api_key.truncated_key,
      action: UserHistory.actions[:api_key_update],
      details: I18n.t("staff_action_logs.api_key.revoked"),
    ),
  )
end

#log_backup_create(opts = {}) ⇒ Object



699
700
701
702
703
704
705
706
# File 'app/services/staff_action_logger.rb', line 699

def log_backup_create(opts = {})
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:backup_create],
      ip_address: @admin.ip_address.to_s,
    ),
  )
end

#log_backup_destroy(backup, opts = {}) ⇒ Object



729
730
731
732
733
734
735
736
737
738
# File 'app/services/staff_action_logger.rb', line 729

def log_backup_destroy(backup, opts = {})
  raise Discourse::InvalidParameters.new(:backup) unless backup
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:backup_destroy],
      ip_address: @admin.ip_address.to_s,
      details: backup.filename,
    ),
  )
end

#log_backup_download(backup, opts = {}) ⇒ Object



718
719
720
721
722
723
724
725
726
727
# File 'app/services/staff_action_logger.rb', line 718

def log_backup_download(backup, opts = {})
  raise Discourse::InvalidParameters.new(:backup) unless backup
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:backup_download],
      ip_address: @admin.ip_address.to_s,
      details: backup.filename,
    ),
  )
end

#log_badge_change(badge) ⇒ Object



447
448
449
450
451
452
453
454
455
456
# File 'app/services/staff_action_logger.rb', line 447

def log_badge_change(badge)
  raise Discourse::InvalidParameters.new(:badge) unless badge
  details = ["id: #{badge.id}"]
  badge.previous_changes.each do |f, values|
    details << "#{f}: #{values[1]}" if BADGE_FIELDS.include?(f.to_sym)
  end
  UserHistory.create!(
    params.merge(action: UserHistory.actions[:change_badge], details: details.join("\n")),
  )
end

#log_badge_creation(badge) ⇒ Object



433
434
435
436
437
438
439
440
441
442
443
444
445
# File 'app/services/staff_action_logger.rb', line 433

def log_badge_creation(badge)
  raise Discourse::InvalidParameters.new(:badge) unless badge

  details =
    BADGE_FIELDS
      .map { |f| [f, badge.public_send(f)] }
      .select { |f, v| v.present? }
      .map { |f, v| "#{f}: #{v}" }

  UserHistory.create!(
    params.merge(action: UserHistory.actions[:create_badge], details: details.join("\n")),
  )
end

#log_badge_deletion(badge) ⇒ Object



458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'app/services/staff_action_logger.rb', line 458

def log_badge_deletion(badge)
  raise Discourse::InvalidParameters.new(:badge) unless badge

  details =
    BADGE_FIELDS
      .map { |f| [f, badge.public_send(f)] }
      .select { |f, v| v.present? }
      .map { |f, v| "#{f}: #{v}" }

  UserHistory.create!(
    params.merge(action: UserHistory.actions[:delete_badge], details: details.join("\n")),
  )
end

#log_badge_grant(user_badge, opts = {}) ⇒ Object



472
473
474
475
476
477
478
479
480
481
# File 'app/services/staff_action_logger.rb', line 472

def log_badge_grant(user_badge, opts = {})
  raise Discourse::InvalidParameters.new(:user_badge) unless user_badge
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:grant_badge],
      target_user_id: user_badge.user_id,
      details: user_badge.badge.name,
    ),
  )
end

#log_badge_revoke(user_badge, opts = {}) ⇒ Object



483
484
485
486
487
488
489
490
491
492
# File 'app/services/staff_action_logger.rb', line 483

def log_badge_revoke(user_badge, opts = {})
  raise Discourse::InvalidParameters.new(:user_badge) unless user_badge
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:revoke_badge],
      target_user_id: user_badge.user_id,
      details: user_badge.badge.name,
    ),
  )
end

#log_category_creation(category) ⇒ Object



625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'app/services/staff_action_logger.rb', line 625

def log_category_creation(category)
  validate_category(category)

  details = ["created_at: #{category.created_at}", "name: #{category.name}"]

  UserHistory.create!(
    params.merge(
      action: UserHistory.actions[:create_category],
      details: details.join("\n"),
      category_id: category.id,
      context: category.url,
    ),
  )
end

#log_category_deletion(category) ⇒ Object



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
# File 'app/services/staff_action_logger.rb', line 602

def log_category_deletion(category)
  validate_category(category)

  details = [
    "created_at: #{category.created_at}",
    "name: #{category.name}",
    "permissions: #{category.permissions_params}",
  ]

  if parent_category = category.parent_category
    details << "parent_category: #{parent_category.name}"
  end

  UserHistory.create!(
    params.merge(
      action: UserHistory.actions[:delete_category],
      category_id: category.id,
      details: details.join("\n"),
      context: category.url,
    ),
  )
end

#log_category_settings_change(category, category_params, old_permissions: nil, old_custom_fields: nil) ⇒ Object



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'app/services/staff_action_logger.rb', line 565

def log_category_settings_change(
  category,
  category_params,
  old_permissions: nil,
  old_custom_fields: nil
)
  validate_category(category)

  changed_attributes = category.previous_changes.slice(*category_params.keys)

  if !old_permissions.empty? && (old_permissions != category_params[:permissions].to_h)
    changed_attributes.merge!(
      permissions: [old_permissions.to_json, category_params[:permissions].to_json],
    )
  end

  if old_custom_fields && category_params[:custom_fields]
    category_params[:custom_fields].each do |key, value|
      next if old_custom_fields[key] == value
      changed_attributes["custom_fields[#{key}]"] = [old_custom_fields[key], value]
    end
  end

  changed_attributes.each do |key, value|
    UserHistory.create!(
      params.merge(
        action: UserHistory.actions[:change_category_settings],
        category_id: category.id,
        context: category.url,
        subject: key,
        previous_value: value[0],
        new_value: value[1],
      ),
    )
  end
end

#log_change_readonly_mode(state) ⇒ Object



785
786
787
788
789
790
791
792
793
# File 'app/services/staff_action_logger.rb', line 785

def log_change_readonly_mode(state)
  UserHistory.create!(
    params.merge(
      action: UserHistory.actions[:change_readonly_mode],
      previous_value: !state,
      new_value: state,
    ),
  )
end

#log_change_upload_secure_status(opts = {}) ⇒ Object



519
520
521
522
523
524
525
526
527
528
529
530
# File 'app/services/staff_action_logger.rb', line 519

def log_change_upload_secure_status(opts = {})
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:override_upload_secure_status],
      details: [
        "upload_id: #{opts[:upload_id]}",
        "reason: #{I18n.t("uploads.marked_insecure_from_theme_component_reason")}",
      ].join("\n"),
      new_value: opts[:new_value],
    ),
  )
end

#log_check_email(user, opts = {}) ⇒ Object



532
533
534
535
536
537
# File 'app/services/staff_action_logger.rb', line 532

def log_check_email(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:check_email], target_user_id: user.id),
  )
end

#log_check_personal_message(topic, opts = {}) ⇒ Object



795
796
797
798
799
800
801
802
803
804
# File 'app/services/staff_action_logger.rb', line 795

def log_check_personal_message(topic, opts = {})
  raise Discourse::InvalidParameters.new(:topic) unless topic && topic.is_a?(Topic)
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:check_personal_message],
      topic_id: topic.id,
      context: topic.relative_url,
    ),
  )
end

#log_create_public_sidebar_section(section) ⇒ Object



1007
1008
1009
1010
1011
1012
1013
1014
# File 'app/services/staff_action_logger.rb', line 1007

def log_create_public_sidebar_section(section)
  UserHistory.create!(
    action: UserHistory.actions[:create_public_sidebar_section],
    acting_user_id: @admin.id,
    subject: section.title,
    details: custom_section_details(section),
  )
end

#log_custom(custom_type, details = nil) ⇒ Object



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'app/services/staff_action_logger.rb', line 32

def log_custom(custom_type, details = nil)
  raise Discourse::InvalidParameters.new(:custom_type) unless custom_type

  details ||= {}

  attrs = {}
  StaffActionLogger.base_attrs.each do |attr|
    attrs[attr] = details.delete(attr) if details.has_key?(attr)
  end
  attrs[:details] = details.map { |r| "#{r[0]}: #{truncate(r[1].to_s)}" }.join("\n")
  attrs[:acting_user_id] = @admin.id
  attrs[:action] = UserHistory.actions[:custom_staff]
  attrs[:custom_type] = custom_type

  UserHistory.create!(attrs)
end

#log_custom_emoji_create(name, opts = {}) ⇒ Object



1041
1042
1043
1044
1045
1046
1047
# File 'app/services/staff_action_logger.rb', line 1041

def log_custom_emoji_create(name, opts = {})
  opts[:details] = "Group: #{opts[:group]}" if opts[:group].present?

  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:custom_emoji_create], new_value: name),
  )
end

#log_custom_emoji_destroy(name, opts = {}) ⇒ Object



1049
1050
1051
1052
1053
# File 'app/services/staff_action_logger.rb', line 1049

def log_custom_emoji_destroy(name, opts = {})
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:custom_emoji_destroy], previous_value: name),
  )
end

#log_delete_associated_accounts(user, previous_value:, context:) ⇒ Object



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
# File 'app/services/staff_action_logger.rb', line 1082

def log_delete_associated_accounts(user, previous_value:, context:)
  UserHistory.create!(
    params.merge(
      action: UserHistory.actions[:delete_associated_accounts],
      target_user_id: user.id,
      previous_value:,
      context:,
    ),
  )
end

#log_destroy_email(user) ⇒ Object



945
946
947
948
949
950
951
952
953
# File 'app/services/staff_action_logger.rb', line 945

def log_destroy_email(user)
  raise Discourse::InvalidParameters.new(:user) unless user

  UserHistory.create!(
    action: UserHistory.actions[:destroy_email],
    acting_user_id: @admin.id,
    target_user_id: user.id,
  )
end

#log_destroy_public_sidebar_section(section) ⇒ Object



1025
1026
1027
1028
1029
1030
1031
# File 'app/services/staff_action_logger.rb', line 1025

def log_destroy_public_sidebar_section(section)
  UserHistory.create!(
    action: UserHistory.actions[:destroy_public_sidebar_section],
    acting_user_id: @admin.id,
    subject: section.title,
  )
end

#log_disable_second_factor_auth(user, opts = {}) ⇒ Object



661
662
663
664
665
666
667
668
669
# File 'app/services/staff_action_logger.rb', line 661

def log_disable_second_factor_auth(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:disabled_second_factor],
      target_user_id: user.id,
    ),
  )
end

#log_embeddable_host(embeddable_host, action, opts = {}) ⇒ Object



862
863
864
865
866
867
868
869
870
871
872
873
# File 'app/services/staff_action_logger.rb', line 862

def log_embeddable_host(embeddable_host, action, opts = {})
  old_values, new_values = get_changes(opts[:changes])

  UserHistory.create!(
    params(opts).merge(
      action: action,
      context: "host: #{embeddable_host.host}",
      previous_value: old_values&.join(", "),
      new_value: new_values&.join(", "),
    ),
  )
end

#log_entity_export(entity, opts = {}) ⇒ Object



708
709
710
711
712
713
714
715
716
# File 'app/services/staff_action_logger.rb', line 708

def log_entity_export(entity, opts = {})
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:entity_export],
      ip_address: @admin.ip_address.to_s,
      subject: entity,
    ),
  )
end

#log_grant_admin(user, opts = {}) ⇒ Object



671
672
673
674
675
676
# File 'app/services/staff_action_logger.rb', line 671

def log_grant_admin(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:grant_admin], target_user_id: user.id),
  )
end

#log_grant_moderation(user, opts = {}) ⇒ Object



685
686
687
688
689
690
# File 'app/services/staff_action_logger.rb', line 685

def log_grant_moderation(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:grant_moderation], target_user_id: user.id),
  )
end

#log_group_deletion(group) ⇒ Object



983
984
985
986
987
988
989
990
991
992
993
994
995
# File 'app/services/staff_action_logger.rb', line 983

def log_group_deletion(group)
  raise Discourse::InvalidParameters.new(:group) if group.nil?

  details = ["name: #{group.name}", "id: #{group.id}"]

  details << "grant_trust_level: #{group.grant_trust_level}" if group.grant_trust_level

  UserHistory.create!(
    acting_user_id: @admin.id,
    action: UserHistory.actions[:delete_group],
    details: details.join(", "),
  )
end

#log_impersonate(user, opts = {}) ⇒ Object



549
550
551
552
553
554
# File 'app/services/staff_action_logger.rb', line 549

def log_impersonate(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:impersonate], target_user_id: user.id),
  )
end

#log_lock_trust_level(user, opts = {}) ⇒ Object



146
147
148
149
150
151
152
153
# File 'app/services/staff_action_logger.rb', line 146

def log_lock_trust_level(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user && user.is_a?(User)
  action =
    UserHistory.actions[
      user.manual_locked_trust_level.nil? ? :unlock_trust_level : :lock_trust_level
    ]
  UserHistory.create!(params(opts).merge(action: action, target_user_id: user.id))
end

#log_name_change(user_id, old_name, new_name, opts = {}) ⇒ Object



367
368
369
370
371
372
373
374
375
376
377
# File 'app/services/staff_action_logger.rb', line 367

def log_name_change(user_id, old_name, new_name, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user_id
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:change_name],
      target_user_id: user_id,
      previous_value: old_name,
      new_value: new_name,
    ),
  )
end

#log_permanently_delete_post_revisions(post) ⇒ Object



997
998
999
1000
1001
1002
1003
1004
1005
# File 'app/services/staff_action_logger.rb', line 997

def log_permanently_delete_post_revisions(post)
  raise Discourse::InvalidParameters.new(:post) if post.nil?

  UserHistory.create!(
    action: UserHistory.actions[:permanently_delete_post_revisions],
    acting_user_id: @admin.id,
    post_id: post.id,
  )
end

#log_post_approved(post, opts = {}) ⇒ Object



806
807
808
809
810
811
# File 'app/services/staff_action_logger.rb', line 806

def log_post_approved(post, opts = {})
  raise Discourse::InvalidParameters.new(:post) unless post.is_a?(Post)
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:post_approved], post_id: post.id),
  )
end

#log_post_deletion(deleted_post, opts = {}) ⇒ Object



66
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
# File 'app/services/staff_action_logger.rb', line 66

def log_post_deletion(deleted_post, opts = {})
  unless deleted_post && deleted_post.is_a?(Post)
    raise Discourse::InvalidParameters.new(:deleted_post)
  end

  topic = deleted_post.topic || Topic.with_deleted.find_by(id: deleted_post.topic_id)

  username = deleted_post.user.try(:username) || I18n.t("staff_action_logs.unknown")
  name = deleted_post.user.try(:name) || I18n.t("staff_action_logs.unknown")
  topic_title = topic.try(:title) || I18n.t("staff_action_logs.not_found")

  if opts[:permanent]
    details = []
  else
    details = [
      "id: #{deleted_post.id}",
      "created_at: #{deleted_post.created_at}",
      "user: #{username} (#{name})",
      "topic: #{topic_title}",
      "post_number: #{deleted_post.post_number}",
      "raw: #{truncate(deleted_post.raw)}",
    ]
  end

  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[opts[:permanent] ? :delete_post_permanently : :delete_post],
      post_id: deleted_post.id,
      details: details.join("\n"),
    ),
  )
end

#log_post_edit(post, opts = {}) ⇒ Object



184
185
186
187
188
189
190
191
192
193
# File 'app/services/staff_action_logger.rb', line 184

def log_post_edit(post, opts = {})
  raise Discourse::InvalidParameters.new(:post) unless post && post.is_a?(Post)
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:post_edit],
      post_id: post.id,
      details: "#{truncate(opts[:old_raw])}\n\n---\n\n#{truncate(post.raw)}",
    ),
  )
end

#log_post_lock(post, opts = {}) ⇒ Object



174
175
176
177
178
179
180
181
182
# File 'app/services/staff_action_logger.rb', line 174

def log_post_lock(post, opts = {})
  raise Discourse::InvalidParameters.new(:post) unless post && post.is_a?(Post)
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[opts[:locked] ? :post_locked : :post_unlocked],
      post_id: post.id,
    ),
  )
end

#log_post_rejected(reviewable, rejected_at, opts = {}) ⇒ Object



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
# File 'app/services/staff_action_logger.rb', line 813

def log_post_rejected(reviewable, rejected_at, opts = {})
  raise Discourse::InvalidParameters.new(:rejected_post) unless reviewable.is_a?(Reviewable)

  topic = reviewable.topic || Topic.with_deleted.find_by(id: reviewable.topic_id)
  topic_title = topic&.title || I18n.t("staff_action_logs.not_found")
  username = reviewable.target_created_by&.username || I18n.t("staff_action_logs.unknown")
  name = reviewable.target_created_by&.name || I18n.t("staff_action_logs.unknown")

  details = [
    "created_at: #{reviewable.created_at}",
    "rejected_at: #{rejected_at}",
    "user: #{username} (#{name})",
    "topic: #{topic_title}",
    "raw: #{truncate(reviewable.payload["raw"])}",
  ]

  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:post_rejected], details: details.join("\n")),
  )
end

#log_post_staff_note(post, opts = {}) ⇒ Object



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'app/services/staff_action_logger.rb', line 230

def log_post_staff_note(post, opts = {})
  raise Discourse::InvalidParameters.new(:post) unless post && post.is_a?(Post)

  args =
    params(opts).merge(
      action:
        UserHistory.actions[
          opts[:new_value].present? ? :post_staff_note_create : :post_staff_note_destroy
        ],
      post_id: post.id,
    )
  args[:new_value] = opts[:new_value] if opts[:new_value].present?
  args[:previous_value] = opts[:old_value] if opts[:old_value].present?

  UserHistory.create!(params(opts).merge(args))
end

#log_published_page(topic_id, slug) ⇒ Object



909
910
911
912
913
# File 'app/services/staff_action_logger.rb', line 909

def log_published_page(topic_id, slug)
  UserHistory.create!(
    params.merge(subject: slug, topic_id: topic_id, action: UserHistory.actions[:page_published]),
  )
end

#log_reset_bounce_score(user, opts = {}) ⇒ Object



1033
1034
1035
1036
1037
1038
1039
# File 'app/services/staff_action_logger.rb', line 1033

def log_reset_bounce_score(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user

  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:reset_bounce_score], target_user_id: user.id),
  )
end

#log_revoke_admin(user, opts = {}) ⇒ Object



678
679
680
681
682
683
# File 'app/services/staff_action_logger.rb', line 678

def log_revoke_admin(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:revoke_admin], target_user_id: user.id),
  )
end

#log_revoke_email(user, reason, opts = {}) ⇒ Object



740
741
742
743
744
745
746
747
748
# File 'app/services/staff_action_logger.rb', line 740

def log_revoke_email(user, reason, opts = {})
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:revoke_email],
      target_user_id: user.id,
      details: reason,
    ),
  )
end

#log_revoke_moderation(user, opts = {}) ⇒ Object



692
693
694
695
696
697
# File 'app/services/staff_action_logger.rb', line 692

def log_revoke_moderation(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:revoke_moderation], target_user_id: user.id),
  )
end

#log_roll_up(subnet, ips, opts = {}) ⇒ Object



556
557
558
559
560
561
562
563
# File 'app/services/staff_action_logger.rb', line 556

def log_roll_up(subnet, ips, opts = {})
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:roll_up],
      details: "#{subnet} from #{ips.join(", ")}",
    ),
  )
end

#log_show_emails(users, opts = {}) ⇒ Object



539
540
541
542
543
544
545
546
547
# File 'app/services/staff_action_logger.rb', line 539

def log_show_emails(users, opts = {})
  return if users.blank?
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:check_email],
      details: users.map { |u| "[#{u.id}] #{u.username}" }.join("\n"),
    ),
  )
end

#log_silence_user(user, opts = {}) ⇒ Object



640
641
642
643
644
645
646
647
648
649
650
651
652
# File 'app/services/staff_action_logger.rb', line 640

def log_silence_user(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user

  create_args =
    params(opts).merge(
      action: UserHistory.actions[:silence_user],
      target_user_id: user.id,
      details: opts[:details],
    )
  create_args[:post_id] = opts[:post_id] if opts[:post_id]

  UserHistory.create!(create_args)
end

#log_site_setting_change(setting_name, previous_value, new_value, opts = {}) ⇒ Object



247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'app/services/staff_action_logger.rb', line 247

def log_site_setting_change(setting_name, previous_value, new_value, opts = {})
  unless setting_name.present? && SiteSetting.respond_to?(setting_name)
    raise Discourse::InvalidParameters.new(:setting_name)
  end
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:change_site_setting],
      subject: setting_name,
      previous_value: previous_value&.to_s,
      new_value: new_value&.to_s,
    ),
  )
end

#log_site_text_change(subject, new_text = nil, old_text = nil, opts = {}) ⇒ Object



343
344
345
346
347
348
349
350
351
352
353
# File 'app/services/staff_action_logger.rb', line 343

def log_site_text_change(subject, new_text = nil, old_text = nil, opts = {})
  raise Discourse::InvalidParameters.new(:subject) if subject.blank?
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:change_site_text],
      subject: subject,
      previous_value: old_text,
      new_value: new_text,
    ),
  )
end

#log_tag_group_change(name, old_data, new_data) ⇒ Object



1073
1074
1075
1076
1077
1078
1079
1080
# File 'app/services/staff_action_logger.rb', line 1073

def log_tag_group_change(name, old_data, new_data)
  UserHistory.create!(
    params.merge(json_params(old_data, new_data)).merge(
      action: UserHistory.actions[:tag_group_change],
      subject: name,
    ),
  )
end

#log_tag_group_create(name, new_value, opts = {}) ⇒ Object



1055
1056
1057
1058
1059
1060
1061
1062
# File 'app/services/staff_action_logger.rb', line 1055

def log_tag_group_create(name, new_value, opts = {})
  UserHistory.create!(
    params(opts).merge(json_params(nil, new_value)).merge(
      action: UserHistory.actions[:tag_group_create],
      subject: name,
    ),
  )
end

#log_tag_group_destroy(name, old_value, opts = {}) ⇒ Object



1064
1065
1066
1067
1068
1069
1070
1071
# File 'app/services/staff_action_logger.rb', line 1064

def log_tag_group_destroy(name, old_value, opts = {})
  UserHistory.create!(
    params(opts).merge(json_params(old_value, nil)).merge(
      action: UserHistory.actions[:tag_group_destroy],
      subject: name,
    ),
  )
end

#log_theme_change(old_json, new_theme, opts = {}) ⇒ Object



283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'app/services/staff_action_logger.rb', line 283

def log_theme_change(old_json, new_theme, opts = {})
  raise Discourse::InvalidParameters.new(:new_theme) unless new_theme

  new_json = theme_json(new_theme)
  old_json, new_json = strip_duplicates(old_json, new_json)

  UserHistory.create!(
    params(opts).merge(json_params(old_json, new_json)).merge(
      action: UserHistory.actions[:change_theme],
      subject: new_theme.name,
    ),
  )
end

#log_theme_component_disabled(component) ⇒ Object



307
308
309
310
311
312
313
314
315
# File 'app/services/staff_action_logger.rb', line 307

def log_theme_component_disabled(component)
  UserHistory.create!(
    params.merge(
      action: UserHistory.actions[:disable_theme_component],
      subject: component.name,
      context: component.id,
    ),
  )
end

#log_theme_component_enabled(component) ⇒ Object



317
318
319
320
321
322
323
324
325
# File 'app/services/staff_action_logger.rb', line 317

def log_theme_component_enabled(component)
  UserHistory.create!(
    params.merge(
      action: UserHistory.actions[:enable_theme_component],
      subject: component.name,
      context: component.id,
    ),
  )
end

#log_theme_destroy(theme, opts = {}) ⇒ Object



297
298
299
300
301
302
303
304
305
# File 'app/services/staff_action_logger.rb', line 297

def log_theme_destroy(theme, opts = {})
  raise Discourse::InvalidParameters.new(:theme) unless theme
  UserHistory.create!(
    params(opts).merge(json_params(theme_json(theme), nil)).merge(
      action: UserHistory.actions[:delete_theme],
      subject: theme.name,
    ),
  )
end

#log_theme_setting_change(setting_name, previous_value, new_value, theme, opts = {}) ⇒ Object



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'app/services/staff_action_logger.rb', line 327

def log_theme_setting_change(setting_name, previous_value, new_value, theme, opts = {})
  raise Discourse::InvalidParameters.new(:theme) unless theme
  unless theme.cached_settings.has_key?(setting_name)
    raise Discourse::InvalidParameters.new(:setting_name)
  end

  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:change_theme_setting],
      subject: "#{theme.name}: #{setting_name}",
      previous_value: previous_value,
      new_value: new_value,
    ),
  )
end

#log_title_change(user, opts = {}) ⇒ Object



506
507
508
509
510
511
512
513
514
515
516
517
# File 'app/services/staff_action_logger.rb', line 506

def log_title_change(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:change_title],
      target_user_id: user.id,
      details: opts[:details],
      new_value: opts[:new_value],
      previous_value: opts[:previous_value],
    ),
  )
end

#log_title_revoke(user, opts = {}) ⇒ Object



494
495
496
497
498
499
500
501
502
503
504
# File 'app/services/staff_action_logger.rb', line 494

def log_title_revoke(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:revoke_title],
      target_user_id: user.id,
      details: opts[:revoke_reason],
      previous_value: opts[:previous_value],
    ),
  )
end

#log_topic_archived(topic, opts = {}) ⇒ Object



205
206
207
208
209
210
211
212
213
# File 'app/services/staff_action_logger.rb', line 205

def log_topic_archived(topic, opts = {})
  raise Discourse::InvalidParameters.new(:topic) unless topic && topic.is_a?(Topic)
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[opts[:archived] ? :topic_archived : :topic_unarchived],
      topic_id: topic.id,
    ),
  )
end

#log_topic_closed(topic, opts = {}) ⇒ Object



195
196
197
198
199
200
201
202
203
# File 'app/services/staff_action_logger.rb', line 195

def log_topic_closed(topic, opts = {})
  raise Discourse::InvalidParameters.new(:topic) unless topic && topic.is_a?(Topic)
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[opts[:closed] ? :topic_closed : :topic_opened],
      topic_id: topic.id,
    ),
  )
end

#log_topic_delete_recover(topic, action = "delete_topic", opts = {}) ⇒ Object



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'app/services/staff_action_logger.rb', line 99

def log_topic_delete_recover(topic, action = "delete_topic", opts = {})
  raise Discourse::InvalidParameters.new(:topic) unless topic && topic.is_a?(Topic)

  user = topic.user ? "#{topic.user.username} (#{topic.user.name})" : "(deleted user)"

  if action == "delete_topic_permanently"
    details = []
  else
    details = [
      "id: #{topic.id}",
      "created_at: #{topic.created_at}",
      "user: #{user}",
      "title: #{topic.title}",
    ]

    if first_post = topic.ordered_posts.with_deleted.first
      details << "raw: #{truncate(first_post.raw)}"
    end
  end

  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[action.to_sym],
      topic_id: topic.id,
      details: details.join("\n"),
    ),
  )
end

#log_topic_published(topic, opts = {}) ⇒ Object



155
156
157
158
159
160
# File 'app/services/staff_action_logger.rb', line 155

def log_topic_published(topic, opts = {})
  raise Discourse::InvalidParameters.new(:topic) unless topic && topic.is_a?(Topic)
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:topic_published], topic_id: topic.id),
  )
end

#log_topic_slow_mode(topic, opts = {}) ⇒ Object



215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'app/services/staff_action_logger.rb', line 215

def log_topic_slow_mode(topic, opts = {})
  raise Discourse::InvalidParameters.new(:topic) unless topic && topic.is_a?(Topic)

  details = opts[:enabled] ? ["interval: #{opts[:seconds]}", "until: #{opts[:until]}"] : []

  UserHistory.create!(
    params(opts).merge(
      action:
        UserHistory.actions[opts[:enabled] ? :topic_slow_mode_set : :topic_slow_mode_removed],
      topic_id: topic.id,
      details: details.join("\n"),
    ),
  )
end

#log_topic_timestamps_changed(topic, new_timestamp, previous_timestamp, opts = {}) ⇒ Object



162
163
164
165
166
167
168
169
170
171
172
# File 'app/services/staff_action_logger.rb', line 162

def log_topic_timestamps_changed(topic, new_timestamp, previous_timestamp, opts = {})
  raise Discourse::InvalidParameters.new(:topic) unless topic && topic.is_a?(Topic)
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:topic_timestamps_changed],
      topic_id: topic.id,
      new_value: new_timestamp,
      previous_value: previous_timestamp,
    ),
  )
end

#log_trust_level_change(user, old_trust_level, new_trust_level, opts = {}) ⇒ Object



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'app/services/staff_action_logger.rb', line 128

def log_trust_level_change(user, old_trust_level, new_trust_level, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user && user.is_a?(User)
  unless TrustLevel.valid? old_trust_level
    raise Discourse::InvalidParameters.new(:old_trust_level)
  end
  unless TrustLevel.valid? new_trust_level
    raise Discourse::InvalidParameters.new(:new_trust_level)
  end
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:change_trust_level],
      target_user_id: user.id,
      previous_value: old_trust_level,
      new_value: new_trust_level,
    ),
  )
end

#log_unpublished_page(topic_id, slug) ⇒ Object



915
916
917
918
919
920
921
922
923
# File 'app/services/staff_action_logger.rb', line 915

def log_unpublished_page(topic_id, slug)
  UserHistory.create!(
    params.merge(
      subject: slug,
      topic_id: topic_id,
      action: UserHistory.actions[:page_unpublished],
    ),
  )
end

#log_unsilence_user(user, opts = {}) ⇒ Object



654
655
656
657
658
659
# File 'app/services/staff_action_logger.rb', line 654

def log_unsilence_user(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:unsilence_user], target_user_id: user.id),
  )
end

#log_update_email(user) ⇒ Object



935
936
937
938
939
940
941
942
943
# File 'app/services/staff_action_logger.rb', line 935

def log_update_email(user)
  raise Discourse::InvalidParameters.new(:user) unless user

  UserHistory.create!(
    action: UserHistory.actions[:update_email],
    acting_user_id: @admin.id,
    target_user_id: user.id,
  )
end

#log_update_public_sidebar_section(section) ⇒ Object



1016
1017
1018
1019
1020
1021
1022
1023
# File 'app/services/staff_action_logger.rb', line 1016

def log_update_public_sidebar_section(section)
  UserHistory.create!(
    action: UserHistory.actions[:update_public_sidebar_section],
    acting_user_id: @admin.id,
    subject: section.title,
    details: custom_section_details(section),
  )
end

#log_user_activate(user, reason, opts = {}) ⇒ Object



767
768
769
770
771
772
773
774
775
776
# File 'app/services/staff_action_logger.rb', line 767

def log_user_activate(user, reason, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:activate_user],
      target_user_id: user.id,
      details: reason,
    ),
  )
end

#log_user_approve(user, opts = {}) ⇒ Object



750
751
752
753
754
# File 'app/services/staff_action_logger.rb', line 750

def log_user_approve(user, opts = {})
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:approve_user], target_user_id: user.id),
  )
end

#log_user_deactivate(user, reason, opts = {}) ⇒ Object



756
757
758
759
760
761
762
763
764
765
# File 'app/services/staff_action_logger.rb', line 756

def log_user_deactivate(user, reason, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:deactivate_user],
      target_user_id: user.id,
      details: reason,
    ),
  )
end

#log_user_deletion(deleted_user, opts = {}) ⇒ Object



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# File 'app/services/staff_action_logger.rb', line 16

def log_user_deletion(deleted_user, opts = {})
  unless deleted_user && deleted_user.is_a?(User)
    raise Discourse::InvalidParameters.new(:deleted_user)
  end

  details = USER_FIELDS.map { |x| "#{x}: #{deleted_user.public_send(x)}" }.join("\n")

  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:delete_user],
      ip_address: deleted_user.ip_address.to_s,
      details: details,
    ),
  )
end

#log_user_merge(user, source_username, source_email, opts = {}) ⇒ Object



401
402
403
404
405
406
407
408
409
410
411
# File 'app/services/staff_action_logger.rb', line 401

def log_user_merge(user, source_username, source_email, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:merge_user],
      target_user_id: user.id,
      context: I18n.t("staff_action_logs.user_merged", username: source_username),
      email: source_email,
    ),
  )
end

#log_user_suspend(user, reason, opts = {}) ⇒ Object



379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'app/services/staff_action_logger.rb', line 379

def log_user_suspend(user, reason, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user

  details = StaffMessageFormat.new(:suspend, reason, opts[:message]).format

  args =
    params(opts).merge(
      action: UserHistory.actions[:suspend_user],
      target_user_id: user.id,
      details: details,
    )
  args[:post_id] = opts[:post_id] if opts[:post_id]
  UserHistory.create!(args)
end

#log_user_unsuspend(user, opts = {}) ⇒ Object



394
395
396
397
398
399
# File 'app/services/staff_action_logger.rb', line 394

def log_user_unsuspend(user, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:unsuspend_user], target_user_id: user.id),
  )
end

#log_username_change(user, old_username, new_username, opts = {}) ⇒ Object



355
356
357
358
359
360
361
362
363
364
365
# File 'app/services/staff_action_logger.rb', line 355

def log_username_change(user, old_username, new_username, opts = {})
  raise Discourse::InvalidParameters.new(:user) unless user
  UserHistory.create!(
    params(opts).merge(
      action: UserHistory.actions[:change_username],
      target_user_id: user.id,
      previous_value: old_username,
      new_value: new_username,
    ),
  )
end

#log_watched_words_creation(watched_word) ⇒ Object



955
956
957
958
959
960
961
962
963
964
965
966
967
# File 'app/services/staff_action_logger.rb', line 955

def log_watched_words_creation(watched_word)
  raise Discourse::InvalidParameters.new(:watched_word) unless watched_word

  action_key = :watched_word_create
  action_key = :create_watched_word_group if watched_word.is_a?(WatchedWordGroup)

  UserHistory.create!(
    action: UserHistory.actions[action_key],
    acting_user_id: @admin.id,
    details: watched_word.action_log_details,
    context: WatchedWord.actions[watched_word.action],
  )
end

#log_watched_words_deletion(watched_word) ⇒ Object



969
970
971
972
973
974
975
976
977
978
979
980
981
# File 'app/services/staff_action_logger.rb', line 969

def log_watched_words_deletion(watched_word)
  raise Discourse::InvalidParameters.new(:watched_word) unless watched_word

  action_key = :watched_word_destroy
  action_key = :delete_watched_word_group if watched_word.is_a?(WatchedWordGroup)

  UserHistory.create!(
    action: UserHistory.actions[action_key],
    acting_user_id: @admin.id,
    details: watched_word.action_log_details,
    context: WatchedWord.actions[watched_word.action],
  )
end

#log_web_hook(web_hook, action, opts = {}) ⇒ Object



834
835
836
837
838
839
840
841
842
843
844
845
846
847
# File 'app/services/staff_action_logger.rb', line 834

def log_web_hook(web_hook, action, opts = {})
  details = ["webhook_id: #{web_hook.id}", "payload_url: #{web_hook.payload_url}"]

  old_values, new_values = get_changes(opts[:changes])

  UserHistory.create!(
    params(opts).merge(
      action: action,
      context: details.join(", "),
      previous_value: old_values&.join(", "),
      new_value: new_values&.join(", "),
    ),
  )
end

#log_web_hook_deactivate(web_hook, response_http_status, opts = {}) ⇒ Object



849
850
851
852
853
854
855
856
857
858
859
860
# File 'app/services/staff_action_logger.rb', line 849

def log_web_hook_deactivate(web_hook, response_http_status, opts = {})
  context = ["webhook_id: #{web_hook.id}", "webhook_response_status: #{response_http_status}"]

  UserHistory.create!(
    params.merge(
      action: UserHistory.actions[:web_hook_deactivate],
      context: context,
      details:
        I18n.t("staff_action_logs.webhook_deactivation_reason", status: response_http_status),
    ),
  )
end

#log_wizard_step(step, opts = {}) ⇒ Object



778
779
780
781
782
783
# File 'app/services/staff_action_logger.rb', line 778

def log_wizard_step(step, opts = {})
  raise Discourse::InvalidParameters.new(:step) unless step
  UserHistory.create!(
    params(opts).merge(action: UserHistory.actions[:wizard_step], context: step.id),
  )
end

#strip_duplicates(old, cur) ⇒ Object



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'app/services/staff_action_logger.rb', line 265

def strip_duplicates(old, cur)
  return old, cur unless old && cur

  old = JSON.parse(old)
  cur = JSON.parse(cur)

  old.each do |k, v|
    next if k == "name"
    next if k == "id"
    if (v == cur[k])
      cur.delete(k)
      old.delete(k)
    end
  end

  [old.to_json, cur.to_json]
end

#theme_json(theme) ⇒ Object



261
262
263
# File 'app/services/staff_action_logger.rb', line 261

def theme_json(theme)
  ThemeSerializer.new(theme, root: false, include_theme_field_values: true).to_json
end