includes/objectcache/MemcachedPhpBagOStuff.php

   1 <?php
   2
   3 /**
   4  * A wrapper class for the pure-PHP memcached client, exposing a BagOStuff interface.
   5  */
   6 class MemcachedPhpBagOStuff extends BagOStuff {
   7
   8         /**
   9          * @var MemCachedClientforWiki
  10          */
  11         protected $client;
  12
  13         /**
  14          * Constructor.
  15          *
  16          * Available parameters are:
  17          *   - servers:             The list of IP:port combinations holding the memcached servers.
  18          *   - debug:               Whether to set the debug flag in the underlying client.
  19          *   - persistent:          Whether to use a persistent connection
  20          *   - compress_threshold:  The minimum size an object must be before it is compressed
  21          *   - timeout:             The read timeout in microseconds
  22          *   - connect_timeout:     The connect timeout in seconds
  23          *
  24          * @params $params array
  25          */
  26         function __construct( $params ) {
  27                 if ( !isset( $params['servers'] ) ) {
  28                         $params['servers'] = $GLOBALS['wgMemCachedServers'];
  29                 }
  30                 if ( !isset( $params['debug'] ) ) {
  31                         $params['debug'] = $GLOBALS['wgMemCachedDebug'];
  32                 }
  33                 if ( !isset( $params['persistent'] ) ) {
  34                         $params['persistent'] = $GLOBALS['wgMemCachedPersistent'];
  35                 }
  36                 if  ( !isset( $params['compress_threshold'] ) ) {
  37                         $params['compress_threshold'] = 1500;
  38                 }
  39                 if ( !isset( $params['timeout'] ) ) {
  40                         $params['timeout'] = $GLOBALS['wgMemCachedTimeout'];
  41                 }
  42                 if ( !isset( $params['connect_timeout'] ) ) {
  43                         $params['connect_timeout'] = 0.1;
  44                 }
  45
  46                 $this->client = new MemCachedClientforWiki( $params );
  47                 $this->client->set_servers( $params['servers'] );
  48                 $this->client->set_debug( $params['debug'] );
  49         }
  50
  51         public function setDebug( $debug ) {
  52                 $this->client->set_debug( $debug );
  53         }
  54
  55         public function get( $key ) {
  56                 return $this->client->get( $this->encodeKey( $key ) );
  57         }
  58
  59         public function set( $key, $value, $exptime = 0 ) {
  60                 return $this->client->set( $this->encodeKey( $key ), $value, $exptime );
  61         }
  62
  63         public function delete( $key, $time = 0 ) {
  64                 return $this->client->delete( $this->encodeKey( $key ), $time );
  65         }
  66
  67         public function lock( $key, $timeout = 0 ) {
  68                 return $this->client->lock( $this->encodeKey( $key ), $timeout );
  69         }
  70
  71         public function unlock( $key ) {
  72                 return $this->client->unlock( $this->encodeKey( $key ) );
  73         }
  74
  75         public function add( $key, $value, $exptime = 0 ) {
  76                 return $this->client->add( $this->encodeKey( $key ), $value, $exptime );
  77         }
  78
  79         public function replace( $key, $value, $exptime = 0 ) {
  80                 return $this->client->replace( $this->encodeKey( $key ), $value, $exptime );
  81         }
  82
  83         public function incr( $key, $value = 1 ) {
  84                 return $this->client->incr( $this->encodeKey( $key ), $value );
  85         }
  86
  87         public function decr( $key, $value = 1 ) {
  88                 return $this->client->decr( $this->encodeKey( $key ), $value );
  89         }
  90
  91         /**
  92          * Get the underlying client object. This is provided for debugging
  93          * purposes.
  94          */
  95         public function getClient() {
  96                 return $this->client;
  97         }
  98
  99         /**
 100          * Encode a key for use on the wire inside the memcached protocol.
 101          *
 102          * We encode spaces and line breaks to avoid protocol errors. We encode
 103          * the other control characters for compatibility with libmemcached
 104          * verify_key. We leave other punctuation alone, to maximise backwards
 105          * compatibility.
 106          */
 107         public function encodeKey( $key ) {
 108                 return preg_replace_callback( '/[\x00-\x20\x25\x7f]+/',
 109                         array( $this, 'encodeKeyCallback' ), $key );
 110         }
 111
 112         protected function encodeKeyCallback( $m ) {
 113                 return rawurlencode( $m[0] );
 114         }
 115
 116         /**
 117          * Decode a key encoded with encodeKey(). This is provided as a convenience
 118          * function for debugging.
 119          */
 120         public function decodeKey( $key ) {
 121                 return urldecode( $key );
 122         }
 123 }
 124