annotate vendor/symfony/var-dumper/Cloner/VarCloner.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\VarDumper\Cloner;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * @author Nicolas Grekas <p@tchwork.com>
Chris@0 16 */
Chris@0 17 class VarCloner extends AbstractCloner
Chris@0 18 {
Chris@0 19 private static $gid;
Chris@0 20 private static $hashMask = 0;
Chris@0 21 private static $hashOffset = 0;
Chris@17 22 private static $arrayCache = [];
Chris@0 23
Chris@0 24 /**
Chris@0 25 * {@inheritdoc}
Chris@0 26 */
Chris@0 27 protected function doClone($var)
Chris@0 28 {
Chris@0 29 $len = 1; // Length of $queue
Chris@12 30 $pos = 0; // Number of cloned items past the minimum depth
Chris@0 31 $refsCounter = 0; // Hard references counter
Chris@17 32 $queue = [[$var]]; // This breadth-first queue is the return value
Chris@17 33 $indexedArrays = []; // Map of queue indexes that hold numerically indexed arrays
Chris@17 34 $hardRefs = []; // Map of original zval hashes to stub objects
Chris@17 35 $objRefs = []; // Map of original object handles to their stub object counterpart
Chris@18 36 $objects = []; // Keep a ref to objects to ensure their handle cannot be reused while cloning
Chris@17 37 $resRefs = []; // Map of original resource handles to their stub object counterpart
Chris@17 38 $values = []; // Map of stub objects' hashes to original values
Chris@0 39 $maxItems = $this->maxItems;
Chris@0 40 $maxString = $this->maxString;
Chris@12 41 $minDepth = $this->minDepth;
Chris@12 42 $currentDepth = 0; // Current tree depth
Chris@12 43 $currentDepthFinalIndex = 0; // Final $queue index for current tree depth
Chris@12 44 $minimumDepthReached = 0 === $minDepth; // Becomes true when minimum tree depth has been reached
Chris@17 45 $cookie = (object) []; // Unique object used to detect hard references
Chris@0 46 $a = null; // Array cast for nested structures
Chris@0 47 $stub = null; // Stub capturing the main properties of an original item value
Chris@0 48 // or null if the original value is used directly
Chris@0 49
Chris@0 50 if (!self::$hashMask) {
Chris@0 51 self::$gid = uniqid(mt_rand(), true); // Unique string used to detect the special $GLOBALS variable
Chris@0 52 self::initHashMask();
Chris@0 53 }
Chris@0 54 $gid = self::$gid;
Chris@0 55 $hashMask = self::$hashMask;
Chris@0 56 $hashOffset = self::$hashOffset;
Chris@0 57 $arrayStub = new Stub();
Chris@0 58 $arrayStub->type = Stub::TYPE_ARRAY;
Chris@0 59 $fromObjCast = false;
Chris@0 60
Chris@0 61 for ($i = 0; $i < $len; ++$i) {
Chris@12 62 // Detect when we move on to the next tree depth
Chris@12 63 if ($i > $currentDepthFinalIndex) {
Chris@12 64 ++$currentDepth;
Chris@12 65 $currentDepthFinalIndex = $len - 1;
Chris@12 66 if ($currentDepth >= $minDepth) {
Chris@12 67 $minimumDepthReached = true;
Chris@12 68 }
Chris@12 69 }
Chris@12 70
Chris@0 71 $refs = $vals = $queue[$i];
Chris@0 72 if (\PHP_VERSION_ID < 70200 && empty($indexedArrays[$i])) {
Chris@0 73 // see https://wiki.php.net/rfc/convert_numeric_keys_in_object_array_casts
Chris@0 74 foreach ($vals as $k => $v) {
Chris@0 75 if (\is_int($k)) {
Chris@0 76 continue;
Chris@0 77 }
Chris@17 78 foreach ([$k => true] as $gk => $gv) {
Chris@0 79 }
Chris@0 80 if ($gk !== $k) {
Chris@0 81 $fromObjCast = true;
Chris@0 82 $refs = $vals = \array_values($queue[$i]);
Chris@0 83 break;
Chris@0 84 }
Chris@0 85 }
Chris@0 86 }
Chris@0 87 foreach ($vals as $k => $v) {
Chris@0 88 // $v is the original value or a stub object in case of hard references
Chris@0 89 $refs[$k] = $cookie;
Chris@0 90 if ($zvalIsRef = $vals[$k] === $cookie) {
Chris@0 91 $vals[$k] = &$stub; // Break hard references to make $queue completely
Chris@0 92 unset($stub); // independent from the original structure
Chris@0 93 if ($v instanceof Stub && isset($hardRefs[\spl_object_hash($v)])) {
Chris@0 94 $vals[$k] = $refs[$k] = $v;
Chris@0 95 if ($v->value instanceof Stub && (Stub::TYPE_OBJECT === $v->value->type || Stub::TYPE_RESOURCE === $v->value->type)) {
Chris@0 96 ++$v->value->refCount;
Chris@0 97 }
Chris@0 98 ++$v->refCount;
Chris@0 99 continue;
Chris@0 100 }
Chris@0 101 $refs[$k] = $vals[$k] = new Stub();
Chris@0 102 $refs[$k]->value = $v;
Chris@0 103 $h = \spl_object_hash($refs[$k]);
Chris@0 104 $hardRefs[$h] = &$refs[$k];
Chris@0 105 $values[$h] = $v;
Chris@0 106 $vals[$k]->handle = ++$refsCounter;
Chris@0 107 }
Chris@0 108 // Create $stub when the original value $v can not be used directly
Chris@0 109 // If $v is a nested structure, put that structure in array $a
Chris@0 110 switch (true) {
Chris@12 111 case null === $v:
Chris@12 112 case \is_bool($v):
Chris@0 113 case \is_int($v):
Chris@0 114 case \is_float($v):
Chris@0 115 continue 2;
Chris@0 116
Chris@0 117 case \is_string($v):
Chris@12 118 if ('' === $v) {
Chris@12 119 continue 2;
Chris@12 120 }
Chris@0 121 if (!\preg_match('//u', $v)) {
Chris@0 122 $stub = new Stub();
Chris@0 123 $stub->type = Stub::TYPE_STRING;
Chris@0 124 $stub->class = Stub::STRING_BINARY;
Chris@0 125 if (0 <= $maxString && 0 < $cut = \strlen($v) - $maxString) {
Chris@0 126 $stub->cut = $cut;
Chris@0 127 $stub->value = \substr($v, 0, -$cut);
Chris@0 128 } else {
Chris@0 129 $stub->value = $v;
Chris@0 130 }
Chris@0 131 } elseif (0 <= $maxString && isset($v[1 + ($maxString >> 2)]) && 0 < $cut = \mb_strlen($v, 'UTF-8') - $maxString) {
Chris@0 132 $stub = new Stub();
Chris@0 133 $stub->type = Stub::TYPE_STRING;
Chris@0 134 $stub->class = Stub::STRING_UTF8;
Chris@0 135 $stub->cut = $cut;
Chris@0 136 $stub->value = \mb_substr($v, 0, $maxString, 'UTF-8');
Chris@0 137 } else {
Chris@0 138 continue 2;
Chris@0 139 }
Chris@0 140 $a = null;
Chris@0 141 break;
Chris@0 142
Chris@0 143 case \is_array($v):
Chris@12 144 if (!$v) {
Chris@12 145 continue 2;
Chris@12 146 }
Chris@0 147 $stub = $arrayStub;
Chris@0 148 $stub->class = Stub::ARRAY_INDEXED;
Chris@0 149
Chris@0 150 $j = -1;
Chris@0 151 foreach ($v as $gk => $gv) {
Chris@0 152 if ($gk !== ++$j) {
Chris@0 153 $stub->class = Stub::ARRAY_ASSOC;
Chris@0 154 break;
Chris@0 155 }
Chris@0 156 }
Chris@0 157 $a = $v;
Chris@0 158
Chris@0 159 if (Stub::ARRAY_ASSOC === $stub->class) {
Chris@0 160 // Copies of $GLOBALS have very strange behavior,
Chris@0 161 // let's detect them with some black magic
Chris@0 162 $a[$gid] = true;
Chris@0 163
Chris@0 164 // Happens with copies of $GLOBALS
Chris@0 165 if (isset($v[$gid])) {
Chris@0 166 unset($v[$gid]);
Chris@17 167 $a = [];
Chris@0 168 foreach ($v as $gk => &$gv) {
Chris@0 169 $a[$gk] = &$gv;
Chris@0 170 }
Chris@0 171 unset($gv);
Chris@0 172 } else {
Chris@0 173 $a = $v;
Chris@0 174 }
Chris@0 175 } elseif (\PHP_VERSION_ID < 70200) {
Chris@0 176 $indexedArrays[$len] = true;
Chris@0 177 }
Chris@0 178 break;
Chris@0 179
Chris@0 180 case \is_object($v):
Chris@0 181 case $v instanceof \__PHP_Incomplete_Class:
Chris@0 182 if (empty($objRefs[$h = $hashMask ^ \hexdec(\substr(\spl_object_hash($v), $hashOffset, \PHP_INT_SIZE))])) {
Chris@0 183 $stub = new Stub();
Chris@0 184 $stub->type = Stub::TYPE_OBJECT;
Chris@0 185 $stub->class = \get_class($v);
Chris@0 186 $stub->value = $v;
Chris@0 187 $stub->handle = $h;
Chris@0 188 $a = $this->castObject($stub, 0 < $i);
Chris@0 189 if ($v !== $stub->value) {
Chris@0 190 if (Stub::TYPE_OBJECT !== $stub->type || null === $stub->value) {
Chris@0 191 break;
Chris@0 192 }
Chris@0 193 $h = $hashMask ^ \hexdec(\substr(\spl_object_hash($stub->value), $hashOffset, \PHP_INT_SIZE));
Chris@0 194 $stub->handle = $h;
Chris@0 195 }
Chris@0 196 $stub->value = null;
Chris@12 197 if (0 <= $maxItems && $maxItems <= $pos && $minimumDepthReached) {
Chris@0 198 $stub->cut = \count($a);
Chris@0 199 $a = null;
Chris@0 200 }
Chris@0 201 }
Chris@0 202 if (empty($objRefs[$h])) {
Chris@0 203 $objRefs[$h] = $stub;
Chris@18 204 $objects[] = $v;
Chris@0 205 } else {
Chris@0 206 $stub = $objRefs[$h];
Chris@0 207 ++$stub->refCount;
Chris@0 208 $a = null;
Chris@0 209 }
Chris@0 210 break;
Chris@0 211
Chris@0 212 default: // resource
Chris@0 213 if (empty($resRefs[$h = (int) $v])) {
Chris@0 214 $stub = new Stub();
Chris@0 215 $stub->type = Stub::TYPE_RESOURCE;
Chris@0 216 if ('Unknown' === $stub->class = @\get_resource_type($v)) {
Chris@0 217 $stub->class = 'Closed';
Chris@0 218 }
Chris@0 219 $stub->value = $v;
Chris@0 220 $stub->handle = $h;
Chris@0 221 $a = $this->castResource($stub, 0 < $i);
Chris@0 222 $stub->value = null;
Chris@12 223 if (0 <= $maxItems && $maxItems <= $pos && $minimumDepthReached) {
Chris@0 224 $stub->cut = \count($a);
Chris@0 225 $a = null;
Chris@0 226 }
Chris@0 227 }
Chris@0 228 if (empty($resRefs[$h])) {
Chris@0 229 $resRefs[$h] = $stub;
Chris@0 230 } else {
Chris@0 231 $stub = $resRefs[$h];
Chris@0 232 ++$stub->refCount;
Chris@0 233 $a = null;
Chris@0 234 }
Chris@0 235 break;
Chris@0 236 }
Chris@0 237
Chris@0 238 if ($a) {
Chris@12 239 if (!$minimumDepthReached || 0 > $maxItems) {
Chris@0 240 $queue[$len] = $a;
Chris@0 241 $stub->position = $len++;
Chris@0 242 } elseif ($pos < $maxItems) {
Chris@0 243 if ($maxItems < $pos += \count($a)) {
Chris@0 244 $a = \array_slice($a, 0, $maxItems - $pos);
Chris@0 245 if ($stub->cut >= 0) {
Chris@0 246 $stub->cut += $pos - $maxItems;
Chris@0 247 }
Chris@0 248 }
Chris@0 249 $queue[$len] = $a;
Chris@0 250 $stub->position = $len++;
Chris@0 251 } elseif ($stub->cut >= 0) {
Chris@0 252 $stub->cut += \count($a);
Chris@0 253 $stub->position = 0;
Chris@0 254 }
Chris@0 255 }
Chris@0 256
Chris@0 257 if ($arrayStub === $stub) {
Chris@0 258 if ($arrayStub->cut) {
Chris@17 259 $stub = [$arrayStub->cut, $arrayStub->class => $arrayStub->position];
Chris@0 260 $arrayStub->cut = 0;
Chris@0 261 } elseif (isset(self::$arrayCache[$arrayStub->class][$arrayStub->position])) {
Chris@0 262 $stub = self::$arrayCache[$arrayStub->class][$arrayStub->position];
Chris@0 263 } else {
Chris@17 264 self::$arrayCache[$arrayStub->class][$arrayStub->position] = $stub = [$arrayStub->class => $arrayStub->position];
Chris@0 265 }
Chris@0 266 }
Chris@0 267
Chris@0 268 if ($zvalIsRef) {
Chris@0 269 $refs[$k]->value = $stub;
Chris@0 270 } else {
Chris@0 271 $vals[$k] = $stub;
Chris@0 272 }
Chris@0 273 }
Chris@0 274
Chris@0 275 if ($fromObjCast) {
Chris@0 276 $fromObjCast = false;
Chris@0 277 $refs = $vals;
Chris@17 278 $vals = [];
Chris@0 279 $j = -1;
Chris@0 280 foreach ($queue[$i] as $k => $v) {
Chris@17 281 foreach ([$k => true] as $gk => $gv) {
Chris@0 282 }
Chris@0 283 if ($gk !== $k) {
Chris@0 284 $vals = (object) $vals;
Chris@0 285 $vals->{$k} = $refs[++$j];
Chris@0 286 $vals = (array) $vals;
Chris@0 287 } else {
Chris@0 288 $vals[$k] = $refs[++$j];
Chris@0 289 }
Chris@0 290 }
Chris@0 291 }
Chris@0 292
Chris@0 293 $queue[$i] = $vals;
Chris@0 294 }
Chris@0 295
Chris@0 296 foreach ($values as $h => $v) {
Chris@0 297 $hardRefs[$h] = $v;
Chris@0 298 }
Chris@0 299
Chris@0 300 return $queue;
Chris@0 301 }
Chris@0 302
Chris@0 303 private static function initHashMask()
Chris@0 304 {
Chris@17 305 $obj = (object) [];
Chris@0 306 self::$hashOffset = 16 - PHP_INT_SIZE;
Chris@0 307 self::$hashMask = -1;
Chris@0 308
Chris@17 309 if (\defined('HHVM_VERSION')) {
Chris@0 310 self::$hashOffset += 16;
Chris@0 311 } else {
Chris@0 312 // check if we are nested in an output buffering handler to prevent a fatal error with ob_start() below
Chris@17 313 $obFuncs = ['ob_clean', 'ob_end_clean', 'ob_flush', 'ob_end_flush', 'ob_get_contents', 'ob_get_flush'];
Chris@0 314 foreach (debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) as $frame) {
Chris@17 315 if (isset($frame['function'][0]) && !isset($frame['class']) && 'o' === $frame['function'][0] && \in_array($frame['function'], $obFuncs)) {
Chris@0 316 $frame['line'] = 0;
Chris@0 317 break;
Chris@0 318 }
Chris@0 319 }
Chris@0 320 if (!empty($frame['line'])) {
Chris@0 321 ob_start();
Chris@0 322 debug_zval_dump($obj);
Chris@0 323 self::$hashMask = (int) substr(ob_get_clean(), 17);
Chris@0 324 }
Chris@0 325 }
Chris@0 326
Chris@0 327 self::$hashMask ^= hexdec(substr(spl_object_hash($obj), self::$hashOffset, PHP_INT_SIZE));
Chris@0 328 }
Chris@0 329 }