Class: GlobalSetting

Inherits:
Object
  • Object
show all
Defined in:
app/models/global_setting.rb

Defined Under Namespace

Classes: BaseProvider, BlankProvider, EnvProvider, FileProvider

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.providerObject

Returns the value of attribute provider.



332
333
334
# File 'app/models/global_setting.rb', line 332

def provider
  @provider
end

Class Method Details

.add_default(name, default) ⇒ Object



244
245
246
# File 'app/models/global_setting.rb', line 244

def self.add_default(name, default)
  define_singleton_method(name) { default } unless self.respond_to? name
end

.cdn_hostnamesObject



115
116
117
118
119
120
# File 'app/models/global_setting.rb', line 115

def self.cdn_hostnames
  hostnames = []
  hostnames << URI.parse(cdn_url).host if cdn_url.present?
  hostnames << cdn_origin_hostname if cdn_origin_hostname.present?
  hostnames
end

.configure!Object



335
336
337
338
339
340
341
342
343
# File 'app/models/global_setting.rb', line 335

def self.configure!
  if Rails.env == "test"
    @provider = BlankProvider.new
  else
    @provider =
      FileProvider.from(File.expand_path("../../../config/discourse.conf", __FILE__)) ||
        EnvProvider.new
  end
end

.database_configObject



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
# File 'app/models/global_setting.rb', line 122

def self.database_config
  hash = { "adapter" => "postgresql" }

  %w[
    pool
    connect_timeout
    socket
    host
    backup_host
    port
    backup_port
    username
    password
    replica_host
    replica_port
  ].each do |s|
    if val = self.public_send("db_#{s}")
      hash[s] = val
    end
  end

  hostnames = [hostname]
  hostnames << backup_hostname if backup_hostname.present?

  hostnames << URI.parse(cdn_url).host if cdn_url.present?
  hostnames << cdn_origin_hostname if cdn_origin_hostname.present?

  hash["host_names"] = hostnames
  hash["database"] = db_name
  hash["prepared_statements"] = !!self.db_prepared_statements
  hash["idle_timeout"] = connection_reaper_age if connection_reaper_age.present?
  hash["reaping_frequency"] = connection_reaper_interval if connection_reaper_interval.present?
  hash["advisory_locks"] = !!self.db_advisory_locks

  db_variables = provider.keys.filter { |k| k.to_s.starts_with? "db_variables_" }
  if db_variables.length > 0
    hash["variables"] = {}
    db_variables.each do |k|
      hash["variables"][k.slice(("db_variables_".length)..)] = self.public_send(k)
    end
  end

  { "production" => hash }
end

.get_message_bus_redis_replica_hostObject



183
184
185
186
187
188
# File 'app/models/global_setting.rb', line 183

def self.get_message_bus_redis_replica_host
  return message_bus_redis_replica_host if message_bus_redis_replica_host.present?
  if respond_to?(:message_bus_redis_slave_host) && message_bus_redis_slave_host.present?
    message_bus_redis_slave_host
  end
end

.get_message_bus_redis_replica_portObject



190
191
192
193
194
195
# File 'app/models/global_setting.rb', line 190

def self.get_message_bus_redis_replica_port
  return message_bus_redis_replica_port if message_bus_redis_replica_port.present?
  if respond_to?(:message_bus_redis_slave_port) && message_bus_redis_slave_port.present?
    message_bus_redis_slave_port
  end
end

.get_redis_replica_hostObject



173
174
175
176
# File 'app/models/global_setting.rb', line 173

def self.get_redis_replica_host
  return redis_replica_host if redis_replica_host.present?
  redis_slave_host if respond_to?(:redis_slave_host) && redis_slave_host.present?
end

.get_redis_replica_portObject



178
179
180
181
# File 'app/models/global_setting.rb', line 178

def self.get_redis_replica_port
  return redis_replica_port if redis_replica_port.present?
  redis_slave_port if respond_to?(:redis_slave_port) && redis_slave_port.present?
end

.load_defaultsObject



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'app/models/global_setting.rb', line 52

def self.load_defaults
  default_provider =
    FileProvider.from(File.expand_path("../../../config/discourse_defaults.conf", __FILE__))
  default_provider
    .keys
    .concat(@provider.keys)
    .uniq
    .each do |key|
      default = default_provider.lookup(key, nil)

      instance_variable_set("@#{key}_cache", nil)

      define_singleton_method(key) do
        val = instance_variable_get("@#{key}_cache")
        if val.nil?
          val = provider.lookup(key, default)
          val = :missing if val.nil?
          instance_variable_set("@#{key}_cache", val)
        end
        val == :missing ? nil : val
      end
    end
end

.load_plugins?Boolean

Returns:

  • (Boolean)


345
346
347
348
349
350
351
352
353
354
355
# File 'app/models/global_setting.rb', line 345

def self.load_plugins?
  if ENV["LOAD_PLUGINS"] == "1"
    true
  elsif ENV["LOAD_PLUGINS"] == "0"
    false
  elsif Rails.env.test?
    false
  else
    true
  end
end

.message_bus_redis_configObject



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'app/models/global_setting.rb', line 220

