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@0:     public static $defaultCasters = array(
Chris@0:         '__PHP_Incomplete_Class' => array('Symfony\Component\VarDumper\Caster\Caster', 'castPhpIncompleteClass'),
Chris@0: 
Chris@0:         'Symfony\Component\VarDumper\Caster\CutStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'),
Chris@0:         'Symfony\Component\VarDumper\Caster\CutArrayStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castCutArray'),
Chris@0:         'Symfony\Component\VarDumper\Caster\ConstStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'),
Chris@0:         'Symfony\Component\VarDumper\Caster\EnumStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castEnum'),
Chris@0: 
Chris@0:         'Closure' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClosure'),
Chris@0:         'Generator' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castGenerator'),
Chris@0:         'ReflectionType' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castType'),
Chris@0:         'ReflectionGenerator' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castReflectionGenerator'),
Chris@0:         'ReflectionClass' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClass'),
Chris@0:         'ReflectionFunctionAbstract' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castFunctionAbstract'),
Chris@0:         'ReflectionMethod' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castMethod'),
Chris@0:         'ReflectionParameter' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castParameter'),
Chris@0:         'ReflectionProperty' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castProperty'),
Chris@0:         'ReflectionExtension' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castExtension'),
Chris@0:         'ReflectionZendExtension' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castZendExtension'),
Chris@0: 
Chris@0:         'Doctrine\Common\Persistence\ObjectManager' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
Chris@0:         'Doctrine\Common\Proxy\Proxy' => array('Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castCommonProxy'),
Chris@0:         'Doctrine\ORM\Proxy\Proxy' => array('Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castOrmProxy'),
Chris@0:         'Doctrine\ORM\PersistentCollection' => array('Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castPersistentCollection'),
Chris@0: 
Chris@0:         'DOMException' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castException'),
Chris@0:         'DOMStringList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
Chris@0:         'DOMNameList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
Chris@0:         'DOMImplementation' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castImplementation'),
Chris@0:         'DOMImplementationList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
Chris@0:         'DOMNode' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castNode'),
Chris@0:         'DOMNameSpaceNode' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castNameSpaceNode'),
Chris@0:         'DOMDocument' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocument'),
Chris@0:         'DOMNodeList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
Chris@0:         'DOMNamedNodeMap' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
Chris@0:         'DOMCharacterData' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castCharacterData'),
Chris@0:         'DOMAttr' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castAttr'),
Chris@0:         'DOMElement' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castElement'),
Chris@0:         'DOMText' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castText'),
Chris@0:         'DOMTypeinfo' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castTypeinfo'),
Chris@0:         'DOMDomError' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castDomError'),
Chris@0:         'DOMLocator' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLocator'),
Chris@0:         'DOMDocumentType' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocumentType'),
Chris@0:         'DOMNotation' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castNotation'),
Chris@0:         'DOMEntity' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castEntity'),
Chris@0:         'DOMProcessingInstruction' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castProcessingInstruction'),
Chris@0:         'DOMXPath' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castXPath'),
Chris@0: 
Chris@0:         'XmlReader' => array('Symfony\Component\VarDumper\Caster\XmlReaderCaster', 'castXmlReader'),
Chris@0: 
Chris@0:         'ErrorException' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castErrorException'),
Chris@0:         'Exception' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castException'),
Chris@0:         'Error' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castError'),
Chris@0:         'Symfony\Component\DependencyInjection\ContainerInterface' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
Chris@0:         'Symfony\Component\HttpFoundation\Request' => array('Symfony\Component\VarDumper\Caster\SymfonyCaster', 'castRequest'),
Chris@0:         'Symfony\Component\VarDumper\Exception\ThrowingCasterException' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castThrowingCasterException'),
Chris@0:         'Symfony\Component\VarDumper\Caster\TraceStub' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castTraceStub'),
Chris@0:         'Symfony\Component\VarDumper\Caster\FrameStub' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castFrameStub'),
Chris@0:         'Symfony\Component\Debug\Exception\SilencedErrorContext' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castSilencedErrorContext'),
Chris@0: 
Chris@0:         'PHPUnit_Framework_MockObject_MockObject' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
Chris@0:         'Prophecy\Prophecy\ProphecySubjectInterface' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
Chris@0:         'Mockery\MockInterface' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
Chris@0: 
Chris@0:         'PDO' => array('Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdo'),
Chris@0:         'PDOStatement' => array('Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdoStatement'),
Chris@0: 
Chris@0:         'AMQPConnection' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castConnection'),
Chris@0:         'AMQPChannel' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castChannel'),
Chris@0:         'AMQPQueue' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castQueue'),
Chris@0:         'AMQPExchange' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castExchange'),
Chris@0:         'AMQPEnvelope' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castEnvelope'),
Chris@0: 
Chris@0:         'ArrayObject' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castArrayObject'),
Chris@0:         'SplDoublyLinkedList' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castDoublyLinkedList'),
Chris@0:         'SplFileInfo' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castFileInfo'),
Chris@0:         'SplFileObject' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castFileObject'),
Chris@0:         'SplFixedArray' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castFixedArray'),
Chris@0:         'SplHeap' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'),
Chris@0:         'SplObjectStorage' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castObjectStorage'),
Chris@0:         'SplPriorityQueue' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'),
Chris@0:         'OuterIterator' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castOuterIterator'),
Chris@0: 
Chris@0:         'MongoCursorInterface' => array('Symfony\Component\VarDumper\Caster\MongoCaster', 'castCursor'),
Chris@0: 
Chris@0:         'Redis' => array('Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedis'),
Chris@0:         'RedisArray' => array('Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedisArray'),
Chris@0: 
Chris@0:         ':curl' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castCurl'),
Chris@0:         ':dba' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'),
Chris@0:         ':dba persistent' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'),
Chris@0:         ':gd' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castGd'),
Chris@0:         ':mysql link' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castMysqlLink'),
Chris@0:         ':pgsql large object' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLargeObject'),
Chris@0:         ':pgsql link' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'),
Chris@0:         ':pgsql link persistent' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'),
Chris@0:         ':pgsql result' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castResult'),
Chris@0:         ':process' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castProcess'),
Chris@0:         ':stream' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'),
Chris@0:         ':persistent stream' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'),
Chris@0:         ':stream-context' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStreamContext'),
Chris@0:         ':xml' => array('Symfony\Component\VarDumper\Caster\XmlResourceCaster', 'castXml'),
Chris@0:     );
Chris@0: 
Chris@0:     protected $maxItems = 2500;
Chris@0:     protected $maxString = -1;
Chris@0:     protected $useExt;
Chris@0: 
Chris@0:     private $casters = array();
Chris@0:     private $prevErrorHandler;
Chris@0:     private $classInfo = array();
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@0:         $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@0:             $this->casters[strtolower($type)][] = is_string($callback) && false !== strpos($callback, '::') ? explode('::', $callback, 2) : $callback;
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the maximum number of items to clone past the first level 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@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@0:         $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@0:                 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@0:             $parents = array(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@0:             $this->classInfo[$class] = array($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@0:             $a = array((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@0:         $a = array();
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@0:             $a = array((Stub::TYPE_OBJECT === $stub->type ? Caster::PREFIX_VIRTUAL : '').'⚠' => new ThrowingCasterException($e)) + $a;
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: }