Class: UserHistory

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/user_history.rb

Overview

UserHistory stores information about actions that users have taken, like deleting users, changing site settings, dismissing notifications, etc. Use other classes, like StaffActionLogger, to log records to this table.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.actions ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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
98
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
127
128
 
# File 'app/models/user_history.rb', line 20

def self.actions
  @actions ||=
    Enum.new(
      delete_user: 1,
      change_trust_level: 2,
      change_site_setting: 3,
      change_theme: 4,
      delete_theme: 5,
      checked_for_custom_avatar: 6, # not used anymore
      notified_about_avatar: 7,
      notified_about_sequential_replies: 8,
      notified_about_dominating_topic: 9,
      suspend_user: 10,
      unsuspend_user: 11,
      facebook_no_email: 12, # not used anymore
      grant_badge: 13,
      revoke_badge: 14,
      auto_trust_level_change: 15,
      check_email: 16,
      delete_post: 17,
      delete_topic: 18,
      impersonate: 19,
      roll_up: 20,
      change_username: 21,
      custom: 22,
      custom_staff: 23,
      anonymize_user: 24,
      reviewed_post: 25,
      change_category_settings: 26,
      delete_category: 27,
      create_category: 28,
      change_site_text: 29,
      silence_user: 30,
      unsilence_user: 31,
      grant_admin: 32,
      revoke_admin: 33,
      grant_moderation: 34,
      revoke_moderation: 35,
      backup_create: 36,
      rate_limited_like: 37, # not used anymore
      revoke_email: 38,
      deactivate_user: 39,
      wizard_step: 40,
      lock_trust_level: 41,
      unlock_trust_level: 42,
      activate_user: 43,
      change_readonly_mode: 44,
      backup_download: 45,
      backup_destroy: 46,
      notified_about_get_a_room: 47,
      change_name: 48,
      post_locked: 49,
      post_unlocked: 50,
      check_personal_message: 51,
      disabled_second_factor: 52,
      post_edit: 53,
      topic_published: 54,
      recover_topic: 55,
      post_approved: 56,
      create_badge: 57,
      change_badge: 58,
      delete_badge: 59,
      removed_silence_user: 60,
      removed_suspend_user: 61,
      removed_unsilence_user: 62,
      removed_unsuspend_user: 63,
      post_rejected: 64,
      merge_user: 65,
      entity_export: 66,
      change_password: 67,
      topic_timestamps_changed: 68,
      approve_user: 69,
      web_hook_create: 70,
      web_hook_update: 71,
      web_hook_destroy: 72,
      embeddable_host_create: 73,
      embeddable_host_update: 74,
      embeddable_host_destroy: 75,
      web_hook_deactivate: 76,
      change_theme_setting: 77,
      disable_theme_component: 78,
      enable_theme_component: 79,
      api_key_create: 80,
      api_key_update: 81,
      api_key_destroy: 82,
      revoke_title: 83,
      change_title: 84,
      override_upload_secure_status: 85,
      page_published: 86,
      page_unpublished: 87,
      add_email: 88,
      update_email: 89,
      destroy_email: 90,
      topic_closed: 91,
      topic_opened: 92,
      topic_archived: 93,
      topic_unarchived: 94,
      post_staff_note_create: 95,
      post_staff_note_destroy: 96,
      watched_word_create: 97,
      watched_word_destroy: 98,
      delete_group: 99,
      permanently_delete_post_revisions: 100,
      create_public_sidebar_section: 101,
      update_public_sidebar_section: 102,
      destroy_public_sidebar_section: 103,
      reset_bounce_score: 104,
    )
end

.admin_only_action_ids ⇒ Object 



239
240
241
 
# File 'app/models/user_history.rb', line 239

def self.admin_only_action_ids
  @admin_only_action_ids ||= [actions[:change_site_setting]]
end

.exists_for_user?(user, action_type, opts = nil) ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
264
265
266
 
# File 'app/models/user_history.rb', line 261

def self.exists_for_user?(user, action_type, opts = nil)
  opts = opts || {}
  result = self.where(target_user_id: user.id, action: UserHistory.actions[action_type])
  result = result.where(topic_id: opts[:topic_id]) if opts[:topic_id]
  result.exists?
end

.for(user, action_type) ⇒ Object 



257
258
259
 
# File 'app/models/user_history.rb', line 257

def self.for(user, action_type)
  self.where(target_user_id: user.id, action: UserHistory.actions[action_type])
end

.staff_action_ids ⇒ Object 



235
236
237
 
