Exporter.php 15 KB

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