Module: SiteSettingExtension

Includes:
HasSanitizableFields, SiteSettings::DeprecatedSettings
Included in:
SiteSetting
Defined in:
lib/site_setting_extension.rb

Constant Summary

Constants included from SiteSettings::DeprecatedSettings

SiteSettings::DeprecatedSettings::SETTINGS

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HasSanitizableFields

#sanitize_field

Methods included from SiteSettings::DeprecatedSettings

#setup_deprecated_methods

Class Method Details

.client_settings_cache_key ⇒ Object 



229
230
231
232
233
234
 
# File 'lib/site_setting_extension.rb', line 229

def self.client_settings_cache_key
  # NOTE: we use the git version in the key to ensure
  # that we don't end up caching the incorrect version
  # in cases where we are cycling unicorns
  "client_settings_json_#{Discourse.git_version}"
end

.extended(klass) ⇒ Object

support default_locale being set via global settings this also adds support for testing the extension and global settings for site locale



10
11
12
13
14
15
 
# File 'lib/site_setting_extension.rb', line 10

def self.extended(klass)
  if GlobalSetting.respond_to?(:default_locale) && GlobalSetting.default_locale.present?
    # protected
    klass.send :setup_shadowed_methods, :default_locale, GlobalSetting.default_locale
  end
end

Instance Method Details

#add_override!(name, val) ⇒ Object 



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/site_setting_extension.rb', line 316

def add_override!(name, val)
  old_val = current[name]
  val, type = type_supervisor.to_db_value(name, val)

  sanitize_override = val.is_a?(String) && client_settings.include?(name)

  sanitized_val = sanitize_override ? sanitize_field(val) : val
  provider.save(name, sanitized_val, type)
  current[name] = type_supervisor.to_rb_value(name, sanitized_val)

  return if current[name] == old_val

  clear_uploads_cache(name)
  notify_clients!(name) if client_settings.include? name
  clear_cache!
  if old_val != current[name]
    DiscourseEvent.trigger(:site_setting_changed, name, old_val, current[name])
  end
end

#after_fork ⇒ Object 



297
298
299
300
 
# File 'lib/site_setting_extension.rb', line 297

def after_fork
  @process_id = nil
  ensure_listen_for_changes
end

#all_settings(include_hidden: false) ⇒ Object

Retrieve all settings



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
 
# File 'lib/site_setting_extension.rb', line 169

def all_settings(include_hidden: false)
  locale_setting_hash = {
    setting: "default_locale",
    default: SiteSettings::DefaultsProvider::DEFAULT_LOCALE,
    category: "required",
    description: description("default_locale"),
    type: SiteSetting.types[SiteSetting.types[:enum]],
    preview: nil,
    value: self.default_locale,
    valid_values: LocaleSiteSetting.values,
    translate_names: LocaleSiteSetting.translate_names?,
  }

  defaults
    .all(default_locale)
    .reject do |setting_name, _|
      plugins[name] && !Discourse.plugins_by_name[plugins[name]].configurable?
    end
    .reject { |setting_name, _| !include_hidden && hidden_settings.include?(setting_name) }
    .map do |s, v|
      type_hash = type_supervisor.type_hash(s)
      default = defaults.get(s, default_locale).to_s

      value = public_send(s)
      value = value.map(&:to_s).join("|") if type_hash[:type].to_s == "uploaded_image_list"

      if type_hash[:type].to_s == "upload" && default.to_i < Upload::SEEDED_ID_THRESHOLD
        default = default_uploads[default.to_i]
      end

      opts = {
        setting: s,
        description: description(s),
        default: default,
        value: value.to_s,
        category: categories[s],
        preview: previews[s],
        secret: secret_settings.include?(s),
        placeholder: placeholder(s),
      }.merge!(type_hash)

      opts[:plugin] = plugins[s] if plugins[s]

      opts
    end
    .unshift(locale_setting_hash)
end

#categories ⇒ Object 



86
87
88
 
# File 'lib/site_setting_extension.rb', line 86

def categories
  @categories ||= {}
end

#client_settings ⇒ Object 



102
103
104
 
# File 'lib/site_setting_extension.rb', line 102

def client_settings
  @client_settings ||= [:default_locale]
end

#client_settings_json ⇒ Object 



143
144
145
146
147
148
149
 
# File 'lib/site_setting_extension.rb', line 143

def client_settings_json
  Discourse
    .cache
    .fetch(SiteSettingExtension.client_settings_cache_key, expires_in: 30.minutes) do
      client_settings_json_uncached
    end
end

#client_settings_json_uncached ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/site_setting_extension.rb', line 151

def client_settings_json_uncached
  MultiJson.dump(
    Hash[
      *@client_settings
        .map do |name|
          value = self.public_send(name)
          type = type_supervisor.get_type(name)
          value = value.to_s if type == :upload
          value = value.map(&:to_s).join("|") if type == :uploaded_image_list

          [name, value]
        end
        .flatten
    ],
  )
end

#current ⇒ Object 



73
74
75
76
 
# File 'lib/site_setting_extension.rb', line 73

