3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 use Wikimedia\ObjectFactory
;
24 * A cache class that directs writes to one set of servers and reads to
25 * another. This assumes that the servers used for reads are setup to replica DB
26 * those that writes go to. This can easily be used with redis for example.
28 * In the WAN scenario (e.g. multi-datacenter case), this is useful when
29 * writes are rare or they usually take place in the primary datacenter.
34 class ReplicatedBagOStuff
extends BagOStuff
{
36 protected $writeStore;
41 * Constructor. Parameters are:
42 * - writeFactory : ObjectFactory::getObjectFromSpec array yeilding BagOStuff.
43 * This object will be used for writes (e.g. the master DB).
44 * - readFactory : ObjectFactory::getObjectFromSpec array yeilding BagOStuff.
45 * This object will be used for reads (e.g. a replica DB).
47 * @param array $params
48 * @throws InvalidArgumentException
50 public function __construct( $params ) {
51 parent
::__construct( $params );
53 if ( !isset( $params['writeFactory'] ) ) {
54 throw new InvalidArgumentException(
55 __METHOD__
. ': the "writeFactory" parameter is required' );
57 if ( !isset( $params['readFactory'] ) ) {
58 throw new InvalidArgumentException(
59 __METHOD__
. ': the "readFactory" parameter is required' );
62 $opts = [ 'reportDupes' => false ]; // redundant
63 $this->writeStore
= ( $params['writeFactory'] instanceof BagOStuff
)
64 ?
$params['writeFactory']
65 : ObjectFactory
::getObjectFromSpec( $opts +
$params['writeFactory'] );
66 $this->readStore
= ( $params['readFactory'] instanceof BagOStuff
)
67 ?
$params['readFactory']
68 : ObjectFactory
::getObjectFromSpec( $opts +
$params['readFactory'] );
69 $this->attrMap
= $this->mergeFlagMaps( [ $this->readStore
, $this->writeStore
] );
72 public function setDebug( $debug ) {
73 $this->writeStore
->setDebug( $debug );
74 $this->readStore
->setDebug( $debug );
77 public function get( $key, $flags = 0 ) {
78 return ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
79 ?
$this->writeStore
->get( $key, $flags )
80 : $this->readStore
->get( $key, $flags );
83 public function set( $key, $value, $exptime = 0, $flags = 0 ) {
84 return $this->writeStore
->set( $key, $value, $exptime, $flags );
87 public function delete( $key, $flags = 0 ) {
88 return $this->writeStore
->delete( $key, $flags );
91 public function add( $key, $value, $exptime = 0, $flags = 0 ) {
92 return $this->writeStore
->add( $key, $value, $exptime, $flags );
95 public function merge( $key, callable
$callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
96 return $this->writeStore
->merge( $key, $callback, $exptime, $attempts, $flags );
99 public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
100 return $this->writeStore
->changeTTL( $key, $exptime, $flags );
103 public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
104 return $this->writeStore
->lock( $key, $timeout, $expiry, $rclass );
107 public function unlock( $key ) {
108 return $this->writeStore
->unlock( $key );
111 public function deleteObjectsExpiringBefore( $date, $progressCallback = false, $limit = INF
) {
112 return $this->writeStore
->deleteObjectsExpiringBefore( $date, $progressCallback );
115 public function getMulti( array $keys, $flags = 0 ) {
116 return ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
117 ?
$this->writeStore
->getMulti( $keys, $flags )
118 : $this->readStore
->getMulti( $keys, $flags );
121 public function setMulti( array $data, $exptime = 0, $flags = 0 ) {
122 return $this->writeStore
->setMulti( $data, $exptime, $flags );
125 public function deleteMulti( array $keys, $flags = 0 ) {
126 return $this->writeStore
->deleteMulti( $keys, $flags );
129 public function incr( $key, $value = 1 ) {
130 return $this->writeStore
->incr( $key, $value );
133 public function decr( $key, $value = 1 ) {
134 return $this->writeStore
->decr( $key, $value );
137 public function incrWithInit( $key, $ttl, $value = 1, $init = 1 ) {
138 return $this->writeStore
->incrWithInit( $key, $ttl, $value, $init );
141 public function getLastError() {
142 return ( $this->writeStore
->getLastError() != self
::ERR_NONE
)
143 ?
$this->writeStore
->getLastError()
144 : $this->readStore
->getLastError();
147 public function clearLastError() {
148 $this->writeStore
->clearLastError();
149 $this->readStore
->clearLastError();
152 public function makeKeyInternal( $keyspace, $args ) {
153 return $this->writeStore
->makeKeyInternal( ...func_get_args() );
156 public function makeKey( $class, $component = null ) {
157 return $this->writeStore
->makeKey( ...func_get_args() );
160 public function makeGlobalKey( $class, $component = null ) {
161 return $this->writeStore
->makeGlobalKey( ...func_get_args() );
164 protected function doGet( $key, $flags = 0, &$casToken = null ) {
165 throw new LogicException( __METHOD__
. ': proxy class does not need this method.' );
168 protected function doSet( $key, $value, $exptime = 0, $flags = 0 ) {
169 throw new LogicException( __METHOD__
. ': proxy class does not need this method.' );
172 protected function doDelete( $key, $flags = 0 ) {
173 throw new LogicException( __METHOD__
. ': proxy class does not need this method.' );
176 protected function doGetMulti( array $keys, $flags = 0 ) {
177 throw new LogicException( __METHOD__
. ': proxy class does not need this method.' );
180 protected function serialize( $value ) {
181 throw new LogicException( __METHOD__
. ': proxy class does not need this method.' );
184 protected function unserialize( $blob ) {
185 throw new LogicException( __METHOD__
. ': proxy class does not need this method.' );