vendor/zendframework/zend-serializer/src/Adapter/PhpSerialize.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-serializer for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-serializer/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Serializer\Adapter;
   9
  10 use Traversable;
  11 use Zend\Serializer\Exception;
  12 use Zend\Stdlib\ErrorHandler;
  13
  14 class PhpSerialize extends AbstractAdapter
  15 {
  16     /**
  17      * Serialized boolean false value
  18      *
  19      * @var null|string
  20      */
  21     private static $serializedFalse = null;
  22
  23     /**
  24      * @var PhpSerializeOptions
  25      */
  26     protected $options;
  27
  28     /**
  29      * Constructor
  30      *
  31      * @param  array|Traversable|PhpSerializeOptions|null $options
  32      */
  33     public function __construct($options = null)
  34     {
  35         // needed to check if a returned false is based on a serialize false
  36         // or based on failure (igbinary can overwrite [un]serialize functions)
  37         if (static::$serializedFalse === null) {
  38             static::$serializedFalse = serialize(false);
  39         }
  40
  41         parent::__construct($options);
  42     }
  43
  44     /**
  45      * Set options
  46      *
  47      * @param  array|Traversable|PhpSerializeOptions $options
  48      * @return PhpSerialize
  49      */
  50     public function setOptions($options)
  51     {
  52         if (! $options instanceof PhpSerializeOptions) {
  53             $options = new PhpSerializeOptions($options);
  54         }
  55
  56         $this->options = $options;
  57         return $this;
  58     }
  59
  60     /**
  61      * Get options
  62      *
  63      * @return PhpSerializeOptions
  64      */
  65     public function getOptions()
  66     {
  67         if ($this->options === null) {
  68             $this->options = new PhpSerializeOptions();
  69         }
  70
  71         return $this->options;
  72     }
  73
  74     /**
  75      * Serialize using serialize()
  76      *
  77      * @param  mixed $value
  78      * @return string
  79      * @throws Exception\RuntimeException On serialize error
  80      */
  81     public function serialize($value)
  82     {
  83         ErrorHandler::start();
  84         $ret = serialize($value);
  85         $err = ErrorHandler::stop();
  86         if ($err) {
  87             throw new Exception\RuntimeException('Serialization failed', 0, $err);
  88         }
  89
  90         return $ret;
  91     }
  92
  93     /**
  94      * Unserialize
  95      *
  96      * @todo   Allow integration with unserialize_callback_func
  97      * @param  string $serialized
  98      * @return mixed
  99      * @throws Exception\RuntimeException on unserialize error
 100      */
 101     public function unserialize($serialized)
 102     {
 103         if (! is_string($serialized) || ! preg_match('/^((s|i|d|b|a|O|C):|N;)/', $serialized)) {
 104             $value = $serialized;
 105             if (is_object($value)) {
 106                 $value = get_class($value);
 107             } elseif (! is_string($value)) {
 108                 $value = gettype($value);
 109             }
 110
 111             throw new Exception\RuntimeException(sprintf(
 112                 'Serialized data must be a string containing serialized PHP code; received: %s',
 113                 $value
 114             ));
 115         }
 116
 117         // If we have a serialized boolean false value, just return false;
 118         // prevents the unserialize handler from creating an error.
 119         if ($serialized === static::$serializedFalse) {
 120             return false;
 121         }
 122
 123         ErrorHandler::start(E_NOTICE);
 124
 125         // The second parameter to unserialize() is only available on PHP 7.0 or higher
 126         $ret = PHP_MAJOR_VERSION >= 7
 127             ? unserialize($serialized, ['allowed_classes' => $this->getOptions()->getUnserializeClassWhitelist()])
 128             : unserialize($serialized);
 129
 130         $err = ErrorHandler::stop();
 131         if ($ret === false) {
 132             throw new Exception\RuntimeException('Unserialization failed', 0, $err);
 133         }
 134
 135         return $ret;
 136     }
 137 }