def current
  @containers ||= {}
  @containers[provider.current_site] ||= {}
end

#default_locale ⇒ Object

set up some sort of default so we can look stuff up



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/site_setting_extension.rb', line 33

def default_locale
  # note optimised cause this is called a lot so avoiding .presence which
  # adds 2 method calls
  locale = current[:default_locale]
  if locale && !locale.blank?
    locale
  else
    SiteSettings::DefaultsProvider::DEFAULT_LOCALE
  end
end

#default_locale=(val) ⇒ Object

we need a default here to support defaults per locale

Raises:



18
19
20
21
22
23
24
25
26
 
# File 'lib/site_setting_extension.rb', line 18

def default_locale=(val)
  val = val.to_s
  raise Discourse::InvalidParameters.new(:value) unless LocaleSiteSetting.valid_value?(val)
  if val != self.default_locale
    add_override!(:default_locale, val)
    refresh!
    Discourse.request_refresh!
  end
end

#default_locale? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/site_setting_extension.rb', line 28

def default_locale?
  true
end

#defaults ⇒ Object 



78
79
80
 
# File 'lib/site_setting_extension.rb', line 78

def defaults
  @defaults ||= SiteSettings::DefaultsProvider.new(self)
end

#description(setting) ⇒ Object 



217
218
219
 
# File 'lib/site_setting_extension.rb', line 217

def description(setting)
  I18n.t("site_settings.#{setting}", base_path: Discourse.base_path)
end

#ensure_listen_for_changes ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/site_setting_extension.rb', line 272

def ensure_listen_for_changes
  return if @listen_for_changes == false

  unless @subscribed
    MessageBus.subscribe("/site_settings") do |message|
      process_message(message) if message.data["process"] != process_id
    end

    @subscribed = true
  end
end

#filter_value(name, value) ⇒ Object 



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/site_setting_extension.rb', line 357

def filter_value(name, value)
  if HOSTNAME_SETTINGS.include?(name)
    value
      .split("|")
      .map do |url|
        url.strip!
        get_hostname(url)
      end
      .compact
      .uniq
      .join("|")
  else
    value
  end
end

#get(name) ⇒ Object 



402
403
404
405
406
407
408
409
410
 
# File 'lib/site_setting_extension.rb', line 402

def get(name)
  if has_setting?(name)
    self.public_send(name)
  else
    raise Discourse::InvalidParameters.new(
            I18n.t("errors.site_settings.invalid_site_setting", name: name),
          )
  end
end

#has_setting?(v) ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/site_setting_extension.rb', line 44

def has_setting?(v)
  defaults.has_setting?(v)
end

#hidden_settings ⇒ Object 



94
95
96
 
# File 'lib/site_setting_extension.rb', line 94

def hidden_settings
  @hidden_settings ||= []
end

#info(name) ⇒ Object

Convenience method for debugging site setting issues Returns a hash with information about a specific setting



415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/site_setting_extension.rb', line 415

def info(name)
  {
    resolved_value: get(name),
    default_value: defaults[name],
    global_override: GlobalSetting.respond_to?(name) ? GlobalSetting.public_send(name) : nil,
    database_value: provider.find(name)&.value,
    refresh?: refresh_settings.include?(name),
    client?: client_settings.include?(name),
    secret?: secret_settings.include?(name),
  }
end

#listen_for_changes=(val) ⇒ Object 



56
57
58
 
# File 'lib/site_setting_extension.rb', line 56

def listen_for_changes=(val)
  @listen_for_changes = val
end

#load_settings(file, plugin: nil) ⇒ Object 



118
119
120
121
122
123
124
 
# File 'lib/site_setting_extension.rb', line 118

def load_settings(file, plugin: nil)
  SiteSettings::YamlLoader
    .new(file)
    .load do |category, name, default, opts|
      setting(name, default, opts.merge(category: category, plugin: plugin))
    end
end

#mutex ⇒ Object 



69
70
71
 
# File 'lib/site_setting_extension.rb', line 69

def mutex
  @mutex ||= Mutex.new
end

#notify_changed! ⇒ Object 



336
337
338
 
# File 'lib/site_setting_extension.rb', line 336

def notify_changed!
  MessageBus.publish("/site_settings", process: process_id)
end

#notify_clients!(name) ⇒ Object 



340
341
342
 
# File 'lib/site_setting_extension.rb', line 340

def notify_clients!(name)
  MessageBus.publish("/client_settings", name: name, value: self.public_send(name))
end

#placeholder(setting) ⇒ Object 



221
222
223
224
225
226
227
 
# File 'lib/site_setting_extension.rb', line 221

def placeholder(setting)
  if !I18n.t("site_settings.placeholder.#{setting}", default: "").empty?
    I18n.t("site_settings.placeholder.#{setting}")
  elsif SiteIconManager.respond_to?("#{setting}_url")
    SiteIconManager.public_send("#{setting}_url")
  end
end

#plugins ⇒ Object 



114
115
116
 
# File 'lib/site_setting_extension.rb', line 114

def plugins
  @plugins ||= {}
end

#previews ⇒ Object 



106
107
108
 
