Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\VarDumper\Cloner;
Chris@0: 
Chris@0: use Symfony\Component\VarDumper\Caster\Caster;
Chris@0: use Symfony\Component\VarDumper\Exception\ThrowingCasterException;
Chris@0: 
Chris@0: /**
Chris@0:  * AbstractCloner implements a generic caster mechanism for objects and resources.
Chris@0:  *
Chris@0:  * @author Nicolas Grekas <p@tchwork.com>
Chris@0:  */
Chris@0: abstract class AbstractCloner implements ClonerInterface
Chris@0: {
Chris@17:     public static $defaultCasters = [
Chris@17:         '__PHP_Incomplete_Class' => ['Symfony\Component\VarDumper\Caster\Caster', 'castPhpIncompleteClass'],
Chris@0: 
Chris@17:         'Symfony\Component\VarDumper\Caster\CutStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'],
Chris@17:         'Symfony\Component\VarDumper\Caster\CutArrayStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castCutArray'],
Chris@17:         'Symfony\Component\VarDumper\Caster\ConstStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'],
Chris@17:         'Symfony\Component\VarDumper\Caster\EnumStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castEnum'],
Chris@0: 
Chris@17:         'Closure' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClosure'],
Chris@17:         'Generator' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castGenerator'],
Chris@17:         'ReflectionType' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castType'],
Chris@17:         'ReflectionGenerator' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castReflectionGenerator'],
Chris@17:         'ReflectionClass' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClass'],
Chris@17:         'ReflectionFunctionAbstract' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castFunctionAbstract'],
Chris@17:         'ReflectionMethod' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castMethod'],
Chris@17:         'ReflectionParameter' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castParameter'],
Chris@17:         'ReflectionProperty' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castProperty'],
Chris@17:         'ReflectionExtension' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castExtension'],
Chris@17:         'ReflectionZendExtension' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castZendExtension'],
Chris@0: 
Chris@17:         'Doctrine\Common\Persistence\ObjectManager' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
Chris@17:         'Doctrine\Common\Proxy\Proxy' => ['Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castCommonProxy'],
Chris@17:         'Doctrine\ORM\Proxy\Proxy' => ['Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castOrmProxy'],
Chris@17:         'Doctrine\ORM\PersistentCollection' => ['Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castPersistentCollection'],
Chris@0: 
Chris@17:         'DOMException' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castException'],
Chris@17:         'DOMStringList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
Chris@17:         'DOMNameList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
Chris@17:         'DOMImplementation' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castImplementation'],
Chris@17:         'DOMImplementationList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
Chris@17:         'DOMNode' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castNode'],
Chris@17:         'DOMNameSpaceNode' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castNameSpaceNode'],
Chris@17:         'DOMDocument' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocument'],
Chris@17:         'DOMNodeList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
Chris@17:         'DOMNamedNodeMap' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
Chris@17:         'DOMCharacterData' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castCharacterData'],
Chris@17:         'DOMAttr' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castAttr'],
Chris@17:         'DOMElement' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castElement'],
Chris@17:         'DOMText' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castText'],
Chris@17:         'DOMTypeinfo' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castTypeinfo'],
Chris@17:         'DOMDomError' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castDomError'],
Chris@17:         'DOMLocator' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLocator'],
Chris@17:         'DOMDocumentType' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocumentType'],
Chris@17:         'DOMNotation' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castNotation'],
Chris@17:         'DOMEntity' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castEntity'],
Chris@17:         'DOMProcessingInstruction' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castProcessingInstruction'],
Chris@17:         'DOMXPath' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castXPath'],
Chris@0: 
Chris@17:         'XmlReader' => ['Symfony\Component\VarDumper\Caster\XmlReaderCaster', 'castXmlReader'],
Chris@0: 
Chris@17:         'ErrorException' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castErrorException'],
Chris@17:         'Exception' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castException'],
Chris@17:         'Error' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castError'],
Chris@17:         'Symfony\Component\DependencyInjection\ContainerInterface' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
Chris@17:         'Symfony\Component\HttpFoundation\Request' => ['Symfony\Component\VarDumper\Caster\SymfonyCaster', 'castRequest'],
Chris@17:         'Symfony\Component\VarDumper\Exception\ThrowingCasterException' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castThrowingCasterException'],
Chris@17:         'Symfony\Component\VarDumper\Caster\TraceStub' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castTraceStub'],
Chris@17:         'Symfony\Component\VarDumper\Caster\FrameStub' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castFrameStub'],
Chris@17:         'Symfony\Component\Debug\Exception\SilencedErrorContext' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castSilencedErrorContext'],
Chris@0: 
Chris@17:         'PHPUnit_Framework_MockObject_MockObject' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
Chris@17:         'Prophecy\Prophecy\ProphecySubjectInterface' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
Chris@17:         'Mockery\MockInterface' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
Chris@0: 
Chris@17:         'PDO' => ['Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdo'],
Chris@17:         'PDOStatement' => ['Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdoStatement'],
Chris@0: 
Chris@17:         'AMQPConnection' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castConnection'],
Chris@17:         'AMQPChannel' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castChannel'],
Chris@17:         'AMQPQueue' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castQueue'],
Chris@17:         'AMQPExchange' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castExchange'],
Chris@17:         'AMQPEnvelope' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castEnvelope'],
Chris@0: 
Chris@17:         'ArrayObject' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castArrayObject'],
Chris@17:         'ArrayIterator' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castArrayIterator'],
Chris@17:         'SplDoublyLinkedList' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castDoublyLinkedList'],
Chris@17:         'SplFileInfo' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castFileInfo'],
Chris@17:         'SplFileObject' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castFileObject'],
Chris@17:         'SplFixedArray' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castFixedArray'],
Chris@17:         'SplHeap' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'],
Chris@17:         'SplObjectStorage' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castObjectStorage'],
Chris@17:         'SplPriorityQueue' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'],
Chris@17:         'OuterIterator' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castOuterIterator'],
Chris@0: 
Chris@17:         'MongoCursorInterface' => ['Symfony\Component\VarDumper\Caster\MongoCaster', 'castCursor'],
Chris@0: 
Chris@17:         'Redis' => ['Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedis'],
Chris@17:         'RedisArray' => ['Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedisArray'],
Chris@0: 
Chris@17:         'DateTimeInterface' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castDateTime'],
Chris@17:         'DateInterval' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castInterval'],
Chris@17:         'DateTimeZone' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castTimeZone'],
Chris@17:         'DatePeriod' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castPeriod'],
Chris@12: 
Chris@17:         ':curl' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castCurl'],
Chris@17:         ':dba' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'],
Chris@17:         ':dba persistent' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'],
Chris@17:         ':gd' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castGd'],
Chris@17:         ':mysql link' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castMysqlLink'],
Chris@17:         ':pgsql large object' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLargeObject'],
Chris@17:         ':pgsql link' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'],
Chris@17:         ':pgsql link persistent' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'],
Chris@17:         ':pgsql result' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castResult'],
Chris@17:         ':process' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castProcess'],
Chris@17:         ':stream' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'],
Chris@17:         ':persistent stream' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'],
Chris@17:         ':stream-context' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStreamContext'],
Chris@17:         ':xml' => ['Symfony\Component\VarDumper\Caster\XmlResourceCaster', 'castXml'],
Chris@17:     ];
Chris@0: 
Chris@0:     protected $maxItems = 2500;
Chris@0:     protected $maxString = -1;
Chris@12:     protected $minDepth = 1;
Chris@0:     protected $useExt;
Chris@0: 
Chris@17:     private $casters = [];
Chris@0:     private $prevErrorHandler;
Chris@17:     private $classInfo = [];
Chris@0:     private $filter = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param callable[]|null $casters A map of casters
Chris@0:      *
Chris@0:      * @see addCasters
Chris@0:      */
Chris@0:     public function __construct(array $casters = null)
Chris@0:     {
Chris@0:         if (null === $casters) {
Chris@0:             $casters = static::$defaultCasters;
Chris@0:         }
Chris@0:         $this->addCasters($casters);
Chris@17:         $this->useExt = \extension_loaded('symfony_debug');
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Adds casters for resources and objects.
Chris@0:      *
Chris@0:      * Maps resources or objects types to a callback.
Chris@0:      * Types are in the key, with a callable caster for value.
Chris@0:      * Resource types are to be prefixed with a `:`,
Chris@0:      * see e.g. static::$defaultCasters.
Chris@0:      *
Chris@0:      * @param callable[] $casters A map of casters
Chris@0:      */
Chris@0:     public function addCasters(array $casters)
Chris@0:     {
Chris@0:         foreach ($casters as $type => $callback) {
Chris@17:             $this->casters[strtolower($type)][] = \is_string($callback) && false !== strpos($callback, '::') ? explode('::', $callback, 2) : $callback;
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@12:      * Sets the maximum number of items to clone past the minimum depth in nested structures.
Chris@0:      *
Chris@0:      * @param int $maxItems
Chris@0:      */
Chris@0:     public function setMaxItems($maxItems)
Chris@0:     {
Chris@0:         $this->maxItems = (int) $maxItems;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the maximum cloned length for strings.
Chris@0:      *
Chris@0:      * @param int $maxString
Chris@0:      */
Chris@0:     public function setMaxString($maxString)
Chris@0:     {
Chris@0:         $this->maxString = (int) $maxString;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@12:      * Sets the minimum tree depth where we are guaranteed to clone all the items.  After this
Chris@12:      * depth is reached, only setMaxItems items will be cloned.
Chris@12:      *
Chris@12:      * @param int $minDepth
Chris@12:      */
Chris@12:     public function setMinDepth($minDepth)
Chris@12:     {
Chris@12:         $this->minDepth = (int) $minDepth;
Chris@12:     }
Chris@12: 
Chris@12:     /**
Chris@0:      * Clones a PHP variable.
Chris@0:      *
Chris@0:      * @param mixed $var    Any PHP variable
Chris@0:      * @param int   $filter A bit field of Caster::EXCLUDE_* constants
Chris@0:      *
Chris@0:      * @return Data The cloned variable represented by a Data object
Chris@0:      */
Chris@0:     public function cloneVar($var, $filter = 0)
Chris@0:     {
Chris@17:         $this->prevErrorHandler = set_error_handler(function ($type, $msg, $file, $line, $context = []) {
Chris@0:             if (E_RECOVERABLE_ERROR === $type || E_USER_ERROR === $type) {
Chris@0:                 // Cloner never dies
Chris@0:                 throw new \ErrorException($msg, 0, $type, $file, $line);
Chris@0:             }
Chris@0: 
Chris@0:             if ($this->prevErrorHandler) {
Chris@17:                 return \call_user_func($this->prevErrorHandler, $type, $msg, $file, $line, $context);
Chris@0:             }
Chris@0: 
Chris@0:             return false;
Chris@0:         });
Chris@0:         $this->filter = $filter;
Chris@0: 
Chris@0:         if ($gc = gc_enabled()) {
Chris@0:             gc_disable();
Chris@0:         }
Chris@0:         try {
Chris@0:             return new Data($this->doClone($var));
Chris@0:         } finally {
Chris@0:             if ($gc) {
Chris@0:                 gc_enable();
Chris@0:             }
Chris@0:             restore_error_handler();
Chris@0:             $this->prevErrorHandler = null;
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Effectively clones the PHP variable.
Chris@0:      *
Chris@0:      * @param mixed $var Any PHP variable
Chris@0:      *
Chris@0:      * @return array The cloned variable represented in an array
Chris@0:      */
Chris@0:     abstract protected function doClone($var);
Chris@0: 
Chris@0:     /**
Chris@0:      * Casts an object to an array representation.
Chris@0:      *
Chris@0:      * @param Stub $stub     The Stub for the casted object
Chris@0:      * @param bool $isNested True if the object is nested in the dumped structure
Chris@0:      *
Chris@0:      * @return array The object casted as array
Chris@0:      */
Chris@0:     protected function castObject(Stub $stub, $isNested)
Chris@0:     {
Chris@0:         $obj = $stub->value;
Chris@0:         $class = $stub->class;
Chris@0: 
Chris@0:         if (isset($class[15]) && "\0" === $class[15] && 0 === strpos($class, "class@anonymous\x00")) {
Chris@0:             $stub->class = get_parent_class($class).'@anonymous';
Chris@0:         }
Chris@0:         if (isset($this->classInfo[$class])) {
Chris@0:             list($i, $parents, $hasDebugInfo) = $this->classInfo[$class];
Chris@0:         } else {
Chris@0:             $i = 2;
Chris@17:             $parents = [strtolower($class)];
Chris@0:             $hasDebugInfo = method_exists($class, '__debugInfo');
Chris@0: 
Chris@0:             foreach (class_parents($class) as $p) {
Chris@0:                 $parents[] = strtolower($p);
Chris@0:                 ++$i;
Chris@0:             }
Chris@0:             foreach (class_implements($class) as $p) {
Chris@0:                 $parents[] = strtolower($p);
Chris@0:                 ++$i;
Chris@0:             }
Chris@0:             $parents[] = '*';
Chris@0: 
Chris@17:             $this->classInfo[$class] = [$i, $parents, $hasDebugInfo];
Chris@0:         }
Chris@0: 
Chris@0:         $a = Caster::castObject($obj, $class, $hasDebugInfo);
Chris@0: 
Chris@0:         try {
Chris@0:             while ($i--) {
Chris@0:                 if (!empty($this->casters[$p = $parents[$i]])) {
Chris@0:                     foreach ($this->casters[$p] as $callback) {
Chris@0:                         $a = $callback($obj, $a, $stub, $isNested, $this->filter);
Chris@0:                     }
Chris@0:                 }
Chris@0:             }
Chris@0:         } catch (\Exception $e) {
Chris@17:             $a = [(Stub::TYPE_OBJECT === $stub->type ? Caster::PREFIX_VIRTUAL : '').'⚠' => new ThrowingCasterException($e)] + $a;
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Casts a resource to an array representation.
Chris@0:      *
Chris@0:      * @param Stub $stub     The Stub for the casted resource
Chris@0:      * @param bool $isNested True if the object is nested in the dumped structure
Chris@0:      *
Chris@0:      * @return array The resource casted as array
Chris@0:      */
Chris@0:     protected function castResource(Stub $stub, $isNested)
Chris@0:     {
Chris@17:         $a = [];
Chris@0:         $res = $stub->value;
Chris@0:         $type = $stub->class;
Chris@0: 
Chris@0:         try {
Chris@0:             if (!empty($this->casters[':'.$type])) {
Chris@0:                 foreach ($this->casters[':'.$type] as $callback) {
Chris@0:                     $a = $callback($res, $a, $stub, $isNested, $this->filter);
Chris@0:                 }
Chris@0:             }
Chris@0:         } catch (\Exception $e) {
Chris@17:             $a = [(Stub::TYPE_OBJECT === $stub->type ? Caster::PREFIX_VIRTUAL : '').'⚠' => new ThrowingCasterException($e)] + $a;
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: }