3 * +---------------------------------------------------------------------------+
4 * | memcached client, PHP |
5 * +---------------------------------------------------------------------------+
6 * | Copyright (c) 2003 Ryan T. Dean <rtdean@cytherianage.net> |
7 * | All rights reserved. |
9 * | Redistribution and use in source and binary forms, with or without |
10 * | modification, are permitted provided that the following conditions |
13 * | 1. Redistributions of source code must retain the above copyright |
14 * | notice, this list of conditions and the following disclaimer. |
15 * | 2. Redistributions in binary form must reproduce the above copyright |
16 * | notice, this list of conditions and the following disclaimer in the |
17 * | documentation and/or other materials provided with the distribution. |
19 * | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
20 * | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
21 * | OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
22 * | IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
23 * | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
24 * | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
25 * | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
26 * | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
27 * | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
28 * | THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
29 * +---------------------------------------------------------------------------+
30 * | Author: Ryan T. Dean <rtdean@cytherianage.net> |
31 * | Heavily influenced by the Perl memcached client by Brad Fitzpatrick. |
32 * | Permission granted by Brad Fitzpatrick for relicense of ported Perl |
33 * | client logic under 2-clause BSD license. |
34 * +---------------------------------------------------------------------------+
41 * This is the PHP client for memcached - a distributed memory cache daemon.
42 * More information is available at http://www.danga.com/memcached/
46 * require_once 'memcached.php';
48 * $mc = new MWMemcached(array(
49 * 'servers' => array('127.0.0.1:10000',
50 * array('192.0.0.1:10010', 2),
53 * 'compress_threshold' => 10240,
54 * 'persistent' => true));
56 * $mc->add('key', array('some', 'array'));
57 * $mc->replace('key', 'some random string');
58 * $val = $mc->get('key');
60 * @author Ryan T. Dean <rtdean@cytherianage.net>
67 // {{{ class MWMemcached
69 * memcached client class implemented using (p)fsockopen()
71 * @author Ryan T. Dean <rtdean@cytherianage.net>
82 * Flag: indicates data is serialized
87 * Flag: indicates data is compressed
94 * Minimum savings to store data compressed
96 const COMPRESSION_SAVINGS
= 0.20;
113 * Cached Sockets that are connected
121 * Current debug status; 0 - none to 9 - profiling
129 * Dead hosts, assoc array, 'host'=>'unixtime when ok to check again'
137 * Is compression available?
145 * Do we want to use compression?
150 var $_compress_enable;
153 * At how many bytes should we compress?
158 var $_compress_threshold;
161 * Are we using persistent links?
169 * If only using one server; contains ip:port to connect to
177 * Array containing ip:port or array(ip:port, weight)
193 * Total # of bit buckets we have
201 * # of total servers we have
209 * Stream timeout in seconds. Applies for example to fread()
214 var $_timeout_seconds;
217 * Stream timeout in microseconds
222 var $_timeout_microseconds;
225 * Connect timeout in seconds
227 var $_connect_timeout;
230 * Number of connection attempts for each server
232 var $_connect_attempts;
237 // {{{ public functions
241 * Memcache initializer
243 * @param $args Array Associative array of settings
247 public function __construct( $args ) {
248 $this->set_servers( isset( $args['servers'] ) ?
$args['servers'] : array() );
249 $this->_debug
= isset( $args['debug'] ) ?
$args['debug'] : false;
250 $this->stats
= array();
251 $this->_compress_threshold
= isset( $args['compress_threshold'] ) ?
$args['compress_threshold'] : 0;
252 $this->_persistent
= isset( $args['persistent'] ) ?
$args['persistent'] : false;
253 $this->_compress_enable
= true;
254 $this->_have_zlib
= function_exists( 'gzcompress' );
256 $this->_cache_sock
= array();
257 $this->_host_dead
= array();
259 $this->_timeout_seconds
= 0;
260 $this->_timeout_microseconds
= isset( $args['timeout'] ) ?
$args['timeout'] : 100000;
262 $this->_connect_timeout
= isset( $args['connect_timeout'] ) ?
$args['connect_timeout'] : 0.1;
263 $this->_connect_attempts
= 2;
270 * Adds a key/value to the memcache server if one isn't already set with
273 * @param $key String: key to set with data
274 * @param $val Mixed: value to store
275 * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
276 * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
277 * longer must be the timestamp of the time at which the mapping should expire. It
278 * is safe to use timestamps in all cases, regardless of exipration
279 * eg: strtotime("+3 hour")
283 public function add( $key, $val, $exp = 0 ) {
284 return $this->_set( 'add', $key, $val, $exp );
291 * Decrease a value stored on the memcache server
293 * @param $key String: key to decrease
294 * @param $amt Integer: (optional) amount to decrease
296 * @return Mixed: FALSE on failure, value on success
298 public function decr( $key, $amt = 1 ) {
299 return $this->_incrdecr( 'decr', $key, $amt );
306 * Deletes a key from the server, optionally after $time
308 * @param $key String: key to delete
309 * @param $time Integer: (optional) how long to wait before deleting
311 * @return Boolean: TRUE on success, FALSE on failure
313 public function delete( $key, $time = 0 ) {
314 if ( !$this->_active
) {
318 $sock = $this->get_sock( $key );
319 if ( !is_resource( $sock ) ) {
323 $key = is_array( $key ) ?
$key[1] : $key;
325 if ( isset( $this->stats
['delete'] ) ) {
326 $this->stats
['delete']++
;
328 $this->stats
['delete'] = 1;
330 $cmd = "delete $key $time\r\n";
331 if( !$this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
332 $this->_dead_sock( $sock );
335 $res = trim( fgets( $sock ) );
337 if ( $this->_debug
) {
338 $this->_debugprint( sprintf( "MemCache: delete %s (%s)\n", $key, $res ) );
341 if ( $res == "DELETED" ) {
347 public function lock( $key, $timeout = 0 ) {
352 public function unlock( $key ) {
358 // {{{ disconnect_all()
361 * Disconnects all connected sockets
363 public function disconnect_all() {
364 foreach ( $this->_cache_sock
as $sock ) {
368 $this->_cache_sock
= array();
372 // {{{ enable_compress()
375 * Enable / Disable compression
377 * @param $enable Boolean: TRUE to enable, FALSE to disable
379 public function enable_compress( $enable ) {
380 $this->_compress_enable
= $enable;
384 // {{{ forget_dead_hosts()
387 * Forget about all of the dead hosts
389 public function forget_dead_hosts() {
390 $this->_host_dead
= array();
397 * Retrieves the value associated with the key from the memcache server
399 * @param $key array|string key to retrieve
403 public function get( $key ) {
404 wfProfileIn( __METHOD__
);
406 if ( $this->_debug
) {
407 $this->_debugprint( "get($key)\n" );
410 if ( !$this->_active
) {
411 wfProfileOut( __METHOD__
);
415 $sock = $this->get_sock( $key );
417 if ( !is_resource( $sock ) ) {
418 wfProfileOut( __METHOD__
);
422 $key = is_array( $key ) ?
$key[1] : $key;
423 if ( isset( $this->stats
['get'] ) ) {
424 $this->stats
['get']++
;
426 $this->stats
['get'] = 1;
429 $cmd = "get $key\r\n";
430 if ( !$this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
431 $this->_dead_sock( $sock );
432 wfProfileOut( __METHOD__
);
437 $this->_load_items( $sock, $val );
439 if ( $this->_debug
) {
440 foreach ( $val as $k => $v ) {
441 $this->_debugprint( sprintf( "MemCache: sock %s got %s\n", serialize( $sock ), $k ) );
446 if ( isset( $val[$key] ) ) {
449 wfProfileOut( __METHOD__
);
457 * Get multiple keys from the server(s)
459 * @param $keys Array: keys to retrieve
463 public function get_multi( $keys ) {
464 if ( !$this->_active
) {
468 if ( isset( $this->stats
['get_multi'] ) ) {
469 $this->stats
['get_multi']++
;
471 $this->stats
['get_multi'] = 1;
473 $sock_keys = array();
475 foreach ( $keys as $key ) {
476 $sock = $this->get_sock( $key );
477 if ( !is_resource( $sock ) ) {
480 $key = is_array( $key ) ?
$key[1] : $key;
481 if ( !isset( $sock_keys[$sock] ) ) {
482 $sock_keys[$sock] = array();
485 $sock_keys[$sock][] = $key;
488 // Send out the requests
489 foreach ( $socks as $sock ) {
491 foreach ( $sock_keys[$sock] as $key ) {
496 if ( $this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
499 $this->_dead_sock( $sock );
505 foreach ( $gather as $sock ) {
506 $this->_load_items( $sock, $val );
509 if ( $this->_debug
) {
510 foreach ( $val as $k => $v ) {
511 $this->_debugprint( sprintf( "MemCache: got %s\n", $k ) );
522 * Increments $key (optionally) by $amt
524 * @param $key String: key to increment
525 * @param $amt Integer: (optional) amount to increment
527 * @return Integer: null if the key does not exist yet (this does NOT
528 * create new mappings if the key does not exist). If the key does
529 * exist, this returns the new value for that key.
531 public function incr( $key, $amt = 1 ) {
532 return $this->_incrdecr( 'incr', $key, $amt );
539 * Overwrites an existing value for key; only works if key is already set
541 * @param $key String: key to set value as
542 * @param $value Mixed: value to store
543 * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
544 * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
545 * longer must be the timestamp of the time at which the mapping should expire. It
546 * is safe to use timestamps in all cases, regardless of exipration
547 * eg: strtotime("+3 hour")
551 public function replace( $key, $value, $exp = 0 ) {
552 return $this->_set( 'replace', $key, $value, $exp );
559 * Passes through $cmd to the memcache server connected by $sock; returns
560 * output as an array (null array if no output)
562 * NOTE: due to a possible bug in how PHP reads while using fgets(), each
563 * line may not be terminated by a \r\n. More specifically, my testing
564 * has shown that, on FreeBSD at least, each line is terminated only
565 * with a \n. This is with the PHP flag auto_detect_line_endings set
566 * to falase (the default).
568 * @param $sock Resource: socket to send command on
569 * @param $cmd String: command to run
571 * @return Array: output array
573 public function run_command( $sock, $cmd ) {
574 if ( !is_resource( $sock ) ) {
578 if ( !$this->_safe_fwrite( $sock, $cmd, strlen( $cmd ) ) ) {
583 $res = fgets( $sock );
585 if ( preg_match( '/^END/', $res ) ) {
588 if ( strlen( $res ) == 0 ) {
599 * Unconditionally sets a key to a given value in the memcache. Returns true
600 * if set successfully.
602 * @param $key String: key to set value as
603 * @param $value Mixed: value to set
604 * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
605 * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
606 * longer must be the timestamp of the time at which the mapping should expire. It
607 * is safe to use timestamps in all cases, regardless of exipration
608 * eg: strtotime("+3 hour")
610 * @return Boolean: TRUE on success
612 public function set( $key, $value, $exp = 0 ) {
613 return $this->_set( 'set', $key, $value, $exp );
617 // {{{ set_compress_threshold()
620 * Sets the compression threshold
622 * @param $thresh Integer: threshold to compress if larger than
624 public function set_compress_threshold( $thresh ) {
625 $this->_compress_threshold
= $thresh;
632 * Sets the debug flag
634 * @param $dbg Boolean: TRUE for debugging, FALSE otherwise
636 * @see MWMemcached::__construct
638 public function set_debug( $dbg ) {
639 $this->_debug
= $dbg;
646 * Sets the server list to distribute key gets and puts between
648 * @param $list Array of servers to connect to
650 * @see MWMemcached::__construct()
652 public function set_servers( $list ) {
653 $this->_servers
= $list;
654 $this->_active
= count( $list );
655 $this->_buckets
= null;
656 $this->_bucketcount
= 0;
658 $this->_single_sock
= null;
659 if ( $this->_active
== 1 ) {
660 $this->_single_sock
= $this->_servers
[0];
665 * Sets the timeout for new connections
667 * @param $seconds Integer: number of seconds
668 * @param $microseconds Integer: number of microseconds
670 public function set_timeout( $seconds, $microseconds ) {
671 $this->_timeout_seconds
= $seconds;
672 $this->_timeout_microseconds
= $microseconds;
677 // {{{ private methods
681 * Close the specified socket
683 * @param $sock String: socket to close
687 function _close_sock( $sock ) {
688 $host = array_search( $sock, $this->_cache_sock
);
689 fclose( $this->_cache_sock
[$host] );
690 unset( $this->_cache_sock
[$host] );
694 // {{{ _connect_sock()
697 * Connects $sock to $host, timing out after $timeout
699 * @param $sock Integer: socket to connect
700 * @param $host String: Host:IP to connect to
705 function _connect_sock( &$sock, $host ) {
706 list( $ip, $port ) = explode( ':', $host );
708 $timeout = $this->_connect_timeout
;
709 $errno = $errstr = null;
710 for( $i = 0; !$sock && $i < $this->_connect_attempts
; $i++
) {
711 wfSuppressWarnings();
712 if ( $this->_persistent
== 1 ) {
713 $sock = pfsockopen( $ip, $port, $errno, $errstr, $timeout );
715 $sock = fsockopen( $ip, $port, $errno, $errstr, $timeout );
720 if ( $this->_debug
) {
721 $this->_debugprint( "Error connecting to $host: $errstr\n" );
726 // Initialise timeout
727 stream_set_timeout( $sock, $this->_timeout_seconds
, $this->_timeout_microseconds
);
736 * Marks a host as dead until 30-40 seconds in the future
738 * @param $sock String: socket to mark as dead
742 function _dead_sock( $sock ) {
743 $host = array_search( $sock, $this->_cache_sock
);
744 $this->_dead_host( $host );
747 function _dead_host( $host ) {
748 $parts = explode( ':', $host );
750 $this->_host_dead
[$ip] = time() +
30 +
intval( rand( 0, 10 ) );
751 $this->_host_dead
[$host] = $this->_host_dead
[$ip];
752 unset( $this->_cache_sock
[$host] );
761 * @param $key String: key to retrieve value for;
763 * @return Mixed: resource on success, false on failure
766 function get_sock( $key ) {
767 if ( !$this->_active
) {
771 if ( $this->_single_sock
!== null ) {
772 $this->_flush_read_buffer( $this->_single_sock
);
773 return $this->sock_to_host( $this->_single_sock
);
776 $hv = is_array( $key ) ?
intval( $key[0] ) : $this->_hashfunc( $key );
778 if ( $this->_buckets
=== null ) {
779 foreach ( $this->_servers
as $v ) {
780 if ( is_array( $v ) ) {
781 for( $i = 0; $i < $v[1]; $i++
) {
788 $this->_buckets
= $bu;
789 $this->_bucketcount
= count( $bu );
792 $realkey = is_array( $key ) ?
$key[1] : $key;
793 for( $tries = 0; $tries < 20; $tries++
) {
794 $host = $this->_buckets
[$hv %
$this->_bucketcount
];
795 $sock = $this->sock_to_host( $host );
796 if ( is_resource( $sock ) ) {
797 $this->_flush_read_buffer( $sock );
800 $hv = $this->_hashfunc( $hv . $realkey );
810 * Creates a hash integer based on the $key
812 * @param $key String: key to hash
814 * @return Integer: hash value
817 function _hashfunc( $key ) {
818 # Hash function must on [0,0x7ffffff]
819 # We take the first 31 bits of the MD5 hash, which unlike the hash
820 # function used in a previous version of this client, works
821 return hexdec( substr( md5( $key ), 0, 8 ) ) & 0x7fffffff;
828 * Perform increment/decriment on $key
830 * @param $cmd String command to perform
831 * @param $key String|array key to perform it on
832 * @param $amt Integer amount to adjust
834 * @return Integer: new value of $key
837 function _incrdecr( $cmd, $key, $amt = 1 ) {
838 if ( !$this->_active
) {
842 $sock = $this->get_sock( $key );
843 if ( !is_resource( $sock ) ) {
847 $key = is_array( $key ) ?
$key[1] : $key;
848 if ( isset( $this->stats
[$cmd] ) ) {
849 $this->stats
[$cmd]++
;
851 $this->stats
[$cmd] = 1;
853 if ( !$this->_safe_fwrite( $sock, "$cmd $key $amt\r\n" ) ) {
854 return $this->_dead_sock( $sock );
857 $line = fgets( $sock );
859 if ( !preg_match( '/^(\d+)/', $line, $match ) ) {
869 * Load items into $ret from $sock
871 * @param $sock Resource: socket to read from
872 * @param $ret Array: returned values
877 function _load_items( $sock, &$ret ) {
879 $decl = fgets( $sock );
880 if ( $decl == "END\r\n" ) {
882 } elseif ( preg_match( '/^VALUE (\S+) (\d+) (\d+)\r\n$/', $decl, $match ) ) {
883 list( $rkey, $flags, $len ) = array( $match[1], $match[2], $match[3] );
887 while ( $bneed > 0 ) {
888 $data = fread( $sock, $bneed );
889 $n = strlen( $data );
895 if ( isset( $ret[$rkey] ) ) {
896 $ret[$rkey] .= $data;
902 if ( $offset != $len +
2 ) {
903 // Something is borked!
904 if ( $this->_debug
) {
905 $this->_debugprint( sprintf( "Something is borked! key %s expecting %d got %d length\n", $rkey, $len +
2, $offset ) );
908 unset( $ret[$rkey] );
909 $this->_close_sock( $sock );
913 if ( $this->_have_zlib
&& $flags & self
::COMPRESSED
) {
914 $ret[$rkey] = gzuncompress( $ret[$rkey] );
917 $ret[$rkey] = rtrim( $ret[$rkey] );
919 if ( $flags & self
::SERIALIZED
) {
920 $ret[$rkey] = unserialize( $ret[$rkey] );
924 $this->_debugprint( "Error parsing memcached response\n" );
934 * Performs the requested storage operation to the memcache server
936 * @param $cmd String: command to perform
937 * @param $key String: key to act on
938 * @param $val Mixed: what we need to store
939 * @param $exp Integer: (optional) Expiration time. This can be a number of seconds
940 * to cache for (up to 30 days inclusive). Any timespans of 30 days + 1 second or
941 * longer must be the timestamp of the time at which the mapping should expire. It
942 * is safe to use timestamps in all cases, regardless of exipration
943 * eg: strtotime("+3 hour")
948 function _set( $cmd, $key, $val, $exp ) {
949 if ( !$this->_active
) {
953 $sock = $this->get_sock( $key );
954 if ( !is_resource( $sock ) ) {
958 if ( isset( $this->stats
[$cmd] ) ) {
959 $this->stats
[$cmd]++
;
961 $this->stats
[$cmd] = 1;
964 // TTLs higher than 30 days will be detected as absolute TTLs
965 // (UNIX timestamps), and will result in the cache entry being
966 // discarded immediately because the expiry is in the past.
967 // Clamp expiries >30d at 30d, unless they're >=1e9 in which
968 // case they are likely to really be absolute (1e9 = 2011-09-09)
969 if ( $exp > 2592000 && $exp < 1000000000 ) {
975 if ( !is_scalar( $val ) ) {
976 $val = serialize( $val );
977 $flags |
= self
::SERIALIZED
;
978 if ( $this->_debug
) {
979 $this->_debugprint( sprintf( "client: serializing data as it is not scalar\n" ) );
983 $len = strlen( $val );
985 if ( $this->_have_zlib
&& $this->_compress_enable
&&
986 $this->_compress_threshold
&& $len >= $this->_compress_threshold
)
988 $c_val = gzcompress( $val, 9 );
989 $c_len = strlen( $c_val );
991 if ( $c_len < $len * ( 1 - self
::COMPRESSION_SAVINGS
) ) {
992 if ( $this->_debug
) {
993 $this->_debugprint( sprintf( "client: compressing data; was %d bytes is now %d bytes\n", $len, $c_len ) );
997 $flags |
= self
::COMPRESSED
;
1000 if ( !$this->_safe_fwrite( $sock, "$cmd $key $flags $exp $len\r\n$val\r\n" ) ) {
1001 return $this->_dead_sock( $sock );
1004 $line = trim( fgets( $sock ) );
1006 if ( $this->_debug
) {
1007 $this->_debugprint( sprintf( "%s %s (%s)\n", $cmd, $key, $line ) );
1009 if ( $line == "STORED" ) {
1016 // {{{ sock_to_host()
1019 * Returns the socket for the host
1021 * @param $host String: Host:IP to get socket for
1023 * @return Mixed: IO Stream or false
1026 function sock_to_host( $host ) {
1027 if ( isset( $this->_cache_sock
[$host] ) ) {
1028 return $this->_cache_sock
[$host];
1033 list( $ip, /* $port */) = explode( ':', $host );
1034 if ( isset( $this->_host_dead
[$host] ) && $this->_host_dead
[$host] > $now ||
1035 isset( $this->_host_dead
[$ip] ) && $this->_host_dead
[$ip] > $now
1040 if ( !$this->_connect_sock( $sock, $host ) ) {
1041 return $this->_dead_host( $host );
1044 // Do not buffer writes
1045 stream_set_write_buffer( $sock, 0 );
1047 $this->_cache_sock
[$host] = $sock;
1049 return $this->_cache_sock
[$host];
1052 function _debugprint( $str ) {
1057 * Write to a stream, timing out after the correct amount of time
1059 * @return Boolean: false on failure, true on success
1062 function _safe_fwrite( $f, $buf, $len = false ) {
1063 stream_set_blocking( $f, 0 );
1065 if ( $len === false ) {
1066 wfDebug( "Writing " . strlen( $buf ) . " bytes\n" );
1067 $bytesWritten = fwrite( $f, $buf );
1069 wfDebug( "Writing $len bytes\n" );
1070 $bytesWritten = fwrite( $f, $buf, $len );
1072 $n = stream_select( $r = null, $w = array( $f ), $e = null, 10, 0 );
1073 # $this->_timeout_seconds, $this->_timeout_microseconds );
1075 wfDebug( "stream_select returned $n\n" );
1076 stream_set_blocking( $f, 1 );
1078 return $bytesWritten;
1082 * Original behaviour
1085 function _safe_fwrite( $f, $buf, $len = false ) {
1086 if ( $len === false ) {
1087 $bytesWritten = fwrite( $f, $buf );
1089 $bytesWritten = fwrite( $f, $buf, $len );
1091 return $bytesWritten;
1095 * Flush the read buffer of a stream
1097 function _flush_read_buffer( $f ) {
1098 if ( !is_resource( $f ) ) {
1101 $n = stream_select( $r = array( $f ), $w = null, $e = null, 0, 0 );
1102 while ( $n == 1 && !feof( $f ) ) {
1104 $n = stream_select( $r = array( $f ), $w = null, $e = null, 0, 0 );
1113 // vim: sts=3 sw=3 et
1117 class MemCachedClientforWiki
extends MWMemcached
{
1118 function _debugprint( $text ) {
1119 wfDebug( "memcached: $text" );