# File 'lib/site_setting_extension.rb', line 106

def previews
  @previews ||= {}
end

#process_id ⇒ Object 



293
294
295
 
# File 'lib/site_setting_extension.rb', line 293

def process_id
  @process_id ||= SecureRandom.uuid
end

#process_message(message) ⇒ Object 



284
285
286
287
288
289
290
291
 
# File 'lib/site_setting_extension.rb', line 284

def process_message(message)
  begin
    MessageBus.on_connect.call(message.site_id)
    refresh!
  ensure
    MessageBus.on_disconnect.call(message.site_id)
  end
end

#provider ⇒ Object 



65
66
67
 
# File 'lib/site_setting_extension.rb', line 65

def provider
  @provider ||= SiteSettings::DbProvider.new(SiteSetting)
end

#provider=(val) ⇒ Object 



60
61
62
63
 
# File 'lib/site_setting_extension.rb', line 60

def provider=(val)
  @provider = val
  refresh!
end

#refresh! ⇒ Object

refresh all the site settings



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/site_setting_extension.rb', line 237

def refresh!
  mutex.synchronize do
    ensure_listen_for_changes

    new_hash =
      Hash[
        *(
          defaults
            .db_all
            .map do |s|
              [s.name.to_sym, type_supervisor.to_rb_value(s.name, s.value, s.data_type)]
            end
            .to_a
            .flatten
        )
      ]

    defaults_view = defaults.all(new_hash[:default_locale])

    # add locale default and defaults based on default_locale, cause they are cached
    new_hash = defaults_view.merge!(new_hash)

    # add shadowed
    shadowed_settings.each { |ss| new_hash[ss] = GlobalSetting.public_send(ss) }

    changes, deletions = diff_hash(new_hash, current)

    changes.each { |name, val| current[name] = val }
    deletions.each { |name, _| current[name] = defaults_view[name] }
    uploads.clear

    clear_cache!
  end
end

#refresh_settings ⇒ Object 



98
99
100
 
# File 'lib/site_setting_extension.rb', line 98

def refresh_settings
  @refresh_settings ||= [:default_locale]
end

#remove_override!(name) ⇒ Object 



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/site_setting_extension.rb', line 302

def remove_override!(name)
  old_val = current[name]
  provider.destroy(name)
  current[name] = defaults.get(name, default_locale)

  return if current[name] == old_val

  clear_uploads_cache(name)
  clear_cache!
  if old_val != current[name]
    DiscourseEvent.trigger(:site_setting_changed, name, old_val, current[name])
  end
end

#requires_refresh?(name) ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/site_setting_extension.rb', line 344

def requires_refresh?(name)
  refresh_settings.include?(name.to_sym)
end

#secret_settings ⇒ Object 



110
111
112
 
# File 'lib/site_setting_extension.rb', line 110

def secret_settings
  @secret_settings ||= []
end

#set(name, value, options = nil) ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/site_setting_extension.rb', line 373

def set(name, value, options = nil)
  if has_setting?(name)
    value = filter_value(name, value)
    if options
      self.public_send("#{name}=", value, options)
    else
      self.public_send("#{name}=", value)
    end
    Discourse.request_refresh! if requires_refresh?(name)
  else
    raise Discourse::InvalidParameters.new(
            "Either no setting named '#{name}' exists or value provided is invalid",
          )
  end
end

#set_and_log(name, value, user = Discourse.system_user) ⇒ Object 



389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/site_setting_extension.rb', line 389

def set_and_log(name, value, user = Discourse.system_user)
  if has_setting?(name)
    prev_value = public_send(name)
    set(name, value)
    value = prev_value = "[FILTERED]" if secret_settings.include?(name.to_sym)
    StaffActionLogger.new(user).log_site_setting_change(name, prev_value, value)
  else
    raise Discourse::InvalidParameters.new(
            I18n.t("errors.site_settings.invalid_site_setting", name: name),
          )
  end
end

#settings_hash ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/site_setting_extension.rb', line 126

def settings_hash
  result = {}
  deprecated_settings = Set.new

  SiteSettings::DeprecatedSettings::SETTINGS.each { |s| deprecated_settings << s[0] }

  defaults.all.keys.each do |s|
    result[s] = if deprecated_settings.include?(s.to_s)
      public_send(s, warn: false).to_s
    else
      public_send(s).to_s
    end
  end

  result
end

#shadowed_settings ⇒ Object 



90
91
92
 
# File 'lib/site_setting_extension.rb', line 90

def shadowed_settings
  @shadowed_settings ||= []
end

#supported_types ⇒ Object 



48
49
50
 
# File 'lib/site_setting_extension.rb', line 48

def supported_types
  SiteSettings::TypeSupervisor.supported_types
end

#type_supervisor ⇒ Object 



82
83
84
 
# File 'lib/site_setting_extension.rb', line 82

def type_supervisor
  @type_supervisor ||= SiteSettings::TypeSupervisor.new(defaults)
end

#types ⇒ Object 



52
53
54
 
# File 'lib/site_setting_extension.rb', line 52

def types
  SiteSettings::TypeSupervisor.types
end