# File 'app/models/user_history.rb', line 235

def self.staff_action_ids
  @staff_action_ids ||= staff_actions.map { |a| actions[a] }
end

.staff_action_records(viewer, opts = nil) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'app/models/user_history.rb', line 272

def self.staff_action_records(viewer, opts = nil)
  opts ||= {}
  custom_staff = opts[:action_id].to_i == actions[:custom_staff]

  if custom_staff
    opts[:custom_type] = opts[:action_name]
  else
    opts[:action_id] = self.actions[opts[:action_name].to_sym] if opts[:action_name]
  end

  query =
    self
      .with_filters(opts.slice(*staff_filters))
      .only_staff_actions
      .order("id DESC")
      .includes(:acting_user, :target_user)
  query = query.where(admin_only: false) unless viewer && viewer.admin?
  query
end

.staff_actions ⇒ Object

Staff actions is a subset of all actions, used to audit actions taken by staff users.



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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'app/models/user_history.rb', line 131

def self.staff_actions
  @staff_actions ||= %i[
    delete_user
    change_trust_level
    change_site_setting
    change_theme
    delete_theme
    change_site_text
    suspend_user
    unsuspend_user
    removed_suspend_user
    removed_unsuspend_user
    grant_badge
    revoke_badge
    check_email
    delete_post
    delete_topic
    impersonate
    roll_up
    change_username
    custom_staff
    anonymize_user
    reviewed_post
    change_category_settings
    delete_category
    create_category
    silence_user
    unsilence_user
    removed_silence_user
    removed_unsilence_user
    grant_admin
    revoke_admin
    grant_moderation
    revoke_moderation
    backup_create
    revoke_email
    deactivate_user
    lock_trust_level
    unlock_trust_level
    activate_user
    change_readonly_mode
    backup_download
    backup_destroy
    post_locked
    post_unlocked
    check_personal_message
    disabled_second_factor
    post_edit
    topic_published
    recover_topic
    post_approved
    create_badge
    change_badge
    delete_badge
    post_rejected
    merge_user
    entity_export
    change_name
    topic_timestamps_changed
    approve_user
    web_hook_create
    web_hook_update
    web_hook_destroy
    web_hook_deactivate
    embeddable_host_create
    embeddable_host_update
    embeddable_host_destroy
    change_theme_setting
    disable_theme_component
    enable_theme_component
    revoke_title
    change_title
    api_key_create
    api_key_update
    api_key_destroy
    override_upload_secure_status
    page_published
    page_unpublished
    add_email
    update_email
    destroy_email
    topic_closed
    topic_opened
    topic_archived
    topic_unarchived
    post_staff_note_create
    post_staff_note_destroy
    watched_word_create
    watched_word_destroy
    delete_group
    permanently_delete_post_revisions
    create_public_sidebar_section
    update_public_sidebar_section
    destroy_public_sidebar_section
    reset_bounce_score
    update_directory_columns
    deleted_unused_tags
    renamed_tag
    deleted_tag
    chat_channel_status_change
    chat_auto_remove_membership
  ]
end

.staff_filters ⇒ Object 



268
269
270
 
# File 'app/models/user_history.rb', line 268

def self.staff_filters
  %i[action_id custom_type acting_user target_user subject action_name]
end

.with_filters(filters) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'app/models/user_history.rb', line 243

def self.with_filters(filters)
  query = self
  query = query.where(action: filters[:action_id]) if filters[:action_id].present?
  query = query.where(custom_type: filters[:custom_type]) if filters[:custom_type].present?

  %i[acting_user target_user].each do |key|
    if filters[key] && (obj_id = User.where(username_lower: filters[key].downcase).pluck(:id))
      query = query.where("#{key}_id = ?", obj_id)
    end
  end
  query = query.where("subject = ?", filters[:subject]) if filters[:subject]
  query
end

Instance Method Details

#new_value_is_json? ⇒ Boolean

Returns:

  • (Boolean) 


297
298
299
 
# File 'app/models/user_history.rb', line 297

def new_value_is_json?
  [UserHistory.actions[:change_theme], UserHistory.actions[:delete_theme]].include?(action)
end

#previous_value_is_json? ⇒ Boolean

Returns:

  • (Boolean) 


301
302
303
 
# File 'app/models/user_history.rb', line 301

def previous_value_is_json?
  new_value_is_json?
end

#set_admin_only ⇒ Object 



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

def set_admin_only
  self.admin_only = UserHistory.admin_only_action_ids.include?(self.action)
  self
end