2019-05-02 18:17:27 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2013-02-05 14:16:51 -05:00
|
|
|
#
|
|
|
|
# A wrapper around redis that namespaces keys with the current site id
|
|
|
|
#
|
2017-10-05 03:57:08 -04:00
|
|
|
|
2013-02-05 14:16:51 -05:00
|
|
|
class DiscourseRedis
|
2013-03-25 02:19:59 -04:00
|
|
|
def self.raw_connection(config = nil)
|
|
|
|
config ||= self.config
|
2015-06-25 02:51:48 -04:00
|
|
|
Redis.new(config)
|
2013-03-25 02:19:59 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def self.config
|
2015-06-25 02:51:48 -04:00
|
|
|
GlobalSetting.redis_config
|
2013-03-25 02:19:59 -04:00
|
|
|
end
|
|
|
|
|
2017-08-02 01:32:01 -04:00
|
|
|
def initialize(config = nil, namespace: true)
|
2015-04-24 13:10:43 -04:00
|
|
|
@config = config || DiscourseRedis.config
|
2019-10-20 18:59:24 -04:00
|
|
|
@redis = DiscourseRedis.raw_connection(@config.dup)
|
2017-08-02 01:32:01 -04:00
|
|
|
@namespace = namespace
|
2013-02-05 14:16:51 -05:00
|
|
|
end
|
|
|
|
|
2013-12-20 16:34:34 -05:00
|
|
|
def without_namespace
|
|
|
|
# Only use this if you want to store and fetch data that's shared between sites
|
|
|
|
@redis
|
|
|
|
end
|
|
|
|
|
2015-04-24 13:10:43 -04:00
|
|
|
def self.ignore_readonly
|
|
|
|
yield
|
|
|
|
rescue Redis::CommandError => ex
|
|
|
|
if ex.message =~ /READONLY/
|
2019-06-21 10:08:57 -04:00
|
|
|
Discourse.received_redis_readonly!
|
2017-10-24 22:19:43 -04:00
|
|
|
nil
|
2015-04-24 13:10:43 -04:00
|
|
|
else
|
|
|
|
raise ex
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2013-02-05 14:16:51 -05:00
|
|
|
# prefix the key with the namespace
|
2021-09-27 22:11:18 -04:00
|
|
|
def method_missing(meth, *args, **kwargs, &block)
|
2013-02-05 14:16:51 -05:00
|
|
|
if @redis.respond_to?(meth)
|
2021-10-06 10:42:04 -04:00
|
|
|
DiscourseRedis.ignore_readonly { @redis.public_send(meth, *args, **kwargs, &block) }
|
2013-02-05 14:16:51 -05:00
|
|
|
else
|
|
|
|
super
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Proxy key methods through, but prefix the keys with the namespace
|
2020-06-10 02:52:05 -04:00
|
|
|
[:append, :blpop, :brpop, :brpoplpush, :decr, :decrby, :expire, :expireat, :get, :getbit, :getrange, :getset,
|
2013-05-05 19:51:09 -04:00
|
|
|
:hdel, :hexists, :hget, :hgetall, :hincrby, :hincrbyfloat, :hkeys, :hlen, :hmget, :hmset, :hset, :hsetnx, :hvals, :incr,
|
2013-12-31 15:52:16 -05:00
|
|
|
:incrby, :incrbyfloat, :lindex, :linsert, :llen, :lpop, :lpush, :lpushx, :lrange, :lrem, :lset, :ltrim,
|
2015-09-28 02:38:52 -04:00
|
|
|
:mapped_hmset, :mapped_hmget, :mapped_mget, :mapped_mset, :mapped_msetnx, :move, :mset,
|
2013-05-05 19:51:09 -04:00
|
|
|
:msetnx, :persist, :pexpire, :pexpireat, :psetex, :pttl, :rename, :renamenx, :rpop, :rpoplpush, :rpush, :rpushx, :sadd, :scard,
|
|
|
|
:sdiff, :set, :setbit, :setex, :setnx, :setrange, :sinter, :sismember, :smembers, :sort, :spop, :srandmember, :srem, :strlen,
|
|
|
|
:sunion, :ttl, :type, :watch, :zadd, :zcard, :zcount, :zincrby, :zrange, :zrangebyscore, :zrank, :zrem, :zremrangebyrank,
|
2021-12-10 15:25:26 -05:00
|
|
|
:zremrangebyscore, :zrevrange, :zrevrangebyscore, :zrevrank, :zrangebyscore,
|
|
|
|
:dump, :restore].each do |m|
|
2021-09-27 22:11:18 -04:00
|
|
|
define_method m do |*args, **kwargs|
|
2017-08-02 01:32:01 -04:00
|
|
|
args[0] = "#{namespace}:#{args[0]}" if @namespace
|
2021-09-27 22:11:18 -04:00
|
|
|
DiscourseRedis.ignore_readonly { @redis.public_send(m, *args, **kwargs) }
|
2013-02-09 18:02:29 -05:00
|
|
|
end
|
2013-02-05 14:16:51 -05:00
|
|
|
end
|
|
|
|
|
2020-06-14 21:57:44 -04:00
|
|
|
def exists(*args)
|
|
|
|
args.map! { |a| "#{namespace}:#{a}" } if @namespace
|
|
|
|
DiscourseRedis.ignore_readonly { @redis.exists(*args) }
|
|
|
|
end
|
2020-06-10 02:52:05 -04:00
|
|
|
|
2020-06-14 21:57:44 -04:00
|
|
|
def exists?(*args)
|
|
|
|
args.map! { |a| "#{namespace}:#{a}" } if @namespace
|
|
|
|
DiscourseRedis.ignore_readonly { @redis.exists?(*args) }
|
2020-06-10 02:52:05 -04:00
|
|
|
end
|
|
|
|
|
2015-09-28 02:38:52 -04:00
|
|
|
def mget(*args)
|
2017-08-02 01:32:01 -04:00
|
|
|
args.map! { |a| "#{namespace}:#{a}" } if @namespace
|
2015-09-28 02:38:52 -04:00
|
|
|
DiscourseRedis.ignore_readonly { @redis.mget(*args) }
|
|
|
|
end
|
|
|
|
|
2014-01-06 00:50:04 -05:00
|
|
|
def del(k)
|
2015-04-24 13:10:43 -04:00
|
|
|
DiscourseRedis.ignore_readonly do
|
2017-08-02 01:32:01 -04:00
|
|
|
k = "#{namespace}:#{k}" if @namespace
|
2015-04-24 13:10:43 -04:00
|
|
|
@redis.del k
|
|
|
|
end
|
2014-01-06 00:50:04 -05:00
|
|
|
end
|
|
|
|
|
2018-12-14 19:53:52 -05:00
|
|
|
def scan_each(options = {}, &block)
|
|
|
|
DiscourseRedis.ignore_readonly do
|
|
|
|
match = options[:match].presence || '*'
|
|
|
|
|
|
|
|
options[:match] =
|
|
|
|
if @namespace
|
|
|
|
"#{namespace}:#{match}"
|
|
|
|
else
|
|
|
|
match
|
|
|
|
end
|
|
|
|
|
|
|
|
if block
|
2021-09-27 08:45:05 -04:00
|
|
|
@redis.scan_each(**options) do |key|
|
2018-12-14 19:53:52 -05:00
|
|
|
key = remove_namespace(key) if @namespace
|
|
|
|
block.call(key)
|
|
|
|
end
|
|
|
|
else
|
2021-09-27 08:45:05 -04:00
|
|
|
@redis.scan_each(**options).map do |key|
|
2018-12-14 19:53:52 -05:00
|
|
|
key = remove_namespace(key) if @namespace
|
|
|
|
key
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-01-29 11:44:51 -05:00
|
|
|
def keys(pattern = nil)
|
2015-04-24 13:10:43 -04:00
|
|
|
DiscourseRedis.ignore_readonly do
|
2017-08-02 01:32:01 -04:00
|
|
|
pattern = pattern || '*'
|
|
|
|
pattern = "#{namespace}:#{pattern}" if @namespace
|
|
|
|
keys = @redis.keys(pattern)
|
|
|
|
|
|
|
|
if @namespace
|
|
|
|
len = namespace.length + 1
|
|
|
|
keys.map! { |k| k[len..-1] }
|
|
|
|
end
|
|
|
|
|
|
|
|
keys
|
2015-04-24 13:10:43 -04:00
|
|
|
end
|
2014-01-06 00:50:04 -05:00
|
|
|
end
|
|
|
|
|
2015-02-02 12:44:21 -05:00
|
|
|
def delete_prefixed(prefix)
|
2015-04-24 13:10:43 -04:00
|
|
|
DiscourseRedis.ignore_readonly do
|
2019-12-03 04:05:53 -05:00
|
|
|
keys("#{prefix}*").each { |k| Discourse.redis.del(k) }
|
2015-04-24 13:10:43 -04:00
|
|
|
end
|
2015-02-02 12:44:21 -05:00
|
|
|
end
|
|
|
|
|
2014-01-06 00:50:04 -05:00
|
|
|
def reconnect
|
2018-04-20 01:01:17 -04:00
|
|
|
@redis._client.reconnect
|
2014-01-06 00:50:04 -05:00
|
|
|
end
|
|
|
|
|
2017-10-24 22:19:43 -04:00
|
|
|
def namespace_key(key)
|
|
|
|
if @namespace
|
|
|
|
"#{namespace}:#{key}"
|
|
|
|
else
|
|
|
|
key
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-05-05 19:53:10 -04:00
|
|
|
def namespace
|
|
|
|
RailsMultisite::ConnectionManagement.current_db
|
|
|
|
end
|
|
|
|
|
2013-02-05 14:16:51 -05:00
|
|
|
def self.namespace
|
2015-05-05 19:53:10 -04:00
|
|
|
Rails.logger.warn("DiscourseRedis.namespace is going to be deprecated, do not use it!")
|
2013-02-05 14:16:51 -05:00
|
|
|
RailsMultisite::ConnectionManagement.current_db
|
|
|
|
end
|
|
|
|
|
2013-03-11 08:33:20 -04:00
|
|
|
def self.new_redis_store
|
2014-01-06 00:50:04 -05:00
|
|
|
Cache.new
|
2013-03-11 08:33:20 -04:00
|
|
|
end
|
|
|
|
|
2018-12-14 19:53:52 -05:00
|
|
|
private
|
|
|
|
|
|
|
|
def remove_namespace(key)
|
|
|
|
key[(namespace.length + 1)..-1]
|
|
|
|
end
|
2020-01-23 17:20:17 -05:00
|
|
|
|
2013-02-05 14:16:51 -05:00
|
|
|
end
|