includes/libs/objectcache/MemcachedPeclBagOStuff.php

   1 <?php
   2 /**
   3  * Object caching using memcached.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23
  24 /**
  25  * A wrapper class for the PECL memcached client
  26  *
  27  * @ingroup Cache
  28  */
  29 class MemcachedPeclBagOStuff extends MemcachedBagOStuff {
  30
  31         /**
  32          * Constructor
  33          *
  34          * Available parameters are:
  35          *   - servers:             The list of IP:port combinations holding the memcached servers.
  36          *   - persistent:          Whether to use a persistent connection
  37          *   - compress_threshold:  The minimum size an object must be before it is compressed
  38          *   - timeout:             The read timeout in microseconds
  39          *   - connect_timeout:     The connect timeout in seconds
  40          *   - retry_timeout:       Time in seconds to wait before retrying a failed connect attempt
  41          *   - server_failure_limit:  Limit for server connect failures before it is removed
  42          *   - serializer:          May be either "php" or "igbinary". Igbinary produces more compact
  43          *                          values, but serialization is much slower unless the php.ini option
  44          *                          igbinary.compact_strings is off.
  45          *   - use_binary_protocol  Whether to enable the binary protocol (default is ASCII) (boolean)
  46          * @param array $params
  47          * @throws InvalidArgumentException
  48          */
  49         function __construct( $params ) {
  50                 parent::__construct( $params );
  51                 $params = $this->applyDefaultParams( $params );
  52
  53                 if ( $params['persistent'] ) {
  54                         // The pool ID must be unique to the server/option combination.
  55                         // The Memcached object is essentially shared for each pool ID.
  56                         // We can only reuse a pool ID if we keep the config consistent.
  57                         $this->client = new Memcached( md5( serialize( $params ) ) );
  58                         if ( count( $this->client->getServerList() ) ) {
  59                                 $this->logger->debug( __METHOD__ . ": persistent Memcached object already loaded." );
  60                                 return; // already initialized; don't add duplicate servers
  61                         }
  62                 } else {
  63                         $this->client = new Memcached;
  64                 }
  65
  66                 if ( $params['use_binary_protocol'] ) {
  67                         $this->client->setOption( Memcached::OPT_BINARY_PROTOCOL, true );
  68                 }
  69
  70                 if ( isset( $params['retry_timeout'] ) ) {
  71                         $this->client->setOption( Memcached::OPT_RETRY_TIMEOUT, $params['retry_timeout'] );
  72                 }
  73
  74                 if ( isset( $params['server_failure_limit'] ) ) {
  75                         $this->client->setOption( Memcached::OPT_SERVER_FAILURE_LIMIT, $params['server_failure_limit'] );
  76                 }
  77
  78                 // The compression threshold is an undocumented php.ini option for some
  79                 // reason. There's probably not much harm in setting it globally, for
  80                 // compatibility with the settings for the PHP client.
  81                 ini_set( 'memcached.compression_threshold', $params['compress_threshold'] );
  82
  83                 // Set timeouts
  84                 $this->client->setOption( Memcached::OPT_CONNECT_TIMEOUT, $params['connect_timeout'] * 1000 );
  85                 $this->client->setOption( Memcached::OPT_SEND_TIMEOUT, $params['timeout'] );
  86                 $this->client->setOption( Memcached::OPT_RECV_TIMEOUT, $params['timeout'] );
  87                 $this->client->setOption( Memcached::OPT_POLL_TIMEOUT, $params['timeout'] / 1000 );
  88
  89                 // Set libketama mode since it's recommended by the documentation and
  90                 // is as good as any. There's no way to configure libmemcached to use
  91                 // hashes identical to the ones currently in use by the PHP client, and
  92                 // even implementing one of the libmemcached hashes in pure PHP for
  93                 // forwards compatibility would require MemcachedClient::get_sock() to be
  94                 // rewritten.
  95                 $this->client->setOption( Memcached::OPT_LIBKETAMA_COMPATIBLE, true );
  96
  97                 // Set the serializer
  98                 switch ( $params['serializer'] ) {
  99                         case 'php':
 100                                 $this->client->setOption( Memcached::OPT_SERIALIZER, Memcached::SERIALIZER_PHP );
 101                                 break;
 102                         case 'igbinary':
 103                                 if ( !Memcached::HAVE_IGBINARY ) {
 104                                         throw new InvalidArgumentException(
 105                                                 __CLASS__ . ': the igbinary extension is not available ' .
 106                                                 'but igbinary serialization was requested.'
 107                                         );
 108                                 }
 109                                 $this->client->setOption( Memcached::OPT_SERIALIZER, Memcached::SERIALIZER_IGBINARY );
 110                                 break;
 111                         default:
 112                                 throw new InvalidArgumentException(
 113                                         __CLASS__ . ': invalid value for serializer parameter'
 114                                 );
 115                 }
 116                 $servers = [];
 117                 foreach ( $params['servers'] as $host ) {
 118                         if ( preg_match( '/^\[(.+)\]:(\d+)$/', $host, $m ) ) {
 119                                 $servers[] = [ $m[1], (int)$m[2] ]; // (ip, port)
 120                         } elseif ( preg_match( '/^([^:]+):(\d+)$/', $host, $m ) ) {
 121                                 $servers[] = [ $m[1], (int)$m[2] ]; // (ip or path, port)
 122                         } else {
 123                                 $servers[] = [ $host, false ]; // (ip or path, port)
 124                         }
 125                 }
 126                 $this->client->addServers( $servers );
 127         }
 128
 129         protected function applyDefaultParams( $params ) {
 130                 $params = parent::applyDefaultParams( $params );
 131
 132                 if ( !isset( $params['use_binary_protocol'] ) ) {
 133                         $params['use_binary_protocol'] = false;
 134                 }
 135
 136                 if ( !isset( $params['serializer'] ) ) {
 137                         $params['serializer'] = 'php';
 138                 }
 139
 140                 return $params;
 141         }
 142
 143         protected function getWithToken( $key, &$casToken, $flags = 0 ) {
 144                 $this->debugLog( "get($key)" );
 145                 $result = $this->client->get( $this->validateKeyEncoding( $key ), null, $casToken );
 146                 $result = $this->checkResult( $key, $result );
 147                 return $result;
 148         }
 149
 150         public function set( $key, $value, $exptime = 0, $flags = 0 ) {
 151                 $this->debugLog( "set($key)" );
 152                 $result = parent::set( $key, $value, $exptime );
 153                 if ( $result === false && $this->client->getResultCode() === Memcached::RES_NOTSTORED ) {
 154                         // "Not stored" is always used as the mcrouter response with AllAsyncRoute
 155                         return true;
 156                 }
 157                 return $this->checkResult( $key, $result );
 158         }
 159
 160         protected function cas( $casToken, $key, $value, $exptime = 0 ) {
 161                 $this->debugLog( "cas($key)" );
 162                 return $this->checkResult( $key, parent::cas( $casToken, $key, $value, $exptime ) );
 163         }
 164
 165         public function delete( $key ) {
 166                 $this->debugLog( "delete($key)" );
 167                 $result = parent::delete( $key );
 168                 if ( $result === false && $this->client->getResultCode() === Memcached::RES_NOTFOUND ) {
 169                         // "Not found" is counted as success in our interface
 170                         return true;
 171                 }
 172                 return $this->checkResult( $key, $result );
 173         }
 174
 175         public function add( $key, $value, $exptime = 0 ) {
 176                 $this->debugLog( "add($key)" );
 177                 return $this->checkResult( $key, parent::add( $key, $value, $exptime ) );
 178         }
 179
 180         public function incr( $key, $value = 1 ) {
 181                 $this->debugLog( "incr($key)" );
 182                 $result = $this->client->increment( $key, $value );
 183                 return $this->checkResult( $key, $result );
 184         }
 185
 186         public function decr( $key, $value = 1 ) {
 187                 $this->debugLog( "decr($key)" );
 188                 $result = $this->client->decrement( $key, $value );
 189                 return $this->checkResult( $key, $result );
 190         }
 191
 192         /**
 193          * Check the return value from a client method call and take any necessary
 194          * action. Returns the value that the wrapper function should return. At
 195          * present, the return value is always the same as the return value from
 196          * the client, but some day we might find a case where it should be
 197          * different.
 198          *
 199          * @param string $key The key used by the caller, or false if there wasn't one.
 200          * @param mixed $result The return value
 201          * @return mixed
 202          */
 203         protected function checkResult( $key, $result ) {
 204                 if ( $result !== false ) {
 205                         return $result;
 206                 }
 207                 switch ( $this->client->getResultCode() ) {
 208                         case Memcached::RES_SUCCESS:
 209                                 break;
 210                         case Memcached::RES_DATA_EXISTS:
 211                         case Memcached::RES_NOTSTORED:
 212                         case Memcached::RES_NOTFOUND:
 213                                 $this->debugLog( "result: " . $this->client->getResultMessage() );
 214                                 break;
 215                         default:
 216                                 $msg = $this->client->getResultMessage();
 217                                 $logCtx = [];
 218                                 if ( $key !== false ) {
 219                                         $server = $this->client->getServerByKey( $key );
 220                                         $logCtx['memcached-server'] = "{$server['host']}:{$server['port']}";
 221                                         $logCtx['memcached-key'] = $key;
 222                                         $msg = "Memcached error for key \"{memcached-key}\" on server \"{memcached-server}\": $msg";
 223                                 } else {
 224                                         $msg = "Memcached error: $msg";
 225                                 }
 226                                 $this->logger->error( $msg, $logCtx );
 227                                 $this->setLastError( BagOStuff::ERR_UNEXPECTED );
 228                 }
 229                 return $result;
 230         }
 231
 232         public function getMulti( array $keys, $flags = 0 ) {
 233                 $this->debugLog( 'getMulti(' . implode( ', ', $keys ) . ')' );
 234                 foreach ( $keys as $key ) {
 235                         $this->validateKeyEncoding( $key );
 236                 }
 237                 $result = $this->client->getMulti( $keys ) ?: [];
 238                 return $this->checkResult( false, $result );
 239         }
 240
 241         /**
 242          * @param array $data
 243          * @param int $exptime
 244          * @return bool
 245          */
 246         public function setMulti( array $data, $exptime = 0 ) {
 247                 $this->debugLog( 'setMulti(' . implode( ', ', array_keys( $data ) ) . ')' );
 248                 foreach ( array_keys( $data ) as $key ) {
 249                         $this->validateKeyEncoding( $key );
 250                 }
 251                 $result = $this->client->setMulti( $data, $this->fixExpiry( $exptime ) );
 252                 return $this->checkResult( false, $result );
 253         }
 254
 255         public function changeTTL( $key, $expiry = 0 ) {
 256                 $this->debugLog( "touch($key)" );
 257                 $result = $this->client->touch( $key, $expiry );
 258                 return $this->checkResult( $key, $result );
 259         }
 260 }