def self.message_bus_redis_config
  return redis_config unless message_bus_redis_enabled
  @message_bus_config ||=
    begin
      c = {}
      c[:host] = message_bus_redis_host if message_bus_redis_host
      c[:port] = message_bus_redis_port if message_bus_redis_port

      if get_message_bus_redis_replica_host && get_message_bus_redis_replica_port
        c[:replica_host] = get_message_bus_redis_replica_host
        c[:replica_port] = get_message_bus_redis_replica_port
        c[:connector] = RailsFailover::Redis::Connector
      end

      c[:password] = message_bus_redis_password if message_bus_redis_password.present?
      c[:db] = message_bus_redis_db if message_bus_redis_db != 0
      c[:db] = 1 if Rails.env == "test"
      c[:id] = nil if message_bus_redis_skip_client_commands
      c[:ssl] = true if redis_use_ssl

      c.freeze
    end
end

.redis_configObject



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'app/models/global_setting.rb', line 197

def self.redis_config
  @config ||=
    begin
      c = {}
      c[:host] = redis_host if redis_host
      c[:port] = redis_port if redis_port

      if get_redis_replica_host && get_redis_replica_port && defined?(RailsFailover)
        c[:replica_host] = get_redis_replica_host
        c[:replica_port] = get_redis_replica_port
        c[:connector] = RailsFailover::Redis::Connector
      end

      c[:password] = redis_password if redis_password.present?
      c[:db] = redis_db if redis_db != 0
      c[:db] = 1 if Rails.env == "test"
      c[:id] = nil if redis_skip_client_commands
      c[:ssl] = true if redis_use_ssl

      c.freeze
    end
end

.register(key, default) ⇒ Object



4
5
6
# File 'app/models/global_setting.rb', line 4

def self.register(key, default)
  define_singleton_method(key) { provider.lookup(key, default) }
end

.reset_redis_config!Object

For testing purposes



168
169
170
171
# File 'app/models/global_setting.rb', line 168

def self.reset_redis_config!
  @config = nil
  @message_bus_config = nil
end

.reset_s3_cache!Object

for testing



111
112
113
# File 'app/models/global_setting.rb', line 111

def self.reset_s3_cache!
  @use_s3 = nil
end

.s3_bucket_nameObject



106
107
108
# File 'app/models/global_setting.rb', line 106

def self.s3_bucket_name
  @s3_bucket_name ||= s3_bucket.downcase.split("/")[0]
end

.safe_secret_key_baseObject

In Rails secret_key_base is used to encrypt the cookie store the cookie store contains session data Discourse also uses this secret key to digest user auth tokens This method will

  • use existing token if already set in ENV or discourse.conf

  • generate a token on the fly if needed and cache in redis

  • enforce rules about token format falling back to redis if needed



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
# File 'app/models/global_setting.rb', line 22

def self.safe_secret_key_base
  if @safe_secret_key_base && @token_in_redis &&
       (@token_last_validated + REDIS_VALIDATE_SECONDS) < Time.now
    @token_last_validated = Time.now
    token = Discourse.redis.without_namespace.get(REDIS_SECRET_KEY)
    Discourse.redis.without_namespace.set(REDIS_SECRET_KEY, @safe_secret_key_base) if token.nil?
  end

  @safe_secret_key_base ||=
    begin
      token = secret_key_base
      if token.blank? || token !~ VALID_SECRET_KEY
        @token_in_redis = true
        @token_last_validated = Time.now

        token = Discourse.redis.without_namespace.get(REDIS_SECRET_KEY)
        unless token && token =~ VALID_SECRET_KEY
          token = SecureRandom.hex(64)
          Discourse.redis.without_namespace.set(REDIS_SECRET_KEY, token)
        end
      end
      if !secret_key_base.blank? && token != secret_key_base
        STDERR.puts "WARNING: DISCOURSE_SECRET_KEY_BASE is invalid, it was re-generated"
      end
      token
    end
rescue Redis::CommandError => e
  @safe_secret_key_base = SecureRandom.hex(64) if e.message =~ /READONLY/
end

.skip_db=(v) ⇒ Object



76
77
78
# File 'app/models/global_setting.rb', line 76

def self.skip_db=(v)
  @skip_db = v
end

.skip_db?Boolean

Returns:

  • (Boolean)


80
81
82
# File 'app/models/global_setting.rb', line 80

def self.skip_db?
  @skip_db
end

.skip_redis=(v) ⇒ Object



84
85
86
# File 'app/models/global_setting.rb', line 84

def self.skip_redis=(v)
  @skip_redis = v
end

.skip_redis?Boolean

Returns:

  • (Boolean)


88
89
90
# File 'app/models/global_setting.rb', line 88

def self.skip_redis?
  @skip_redis
end

.use_s3?Boolean

Returns:

  • (Boolean)


92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'app/models/global_setting.rb', line 92

def self.use_s3?
  (
    @use_s3 ||=
      begin
        if s3_bucket && s3_region &&
             (s3_use_iam_profile || (s3_access_key_id && s3_secret_access_key))
          :true
        else
          :false
        end
      end
  ) == :true
end