<?php
+// @codingStandardsIgnoreFile It's an external lib and it isn't. Let's not bother.
/**
+ * Memcached client for PHP.
+ *
* +---------------------------------------------------------------------------+
* | memcached client, PHP |
* +---------------------------------------------------------------------------+
*/
/**
- * This is the PHP client for memcached - a distributed memory cache daemon.
+ * This is a PHP client for memcached - a distributed memory cache daemon.
+ *
* More information is available at http://www.danga.com/memcached/
*
* Usage example:
*
- * require_once 'memcached.php';
- *
- * $mc = new MWMemcached(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,
- * 'persistant' => true));
+ * $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');
+ * $mc->add( 'key', array( 'some', 'array' ) );
+ * $mc->replace( 'key', 'some random string' );
+ * $val = $mc->get( 'key' );
*
- * @author Ryan T. Dean <rtdean@cytherianage.net>
+ * @author Ryan T. Dean <rtdean@cytherianage.net>
* @version 0.1.2
*/
-// {{{ requirements
-// }}}
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
-// {{{ class MWMemcached
+// {{{ class MemcachedClient
/**
* memcached client class implemented using (p)fsockopen()
*
* @author Ryan T. Dean <rtdean@cytherianage.net>
* @ingroup Cache
*/
-class MWMemcached {
+class MemcachedClient {
// {{{ properties
// {{{ public
*/
const COMPRESSED = 2;
+ /**
+ * Flag: indicates data is an integer
+ */
+ const INTVAL = 4;
+
// }}}
/**
// }}}
-
/**
* Command statistics
*
- * @var array
- * @access public
+ * @var array
+ * @access public
*/
- var $stats;
+ public $stats;
// }}}
// {{{ private
/**
* Cached Sockets that are connected
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
- var $_cache_sock;
+ public $_cache_sock;
/**
* Current debug status; 0 - none to 9 - profiling
*
- * @var boolean
- * @access private
+ * @var bool
+ * @access private
*/
- var $_debug;
+ public $_debug;
/**
* Dead hosts, assoc array, 'host'=>'unixtime when ok to check again'
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
- var $_host_dead;
+ public $_host_dead;
/**
* Is compression available?
*
- * @var boolean
- * @access private
+ * @var bool
+ * @access private
*/
- var $_have_zlib;
+ public $_have_zlib;
/**
* Do we want to use compression?
*
- * @var boolean
- * @access private
+ * @var bool
+ * @access private
*/
- var $_compress_enable;
+ public $_compress_enable;
/**
* At how many bytes should we compress?
*
- * @var integer
- * @access private
+ * @var int
+ * @access private
*/
- var $_compress_threshold;
+ public $_compress_threshold;
/**
- * Are we using persistant links?
+ * Are we using persistent links?
*
- * @var boolean
- * @access private
+ * @var bool
+ * @access private
*/
- var $_persistant;
+ public $_persistent;
/**
* If only using one server; contains ip:port to connect to
*
- * @var string
- * @access private
+ * @var string
+ * @access private
*/
- var $_single_sock;
+ public $_single_sock;
/**
* Array containing ip:port or array(ip:port, weight)
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
- var $_servers;
+ public $_servers;
/**
* Our bit buckets
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
- var $_buckets;
+ public $_buckets;
/**
* Total # of bit buckets we have
*
- * @var integer
- * @access private
+ * @var int
+ * @access private
*/
- var $_bucketcount;
+ public $_bucketcount;
/**
* # of total servers we have
*
- * @var integer
- * @access private
+ * @var int
+ * @access private
*/
- var $_active;
+ public $_active;
/**
* Stream timeout in seconds. Applies for example to fread()
*
- * @var integer
- * @access private
+ * @var int
+ * @access private
*/
- var $_timeout_seconds;
+ public $_timeout_seconds;
/**
* Stream timeout in microseconds
*
- * @var integer
- * @access private
+ * @var int
+ * @access private
*/
- var $_timeout_microseconds;
+ public $_timeout_microseconds;
/**
* Connect timeout in seconds
*/
- var $_connect_timeout;
+ public $_connect_timeout;
/**
* Number of connection attempts for each server
*/
- var $_connect_attempts;
+ public $_connect_attempts;
+
+ /**
+ * @var LoggerInterface
+ */
+ private $_logger;
// }}}
// }}}
/**
* Memcache initializer
*
- * @param $args Array Associative array of settings
+ * @param array $args Associative array of settings
*
- * @return mixed
+ * @return mixed
*/
public function __construct( $args ) {
- global $wgMemCachedTimeout;
$this->set_servers( isset( $args['servers'] ) ? $args['servers'] : array() );
$this->_debug = isset( $args['debug'] ) ? $args['debug'] : false;
$this->stats = array();
$this->_compress_threshold = isset( $args['compress_threshold'] ) ? $args['compress_threshold'] : 0;
- $this->_persistant = isset( $args['persistant'] ) ? $args['persistant'] : false;
+ $this->_persistent = isset( $args['persistent'] ) ? $args['persistent'] : false;
$this->_compress_enable = true;
$this->_have_zlib = function_exists( 'gzcompress' );
$this->_host_dead = array();
$this->_timeout_seconds = 0;
- $this->_timeout_microseconds = $wgMemCachedTimeout;
+ $this->_timeout_microseconds = isset( $args['timeout'] ) ? $args['timeout'] : 500000;
- $this->_connect_timeout = 0.01;
+ $this->_connect_timeout = isset( $args['connect_timeout'] ) ? $args['connect_timeout'] : 0.1;
$this->_connect_attempts = 2;
+
+ $this->_logger = isset( $args['logger'] ) ? $args['logger'] : new NullLogger();
}
// }}}
* Adds a key/value to the memcache server if one isn't already set with
* that key
*
- * @param $key String: key to set with data
- * @param $val Mixed: value to store
- * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
+ * @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 exipration
+ * is safe to use timestamps in all cases, regardless of expiration
* eg: strtotime("+3 hour")
*
- * @return Boolean
+ * @return bool
*/
public function add( $key, $val, $exp = 0 ) {
return $this->_set( 'add', $key, $val, $exp );
/**
* Decrease a value stored on the memcache server
*
- * @param $key String: key to decrease
- * @param $amt Integer: (optional) amount to decrease
+ * @param string $key Key to decrease
+ * @param int $amt (optional) amount to decrease
*
- * @return Mixed: FALSE on failure, value on success
+ * @return mixed False on failure, value on success
*/
public function decr( $key, $amt = 1 ) {
return $this->_incrdecr( 'decr', $key, $amt );
/**
* Deletes a key from the server, optionally after $time
*
- * @param $key String: key to delete
- * @param $time Integer: (optional) how long to wait before deleting
+ * @param string $key Key to delete
+ * @param int $time (optional) how long to wait before deleting
*
- * @return Boolean: TRUE on success, FALSE on failure
+ * @return bool True on success, false on failure
*/
public function delete( $key, $time = 0 ) {
if ( !$this->_active ) {
$this->stats['delete'] = 1;
}
$cmd = "delete $key $time\r\n";
- if( !$this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
- $this->_dead_sock( $sock );
+ if ( !$this->_fwrite( $sock, $cmd ) ) {
return false;
}
- $res = trim( fgets( $sock ) );
+ $res = $this->_fgets( $sock );
if ( $this->_debug ) {
- $this->_debugprint( sprintf( "MemCache: delete %s (%s)\n", $key, $res ) );
+ $this->_debugprint( sprintf( "MemCache: delete %s (%s)", $key, $res ) );
}
- if ( $res == "DELETED" ) {
+ if ( $res == "DELETED" || $res == "NOT_FOUND" ) {
return true;
}
+
return false;
}
+ /**
+ * Changes the TTL on a key from the server to $time
+ *
+ * @param string $key 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;
+ }
+
+ /**
+ * @param string $key
+ * @param int $timeout
+ * @return bool
+ */
+ public function lock( $key, $timeout = 0 ) {
+ /* stub */
+ return true;
+ }
+
+ /**
+ * @param string $key
+ * @return bool
+ */
+ public function unlock( $key ) {
+ /* stub */
+ return true;
+ }
+
// }}}
// {{{ disconnect_all()
/**
* Enable / Disable compression
*
- * @param $enable Boolean: TRUE to enable, FALSE to disable
+ * @param bool $enable True to enable, false to disable
*/
public function enable_compress( $enable ) {
$this->_compress_enable = $enable;
/**
* Retrieves the value associated with the key from the memcache server
*
- * @param $key Mixed: key to retrieve
+ * @param array|string $key key to retrieve
+ * @param float $casToken [optional]
*
- * @return Mixed
+ * @return mixed
*/
- public function get( $key ) {
- wfProfileIn( __METHOD__ );
-
+ public function get( $key, &$casToken = null ) {
if ( $this->_debug ) {
- $this->_debugprint( "get($key)\n" );
+ $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 ) {
- wfProfileOut( __METHOD__ );
return false;
}
$sock = $this->get_sock( $key );
if ( !is_resource( $sock ) ) {
- wfProfileOut( __METHOD__ );
return false;
}
+ $key = is_array( $key ) ? $key[1] : $key;
if ( isset( $this->stats['get'] ) ) {
$this->stats['get']++;
} else {
$this->stats['get'] = 1;
}
- $cmd = "get $key\r\n";
- if ( !$this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
- $this->_dead_sock( $sock );
- wfProfileOut( __METHOD__ );
+ $cmd = "gets $key\r\n";
+ if ( !$this->_fwrite( $sock, $cmd ) ) {
return false;
}
$val = array();
- $this->_load_items( $sock, $val );
+ $this->_load_items( $sock, $val, $casToken );
if ( $this->_debug ) {
foreach ( $val as $k => $v ) {
- $this->_debugprint( sprintf( "MemCache: sock %s got %s\n", serialize( $sock ), $k ) );
+ $this->_debugprint( sprintf( "MemCache: sock %s got %s", serialize( $sock ), $k ) );
}
}
- wfProfileOut( __METHOD__ );
- return @$val[$key];
+ $value = false;
+ if ( isset( $val[$key] ) ) {
+ $value = $val[$key];
+ }
+ return $value;
}
// }}}
/**
* Get multiple keys from the server(s)
*
- * @param $keys Array: keys to retrieve
+ * @param array $keys Keys to retrieve
*
- * @return Array
+ * @return array
*/
public function get_multi( $keys ) {
if ( !$this->_active ) {
- return false;
+ return array();
}
if ( isset( $this->stats['get_multi'] ) ) {
$this->stats['get_multi'] = 1;
}
$sock_keys = array();
-
+ $socks = array();
foreach ( $keys as $key ) {
$sock = $this->get_sock( $key );
if ( !is_resource( $sock ) ) {
}
$key = is_array( $key ) ? $key[1] : $key;
if ( !isset( $sock_keys[$sock] ) ) {
- $sock_keys[$sock] = array();
+ $sock_keys[intval( $sock )] = array();
$socks[] = $sock;
}
- $sock_keys[$sock][] = $key;
+ $sock_keys[intval( $sock )][] = $key;
}
+ $gather = array();
// Send out the requests
foreach ( $socks as $sock ) {
- $cmd = 'get';
- foreach ( $sock_keys[$sock] as $key ) {
+ $cmd = 'gets';
+ foreach ( $sock_keys[intval( $sock )] as $key ) {
$cmd .= ' ' . $key;
}
$cmd .= "\r\n";
- if ( $this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
+ if ( $this->_fwrite( $sock, $cmd ) ) {
$gather[] = $sock;
- } else {
- $this->_dead_sock( $sock );
}
}
// Parse responses
$val = array();
foreach ( $gather as $sock ) {
- $this->_load_items( $sock, $val );
+ $this->_load_items( $sock, $val, $casToken );
}
if ( $this->_debug ) {
foreach ( $val as $k => $v ) {
- $this->_debugprint( sprintf( "MemCache: got %s\n", $k ) );
+ $this->_debugprint( sprintf( "MemCache: got %s", $k ) );
}
}
/**
* Increments $key (optionally) by $amt
*
- * @param $key String: key to increment
- * @param $amt Integer: (optional) amount to increment
+ * @param string $key Key to increment
+ * @param int $amt (optional) amount to increment
*
- * @return Integer: null if the key does not exist yet (this does NOT
+ * @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.
*/
/**
* Overwrites an existing value for key; only works if key is already set
*
- * @param $key String: key to set value as
- * @param $value Mixed: value to store
- * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
+ * @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 Boolean
+ * @return bool
*/
public function replace( $key, $value, $exp = 0 ) {
return $this->_set( 'replace', $key, $value, $exp );
* Passes through $cmd to the memcache server connected by $sock; returns
* output as an array (null array if no output)
*
- * NOTE: due to a possible bug in how PHP reads while using fgets(), each
- * line may not be terminated by a \r\n. More specifically, my testing
- * has shown that, on FreeBSD at least, each line is terminated only
- * with a \n. This is with the PHP flag auto_detect_line_endings set
- * to falase (the default).
- *
- * @param $sock Ressource: socket to send command on
- * @param $cmd String: command to run
+ * @param Resource $sock Socket to send command on
+ * @param string $cmd Command to run
*
- * @return Array: output array
+ * @return array Output array
*/
public function run_command( $sock, $cmd ) {
if ( !is_resource( $sock ) ) {
return array();
}
- if ( !$this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
+ if ( !$this->_fwrite( $sock, $cmd ) ) {
return array();
}
+ $ret = array();
while ( true ) {
- $res = fgets( $sock );
+ $res = $this->_fgets( $sock );
$ret[] = $res;
if ( preg_match( '/^END/', $res ) ) {
break;
* Unconditionally sets a key to a given value in the memcache. Returns true
* if set successfully.
*
- * @param $key String: key to set value as
- * @param $value Mixed: value to set
- * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
+ * @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 Boolean: TRUE on success
+ * @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()
/**
- * Sets the compression threshold
+ * Set the compression threshold
*
- * @param $thresh Integer: threshold to compress if larger than
+ * @param int $thresh Threshold to compress if larger than
*/
public function set_compress_threshold( $thresh ) {
$this->_compress_threshold = $thresh;
// {{{ set_debug()
/**
- * Sets the debug flag
- *
- * @param $dbg Boolean: TRUE for debugging, FALSE otherwise
+ * Set the debug flag
*
- * @see MWMemcached::__construct
+ * @see __construct()
+ * @param bool $dbg True for debugging, false otherwise
*/
public function set_debug( $dbg ) {
$this->_debug = $dbg;
// {{{ set_servers()
/**
- * Sets the server list to distribute key gets and puts between
+ * Set the server list to distribute key gets and puts between
*
- * @param $list Array of servers to connect to
- *
- * @see MWMemcached::__construct()
+ * @see __construct()
+ * @param array $list Array of servers to connect to
*/
public function set_servers( $list ) {
$this->_servers = $list;
/**
* Sets the timeout for new connections
*
- * @param $seconds Integer: number of seconds
- * @param $microseconds Integer: number of microseconds
+ * @param int $seconds Number of seconds
+ * @param int $microseconds Number of microseconds
*/
public function set_timeout( $seconds, $microseconds ) {
$this->_timeout_seconds = $seconds;
/**
* Close the specified socket
*
- * @param $sock String: socket to close
+ * @param string $sock Socket to close
*
- * @access private
+ * @access private
*/
function _close_sock( $sock ) {
$host = array_search( $sock, $this->_cache_sock );
/**
* Connects $sock to $host, timing out after $timeout
*
- * @param $sock Integer: socket to connect
- * @param $host String: Host:IP to connect to
+ * @param int $sock Socket to connect
+ * @param string $host Host:IP to connect to
*
- * @return boolean
- * @access private
+ * @return bool
+ * @access private
*/
function _connect_sock( &$sock, $host ) {
- list( $ip, $port ) = explode( ':', $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++ ) {
- wfSuppressWarnings();
- if ( $this->_persistant == 1 ) {
+ for ( $i = 0; !$sock && $i < $this->_connect_attempts; $i++ ) {
+ MediaWiki\suppressWarnings();
+ if ( $this->_persistent == 1 ) {
$sock = pfsockopen( $ip, $port, $errno, $errstr, $timeout );
} else {
$sock = fsockopen( $ip, $port, $errno, $errstr, $timeout );
}
- wfRestoreWarnings();
+ MediaWiki\restoreWarnings();
}
if ( !$sock ) {
- if ( $this->_debug ) {
- $this->_debugprint( "Error connecting to $host: $errstr\n" );
- }
+ $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;
}
/**
* Marks a host as dead until 30-40 seconds in the future
*
- * @param $sock String: socket to mark as dead
+ * @param string $sock Socket to mark as dead
*
- * @access private
+ * @access private
*/
function _dead_sock( $sock ) {
$host = array_search( $sock, $this->_cache_sock );
$this->_dead_host( $host );
}
+ /**
+ * @param string $host
+ */
function _dead_host( $host ) {
- $parts = explode( ':', $host );
- $ip = $parts[0];
+ $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
*
- * @param $key String: key to retrieve value for;
+ * @param string $key Key to retrieve value for;
*
- * @return Mixed: resource on success, false on failure
+ * @return Resource|bool Resource on success, false on failure
* @access private
*/
function get_sock( $key ) {
}
if ( $this->_single_sock !== null ) {
- $this->_flush_read_buffer( $this->_single_sock );
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++ ) {
+ for ( $i = 0; $i < $v[1]; $i++ ) {
$bu[] = $v[0];
}
} else {
}
$realkey = is_array( $key ) ? $key[1] : $key;
- for( $tries = 0; $tries < 20; $tries++ ) {
+ for ( $tries = 0; $tries < 20; $tries++ ) {
$host = $this->_buckets[$hv % $this->_bucketcount];
$sock = $this->sock_to_host( $host );
if ( is_resource( $sock ) ) {
- $this->_flush_read_buffer( $sock );
return $sock;
}
$hv = $this->_hashfunc( $hv . $realkey );
/**
* Creates a hash integer based on the $key
*
- * @param $key String: key to hash
+ * @param string $key Key to hash
*
- * @return Integer: hash value
+ * @return int Hash value
* @access private
*/
function _hashfunc( $key ) {
- # Hash function must on [0,0x7ffffff]
+ # 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;
/**
* Perform increment/decriment on $key
*
- * @param $cmd String: command to perform
- * @param $key String: key to perform it on
- * @param $amt Integer: amount to adjust
+ * @param string $cmd Command to perform
+ * @param string|array $key Key to perform it on
+ * @param int $amt Amount to adjust
*
- * @return Integer: new value of $key
+ * @return int New value of $key
* @access private
*/
function _incrdecr( $cmd, $key, $amt = 1 ) {
} else {
$this->stats[$cmd] = 1;
}
- if ( !$this->_safe_fwrite( $sock, "$cmd $key $amt\r\n" ) ) {
- return $this->_dead_sock( $sock );
+ if ( !$this->_fwrite( $sock, "$cmd $key $amt\r\n" ) ) {
+ return null;
}
- $line = fgets( $sock );
+ $line = $this->_fgets( $sock );
$match = array();
if ( !preg_match( '/^(\d+)/', $line, $match ) ) {
return null;
/**
* Load items into $ret from $sock
*
- * @param $sock Ressource: socket to read from
- * @param $ret Array: returned values
+ * @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 ) {
- while ( 1 ) {
- $decl = fgets( $sock );
- if ( $decl == "END\r\n" ) {
- return true;
- } elseif ( preg_match( '/^VALUE (\S+) (\d+) (\d+)\r\n$/', $decl, $match ) ) {
- list( $rkey, $flags, $len ) = array( $match[1], $match[2], $match[3] );
- $bneed = $len + 2;
- $offset = 0;
-
- while ( $bneed > 0 ) {
- $data = fread( $sock, $bneed );
- $n = strlen( $data );
- if ( $n == 0 ) {
- break;
- }
- $offset += $n;
- $bneed -= $n;
- if ( isset( $ret[$rkey] ) ) {
- $ret[$rkey] .= $data;
- } else {
- $ret[$rkey] = $data;
- }
- }
-
- if ( $offset != $len + 2 ) {
- // Something is borked!
- if ( $this->_debug ) {
- $this->_debugprint( sprintf( "Something is borked! key %s expecting %d got %d length\n", $rkey, $len + 2, $offset ) );
- }
+ function _load_items( $sock, &$ret, &$casToken = null ) {
+ $results = array();
- unset( $ret[$rkey] );
- $this->_close_sock( $sock );
+ 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;
}
- if ( $this->_have_zlib && $flags & self::COMPRESSED ) {
- $ret[$rkey] = gzuncompress( $ret[$rkey] );
- }
+ /**
+ * 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;
- $ret[$rkey] = rtrim( $ret[$rkey] );
+ if ( $this->_have_zlib && $flags & self::COMPRESSED ) {
+ $ret[$rkey] = gzuncompress( $ret[$rkey] );
+ }
- if ( $flags & self::SERIALIZED ) {
- $ret[$rkey] = unserialize( $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] = unserialize( $ret[$rkey] );
+ } elseif ( $flags & self::INTVAL ) {
+ $ret[$rkey] = intval( $ret[$rkey] );
+ }
}
+ return true;
} else {
- $this->_debugprint( "Error parsing memcached response\n" );
- return 0;
+ $this->_handle_error( $sock, 'Error parsing response from $1' );
+ return false;
}
}
}
/**
* Performs the requested storage operation to the memcache server
*
- * @param $cmd String: command to perform
- * @param $key String: key to act on
- * @param $val Mixed: what we need to store
- * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
+ * @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 Boolean
+ * @return bool
* @access private
*/
- function _set( $cmd, $key, $val, $exp ) {
+ function _set( $cmd, $key, $val, $exp, $casToken = null ) {
if ( !$this->_active ) {
return false;
}
$flags = 0;
- if ( !is_scalar( $val ) ) {
+ if ( is_int( $val ) ) {
+ $flags |= self::INTVAL;
+ } elseif ( !is_scalar( $val ) ) {
$val = serialize( $val );
$flags |= self::SERIALIZED;
if ( $this->_debug ) {
- $this->_debugprint( sprintf( "client: serializing data as it is not scalar\n" ) );
+ $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 )
- {
+ 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\n", $len, $c_len ) );
+ $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;
}
}
- if ( !$this->_safe_fwrite( $sock, "$cmd $key $flags $exp $len\r\n$val\r\n" ) ) {
- return $this->_dead_sock( $sock );
+
+ $command = "$cmd $key $flags $exp $len";
+ if ( $casToken ) {
+ $command .= " $casToken";
}
- $line = trim( fgets( $sock ) );
+ 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)\n", $cmd, $key, $line ) );
+ $this->_debugprint( sprintf( "%s %s (%s)", $cmd, $key, $line ) );
}
- if ( $line == "STORED" ) {
+ 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;
}
/**
* Returns the socket for the host
*
- * @param $host String: Host:IP to get socket for
+ * @param string $host Host:IP to get socket for
*
- * @return Mixed: IO Stream or false
+ * @return Resource|bool IO Stream or false
* @access private
*/
function sock_to_host( $host ) {
}
if ( !$this->_connect_sock( $sock, $host ) ) {
- return $this->_dead_host( $host );
+ return null;
}
// Do not buffer writes
return $this->_cache_sock[$host];
}
- function _debugprint( $str ) {
- print( $str );
+ /**
+ * @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, timing out after the correct amount of time
+ * Write to a stream. If there is an error, mark the socket dead.
*
- * @return Boolean: false on failure, true on success
+ * @param Resource $sock The socket
+ * @param string $buf The string to write
+ * @return bool True on success, false on failure
*/
- /*
- function _safe_fwrite( $f, $buf, $len = false ) {
- stream_set_blocking( $f, 0 );
+ 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;
+ }
- if ( $len === false ) {
- wfDebug( "Writing " . strlen( $buf ) . " bytes\n" );
- $bytesWritten = fwrite( $f, $buf );
- } else {
- wfDebug( "Writing $len bytes\n" );
- $bytesWritten = fwrite( $f, $buf, $len );
+ 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]';
+ }
}
- $n = stream_select( $r = null, $w = array( $f ), $e = null, 10, 0 );
- # $this->_timeout_seconds, $this->_timeout_microseconds );
+ $msg = str_replace( '$1', $peer, $msg );
+ $this->_error_log( "$msg" );
+ $this->_dead_sock( $sock );
+ }
- wfDebug( "stream_select returned $n\n" );
- stream_set_blocking( $f, 1 );
- return $n == 1;
- return $bytesWritten;
- }*/
+ /**
+ * 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;
+ }
/**
- * Original behaviour
+ * 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 _safe_fwrite( $f, $buf, $len = false ) {
- if ( $len === false ) {
- $bytesWritten = fwrite( $f, $buf );
+ 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 {
- $bytesWritten = fwrite( $f, $buf, $len );
+ $this->_handle_error( $sock, 'line ending missing in response from $1' );
+ return false;
}
- return $bytesWritten;
+ return $result;
}
/**
* Flush the read buffer of a stream
+ * @param Resource $f
*/
function _flush_read_buffer( $f ) {
if ( !is_resource( $f ) ) {
return;
}
- $n = stream_select( $r = array( $f ), $w = null, $e = null, 0, 0 );
+ $r = array( $f );
+ $w = null;
+ $e = null;
+ $n = stream_select( $r, $w, $e, 0, 0 );
while ( $n == 1 && !feof( $f ) ) {
fread( $f, 1024 );
- $n = stream_select( $r = array( $f ), $w = null, $e = null, 0, 0 );
+ $r = array( $f );
+ $w = null;
+ $e = null;
+ $n = stream_select( $r, $w, $e, 0, 0 );
}
}
// }}}
}
-// vim: sts=3 sw=3 et
-
// }}}
-
-class MemCachedClientforWiki extends MWMemcached {
- function _debugprint( $text ) {
- wfDebug( "memcached: $text" );
- }
-}
scripts.mit.edu / autoinstalls / mediawiki.git / blobdiff