'MediumSpecificBagOStuff' => __DIR__ . '/includes/libs/objectcache/MediumSpecificBagOStuff.php',
'MemcLockManager' => __DIR__ . '/includes/libs/lockmanager/MemcLockManager.php',
'MemcachedBagOStuff' => __DIR__ . '/includes/libs/objectcache/MemcachedBagOStuff.php',
- 'MemcachedClient' => __DIR__ . '/includes/libs/objectcache/MemcachedClient.php',
+ 'MemcachedClient' => __DIR__ . '/includes/libs/objectcache/utils/MemcachedClient.php',
'MemcachedPeclBagOStuff' => __DIR__ . '/includes/libs/objectcache/MemcachedPeclBagOStuff.php',
'MemcachedPhpBagOStuff' => __DIR__ . '/includes/libs/objectcache/MemcachedPhpBagOStuff.php',
'MemoizedCallable' => __DIR__ . '/includes/libs/MemoizedCallable.php',
+++ /dev/null
-<?php
-// phpcs:ignoreFile -- It's an external lib and it isn't. Let's not bother.
-/**
- * Memcached client for PHP.
- *
- * +---------------------------------------------------------------------------+
- * | memcached client, PHP |
- * +---------------------------------------------------------------------------+
- * | Copyright (c) 2003 Ryan T. Dean <rtdean@cytherianage.net> |
- * | All rights reserved. |
- * | |
- * | Redistribution and use in source and binary forms, with or without |
- * | modification, are permitted provided that the following conditions |
- * | are met: |
- * | |
- * | 1. Redistributions of source code must retain the above copyright |
- * | notice, this list of conditions and the following disclaimer. |
- * | 2. Redistributions in binary form must reproduce the above copyright |
- * | notice, this list of conditions and the following disclaimer in the |
- * | documentation and/or other materials provided with the distribution. |
- * | |
- * | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
- * | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
- * | OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
- * | IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
- * | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
- * | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
- * | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
- * | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
- * | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
- * | THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
- * +---------------------------------------------------------------------------+
- * | Author: Ryan T. Dean <rtdean@cytherianage.net> |
- * | Heavily influenced by the Perl memcached client by Brad Fitzpatrick. |
- * | Permission granted by Brad Fitzpatrick for relicense of ported Perl |
- * | client logic under 2-clause BSD license. |
- * +---------------------------------------------------------------------------+
- *
- * @file
- * $TCAnet$
- */
-
-/**
- * This is a PHP client for memcached - a distributed memory cache daemon.
- *
- * More information is available at http://www.danga.com/memcached/
- *
- * Usage example:
- *
- * $mc = new MemcachedClient(array(
- * 'servers' => array(
- * '127.0.0.1:10000',
- * array( '192.0.0.1:10010', 2 ),
- * '127.0.0.1:10020'
- * ),
- * 'debug' => false,
- * 'compress_threshold' => 10240,
- * 'persistent' => true
- * ));
- *
- * $mc->add( 'key', array( 'some', 'array' ) );
- * $mc->replace( 'key', 'some random string' );
- * $val = $mc->get( 'key' );
- *
- * @author Ryan T. Dean <rtdean@cytherianage.net>
- * @version 0.1.2
- */
-
-use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
-
-// {{{ class MemcachedClient
-/**
- * memcached client class implemented using (p)fsockopen()
- *
- * @author Ryan T. Dean <rtdean@cytherianage.net>
- * @ingroup Cache
- */
-class MemcachedClient {
- // {{{ properties
- // {{{ public
-
- // {{{ constants
- // {{{ flags
-
- /**
- * Flag: indicates data is serialized
- */
- const SERIALIZED = 1;
-
- /**
- * Flag: indicates data is compressed
- */
- const COMPRESSED = 2;
-
- /**
- * Flag: indicates data is an integer
- */
- const INTVAL = 4;
-
- // }}}
-
- /**
- * Minimum savings to store data compressed
- */
- const COMPRESSION_SAVINGS = 0.20;
-
- // }}}
-
- /**
- * Command statistics
- *
- * @var array
- * @access public
- */
- public $stats;
-
- // }}}
- // {{{ private
-
- /**
- * Cached Sockets that are connected
- *
- * @var array
- * @access private
- */
- public $_cache_sock;
-
- /**
- * Current debug status; 0 - none to 9 - profiling
- *
- * @var bool
- * @access private
- */
- public $_debug;
-
- /**
- * Dead hosts, assoc array, 'host'=>'unixtime when ok to check again'
- *
- * @var array
- * @access private
- */
- public $_host_dead;
-
- /**
- * Is compression available?
- *
- * @var bool
- * @access private
- */
- public $_have_zlib;
-
- /**
- * Do we want to use compression?
- *
- * @var bool
- * @access private
- */
- public $_compress_enable;
-
- /**
- * At how many bytes should we compress?
- *
- * @var int
- * @access private
- */
- public $_compress_threshold;
-
- /**
- * Are we using persistent links?
- *
- * @var bool
- * @access private
- */
- public $_persistent;
-
- /**
- * If only using one server; contains ip:port to connect to
- *
- * @var string
- * @access private
- */
- public $_single_sock;
-
- /**
- * Array containing ip:port or array(ip:port, weight)
- *
- * @var array
- * @access private
- */
- public $_servers;
-
- /**
- * Our bit buckets
- *
- * @var array
- * @access private
- */
- public $_buckets;
-
- /**
- * Total # of bit buckets we have
- *
- * @var int
- * @access private
- */
- public $_bucketcount;
-
- /**
- * # of total servers we have
- *
- * @var int
- * @access private
- */
- public $_active;
-
- /**
- * Stream timeout in seconds. Applies for example to fread()
- *
- * @var int
- * @access private
- */
- public $_timeout_seconds;
-
- /**
- * Stream timeout in microseconds
- *
- * @var int
- * @access private
- */
- public $_timeout_microseconds;
-
- /**
- * Connect timeout in seconds
- */
- public $_connect_timeout;
-
- /**
- * Number of connection attempts for each server
- */
- public $_connect_attempts;
-
- /**
- * @var LoggerInterface
- */
- private $_logger;
-
- // }}}
- // }}}
- // {{{ methods
- // {{{ public functions
- // {{{ memcached()
-
- /**
- * Memcache initializer
- *
- * @param array $args Associative array of settings
- */
- public function __construct( $args ) {
- $this->set_servers( $args['servers'] ?? array() );
- $this->_debug = $args['debug'] ?? false;
- $this->stats = array();
- $this->_compress_threshold = $args['compress_threshold'] ?? 0;
- $this->_persistent = $args['persistent'] ?? false;
- $this->_compress_enable = true;
- $this->_have_zlib = function_exists( 'gzcompress' );
-
- $this->_cache_sock = array();
- $this->_host_dead = array();
-
- $this->_timeout_seconds = 0;
- $this->_timeout_microseconds = $args['timeout'] ?? 500000;
-
- $this->_connect_timeout = $args['connect_timeout'] ?? 0.1;
- $this->_connect_attempts = 2;
-
- $this->_logger = $args['logger'] ?? new NullLogger();
- }
-
- // }}}
-
- /**
- * @param mixed $value
- * @return string|integer
- */
- public function serialize( $value ) {
- return serialize( $value );
- }
-
- /**
- * @param string $value
- * @return mixed
- */
- public function unserialize( $value ) {
- return unserialize( $value );
- }
-
- // {{{ add()
-
- /**
- * Adds a key/value to the memcache server if one isn't already set with
- * that key
- *
- * @param string $key Key to set with data
- * @param mixed $val Value to store
- * @param int $exp (optional) Expiration time. This can be a number of seconds
- * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
- * longer must be the timestamp of the time at which the mapping should expire. It
- * is safe to use timestamps in all cases, regardless of expiration
- * eg: strtotime("+3 hour")
- *
- * @return bool
- */
- public function add( $key, $val, $exp = 0 ) {
- return $this->_set( 'add', $key, $val, $exp );
- }
-
- // }}}
- // {{{ decr()
-
- /**
- * Decrease a value stored on the memcache server
- *
- * @param string $key Key to decrease
- * @param int $amt (optional) amount to decrease
- *
- * @return mixed False on failure, value on success
- */
- public function decr( $key, $amt = 1 ) {
- return $this->_incrdecr( 'decr', $key, $amt );
- }
-
- // }}}
- // {{{ delete()
-
- /**
- * Deletes a key from the server, optionally after $time
- *
- * @param string $key Key to delete
- * @param int $time (optional) how long to wait before deleting
- *
- * @return bool True on success, false on failure
- */
- public function delete( $key, $time = 0 ) {
- if ( !$this->_active ) {
- return false;
- }
-
- $sock = $this->get_sock( $key );
- if ( !is_resource( $sock ) ) {
- return false;
- }
-
- $key = is_array( $key ) ? $key[1] : $key;
-
- if ( isset( $this->stats['delete'] ) ) {
- $this->stats['delete']++;
- } else {
- $this->stats['delete'] = 1;
- }
- $cmd = "delete $key $time\r\n";
- if ( !$this->_fwrite( $sock, $cmd ) ) {
- return false;
- }
- $res = $this->_fgets( $sock );
-
- if ( $this->_debug ) {
- $this->_debugprint( sprintf( "MemCache: delete %s (%s)", $key, $res ) );
- }
-
- if ( $res == "DELETED" || $res == "NOT_FOUND" ) {
- return true;
- }
-
- return false;
- }
-
- /**
- * Changes the TTL on a key from the server to $time
- *
- * @param string $key
- * @param int $time TTL in seconds
- *
- * @return bool True on success, false on failure
- */
- public function touch( $key, $time = 0 ) {
- if ( !$this->_active ) {
- return false;
- }
-
- $sock = $this->get_sock( $key );
- if ( !is_resource( $sock ) ) {
- return false;
- }
-
- $key = is_array( $key ) ? $key[1] : $key;
-
- if ( isset( $this->stats['touch'] ) ) {
- $this->stats['touch']++;
- } else {
- $this->stats['touch'] = 1;
- }
- $cmd = "touch $key $time\r\n";
- if ( !$this->_fwrite( $sock, $cmd ) ) {
- return false;
- }
- $res = $this->_fgets( $sock );
-
- if ( $this->_debug ) {
- $this->_debugprint( sprintf( "MemCache: touch %s (%s)", $key, $res ) );
- }
-
- if ( $res == "TOUCHED" ) {
- return true;
- }
-
- return false;
- }
-
- // }}}
- // {{{ disconnect_all()
-
- /**
- * Disconnects all connected sockets
- */
- public function disconnect_all() {
- foreach ( $this->_cache_sock as $sock ) {
- fclose( $sock );
- }
-
- $this->_cache_sock = array();
- }
-
- // }}}
- // {{{ enable_compress()
-
- /**
- * Enable / Disable compression
- *
- * @param bool $enable True to enable, false to disable
- */
- public function enable_compress( $enable ) {
- $this->_compress_enable = $enable;
- }
-
- // }}}
- // {{{ forget_dead_hosts()
-
- /**
- * Forget about all of the dead hosts
- */
- public function forget_dead_hosts() {
- $this->_host_dead = array();
- }
-
- // }}}
- // {{{ get()
-
- /**
- * Retrieves the value associated with the key from the memcache server
- *
- * @param array|string $key key to retrieve
- * @param float $casToken [optional]
- *
- * @return mixed
- */
- public function get( $key, &$casToken = null ) {
- if ( $this->_debug ) {
- $this->_debugprint( "get($key)" );
- }
-
- if ( !is_array( $key ) && strval( $key ) === '' ) {
- $this->_debugprint( "Skipping key which equals to an empty string" );
- return false;
- }
-
- if ( !$this->_active ) {
- return false;
- }
-
- $sock = $this->get_sock( $key );
-
- if ( !is_resource( $sock ) ) {
- return false;
- }
-
- $key = is_array( $key ) ? $key[1] : $key;
- if ( isset( $this->stats['get'] ) ) {
- $this->stats['get']++;
- } else {
- $this->stats['get'] = 1;
- }
-
- $cmd = "gets $key\r\n";
- if ( !$this->_fwrite( $sock, $cmd ) ) {
- return false;
- }
-
- $val = array();
- $this->_load_items( $sock, $val, $casToken );
-
- if ( $this->_debug ) {
- foreach ( $val as $k => $v ) {
- $this->_debugprint(
- sprintf( "MemCache: sock %s got %s", $this->serialize( $sock ), $k ) );
- }
- }
-
- $value = false;
- if ( isset( $val[$key] ) ) {
- $value = $val[$key];
- }
- return $value;
- }
-
- // }}}
- // {{{ get_multi()
-
- /**
- * Get multiple keys from the server(s)
- *
- * @param array $keys Keys to retrieve
- *
- * @return array
- */
- public function get_multi( $keys ) {
- if ( !$this->_active ) {
- return array();
- }
-
- if ( isset( $this->stats['get_multi'] ) ) {
- $this->stats['get_multi']++;
- } else {
- $this->stats['get_multi'] = 1;
- }
- $sock_keys = array();
- $socks = array();
- foreach ( $keys as $key ) {
- $sock = $this->get_sock( $key );
- if ( !is_resource( $sock ) ) {
- continue;
- }
- $key = is_array( $key ) ? $key[1] : $key;
- if ( !isset( $sock_keys[$sock] ) ) {
- $sock_keys[intval( $sock )] = array();
- $socks[] = $sock;
- }
- $sock_keys[intval( $sock )][] = $key;
- }
-
- $gather = array();
- // Send out the requests
- foreach ( $socks as $sock ) {
- $cmd = 'gets';
- foreach ( $sock_keys[intval( $sock )] as $key ) {
- $cmd .= ' ' . $key;
- }
- $cmd .= "\r\n";
-
- if ( $this->_fwrite( $sock, $cmd ) ) {
- $gather[] = $sock;
- }
- }
-
- // Parse responses
- $val = array();
- foreach ( $gather as $sock ) {
- $this->_load_items( $sock, $val, $casToken );
- }
-
- if ( $this->_debug ) {
- foreach ( $val as $k => $v ) {
- $this->_debugprint( sprintf( "MemCache: got %s", $k ) );
- }
- }
-
- return $val;
- }
-
- // }}}
- // {{{ incr()
-
- /**
- * Increments $key (optionally) by $amt
- *
- * @param string $key Key to increment
- * @param int $amt (optional) amount to increment
- *
- * @return int|null Null if the key does not exist yet (this does NOT
- * create new mappings if the key does not exist). If the key does
- * exist, this returns the new value for that key.
- */
- public function incr( $key, $amt = 1 ) {
- return $this->_incrdecr( 'incr', $key, $amt );
- }
-
- // }}}
- // {{{ replace()
-
- /**
- * Overwrites an existing value for key; only works if key is already set
- *
- * @param string $key Key to set value as
- * @param mixed $value Value to store
- * @param int $exp (optional) Expiration time. This can be a number of seconds
- * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
- * longer must be the timestamp of the time at which the mapping should expire. It
- * is safe to use timestamps in all cases, regardless of exipration
- * eg: strtotime("+3 hour")
- *
- * @return bool
- */
- public function replace( $key, $value, $exp = 0 ) {
- return $this->_set( 'replace', $key, $value, $exp );
- }
-
- // }}}
- // {{{ run_command()
-
- /**
- * Passes through $cmd to the memcache server connected by $sock; returns
- * output as an array (null array if no output)
- *
- * @param Resource $sock Socket to send command on
- * @param string $cmd Command to run
- *
- * @return array Output array
- */
- public function run_command( $sock, $cmd ) {
- if ( !is_resource( $sock ) ) {
- return array();
- }
-
- if ( !$this->_fwrite( $sock, $cmd ) ) {
- return array();
- }
-
- $ret = array();
- while ( true ) {
- $res = $this->_fgets( $sock );
- $ret[] = $res;
- if ( preg_match( '/^END/', $res ) ) {
- break;
- }
- if ( strlen( $res ) == 0 ) {
- break;
- }
- }
- return $ret;
- }
-
- // }}}
- // {{{ set()
-
- /**
- * Unconditionally sets a key to a given value in the memcache. Returns true
- * if set successfully.
- *
- * @param string $key Key to set value as
- * @param mixed $value Value to set
- * @param int $exp (optional) Expiration time. This can be a number of seconds
- * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
- * longer must be the timestamp of the time at which the mapping should expire. It
- * is safe to use timestamps in all cases, regardless of exipration
- * eg: strtotime("+3 hour")
- *
- * @return bool True on success
- */
- public function set( $key, $value, $exp = 0 ) {
- return $this->_set( 'set', $key, $value, $exp );
- }
-
- // }}}
- // {{{ cas()
-
- /**
- * Sets a key to a given value in the memcache if the current value still corresponds
- * to a known, given value. Returns true if set successfully.
- *
- * @param float $casToken Current known value
- * @param string $key Key to set value as
- * @param mixed $value Value to set
- * @param int $exp (optional) Expiration time. This can be a number of seconds
- * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
- * longer must be the timestamp of the time at which the mapping should expire. It
- * is safe to use timestamps in all cases, regardless of exipration
- * eg: strtotime("+3 hour")
- *
- * @return bool True on success
- */
- public function cas( $casToken, $key, $value, $exp = 0 ) {
- return $this->_set( 'cas', $key, $value, $exp, $casToken );
- }
-
- // }}}
- // {{{ set_compress_threshold()
-
- /**
- * Set the compression threshold
- *
- * @param int $thresh Threshold to compress if larger than
- */
- public function set_compress_threshold( $thresh ) {
- $this->_compress_threshold = $thresh;
- }
-
- // }}}
- // {{{ set_debug()
-
- /**
- * Set the debug flag
- *
- * @see __construct()
- * @param bool $dbg True for debugging, false otherwise
- */
- public function set_debug( $dbg ) {
- $this->_debug = $dbg;
- }
-
- // }}}
- // {{{ set_servers()
-
- /**
- * Set the server list to distribute key gets and puts between
- *
- * @see __construct()
- * @param array $list Array of servers to connect to
- */
- public function set_servers( $list ) {
- $this->_servers = $list;
- $this->_active = count( $list );
- $this->_buckets = null;
- $this->_bucketcount = 0;
-
- $this->_single_sock = null;
- if ( $this->_active == 1 ) {
- $this->_single_sock = $this->_servers[0];
- }
- }
-
- /**
- * Sets the timeout for new connections
- *
- * @param int $seconds Number of seconds
- * @param int $microseconds Number of microseconds
- */
- public function set_timeout( $seconds, $microseconds ) {
- $this->_timeout_seconds = $seconds;
- $this->_timeout_microseconds = $microseconds;
- }
-
- // }}}
- // }}}
- // {{{ private methods
- // {{{ _close_sock()
-
- /**
- * Close the specified socket
- *
- * @param string $sock Socket to close
- *
- * @access private
- */
- function _close_sock( $sock ) {
- $host = array_search( $sock, $this->_cache_sock );
- fclose( $this->_cache_sock[$host] );
- unset( $this->_cache_sock[$host] );
- }
-
- // }}}
- // {{{ _connect_sock()
-
- /**
- * Connects $sock to $host, timing out after $timeout
- *
- * @param int $sock Socket to connect
- * @param string $host Host:IP to connect to
- *
- * @return bool
- * @access private
- */
- function _connect_sock( &$sock, $host ) {
- list( $ip, $port ) = preg_split( '/:(?=\d)/', $host );
- $sock = false;
- $timeout = $this->_connect_timeout;
- $errno = $errstr = null;
- for ( $i = 0; !$sock && $i < $this->_connect_attempts; $i++ ) {
- Wikimedia\suppressWarnings();
- if ( $this->_persistent == 1 ) {
- $sock = pfsockopen( $ip, $port, $errno, $errstr, $timeout );
- } else {
- $sock = fsockopen( $ip, $port, $errno, $errstr, $timeout );
- }
- Wikimedia\restoreWarnings();
- }
- if ( !$sock ) {
- $this->_error_log( "Error connecting to $host: $errstr" );
- $this->_dead_host( $host );
- return false;
- }
-
- // Initialise timeout
- stream_set_timeout( $sock, $this->_timeout_seconds, $this->_timeout_microseconds );
-
- // If the connection was persistent, flush the read buffer in case there
- // was a previous incomplete request on this connection
- if ( $this->_persistent ) {
- $this->_flush_read_buffer( $sock );
- }
- return true;
- }
-
- // }}}
- // {{{ _dead_sock()
-
- /**
- * Marks a host as dead until 30-40 seconds in the future
- *
- * @param string $sock Socket to mark as dead
- *
- * @access private
- */
- function _dead_sock( $sock ) {
- $host = array_search( $sock, $this->_cache_sock );
- $this->_dead_host( $host );
- }
-
- /**
- * @param string $host
- */
- function _dead_host( $host ) {
- $ip = explode( ':', $host )[0];
- $this->_host_dead[$ip] = time() + 30 + intval( rand( 0, 10 ) );
- $this->_host_dead[$host] = $this->_host_dead[$ip];
- unset( $this->_cache_sock[$host] );
- }
-
- // }}}
- // {{{ get_sock()
-
- /**
- * get_sock
- *
- * @param string $key Key to retrieve value for;
- *
- * @return Resource|bool Resource on success, false on failure
- * @access private
- */
- function get_sock( $key ) {
- if ( !$this->_active ) {
- return false;
- }
-
- if ( $this->_single_sock !== null ) {
- return $this->sock_to_host( $this->_single_sock );
- }
-
- $hv = is_array( $key ) ? intval( $key[0] ) : $this->_hashfunc( $key );
- if ( $this->_buckets === null ) {
- $bu = array();
- foreach ( $this->_servers as $v ) {
- if ( is_array( $v ) ) {
- for ( $i = 0; $i < $v[1]; $i++ ) {
- $bu[] = $v[0];
- }
- } else {
- $bu[] = $v;
- }
- }
- $this->_buckets = $bu;
- $this->_bucketcount = count( $bu );
- }
-
- $realkey = is_array( $key ) ? $key[1] : $key;
- for ( $tries = 0; $tries < 20; $tries++ ) {
- $host = $this->_buckets[$hv % $this->_bucketcount];
- $sock = $this->sock_to_host( $host );
- if ( is_resource( $sock ) ) {
- return $sock;
- }
- $hv = $this->_hashfunc( $hv . $realkey );
- }
-
- return false;
- }
-
- // }}}
- // {{{ _hashfunc()
-
- /**
- * Creates a hash integer based on the $key
- *
- * @param string $key Key to hash
- *
- * @return int Hash value
- * @access private
- */
- function _hashfunc( $key ) {
- # Hash function must be in [0,0x7ffffff]
- # We take the first 31 bits of the MD5 hash, which unlike the hash
- # function used in a previous version of this client, works
- return hexdec( substr( md5( $key ), 0, 8 ) ) & 0x7fffffff;
- }
-
- // }}}
- // {{{ _incrdecr()
-
- /**
- * Perform increment/decriment on $key
- *
- * @param string $cmd Command to perform
- * @param string|array $key Key to perform it on
- * @param int $amt Amount to adjust
- *
- * @return int New value of $key
- * @access private
- */
- function _incrdecr( $cmd, $key, $amt = 1 ) {
- if ( !$this->_active ) {
- return null;
- }
-
- $sock = $this->get_sock( $key );
- if ( !is_resource( $sock ) ) {
- return null;
- }
-
- $key = is_array( $key ) ? $key[1] : $key;
- if ( isset( $this->stats[$cmd] ) ) {
- $this->stats[$cmd]++;
- } else {
- $this->stats[$cmd] = 1;
- }
- if ( !$this->_fwrite( $sock, "$cmd $key $amt\r\n" ) ) {
- return null;
- }
-
- $line = $this->_fgets( $sock );
- $match = array();
- if ( !preg_match( '/^(\d+)/', $line, $match ) ) {
- return null;
- }
- return $match[1];
- }
-
- // }}}
- // {{{ _load_items()
-
- /**
- * Load items into $ret from $sock
- *
- * @param Resource $sock Socket to read from
- * @param array $ret returned values
- * @param float $casToken [optional]
- * @return bool True for success, false for failure
- *
- * @access private
- */
- function _load_items( $sock, &$ret, &$casToken = null ) {
- $results = array();
-
- while ( 1 ) {
- $decl = $this->_fgets( $sock );
-
- if ( $decl === false ) {
- /*
- * If nothing can be read, something is wrong because we know exactly when
- * to stop reading (right after "END") and we return right after that.
- */
- return false;
- } elseif ( preg_match( '/^VALUE (\S+) (\d+) (\d+) (\d+)$/', $decl, $match ) ) {
- /*
- * Read all data returned. This can be either one or multiple values.
- * Save all that data (in an array) to be processed later: we'll first
- * want to continue reading until "END" before doing anything else,
- * to make sure that we don't leave our client in a state where it's
- * output is not yet fully read.
- */
- $results[] = array(
- $match[1], // rkey
- $match[2], // flags
- $match[3], // len
- $match[4], // casToken
- $this->_fread( $sock, $match[3] + 2 ), // data
- );
- } elseif ( $decl == "END" ) {
- if ( count( $results ) == 0 ) {
- return false;
- }
-
- /**
- * All data has been read, time to process the data and build
- * meaningful return values.
- */
- foreach ( $results as $vars ) {
- list( $rkey, $flags, $len, $casToken, $data ) = $vars;
-
- if ( $data === false || substr( $data, -2 ) !== "\r\n" ) {
- $this->_handle_error( $sock,
- 'line ending missing from data block from $1' );
- return false;
- }
- $data = substr( $data, 0, -2 );
- $ret[$rkey] = $data;
-
- if ( $this->_have_zlib && $flags & self::COMPRESSED ) {
- $ret[$rkey] = gzuncompress( $ret[$rkey] );
- }
-
- /*
- * This unserialize is the exact reason that we only want to
- * process data after having read until "END" (instead of doing
- * this right away): "unserialize" can trigger outside code:
- * in the event that $ret[$rkey] is a serialized object,
- * unserializing it will trigger __wakeup() if present. If that
- * function attempted to read from memcached (while we did not
- * yet read "END"), these 2 calls would collide.
- */
- if ( $flags & self::SERIALIZED ) {
- $ret[$rkey] = $this->unserialize( $ret[$rkey] );
- } elseif ( $flags & self::INTVAL ) {
- $ret[$rkey] = intval( $ret[$rkey] );
- }
- }
-
- return true;
- } else {
- $this->_handle_error( $sock, 'Error parsing response from $1' );
- return false;
- }
- }
- }
-
- // }}}
- // {{{ _set()
-
- /**
- * Performs the requested storage operation to the memcache server
- *
- * @param string $cmd Command to perform
- * @param string $key Key to act on
- * @param mixed $val What we need to store
- * @param int $exp (optional) Expiration time. This can be a number of seconds
- * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
- * longer must be the timestamp of the time at which the mapping should expire. It
- * is safe to use timestamps in all cases, regardless of exipration
- * eg: strtotime("+3 hour")
- * @param float $casToken [optional]
- *
- * @return bool
- * @access private
- */
- function _set( $cmd, $key, $val, $exp, $casToken = null ) {
- if ( !$this->_active ) {
- return false;
- }
-
- $sock = $this->get_sock( $key );
- if ( !is_resource( $sock ) ) {
- return false;
- }
-
- if ( isset( $this->stats[$cmd] ) ) {
- $this->stats[$cmd]++;
- } else {
- $this->stats[$cmd] = 1;
- }
-
- $flags = 0;
-
- if ( is_int( $val ) ) {
- $flags |= self::INTVAL;
- } elseif ( !is_scalar( $val ) ) {
- $val = $this->serialize( $val );
- $flags |= self::SERIALIZED;
- if ( $this->_debug ) {
- $this->_debugprint( sprintf( "client: serializing data as it is not scalar" ) );
- }
- }
-
- $len = strlen( $val );
-
- if ( $this->_have_zlib && $this->_compress_enable
- && $this->_compress_threshold && $len >= $this->_compress_threshold
- ) {
- $c_val = gzcompress( $val, 9 );
- $c_len = strlen( $c_val );
-
- if ( $c_len < $len * ( 1 - self::COMPRESSION_SAVINGS ) ) {
- if ( $this->_debug ) {
- $this->_debugprint( sprintf( "client: compressing data; was %d bytes is now %d bytes", $len, $c_len ) );
- }
- $val = $c_val;
- $len = $c_len;
- $flags |= self::COMPRESSED;
- }
- }
-
- $command = "$cmd $key $flags $exp $len";
- if ( $casToken ) {
- $command .= " $casToken";
- }
-
- if ( !$this->_fwrite( $sock, "$command\r\n$val\r\n" ) ) {
- return false;
- }
-
- $line = $this->_fgets( $sock );
-
- if ( $this->_debug ) {
- $this->_debugprint( sprintf( "%s %s (%s)", $cmd, $key, $line ) );
- }
- if ( $line === "STORED" ) {
- return true;
- } elseif ( $line === "NOT_STORED" && $cmd === "set" ) {
- // "Not stored" is always used as the mcrouter response with AllAsyncRoute
- return true;
- }
-
- return false;
- }
-
- // }}}
- // {{{ sock_to_host()
-
- /**
- * Returns the socket for the host
- *
- * @param string $host Host:IP to get socket for
- *
- * @return Resource|bool IO Stream or false
- * @access private
- */
- function sock_to_host( $host ) {
- if ( isset( $this->_cache_sock[$host] ) ) {
- return $this->_cache_sock[$host];
- }
-
- $sock = null;
- $now = time();
- list( $ip, /* $port */) = explode( ':', $host );
- if ( isset( $this->_host_dead[$host] ) && $this->_host_dead[$host] > $now ||
- isset( $this->_host_dead[$ip] ) && $this->_host_dead[$ip] > $now
- ) {
- return null;
- }
-
- if ( !$this->_connect_sock( $sock, $host ) ) {
- return null;
- }
-
- // Do not buffer writes
- stream_set_write_buffer( $sock, 0 );
-
- $this->_cache_sock[$host] = $sock;
-
- return $this->_cache_sock[$host];
- }
-
- /**
- * @param string $text
- */
- function _debugprint( $text ) {
- $this->_logger->debug( $text );
- }
-
- /**
- * @param string $text
- */
- function _error_log( $text ) {
- $this->_logger->error( "Memcached error: $text" );
- }
-
- /**
- * Write to a stream. If there is an error, mark the socket dead.
- *
- * @param Resource $sock The socket
- * @param string $buf The string to write
- * @return bool True on success, false on failure
- */
- function _fwrite( $sock, $buf ) {
- $bytesWritten = 0;
- $bufSize = strlen( $buf );
- while ( $bytesWritten < $bufSize ) {
- $result = fwrite( $sock, $buf );
- $data = stream_get_meta_data( $sock );
- if ( $data['timed_out'] ) {
- $this->_handle_error( $sock, 'timeout writing to $1' );
- return false;
- }
- // Contrary to the documentation, fwrite() returns zero on error in PHP 5.3.
- if ( $result === false || $result === 0 ) {
- $this->_handle_error( $sock, 'error writing to $1' );
- return false;
- }
- $bytesWritten += $result;
- }
-
- return true;
- }
-
- /**
- * Handle an I/O error. Mark the socket dead and log an error.
- *
- * @param Resource $sock
- * @param string $msg
- */
- function _handle_error( $sock, $msg ) {
- $peer = stream_socket_get_name( $sock, true /** remote **/ );
- if ( strval( $peer ) === '' ) {
- $peer = array_search( $sock, $this->_cache_sock );
- if ( $peer === false ) {
- $peer = '[unknown host]';
- }
- }
- $msg = str_replace( '$1', $peer, $msg );
- $this->_error_log( "$msg" );
- $this->_dead_sock( $sock );
- }
-
- /**
- * Read the specified number of bytes from a stream. If there is an error,
- * mark the socket dead.
- *
- * @param Resource $sock The socket
- * @param int $len The number of bytes to read
- * @return string|bool The string on success, false on failure.
- */
- function _fread( $sock, $len ) {
- $buf = '';
- while ( $len > 0 ) {
- $result = fread( $sock, $len );
- $data = stream_get_meta_data( $sock );
- if ( $data['timed_out'] ) {
- $this->_handle_error( $sock, 'timeout reading from $1' );
- return false;
- }
- if ( $result === false ) {
- $this->_handle_error( $sock, 'error reading buffer from $1' );
- return false;
- }
- if ( $result === '' ) {
- // This will happen if the remote end of the socket is shut down
- $this->_handle_error( $sock, 'unexpected end of file reading from $1' );
- return false;
- }
- $len -= strlen( $result );
- $buf .= $result;
- }
- return $buf;
- }
-
- /**
- * Read a line from a stream. If there is an error, mark the socket dead.
- * The \r\n line ending is stripped from the response.
- *
- * @param Resource $sock The socket
- * @return string|bool The string on success, false on failure
- */
- function _fgets( $sock ) {
- $result = fgets( $sock );
- // fgets() may return a partial line if there is a select timeout after
- // a successful recv(), so we have to check for a timeout even if we
- // got a string response.
- $data = stream_get_meta_data( $sock );
- if ( $data['timed_out'] ) {
- $this->_handle_error( $sock, 'timeout reading line from $1' );
- return false;
- }
- if ( $result === false ) {
- $this->_handle_error( $sock, 'error reading line from $1' );
- return false;
- }
- if ( substr( $result, -2 ) === "\r\n" ) {
- $result = substr( $result, 0, -2 );
- } elseif ( substr( $result, -1 ) === "\n" ) {
- $result = substr( $result, 0, -1 );
- } else {
- $this->_handle_error( $sock, 'line ending missing in response from $1' );
- return false;
- }
- return $result;
- }
-
- /**
- * Flush the read buffer of a stream
- * @param Resource $f
- */
- function _flush_read_buffer( $f ) {
- if ( !is_resource( $f ) ) {
- return;
- }
- $r = array( $f );
- $w = null;
- $e = null;
- $n = stream_select( $r, $w, $e, 0, 0 );
- while ( $n == 1 && !feof( $f ) ) {
- fread( $f, 1024 );
- $r = array( $f );
- $w = null;
- $e = null;
- $n = stream_select( $r, $w, $e, 0, 0 );
- }
- }
-
- // }}}
- // }}}
- // }}}
-}
-
-// }}}
--- /dev/null
+<?php
+// phpcs:ignoreFile -- It's an external lib and it isn't. Let's not bother.
+/**
+ * Memcached client for PHP.
+ *
+ * +---------------------------------------------------------------------------+
+ * | memcached client, PHP |
+ * +---------------------------------------------------------------------------+
+ * | Copyright (c) 2003 Ryan T. Dean <rtdean@cytherianage.net> |
+ * | All rights reserved. |
+ * | |
+ * | Redistribution and use in source and binary forms, with or without |
+ * | modification, are permitted provided that the following conditions |
+ * | are met: |
+ * | |
+ * | 1. Redistributions of source code must retain the above copyright |
+ * | notice, this list of conditions and the following disclaimer. |
+ * | 2. Redistributions in binary form must reproduce the above copyright |
+ * | notice, this list of conditions and the following disclaimer in the |
+ * | documentation and/or other materials provided with the distribution. |
+ * | |
+ * | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
+ * | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
+ * | OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
+ * | IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
+ * | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
+ * | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
+ * | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
+ * | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
+ * | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
+ * | THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
+ * +---------------------------------------------------------------------------+
+ * | Author: Ryan T. Dean <rtdean@cytherianage.net> |
+ * | Heavily influenced by the Perl memcached client by Brad Fitzpatrick. |
+ * | Permission granted by Brad Fitzpatrick for relicense of ported Perl |
+ * | client logic under 2-clause BSD license. |
+ * +---------------------------------------------------------------------------+
+ *
+ * @file
+ * $TCAnet$
+ */
+
+/**
+ * This is a PHP client for memcached - a distributed memory cache daemon.
+ *
+ * More information is available at http://www.danga.com/memcached/
+ *
+ * Usage example:
+ *
+ * $mc = new MemcachedClient(array(
+ * 'servers' => array(
+ * '127.0.0.1:10000',
+ * array( '192.0.0.1:10010', 2 ),
+ * '127.0.0.1:10020'
+ * ),
+ * 'debug' => false,
+ * 'compress_threshold' => 10240,
+ * 'persistent' => true
+ * ));
+ *
+ * $mc->add( 'key', array( 'some', 'array' ) );
+ * $mc->replace( 'key', 'some random string' );
+ * $val = $mc->get( 'key' );
+ *
+ * @author Ryan T. Dean <rtdean@cytherianage.net>
+ * @version 0.1.2
+ */
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+
+// {{{ class MemcachedClient
+/**
+ * memcached client class implemented using (p)fsockopen()
+ *
+ * @author Ryan T. Dean <rtdean@cytherianage.net>
+ * @ingroup Cache
+ */
+class MemcachedClient {
+ // {{{ properties
+ // {{{ public
+
+ // {{{ constants
+ // {{{ flags
+
+ /**
+ * Flag: indicates data is serialized
+ */
+ const SERIALIZED = 1;
+
+ /**
+ * Flag: indicates data is compressed
+ */
+ const COMPRESSED = 2;
+
+ /**
+ * Flag: indicates data is an integer
+ */
+ const INTVAL = 4;
+
+ // }}}
+
+ /**
+ * Minimum savings to store data compressed
+ */
+ const COMPRESSION_SAVINGS = 0.20;
+
+ // }}}
+
+ /**
+ * Command statistics
+ *
+ * @var array
+ * @access public
+ */
+ public $stats;
+
+ // }}}
+ // {{{ private
+
+ /**
+ * Cached Sockets that are connected
+ *
+ * @var array
+ * @access private
+ */
+ public $_cache_sock;
+
+ /**
+ * Current debug status; 0 - none to 9 - profiling
+ *
+ * @var bool
+ * @access private
+ */
+ public $_debug;
+
+ /**
+ * Dead hosts, assoc array, 'host'=>'unixtime when ok to check again'
+ *
+ * @var array
+ * @access private
+ */
+ public $_host_dead;
+
+ /**
+ * Is compression available?
+ *
+ * @var bool
+ * @access private
+ */
+ public $_have_zlib;
+
+ /**
+ * Do we want to use compression?
+ *
+ * @var bool
+ * @access private
+ */
+ public $_compress_enable;
+
+ /**
+ * At how many bytes should we compress?
+ *
+ * @var int
+ * @access private
+ */
+ public $_compress_threshold;
+
+ /**
+ * Are we using persistent links?
+ *
+ * @var bool
+ * @access private
+ */
+ public $_persistent;
+
+ /**
+ * If only using one server; contains ip:port to connect to
+ *
+ * @var string
+ * @access private
+ */
+ public $_single_sock;
+
+ /**
+ * Array containing ip:port or array(ip:port, weight)
+ *
+ * @var array
+ * @access private
+ */
+ public $_servers;
+
+ /**
+ * Our bit buckets
+ *
+ * @var array
+ * @access private
+ */
+ public $_buckets;
+
+ /**
+ * Total # of bit buckets we have
+ *
+ * @var int
+ * @access private
+ */
+ public $_bucketcount;
+
+ /**
+ * # of total servers we have
+ *
+ * @var int
+ * @access private
+ */
+ public $_active;
+
+ /**
+ * Stream timeout in seconds. Applies for example to fread()
+ *
+ * @var int
+ * @access private
+ */
+ public $_timeout_seconds;
+
+ /**
+ * Stream timeout in microseconds
+ *
+ * @var int
+ * @access private
+ */
+ public $_timeout_microseconds;
+
+ /**
+ * Connect timeout in seconds
+ */
+ public $_connect_timeout;
+
+ /**
+ * Number of connection attempts for each server
+ */
+ public $_connect_attempts;
+
+ /**
+ * @var LoggerInterface
+ */
+ private $_logger;
+
+ // }}}
+ // }}}
+ // {{{ methods
+ // {{{ public functions
+ // {{{ memcached()
+
+ /**
+ * Memcache initializer
+ *
+ * @param array $args Associative array of settings
+ */
+ public function __construct( $args ) {
+ $this->set_servers( $args['servers'] ?? array() );
+ $this->_debug = $args['debug'] ?? false;
+ $this->stats = array();
+ $this->_compress_threshold = $args['compress_threshold'] ?? 0;
+ $this->_persistent = $args['persistent'] ?? false;
+ $this->_compress_enable = true;
+ $this->_have_zlib = function_exists( 'gzcompress' );
+
+ $this->_cache_sock = array();
+ $this->_host_dead = array();
+
+ $this->_timeout_seconds = 0;
+ $this->_timeout_microseconds = $args['timeout'] ?? 500000;
+
+ $this->_connect_timeout = $args['connect_timeout'] ?? 0.1;
+ $this->_connect_attempts = 2;
+
+ $this->_logger = $args['logger'] ?? new NullLogger();
+ }
+
+ // }}}
+
+ /**
+ * @param mixed $value
+ * @return string|integer
+ */
+ public function serialize( $value ) {
+ return serialize( $value );
+ }
+
+ /**
+ * @param string $value
+ * @return mixed
+ */
+ public function unserialize( $value ) {
+ return unserialize( $value );
+ }
+
+ // {{{ add()
+
+ /**
+ * Adds a key/value to the memcache server if one isn't already set with
+ * that key
+ *
+ * @param string $key Key to set with data
+ * @param mixed $val Value to store
+ * @param int $exp (optional) Expiration time. This can be a number of seconds
+ * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
+ * longer must be the timestamp of the time at which the mapping should expire. It
+ * is safe to use timestamps in all cases, regardless of expiration
+ * eg: strtotime("+3 hour")
+ *
+ * @return bool
+ */
+ public function add( $key, $val, $exp = 0 ) {
+ return $this->_set( 'add', $key, $val, $exp );
+ }
+
+ // }}}
+ // {{{ decr()
+
+ /**
+ * Decrease a value stored on the memcache server
+ *
+ * @param string $key Key to decrease
+ * @param int $amt (optional) amount to decrease
+ *
+ * @return mixed False on failure, value on success
+ */
+ public function decr( $key, $amt = 1 ) {
+ return $this->_incrdecr( 'decr', $key, $amt );
+ }
+
+ // }}}
+ // {{{ delete()
+
+ /**
+ * Deletes a key from the server, optionally after $time
+ *
+ * @param string $key Key to delete
+ * @param int $time (optional) how long to wait before deleting
+ *
+ * @return bool True on success, false on failure
+ */
+ public function delete( $key, $time = 0 ) {
+ if ( !$this->_active ) {
+ return false;
+ }
+
+ $sock = $this->get_sock( $key );
+ if ( !is_resource( $sock ) ) {
+ return false;
+ }
+
+ $key = is_array( $key ) ? $key[1] : $key;
+
+ if ( isset( $this->stats['delete'] ) ) {
+ $this->stats['delete']++;
+ } else {
+ $this->stats['delete'] = 1;
+ }
+ $cmd = "delete $key $time\r\n";
+ if ( !$this->_fwrite( $sock, $cmd ) ) {
+ return false;
+ }
+ $res = $this->_fgets( $sock );
+
+ if ( $this->_debug ) {
+ $this->_debugprint( sprintf( "MemCache: delete %s (%s)", $key, $res ) );
+ }
+
+ if ( $res == "DELETED" || $res == "NOT_FOUND" ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Changes the TTL on a key from the server to $time
+ *
+ * @param string $key
+ * @param int $time TTL in seconds
+ *
+ * @return bool True on success, false on failure
+ */
+ public function touch( $key, $time = 0 ) {
+ if ( !$this->_active ) {
+ return false;
+ }
+
+ $sock = $this->get_sock( $key );
+ if ( !is_resource( $sock ) ) {
+ return false;
+ }
+
+ $key = is_array( $key ) ? $key[1] : $key;
+
+ if ( isset( $this->stats['touch'] ) ) {
+ $this->stats['touch']++;
+ } else {
+ $this->stats['touch'] = 1;
+ }
+ $cmd = "touch $key $time\r\n";
+ if ( !$this->_fwrite( $sock, $cmd ) ) {
+ return false;
+ }
+ $res = $this->_fgets( $sock );
+
+ if ( $this->_debug ) {
+ $this->_debugprint( sprintf( "MemCache: touch %s (%s)", $key, $res ) );
+ }
+
+ if ( $res == "TOUCHED" ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ // }}}
+ // {{{ disconnect_all()
+
+ /**
+ * Disconnects all connected sockets
+ */
+ public function disconnect_all() {
+ foreach ( $this->_cache_sock as $sock ) {
+ fclose( $sock );
+ }
+
+ $this->_cache_sock = array();
+ }
+
+ // }}}
+ // {{{ enable_compress()
+
+ /**
+ * Enable / Disable compression
+ *
+ * @param bool $enable True to enable, false to disable
+ */
+ public function enable_compress( $enable ) {
+ $this->_compress_enable = $enable;
+ }
+
+ // }}}
+ // {{{ forget_dead_hosts()
+
+ /**
+ * Forget about all of the dead hosts
+ */
+ public function forget_dead_hosts() {
+ $this->_host_dead = array();
+ }
+
+ // }}}
+ // {{{ get()
+
+ /**
+ * Retrieves the value associated with the key from the memcache server
+ *
+ * @param array|string $key key to retrieve
+ * @param float $casToken [optional]
+ *
+ * @return mixed
+ */
+ public function get( $key, &$casToken = null ) {
+ if ( $this->_debug ) {
+ $this->_debugprint( "get($key)" );
+ }
+
+ if ( !is_array( $key ) && strval( $key ) === '' ) {
+ $this->_debugprint( "Skipping key which equals to an empty string" );
+ return false;
+ }
+
+ if ( !$this->_active ) {
+ return false;
+ }
+
+ $sock = $this->get_sock( $key );
+
+ if ( !is_resource( $sock ) ) {
+ return false;
+ }
+
+ $key = is_array( $key ) ? $key[1] : $key;
+ if ( isset( $this->stats['get'] ) ) {
+ $this->stats['get']++;
+ } else {
+ $this->stats['get'] = 1;
+ }
+
+ $cmd = "gets $key\r\n";
+ if ( !$this->_fwrite( $sock, $cmd ) ) {
+ return false;
+ }
+
+ $val = array();
+ $this->_load_items( $sock, $val, $casToken );
+
+ if ( $this->_debug ) {
+ foreach ( $val as $k => $v ) {
+ $this->_debugprint(
+ sprintf( "MemCache: sock %s got %s", $this->serialize( $sock ), $k ) );
+ }
+ }
+
+ $value = false;
+ if ( isset( $val[$key] ) ) {
+ $value = $val[$key];
+ }
+ return $value;
+ }
+
+ // }}}
+ // {{{ get_multi()
+
+ /**
+ * Get multiple keys from the server(s)
+ *
+ * @param array $keys Keys to retrieve
+ *
+ * @return array
+ */
+ public function get_multi( $keys ) {
+ if ( !$this->_active ) {
+ return array();
+ }
+
+ if ( isset( $this->stats['get_multi'] ) ) {
+ $this->stats['get_multi']++;
+ } else {
+ $this->stats['get_multi'] = 1;
+ }
+ $sock_keys = array();
+ $socks = array();
+ foreach ( $keys as $key ) {
+ $sock = $this->get_sock( $key );
+ if ( !is_resource( $sock ) ) {
+ continue;
+ }
+ $key = is_array( $key ) ? $key[1] : $key;
+ if ( !isset( $sock_keys[$sock] ) ) {
+ $sock_keys[intval( $sock )] = array();
+ $socks[] = $sock;
+ }
+ $sock_keys[intval( $sock )][] = $key;
+ }
+
+ $gather = array();
+ // Send out the requests
+ foreach ( $socks as $sock ) {
+ $cmd = 'gets';
+ foreach ( $sock_keys[intval( $sock )] as $key ) {
+ $cmd .= ' ' . $key;
+ }
+ $cmd .= "\r\n";
+
+ if ( $this->_fwrite( $sock, $cmd ) ) {
+ $gather[] = $sock;
+ }
+ }
+
+ // Parse responses
+ $val = array();
+ foreach ( $gather as $sock ) {
+ $this->_load_items( $sock, $val, $casToken );
+ }
+
+ if ( $this->_debug ) {
+ foreach ( $val as $k => $v ) {
+ $this->_debugprint( sprintf( "MemCache: got %s", $k ) );
+ }
+ }
+
+ return $val;
+ }
+
+ // }}}
+ // {{{ incr()
+
+ /**
+ * Increments $key (optionally) by $amt
+ *
+ * @param string $key Key to increment
+ * @param int $amt (optional) amount to increment
+ *
+ * @return int|null Null if the key does not exist yet (this does NOT
+ * create new mappings if the key does not exist). If the key does
+ * exist, this returns the new value for that key.
+ */
+ public function incr( $key, $amt = 1 ) {
+ return $this->_incrdecr( 'incr', $key, $amt );
+ }
+
+ // }}}
+ // {{{ replace()
+
+ /**
+ * Overwrites an existing value for key; only works if key is already set
+ *
+ * @param string $key Key to set value as
+ * @param mixed $value Value to store
+ * @param int $exp (optional) Expiration time. This can be a number of seconds
+ * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
+ * longer must be the timestamp of the time at which the mapping should expire. It
+ * is safe to use timestamps in all cases, regardless of exipration
+ * eg: strtotime("+3 hour")
+ *
+ * @return bool
+ */
+ public function replace( $key, $value, $exp = 0 ) {
+ return $this->_set( 'replace', $key, $value, $exp );
+ }
+
+ // }}}
+ // {{{ run_command()
+
+ /**
+ * Passes through $cmd to the memcache server connected by $sock; returns
+ * output as an array (null array if no output)
+ *
+ * @param Resource $sock Socket to send command on
+ * @param string $cmd Command to run
+ *
+ * @return array Output array
+ */
+ public function run_command( $sock, $cmd ) {
+ if ( !is_resource( $sock ) ) {
+ return array();
+ }
+
+ if ( !$this->_fwrite( $sock, $cmd ) ) {
+ return array();
+ }
+
+ $ret = array();
+ while ( true ) {
+ $res = $this->_fgets( $sock );
+ $ret[] = $res;
+ if ( preg_match( '/^END/', $res ) ) {
+ break;
+ }
+ if ( strlen( $res ) == 0 ) {
+ break;
+ }
+ }
+ return $ret;
+ }
+
+ // }}}
+ // {{{ set()
+
+ /**
+ * Unconditionally sets a key to a given value in the memcache. Returns true
+ * if set successfully.
+ *
+ * @param string $key Key to set value as
+ * @param mixed $value Value to set
+ * @param int $exp (optional) Expiration time. This can be a number of seconds
+ * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
+ * longer must be the timestamp of the time at which the mapping should expire. It
+ * is safe to use timestamps in all cases, regardless of exipration
+ * eg: strtotime("+3 hour")
+ *
+ * @return bool True on success
+ */
+ public function set( $key, $value, $exp = 0 ) {
+ return $this->_set( 'set', $key, $value, $exp );
+ }
+
+ // }}}
+ // {{{ cas()
+
+ /**
+ * Sets a key to a given value in the memcache if the current value still corresponds
+ * to a known, given value. Returns true if set successfully.
+ *
+ * @param float $casToken Current known value
+ * @param string $key Key to set value as
+ * @param mixed $value Value to set
+ * @param int $exp (optional) Expiration time. This can be a number of seconds
+ * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
+ * longer must be the timestamp of the time at which the mapping should expire. It
+ * is safe to use timestamps in all cases, regardless of exipration
+ * eg: strtotime("+3 hour")
+ *
+ * @return bool True on success
+ */
+ public function cas( $casToken, $key, $value, $exp = 0 ) {
+ return $this->_set( 'cas', $key, $value, $exp, $casToken );
+ }
+
+ // }}}
+ // {{{ set_compress_threshold()
+
+ /**
+ * Set the compression threshold
+ *
+ * @param int $thresh Threshold to compress if larger than
+ */
+ public function set_compress_threshold( $thresh ) {
+ $this->_compress_threshold = $thresh;
+ }
+
+ // }}}
+ // {{{ set_debug()
+
+ /**
+ * Set the debug flag
+ *
+ * @see __construct()
+ * @param bool $dbg True for debugging, false otherwise
+ */
+ public function set_debug( $dbg ) {
+ $this->_debug = $dbg;
+ }
+
+ // }}}
+ // {{{ set_servers()
+
+ /**
+ * Set the server list to distribute key gets and puts between
+ *
+ * @see __construct()
+ * @param array $list Array of servers to connect to
+ */
+ public function set_servers( $list ) {
+ $this->_servers = $list;
+ $this->_active = count( $list );
+ $this->_buckets = null;
+ $this->_bucketcount = 0;
+
+ $this->_single_sock = null;
+ if ( $this->_active == 1 ) {
+ $this->_single_sock = $this->_servers[0];
+ }
+ }
+
+ /**
+ * Sets the timeout for new connections
+ *
+ * @param int $seconds Number of seconds
+ * @param int $microseconds Number of microseconds
+ */
+ public function set_timeout( $seconds, $microseconds ) {
+ $this->_timeout_seconds = $seconds;
+ $this->_timeout_microseconds = $microseconds;
+ }
+
+ // }}}
+ // }}}
+ // {{{ private methods
+ // {{{ _close_sock()
+
+ /**
+ * Close the specified socket
+ *
+ * @param string $sock Socket to close
+ *
+ * @access private
+ */
+ function _close_sock( $sock ) {
+ $host = array_search( $sock, $this->_cache_sock );
+ fclose( $this->_cache_sock[$host] );
+ unset( $this->_cache_sock[$host] );
+ }
+
+ // }}}
+ // {{{ _connect_sock()
+
+ /**
+ * Connects $sock to $host, timing out after $timeout
+ *
+ * @param int $sock Socket to connect
+ * @param string $host Host:IP to connect to
+ *
+ * @return bool
+ * @access private
+ */
+ function _connect_sock( &$sock, $host ) {
+ list( $ip, $port ) = preg_split( '/:(?=\d)/', $host );
+ $sock = false;
+ $timeout = $this->_connect_timeout;
+ $errno = $errstr = null;
+ for ( $i = 0; !$sock && $i < $this->_connect_attempts; $i++ ) {
+ Wikimedia\suppressWarnings();
+ if ( $this->_persistent == 1 ) {
+ $sock = pfsockopen( $ip, $port, $errno, $errstr, $timeout );
+ } else {
+ $sock = fsockopen( $ip, $port, $errno, $errstr, $timeout );
+ }
+ Wikimedia\restoreWarnings();
+ }
+ if ( !$sock ) {
+ $this->_error_log( "Error connecting to $host: $errstr" );
+ $this->_dead_host( $host );
+ return false;
+ }
+
+ // Initialise timeout
+ stream_set_timeout( $sock, $this->_timeout_seconds, $this->_timeout_microseconds );
+
+ // If the connection was persistent, flush the read buffer in case there
+ // was a previous incomplete request on this connection
+ if ( $this->_persistent ) {
+ $this->_flush_read_buffer( $sock );
+ }
+ return true;
+ }
+
+ // }}}
+ // {{{ _dead_sock()
+
+ /**
+ * Marks a host as dead until 30-40 seconds in the future
+ *
+ * @param string $sock Socket to mark as dead
+ *
+ * @access private
+ */
+ function _dead_sock( $sock ) {
+ $host = array_search( $sock, $this->_cache_sock );
+ $this->_dead_host( $host );
+ }
+
+ /**
+ * @param string $host
+ */
+ function _dead_host( $host ) {
+ $ip = explode( ':', $host )[0];
+ $this->_host_dead[$ip] = time() + 30 + intval( rand( 0, 10 ) );
+ $this->_host_dead[$host] = $this->_host_dead[$ip];
+ unset( $this->_cache_sock[$host] );
+ }
+
+ // }}}
+ // {{{ get_sock()
+
+ /**
+ * get_sock
+ *
+ * @param string $key Key to retrieve value for;
+ *
+ * @return Resource|bool Resource on success, false on failure
+ * @access private
+ */
+ function get_sock( $key ) {
+ if ( !$this->_active ) {
+ return false;
+ }
+
+ if ( $this->_single_sock !== null ) {
+ return $this->sock_to_host( $this->_single_sock );
+ }
+
+ $hv = is_array( $key ) ? intval( $key[0] ) : $this->_hashfunc( $key );
+ if ( $this->_buckets === null ) {
+ $bu = array();
+ foreach ( $this->_servers as $v ) {
+ if ( is_array( $v ) ) {
+ for ( $i = 0; $i < $v[1]; $i++ ) {
+ $bu[] = $v[0];
+ }
+ } else {
+ $bu[] = $v;
+ }
+ }
+ $this->_buckets = $bu;
+ $this->_bucketcount = count( $bu );
+ }
+
+ $realkey = is_array( $key ) ? $key[1] : $key;
+ for ( $tries = 0; $tries < 20; $tries++ ) {
+ $host = $this->_buckets[$hv % $this->_bucketcount];
+ $sock = $this->sock_to_host( $host );
+ if ( is_resource( $sock ) ) {
+ return $sock;
+ }
+ $hv = $this->_hashfunc( $hv . $realkey );
+ }
+
+ return false;
+ }
+
+ // }}}
+ // {{{ _hashfunc()
+
+ /**
+ * Creates a hash integer based on the $key
+ *
+ * @param string $key Key to hash
+ *
+ * @return int Hash value
+ * @access private
+ */
+ function _hashfunc( $key ) {
+ # Hash function must be in [0,0x7ffffff]
+ # We take the first 31 bits of the MD5 hash, which unlike the hash
+ # function used in a previous version of this client, works
+ return hexdec( substr( md5( $key ), 0, 8 ) ) & 0x7fffffff;
+ }
+
+ // }}}
+ // {{{ _incrdecr()
+
+ /**
+ * Perform increment/decriment on $key
+ *
+ * @param string $cmd Command to perform
+ * @param string|array $key Key to perform it on
+ * @param int $amt Amount to adjust
+ *
+ * @return int New value of $key
+ * @access private
+ */
+ function _incrdecr( $cmd, $key, $amt = 1 ) {
+ if ( !$this->_active ) {
+ return null;
+ }
+
+ $sock = $this->get_sock( $key );
+ if ( !is_resource( $sock ) ) {
+ return null;
+ }
+
+ $key = is_array( $key ) ? $key[1] : $key;
+ if ( isset( $this->stats[$cmd] ) ) {
+ $this->stats[$cmd]++;
+ } else {
+ $this->stats[$cmd] = 1;
+ }
+ if ( !$this->_fwrite( $sock, "$cmd $key $amt\r\n" ) ) {
+ return null;
+ }
+
+ $line = $this->_fgets( $sock );
+ $match = array();
+ if ( !preg_match( '/^(\d+)/', $line, $match ) ) {
+ return null;
+ }
+ return $match[1];
+ }
+
+ // }}}
+ // {{{ _load_items()
+
+ /**
+ * Load items into $ret from $sock
+ *
+ * @param Resource $sock Socket to read from
+ * @param array $ret returned values
+ * @param float $casToken [optional]
+ * @return bool True for success, false for failure
+ *
+ * @access private
+ */
+ function _load_items( $sock, &$ret, &$casToken = null ) {
+ $results = array();
+
+ while ( 1 ) {
+ $decl = $this->_fgets( $sock );
+
+ if ( $decl === false ) {
+ /*
+ * If nothing can be read, something is wrong because we know exactly when
+ * to stop reading (right after "END") and we return right after that.
+ */
+ return false;
+ } elseif ( preg_match( '/^VALUE (\S+) (\d+) (\d+) (\d+)$/', $decl, $match ) ) {
+ /*
+ * Read all data returned. This can be either one or multiple values.
+ * Save all that data (in an array) to be processed later: we'll first
+ * want to continue reading until "END" before doing anything else,
+ * to make sure that we don't leave our client in a state where it's
+ * output is not yet fully read.
+ */
+ $results[] = array(
+ $match[1], // rkey
+ $match[2], // flags
+ $match[3], // len
+ $match[4], // casToken
+ $this->_fread( $sock, $match[3] + 2 ), // data
+ );
+ } elseif ( $decl == "END" ) {
+ if ( count( $results ) == 0 ) {
+ return false;
+ }
+
+ /**
+ * All data has been read, time to process the data and build
+ * meaningful return values.
+ */
+ foreach ( $results as $vars ) {
+ list( $rkey, $flags, $len, $casToken, $data ) = $vars;
+
+ if ( $data === false || substr( $data, -2 ) !== "\r\n" ) {
+ $this->_handle_error( $sock,
+ 'line ending missing from data block from $1' );
+ return false;
+ }
+ $data = substr( $data, 0, -2 );
+ $ret[$rkey] = $data;
+
+ if ( $this->_have_zlib && $flags & self::COMPRESSED ) {
+ $ret[$rkey] = gzuncompress( $ret[$rkey] );
+ }
+
+ /*
+ * This unserialize is the exact reason that we only want to
+ * process data after having read until "END" (instead of doing
+ * this right away): "unserialize" can trigger outside code:
+ * in the event that $ret[$rkey] is a serialized object,
+ * unserializing it will trigger __wakeup() if present. If that
+ * function attempted to read from memcached (while we did not
+ * yet read "END"), these 2 calls would collide.
+ */
+ if ( $flags & self::SERIALIZED ) {
+ $ret[$rkey] = $this->unserialize( $ret[$rkey] );
+ } elseif ( $flags & self::INTVAL ) {
+ $ret[$rkey] = intval( $ret[$rkey] );
+ }
+ }
+
+ return true;
+ } else {
+ $this->_handle_error( $sock, 'Error parsing response from $1' );
+ return false;
+ }
+ }
+ }
+
+ // }}}
+ // {{{ _set()
+
+ /**
+ * Performs the requested storage operation to the memcache server
+ *
+ * @param string $cmd Command to perform
+ * @param string $key Key to act on
+ * @param mixed $val What we need to store
+ * @param int $exp (optional) Expiration time. This can be a number of seconds
+ * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
+ * longer must be the timestamp of the time at which the mapping should expire. It
+ * is safe to use timestamps in all cases, regardless of exipration
+ * eg: strtotime("+3 hour")
+ * @param float $casToken [optional]
+ *
+ * @return bool
+ * @access private
+ */
+ function _set( $cmd, $key, $val, $exp, $casToken = null ) {
+ if ( !$this->_active ) {
+ return false;
+ }
+
+ $sock = $this->get_sock( $key );
+ if ( !is_resource( $sock ) ) {
+ return false;
+ }
+
+ if ( isset( $this->stats[$cmd] ) ) {
+ $this->stats[$cmd]++;
+ } else {
+ $this->stats[$cmd] = 1;
+ }
+
+ $flags = 0;
+
+ if ( is_int( $val ) ) {
+ $flags |= self::INTVAL;
+ } elseif ( !is_scalar( $val ) ) {
+ $val = $this->serialize( $val );
+ $flags |= self::SERIALIZED;
+ if ( $this->_debug ) {
+ $this->_debugprint( sprintf( "client: serializing data as it is not scalar" ) );
+ }
+ }
+
+ $len = strlen( $val );
+
+ if ( $this->_have_zlib && $this->_compress_enable
+ && $this->_compress_threshold && $len >= $this->_compress_threshold
+ ) {
+ $c_val = gzcompress( $val, 9 );
+ $c_len = strlen( $c_val );
+
+ if ( $c_len < $len * ( 1 - self::COMPRESSION_SAVINGS ) ) {
+ if ( $this->_debug ) {
+ $this->_debugprint( sprintf( "client: compressing data; was %d bytes is now %d bytes", $len, $c_len ) );
+ }
+ $val = $c_val;
+ $len = $c_len;
+ $flags |= self::COMPRESSED;
+ }
+ }
+
+ $command = "$cmd $key $flags $exp $len";
+ if ( $casToken ) {
+ $command .= " $casToken";
+ }
+
+ if ( !$this->_fwrite( $sock, "$command\r\n$val\r\n" ) ) {
+ return false;
+ }
+
+ $line = $this->_fgets( $sock );
+
+ if ( $this->_debug ) {
+ $this->_debugprint( sprintf( "%s %s (%s)", $cmd, $key, $line ) );
+ }
+ if ( $line === "STORED" ) {
+ return true;
+ } elseif ( $line === "NOT_STORED" && $cmd === "set" ) {
+ // "Not stored" is always used as the mcrouter response with AllAsyncRoute
+ return true;
+ }
+
+ return false;
+ }
+
+ // }}}
+ // {{{ sock_to_host()
+
+ /**
+ * Returns the socket for the host
+ *
+ * @param string $host Host:IP to get socket for
+ *
+ * @return Resource|bool IO Stream or false
+ * @access private
+ */
+ function sock_to_host( $host ) {
+ if ( isset( $this->_cache_sock[$host] ) ) {
+ return $this->_cache_sock[$host];
+ }
+
+ $sock = null;
+ $now = time();
+ list( $ip, /* $port */) = explode( ':', $host );
+ if ( isset( $this->_host_dead[$host] ) && $this->_host_dead[$host] > $now ||
+ isset( $this->_host_dead[$ip] ) && $this->_host_dead[$ip] > $now
+ ) {
+ return null;
+ }
+
+ if ( !$this->_connect_sock( $sock, $host ) ) {
+ return null;
+ }
+
+ // Do not buffer writes
+ stream_set_write_buffer( $sock, 0 );
+
+ $this->_cache_sock[$host] = $sock;
+
+ return $this->_cache_sock[$host];
+ }
+
+ /**
+ * @param string $text
+ */
+ function _debugprint( $text ) {
+ $this->_logger->debug( $text );
+ }
+
+ /**
+ * @param string $text
+ */
+ function _error_log( $text ) {
+ $this->_logger->error( "Memcached error: $text" );
+ }
+
+ /**
+ * Write to a stream. If there is an error, mark the socket dead.
+ *
+ * @param Resource $sock The socket
+ * @param string $buf The string to write
+ * @return bool True on success, false on failure
+ */
+ function _fwrite( $sock, $buf ) {
+ $bytesWritten = 0;
+ $bufSize = strlen( $buf );
+ while ( $bytesWritten < $bufSize ) {
+ $result = fwrite( $sock, $buf );
+ $data = stream_get_meta_data( $sock );
+ if ( $data['timed_out'] ) {
+ $this->_handle_error( $sock, 'timeout writing to $1' );
+ return false;
+ }
+ // Contrary to the documentation, fwrite() returns zero on error in PHP 5.3.
+ if ( $result === false || $result === 0 ) {
+ $this->_handle_error( $sock, 'error writing to $1' );
+ return false;
+ }
+ $bytesWritten += $result;
+ }
+
+ return true;
+ }
+
+ /**
+ * Handle an I/O error. Mark the socket dead and log an error.
+ *
+ * @param Resource $sock
+ * @param string $msg
+ */
+ function _handle_error( $sock, $msg ) {
+ $peer = stream_socket_get_name( $sock, true /** remote **/ );
+ if ( strval( $peer ) === '' ) {
+ $peer = array_search( $sock, $this->_cache_sock );
+ if ( $peer === false ) {
+ $peer = '[unknown host]';
+ }
+ }
+ $msg = str_replace( '$1', $peer, $msg );
+ $this->_error_log( "$msg" );
+ $this->_dead_sock( $sock );
+ }
+
+ /**
+ * Read the specified number of bytes from a stream. If there is an error,
+ * mark the socket dead.
+ *
+ * @param Resource $sock The socket
+ * @param int $len The number of bytes to read
+ * @return string|bool The string on success, false on failure.
+ */
+ function _fread( $sock, $len ) {
+ $buf = '';
+ while ( $len > 0 ) {
+ $result = fread( $sock, $len );
+ $data = stream_get_meta_data( $sock );
+ if ( $data['timed_out'] ) {
+ $this->_handle_error( $sock, 'timeout reading from $1' );
+ return false;
+ }
+ if ( $result === false ) {
+ $this->_handle_error( $sock, 'error reading buffer from $1' );
+ return false;
+ }
+ if ( $result === '' ) {
+ // This will happen if the remote end of the socket is shut down
+ $this->_handle_error( $sock, 'unexpected end of file reading from $1' );
+ return false;
+ }
+ $len -= strlen( $result );
+ $buf .= $result;
+ }
+ return $buf;
+ }
+
+ /**
+ * Read a line from a stream. If there is an error, mark the socket dead.
+ * The \r\n line ending is stripped from the response.
+ *
+ * @param Resource $sock The socket
+ * @return string|bool The string on success, false on failure
+ */
+ function _fgets( $sock ) {
+ $result = fgets( $sock );
+ // fgets() may return a partial line if there is a select timeout after
+ // a successful recv(), so we have to check for a timeout even if we
+ // got a string response.
+ $data = stream_get_meta_data( $sock );
+ if ( $data['timed_out'] ) {
+ $this->_handle_error( $sock, 'timeout reading line from $1' );
+ return false;
+ }
+ if ( $result === false ) {
+ $this->_handle_error( $sock, 'error reading line from $1' );
+ return false;
+ }
+ if ( substr( $result, -2 ) === "\r\n" ) {
+ $result = substr( $result, 0, -2 );
+ } elseif ( substr( $result, -1 ) === "\n" ) {
+ $result = substr( $result, 0, -1 );
+ } else {
+ $this->_handle_error( $sock, 'line ending missing in response from $1' );
+ return false;
+ }
+ return $result;
+ }
+
+ /**
+ * Flush the read buffer of a stream
+ * @param Resource $f
+ */
+ function _flush_read_buffer( $f ) {
+ if ( !is_resource( $f ) ) {
+ return;
+ }
+ $r = array( $f );
+ $w = null;
+ $e = null;
+ $n = stream_select( $r, $w, $e, 0, 0 );
+ while ( $n == 1 && !feof( $f ) ) {
+ fread( $f, 1024 );
+ $r = array( $f );
+ $w = null;
+ $e = null;
+ $n = stream_select( $r, $w, $e, 0, 0 );
+ }
+ }
+
+ // }}}
+ // }}}
+ // }}}
+}
+
+// }}}
/** @var string[] (server index => tag/host name) */
protected $serverTags;
/** @var int */
- protected $numServers;
+ protected $numServerShards;
/** @var int UNIX timestamp */
protected $lastGarbageCollect = 0;
/** @var int */
/** @var int */
protected $purgeLimit = 100;
/** @var int */
- protected $shards = 1;
+ protected $numTableShards = 1;
/** @var string */
protected $tableName = 'objectcache';
/** @var bool */
if ( isset( $params['servers'] ) ) {
$this->serverInfos = [];
$this->serverTags = [];
- $this->numServers = count( $params['servers'] );
+ $this->numServerShards = count( $params['servers'] );
$index = 0;
foreach ( $params['servers'] as $tag => $info ) {
$this->serverInfos[$index] = $info;
}
} elseif ( isset( $params['server'] ) ) {
$this->serverInfos = [ $params['server'] ];
- $this->numServers = count( $this->serverInfos );
+ $this->numServerShards = count( $this->serverInfos );
} else {
// Default to using the main wiki's database servers
$this->serverInfos = false;
- $this->numServers = 1;
+ $this->numServerShards = 1;
$this->attrMap[self::ATTR_SYNCWRITES] = self::QOS_SYNCWRITES_BE;
}
if ( isset( $params['purgePeriod'] ) ) {
$this->tableName = $params['tableName'];
}
if ( isset( $params['shards'] ) ) {
- $this->shards = intval( $params['shards'] );
+ $this->numTableShards = intval( $params['shards'] );
}
// Backwards-compatibility for < 1.34
$this->replicaOnly = $params['replicaOnly'] ?? ( $params['slaveOnly'] ?? false );
/**
* Get a connection to the specified database
*
- * @param int $serverIndex
+ * @param int $shardIndex
* @return IMaintainableDatabase
* @throws MWException
*/
- protected function getDB( $serverIndex ) {
- if ( $serverIndex >= $this->numServers ) {
- throw new MWException( __METHOD__ . ": Invalid server index \"$serverIndex\"" );
+ private function getDB( $shardIndex ) {
+ if ( $shardIndex >= $this->numServerShards ) {
+ throw new MWException( __METHOD__ . ": Invalid server index \"$shardIndex\"" );
}
# Don't keep timing out trying to connect for each call if the DB is down
if (
- isset( $this->connFailureErrors[$serverIndex] ) &&
- ( $this->getCurrentTime() - $this->connFailureTimes[$serverIndex] ) < 60
+ isset( $this->connFailureErrors[$shardIndex] ) &&
+ ( $this->getCurrentTime() - $this->connFailureTimes[$shardIndex] ) < 60
) {
- throw $this->connFailureErrors[$serverIndex];
+ throw $this->connFailureErrors[$shardIndex];
}
if ( $this->serverInfos ) {
- if ( !isset( $this->conns[$serverIndex] ) ) {
+ if ( !isset( $this->conns[$shardIndex] ) ) {
// Use custom database defined by server connection info
- $info = $this->serverInfos[$serverIndex];
+ $info = $this->serverInfos[$shardIndex];
$type = $info['type'] ?? 'mysql';
$host = $info['host'] ?? '[unknown]';
$this->logger->debug( __CLASS__ . ": connecting to $host" );
$db = Database::factory( $type, $info );
$db->clearFlag( DBO_TRX ); // auto-commit mode
- $this->conns[$serverIndex] = $db;
+ $this->conns[$shardIndex] = $db;
}
- $db = $this->conns[$serverIndex];
+ $db = $this->conns[$shardIndex];
} else {
// Use the main LB database
$lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
* @param string $key
* @return array Server index and table name
*/
- protected function getTableByKey( $key ) {
- if ( $this->shards > 1 ) {
+ private function getTableByKey( $key ) {
+ if ( $this->numTableShards > 1 ) {
$hash = hexdec( substr( md5( $key ), 0, 8 ) ) & 0x7fffffff;
- $tableIndex = $hash % $this->shards;
+ $tableIndex = $hash % $this->numTableShards;
} else {
$tableIndex = 0;
}
- if ( $this->numServers > 1 ) {
+ if ( $this->numServerShards > 1 ) {
$sortedServers = $this->serverTags;
ArrayUtils::consistentHashSort( $sortedServers, $key );
reset( $sortedServers );
- $serverIndex = key( $sortedServers );
+ $shardIndex = key( $sortedServers );
} else {
- $serverIndex = 0;
+ $shardIndex = 0;
}
- return [ $serverIndex, $this->getTableNameByShard( $tableIndex ) ];
+ return [ $shardIndex, $this->getTableNameByShard( $tableIndex ) ];
}
/**
* @param int $index
* @return string
*/
- protected function getTableNameByShard( $index ) {
- if ( $this->shards > 1 ) {
- $decimals = strlen( $this->shards - 1 );
+ private function getTableNameByShard( $index ) {
+ if ( $this->numTableShards > 1 ) {
+ $decimals = strlen( $this->numTableShards - 1 );
return $this->tableName .
sprintf( "%0{$decimals}d", $index );
} else {
return $values;
}
- protected function fetchBlobMulti( array $keys, $flags = 0 ) {
+ private function fetchBlobMulti( array $keys, $flags = 0 ) {
$values = []; // array of (key => value)
$keysByTable = [];
foreach ( $keys as $key ) {
- list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
- $keysByTable[$serverIndex][$tableName][] = $key;
+ list( $shardIndex, $tableName ) = $this->getTableByKey( $key );
+ $keysByTable[$shardIndex][$tableName][] = $key;
}
$dataRows = [];
- foreach ( $keysByTable as $serverIndex => $serverKeys ) {
+ foreach ( $keysByTable as $shardIndex => $serverKeys ) {
try {
- $db = $this->getDB( $serverIndex );
+ $db = $this->getDB( $shardIndex );
foreach ( $serverKeys as $tableName => $tableKeys ) {
$res = $db->select( $tableName,
[ 'keyname', 'value', 'exptime' ],
continue;
}
foreach ( $res as $row ) {
- $row->serverIndex = $serverIndex;
+ $row->shardIndex = $shardIndex;
$row->tableName = $tableName;
$dataRows[$row->keyname] = $row;
}
}
} catch ( DBError $e ) {
- $this->handleReadError( $e, $serverIndex );
+ $this->handleReadError( $e, $shardIndex );
}
}
$this->debug( "get: retrieved data; expiry time is " . $row->exptime );
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $row->serverIndex );
+ $db = $this->getDB( $row->shardIndex );
if ( $this->isExpired( $db, $row->exptime ) ) { // MISS
$this->debug( "get: key has expired" );
} else { // HIT
$values[$key] = $db->decodeBlob( $row->value );
}
} catch ( DBQueryError $e ) {
- $this->handleWriteError( $e, $db, $row->serverIndex );
+ $this->handleWriteError( $e, $db, $row->shardIndex );
}
} else { // MISS
$this->debug( 'get: no matching rows' );
private function modifyMulti( array $data, $exptime, $flags, $op ) {
$keysByTable = [];
foreach ( $data as $key => $value ) {
- list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
- $keysByTable[$serverIndex][$tableName][] = $key;
+ list( $shardIndex, $tableName ) = $this->getTableByKey( $key );
+ $keysByTable[$shardIndex][$tableName][] = $key;
}
$exptime = $this->getExpirationAsTimestamp( $exptime );
$result = true;
/** @noinspection PhpUnusedLocalVariableInspection */
$silenceScope = $this->silenceTransactionProfiler();
- foreach ( $keysByTable as $serverIndex => $serverKeys ) {
+ foreach ( $keysByTable as $shardIndex => $serverKeys ) {
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $serverIndex );
+ $db = $this->getDB( $shardIndex );
$this->occasionallyGarbageCollect( $db ); // expire old entries if any
$dbExpiry = $exptime ? $db->timestamp( $exptime ) : $this->getMaxDateTime( $db );
} catch ( DBError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
$result = false;
continue;
}
$dbExpiry
) && $result;
} catch ( DBError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
$result = false;
}
}
protected function doCas( $casToken, $key, $value, $exptime = 0, $flags = 0 ) {
- list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
+ list( $shardIndex, $tableName ) = $this->getTableByKey( $key );
$exptime = $this->getExpirationAsTimestamp( $exptime );
/** @noinspection PhpUnusedLocalVariableInspection */
$silenceScope = $this->silenceTransactionProfiler();
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $serverIndex );
+ $db = $this->getDB( $shardIndex );
// (T26425) use a replace if the db supports it instead of
// delete/insert to avoid clashes with conflicting keynames
$db->update(
__METHOD__
);
} catch ( DBQueryError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
return false;
}
}
public function incr( $key, $step = 1 ) {
- list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
+ list( $shardIndex, $tableName ) = $this->getTableByKey( $key );
$newCount = false;
/** @noinspection PhpUnusedLocalVariableInspection */
$silenceScope = $this->silenceTransactionProfiler();
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $serverIndex );
+ $db = $this->getDB( $shardIndex );
$encTimestamp = $db->addQuotes( $db->timestamp() );
$db->update(
$tableName,
}
}
} catch ( DBError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
}
return $newCount;
* @param string $exptime
* @return bool
*/
- protected function isExpired( $db, $exptime ) {
+ private function isExpired( $db, $exptime ) {
return (
$exptime != $this->getMaxDateTime( $db ) &&
wfTimestamp( TS_UNIX, $exptime ) < $this->getCurrentTime()
* @param IDatabase $db
* @return string
*/
- protected function getMaxDateTime( $db ) {
+ private function getMaxDateTime( $db ) {
if ( (int)$this->getCurrentTime() > 0x7fffffff ) {
return $db->timestamp( 1 << 62 );
} else {
* @param IDatabase $db
* @throws DBError
*/
- protected function occasionallyGarbageCollect( IDatabase $db ) {
+ private function occasionallyGarbageCollect( IDatabase $db ) {
if (
// Random purging is enabled
$this->purgePeriod &&
/** @noinspection PhpUnusedLocalVariableInspection */
$silenceScope = $this->silenceTransactionProfiler();
- $serverIndexes = range( 0, $this->numServers - 1 );
- shuffle( $serverIndexes );
+ $shardIndexes = range( 0, $this->numServerShards - 1 );
+ shuffle( $shardIndexes );
$ok = true;
$keysDeletedCount = 0;
- foreach ( $serverIndexes as $numServersDone => $serverIndex ) {
+ foreach ( $shardIndexes as $numServersDone => $shardIndex ) {
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $serverIndex );
+ $db = $this->getDB( $shardIndex );
$this->deleteServerObjectsExpiringBefore(
$db,
$timestamp,
$keysDeletedCount
);
} catch ( DBError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
$ok = false;
}
}
&$keysDeletedCount = 0
) {
$cutoffUnix = wfTimestamp( TS_UNIX, $timestamp );
- $shardIndexes = range( 0, $this->shards - 1 );
+ $shardIndexes = range( 0, $this->numTableShards - 1 );
shuffle( $shardIndexes );
foreach ( $shardIndexes as $numShardsDone => $shardIndex ) {
if ( $lag ) {
$remainingLag = $cutoffUnix - wfTimestamp( TS_UNIX, $continue );
$processedLag = max( $lag - $remainingLag, 0 );
- $doneRatio = ( $numShardsDone + $processedLag / $lag ) / $this->shards;
+ $doneRatio = ( $numShardsDone + $processedLag / $lag ) / $this->numTableShards;
} else {
$doneRatio = 1;
}
- $overallRatio = ( $doneRatio / $this->numServers )
- + ( $serversDoneCount / $this->numServers );
+ $overallRatio = ( $doneRatio / $this->numServerShards )
+ + ( $serversDoneCount / $this->numServerShards );
call_user_func( $progressCallback, $overallRatio * 100 );
}
} while ( $res->numRows() && $keysDeletedCount < $limit );
public function deleteAll() {
/** @noinspection PhpUnusedLocalVariableInspection */
$silenceScope = $this->silenceTransactionProfiler();
- for ( $serverIndex = 0; $serverIndex < $this->numServers; $serverIndex++ ) {
+ for ( $shardIndex = 0; $shardIndex < $this->numServerShards; $shardIndex++ ) {
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $serverIndex );
- for ( $i = 0; $i < $this->shards; $i++ ) {
+ $db = $this->getDB( $shardIndex );
+ for ( $i = 0; $i < $this->numTableShards; $i++ ) {
$db->delete( $this->getTableNameByShard( $i ), '*', __METHOD__ );
}
} catch ( DBError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
return false;
}
}
}
}
- list( $serverIndex ) = $this->getTableByKey( $key );
+ list( $shardIndex ) = $this->getTableByKey( $key );
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $serverIndex );
+ $db = $this->getDB( $shardIndex );
$ok = $db->lock( $key, __METHOD__, $timeout );
if ( $ok ) {
$this->locks[$key] = [ 'class' => $rclass, 'depth' => 1 ];
return $ok;
} catch ( DBError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
$ok = false;
}
if ( --$this->locks[$key]['depth'] <= 0 ) {
unset( $this->locks[$key] );
- list( $serverIndex ) = $this->getTableByKey( $key );
+ list( $shardIndex ) = $this->getTableByKey( $key );
$db = null; // in case of connection failure
try {
- $db = $this->getDB( $serverIndex );
+ $db = $this->getDB( $shardIndex );
$ok = $db->unlock( $key, __METHOD__ );
if ( !$ok ) {
$this->logger->warning(
);
}
} catch ( DBError $e ) {
- $this->handleWriteError( $e, $db, $serverIndex );
+ $this->handleWriteError( $e, $db, $shardIndex );
$ok = false;
}
* Handle a DBError which occurred during a read operation.
*
* @param DBError $exception
- * @param int $serverIndex
+ * @param int $shardIndex
*/
- protected function handleReadError( DBError $exception, $serverIndex ) {
+ private function handleReadError( DBError $exception, $shardIndex ) {
if ( $exception instanceof DBConnectionError ) {
- $this->markServerDown( $exception, $serverIndex );
+ $this->markServerDown( $exception, $shardIndex );
}
$this->setAndLogDBError( $exception );
*
* @param DBError $exception
* @param IDatabase|null $db DB handle or null if connection failed
- * @param int $serverIndex
+ * @param int $shardIndex
* @throws Exception
*/
- protected function handleWriteError( DBError $exception, $db, $serverIndex ) {
+ private function handleWriteError( DBError $exception, $db, $shardIndex ) {
if ( !( $db instanceof IDatabase ) ) {
- $this->markServerDown( $exception, $serverIndex );
+ $this->markServerDown( $exception, $shardIndex );
}
$this->setAndLogDBError( $exception );
* Mark a server down due to a DBConnectionError exception
*
* @param DBError $exception
- * @param int $serverIndex
+ * @param int $shardIndex
*/
- protected function markServerDown( DBError $exception, $serverIndex ) {
- unset( $this->conns[$serverIndex] ); // bug T103435
+ private function markServerDown( DBError $exception, $shardIndex ) {
+ unset( $this->conns[$shardIndex] ); // bug T103435
$now = $this->getCurrentTime();
- if ( isset( $this->connFailureTimes[$serverIndex] ) ) {
- if ( $now - $this->connFailureTimes[$serverIndex] >= 60 ) {
- unset( $this->connFailureTimes[$serverIndex] );
- unset( $this->connFailureErrors[$serverIndex] );
+ if ( isset( $this->connFailureTimes[$shardIndex] ) ) {
+ if ( $now - $this->connFailureTimes[$shardIndex] >= 60 ) {
+ unset( $this->connFailureTimes[$shardIndex] );
+ unset( $this->connFailureErrors[$shardIndex] );
} else {
- $this->logger->debug( __METHOD__ . ": Server #$serverIndex already down" );
+ $this->logger->debug( __METHOD__ . ": Server #$shardIndex already down" );
return;
}
}
- $this->logger->info( __METHOD__ . ": Server #$serverIndex down until " . ( $now + 60 ) );
- $this->connFailureTimes[$serverIndex] = $now;
- $this->connFailureErrors[$serverIndex] = $exception;
+ $this->logger->info( __METHOD__ . ": Server #$shardIndex down until " . ( $now + 60 ) );
+ $this->connFailureTimes[$shardIndex] = $now;
+ $this->connFailureErrors[$shardIndex] = $exception;
}
/**
* Create shard tables. For use from eval.php.
*/
public function createTables() {
- for ( $serverIndex = 0; $serverIndex < $this->numServers; $serverIndex++ ) {
- $db = $this->getDB( $serverIndex );
+ for ( $shardIndex = 0; $shardIndex < $this->numServerShards; $shardIndex++ ) {
+ $db = $this->getDB( $shardIndex );
if ( $db->getType() !== 'mysql' ) {
throw new MWException( __METHOD__ . ' is not supported on this DB server' );
}
- for ( $i = 0; $i < $this->shards; $i++ ) {
+ for ( $i = 0; $i < $this->numTableShards; $i++ ) {
$db->query(
'CREATE TABLE ' . $db->tableName( $this->getTableNameByShard( $i ) ) .
' LIKE ' . $db->tableName( 'objectcache' ),
/**
* @return bool Whether the main DB is used, e.g. wfGetDB( DB_MASTER )
*/
- protected function usesMainDB() {
+ private function usesMainDB() {
return !$this->serverInfos;
}
- protected function waitForReplication() {
+ private function waitForReplication() {
if ( !$this->usesMainDB() ) {
// Custom DB server list; probably doesn't use replication
return true;
}
/**
- * Returns a ScopedCallback which resets the silence flag in the transaction profiler when it is
- * destroyed on the end of a scope, for example on return or throw
- * @return ScopedCallback
- * @since 1.32
+ * Silence the transaction profiler until the return value falls out of scope
+ *
+ * @return ScopedCallback|null
*/
- protected function silenceTransactionProfiler() {
+ private function silenceTransactionProfiler() {
+ if ( !$this->usesMainDB() ) {
+ // Custom DB is configured which either has no TransactionProfiler injected,
+ // or has one specific for cache use, which we shouldn't silence
+ return null;
+ }
+
$trxProfiler = Profiler::instance()->getTransactionProfiler();
$oldSilenced = $trxProfiler->setSilenced( true );
return new ScopedCallback( function () use ( $trxProfiler, $oldSilenced ) {
dépôts / lhc / web / wiklou.git / commitdiff