Exporter.php 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\VarExporter\Internal;
  11. use Symfony\Component\VarExporter\Exception\NotInstantiableTypeException;
  12. /**
  13. * @author Nicolas Grekas <p@tchwork.com>
  14. *
  15. * @internal
  16. */
  17. class Exporter
  18. {
  19. /**
  20. * Prepares an array of values for VarExporter.
  21. *
  22. * For performance this method is public and has no type-hints.
  23. *
  24. * @param array &$values
  25. * @param \SplObjectStorage $objectsPool
  26. * @param array &$refsPool
  27. * @param int &$objectsCount
  28. * @param bool &$valuesAreStatic
  29. *
  30. * @return array
  31. *
  32. * @throws NotInstantiableTypeException When a value cannot be serialized
  33. */
  34. public static function prepare($values, $objectsPool, &$refsPool, &$objectsCount, &$valuesAreStatic)
  35. {
  36. $refs = $values;
  37. foreach ($values as $k => $value) {
  38. if (\is_resource($value)) {
  39. throw new NotInstantiableTypeException(get_resource_type($value).' resource');
  40. }
  41. $refs[$k] = $objectsPool;
  42. if ($isRef = !$valueIsStatic = $values[$k] !== $objectsPool) {
  43. $values[$k] = &$value; // Break hard references to make $values completely
  44. unset($value); // independent from the original structure
  45. $refs[$k] = $value = $values[$k];
  46. if ($value instanceof Reference && 0 > $value->id) {
  47. $valuesAreStatic = false;
  48. ++$value->count;
  49. continue;
  50. }
  51. $refsPool[] = [&$refs[$k], $value, &$value];
  52. $refs[$k] = $values[$k] = new Reference(-\count($refsPool), $value);
  53. }
  54. if (\is_array($value)) {
  55. if ($value) {
  56. $value = self::prepare($value, $objectsPool, $refsPool, $objectsCount, $valueIsStatic);
  57. }
  58. goto handle_value;
  59. } elseif (!\is_object($value) && !$value instanceof \__PHP_Incomplete_Class || $value instanceof \UnitEnum) {
  60. goto handle_value;
  61. }
  62. $valueIsStatic = false;
  63. if (isset($objectsPool[$value])) {
  64. ++$objectsCount;
  65. $value = new Reference($objectsPool[$value][0]);
  66. goto handle_value;
  67. }
  68. $class = \get_class($value);
  69. $reflector = Registry::$reflectors[$class] ?? Registry::getClassReflector($class);
  70. if ($reflector->hasMethod('__serialize')) {
  71. if (!$reflector->getMethod('__serialize')->isPublic()) {
  72. throw new \Error(sprintf('Call to %s method "%s::__serialize()".', $reflector->getMethod('__serialize')->isProtected() ? 'protected' : 'private', $class));
  73. }
  74. if (!\is_array($properties = $value->__serialize())) {
  75. throw new \TypeError($class.'::__serialize() must return an array');
  76. }
  77. goto prepare_value;
  78. }
  79. $properties = [];
  80. $sleep = null;
  81. $proto = Registry::$prototypes[$class];
  82. if (($value instanceof \ArrayIterator || $value instanceof \ArrayObject) && null !== $proto) {
  83. // ArrayIterator and ArrayObject need special care because their "flags"
  84. // option changes the behavior of the (array) casting operator.
  85. [$arrayValue, $properties] = self::getArrayObjectProperties($value, $proto);
  86. // populates Registry::$prototypes[$class] with a new instance
  87. Registry::getClassReflector($class, Registry::$instantiableWithoutConstructor[$class], Registry::$cloneable[$class]);
  88. } elseif ($value instanceof \SplObjectStorage && Registry::$cloneable[$class] && null !== $proto) {
  89. // By implementing Serializable, SplObjectStorage breaks
  90. // internal references; let's deal with it on our own.
  91. foreach (clone $value as $v) {
  92. $properties[] = $v;
  93. $properties[] = $value[$v];
  94. }
  95. $properties = ['SplObjectStorage' => ["\0" => $properties]];
  96. $arrayValue = (array) $value;
  97. } elseif ($value instanceof \Serializable || $value instanceof \__PHP_Incomplete_Class) {
  98. ++$objectsCount;
  99. $objectsPool[$value] = [$id = \count($objectsPool), serialize($value), [], 0];
  100. $value = new Reference($id);
  101. goto handle_value;
  102. } else {
  103. if (method_exists($class, '__sleep')) {
  104. if (!\is_array($sleep = $value->__sleep())) {
  105. trigger_error('serialize(): __sleep should return an array only containing the names of instance-variables to serialize', \E_USER_NOTICE);
  106. $value = null;
  107. goto handle_value;
  108. }
  109. $sleep = array_flip($sleep);
  110. }
  111. $arrayValue = (array) $value;
  112. }
  113. $proto = (array) $proto;
  114. foreach ($arrayValue as $name => $v) {
  115. $i = 0;
  116. $n = (string) $name;
  117. if ('' === $n || "\0" !== $n[0]) {
  118. $c = 'stdClass';
  119. } elseif ('*' === $n[1]) {
  120. $n = substr($n, 3);
  121. $c = $reflector->getProperty($n)->class;
  122. if ('Error' === $c) {
  123. $c = 'TypeError';
  124. } elseif ('Exception' === $c) {
  125. $c = 'ErrorException';
  126. }
  127. } else {
  128. $i = strpos($n, "\0", 2);
  129. $c = substr($n, 1, $i - 1);
  130. $n = substr($n, 1 + $i);
  131. }
  132. if (null !== $sleep) {
  133. if (!isset($sleep[$n]) || ($i && $c !== $class)) {
  134. continue;
  135. }
  136. $sleep[$n] = false;
  137. }
  138. if (!\array_key_exists($name, $proto) || $proto[$name] !== $v || "\x00Error\x00trace" === $name || "\x00Exception\x00trace" === $name) {
  139. $properties[$c][$n] = $v;
  140. }
  141. }
  142. if ($sleep) {
  143. foreach ($sleep as $n => $v) {
  144. if (false !== $v) {
  145. trigger_error(sprintf('serialize(): "%s" returned as member variable from __sleep() but does not exist', $n), \E_USER_NOTICE);
  146. }
  147. }
  148. }
  149. prepare_value:
  150. $objectsPool[$value] = [$id = \count($objectsPool)];
  151. $properties = self::prepare($properties, $objectsPool, $refsPool, $objectsCount, $valueIsStatic);
  152. ++$objectsCount;
  153. $objectsPool[$value] = [$id, $class, $properties, method_exists($class, '__unserialize') ? -$objectsCount : (method_exists($class, '__wakeup') ? $objectsCount : 0)];
  154. $value = new Reference($id);
  155. handle_value:
  156. if ($isRef) {
  157. unset($value); // Break the hard reference created above
  158. } elseif (!$valueIsStatic) {
  159. $values[$k] = $value;
  160. }
  161. $valuesAreStatic = $valueIsStatic && $valuesAreStatic;
  162. }
  163. return $values;
  164. }
  165. public static function export($value, $indent = '')
  166. {
  167. switch (true) {
  168. case \is_int($value) || \is_float($value) || $value instanceof \UnitEnum: return var_export($value, true);
  169. case [] === $value: return '[]';
  170. case false === $value: return 'false';
  171. case true === $value: return 'true';
  172. case null === $value: return 'null';
  173. case '' === $value: return "''";
  174. }
  175. if ($value instanceof Reference) {
  176. if (0 <= $value->id) {
  177. return '$o['.$value->id.']';
  178. }
  179. if (!$value->count) {
  180. return self::export($value->value, $indent);
  181. }
  182. $value = -$value->id;
  183. return '&$r['.$value.']';
  184. }
  185. $subIndent = $indent.' ';
  186. if (\is_string($value)) {
  187. $code = sprintf("'%s'", addcslashes($value, "'\\"));
  188. $code = preg_replace_callback("/((?:[\\0\\r\\n]|\u{202A}|\u{202B}|\u{202D}|\u{202E}|\u{2066}|\u{2067}|\u{2068}|\u{202C}|\u{2069})++)(.)/", function ($m) use ($subIndent) {
  189. $m[1] = sprintf('\'."%s".\'', str_replace(
  190. ["\0", "\r", "\n", "\u{202A}", "\u{202B}", "\u{202D}", "\u{202E}", "\u{2066}", "\u{2067}", "\u{2068}", "\u{202C}", "\u{2069}", '\n\\'],
  191. ['\0', '\r', '\n', '\u{202A}', '\u{202B}', '\u{202D}', '\u{202E}', '\u{2066}', '\u{2067}', '\u{2068}', '\u{202C}', '\u{2069}', '\n"'."\n".$subIndent.'."\\'],
  192. $m[1]
  193. ));
  194. if ("'" === $m[2]) {
  195. return substr($m[1], 0, -2);
  196. }
  197. if ('n".\'' === substr($m[1], -4)) {
  198. return substr_replace($m[1], "\n".$subIndent.".'".$m[2], -2);
  199. }
  200. return $m[1].$m[2];
  201. }, $code, -1, $count);
  202. if ($count && str_starts_with($code, "''.")) {
  203. $code = substr($code, 3);
  204. }
  205. return $code;
  206. }
  207. if (\is_array($value)) {
  208. $j = -1;
  209. $code = '';
  210. foreach ($value as $k => $v) {
  211. $code .= $subIndent;
  212. if (!\is_int($k) || 1 !== $k - $j) {
  213. $code .= self::export($k, $subIndent).' => ';
  214. }
  215. if (\is_int($k) && $k > $j) {
  216. $j = $k;
  217. }
  218. $code .= self::export($v, $subIndent).",\n";
  219. }
  220. return "[\n".$code.$indent.']';
  221. }
  222. if ($value instanceof Values) {
  223. $code = $subIndent."\$r = [],\n";
  224. foreach ($value->values as $k => $v) {
  225. $code .= $subIndent.'$r['.$k.'] = '.self::export($v, $subIndent).",\n";
  226. }
  227. return "[\n".$code.$indent.']';
  228. }
  229. if ($value instanceof Registry) {
  230. return self::exportRegistry($value, $indent, $subIndent);
  231. }
  232. if ($value instanceof Hydrator) {
  233. return self::exportHydrator($value, $indent, $subIndent);
  234. }
  235. throw new \UnexpectedValueException(sprintf('Cannot export value of type "%s".', \is_object($value) ? \get_class($value) : \gettype($value)));
  236. }
  237. private static function exportRegistry(Registry $value, string $indent, string $subIndent): string
  238. {
  239. $code = '';
  240. $serializables = [];
  241. $seen = [];
  242. $prototypesAccess = 0;
  243. $factoriesAccess = 0;
  244. $r = '\\'.Registry::class;
  245. $j = -1;
  246. foreach ($value->classes as $k => $class) {
  247. if (':' === ($class[1] ?? null)) {
  248. $serializables[$k] = $class;
  249. continue;
  250. }
  251. if (!Registry::$instantiableWithoutConstructor[$class]) {
  252. if (is_subclass_of($class, 'Serializable') && !method_exists($class, '__unserialize')) {
  253. $serializables[$k] = 'C:'.\strlen($class).':"'.$class.'":0:{}';
  254. } else {
  255. $serializables[$k] = 'O:'.\strlen($class).':"'.$class.'":0:{}';
  256. }
  257. if (is_subclass_of($class, 'Throwable')) {
  258. $eol = is_subclass_of($class, 'Error') ? "\0Error\0" : "\0Exception\0";
  259. $serializables[$k] = substr_replace($serializables[$k], '1:{s:'.(5 + \strlen($eol)).':"'.$eol.'trace";a:0:{}}', -4);
  260. }
  261. continue;
  262. }
  263. $code .= $subIndent.(1 !== $k - $j ? $k.' => ' : '');
  264. $j = $k;
  265. $eol = ",\n";
  266. $c = '['.self::export($class).']';
  267. if ($seen[$class] ?? false) {
  268. if (Registry::$cloneable[$class]) {
  269. ++$prototypesAccess;
  270. $code .= 'clone $p'.$c;
  271. } else {
  272. ++$factoriesAccess;
  273. $code .= '$f'.$c.'()';
  274. }
  275. } else {
  276. $seen[$class] = true;
  277. if (Registry::$cloneable[$class]) {
  278. $code .= 'clone ('.($prototypesAccess++ ? '$p' : '($p = &'.$r.'::$prototypes)').$c.' ?? '.$r.'::p';
  279. } else {
  280. $code .= '('.($factoriesAccess++ ? '$f' : '($f = &'.$r.'::$factories)').$c.' ?? '.$r.'::f';
  281. $eol = '()'.$eol;
  282. }
  283. $code .= '('.substr($c, 1, -1).'))';
  284. }
  285. $code .= $eol;
  286. }
  287. if (1 === $prototypesAccess) {
  288. $code = str_replace('($p = &'.$r.'::$prototypes)', $r.'::$prototypes', $code);
  289. }
  290. if (1 === $factoriesAccess) {
  291. $code = str_replace('($f = &'.$r.'::$factories)', $r.'::$factories', $code);
  292. }
  293. if ('' !== $code) {
  294. $code = "\n".$code.$indent;
  295. }
  296. if ($serializables) {
  297. $code = $r.'::unserialize(['.$code.'], '.self::export($serializables, $indent).')';
  298. } else {
  299. $code = '['.$code.']';
  300. }
  301. return '$o = '.$code;
  302. }
  303. private static function exportHydrator(Hydrator $value, string $indent, string $subIndent): string
  304. {
  305. $code = '';
  306. foreach ($value->properties as $class => $properties) {
  307. $code .= $subIndent.' '.self::export($class).' => '.self::export($properties, $subIndent.' ').",\n";
  308. }
  309. $code = [
  310. self::export($value->registry, $subIndent),
  311. self::export($value->values, $subIndent),
  312. '' !== $code ? "[\n".$code.$subIndent.']' : '[]',
  313. self::export($value->value, $subIndent),
  314. self::export($value->wakeups, $subIndent),
  315. ];
  316. return '\\'.\get_class($value)."::hydrate(\n".$subIndent.implode(",\n".$subIndent, $code)."\n".$indent.')';
  317. }
  318. /**
  319. * @param \ArrayIterator|\ArrayObject $value
  320. * @param \ArrayIterator|\ArrayObject $proto
  321. */
  322. private static function getArrayObjectProperties($value, $proto): array
  323. {
  324. $reflector = $value instanceof \ArrayIterator ? 'ArrayIterator' : 'ArrayObject';
  325. $reflector = Registry::$reflectors[$reflector] ?? Registry::getClassReflector($reflector);
  326. $properties = [
  327. $arrayValue = (array) $value,
  328. $reflector->getMethod('getFlags')->invoke($value),
  329. $value instanceof \ArrayObject ? $reflector->getMethod('getIteratorClass')->invoke($value) : 'ArrayIterator',
  330. ];
  331. $reflector = $reflector->getMethod('setFlags');
  332. $reflector->invoke($proto, \ArrayObject::STD_PROP_LIST);
  333. if ($properties[1] & \ArrayObject::STD_PROP_LIST) {
  334. $reflector->invoke($value, 0);
  335. $properties[0] = (array) $value;
  336. } else {
  337. $reflector->invoke($value, \ArrayObject::STD_PROP_LIST);
  338. $arrayValue = (array) $value;
  339. }
  340. $reflector->invoke($value, $properties[1]);
  341. if ([[], 0, 'ArrayIterator'] === $properties) {
  342. $properties = [];
  343. } else {
  344. if ('ArrayIterator' === $properties[2]) {
  345. unset($properties[2]);
  346. }
  347. $properties = [$reflector->class => ["\0" => $properties]];
  348. }
  349. return [$arrayValue, $properties];
  350. }
  351. }