Exporter.php 15 KB

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