Inline.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546
  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\Yaml;
  11. use Symfony\Component\Yaml\Exception\ParseException;
  12. use Symfony\Component\Yaml\Exception\DumpException;
  13. /**
  14. * Inline implements a YAML parser/dumper for the YAML inline syntax.
  15. *
  16. * @author Fabien Potencier <fabien@symfony.com>
  17. */
  18. class Inline
  19. {
  20. const REGEX_QUOTED_STRING = '(?:"([^"\\\\]*(?:\\\\.[^"\\\\]*)*)"|\'([^\']*(?:\'\'[^\']*)*)\')';
  21. private static $exceptionOnInvalidType = false;
  22. private static $objectSupport = false;
  23. private static $objectForMap = false;
  24. /**
  25. * Converts a YAML string to a PHP array.
  26. *
  27. * @param string $value A YAML string
  28. * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
  29. * @param bool $objectSupport true if object support is enabled, false otherwise
  30. * @param bool $objectForMap true if maps should return a stdClass instead of array()
  31. * @param array $references Mapping of variable names to values
  32. *
  33. * @return array A PHP array representing the YAML string
  34. *
  35. * @throws ParseException
  36. */
  37. public static function parse($value, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false, $references = array())
  38. {
  39. self::$exceptionOnInvalidType = $exceptionOnInvalidType;
  40. self::$objectSupport = $objectSupport;
  41. self::$objectForMap = $objectForMap;
  42. $value = trim($value);
  43. if ('' === $value) {
  44. return '';
  45. }
  46. if (function_exists('mb_internal_encoding') && ((int) ini_get('mbstring.func_overload')) & 2) {
  47. $mbEncoding = mb_internal_encoding();
  48. mb_internal_encoding('ASCII');
  49. }
  50. $i = 0;
  51. switch ($value[0]) {
  52. case '[':
  53. $result = self::parseSequence($value, $i, $references);
  54. ++$i;
  55. break;
  56. case '{':
  57. $result = self::parseMapping($value, $i, $references);
  58. ++$i;
  59. break;
  60. default:
  61. $result = self::parseScalar($value, null, array('"', "'"), $i, true, $references);
  62. }
  63. // some comments are allowed at the end
  64. if (preg_replace('/\s+#.*$/A', '', substr($value, $i))) {
  65. throw new ParseException(sprintf('Unexpected characters near "%s".', substr($value, $i)));
  66. }
  67. if (isset($mbEncoding)) {
  68. mb_internal_encoding($mbEncoding);
  69. }
  70. return $result;
  71. }
  72. /**
  73. * Dumps a given PHP variable to a YAML string.
  74. *
  75. * @param mixed $value The PHP variable to convert
  76. * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
  77. * @param bool $objectSupport true if object support is enabled, false otherwise
  78. *
  79. * @return string The YAML string representing the PHP array
  80. *
  81. * @throws DumpException When trying to dump PHP resource
  82. */
  83. public static function dump($value, $exceptionOnInvalidType = false, $objectSupport = false)
  84. {
  85. switch (true) {
  86. case is_resource($value):
  87. if ($exceptionOnInvalidType) {
  88. throw new DumpException(sprintf('Unable to dump PHP resources in a YAML file ("%s").', get_resource_type($value)));
  89. }
  90. return 'null';
  91. case is_object($value):
  92. if ($objectSupport) {
  93. return '!!php/object:'.serialize($value);
  94. }
  95. if ($exceptionOnInvalidType) {
  96. throw new DumpException('Object support when dumping a YAML file has been disabled.');
  97. }
  98. return 'null';
  99. case is_array($value):
  100. return self::dumpArray($value, $exceptionOnInvalidType, $objectSupport);
  101. case null === $value:
  102. return 'null';
  103. case true === $value:
  104. return 'true';
  105. case false === $value:
  106. return 'false';
  107. case ctype_digit($value):
  108. return is_string($value) ? "'$value'" : (int) $value;
  109. case is_numeric($value):
  110. $locale = setlocale(LC_NUMERIC, 0);
  111. if (false !== $locale) {
  112. setlocale(LC_NUMERIC, 'C');
  113. }
  114. if (is_float($value)) {
  115. $repr = (string) $value;
  116. if (is_infinite($value)) {
  117. $repr = str_ireplace('INF', '.Inf', $repr);
  118. } elseif (floor($value) == $value && $repr == $value) {
  119. // Preserve float data type since storing a whole number will result in integer value.
  120. $repr = '!!float '.$repr;
  121. }
  122. } else {
  123. $repr = is_string($value) ? "'$value'" : (string) $value;
  124. }
  125. if (false !== $locale) {
  126. setlocale(LC_NUMERIC, $locale);
  127. }
  128. return $repr;
  129. case '' == $value:
  130. return "''";
  131. case Escaper::requiresDoubleQuoting($value):
  132. return Escaper::escapeWithDoubleQuotes($value);
  133. case Escaper::requiresSingleQuoting($value):
  134. case preg_match(self::getHexRegex(), $value):
  135. case preg_match(self::getTimestampRegex(), $value):
  136. return Escaper::escapeWithSingleQuotes($value);
  137. default:
  138. return $value;
  139. }
  140. }
  141. /**
  142. * Dumps a PHP array to a YAML string.
  143. *
  144. * @param array $value The PHP array to dump
  145. * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
  146. * @param bool $objectSupport true if object support is enabled, false otherwise
  147. *
  148. * @return string The YAML string representing the PHP array
  149. */
  150. private static function dumpArray($value, $exceptionOnInvalidType, $objectSupport)
  151. {
  152. // array
  153. $keys = array_keys($value);
  154. $keysCount = count($keys);
  155. if ((1 === $keysCount && '0' == $keys[0])
  156. || ($keysCount > 1 && array_reduce($keys, function ($v, $w) { return (int) $v + $w; }, 0) === $keysCount * ($keysCount - 1) / 2)
  157. ) {
  158. $output = array();
  159. foreach ($value as $val) {
  160. $output[] = self::dump($val, $exceptionOnInvalidType, $objectSupport);
  161. }
  162. return sprintf('[%s]', implode(', ', $output));
  163. }
  164. // mapping
  165. $output = array();
  166. foreach ($value as $key => $val) {
  167. $output[] = sprintf('%s: %s', self::dump($key, $exceptionOnInvalidType, $objectSupport), self::dump($val, $exceptionOnInvalidType, $objectSupport));
  168. }
  169. return sprintf('{ %s }', implode(', ', $output));
  170. }
  171. /**
  172. * Parses a scalar to a YAML string.
  173. *
  174. * @param string $scalar
  175. * @param string $delimiters
  176. * @param array $stringDelimiters
  177. * @param int &$i
  178. * @param bool $evaluate
  179. * @param array $references
  180. *
  181. * @return string A YAML string
  182. *
  183. * @throws ParseException When malformed inline YAML string is parsed
  184. */
  185. public static function parseScalar($scalar, $delimiters = null, $stringDelimiters = array('"', "'"), &$i = 0, $evaluate = true, $references = array())
  186. {
  187. if (in_array($scalar[$i], $stringDelimiters)) {
  188. // quoted scalar
  189. $output = self::parseQuotedScalar($scalar, $i);
  190. if (null !== $delimiters) {
  191. $tmp = ltrim(substr($scalar, $i), ' ');
  192. if (!in_array($tmp[0], $delimiters)) {
  193. throw new ParseException(sprintf('Unexpected characters (%s).', substr($scalar, $i)));
  194. }
  195. }
  196. } else {
  197. // "normal" string
  198. if (!$delimiters) {
  199. $output = substr($scalar, $i);
  200. $i += strlen($output);
  201. // remove comments
  202. if (false !== $strpos = strpos($output, ' #')) {
  203. $output = rtrim(substr($output, 0, $strpos));
  204. }
  205. } elseif (preg_match('/^(.+?)('.implode('|', $delimiters).')/', substr($scalar, $i), $match)) {
  206. $output = $match[1];
  207. $i += strlen($output);
  208. } else {
  209. throw new ParseException(sprintf('Malformed inline YAML string (%s).', $scalar));
  210. }
  211. if ($evaluate) {
  212. $output = self::evaluateScalar($output, $references);
  213. }
  214. }
  215. return $output;
  216. }
  217. /**
  218. * Parses a quoted scalar to YAML.
  219. *
  220. * @param string $scalar
  221. * @param int &$i
  222. *
  223. * @return string A YAML string
  224. *
  225. * @throws ParseException When malformed inline YAML string is parsed
  226. */
  227. private static function parseQuotedScalar($scalar, &$i)
  228. {
  229. if (!preg_match('/'.self::REGEX_QUOTED_STRING.'/Au', substr($scalar, $i), $match)) {
  230. throw new ParseException(sprintf('Malformed inline YAML string (%s).', substr($scalar, $i)));
  231. }
  232. $output = substr($match[0], 1, strlen($match[0]) - 2);
  233. $unescaper = new Unescaper();
  234. if ('"' == $scalar[$i]) {
  235. $output = $unescaper->unescapeDoubleQuotedString($output);
  236. } else {
  237. $output = $unescaper->unescapeSingleQuotedString($output);
  238. }
  239. $i += strlen($match[0]);
  240. return $output;
  241. }
  242. /**
  243. * Parses a sequence to a YAML string.
  244. *
  245. * @param string $sequence
  246. * @param int &$i
  247. * @param array $references
  248. *
  249. * @return string A YAML string
  250. *
  251. * @throws ParseException When malformed inline YAML string is parsed
  252. */
  253. private static function parseSequence($sequence, &$i = 0, $references = array())
  254. {
  255. $output = array();
  256. $len = strlen($sequence);
  257. ++$i;
  258. // [foo, bar, ...]
  259. while ($i < $len) {
  260. switch ($sequence[$i]) {
  261. case '[':
  262. // nested sequence
  263. $output[] = self::parseSequence($sequence, $i, $references);
  264. break;
  265. case '{':
  266. // nested mapping
  267. $output[] = self::parseMapping($sequence, $i, $references);
  268. break;
  269. case ']':
  270. return $output;
  271. case ',':
  272. case ' ':
  273. break;
  274. default:
  275. $isQuoted = in_array($sequence[$i], array('"', "'"));
  276. $value = self::parseScalar($sequence, array(',', ']'), array('"', "'"), $i, true, $references);
  277. // the value can be an array if a reference has been resolved to an array var
  278. if (!is_array($value) && !$isQuoted && false !== strpos($value, ': ')) {
  279. // embedded mapping?
  280. try {
  281. $pos = 0;
  282. $value = self::parseMapping('{'.$value.'}', $pos, $references);
  283. } catch (\InvalidArgumentException $e) {
  284. // no, it's not
  285. }
  286. }
  287. $output[] = $value;
  288. --$i;
  289. }
  290. ++$i;
  291. }
  292. throw new ParseException(sprintf('Malformed inline YAML string %s', $sequence));
  293. }
  294. /**
  295. * Parses a mapping to a YAML string.
  296. *
  297. * @param string $mapping
  298. * @param int &$i
  299. * @param array $references
  300. *
  301. * @return string A YAML string
  302. *
  303. * @throws ParseException When malformed inline YAML string is parsed
  304. */
  305. private static function parseMapping($mapping, &$i = 0, $references = array())
  306. {
  307. $output = array();
  308. $len = strlen($mapping);
  309. ++$i;
  310. // {foo: bar, bar:foo, ...}
  311. while ($i < $len) {
  312. switch ($mapping[$i]) {
  313. case ' ':
  314. case ',':
  315. ++$i;
  316. continue 2;
  317. case '}':
  318. if (self::$objectForMap) {
  319. return (object) $output;
  320. }
  321. return $output;
  322. }
  323. // key
  324. $key = self::parseScalar($mapping, array(':', ' '), array('"', "'"), $i, false);
  325. // value
  326. $done = false;
  327. while ($i < $len) {
  328. switch ($mapping[$i]) {
  329. case '[':
  330. // nested sequence
  331. $value = self::parseSequence($mapping, $i, $references);
  332. // Spec: Keys MUST be unique; first one wins.
  333. // Parser cannot abort this mapping earlier, since lines
  334. // are processed sequentially.
  335. if (!isset($output[$key])) {
  336. $output[$key] = $value;
  337. }
  338. $done = true;
  339. break;
  340. case '{':
  341. // nested mapping
  342. $value = self::parseMapping($mapping, $i, $references);
  343. // Spec: Keys MUST be unique; first one wins.
  344. // Parser cannot abort this mapping earlier, since lines
  345. // are processed sequentially.
  346. if (!isset($output[$key])) {
  347. $output[$key] = $value;
  348. }
  349. $done = true;
  350. break;
  351. case ':':
  352. case ' ':
  353. break;
  354. default:
  355. $value = self::parseScalar($mapping, array(',', '}'), array('"', "'"), $i, true, $references);
  356. // Spec: Keys MUST be unique; first one wins.
  357. // Parser cannot abort this mapping earlier, since lines
  358. // are processed sequentially.
  359. if (!isset($output[$key])) {
  360. $output[$key] = $value;
  361. }
  362. $done = true;
  363. --$i;
  364. }
  365. ++$i;
  366. if ($done) {
  367. continue 2;
  368. }
  369. }
  370. }
  371. throw new ParseException(sprintf('Malformed inline YAML string %s', $mapping));
  372. }
  373. /**
  374. * Evaluates scalars and replaces magic values.
  375. *
  376. * @param string $scalar
  377. * @param array $references
  378. *
  379. * @return string A YAML string
  380. *
  381. * @throws ParseException when object parsing support was disabled and the parser detected a PHP object or when a reference could not be resolved
  382. */
  383. private static function evaluateScalar($scalar, $references = array())
  384. {
  385. $scalar = trim($scalar);
  386. $scalarLower = strtolower($scalar);
  387. if (0 === strpos($scalar, '*')) {
  388. if (false !== $pos = strpos($scalar, '#')) {
  389. $value = substr($scalar, 1, $pos - 2);
  390. } else {
  391. $value = substr($scalar, 1);
  392. }
  393. // an unquoted *
  394. if (false === $value || '' === $value) {
  395. throw new ParseException('A reference must contain at least one character.');
  396. }
  397. if (!array_key_exists($value, $references)) {
  398. throw new ParseException(sprintf('Reference "%s" does not exist.', $value));
  399. }
  400. return $references[$value];
  401. }
  402. switch (true) {
  403. case 'null' === $scalarLower:
  404. case '' === $scalar:
  405. case '~' === $scalar:
  406. return;
  407. case 'true' === $scalarLower:
  408. return true;
  409. case 'false' === $scalarLower:
  410. return false;
  411. // Optimise for returning strings.
  412. case $scalar[0] === '+' || $scalar[0] === '-' || $scalar[0] === '.' || $scalar[0] === '!' || is_numeric($scalar[0]):
  413. switch (true) {
  414. case 0 === strpos($scalar, '!str'):
  415. return (string) substr($scalar, 5);
  416. case 0 === strpos($scalar, '! '):
  417. return (int) self::parseScalar(substr($scalar, 2));
  418. case 0 === strpos($scalar, '!!php/object:'):
  419. if (self::$objectSupport) {
  420. return unserialize(substr($scalar, 13));
  421. }
  422. if (self::$exceptionOnInvalidType) {
  423. throw new ParseException('Object support when parsing a YAML file has been disabled.');
  424. }
  425. return;
  426. case 0 === strpos($scalar, '!!float '):
  427. return (float) substr($scalar, 8);
  428. case ctype_digit($scalar):
  429. $raw = $scalar;
  430. $cast = (int) $scalar;
  431. return '0' == $scalar[0] ? octdec($scalar) : (((string) $raw == (string) $cast) ? $cast : $raw);
  432. case '-' === $scalar[0] && ctype_digit(substr($scalar, 1)):
  433. $raw = $scalar;
  434. $cast = (int) $scalar;
  435. return '0' == $scalar[1] ? octdec($scalar) : (((string) $raw === (string) $cast) ? $cast : $raw);
  436. case is_numeric($scalar):
  437. case preg_match(self::getHexRegex(), $scalar):
  438. return '0x' === $scalar[0].$scalar[1] ? hexdec($scalar) : (float) $scalar;
  439. case '.inf' === $scalarLower:
  440. case '.nan' === $scalarLower:
  441. return -log(0);
  442. case '-.inf' === $scalarLower:
  443. return log(0);
  444. case preg_match('/^(-|\+)?[0-9,]+(\.[0-9]+)?$/', $scalar):
  445. return (float) str_replace(',', '', $scalar);
  446. case preg_match(self::getTimestampRegex(), $scalar):
  447. return strtotime($scalar);
  448. }
  449. default:
  450. return (string) $scalar;
  451. }
  452. }
  453. /**
  454. * Gets a regex that matches a YAML date.
  455. *
  456. * @return string The regular expression
  457. *
  458. * @see http://www.yaml.org/spec/1.2/spec.html#id2761573
  459. */
  460. private static function getTimestampRegex()
  461. {
  462. return <<<EOF
  463. ~^
  464. (?P<year>[0-9][0-9][0-9][0-9])
  465. -(?P<month>[0-9][0-9]?)
  466. -(?P<day>[0-9][0-9]?)
  467. (?:(?:[Tt]|[ \t]+)
  468. (?P<hour>[0-9][0-9]?)
  469. :(?P<minute>[0-9][0-9])
  470. :(?P<second>[0-9][0-9])
  471. (?:\.(?P<fraction>[0-9]*))?
  472. (?:[ \t]*(?P<tz>Z|(?P<tz_sign>[-+])(?P<tz_hour>[0-9][0-9]?)
  473. (?::(?P<tz_minute>[0-9][0-9]))?))?)?
  474. $~x
  475. EOF;
  476. }
  477. /**
  478. * Gets a regex that matches a YAML number in hexadecimal notation.
  479. *
  480. * @return string
  481. */
  482. private static function getHexRegex()
  483. {
  484. return '~^0x[0-9a-f]++$~i';
  485. }
  486. }