includes/libs/objectcache/APCUBagOStuff.php

   1 <?php
   2 /**
   3  * Object caching using PHP's APCU accelerator.
   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  * This is a wrapper for APCU's shared memory functions
  26  *
  27  * Use PHP serialization to avoid bugs and easily create CAS tokens.
  28  * APCu has a memory corruption bug when the serializer is set to 'default'.
  29  * See T120267, and upstream bug reports:
  30  *  - https://github.com/krakjoe/apcu/issues/38
  31  *  - https://github.com/krakjoe/apcu/issues/35
  32  *  - https://github.com/krakjoe/apcu/issues/111
  33  *
  34  * @ingroup Cache
  35  */
  36 class APCUBagOStuff extends BagOStuff {
  37         /**
  38          * @var string String to append to each APC key. This may be changed
  39          *  whenever the handling of values is changed, to prevent existing code
  40          *  from encountering older values which it cannot handle.
  41          */
  42         const KEY_SUFFIX = ':3';
  43
  44         protected function doGet( $key, $flags = 0, &$casToken = null ) {
  45                 $casToken = null;
  46
  47                 $blob = apcu_fetch( $key . self::KEY_SUFFIX );
  48                 $value = $this->unserialize( $blob );
  49                 if ( $value !== false ) {
  50                         $casToken = $blob; // don't bother hashing this
  51                 }
  52
  53                 return $value;
  54         }
  55
  56         public function set( $key, $value, $exptime = 0, $flags = 0 ) {
  57                 return apcu_store(
  58                         $key . self::KEY_SUFFIX,
  59                         $this->serialize( $value ),
  60                         $exptime
  61                 );
  62         }
  63
  64         public function add( $key, $value, $exptime = 0, $flags = 0 ) {
  65                 return apcu_add(
  66                         $key . self::KEY_SUFFIX,
  67                         $this->serialize( $value ),
  68                         $exptime
  69                 );
  70         }
  71
  72         public function delete( $key, $flags = 0 ) {
  73                 apcu_delete( $key . self::KEY_SUFFIX );
  74
  75                 return true;
  76         }
  77
  78         public function incr( $key, $value = 1 ) {
  79                 /**
  80                  * @todo When we only support php 7 or higher remove this hack
  81                  *
  82                  * https://github.com/krakjoe/apcu/issues/166
  83                  */
  84                 if ( apcu_exists( $key . self::KEY_SUFFIX ) ) {
  85                         return apcu_inc( $key . self::KEY_SUFFIX, $value );
  86                 } else {
  87                         return false;
  88                 }
  89         }
  90
  91         public function decr( $key, $value = 1 ) {
  92                 /**
  93                  * @todo When we only support php 7 or higher remove this hack
  94                  *
  95                  * https://github.com/krakjoe/apcu/issues/166
  96                  */
  97                 if ( apcu_exists( $key . self::KEY_SUFFIX ) ) {
  98                         return apcu_dec( $key . self::KEY_SUFFIX, $value );
  99                 } else {
 100                         return false;
 101                 }
 102         }
 103
 104         protected function serialize( $value ) {
 105                 return $this->isInteger( $value ) ? (int)$value : serialize( $value );
 106         }
 107
 108         protected function unserialize( $value ) {
 109                 return $this->isInteger( $value ) ? (int)$value : unserialize( $value );
 110         }
 111 }