includes/libs/objectcache/WinCacheBagOStuff.php

   1 <?php
   2 /**
   3  * Object caching using WinCache.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23
  24 /**
  25  * Wrapper for WinCache object caching functions; identical interface
  26  * to the APC wrapper
  27  *
  28  * @ingroup Cache
  29  */
  30 class WinCacheBagOStuff extends BagOStuff {
  31         protected function doGet( $key, $flags = 0 ) {
  32                 $val = wincache_ucache_get( $key );
  33                 if ( is_string( $val ) ) {
  34                         $val = unserialize( $val );
  35                 }
  36
  37                 return $val;
  38         }
  39
  40         public function set( $key, $value, $expire = 0, $flags = 0 ) {
  41                 $result = wincache_ucache_set( $key, serialize( $value ), $expire );
  42
  43                 /* wincache_ucache_set returns an empty array on success if $value
  44                  * was an array, bool otherwise */
  45                 return ( is_array( $result ) && $result === [] ) || $result;
  46         }
  47
  48         public function delete( $key ) {
  49                 wincache_ucache_delete( $key );
  50
  51                 return true;
  52         }
  53
  54         public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
  55                 if ( wincache_lock( $key ) ) { // optimize with FIFO lock
  56                         $ok = $this->mergeViaLock( $key, $callback, $exptime, $attempts, $flags );
  57                         wincache_unlock( $key );
  58                 } else {
  59                         $ok = false;
  60                 }
  61
  62                 return $ok;
  63         }
  64
  65         /**
  66          * Construct a cache key.
  67          *
  68          * @since 1.27
  69          * @param string $keyspace
  70          * @param array $args
  71          * @return string
  72          */
  73         public function makeKeyInternal( $keyspace, $args ) {
  74                 // WinCache keys have a maximum length of 150 characters. From that,
  75                 // subtract the number of characters we need for the keyspace and for
  76                 // the separator character needed for each argument. To handle some
  77                 // custom prefixes used by thing like WANObjectCache, limit to 125.
  78                 // NOTE: Same as in memcached, except the max key length there is 255.
  79                 $charsLeft = 125 - strlen( $keyspace ) - count( $args );
  80
  81                 $args = array_map(
  82                         function ( $arg ) use ( &$charsLeft ) {
  83                                 // 33 = 32 characters for the MD5 + 1 for the '#' prefix.
  84                                 if ( $charsLeft > 33 && strlen( $arg ) > $charsLeft ) {
  85                                         $arg = '#' . md5( $arg );
  86                                 }
  87
  88                                 $charsLeft -= strlen( $arg );
  89                                 return $arg;
  90                         },
  91                         $args
  92                 );
  93
  94                 if ( $charsLeft < 0 ) {
  95                         return $keyspace . ':BagOStuff-long-key:##' . md5( implode( ':', $args ) );
  96                 }
  97
  98                 return $keyspace . ':' . implode( ':', $args );
  99         }
 100
 101         /**
 102          * Increase stored value of $key by $value while preserving its original TTL
 103          * @param string $key Key to increase
 104          * @param int $value Value to add to $key (Default 1)
 105          * @return int|bool New value or false on failure
 106          */
 107         public function incr( $key, $value = 1 ) {
 108                 if ( !$this->lock( $key ) ) {
 109                         return false;
 110                 }
 111                 $n = $this->get( $key );
 112                 if ( $this->isInteger( $n ) ) { // key exists?
 113                         $n += intval( $value );
 114                         $oldTTL = wincache_ucache_info( false, $key )["ucache_entries"][1]["ttl_seconds"];
 115                         $this->set( $key, max( 0, $n ), $oldTTL );
 116                 } else {
 117                         $n = false;
 118                 }
 119                 $this->unlock( $key );
 120
 121                 return $n;
 122         }
 123 }